7440a4c06949ec26170789779ba10d66ffb68d34
[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.90"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2017
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- the small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of the program,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of the document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, the manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(http://www.uit.co.uk/exim-book/)).
396
397 This book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As the program develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to the program (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP and web sites" "SECID2"
449 .cindex "web site"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is currently the University of
452 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
453 distribution'& below. In addition, there is a web site and an FTP site at
454 &%exim.org%&. These are now also hosted at the University of Cambridge. The
455 &%exim.org%& site was previously hosted for a number of years by Energis
456 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
457
458 .cindex "wiki"
459 .cindex "FAQ"
460 As well as Exim distribution tar files, the Exim web site contains a number of
461 differently formatted versions of the documentation. A recent addition to the
462 online information is the Exim wiki (&url(http://wiki.exim.org)),
463 which contains what used to be a separate FAQ, as well as various other
464 examples, tips, and know-how that have been contributed by Exim users.
465
466 .cindex Bugzilla
467 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
468 this to report bugs, and also to add items to the wish list. Please search
469 first to check that you are not duplicating a previous entry.
470
471
472
473 .section "Mailing lists" "SECID3"
474 .cindex "mailing lists" "for Exim users"
475 The following Exim mailing lists exist:
476
477 .table2 140pt
478 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
479 .row &'exim-users@exim.org'&      "General discussion list"
480 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
481 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
482 .endtable
483
484 You can subscribe to these lists, change your existing subscriptions, and view
485 or search the archives via the mailing lists link on the Exim home page.
486 .cindex "Debian" "mailing list for"
487 If you are using a Debian distribution of Exim, you may wish to subscribe to
488 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
489 via this web page:
490 .display
491 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
492 .endd
493 Please ask Debian-specific questions on this list and not on the general Exim
494 lists.
495
496 .section "Bug reports" "SECID5"
497 .cindex "bug reports"
498 .cindex "reporting bugs"
499 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
500 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
501 whether some behaviour is a bug or not, the best thing to do is to post a
502 message to the &'exim-dev'& mailing list and have it discussed.
503
504
505
506 .section "Where to find the Exim distribution" "SECTavail"
507 .cindex "FTP site"
508 .cindex "distribution" "ftp site"
509 The master ftp site for the Exim distribution is
510 .display
511 &*ftp://ftp.exim.org/pub/exim*&
512 .endd
513 The file references that follow are relative to the &_exim_& directories at
514 these sites. There are now quite a number of independent mirror sites around
515 the world. Those that I know about are listed in the file called &_Mirrors_&.
516
517 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
518 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
519 distributions), and &_Testing_& for testing versions. In the &_exim4_&
520 subdirectory, the current release can always be found in files called
521 .display
522 &_exim-n.nn.tar.gz_&
523 &_exim-n.nn.tar.bz2_&
524 .endd
525 where &'n.nn'& is the highest such version number in the directory. The two
526 files contain identical data; the only difference is the type of compression.
527 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
528
529 .cindex "distribution" "signing details"
530 .cindex "distribution" "public key"
531 .cindex "public key for signed distribution"
532 The distributions will be PGP signed by an individual key of the Release
533 Coordinator.  This key will have a uid containing an email address in the
534 &'exim.org'& domain and will have signatures from other people, including
535 other Exim maintainers.  We expect that the key will be in the "strong set" of
536 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
537 PGP key, a version of which can be found in the release directory in the file
538 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
539 such as &'pool.sks-keyservers.net'&.
540
541 At time of last update, releases were being made by Phil Pennock and signed with
542 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
543 A trust path from Nigel's key to Phil's can be observed at
544 &url(https://www.security.spodhuis.org/exim-trustpath).
545
546 Releases have also been authorized to be performed by Todd Lyons who signs with
547 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
548 Pennock and Todd Lyons through a common associate.
549
550 The signatures for the tar bundles are in:
551 .display
552 &_exim-n.nn.tar.gz.asc_&
553 &_exim-n.nn.tar.bz2.asc_&
554 .endd
555 For each released version, the log of changes is made separately available in a
556 separate file in the directory &_ChangeLogs_& so that it is possible to
557 find out what has changed without having to download the entire distribution.
558
559 .cindex "documentation" "available formats"
560 The main distribution contains ASCII versions of this specification and other
561 documentation; other formats of the documents are available in separate files
562 inside the &_exim4_& directory of the FTP site:
563 .display
564 &_exim-html-n.nn.tar.gz_&
565 &_exim-pdf-n.nn.tar.gz_&
566 &_exim-postscript-n.nn.tar.gz_&
567 &_exim-texinfo-n.nn.tar.gz_&
568 .endd
569 These tar files contain only the &_doc_& directory, not the complete
570 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
571
572
573 .section "Limitations" "SECID6"
574 .ilist
575 .cindex "limitations of Exim"
576 .cindex "bang paths" "not handled by Exim"
577 Exim is designed for use as an Internet MTA, and therefore handles addresses in
578 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
579 simple two-component bang paths can be converted by a straightforward rewriting
580 configuration. This restriction does not prevent Exim from being interfaced to
581 UUCP as a transport mechanism, provided that domain addresses are used.
582 .next
583 .cindex "domainless addresses"
584 .cindex "address" "without domain"
585 Exim insists that every address it handles has a domain attached. For incoming
586 local messages, domainless addresses are automatically qualified with a
587 configured domain value. Configuration options specify from which remote
588 systems unqualified addresses are acceptable. These are then qualified on
589 arrival.
590 .next
591 .cindex "transport" "external"
592 .cindex "external transports"
593 The only external transport mechanisms that are currently implemented are SMTP
594 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
595 transport is available, and there are facilities for writing messages to files
596 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
597 to send messages to other transport mechanisms such as UUCP, provided they can
598 handle domain-style addresses. Batched SMTP input is also catered for.
599 .next
600 Exim is not designed for storing mail for dial-in hosts. When the volumes of
601 such mail are large, it is better to get the messages &"delivered"& into files
602 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
603 other means.
604 .next
605 Although Exim does have basic facilities for scanning incoming messages, these
606 are not comprehensive enough to do full virus or spam scanning. Such operations
607 are best carried out using additional specialized software packages. If you
608 compile Exim with the content-scanning extension, straightforward interfaces to
609 a number of common scanners are provided.
610 .endlist
611
612
613 .section "Run time configuration" "SECID7"
614 Exim's run time configuration is held in a single text file that is divided
615 into a number of sections. The entries in this file consist of keywords and
616 values, in the style of Smail 3 configuration files. A default configuration
617 file which is suitable for simple online installations is provided in the
618 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
619
620
621 .section "Calling interface" "SECID8"
622 .cindex "Sendmail compatibility" "command line interface"
623 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
624 can be a straight replacement for &_/usr/lib/sendmail_& or
625 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
626 about Sendmail in order to run Exim. For actions other than sending messages,
627 Sendmail-compatible options also exist, but those that produce output (for
628 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
629 format. There are also some additional options that are compatible with Smail
630 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
631 documents all Exim's command line options. This information is automatically
632 made into the man page that forms part of the Exim distribution.
633
634 Control of messages on the queue can be done via certain privileged command
635 line options. There is also an optional monitor program called &'eximon'&,
636 which displays current information in an X window, and which contains a menu
637 interface to Exim's command line administration options.
638
639
640
641 .section "Terminology" "SECID9"
642 .cindex "terminology definitions"
643 .cindex "body of message" "definition of"
644 The &'body'& of a message is the actual data that the sender wants to transmit.
645 It is the last part of a message, and is separated from the &'header'& (see
646 below) by a blank line.
647
648 .cindex "bounce message" "definition of"
649 When a message cannot be delivered, it is normally returned to the sender in a
650 delivery failure message or a &"non-delivery report"& (NDR). The term
651 &'bounce'& is commonly used for this action, and the error reports are often
652 called &'bounce messages'&. This is a convenient shorthand for &"delivery
653 failure error report"&. Such messages have an empty sender address in the
654 message's &'envelope'& (see below) to ensure that they cannot themselves give
655 rise to further bounce messages.
656
657 The term &'default'& appears frequently in this manual. It is used to qualify a
658 value which is used in the absence of any setting in the configuration. It may
659 also qualify an action which is taken unless a configuration setting specifies
660 otherwise.
661
662 The term &'defer'& is used when the delivery of a message to a specific
663 destination cannot immediately take place for some reason (a remote host may be
664 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
665 until a later time.
666
667 The word &'domain'& is sometimes used to mean all but the first component of a
668 host's name. It is &'not'& used in that sense here, where it normally refers to
669 the part of an email address following the @ sign.
670
671 .cindex "envelope, definition of"
672 .cindex "sender" "definition of"
673 A message in transit has an associated &'envelope'&, as well as a header and a
674 body. The envelope contains a sender address (to which bounce messages should
675 be delivered), and any number of recipient addresses. References to the
676 sender or the recipients of a message usually mean the addresses in the
677 envelope. An MTA uses these addresses for delivery, and for returning bounce
678 messages, not the addresses that appear in the header lines.
679
680 .cindex "message" "header, definition of"
681 .cindex "header section" "definition of"
682 The &'header'& of a message is the first part of a message's text, consisting
683 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
684 &'Subject:'&, etc. Long header lines can be split over several text lines by
685 indenting the continuations. The header is separated from the body by a blank
686 line.
687
688 .cindex "local part" "definition of"
689 .cindex "domain" "definition of"
690 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
691 part of an email address that precedes the @ sign. The part that follows the
692 @ sign is called the &'domain'& or &'mail domain'&.
693
694 .cindex "local delivery" "definition of"
695 .cindex "remote delivery, definition of"
696 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
697 delivery to a file or a pipe on the local host from delivery by SMTP over
698 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
699 host it is running on are &'remote'&.
700
701 .cindex "return path" "definition of"
702 &'Return path'& is another name that is used for the sender address in a
703 message's envelope.
704
705 .cindex "queue" "definition of"
706 The term &'queue'& is used to refer to the set of messages awaiting delivery,
707 because this term is in widespread use in the context of MTAs. However, in
708 Exim's case the reality is more like a pool than a queue, because there is
709 normally no ordering of waiting messages.
710
711 .cindex "queue runner" "definition of"
712 The term &'queue runner'& is used to describe a process that scans the queue
713 and attempts to deliver those messages whose retry times have come. This term
714 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
715 the waiting messages are normally processed in an unpredictable order.
716
717 .cindex "spool directory" "definition of"
718 The term &'spool directory'& is used for a directory in which Exim keeps the
719 messages on its queue &-- that is, those that it is in the process of
720 delivering. This should not be confused with the directory in which local
721 mailboxes are stored, which is called a &"spool directory"& by some people. In
722 the Exim documentation, &"spool"& is always used in the first sense.
723
724
725
726
727
728
729 . ////////////////////////////////////////////////////////////////////////////
730 . ////////////////////////////////////////////////////////////////////////////
731
732 .chapter "Incorporated code" "CHID2"
733 .cindex "incorporated code"
734 .cindex "regular expressions" "library"
735 .cindex "PCRE"
736 .cindex "OpenDMARC"
737 A number of pieces of external code are included in the Exim distribution.
738
739 .ilist
740 Regular expressions are supported in the main Exim program and in the
741 Exim monitor using the freely-distributable PCRE library, copyright
742 &copy; University of Cambridge. The source to PCRE is no longer shipped with
743 Exim, so you will need to use the version of PCRE shipped with your system,
744 or obtain and install the full version of the library from
745 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
746 .next
747 .cindex "cdb" "acknowledgment"
748 Support for the cdb (Constant DataBase) lookup method is provided by code
749 contributed by Nigel Metheringham of (at the time he contributed it) Planet
750 Online Ltd. The implementation is completely contained within the code of Exim.
751 It does not link against an external cdb library. The code contains the
752 following statements:
753
754 .blockquote
755 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
756
757 This program is free software; you can redistribute it and/or modify it under
758 the terms of the GNU General Public License as published by the Free Software
759 Foundation; either version 2 of the License, or (at your option) any later
760 version.
761 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
762 the spec and sample code for cdb can be obtained from
763 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
764 some code from Dan Bernstein's implementation (which has no license
765 restrictions applied to it).
766 .endblockquote
767 .next
768 .cindex "SPA authentication"
769 .cindex "Samba project"
770 .cindex "Microsoft Secure Password Authentication"
771 Client support for Microsoft's &'Secure Password Authentication'& is provided
772 by code contributed by Marc Prud'hommeaux. Server support was contributed by
773 Tom Kistner. This includes code taken from the Samba project, which is released
774 under the Gnu GPL.
775 .next
776 .cindex "Cyrus"
777 .cindex "&'pwcheck'& daemon"
778 .cindex "&'pwauthd'& daemon"
779 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
780 by code taken from the Cyrus-SASL library and adapted by Alexander S.
781 Sabourenkov. The permission notice appears below, in accordance with the
782 conditions expressed therein.
783
784 .blockquote
785 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
786
787 Redistribution and use in source and binary forms, with or without
788 modification, are permitted provided that the following conditions
789 are met:
790
791 .olist
792 Redistributions of source code must retain the above copyright
793 notice, this list of conditions and the following disclaimer.
794 .next
795 Redistributions in binary form must reproduce the above copyright
796 notice, this list of conditions and the following disclaimer in
797 the documentation and/or other materials provided with the
798 distribution.
799 .next
800 The name &"Carnegie Mellon University"& must not be used to
801 endorse or promote products derived from this software without
802 prior written permission. For permission or any other legal
803 details, please contact
804 .display
805               Office of Technology Transfer
806               Carnegie Mellon University
807               5000 Forbes Avenue
808               Pittsburgh, PA  15213-3890
809               (412) 268-4387, fax: (412) 268-7395
810               tech-transfer@andrew.cmu.edu
811 .endd
812 .next
813 Redistributions of any form whatsoever must retain the following
814 acknowledgment:
815
816 &"This product includes software developed by Computing Services
817 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
818
819 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
820 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
821 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
822 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
823 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
824 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
825 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
826 .endlist
827 .endblockquote
828
829 .next
830 .cindex "Exim monitor" "acknowledgment"
831 .cindex "X-windows"
832 .cindex "Athena"
833 The Exim Monitor program, which is an X-Window application, includes
834 modified versions of the Athena StripChart and TextPop widgets.
835 This code is copyright by DEC and MIT, and their permission notice appears
836 below, in accordance with the conditions expressed therein.
837
838 .blockquote
839 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
840 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
841
842 All Rights Reserved
843
844 Permission to use, copy, modify, and distribute this software and its
845 documentation for any purpose and without fee is hereby granted,
846 provided that the above copyright notice appear in all copies and that
847 both that copyright notice and this permission notice appear in
848 supporting documentation, and that the names of Digital or MIT not be
849 used in advertising or publicity pertaining to distribution of the
850 software without specific, written prior permission.
851
852 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
853 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
854 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
855 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
856 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
857 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
858 SOFTWARE.
859 .endblockquote
860
861 .next
862 .cindex "opendmarc" "acknowledgment"
863 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
864 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
865 derived code are indicated in the respective source files. The full OpenDMARC
866 license is provided in the LICENSE.opendmarc file contained in the distributed
867 source code.
868
869 .next
870 Many people have contributed code fragments, some large, some small, that were
871 not covered by any specific licence requirements. It is assumed that the
872 contributors are happy to see their code incorporated into Exim under the GPL.
873 .endlist
874
875
876
877
878
879 . ////////////////////////////////////////////////////////////////////////////
880 . ////////////////////////////////////////////////////////////////////////////
881
882 .chapter "How Exim receives and delivers mail" "CHID11" &&&
883          "Receiving and delivering mail"
884
885
886 .section "Overall philosophy" "SECID10"
887 .cindex "design philosophy"
888 Exim is designed to work efficiently on systems that are permanently connected
889 to the Internet and are handling a general mix of mail. In such circumstances,
890 most messages can be delivered immediately. Consequently, Exim does not
891 maintain independent queues of messages for specific domains or hosts, though
892 it does try to send several messages in a single SMTP connection after a host
893 has been down, and it also maintains per-host retry information.
894
895
896 .section "Policy control" "SECID11"
897 .cindex "policy control" "overview"
898 Policy controls are now an important feature of MTAs that are connected to the
899 Internet. Perhaps their most important job is to stop MTAs being abused as
900 &"open relays"& by misguided individuals who send out vast amounts of
901 unsolicited junk, and want to disguise its source. Exim provides flexible
902 facilities for specifying policy controls on incoming mail:
903
904 .ilist
905 .cindex "&ACL;" "introduction"
906 Exim 4 (unlike previous versions of Exim) implements policy controls on
907 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
908 series of statements that may either grant or deny access. ACLs can be used at
909 several places in the SMTP dialogue while receiving a message from a remote
910 host. However, the most common places are after each RCPT command, and at the
911 very end of the message. The sysadmin can specify conditions for accepting or
912 rejecting individual recipients or the entire message, respectively, at these
913 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
914 error code.
915 .next
916 An ACL is also available for locally generated, non-SMTP messages. In this
917 case, the only available actions are to accept or deny the entire message.
918 .next
919 When Exim is compiled with the content-scanning extension, facilities are
920 provided in the ACL mechanism for passing the message to external virus and/or
921 spam scanning software. The result of such a scan is passed back to the ACL,
922 which can then use it to decide what to do with the message.
923 .next
924 When a message has been received, either from a remote host or from the local
925 host, but before the final acknowledgment has been sent, a locally supplied C
926 function called &[local_scan()]& can be run to inspect the message and decide
927 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
928 is accepted, the list of recipients can be modified by the function.
929 .next
930 Using the &[local_scan()]& mechanism is another way of calling external scanner
931 software. The &%SA-Exim%& add-on package works this way. It does not require
932 Exim to be compiled with the content-scanning extension.
933 .next
934 After a message has been accepted, a further checking mechanism is available in
935 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
936 runs at the start of every delivery process.
937 .endlist
938
939
940
941 .section "User filters" "SECID12"
942 .cindex "filter" "introduction"
943 .cindex "Sieve filter"
944 In a conventional Exim configuration, users are able to run private filters by
945 setting up appropriate &_.forward_& files in their home directories. See
946 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
947 configuration needed to support this, and the separate document entitled
948 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
949 of filtering are available:
950
951 .ilist
952 Sieve filters are written in the standard filtering language that is defined
953 by RFC 3028.
954 .next
955 Exim filters are written in a syntax that is unique to Exim, but which is more
956 powerful than Sieve, which it pre-dates.
957 .endlist
958
959 User filters are run as part of the routing process, described below.
960
961
962
963 .section "Message identification" "SECTmessiden"
964 .cindex "message ids" "details of format"
965 .cindex "format" "of message id"
966 .cindex "id of message"
967 .cindex "base62"
968 .cindex "base36"
969 .cindex "Darwin"
970 .cindex "Cygwin"
971 Every message handled by Exim is given a &'message id'& which is sixteen
972 characters long. It is divided into three parts, separated by hyphens, for
973 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
974 normally encoding numbers in base 62. However, in the Darwin operating
975 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
976 (avoiding the use of lower case letters) is used instead, because the message
977 id is used to construct file names, and the names of files in those systems are
978 not always case-sensitive.
979
980 .cindex "pid (process id)" "re-use of"
981 The detail of the contents of the message id have changed as Exim has evolved.
982 Earlier versions relied on the operating system not re-using a process id (pid)
983 within one second. On modern operating systems, this assumption can no longer
984 be made, so the algorithm had to be changed. To retain backward compatibility,
985 the format of the message id was retained, which is why the following rules are
986 somewhat eccentric:
987
988 .ilist
989 The first six characters of the message id are the time at which the message
990 started to be received, to a granularity of one second. That is, this field
991 contains the number of seconds since the start of the epoch (the normal Unix
992 way of representing the date and time of day).
993 .next
994 After the first hyphen, the next six characters are the id of the process that
995 received the message.
996 .next
997 There are two different possibilities for the final two characters:
998 .olist
999 .oindex "&%localhost_number%&"
1000 If &%localhost_number%& is not set, this value is the fractional part of the
1001 time of reception, normally in units of 1/2000 of a second, but for systems
1002 that must use base 36 instead of base 62 (because of case-insensitive file
1003 systems), the units are 1/1000 of a second.
1004 .next
1005 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1006 the fractional part of the time, which in this case is in units of 1/200
1007 (1/100) of a second.
1008 .endlist
1009 .endlist
1010
1011 After a message has been received, Exim waits for the clock to tick at the
1012 appropriate resolution before proceeding, so that if another message is
1013 received by the same process, or by another process with the same (re-used)
1014 pid, it is guaranteed that the time will be different. In most cases, the clock
1015 will already have ticked while the message was being received.
1016
1017
1018 .section "Receiving mail" "SECID13"
1019 .cindex "receiving mail"
1020 .cindex "message" "reception"
1021 The only way Exim can receive mail from another host is using SMTP over
1022 TCP/IP, in which case the sender and recipient addresses are transferred using
1023 SMTP commands. However, from a locally running process (such as a user's MUA),
1024 there are several possibilities:
1025
1026 .ilist
1027 If the process runs Exim with the &%-bm%& option, the message is read
1028 non-interactively (usually via a pipe), with the recipients taken from the
1029 command line, or from the body of the message if &%-t%& is also used.
1030 .next
1031 If the process runs Exim with the &%-bS%& option, the message is also read
1032 non-interactively, but in this case the recipients are listed at the start of
1033 the message in a series of SMTP RCPT commands, terminated by a DATA
1034 command. This is so-called &"batch SMTP"& format,
1035 but it isn't really SMTP. The SMTP commands are just another way of passing
1036 envelope addresses in a non-interactive submission.
1037 .next
1038 If the process runs Exim with the &%-bs%& option, the message is read
1039 interactively, using the SMTP protocol. A two-way pipe is normally used for
1040 passing data between the local process and the Exim process.
1041 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1042 example, the ACLs for SMTP commands are used for this form of submission.
1043 .next
1044 A local process may also make a TCP/IP call to the host's loopback address
1045 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1046 does not treat the loopback address specially. It treats all such connections
1047 in the same way as connections from other hosts.
1048 .endlist
1049
1050
1051 .cindex "message sender, constructed by Exim"
1052 .cindex "sender" "constructed by Exim"
1053 In the three cases that do not involve TCP/IP, the sender address is
1054 constructed from the login name of the user that called Exim and a default
1055 qualification domain (which can be set by the &%qualify_domain%& configuration
1056 option). For local or batch SMTP, a sender address that is passed using the
1057 SMTP MAIL command is ignored. However, the system administrator may allow
1058 certain users (&"trusted users"&) to specify a different sender address
1059 unconditionally, or all users to specify certain forms of different sender
1060 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1061 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1062 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1063 users to change sender addresses.
1064
1065 Messages received by either of the non-interactive mechanisms are subject to
1066 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1067 (either over TCP/IP, or interacting with a local process) can be checked by a
1068 number of ACLs that operate at different times during the SMTP session. Either
1069 individual recipients, or the entire message, can be rejected if local policy
1070 requirements are not met. The &[local_scan()]& function (see chapter
1071 &<<CHAPlocalscan>>&) is run for all incoming messages.
1072
1073 Exim can be configured not to start a delivery process when a message is
1074 received; this can be unconditional, or depend on the number of incoming SMTP
1075 connections or the system load. In these situations, new messages wait on the
1076 queue until a queue runner process picks them up. However, in standard
1077 configurations under normal conditions, delivery is started as soon as a
1078 message is received.
1079
1080
1081
1082
1083
1084 .section "Handling an incoming message" "SECID14"
1085 .cindex "spool directory" "files that hold a message"
1086 .cindex "file" "how a message is held"
1087 When Exim accepts a message, it writes two files in its spool directory. The
1088 first contains the envelope information, the current status of the message, and
1089 the header lines, and the second contains the body of the message. The names of
1090 the two spool files consist of the message id, followed by &`-H`& for the
1091 file containing the envelope and header, and &`-D`& for the data file.
1092
1093 .cindex "spool directory" "&_input_& sub-directory"
1094 By default all these message files are held in a single directory called
1095 &_input_& inside the general Exim spool directory. Some operating systems do
1096 not perform very well if the number of files in a directory gets large; to
1097 improve performance in such cases, the &%split_spool_directory%& option can be
1098 used. This causes Exim to split up the input files into 62 sub-directories
1099 whose names are single letters or digits. When this is done, the queue is
1100 processed one sub-directory at a time instead of all at once, which can improve
1101 overall performance even when there are not enough files in each directory to
1102 affect file system performance.
1103
1104 The envelope information consists of the address of the message's sender and
1105 the addresses of the recipients. This information is entirely separate from
1106 any addresses contained in the header lines. The status of the message includes
1107 a list of recipients who have already received the message. The format of the
1108 first spool file is described in chapter &<<CHAPspool>>&.
1109
1110 .cindex "rewriting" "addresses"
1111 Address rewriting that is specified in the rewrite section of the configuration
1112 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1113 both in the header lines and the envelope, at the time the message is accepted.
1114 If during the course of delivery additional addresses are generated (for
1115 example, via aliasing), these new addresses are rewritten as soon as they are
1116 generated. At the time a message is actually delivered (transported) further
1117 rewriting can take place; because this is a transport option, it can be
1118 different for different forms of delivery. It is also possible to specify the
1119 addition or removal of certain header lines at the time the message is
1120 delivered (see chapters &<<CHAProutergeneric>>& and
1121 &<<CHAPtransportgeneric>>&).
1122
1123
1124
1125 .section "Life of a message" "SECID15"
1126 .cindex "message" "life of"
1127 .cindex "message" "frozen"
1128 A message remains in the spool directory until it is completely delivered to
1129 its recipients or to an error address, or until it is deleted by an
1130 administrator or by the user who originally created it. In cases when delivery
1131 cannot proceed &-- for example, when a message can neither be delivered to its
1132 recipients nor returned to its sender, the message is marked &"frozen"& on the
1133 spool, and no more deliveries are attempted.
1134
1135 .cindex "frozen messages" "thawing"
1136 .cindex "message" "thawing frozen"
1137 An administrator can &"thaw"& such messages when the problem has been
1138 corrected, and can also freeze individual messages by hand if necessary. In
1139 addition, an administrator can force a delivery error, causing a bounce message
1140 to be sent.
1141
1142 .oindex "&%timeout_frozen_after%&"
1143 .oindex "&%ignore_bounce_errors_after%&"
1144 There are options called &%ignore_bounce_errors_after%& and
1145 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1146 The first applies only to frozen bounces, the second to any frozen messages.
1147
1148 .cindex "message" "log file for"
1149 .cindex "log" "file for each message"
1150 While Exim is working on a message, it writes information about each delivery
1151 attempt to its main log file. This includes successful, unsuccessful, and
1152 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1153 lines are also written to a separate &'message log'& file for each message.
1154 These logs are solely for the benefit of the administrator, and are normally
1155 deleted along with the spool files when processing of a message is complete.
1156 The use of individual message logs can be disabled by setting
1157 &%no_message_logs%&; this might give an improvement in performance on very busy
1158 systems.
1159
1160 .cindex "journal file"
1161 .cindex "file" "journal"
1162 All the information Exim itself needs to set up a delivery is kept in the first
1163 spool file, along with the header lines. When a successful delivery occurs, the
1164 address is immediately written at the end of a journal file, whose name is the
1165 message id followed by &`-J`&. At the end of a delivery run, if there are some
1166 addresses left to be tried again later, the first spool file (the &`-H`& file)
1167 is updated to indicate which these are, and the journal file is then deleted.
1168 Updating the spool file is done by writing a new file and renaming it, to
1169 minimize the possibility of data loss.
1170
1171 Should the system or the program crash after a successful delivery but before
1172 the spool file has been updated, the journal is left lying around. The next
1173 time Exim attempts to deliver the message, it reads the journal file and
1174 updates the spool file before proceeding. This minimizes the chances of double
1175 deliveries caused by crashes.
1176
1177
1178
1179 .section "Processing an address for delivery" "SECTprocaddress"
1180 .cindex "drivers" "definition of"
1181 .cindex "router" "definition of"
1182 .cindex "transport" "definition of"
1183 The main delivery processing elements of Exim are called &'routers'& and
1184 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1185 number of them is provided in the source distribution, and compile-time options
1186 specify which ones are included in the binary. Run time options specify which
1187 ones are actually used for delivering messages.
1188
1189 .cindex "drivers" "instance definition"
1190 Each driver that is specified in the run time configuration is an &'instance'&
1191 of that particular driver type. Multiple instances are allowed; for example,
1192 you can set up several different &(smtp)& transports, each with different
1193 option values that might specify different ports or different timeouts. Each
1194 instance has its own identifying name. In what follows we will normally use the
1195 instance name when discussing one particular instance (that is, one specific
1196 configuration of the driver), and the generic driver name when discussing
1197 the driver's features in general.
1198
1199 A &'router'& is a driver that operates on an address, either determining how
1200 its delivery should happen, by assigning it to a specific transport, or
1201 converting the address into one or more new addresses (for example, via an
1202 alias file). A router may also explicitly choose to fail an address, causing it
1203 to be bounced.
1204
1205 A &'transport'& is a driver that transmits a copy of the message from Exim's
1206 spool to some destination. There are two kinds of transport: for a &'local'&
1207 transport, the destination is a file or a pipe on the local host, whereas for a
1208 &'remote'& transport the destination is some other host. A message is passed
1209 to a specific transport as a result of successful routing. If a message has
1210 several recipients, it may be passed to a number of different transports.
1211
1212 .cindex "preconditions" "definition of"
1213 An address is processed by passing it to each configured router instance in
1214 turn, subject to certain preconditions, until a router accepts the address or
1215 specifies that it should be bounced. We will describe this process in more
1216 detail shortly. First, as a simple example, we consider how each recipient
1217 address in a message is processed in a small configuration of three routers.
1218
1219 To make this a more concrete example, it is described in terms of some actual
1220 routers, but remember, this is only an example. You can configure Exim's
1221 routers in many different ways, and there may be any number of routers in a
1222 configuration.
1223
1224 The first router that is specified in a configuration is often one that handles
1225 addresses in domains that are not recognized specially by the local host. These
1226 are typically addresses for arbitrary domains on the Internet. A precondition
1227 is set up which looks for the special domains known to the host (for example,
1228 its own domain name), and the router is run for addresses that do &'not'&
1229 match. Typically, this is a router that looks up domains in the DNS in order to
1230 find the hosts to which this address routes. If it succeeds, the address is
1231 assigned to a suitable SMTP transport; if it does not succeed, the router is
1232 configured to fail the address.
1233
1234 The second router is reached only when the domain is recognized as one that
1235 &"belongs"& to the local host. This router does redirection &-- also known as
1236 aliasing and forwarding. When it generates one or more new addresses from the
1237 original, each of them is routed independently from the start. Otherwise, the
1238 router may cause an address to fail, or it may simply decline to handle the
1239 address, in which case the address is passed to the next router.
1240
1241 The final router in many configurations is one that checks to see if the
1242 address belongs to a local mailbox. The precondition may involve a check to
1243 see if the local part is the name of a login account, or it may look up the
1244 local part in a file or a database. If its preconditions are not met, or if
1245 the router declines, we have reached the end of the routers. When this happens,
1246 the address is bounced.
1247
1248
1249
1250 .section "Processing an address for verification" "SECID16"
1251 .cindex "router" "for verification"
1252 .cindex "verifying address" "overview"
1253 As well as being used to decide how to deliver to an address, Exim's routers
1254 are also used for &'address verification'&. Verification can be requested as
1255 one of the checks to be performed in an ACL for incoming messages, on both
1256 sender and recipient addresses, and it can be tested using the &%-bv%& and
1257 &%-bvs%& command line options.
1258
1259 When an address is being verified, the routers are run in &"verify mode"&. This
1260 does not affect the way the routers work, but it is a state that can be
1261 detected. By this means, a router can be skipped or made to behave differently
1262 when verifying. A common example is a configuration in which the first router
1263 sends all messages to a message-scanning program, unless they have been
1264 previously scanned. Thus, the first router accepts all addresses without any
1265 checking, making it useless for verifying. Normally, the &%no_verify%& option
1266 would be set for such a router, causing it to be skipped in verify mode.
1267
1268
1269
1270
1271 .section "Running an individual router" "SECTrunindrou"
1272 .cindex "router" "running details"
1273 .cindex "preconditions" "checking"
1274 .cindex "router" "result of running"
1275 As explained in the example above, a number of preconditions are checked before
1276 running a router. If any are not met, the router is skipped, and the address is
1277 passed to the next router. When all the preconditions on a router &'are'& met,
1278 the router is run. What happens next depends on the outcome, which is one of
1279 the following:
1280
1281 .ilist
1282 &'accept'&: The router accepts the address, and either assigns it to a
1283 transport, or generates one or more &"child"& addresses. Processing the
1284 original address ceases,
1285 .oindex "&%unseen%&"
1286 unless the &%unseen%& option is set on the router. This option
1287 can be used to set up multiple deliveries with different routing (for example,
1288 for keeping archive copies of messages). When &%unseen%& is set, the address is
1289 passed to the next router. Normally, however, an &'accept'& return marks the
1290 end of routing.
1291
1292 Any child addresses generated by the router are processed independently,
1293 starting with the first router by default. It is possible to change this by
1294 setting the &%redirect_router%& option to specify which router to start at for
1295 child addresses. Unlike &%pass_router%& (see below) the router specified by
1296 &%redirect_router%& may be anywhere in the router configuration.
1297 .next
1298 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1299 requests that the address be passed to another router. By default the address
1300 is passed to the next router, but this can be changed by setting the
1301 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1302 must be below the current router (to avoid loops).
1303 .next
1304 &'decline'&: The router declines to accept the address because it does not
1305 recognize it at all. By default, the address is passed to the next router, but
1306 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1307 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1308 &'decline'& into &'fail'&.
1309 .next
1310 &'fail'&: The router determines that the address should fail, and queues it for
1311 the generation of a bounce message. There is no further processing of the
1312 original address unless &%unseen%& is set on the router.
1313 .next
1314 &'defer'&: The router cannot handle the address at the present time. (A
1315 database may be offline, or a DNS lookup may have timed out.) No further
1316 processing of the address happens in this delivery attempt. It is tried again
1317 next time the message is considered for delivery.
1318 .next
1319 &'error'&: There is some error in the router (for example, a syntax error in
1320 its configuration). The action is as for defer.
1321 .endlist
1322
1323 If an address reaches the end of the routers without having been accepted by
1324 any of them, it is bounced as unrouteable. The default error message in this
1325 situation is &"unrouteable address"&, but you can set your own message by
1326 making use of the &%cannot_route_message%& option. This can be set for any
1327 router; the value from the last router that &"saw"& the address is used.
1328
1329 Sometimes while routing you want to fail a delivery when some conditions are
1330 met but others are not, instead of passing the address on for further routing.
1331 You can do this by having a second router that explicitly fails the delivery
1332 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1333 facility for this purpose.
1334
1335
1336 .section "Duplicate addresses" "SECID17"
1337 .cindex "case of local parts"
1338 .cindex "address duplicate, discarding"
1339 .cindex "duplicate addresses"
1340 Once routing is complete, Exim scans the addresses that are assigned to local
1341 and remote transports, and discards any duplicates that it finds. During this
1342 check, local parts are treated as case-sensitive. This happens only when
1343 actually delivering a message; when testing routers with &%-bt%&, all the
1344 routed addresses are shown.
1345
1346
1347
1348 .section "Router preconditions" "SECTrouprecon"
1349 .cindex "router" "preconditions, order of processing"
1350 .cindex "preconditions" "order of processing"
1351 The preconditions that are tested for each router are listed below, in the
1352 order in which they are tested. The individual configuration options are
1353 described in more detail in chapter &<<CHAProutergeneric>>&.
1354
1355 .ilist
1356 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1357 the local parts handled by the router may or must have certain prefixes and/or
1358 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1359 skipped. These conditions are tested first. When an affix is present, it is
1360 removed from the local part before further processing, including the evaluation
1361 of any other conditions.
1362 .next
1363 Routers can be designated for use only when not verifying an address, that is,
1364 only when routing it for delivery (or testing its delivery routing). If the
1365 &%verify%& option is set false, the router is skipped when Exim is verifying an
1366 address.
1367 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1368 &%verify_recipient%&, which independently control the use of the router for
1369 sender and recipient verification. You can set these options directly if
1370 you want a router to be used for only one type of verification.
1371 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1372 .next
1373 If the &%address_test%& option is set false, the router is skipped when Exim is
1374 run with the &%-bt%& option to test an address routing. This can be helpful
1375 when the first router sends all new messages to a scanner of some sort; it
1376 makes it possible to use &%-bt%& to test subsequent delivery routing without
1377 having to simulate the effect of the scanner.
1378 .next
1379 Routers can be designated for use only when verifying an address, as
1380 opposed to routing it for delivery. The &%verify_only%& option controls this.
1381 Again, cutthrough delivery counts as a verification.
1382 .next
1383 Individual routers can be explicitly skipped when running the routers to
1384 check an address given in the SMTP EXPN command (see the &%expn%& option).
1385 .next
1386 If the &%domains%& option is set, the domain of the address must be in the set
1387 of domains that it defines.
1388 .next
1389 .vindex "&$local_part_prefix$&"
1390 .vindex "&$local_part$&"
1391 .vindex "&$local_part_suffix$&"
1392 If the &%local_parts%& option is set, the local part of the address must be in
1393 the set of local parts that it defines. If &%local_part_prefix%& or
1394 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1395 part before this check. If you want to do precondition tests on local parts
1396 that include affixes, you can do so by using a &%condition%& option (see below)
1397 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1398 &$local_part_suffix$& as necessary.
1399 .next
1400 .vindex "&$local_user_uid$&"
1401 .vindex "&$local_user_gid$&"
1402 .vindex "&$home$&"
1403 If the &%check_local_user%& option is set, the local part must be the name of
1404 an account on the local host. If this check succeeds, the uid and gid of the
1405 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1406 user's home directory is placed in &$home$&; these values can be used in the
1407 remaining preconditions.
1408 .next
1409 If the &%router_home_directory%& option is set, it is expanded at this point,
1410 because it overrides the value of &$home$&. If this expansion were left till
1411 later, the value of &$home$& as set by &%check_local_user%& would be used in
1412 subsequent tests. Having two different values of &$home$& in the same router
1413 could lead to confusion.
1414 .next
1415 If the &%senders%& option is set, the envelope sender address must be in the
1416 set of addresses that it defines.
1417 .next
1418 If the &%require_files%& option is set, the existence or non-existence of
1419 specified files is tested.
1420 .next
1421 .cindex "customizing" "precondition"
1422 If the &%condition%& option is set, it is evaluated and tested. This option
1423 uses an expanded string to allow you to set up your own custom preconditions.
1424 Expanded strings are described in chapter &<<CHAPexpand>>&.
1425 .endlist
1426
1427
1428 Note that &%require_files%& comes near the end of the list, so you cannot use
1429 it to check for the existence of a file in which to lookup up a domain, local
1430 part, or sender. However, as these options are all expanded, you can use the
1431 &%exists%& expansion condition to make such tests within each condition. The
1432 &%require_files%& option is intended for checking files that the router may be
1433 going to use internally, or which are needed by a specific transport (for
1434 example, &_.procmailrc_&).
1435
1436
1437
1438 .section "Delivery in detail" "SECID18"
1439 .cindex "delivery" "in detail"
1440 When a message is to be delivered, the sequence of events is as follows:
1441
1442 .ilist
1443 If a system-wide filter file is specified, the message is passed to it. The
1444 filter may add recipients to the message, replace the recipients, discard the
1445 message, cause a new message to be generated, or cause the message delivery to
1446 fail. The format of the system filter file is the same as for Exim user filter
1447 files, described in the separate document entitled &'Exim's interfaces to mail
1448 filtering'&.
1449 .cindex "Sieve filter" "not available for system filter"
1450 (&*Note*&: Sieve cannot be used for system filter files.)
1451
1452 Some additional features are available in system filters &-- see chapter
1453 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1454 filter only once per delivery attempt, however many recipients it has. However,
1455 if there are several delivery attempts because one or more addresses could not
1456 be immediately delivered, the system filter is run each time. The filter
1457 condition &%first_delivery%& can be used to detect the first run of the system
1458 filter.
1459 .next
1460 Each recipient address is offered to each configured router in turn, subject to
1461 its preconditions, until one is able to handle it. If no router can handle the
1462 address, that is, if they all decline, the address is failed. Because routers
1463 can be targeted at particular domains, several locally handled domains can be
1464 processed entirely independently of each other.
1465 .next
1466 .cindex "routing" "loops in"
1467 .cindex "loop" "while routing"
1468 A router that accepts an address may assign it to a local or a remote
1469 transport. However, the transport is not run at this time. Instead, the address
1470 is placed on a list for the particular transport, which will be run later.
1471 Alternatively, the router may generate one or more new addresses (typically
1472 from alias, forward, or filter files). New addresses are fed back into this
1473 process from the top, but in order to avoid loops, a router ignores any address
1474 which has an identically-named ancestor that was processed by itself.
1475 .next
1476 When all the routing has been done, addresses that have been successfully
1477 handled are passed to their assigned transports. When local transports are
1478 doing real local deliveries, they handle only one address at a time, but if a
1479 local transport is being used as a pseudo-remote transport (for example, to
1480 collect batched SMTP messages for transmission by some other means) multiple
1481 addresses can be handled. Remote transports can always handle more than one
1482 address at a time, but can be configured not to do so, or to restrict multiple
1483 addresses to the same domain.
1484 .next
1485 Each local delivery to a file or a pipe runs in a separate process under a
1486 non-privileged uid, and these deliveries are run one at a time. Remote
1487 deliveries also run in separate processes, normally under a uid that is private
1488 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1489 run in parallel. The maximum number of simultaneous remote deliveries for any
1490 one message is set by the &%remote_max_parallel%& option.
1491 The order in which deliveries are done is not defined, except that all local
1492 deliveries happen before any remote deliveries.
1493 .next
1494 .cindex "queue runner"
1495 When it encounters a local delivery during a queue run, Exim checks its retry
1496 database to see if there has been a previous temporary delivery failure for the
1497 address before running the local transport. If there was a previous failure,
1498 Exim does not attempt a new delivery until the retry time for the address is
1499 reached. However, this happens only for delivery attempts that are part of a
1500 queue run. Local deliveries are always attempted when delivery immediately
1501 follows message reception, even if retry times are set for them. This makes for
1502 better behaviour if one particular message is causing problems (for example,
1503 causing quota overflow, or provoking an error in a filter file).
1504 .next
1505 .cindex "delivery" "retry in remote transports"
1506 Remote transports do their own retry handling, since an address may be
1507 deliverable to one of a number of hosts, each of which may have a different
1508 retry time. If there have been previous temporary failures and no host has
1509 reached its retry time, no delivery is attempted, whether in a queue run or
1510 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1511 .next
1512 If there were any permanent errors, a bounce message is returned to an
1513 appropriate address (the sender in the common case), with details of the error
1514 for each failing address. Exim can be configured to send copies of bounce
1515 messages to other addresses.
1516 .next
1517 .cindex "delivery" "deferral"
1518 If one or more addresses suffered a temporary failure, the message is left on
1519 the queue, to be tried again later. Delivery of these addresses is said to be
1520 &'deferred'&.
1521 .next
1522 When all the recipient addresses have either been delivered or bounced,
1523 handling of the message is complete. The spool files and message log are
1524 deleted, though the message log can optionally be preserved if required.
1525 .endlist
1526
1527
1528
1529
1530 .section "Retry mechanism" "SECID19"
1531 .cindex "delivery" "retry mechanism"
1532 .cindex "retry" "description of mechanism"
1533 .cindex "queue runner"
1534 Exim's mechanism for retrying messages that fail to get delivered at the first
1535 attempt is the queue runner process. You must either run an Exim daemon that
1536 uses the &%-q%& option with a time interval to start queue runners at regular
1537 intervals, or use some other means (such as &'cron'&) to start them. If you do
1538 not arrange for queue runners to be run, messages that fail temporarily at the
1539 first attempt will remain on your queue for ever. A queue runner process works
1540 its way through the queue, one message at a time, trying each delivery that has
1541 passed its retry time.
1542 You can run several queue runners at once.
1543
1544 Exim uses a set of configured rules to determine when next to retry the failing
1545 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1546 should give up trying to deliver to the address, at which point it generates a
1547 bounce message. If no retry rules are set for a particular host, address, and
1548 error combination, no retries are attempted, and temporary errors are treated
1549 as permanent.
1550
1551
1552
1553 .section "Temporary delivery failure" "SECID20"
1554 .cindex "delivery" "temporary failure"
1555 There are many reasons why a message may not be immediately deliverable to a
1556 particular address. Failure to connect to a remote machine (because it, or the
1557 connection to it, is down) is one of the most common. Temporary failures may be
1558 detected during routing as well as during the transport stage of delivery.
1559 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1560 is on a file system where the user is over quota. Exim can be configured to
1561 impose its own quotas on local mailboxes; where system quotas are set they will
1562 also apply.
1563
1564 If a host is unreachable for a period of time, a number of messages may be
1565 waiting for it by the time it recovers, and sending them in a single SMTP
1566 connection is clearly beneficial. Whenever a delivery to a remote host is
1567 deferred,
1568 .cindex "hints database" "deferred deliveries"
1569 Exim makes a note in its hints database, and whenever a successful
1570 SMTP delivery has happened, it looks to see if any other messages are waiting
1571 for the same host. If any are found, they are sent over the same SMTP
1572 connection, subject to a configuration limit as to the maximum number in any
1573 one connection.
1574
1575
1576
1577 .section "Permanent delivery failure" "SECID21"
1578 .cindex "delivery" "permanent failure"
1579 .cindex "bounce message" "when generated"
1580 When a message cannot be delivered to some or all of its intended recipients, a
1581 bounce message is generated. Temporary delivery failures turn into permanent
1582 errors when their timeout expires. All the addresses that fail in a given
1583 delivery attempt are listed in a single message. If the original message has
1584 many recipients, it is possible for some addresses to fail in one delivery
1585 attempt and others to fail subsequently, giving rise to more than one bounce
1586 message. The wording of bounce messages can be customized by the administrator.
1587 See chapter &<<CHAPemsgcust>>& for details.
1588
1589 .cindex "&'X-Failed-Recipients:'& header line"
1590 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1591 failed addresses, for the benefit of programs that try to analyse such messages
1592 automatically.
1593
1594 .cindex "bounce message" "recipient of"
1595 A bounce message is normally sent to the sender of the original message, as
1596 obtained from the message's envelope. For incoming SMTP messages, this is the
1597 address given in the MAIL command. However, when an address is expanded via a
1598 forward or alias file, an alternative address can be specified for delivery
1599 failures of the generated addresses. For a mailing list expansion (see section
1600 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1601 of the list.
1602
1603
1604
1605 .section "Failures to deliver bounce messages" "SECID22"
1606 .cindex "bounce message" "failure to deliver"
1607 If a bounce message (either locally generated or received from a remote host)
1608 itself suffers a permanent delivery failure, the message is left on the queue,
1609 but it is frozen, awaiting the attention of an administrator. There are options
1610 that can be used to make Exim discard such failed messages, or to keep them
1611 for only a short time (see &%timeout_frozen_after%& and
1612 &%ignore_bounce_errors_after%&).
1613
1614
1615
1616
1617
1618 . ////////////////////////////////////////////////////////////////////////////
1619 . ////////////////////////////////////////////////////////////////////////////
1620
1621 .chapter "Building and installing Exim" "CHID3"
1622 .scindex IIDbuex "building Exim"
1623
1624 .section "Unpacking" "SECID23"
1625 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1626 creates a directory with the name of the current release (for example,
1627 &_exim-&version()_&) into which the following files are placed:
1628
1629 .table2 140pt
1630 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1631 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1632   documented"
1633 .irow &_LICENCE_&         "the GNU General Public Licence"
1634 .irow &_Makefile_&        "top-level make file"
1635 .irow &_NOTICE_&          "conditions for the use of Exim"
1636 .irow &_README_&          "list of files, directories and simple build &&&
1637   instructions"
1638 .endtable
1639
1640 Other files whose names begin with &_README_& may also be present. The
1641 following subdirectories are created:
1642
1643 .table2 140pt
1644 .irow &_Local_&           "an empty directory for local configuration files"
1645 .irow &_OS_&              "OS-specific files"
1646 .irow &_doc_&             "documentation files"
1647 .irow &_exim_monitor_&    "source files for the Exim monitor"
1648 .irow &_scripts_&         "scripts used in the build process"
1649 .irow &_src_&             "remaining source files"
1650 .irow &_util_&            "independent utilities"
1651 .endtable
1652
1653 The main utility programs are contained in the &_src_& directory, and are built
1654 with the Exim binary. The &_util_& directory contains a few optional scripts
1655 that may be useful to some sites.
1656
1657
1658 .section "Multiple machine architectures and operating systems" "SECID24"
1659 .cindex "building Exim" "multiple OS/architectures"
1660 The building process for Exim is arranged to make it easy to build binaries for
1661 a number of different architectures and operating systems from the same set of
1662 source files. Compilation does not take place in the &_src_& directory.
1663 Instead, a &'build directory'& is created for each architecture and operating
1664 system.
1665 .cindex "symbolic link" "to build directory"
1666 Symbolic links to the sources are installed in this directory, which is where
1667 the actual building takes place. In most cases, Exim can discover the machine
1668 architecture and operating system for itself, but the defaults can be
1669 overridden if necessary.
1670 .cindex compiler requirements
1671 .cindex compiler version
1672 A C99-capable compiler will be required for the build.
1673
1674
1675 .section "PCRE library" "SECTpcre"
1676 .cindex "PCRE library"
1677 Exim no longer has an embedded PCRE library as the vast majority of
1678 modern systems include PCRE as a system library, although you may need
1679 to install the PCRE or PCRE development package for your operating
1680 system. If your system has a normal PCRE installation the Exim build
1681 process will need no further configuration. If the library or the
1682 headers are in an unusual location you will need to either set the PCRE_LIBS
1683 and INCLUDE directives appropriately,
1684 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1685 If your operating system has no
1686 PCRE support then you will need to obtain and build the current PCRE
1687 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1688 More information on PCRE is available at &url(http://www.pcre.org/).
1689
1690 .section "DBM libraries" "SECTdb"
1691 .cindex "DBM libraries" "discussion of"
1692 .cindex "hints database" "DBM files used for"
1693 Even if you do not use any DBM files in your configuration, Exim still needs a
1694 DBM library in order to operate, because it uses indexed files for its hints
1695 databases. Unfortunately, there are a number of DBM libraries in existence, and
1696 different operating systems often have different ones installed.
1697
1698 .cindex "Solaris" "DBM library for"
1699 .cindex "IRIX, DBM library for"
1700 .cindex "BSD, DBM library for"
1701 .cindex "Linux, DBM library for"
1702 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1703 Linux distribution, the DBM configuration should happen automatically, and you
1704 may be able to ignore this section. Otherwise, you may have to learn more than
1705 you would like about DBM libraries from what follows.
1706
1707 .cindex "&'ndbm'& DBM library"
1708 Licensed versions of Unix normally contain a library of DBM functions operating
1709 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1710 versions of Unix seem to vary in what they contain as standard. In particular,
1711 some early versions of Linux have no default DBM library, and different
1712 distributors have chosen to bundle different libraries with their packaged
1713 versions. However, the more recent releases seem to have standardized on the
1714 Berkeley DB library.
1715
1716 Different DBM libraries have different conventions for naming the files they
1717 use. When a program opens a file called &_dbmfile_&, there are several
1718 possibilities:
1719
1720 .olist
1721 A traditional &'ndbm'& implementation, such as that supplied as part of
1722 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1723 .next
1724 .cindex "&'gdbm'& DBM library"
1725 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1726 compatibility interface it makes two different hard links to it with names
1727 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1728 file name is used unmodified.
1729 .next
1730 .cindex "Berkeley DB library"
1731 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1732 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1733 programmer exactly the same as the traditional &'ndbm'& implementation.
1734 .next
1735 If the Berkeley package is used in its native mode, it operates on a single
1736 file called &_dbmfile_&; the programmer's interface is somewhat different to
1737 the traditional &'ndbm'& interface.
1738 .next
1739 To complicate things further, there are several very different versions of the
1740 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1741 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1742 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1743 versions of Berkeley DB can be obtained from
1744 &url(http://www.sleepycat.com/).
1745 .next
1746 .cindex "&'tdb'& DBM library"
1747 Yet another DBM library, called &'tdb'&, is available from
1748 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1749 operates on a single file.
1750 .endlist
1751
1752 .cindex "USE_DB"
1753 .cindex "DBM libraries" "configuration for building"
1754 Exim and its utilities can be compiled to use any of these interfaces. In order
1755 to use any version of the Berkeley DB package in native mode, you must set
1756 USE_DB in an appropriate configuration file (typically
1757 &_Local/Makefile_&). For example:
1758 .code
1759 USE_DB=yes
1760 .endd
1761 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1762 error is diagnosed if you set more than one of these.
1763
1764 At the lowest level, the build-time configuration sets none of these options,
1765 thereby assuming an interface of type (1). However, some operating system
1766 configuration files (for example, those for the BSD operating systems and
1767 Linux) assume type (4) by setting USE_DB as their default, and the
1768 configuration files for Cygwin set USE_GDBM. Anything you set in
1769 &_Local/Makefile_&, however, overrides these system defaults.
1770
1771 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1772 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1773 in one of these lines:
1774 .code
1775 DBMLIB = -ldb
1776 DBMLIB = -ltdb
1777 .endd
1778 Settings like that will work if the DBM library is installed in the standard
1779 place. Sometimes it is not, and the library's header file may also not be in
1780 the default path. You may need to set INCLUDE to specify where the header
1781 file is, and to specify the path to the library more fully in DBMLIB, as in
1782 this example:
1783 .code
1784 INCLUDE=-I/usr/local/include/db-4.1
1785 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1786 .endd
1787 There is further detailed discussion about the various DBM libraries in the
1788 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1789
1790
1791
1792 .section "Pre-building configuration" "SECID25"
1793 .cindex "building Exim" "pre-building configuration"
1794 .cindex "configuration for building Exim"
1795 .cindex "&_Local/Makefile_&"
1796 .cindex "&_src/EDITME_&"
1797 Before building Exim, a local configuration file that specifies options
1798 independent of any operating system has to be created with the name
1799 &_Local/Makefile_&. A template for this file is supplied as the file
1800 &_src/EDITME_&, and it contains full descriptions of all the option settings
1801 therein. These descriptions are therefore not repeated here. If you are
1802 building Exim for the first time, the simplest thing to do is to copy
1803 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1804
1805 There are three settings that you must supply, because Exim will not build
1806 without them. They are the location of the run time configuration file
1807 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1808 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1809 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1810 a colon-separated list of file names; Exim uses the first of them that exists.
1811
1812 There are a few other parameters that can be specified either at build time or
1813 at run time, to enable the same binary to be used on a number of different
1814 machines. However, if the locations of Exim's spool directory and log file
1815 directory (if not within the spool directory) are fixed, it is recommended that
1816 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1817 detected early in Exim's execution (such as a malformed configuration file) can
1818 be logged.
1819
1820 .cindex "content scanning" "specifying at build time"
1821 Exim's interfaces for calling virus and spam scanning software directly from
1822 access control lists are not compiled by default. If you want to include these
1823 facilities, you need to set
1824 .code
1825 WITH_CONTENT_SCAN=yes
1826 .endd
1827 in your &_Local/Makefile_&. For details of the facilities themselves, see
1828 chapter &<<CHAPexiscan>>&.
1829
1830
1831 .cindex "&_Local/eximon.conf_&"
1832 .cindex "&_exim_monitor/EDITME_&"
1833 If you are going to build the Exim monitor, a similar configuration process is
1834 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1835 your installation and saved under the name &_Local/eximon.conf_&. If you are
1836 happy with the default settings described in &_exim_monitor/EDITME_&,
1837 &_Local/eximon.conf_& can be empty, but it must exist.
1838
1839 This is all the configuration that is needed in straightforward cases for known
1840 operating systems. However, the building process is set up so that it is easy
1841 to override options that are set by default or by operating-system-specific
1842 configuration files, for example to change the name of the C compiler, which
1843 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1844 do this.
1845
1846
1847
1848 .section "Support for iconv()" "SECID26"
1849 .cindex "&[iconv()]& support"
1850 .cindex "RFC 2047"
1851 The contents of header lines in messages may be encoded according to the rules
1852 described RFC 2047. This makes it possible to transmit characters that are not
1853 in the ASCII character set, and to label them as being in a particular
1854 character set. When Exim is inspecting header lines by means of the &%$h_%&
1855 mechanism, it decodes them, and translates them into a specified character set
1856 (default is set at build time). The translation is possible only if the operating system
1857 supports the &[iconv()]& function.
1858
1859 However, some of the operating systems that supply &[iconv()]& do not support
1860 very many conversions. The GNU &%libiconv%& library (available from
1861 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1862 systems to remedy this deficiency, as well as on systems that do not supply
1863 &[iconv()]& at all. After installing &%libiconv%&, you should add
1864 .code
1865 HAVE_ICONV=yes
1866 .endd
1867 to your &_Local/Makefile_& and rebuild Exim.
1868
1869
1870
1871 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1872 .cindex "TLS" "including support for TLS"
1873 .cindex "encryption" "including support for"
1874 .cindex "SUPPORT_TLS"
1875 .cindex "OpenSSL" "building Exim with"
1876 .cindex "GnuTLS" "building Exim with"
1877 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1878 command as per RFC 2487. It can also support legacy clients that expect to
1879 start a TLS session immediately on connection to a non-standard port (see the
1880 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1881 line option).
1882
1883 If you want to build Exim with TLS support, you must first install either the
1884 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1885 implementing SSL.
1886
1887 If OpenSSL is installed, you should set
1888 .code
1889 SUPPORT_TLS=yes
1890 TLS_LIBS=-lssl -lcrypto
1891 .endd
1892 in &_Local/Makefile_&. You may also need to specify the locations of the
1893 OpenSSL library and include files. For example:
1894 .code
1895 SUPPORT_TLS=yes
1896 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1897 TLS_INCLUDE=-I/usr/local/openssl/include/
1898 .endd
1899 .cindex "pkg-config" "OpenSSL"
1900 If you have &'pkg-config'& available, then instead you can just use:
1901 .code
1902 SUPPORT_TLS=yes
1903 USE_OPENSSL_PC=openssl
1904 .endd
1905 .cindex "USE_GNUTLS"
1906 If GnuTLS is installed, you should set
1907 .code
1908 SUPPORT_TLS=yes
1909 USE_GNUTLS=yes
1910 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1911 .endd
1912 in &_Local/Makefile_&, and again you may need to specify the locations of the
1913 library and include files. For example:
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1918 TLS_INCLUDE=-I/usr/gnu/include
1919 .endd
1920 .cindex "pkg-config" "GnuTLS"
1921 If you have &'pkg-config'& available, then instead you can just use:
1922 .code
1923 SUPPORT_TLS=yes
1924 USE_GNUTLS=yes
1925 USE_GNUTLS_PC=gnutls
1926 .endd
1927
1928 You do not need to set TLS_INCLUDE if the relevant directory is already
1929 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1930 given in chapter &<<CHAPTLS>>&.
1931
1932
1933
1934
1935 .section "Use of tcpwrappers" "SECID27"
1936
1937 .cindex "tcpwrappers, building Exim to support"
1938 .cindex "USE_TCP_WRAPPERS"
1939 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1940 .cindex "tcp_wrappers_daemon_name"
1941 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1942 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1943 alternative to Exim's own checking facilities for installations that are
1944 already making use of &'tcpwrappers'& for other purposes. To do this, you
1945 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1946 &_tcpd.h_& to be available at compile time, and also ensure that the library
1947 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1948 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1949 you might have
1950 .code
1951 USE_TCP_WRAPPERS=yes
1952 CFLAGS=-O -I/usr/local/include
1953 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1954 .endd
1955 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1956 files is &"exim"&. For example, the line
1957 .code
1958 exim : LOCAL  192.168.1.  .friendly.domain.example
1959 .endd
1960 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1961 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1962 All other connections are denied. The daemon name used by &'tcpwrappers'&
1963 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1964 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1965 configure file. Consult the &'tcpwrappers'& documentation for
1966 further details.
1967
1968
1969 .section "Including support for IPv6" "SECID28"
1970 .cindex "IPv6" "including support for"
1971 Exim contains code for use on systems that have IPv6 support. Setting
1972 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1973 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1974 where the IPv6 support is not fully integrated into the normal include and
1975 library files.
1976
1977 Two different types of DNS record for handling IPv6 addresses have been
1978 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1979 currently seen as the mainstream. Another record type called A6 was proposed
1980 as better than AAAA because it had more flexibility. However, it was felt to be
1981 over-complex, and its status was reduced to &"experimental"&.
1982 Exim used to
1983 have a compile option for including A6 record support but this has now been
1984 withdrawn.
1985
1986
1987
1988 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1989 .cindex "lookup modules"
1990 .cindex "dynamic modules"
1991 .cindex ".so building"
1992 On some platforms, Exim supports not compiling all lookup types directly into
1993 the main binary, instead putting some into external modules which can be loaded
1994 on demand.
1995 This permits packagers to build Exim with support for lookups with extensive
1996 library dependencies without requiring all users to install all of those
1997 dependencies.
1998 Most, but not all, lookup types can be built this way.
1999
2000 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2001 installed; Exim will only load modules from that directory, as a security
2002 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2003 for your OS; see &_OS/Makefile-Linux_& for an example.
2004 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2005 see &_src/EDITME_& for details.
2006
2007 Then, for each module to be loaded dynamically, define the relevant
2008 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2009 For example, this will build in lsearch but load sqlite and mysql support
2010 on demand:
2011 .code
2012 LOOKUP_LSEARCH=yes
2013 LOOKUP_SQLITE=2
2014 LOOKUP_MYSQL=2
2015 .endd
2016
2017
2018 .section "The building process" "SECID29"
2019 .cindex "build directory"
2020 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2021 created, run &'make'& at the top level. It determines the architecture and
2022 operating system types, and creates a build directory if one does not exist.
2023 For example, on a Sun system running Solaris 8, the directory
2024 &_build-SunOS5-5.8-sparc_& is created.
2025 .cindex "symbolic link" "to source files"
2026 Symbolic links to relevant source files are installed in the build directory.
2027
2028 If this is the first time &'make'& has been run, it calls a script that builds
2029 a make file inside the build directory, using the configuration files from the
2030 &_Local_& directory. The new make file is then passed to another instance of
2031 &'make'&. This does the real work, building a number of utility scripts, and
2032 then compiling and linking the binaries for the Exim monitor (if configured), a
2033 number of utility programs, and finally Exim itself. The command &`make
2034 makefile`& can be used to force a rebuild of the make file in the build
2035 directory, should this ever be necessary.
2036
2037 If you have problems building Exim, check for any comments there may be in the
2038 &_README_& file concerning your operating system, and also take a look at the
2039 FAQ, where some common problems are covered.
2040
2041
2042
2043 .section 'Output from &"make"&' "SECID283"
2044 The output produced by the &'make'& process for compile lines is often very
2045 unreadable, because these lines can be very long. For this reason, the normal
2046 output is suppressed by default, and instead output similar to that which
2047 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2048 each module that is being compiled or linked. However, it is still possible to
2049 get the full output, by calling &'make'& like this:
2050 .code
2051 FULLECHO='' make -e
2052 .endd
2053 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2054 command reflection in &'make'&. When you ask for the full output, it is
2055 given in addition to the short output.
2056
2057
2058
2059 .section "Overriding build-time options for Exim" "SECToverride"
2060 .cindex "build-time options, overriding"
2061 The main make file that is created at the beginning of the building process
2062 consists of the concatenation of a number of files which set configuration
2063 values, followed by a fixed set of &'make'& instructions. If a value is set
2064 more than once, the last setting overrides any previous ones. This provides a
2065 convenient way of overriding defaults. The files that are concatenated are, in
2066 order:
2067 .display
2068 &_OS/Makefile-Default_&
2069 &_OS/Makefile-_&<&'ostype'&>
2070 &_Local/Makefile_&
2071 &_Local/Makefile-_&<&'ostype'&>
2072 &_Local/Makefile-_&<&'archtype'&>
2073 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2074 &_OS/Makefile-Base_&
2075 .endd
2076 .cindex "&_Local/Makefile_&"
2077 .cindex "building Exim" "operating system type"
2078 .cindex "building Exim" "architecture type"
2079 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2080 architecture type. &_Local/Makefile_& is required to exist, and the building
2081 process fails if it is absent. The other three &_Local_& files are optional,
2082 and are often not needed.
2083
2084 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2085 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2086 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2087 values are used, thereby providing a means of forcing particular settings.
2088 Otherwise, the scripts try to get values from the &%uname%& command. If this
2089 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2090 of &'ad hoc'& transformations are then applied, to produce the standard names
2091 that Exim expects. You can run these scripts directly from the shell in order
2092 to find out what values are being used on your system.
2093
2094
2095 &_OS/Makefile-Default_& contains comments about the variables that are set
2096 therein. Some (but not all) are mentioned below. If there is something that
2097 needs changing, review the contents of this file and the contents of the make
2098 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2099 default values are.
2100
2101
2102 .cindex "building Exim" "overriding default settings"
2103 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2104 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2105 need to change the original files. Instead, you should make the changes by
2106 putting the new values in an appropriate &_Local_& file. For example,
2107 .cindex "Tru64-Unix build-time settings"
2108 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2109 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2110 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2111 called with the option &%-std1%&, to make it recognize some of the features of
2112 Standard C that Exim uses. (Most other compilers recognize Standard C by
2113 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2114 containing the lines
2115 .code
2116 CC=cc
2117 CFLAGS=-std1
2118 .endd
2119 If you are compiling for just one operating system, it may be easier to put
2120 these lines directly into &_Local/Makefile_&.
2121
2122 Keeping all your local configuration settings separate from the distributed
2123 files makes it easy to transfer them to new versions of Exim simply by copying
2124 the contents of the &_Local_& directory.
2125
2126
2127 .cindex "NIS lookup type" "including support for"
2128 .cindex "NIS+ lookup type" "including support for"
2129 .cindex "LDAP" "including support for"
2130 .cindex "lookup" "inclusion in binary"
2131 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2132 lookup, but not all systems have these components installed, so the default is
2133 not to include the relevant code in the binary. All the different kinds of file
2134 and database lookup that Exim supports are implemented as separate code modules
2135 which are included only if the relevant compile-time options are set. In the
2136 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2137 .code
2138 LOOKUP_LDAP=yes
2139 LOOKUP_NIS=yes
2140 LOOKUP_NISPLUS=yes
2141 .endd
2142 and similar settings apply to the other lookup types. They are all listed in
2143 &_src/EDITME_&. In many cases the relevant include files and interface
2144 libraries need to be installed before compiling Exim.
2145 .cindex "cdb" "including support for"
2146 However, there are some optional lookup types (such as cdb) for which
2147 the code is entirely contained within Exim, and no external include
2148 files or libraries are required. When a lookup type is not included in the
2149 binary, attempts to configure Exim to use it cause run time configuration
2150 errors.
2151
2152 .cindex "pkg-config" "lookups"
2153 .cindex "pkg-config" "authenticators"
2154 Many systems now use a tool called &'pkg-config'& to encapsulate information
2155 about how to compile against a library; Exim has some initial support for
2156 being able to use pkg-config for lookups and authenticators.  For any given
2157 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2158 variable with the &`_PC`& suffix in the name and assign as the value the
2159 name of the package to be queried.  The results of querying via the
2160 &'pkg-config'& command will be added to the appropriate Makefile variables
2161 with &`+=`& directives, so your version of &'make'& will need to support that
2162 syntax.  For instance:
2163 .code
2164 LOOKUP_SQLITE=yes
2165 LOOKUP_SQLITE_PC=sqlite3
2166 AUTH_GSASL=yes
2167 AUTH_GSASL_PC=libgsasl
2168 AUTH_HEIMDAL_GSSAPI=yes
2169 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2170 .endd
2171
2172 .cindex "Perl" "including support for"
2173 Exim can be linked with an embedded Perl interpreter, allowing Perl
2174 subroutines to be called during string expansion. To enable this facility,
2175 .code
2176 EXIM_PERL=perl.o
2177 .endd
2178 must be defined in &_Local/Makefile_&. Details of this facility are given in
2179 chapter &<<CHAPperl>>&.
2180
2181 .cindex "X11 libraries, location of"
2182 The location of the X11 libraries is something that varies a lot between
2183 operating systems, and there may be different versions of X11 to cope
2184 with. Exim itself makes no use of X11, but if you are compiling the Exim
2185 monitor, the X11 libraries must be available.
2186 The following three variables are set in &_OS/Makefile-Default_&:
2187 .code
2188 X11=/usr/X11R6
2189 XINCLUDE=-I$(X11)/include
2190 XLFLAGS=-L$(X11)/lib
2191 .endd
2192 These are overridden in some of the operating-system configuration files. For
2193 example, in &_OS/Makefile-SunOS5_& there is
2194 .code
2195 X11=/usr/openwin
2196 XINCLUDE=-I$(X11)/include
2197 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2198 .endd
2199 If you need to override the default setting for your operating system, place a
2200 definition of all three of these variables into your
2201 &_Local/Makefile-<ostype>_& file.
2202
2203 .cindex "EXTRALIBS"
2204 If you need to add any extra libraries to the link steps, these can be put in a
2205 variable called EXTRALIBS, which appears in all the link commands, but by
2206 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2207 command for linking the main Exim binary, and not for any associated utilities.
2208
2209 .cindex "DBM libraries" "configuration for building"
2210 There is also DBMLIB, which appears in the link commands for binaries that
2211 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2212 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2213 binary, and which can be used, for example, to include additional X11
2214 libraries.
2215
2216 .cindex "configuration file" "editing"
2217 The make file copes with rebuilding Exim correctly if any of the configuration
2218 files are edited. However, if an optional configuration file is deleted, it is
2219 necessary to touch the associated non-optional file (that is,
2220 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2221
2222
2223 .section "OS-specific header files" "SECID30"
2224 .cindex "&_os.h_&"
2225 .cindex "building Exim" "OS-specific C header files"
2226 The &_OS_& directory contains a number of files with names of the form
2227 &_os.h-<ostype>_&. These are system-specific C header files that should not
2228 normally need to be changed. There is a list of macro settings that are
2229 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2230 are porting Exim to a new operating system.
2231
2232
2233
2234 .section "Overriding build-time options for the monitor" "SECID31"
2235 .cindex "building Eximon"
2236 A similar process is used for overriding things when building the Exim monitor,
2237 where the files that are involved are
2238 .display
2239 &_OS/eximon.conf-Default_&
2240 &_OS/eximon.conf-_&<&'ostype'&>
2241 &_Local/eximon.conf_&
2242 &_Local/eximon.conf-_&<&'ostype'&>
2243 &_Local/eximon.conf-_&<&'archtype'&>
2244 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2245 .endd
2246 .cindex "&_Local/eximon.conf_&"
2247 As with Exim itself, the final three files need not exist, and in this case the
2248 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2249 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2250 variables of the same name, preceded by EXIMON_. For example, setting
2251 EXIMON_LOG_DEPTH in the environment overrides the value of
2252 LOG_DEPTH at run time.
2253 .ecindex IIDbuex
2254
2255
2256 .section "Installing Exim binaries and scripts" "SECID32"
2257 .cindex "installing Exim"
2258 .cindex "BIN_DIRECTORY"
2259 The command &`make install`& runs the &(exim_install)& script with no
2260 arguments. The script copies binaries and utility scripts into the directory
2261 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2262 .cindex "setuid" "installing Exim with"
2263 The install script copies files only if they are newer than the files they are
2264 going to replace. The Exim binary is required to be owned by root and have the
2265 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2266 install`& as root so that it can set up the Exim binary in this way. However, in
2267 some special situations (for example, if a host is doing no local deliveries)
2268 it may be possible to run Exim without making the binary setuid root (see
2269 chapter &<<CHAPsecurity>>& for details).
2270
2271 .cindex "CONFIGURE_FILE"
2272 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2273 in &_Local/Makefile_&. If this names a single file, and the file does not
2274 exist, the default configuration file &_src/configure.default_& is copied there
2275 by the installation script. If a run time configuration file already exists, it
2276 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2277 alternative files, no default is installed.
2278
2279 .cindex "system aliases file"
2280 .cindex "&_/etc/aliases_&"
2281 One change is made to the default configuration file when it is installed: the
2282 default configuration contains a router that references a system aliases file.
2283 The path to this file is set to the value specified by
2284 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2285 If the system aliases file does not exist, the installation script creates it,
2286 and outputs a comment to the user.
2287
2288 The created file contains no aliases, but it does contain comments about the
2289 aliases a site should normally have. Mail aliases have traditionally been
2290 kept in &_/etc/aliases_&. However, some operating systems are now using
2291 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2292 Exim's configuration if necessary.
2293
2294 The default configuration uses the local host's name as the only local domain,
2295 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2296 running as the local user. System aliases and &_.forward_& files in users' home
2297 directories are supported, but no NIS or NIS+ support is configured. Domains
2298 other than the name of the local host are routed using the DNS, with delivery
2299 over SMTP.
2300
2301 It is possible to install Exim for special purposes (such as building a binary
2302 distribution) in a private part of the file system. You can do this by a
2303 command such as
2304 .code
2305 make DESTDIR=/some/directory/ install
2306 .endd
2307 This has the effect of pre-pending the specified directory to all the file
2308 paths, except the name of the system aliases file that appears in the default
2309 configuration. (If a default alias file is created, its name &'is'& modified.)
2310 For backwards compatibility, ROOT is used if DESTDIR is not set,
2311 but this usage is deprecated.
2312
2313 .cindex "installing Exim" "what is not installed"
2314 Running &'make install'& does not copy the Exim 4 conversion script
2315 &'convert4r4'&. You will probably run this only once if you are
2316 upgrading from Exim 3. None of the documentation files in the &_doc_&
2317 directory are copied, except for the info files when you have set
2318 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2319
2320 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2321 to their names. The Exim binary itself, however, is handled differently. It is
2322 installed under a name that includes the version number and the compile number,
2323 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2324 called &_exim_& to point to the binary. If you are updating a previous version
2325 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2326 from the directory (as seen by other processes).
2327
2328 .cindex "installing Exim" "testing the script"
2329 If you want to see what the &'make install'& will do before running it for
2330 real, you can pass the &%-n%& option to the installation script by this
2331 command:
2332 .code
2333 make INSTALL_ARG=-n install
2334 .endd
2335 The contents of the variable INSTALL_ARG are passed to the installation
2336 script. You do not need to be root to run this test. Alternatively, you can run
2337 the installation script directly, but this must be from within the build
2338 directory. For example, from the top-level Exim directory you could use this
2339 command:
2340 .code
2341 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2342 .endd
2343 .cindex "installing Exim" "install script options"
2344 There are two other options that can be supplied to the installation script.
2345
2346 .ilist
2347 &%-no_chown%& bypasses the call to change the owner of the installed binary
2348 to root, and the call to make it a setuid binary.
2349 .next
2350 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2351 installed binary.
2352 .endlist
2353
2354 INSTALL_ARG can be used to pass these options to the script. For example:
2355 .code
2356 make INSTALL_ARG=-no_symlink install
2357 .endd
2358 The installation script can also be given arguments specifying which files are
2359 to be copied. For example, to install just the Exim binary, and nothing else,
2360 without creating the symbolic link, you could use:
2361 .code
2362 make INSTALL_ARG='-no_symlink exim' install
2363 .endd
2364
2365
2366
2367 .section "Installing info documentation" "SECTinsinfdoc"
2368 .cindex "installing Exim" "&'info'& documentation"
2369 Not all systems use the GNU &'info'& system for documentation, and for this
2370 reason, the Texinfo source of Exim's documentation is not included in the main
2371 distribution. Instead it is available separately from the ftp site (see section
2372 &<<SECTavail>>&).
2373
2374 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2375 source of the documentation is found in the source tree, running &`make
2376 install`& automatically builds the info files and installs them.
2377
2378
2379
2380 .section "Setting up the spool directory" "SECID33"
2381 .cindex "spool directory" "creating"
2382 When it starts up, Exim tries to create its spool directory if it does not
2383 exist. The Exim uid and gid are used for the owner and group of the spool
2384 directory. Sub-directories are automatically created in the spool directory as
2385 necessary.
2386
2387
2388
2389
2390 .section "Testing" "SECID34"
2391 .cindex "testing" "installation"
2392 Having installed Exim, you can check that the run time configuration file is
2393 syntactically valid by running the following command, which assumes that the
2394 Exim binary directory is within your PATH environment variable:
2395 .code
2396 exim -bV
2397 .endd
2398 If there are any errors in the configuration file, Exim outputs error messages.
2399 Otherwise it outputs the version number and build date,
2400 the DBM library that is being used, and information about which drivers and
2401 other optional code modules are included in the binary.
2402 Some simple routing tests can be done by using the address testing option. For
2403 example,
2404 .display
2405 &`exim -bt`& <&'local username'&>
2406 .endd
2407 should verify that it recognizes a local mailbox, and
2408 .display
2409 &`exim -bt`& <&'remote address'&>
2410 .endd
2411 a remote one. Then try getting it to deliver mail, both locally and remotely.
2412 This can be done by passing messages directly to Exim, without going through a
2413 user agent. For example:
2414 .code
2415 exim -v postmaster@your.domain.example
2416 From: user@your.domain.example
2417 To: postmaster@your.domain.example
2418 Subject: Testing Exim
2419
2420 This is a test message.
2421 ^D
2422 .endd
2423 The &%-v%& option causes Exim to output some verification of what it is doing.
2424 In this case you should see copies of three log lines, one for the message's
2425 arrival, one for its delivery, and one containing &"Completed"&.
2426
2427 .cindex "delivery" "problems with"
2428 If you encounter problems, look at Exim's log files (&'mainlog'& and
2429 &'paniclog'&) to see if there is any relevant information there. Another source
2430 of information is running Exim with debugging turned on, by specifying the
2431 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2432 with debugging turned on by a command of the form
2433 .display
2434 &`exim -d -M`& <&'exim-message-id'&>
2435 .endd
2436 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2437 produces rather a lot of output, but you can cut this down to specific areas.
2438 For example, if you use &%-d-all+route%& only the debugging information
2439 relevant to routing is included. (See the &%-d%& option in chapter
2440 &<<CHAPcommandline>>& for more details.)
2441
2442 .cindex '&"sticky"& bit'
2443 .cindex "lock files"
2444 One specific problem that has shown up on some sites is the inability to do
2445 local deliveries into a shared mailbox directory, because it does not have the
2446 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2447 writing to a mailbox file, and if it cannot create the lock file, the delivery
2448 is deferred. You can get round this either by setting the &"sticky bit"& on the
2449 directory, or by setting a specific group for local deliveries and allowing
2450 that group to create files in the directory (see the comments above the
2451 &(local_delivery)& transport in the default configuration file). Another
2452 approach is to configure Exim not to use lock files, but just to rely on
2453 &[fcntl()]& locking instead. However, you should do this only if all user
2454 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2455 see chapter &<<CHAPappendfile>>&.
2456
2457 One thing that cannot be tested on a system that is already running an MTA is
2458 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2459 &%-oX%& option can be used to run an Exim daemon that listens on some other
2460 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2461 &'exim_checkaccess'& utility can be used to check out policy controls on
2462 incoming SMTP mail.
2463
2464 Testing a new version on a system that is already running Exim can most easily
2465 be done by building a binary with a different CONFIGURE_FILE setting. From
2466 within the run time configuration, all other file and directory names
2467 that Exim uses can be altered, in order to keep it entirely clear of the
2468 production version.
2469
2470
2471 .section "Replacing another MTA with Exim" "SECID35"
2472 .cindex "replacing another MTA"
2473 Building and installing Exim for the first time does not of itself put it in
2474 general use. The name by which the system's MTA is called by mail user agents
2475 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2476 operating system), and it is necessary to make this name point to the &'exim'&
2477 binary in order to get the user agents to pass messages to Exim. This is
2478 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2479 or &_/usr/lib/sendmail_&
2480 .cindex "symbolic link" "to &'exim'& binary"
2481 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2482 privilege and executable status from the old MTA. It is then necessary to stop
2483 and restart the mailer daemon, if one is running.
2484
2485 .cindex "FreeBSD, MTA indirection"
2486 .cindex "&_/etc/mail/mailer.conf_&"
2487 Some operating systems have introduced alternative ways of switching MTAs. For
2488 example, if you are running FreeBSD, you need to edit the file
2489 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2490 described. A typical example of the contents of this file for running Exim is
2491 as follows:
2492 .code
2493 sendmail            /usr/exim/bin/exim
2494 send-mail           /usr/exim/bin/exim
2495 mailq               /usr/exim/bin/exim -bp
2496 newaliases          /usr/bin/true
2497 .endd
2498 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2499 your Exim installation is &"live"&. Check it by sending a message from your
2500 favourite user agent.
2501
2502 You should consider what to tell your users about the change of MTA. Exim may
2503 have different capabilities to what was previously running, and there are
2504 various operational differences such as the text of messages produced by
2505 command line options and in bounce messages. If you allow your users to make
2506 use of Exim's filtering capabilities, you should make the document entitled
2507 &'Exim's interface to mail filtering'& available to them.
2508
2509
2510
2511 .section "Upgrading Exim" "SECID36"
2512 .cindex "upgrading Exim"
2513 If you are already running Exim on your host, building and installing a new
2514 version automatically makes it available to MUAs, or any other programs that
2515 call the MTA directly. However, if you are running an Exim daemon, you do need
2516 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2517 new binary. You do not need to stop processing mail in order to install a new
2518 version of Exim. The install script does not modify an existing runtime
2519 configuration file.
2520
2521
2522
2523
2524 .section "Stopping the Exim daemon on Solaris" "SECID37"
2525 .cindex "Solaris" "stopping Exim on"
2526 The standard command for stopping the mailer daemon on Solaris is
2527 .code
2528 /etc/init.d/sendmail stop
2529 .endd
2530 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2531 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2532 for the text &"sendmail"&; this is not present because the actual program name
2533 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2534 solution is to replace the line that finds the process id with something like
2535 .code
2536 pid=`cat /var/spool/exim/exim-daemon.pid`
2537 .endd
2538 to obtain the daemon's pid directly from the file that Exim saves it in.
2539
2540 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2541 still be received from local processes, and if automatic delivery is configured
2542 (the normal case), deliveries will still occur.
2543
2544
2545
2546
2547 . ////////////////////////////////////////////////////////////////////////////
2548 . ////////////////////////////////////////////////////////////////////////////
2549
2550 .chapter "The Exim command line" "CHAPcommandline"
2551 .scindex IIDclo1 "command line" "options"
2552 .scindex IIDclo2 "options" "command line"
2553 Exim's command line takes the standard Unix form of a sequence of options,
2554 each starting with a hyphen character, followed by a number of arguments. The
2555 options are compatible with the main options of Sendmail, and there are also
2556 some additional options, some of which are compatible with Smail 3. Certain
2557 combinations of options do not make sense, and provoke an error if used.
2558 The form of the arguments depends on which options are set.
2559
2560
2561 .section "Setting options by program name" "SECID38"
2562 .cindex "&'mailq'&"
2563 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2564 were present before any other options.
2565 The &%-bp%& option requests a listing of the contents of the mail queue on the
2566 standard output.
2567 This feature is for compatibility with some systems that contain a command of
2568 that name in one of the standard libraries, symbolically linked to
2569 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2570
2571 .cindex "&'rsmtp'&"
2572 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2573 were present before any other options, for compatibility with Smail. The
2574 &%-bS%& option is used for reading in a number of messages in batched SMTP
2575 format.
2576
2577 .cindex "&'rmail'&"
2578 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2579 &%-oee%& options were present before any other options, for compatibility with
2580 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2581
2582 .cindex "&'runq'&"
2583 .cindex "queue runner"
2584 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2585 were present before any other options, for compatibility with Smail. The &%-q%&
2586 option causes a single queue runner process to be started.
2587
2588 .cindex "&'newaliases'&"
2589 .cindex "alias file" "building"
2590 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2591 If Exim is called under the name &'newaliases'& it behaves as if the option
2592 &%-bi%& were present before any other options, for compatibility with Sendmail.
2593 This option is used for rebuilding Sendmail's alias file. Exim does not have
2594 the concept of a single alias file, but can be configured to run a given
2595 command if called with the &%-bi%& option.
2596
2597
2598 .section "Trusted and admin users" "SECTtrustedadmin"
2599 Some Exim options are available only to &'trusted users'& and others are
2600 available only to &'admin users'&. In the description below, the phrases &"Exim
2601 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2602 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2603 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2604
2605 .ilist
2606 .cindex "trusted users" "definition of"
2607 .cindex "user" "trusted definition of"
2608 The trusted users are root, the Exim user, any user listed in the
2609 &%trusted_users%& configuration option, and any user whose current group or any
2610 supplementary group is one of those listed in the &%trusted_groups%&
2611 configuration option. Note that the Exim group is not automatically trusted.
2612
2613 .cindex '&"From"& line'
2614 .cindex "envelope sender"
2615 Trusted users are always permitted to use the &%-f%& option or a leading
2616 &"From&~"& line to specify the envelope sender of a message that is passed to
2617 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2618 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2619 users to set envelope senders.
2620
2621 .cindex "&'From:'& header line"
2622 .cindex "&'Sender:'& header line"
2623 .cindex "header lines" "From:"
2624 .cindex "header lines" "Sender:"
2625 For a trusted user, there is never any check on the contents of the &'From:'&
2626 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2627 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2628
2629 Trusted users may also specify a host name, host address, interface address,
2630 protocol name, ident value, and authentication data when submitting a message
2631 locally. Thus, they are able to insert messages into Exim's queue locally that
2632 have the characteristics of messages received from a remote host. Untrusted
2633 users may in some circumstances use &%-f%&, but can never set the other values
2634 that are available to trusted users.
2635 .next
2636 .cindex "user" "admin definition of"
2637 .cindex "admin user" "definition of"
2638 The admin users are root, the Exim user, and any user that is a member of the
2639 Exim group or of any group listed in the &%admin_groups%& configuration option.
2640 The current group does not have to be one of these groups.
2641
2642 Admin users are permitted to list the queue, and to carry out certain
2643 operations on messages, for example, to force delivery failures. It is also
2644 necessary to be an admin user in order to see the full information provided by
2645 the Exim monitor, and full debugging output.
2646
2647 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2648 Exim to attempt delivery of messages on its queue is restricted to admin users.
2649 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2650 option false (that is, specifying &%no_prod_requires_admin%&).
2651
2652 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2653 is restricted to admin users unless &%queue_list_requires_admin%& is set
2654 false.
2655 .endlist
2656
2657
2658 &*Warning*&: If you configure your system so that admin users are able to
2659 edit Exim's configuration file, you are giving those users an easy way of
2660 getting root. There is further discussion of this issue at the start of chapter
2661 &<<CHAPconf>>&.
2662
2663
2664
2665
2666 .section "Command line options" "SECID39"
2667 Exim's command line options are described in alphabetical order below. If none
2668 of the options that specifies a specific action (such as starting the daemon or
2669 a queue runner, or testing an address, or receiving a message in a specific
2670 format, or listing the queue) are present, and there is at least one argument
2671 on the command line, &%-bm%& (accept a local message on the standard input,
2672 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2673 outputs a brief message about itself and exits.
2674
2675 . ////////////////////////////////////////////////////////////////////////////
2676 . Insert a stylized XML comment here, to identify the start of the command line
2677 . options. This is for the benefit of the Perl script that automatically
2678 . creates a man page for the options.
2679 . ////////////////////////////////////////////////////////////////////////////
2680
2681 .literal xml
2682 <!-- === Start of command line options === -->
2683 .literal off
2684
2685
2686 .vlist
2687 .vitem &%--%&
2688 .oindex "--"
2689 .cindex "options" "command line; terminating"
2690 This is a pseudo-option whose only purpose is to terminate the options and
2691 therefore to cause subsequent command line items to be treated as arguments
2692 rather than options, even if they begin with hyphens.
2693
2694 .vitem &%--help%&
2695 .oindex "&%--help%&"
2696 This option causes Exim to output a few sentences stating what it is.
2697 The same output is generated if the Exim binary is called with no options and
2698 no arguments.
2699
2700 .vitem &%--version%&
2701 .oindex "&%--version%&"
2702 This option is an alias for &%-bV%& and causes version information to be
2703 displayed.
2704
2705 .vitem &%-Ac%& &&&
2706        &%-Am%&
2707 .oindex "&%-Ac%&"
2708 .oindex "&%-Am%&"
2709 These options are used by Sendmail for selecting configuration files and are
2710 ignored by Exim.
2711
2712 .vitem &%-B%&<&'type'&>
2713 .oindex "&%-B%&"
2714 .cindex "8-bit characters"
2715 .cindex "Sendmail compatibility" "8-bit characters"
2716 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2717 clean; it ignores this option.
2718
2719 .vitem &%-bd%&
2720 .oindex "&%-bd%&"
2721 .cindex "daemon"
2722 .cindex "SMTP" "listener"
2723 .cindex "queue runner"
2724 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2725 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2726 that the daemon should also initiate periodic queue runs.
2727
2728 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2729 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2730 disconnect from the controlling terminal. When running this way, it can be
2731 stopped by pressing ctrl-C.
2732
2733 By default, Exim listens for incoming connections to the standard SMTP port on
2734 all the host's running interfaces. However, it is possible to listen on other
2735 ports, on multiple ports, and only on specific interfaces. Chapter
2736 &<<CHAPinterfaces>>& contains a description of the options that control this.
2737
2738 When a listening daemon
2739 .cindex "daemon" "process id (pid)"
2740 .cindex "pid (process id)" "of daemon"
2741 is started without the use of &%-oX%& (that is, without overriding the normal
2742 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2743 in Exim's spool directory. This location can be overridden by setting
2744 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2745 running as root.
2746
2747 When &%-oX%& is used on the command line to start a listening daemon, the
2748 process id is not written to the normal pid file path. However, &%-oP%& can be
2749 used to specify a path on the command line if a pid file is required.
2750
2751 The SIGHUP signal
2752 .cindex "SIGHUP"
2753 .cindex "daemon" "restarting"
2754 can be used to cause the daemon to re-execute itself. This should be done
2755 whenever Exim's configuration file, or any file that is incorporated into it by
2756 means of the &%.include%& facility, is changed, and also whenever a new version
2757 of Exim is installed. It is not necessary to do this when other files that are
2758 referenced from the configuration (for example, alias files) are changed,
2759 because these are reread each time they are used.
2760
2761 .vitem &%-bdf%&
2762 .oindex "&%-bdf%&"
2763 This option has the same effect as &%-bd%& except that it never disconnects
2764 from the controlling terminal, even when no debugging is specified.
2765
2766 .vitem &%-be%&
2767 .oindex "&%-be%&"
2768 .cindex "testing" "string expansion"
2769 .cindex "expansion" "testing"
2770 Run Exim in expansion testing mode. Exim discards its root privilege, to
2771 prevent ordinary users from using this mode to read otherwise inaccessible
2772 files. If no arguments are given, Exim runs interactively, prompting for lines
2773 of data. Otherwise, it processes each argument in turn.
2774
2775 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2776 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2777 used without command line arguments. If successful, it uses the &[readline()]&
2778 function, which provides extensive line-editing facilities, for reading the
2779 test data. A line history is supported.
2780
2781 Long expansion expressions can be split over several lines by using backslash
2782 continuations. As in Exim's run time configuration, white space at the start of
2783 continuation lines is ignored. Each argument or data line is passed through the
2784 string expansion mechanism, and the result is output. Variable values from the
2785 configuration file (for example, &$qualify_domain$&) are available, but no
2786 message-specific values (such as &$message_exim_id$&) are set, because no message
2787 is being processed (but see &%-bem%& and &%-Mset%&).
2788
2789 &*Note*&: If you use this mechanism to test lookups, and you change the data
2790 files or databases you are using, you must exit and restart Exim before trying
2791 the same lookup again. Otherwise, because each Exim process caches the results
2792 of lookups, you will just get the same result as before.
2793
2794 Macro processing is done on lines before string-expansion: new macros can be
2795 defined and macros will be expanded.
2796 Because macros in the config file are often used for secrets, those are only
2797 available to admin users.
2798
2799 .vitem &%-bem%&&~<&'filename'&>
2800 .oindex "&%-bem%&"
2801 .cindex "testing" "string expansion"
2802 .cindex "expansion" "testing"
2803 This option operates like &%-be%& except that it must be followed by the name
2804 of a file. For example:
2805 .code
2806 exim -bem /tmp/testmessage
2807 .endd
2808 The file is read as a message (as if receiving a locally-submitted non-SMTP
2809 message) before any of the test expansions are done. Thus, message-specific
2810 variables such as &$message_size$& and &$header_from:$& are available. However,
2811 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2812 recipients are read from the headers in the normal way, and are shown in the
2813 &$recipients$& variable. Note that recipients cannot be given on the command
2814 line, because further arguments are taken as strings to expand (just like
2815 &%-be%&).
2816
2817 .vitem &%-bF%&&~<&'filename'&>
2818 .oindex "&%-bF%&"
2819 .cindex "system filter" "testing"
2820 .cindex "testing" "system filter"
2821 This option is the same as &%-bf%& except that it assumes that the filter being
2822 tested is a system filter. The additional commands that are available only in
2823 system filters are recognized.
2824
2825 .vitem &%-bf%&&~<&'filename'&>
2826 .oindex "&%-bf%&"
2827 .cindex "filter" "testing"
2828 .cindex "testing" "filter file"
2829 .cindex "forward file" "testing"
2830 .cindex "testing" "forward file"
2831 .cindex "Sieve filter" "testing"
2832 This option runs Exim in user filter testing mode; the file is the filter file
2833 to be tested, and a test message must be supplied on the standard input. If
2834 there are no message-dependent tests in the filter, an empty file can be
2835 supplied.
2836
2837 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2838 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2839 filter and a user filter in the same run. For example:
2840 .code
2841 exim -bF /system/filter -bf /user/filter </test/message
2842 .endd
2843 This is helpful when the system filter adds header lines or sets filter
2844 variables that are used by the user filter.
2845
2846 If the test filter file does not begin with one of the special lines
2847 .code
2848 # Exim filter
2849 # Sieve filter
2850 .endd
2851 it is taken to be a normal &_.forward_& file, and is tested for validity under
2852 that interpretation. See sections &<<SECTitenonfilred>>& to
2853 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2854 redirection lists.
2855
2856 The result of an Exim command that uses &%-bf%&, provided no errors are
2857 detected, is a list of the actions that Exim would try to take if presented
2858 with the message for real. More details of filter testing are given in the
2859 separate document entitled &'Exim's interfaces to mail filtering'&.
2860
2861 When testing a filter file,
2862 .cindex "&""From""& line"
2863 .cindex "envelope sender"
2864 .oindex "&%-f%&" "for filter testing"
2865 the envelope sender can be set by the &%-f%& option,
2866 or by a &"From&~"& line at the start of the test message. Various parameters
2867 that would normally be taken from the envelope recipient address of the message
2868 can be set by means of additional command line options (see the next four
2869 options).
2870
2871 .vitem &%-bfd%&&~<&'domain'&>
2872 .oindex "&%-bfd%&"
2873 .vindex "&$qualify_domain$&"
2874 This sets the domain of the recipient address when a filter file is being
2875 tested by means of the &%-bf%& option. The default is the value of
2876 &$qualify_domain$&.
2877
2878 .vitem &%-bfl%&&~<&'local&~part'&>
2879 .oindex "&%-bfl%&"
2880 This sets the local part of the recipient address when a filter file is being
2881 tested by means of the &%-bf%& option. The default is the username of the
2882 process that calls Exim. A local part should be specified with any prefix or
2883 suffix stripped, because that is how it appears to the filter when a message is
2884 actually being delivered.
2885
2886 .vitem &%-bfp%&&~<&'prefix'&>
2887 .oindex "&%-bfp%&"
2888 This sets the prefix of the local part of the recipient address when a filter
2889 file is being tested by means of the &%-bf%& option. The default is an empty
2890 prefix.
2891
2892 .vitem &%-bfs%&&~<&'suffix'&>
2893 .oindex "&%-bfs%&"
2894 This sets the suffix of the local part of the recipient address when a filter
2895 file is being tested by means of the &%-bf%& option. The default is an empty
2896 suffix.
2897
2898 .vitem &%-bh%&&~<&'IP&~address'&>
2899 .oindex "&%-bh%&"
2900 .cindex "testing" "incoming SMTP"
2901 .cindex "SMTP" "testing incoming"
2902 .cindex "testing" "relay control"
2903 .cindex "relaying" "testing configuration"
2904 .cindex "policy control" "testing"
2905 .cindex "debugging" "&%-bh%& option"
2906 This option runs a fake SMTP session as if from the given IP address, using the
2907 standard input and output. The IP address may include a port number at the end,
2908 after a full stop. For example:
2909 .code
2910 exim -bh 10.9.8.7.1234
2911 exim -bh fe80::a00:20ff:fe86:a061.5678
2912 .endd
2913 When an IPv6 address is given, it is converted into canonical form. In the case
2914 of the second example above, the value of &$sender_host_address$& after
2915 conversion to the canonical form is
2916 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2917
2918 Comments as to what is going on are written to the standard error file. These
2919 include lines beginning with &"LOG"& for anything that would have been logged.
2920 This facility is provided for testing configuration options for incoming
2921 messages, to make sure they implement the required policy. For example, you can
2922 test your relay controls using &%-bh%&.
2923
2924 &*Warning 1*&:
2925 .cindex "RFC 1413"
2926 You can test features of the configuration that rely on ident (RFC 1413)
2927 information by using the &%-oMt%& option. However, Exim cannot actually perform
2928 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2929 connection.
2930
2931 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2932 are also skipped when testing using &%-bh%&. If you want these callouts to
2933 occur, use &%-bhc%& instead.
2934
2935 Messages supplied during the testing session are discarded, and nothing is
2936 written to any of the real log files. There may be pauses when DNS (and other)
2937 lookups are taking place, and of course these may time out. The &%-oMi%& option
2938 can be used to specify a specific IP interface and port if this is important,
2939 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2940 session were authenticated.
2941
2942 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2943 output just states whether a given recipient address from a given host is
2944 acceptable or not. See section &<<SECTcheckaccess>>&.
2945
2946 Features such as authentication and encryption, where the client input is not
2947 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2948 specialized SMTP test program such as
2949 &url(http://jetmore.org/john/code/#swaks,swaks).
2950
2951 .vitem &%-bhc%&&~<&'IP&~address'&>
2952 .oindex "&%-bhc%&"
2953 This option operates in the same way as &%-bh%&, except that address
2954 verification callouts are performed if required. This includes consulting and
2955 updating the callout cache database.
2956
2957 .vitem &%-bi%&
2958 .oindex "&%-bi%&"
2959 .cindex "alias file" "building"
2960 .cindex "building alias file"
2961 .cindex "Sendmail compatibility" "&%-bi%& option"
2962 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2963 Exim does not have the concept of a single alias file, and so it cannot mimic
2964 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2965 tend to appear in various scripts such as NIS make files, so the option must be
2966 recognized.
2967
2968 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2969 configuration option is run, under the uid and gid of the caller of Exim. If
2970 the &%-oA%& option is used, its value is passed to the command as an argument.
2971 The command set by &%bi_command%& may not contain arguments. The command can
2972 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2973 if this is required. If the &%bi_command%& option is not set, calling Exim with
2974 &%-bi%& is a no-op.
2975
2976 . // Keep :help first, then the rest in alphabetical order
2977 .vitem &%-bI:help%&
2978 .oindex "&%-bI:help%&"
2979 .cindex "querying exim information"
2980 We shall provide various options starting &`-bI:`& for querying Exim for
2981 information.  The output of many of these will be intended for machine
2982 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2983 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2984 options shall cause Exim to exit after producing the requested output.
2985
2986 .vitem &%-bI:dscp%&
2987 .oindex "&%-bI:dscp%&"
2988 .cindex "DSCP" "values"
2989 This option causes Exim to emit an alphabetically sorted list of all
2990 recognised DSCP names.
2991
2992 .vitem &%-bI:sieve%&
2993 .oindex "&%-bI:sieve%&"
2994 .cindex "Sieve filter" "capabilities"
2995 This option causes Exim to emit an alphabetically sorted list of all supported
2996 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2997 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2998 &`SIEVE`& capability response line.  As the precise list may depend upon
2999 compile-time build options, which this option will adapt to, this is the only
3000 way to guarantee a correct response.
3001
3002 .vitem &%-bm%&
3003 .oindex "&%-bm%&"
3004 .cindex "local message reception"
3005 This option runs an Exim receiving process that accepts an incoming,
3006 locally-generated message on the standard input. The recipients are given as the
3007 command arguments (except when &%-t%& is also present &-- see below). Each
3008 argument can be a comma-separated list of RFC 2822 addresses. This is the
3009 default option for selecting the overall action of an Exim call; it is assumed
3010 if no other conflicting option is present.
3011
3012 If any addresses in the message are unqualified (have no domain), they are
3013 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3014 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3015 suppressing this for special cases.
3016
3017 Policy checks on the contents of local messages can be enforced by means of
3018 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3019
3020 .cindex "return code" "for &%-bm%&"
3021 The return code is zero if the message is successfully accepted. Otherwise, the
3022 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3023
3024 The format
3025 .cindex "message" "format"
3026 .cindex "format" "message"
3027 .cindex "&""From""& line"
3028 .cindex "UUCP" "&""From""& line"
3029 .cindex "Sendmail compatibility" "&""From""& line"
3030 of the message must be as defined in RFC 2822, except that, for
3031 compatibility with Sendmail and Smail, a line in one of the forms
3032 .code
3033 From sender Fri Jan  5 12:55 GMT 1997
3034 From sender Fri, 5 Jan 97 12:55:01
3035 .endd
3036 (with the weekday optional, and possibly with additional text after the date)
3037 is permitted to appear at the start of the message. There appears to be no
3038 authoritative specification of the format of this line. Exim recognizes it by
3039 matching against the regular expression defined by the &%uucp_from_pattern%&
3040 option, which can be changed if necessary.
3041
3042 .oindex "&%-f%&" "overriding &""From""& line"
3043 The specified sender is treated as if it were given as the argument to the
3044 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3045 preference to the address taken from the message. The caller of Exim must be a
3046 trusted user for the sender of a message to be set in this way.
3047
3048 .vitem &%-bmalware%&&~<&'filename'&>
3049 .oindex "&%-bmalware%&"
3050 .cindex "testing", "malware"
3051 .cindex "malware scan test"
3052 This debugging option causes Exim to scan the given file or directory
3053 (depending on the used scanner interface),
3054 using the malware scanning framework.  The option of &%av_scanner%& influences
3055 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3056 the expansion should have defaults which apply to this invocation.  ACLs are
3057 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3058 will never be populated and &%-bmalware%& will fail.
3059
3060 Exim will have changed working directory before resolving the filename, so
3061 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3062 user when it tries to open the file, rather than as the invoking user.
3063 This option requires admin privileges.
3064
3065 The &%-bmalware%& option will not be extended to be more generally useful,
3066 there are better tools for file-scanning.  This option exists to help
3067 administrators verify their Exim and AV scanner configuration.
3068
3069 .vitem &%-bnq%&
3070 .oindex "&%-bnq%&"
3071 .cindex "address qualification, suppressing"
3072 By default, Exim automatically qualifies unqualified addresses (those
3073 without domains) that appear in messages that are submitted locally (that
3074 is, not over TCP/IP). This qualification applies both to addresses in
3075 envelopes, and addresses in header lines. Sender addresses are qualified using
3076 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3077 defaults to the value of &%qualify_domain%&).
3078
3079 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3080 being used to re-submit messages that originally came from remote hosts after
3081 content scanning, you probably do not want to qualify unqualified addresses in
3082 header lines. (Such lines will be present only if you have not enabled a header
3083 syntax check in the appropriate ACL.)
3084
3085 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3086 messages that originate on the local host. When this is used, unqualified
3087 addresses in the envelope provoke errors (causing message rejection) and
3088 unqualified addresses in header lines are left alone.
3089
3090
3091 .vitem &%-bP%&
3092 .oindex "&%-bP%&"
3093 .cindex "configuration options" "extracting"
3094 .cindex "options" "configuration &-- extracting"
3095 If this option is given with no arguments, it causes the values of all Exim's
3096 main configuration options to be written to the standard output. The values
3097 of one or more specific options can be requested by giving their names as
3098 arguments, for example:
3099 .code
3100 exim -bP qualify_domain hold_domains
3101 .endd
3102 .cindex "hiding configuration option values"
3103 .cindex "configuration options" "hiding value of"
3104 .cindex "options" "hiding value of"
3105 However, any option setting that is preceded by the word &"hide"& in the
3106 configuration file is not shown in full, except to an admin user. For other
3107 users, the output is as in this example:
3108 .code
3109 mysql_servers = <value not displayable>
3110 .endd
3111 If &%config%& is given as an argument, the config is
3112 output, as it was parsed, any include file resolved, any comment removed.
3113
3114 If &%config_file%& is given as an argument, the name of the run time
3115 configuration file is output. (&%configure_file%& works too, for
3116 backward compatibility.)
3117 If a list of configuration files was supplied, the value that is output here
3118 is the name of the file that was actually used.
3119
3120 .cindex "options" "hiding name of"
3121 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3122 name will not be output.
3123
3124 .cindex "daemon" "process id (pid)"
3125 .cindex "pid (process id)" "of daemon"
3126 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3127 directories where log files and daemon pid files are written are output,
3128 respectively. If these values are unset, log files are written in a
3129 sub-directory of the spool directory called &%log%&, and the pid file is
3130 written directly into the spool directory.
3131
3132 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3133 .code
3134 exim -bP +local_domains
3135 .endd
3136 it searches for a matching named list of any type (domain, host, address, or
3137 local part) and outputs what it finds.
3138
3139 .cindex "options" "router &-- extracting"
3140 .cindex "options" "transport &-- extracting"
3141 .cindex "options" "authenticator &-- extracting"
3142 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3143 followed by the name of an appropriate driver instance, the option settings for
3144 that driver are output. For example:
3145 .code
3146 exim -bP transport local_delivery
3147 .endd
3148 The generic driver options are output first, followed by the driver's private
3149 options. A list of the names of drivers of a particular type can be obtained by
3150 using one of the words &%router_list%&, &%transport_list%&, or
3151 &%authenticator_list%&, and a complete list of all drivers with their option
3152 settings can be obtained by using &%routers%&, &%transports%&, or
3153 &%authenticators%&.
3154
3155 .cindex "environment"
3156 If &%environment%& is given as an argument, the set of environment
3157 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3158 variables.
3159
3160 .cindex "options" "macro &-- extracting"
3161 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3162 are available, similarly to the drivers.  Because macros are sometimes used
3163 for storing passwords, this option is restricted.
3164 The output format is one item per line.
3165
3166 .vitem &%-bp%&
3167 .oindex "&%-bp%&"
3168 .cindex "queue" "listing messages on"
3169 .cindex "listing" "messages on the queue"
3170 This option requests a listing of the contents of the mail queue on the
3171 standard output. If the &%-bp%& option is followed by a list of message ids,
3172 just those messages are listed. By default, this option can be used only by an
3173 admin user. However, the &%queue_list_requires_admin%& option can be set false
3174 to allow any user to see the queue.
3175
3176 Each message on the queue is displayed as in the following example:
3177 .code
3178 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3179           red.king@looking-glass.fict.example
3180           <other addresses>
3181 .endd
3182 .cindex "message" "size in queue listing"
3183 .cindex "size" "of message"
3184 The first line contains the length of time the message has been on the queue
3185 (in this case 25 minutes), the size of the message (2.9K), the unique local
3186 identifier for the message, and the message sender, as contained in the
3187 envelope. For bounce messages, the sender address is empty, and appears as
3188 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3189 the default sender address, the user's login name is shown in parentheses
3190 before the sender address.
3191
3192 .cindex "frozen messages" "in queue listing"
3193 If the message is frozen (attempts to deliver it are suspended) then the text
3194 &"*** frozen ***"& is displayed at the end of this line.
3195
3196 The recipients of the message (taken from the envelope, not the headers) are
3197 displayed on subsequent lines. Those addresses to which the message has already
3198 been delivered are marked with the letter D. If an original address gets
3199 expanded into several addresses via an alias or forward file, the original is
3200 displayed with a D only when deliveries for all of its child addresses are
3201 complete.
3202
3203
3204 .vitem &%-bpa%&
3205 .oindex "&%-bpa%&"
3206 This option operates like &%-bp%&, but in addition it shows delivered addresses
3207 that were generated from the original top level address(es) in each message by
3208 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3209 of just &"D"&.
3210
3211
3212 .vitem &%-bpc%&
3213 .oindex "&%-bpc%&"
3214 .cindex "queue" "count of messages on"
3215 This option counts the number of messages on the queue, and writes the total
3216 to the standard output. It is restricted to admin users, unless
3217 &%queue_list_requires_admin%& is set false.
3218
3219
3220 .vitem &%-bpr%&
3221 .oindex "&%-bpr%&"
3222 This option operates like &%-bp%&, but the output is not sorted into
3223 chronological order of message arrival. This can speed it up when there are
3224 lots of messages on the queue, and is particularly useful if the output is
3225 going to be post-processed in a way that doesn't need the sorting.
3226
3227 .vitem &%-bpra%&
3228 .oindex "&%-bpra%&"
3229 This option is a combination of &%-bpr%& and &%-bpa%&.
3230
3231 .vitem &%-bpru%&
3232 .oindex "&%-bpru%&"
3233 This option is a combination of &%-bpr%& and &%-bpu%&.
3234
3235
3236 .vitem &%-bpu%&
3237 .oindex "&%-bpu%&"
3238 This option operates like &%-bp%& but shows only undelivered top-level
3239 addresses for each message displayed. Addresses generated by aliasing or
3240 forwarding are not shown, unless the message was deferred after processing by a
3241 router with the &%one_time%& option set.
3242
3243
3244 .vitem &%-brt%&
3245 .oindex "&%-brt%&"
3246 .cindex "testing" "retry configuration"
3247 .cindex "retry" "configuration testing"
3248 This option is for testing retry rules, and it must be followed by up to three
3249 arguments. It causes Exim to look for a retry rule that matches the values
3250 and to write it to the standard output. For example:
3251 .code
3252 exim -brt bach.comp.mus.example
3253 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3254 .endd
3255 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3256 argument, which is required, can be a complete address in the form
3257 &'local_part@domain'&, or it can be just a domain name. If the second argument
3258 contains a dot, it is interpreted as an optional second domain name; if no
3259 retry rule is found for the first argument, the second is tried. This ties in
3260 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3261 rule is found that matches the host, one that matches the mail domain is
3262 sought. Finally, an argument that is the name of a specific delivery error, as
3263 used in setting up retry rules, can be given. For example:
3264 .code
3265 exim -brt haydn.comp.mus.example quota_3d
3266 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3267 .endd
3268
3269 .vitem &%-brw%&
3270 .oindex "&%-brw%&"
3271 .cindex "testing" "rewriting"
3272 .cindex "rewriting" "testing"
3273 This option is for testing address rewriting rules, and it must be followed by
3274 a single argument, consisting of either a local part without a domain, or a
3275 complete address with a fully qualified domain. Exim outputs how this address
3276 would be rewritten for each possible place it might appear. See chapter
3277 &<<CHAPrewrite>>& for further details.
3278
3279 .vitem &%-bS%&
3280 .oindex "&%-bS%&"
3281 .cindex "SMTP" "batched incoming"
3282 .cindex "batched SMTP input"
3283 This option is used for batched SMTP input, which is an alternative interface
3284 for non-interactive local message submission. A number of messages can be
3285 submitted in a single run. However, despite its name, this is not really SMTP
3286 input. Exim reads each message's envelope from SMTP commands on the standard
3287 input, but generates no responses. If the caller is trusted, or
3288 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3289 believed; otherwise the sender is always the caller of Exim.
3290
3291 The message itself is read from the standard input, in SMTP format (leading
3292 dots doubled), terminated by a line containing just a single dot. An error is
3293 provoked if the terminating dot is missing. A further message may then follow.
3294
3295 As for other local message submissions, the contents of incoming batch SMTP
3296 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3297 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3298 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3299
3300 Some other SMTP commands are recognized in the input. HELO and EHLO act
3301 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3302 QUIT quits, ignoring the rest of the standard input.
3303
3304 .cindex "return code" "for &%-bS%&"
3305 If any error is encountered, reports are written to the standard output and
3306 error streams, and Exim gives up immediately. The return code is 0 if no error
3307 was detected; it is 1 if one or more messages were accepted before the error
3308 was detected; otherwise it is 2.
3309
3310 More details of input using batched SMTP are given in section
3311 &<<SECTincomingbatchedSMTP>>&.
3312
3313 .vitem &%-bs%&
3314 .oindex "&%-bs%&"
3315 .cindex "SMTP" "local input"
3316 .cindex "local SMTP input"
3317 This option causes Exim to accept one or more messages by reading SMTP commands
3318 on the standard input, and producing SMTP replies on the standard output. SMTP
3319 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3320 Some user agents use this interface as a way of passing locally-generated
3321 messages to the MTA.
3322
3323 In
3324 .cindex "sender" "source of"
3325 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3326 set, the senders of messages are taken from the SMTP MAIL commands.
3327 Otherwise the content of these commands is ignored and the sender is set up as
3328 the calling user. Unqualified addresses are automatically qualified using
3329 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3330 &%-bnq%& option is used.
3331
3332 .cindex "inetd"
3333 The
3334 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3335 using a listening daemon. Exim can distinguish the two cases by checking
3336 whether the standard input is a TCP/IP socket. When Exim is called from
3337 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3338 above concerning senders and qualification do not apply. In this situation,
3339 Exim behaves in exactly the same way as it does when receiving a message via
3340 the listening daemon.
3341
3342 .vitem &%-bt%&
3343 .oindex "&%-bt%&"
3344 .cindex "testing" "addresses"
3345 .cindex "address" "testing"
3346 This option runs Exim in address testing mode, in which each argument is taken
3347 as a recipient address to be tested for deliverability. The results are
3348 written to the standard output. If a test fails, and the caller is not an admin
3349 user, no details of the failure are output, because these might contain
3350 sensitive information such as usernames and passwords for database lookups.
3351
3352 If no arguments are given, Exim runs in an interactive manner, prompting with a
3353 right angle bracket for addresses to be tested.
3354
3355 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3356 &[readline()]& function, because it is running as &'root'& and there are
3357 security issues.
3358
3359 Each address is handled as if it were the recipient address of a message
3360 (compare the &%-bv%& option). It is passed to the routers and the result is
3361 written to the standard output. However, any router that has
3362 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3363 genuine routing tests if your first router passes everything to a scanner
3364 program.
3365
3366 .cindex "return code" "for &%-bt%&"
3367 The return code is 2 if any address failed outright; it is 1 if no address
3368 failed outright but at least one could not be resolved for some reason. Return
3369 code 0 is given only when all addresses succeed.
3370
3371 .cindex "duplicate addresses"
3372 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3373 addresses after routing is complete, so that only one delivery takes place.
3374 This does not happen when testing with &%-bt%&; the full results of routing are
3375 always shown.
3376
3377 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3378 routers in the configuration makes any tests on the sender address of a
3379 message,
3380 .oindex "&%-f%&" "for address testing"
3381 you can use the &%-f%& option to set an appropriate sender when running
3382 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3383 default qualifying domain. However, if you have set up (for example) routers
3384 whose behaviour depends on the contents of an incoming message, you cannot test
3385 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3386 doing such tests.
3387
3388 .vitem &%-bV%&
3389 .oindex "&%-bV%&"
3390 .cindex "version number of Exim"
3391 This option causes Exim to write the current version number, compilation
3392 number, and compilation date of the &'exim'& binary to the standard output.
3393 It also lists the DBM library that is being used, the optional modules (such as
3394 specific lookup types), the drivers that are included in the binary, and the
3395 name of the run time configuration file that is in use.
3396
3397 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3398 configuration file. However, this is a static check only. It cannot check
3399 values that are to be expanded. For example, although a misspelt ACL verb is
3400 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3401 alone to discover (for example) all the typos in the configuration; some
3402 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3403 dynamic testing facilities.
3404
3405 .vitem &%-bv%&
3406 .oindex "&%-bv%&"
3407 .cindex "verifying address" "using &%-bv%&"
3408 .cindex "address" "verification"
3409 This option runs Exim in address verification mode, in which each argument is
3410 taken as a recipient address to be verified by the routers. (This does
3411 not involve any verification callouts). During normal operation, verification
3412 happens mostly as a consequence processing a &%verify%& condition in an ACL
3413 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3414 including callouts, see the &%-bh%& and &%-bhc%& options.
3415
3416 If verification fails, and the caller is not an admin user, no details of the
3417 failure are output, because these might contain sensitive information such as
3418 usernames and passwords for database lookups.
3419
3420 If no arguments are given, Exim runs in an interactive manner, prompting with a
3421 right angle bracket for addresses to be verified.
3422
3423 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3424 &[readline()]& function, because it is running as &'exim'& and there are
3425 security issues.
3426
3427 Verification differs from address testing (the &%-bt%& option) in that routers
3428 that have &%no_verify%& set are skipped, and if the address is accepted by a
3429 router that has &%fail_verify%& set, verification fails. The address is
3430 verified as a recipient if &%-bv%& is used; to test verification for a sender
3431 address, &%-bvs%& should be used.
3432
3433 If the &%-v%& option is not set, the output consists of a single line for each
3434 address, stating whether it was verified or not, and giving a reason in the
3435 latter case. Without &%-v%&, generating more than one address by redirection
3436 causes verification to end successfully, without considering the generated
3437 addresses. However, if just one address is generated, processing continues,
3438 and the generated address must verify successfully for the overall verification
3439 to succeed.
3440
3441 When &%-v%& is set, more details are given of how the address has been handled,
3442 and in the case of address redirection, all the generated addresses are also
3443 considered. Verification may succeed for some and fail for others.
3444
3445 The
3446 .cindex "return code" "for &%-bv%&"
3447 return code is 2 if any address failed outright; it is 1 if no address
3448 failed outright but at least one could not be resolved for some reason. Return
3449 code 0 is given only when all addresses succeed.
3450
3451 If any of the routers in the configuration makes any tests on the sender
3452 address of a message, you should use the &%-f%& option to set an appropriate
3453 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3454 calling user at the default qualifying domain.
3455
3456 .vitem &%-bvs%&
3457 .oindex "&%-bvs%&"
3458 This option acts like &%-bv%&, but verifies the address as a sender rather
3459 than a recipient address. This affects any rewriting and qualification that
3460 might happen.
3461
3462 .vitem &%-bw%&
3463 .oindex "&%-bw%&"
3464 .cindex "daemon"
3465 .cindex "inetd"
3466 .cindex "inetd" "wait mode"
3467 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3468 similarly to the &%-bd%& option.  All port specifications on the command-line
3469 and in the configuration file are ignored.  Queue-running may not be specified.
3470
3471 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3472 listening for connections.  This permits the system to start up and have
3473 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3474 each port only when the first connection is received.
3475
3476 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3477 which the daemon will exit, which should cause inetd to listen once more.
3478
3479 .vitem &%-C%&&~<&'filelist'&>
3480 .oindex "&%-C%&"
3481 .cindex "configuration file" "alternate"
3482 .cindex "CONFIGURE_FILE"
3483 .cindex "alternate configuration file"
3484 This option causes Exim to find the run time configuration file from the given
3485 list instead of from the list specified by the CONFIGURE_FILE
3486 compile-time setting. Usually, the list will consist of just a single file
3487 name, but it can be a colon-separated list of names. In this case, the first
3488 file that exists is used. Failure to open an existing file stops Exim from
3489 proceeding any further along the list, and an error is generated.
3490
3491 When this option is used by a caller other than root, and the list is different
3492 from the compiled-in list, Exim gives up its root privilege immediately, and
3493 runs with the real and effective uid and gid set to those of the caller.
3494 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3495 file contains a list of full pathnames, one per line, for configuration files
3496 which are trusted. Root privilege is retained for any configuration file so
3497 listed, as long as the caller is the Exim user (or the user specified in the
3498 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3499 not writeable by inappropriate users or groups.
3500
3501 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3502 configuration using &%-C%& right through message reception and delivery,
3503 even if the caller is root. The reception works, but by that time, Exim is
3504 running as the Exim user, so when it re-executes to regain privilege for the
3505 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3506 test reception and delivery using two separate commands (one to put a message
3507 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3508
3509 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3510 prefix string with which any file named in a &%-C%& command line option
3511 must start. In addition, the file name must not contain the sequence &`/../`&.
3512 However, if the value of the &%-C%& option is identical to the value of
3513 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3514 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3515 unset, any file name can be used with &%-C%&.
3516
3517 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3518 to a directory to which only root has access. This prevents someone who has
3519 broken into the Exim account from running a privileged Exim with an arbitrary
3520 configuration file.
3521
3522 The &%-C%& facility is useful for ensuring that configuration files are
3523 syntactically correct, but cannot be used for test deliveries, unless the
3524 caller is privileged, or unless it is an exotic configuration that does not
3525 require privilege. No check is made on the owner or group of the files
3526 specified by this option.
3527
3528
3529 .vitem &%-D%&<&'macro'&>=<&'value'&>
3530 .oindex "&%-D%&"
3531 .cindex "macro" "setting on command line"
3532 This option can be used to override macro definitions in the configuration file
3533 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3534 unprivileged caller, it causes Exim to give up its root privilege.
3535 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3536 completely disabled, and its use causes an immediate error exit.
3537
3538 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3539 colon-separated list of macros which are considered safe and, if &%-D%& only
3540 supplies macros from this list, and the values are acceptable, then Exim will
3541 not give up root privilege if the caller is root, the Exim run-time user, or
3542 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3543 to be removed in the future.  Acceptable values for the macros satisfy the
3544 regexp: &`^[A-Za-z0-9_/.-]*$`&
3545
3546 The entire option (including equals sign if present) must all be within one
3547 command line item. &%-D%& can be used to set the value of a macro to the empty
3548 string, in which case the equals sign is optional. These two commands are
3549 synonymous:
3550 .code
3551 exim -DABC  ...
3552 exim -DABC= ...
3553 .endd
3554 To include spaces in a macro definition item, quotes must be used. If you use
3555 quotes, spaces are permitted around the macro name and the equals sign. For
3556 example:
3557 .code
3558 exim '-D ABC = something' ...
3559 .endd
3560 &%-D%& may be repeated up to 10 times on a command line.
3561 Only macro names up to 22 letters long can be set.
3562
3563
3564 .vitem &%-d%&<&'debug&~options'&>
3565 .oindex "&%-d%&"
3566 .cindex "debugging" "list of selectors"
3567 .cindex "debugging" "&%-d%& option"
3568 This option causes debugging information to be written to the standard
3569 error stream. It is restricted to admin users because debugging output may show
3570 database queries that contain password information. Also, the details of users'
3571 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3572 writes an error message to the standard error stream and exits with a non-zero
3573 return code.
3574
3575 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3576 standard debugging data is output. This can be reduced, or increased to include
3577 some more rarely needed information, by directly following &%-d%& with a string
3578 made up of names preceded by plus or minus characters. These add or remove sets
3579 of debugging data, respectively. For example, &%-d+filter%& adds filter
3580 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3581 no spaces are allowed in the debug setting. The available debugging categories
3582 are:
3583 .display
3584 &`acl            `& ACL interpretation
3585 &`auth           `& authenticators
3586 &`deliver        `& general delivery logic
3587 &`dns            `& DNS lookups (see also resolver)
3588 &`dnsbl          `& DNS black list (aka RBL) code
3589 &`exec           `& arguments for &[execv()]& calls
3590 &`expand         `& detailed debugging for string expansions
3591 &`filter         `& filter handling
3592 &`hints_lookup   `& hints data lookups
3593 &`host_lookup    `& all types of name-to-IP address handling
3594 &`ident          `& ident lookup
3595 &`interface      `& lists of local interfaces
3596 &`lists          `& matching things in lists
3597 &`load           `& system load checks
3598 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3599                     &<<CHAPlocalscan>>&)
3600 &`lookup         `& general lookup code and all lookups
3601 &`memory         `& memory handling
3602 &`pid            `& add pid to debug output lines
3603 &`process_info   `& setting info for the process log
3604 &`queue_run      `& queue runs
3605 &`receive        `& general message reception logic
3606 &`resolver       `& turn on the DNS resolver's debugging output
3607 &`retry          `& retry handling
3608 &`rewrite        `& address rewriting
3609 &`route          `& address routing
3610 &`timestamp      `& add timestamp to debug output lines
3611 &`tls            `& TLS logic
3612 &`transport      `& transports
3613 &`uid            `& changes of uid/gid and looking up uid/gid
3614 &`verify         `& address verification logic
3615 &`all            `& almost all of the above (see below), and also &%-v%&
3616 .endd
3617 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3618 for &`-all`&. The reason for this is that &`+all`& is something that people
3619 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3620 is included, an awful lot of output that is very rarely of interest is
3621 generated, so it now has to be explicitly requested. However, &`-all`& does
3622 turn everything off.
3623
3624 .cindex "resolver, debugging output"
3625 .cindex "DNS resolver, debugging output"
3626 The &`resolver`& option produces output only if the DNS resolver was compiled
3627 with DEBUG enabled. This is not the case in some operating systems. Also,
3628 unfortunately, debugging output from the DNS resolver is written to stdout
3629 rather than stderr.
3630
3631 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3632 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3633 However, the &`pid`& selector is forced when debugging is turned on for a
3634 daemon, which then passes it on to any re-executed Exims. Exim also
3635 automatically adds the pid to debug lines when several remote deliveries are
3636 run in parallel.
3637
3638 The &`timestamp`& selector causes the current time to be inserted at the start
3639 of all debug output lines. This can be useful when trying to track down delays
3640 in processing.
3641
3642 If the &%debug_print%& option is set in any driver, it produces output whenever
3643 any debugging is selected, or if &%-v%& is used.
3644
3645 .vitem &%-dd%&<&'debug&~options'&>
3646 .oindex "&%-dd%&"
3647 This option behaves exactly like &%-d%& except when used on a command that
3648 starts a daemon process. In that case, debugging is turned off for the
3649 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3650 behaviour of the daemon without creating as much output as full debugging does.
3651
3652 .vitem &%-dropcr%&
3653 .oindex "&%-dropcr%&"
3654 This is an obsolete option that is now a no-op. It used to affect the way Exim
3655 handled CR and LF characters in incoming messages. What happens now is
3656 described in section &<<SECTlineendings>>&.
3657
3658 .vitem &%-E%&
3659 .oindex "&%-E%&"
3660 .cindex "bounce message" "generating"
3661 This option specifies that an incoming message is a locally-generated delivery
3662 failure report. It is used internally by Exim when handling delivery failures
3663 and is not intended for external use. Its only effect is to stop Exim
3664 generating certain messages to the postmaster, as otherwise message cascades
3665 could occur in some situations. As part of the same option, a message id may
3666 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3667 new message contains the id, following &"R="&, as a cross-reference.
3668
3669 .vitem &%-e%&&'x'&
3670 .oindex "&%-e%&&'x'&"
3671 There are a number of Sendmail options starting with &%-oe%& which seem to be
3672 called by various programs without the leading &%o%& in the option. For
3673 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3674 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3675
3676 .vitem &%-F%&&~<&'string'&>
3677 .oindex "&%-F%&"
3678 .cindex "sender" "name"
3679 .cindex "name" "of sender"
3680 This option sets the sender's full name for use when a locally-generated
3681 message is being accepted. In the absence of this option, the user's &'gecos'&
3682 entry from the password data is used. As users are generally permitted to alter
3683 their &'gecos'& entries, no security considerations are involved. White space
3684 between &%-F%& and the <&'string'&> is optional.
3685
3686 .vitem &%-f%&&~<&'address'&>
3687 .oindex "&%-f%&"
3688 .cindex "sender" "address"
3689 .cindex "address" "sender"
3690 .cindex "trusted users"
3691 .cindex "envelope sender"
3692 .cindex "user" "trusted"
3693 This option sets the address of the envelope sender of a locally-generated
3694 message (also known as the return path). The option can normally be used only
3695 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3696 users to use it.
3697
3698 Processes running as root or the Exim user are always trusted. Other
3699 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3700 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3701 of a local message is set to the caller's login name at the default qualify
3702 domain.
3703
3704 There is one exception to the restriction on the use of &%-f%&: an empty sender
3705 can be specified by any user, trusted or not, to create a message that can
3706 never provoke a bounce. An empty sender can be specified either as an empty
3707 string, or as a pair of angle brackets with nothing between them, as in these
3708 examples of shell commands:
3709 .code
3710 exim -f '<>' user@domain
3711 exim -f "" user@domain
3712 .endd
3713 In addition, the use of &%-f%& is not restricted when testing a filter file
3714 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3715 &%-bv%& options.
3716
3717 Allowing untrusted users to change the sender address does not of itself make
3718 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3719 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3720 though this can be overridden by setting &%no_local_from_check%&.
3721
3722 White
3723 .cindex "&""From""& line"
3724 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3725 given as two arguments or one combined argument). The sender of a
3726 locally-generated message can also be set (when permitted) by an initial
3727 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3728 if &%-f%& is also present, it overrides &"From&~"&.
3729
3730 .vitem &%-G%&
3731 .oindex "&%-G%&"
3732 .cindex "submission fixups, suppressing (command-line)"
3733 This option is equivalent to an ACL applying:
3734 .code
3735 control = suppress_local_fixups
3736 .endd
3737 for every message received.  Note that Sendmail will complain about such
3738 bad formatting, where Exim silently just does not fix it up.  This may change
3739 in future.
3740
3741 As this affects audit information, the caller must be a trusted user to use
3742 this option.
3743
3744 .vitem &%-h%&&~<&'number'&>
3745 .oindex "&%-h%&"
3746 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3747 This option is accepted for compatibility with Sendmail, but has no effect. (In
3748 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3749 headers.)
3750
3751 .vitem &%-i%&
3752 .oindex "&%-i%&"
3753 .cindex "Solaris" "&'mail'& command"
3754 .cindex "dot" "in incoming non-SMTP message"
3755 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3756 line by itself should not terminate an incoming, non-SMTP message. I can find
3757 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3758 command in Solaris 2.4 uses it. See also &%-ti%&.
3759
3760 .vitem &%-L%&&~<&'tag'&>
3761 .oindex "&%-L%&"
3762 .cindex "syslog" "process name; set with flag"
3763 This option is equivalent to setting &%syslog_processname%& in the config
3764 file and setting &%log_file_path%& to &`syslog`&.
3765 Its use is restricted to administrators.  The configuration file has to be
3766 read and parsed, to determine access rights, before this is set and takes
3767 effect, so early configuration file errors will not honour this flag.
3768
3769 The tag should not be longer than 32 characters.
3770
3771 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3772 .oindex "&%-M%&"
3773 .cindex "forcing delivery"
3774 .cindex "delivery" "forcing attempt"
3775 .cindex "frozen messages" "forcing delivery"
3776 This option requests Exim to run a delivery attempt on each message in turn. If
3777 any of the messages are frozen, they are automatically thawed before the
3778 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3779 and &%hold_domains%& are ignored.
3780
3781 Retry
3782 .cindex "hints database" "overriding retry hints"
3783 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3784 the normal retry time has not yet been reached. This option requires the caller
3785 to be an admin user. However, there is an option called &%prod_requires_admin%&
3786 which can be set false to relax this restriction (and also the same requirement
3787 for the &%-q%&, &%-R%&, and &%-S%& options).
3788
3789 The deliveries happen synchronously, that is, the original Exim process does
3790 not terminate until all the delivery attempts have finished. No output is
3791 produced unless there is a serious error. If you want to see what is happening,
3792 use the &%-v%& option as well, or inspect Exim's main log.
3793
3794 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3795 .oindex "&%-Mar%&"
3796 .cindex "message" "adding recipients"
3797 .cindex "recipient" "adding"
3798 This option requests Exim to add the addresses to the list of recipients of the
3799 message (&"ar"& for &"add recipients"&). The first argument must be a message
3800 id, and the remaining ones must be email addresses. However, if the message is
3801 active (in the middle of a delivery attempt), it is not altered. This option
3802 can be used only by an admin user.
3803
3804 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3805         &~<&'message&~id'&>"
3806 .oindex "&%-MC%&"
3807 .cindex "SMTP" "passed connection"
3808 .cindex "SMTP" "multiple deliveries"
3809 .cindex "multiple SMTP deliveries"
3810 This option is not intended for use by external callers. It is used internally
3811 by Exim to invoke another instance of itself to deliver a waiting message using
3812 an existing SMTP connection, which is passed as the standard input. Details are
3813 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3814 must be root or the Exim user in order to use it.
3815
3816 .vitem &%-MCA%&
3817 .oindex "&%-MCA%&"
3818 This option is not intended for use by external callers. It is used internally
3819 by Exim in conjunction with the &%-MC%& option. It signifies that the
3820 connection to the remote host has been authenticated.
3821
3822 .vitem &%-MCD%&
3823 .oindex "&%-MCD%&"
3824 This option is not intended for use by external callers. It is used internally
3825 by Exim in conjunction with the &%-MC%& option. It signifies that the
3826 remote host supports the ESMTP &_DSN_& extension.
3827
3828 .vitem &%-MCG%&&~<&'queue&~name'&>
3829 .oindex "&%-MCG%&"
3830 This option is not intended for use by external callers. It is used internally
3831 by Exim in conjunction with the &%-MC%& option. It signifies that an
3832 alternate queue is used, named by the following argument.
3833
3834 .vitem &%-MCK%&
3835 .oindex "&%-MCK%&"
3836 This option is not intended for use by external callers. It is used internally
3837 by Exim in conjunction with the &%-MC%& option. It signifies that an
3838 remote host supports the ESMTP &_CHUNKING_& extension.
3839
3840 .vitem &%-MCP%&
3841 .oindex "&%-MCP%&"
3842 This option is not intended for use by external callers. It is used internally
3843 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3844 which Exim is connected supports pipelining.
3845
3846 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3847 .oindex "&%-MCQ%&"
3848 This option is not intended for use by external callers. It is used internally
3849 by Exim in conjunction with the &%-MC%& option when the original delivery was
3850 started by a queue runner. It passes on the process id of the queue runner,
3851 together with the file descriptor number of an open pipe. Closure of the pipe
3852 signals the final completion of the sequence of processes that are passing
3853 messages through the same SMTP connection.
3854
3855 .vitem &%-MCS%&
3856 .oindex "&%-MCS%&"
3857 This option is not intended for use by external callers. It is used internally
3858 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3859 SMTP SIZE option should be used on messages delivered down the existing
3860 connection.
3861
3862 .vitem &%-MCT%&
3863 .oindex "&%-MCT%&"
3864 This option is not intended for use by external callers. It is used internally
3865 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3866 host to which Exim is connected supports TLS encryption.
3867
3868 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3869 .oindex "&%-MCt%&"
3870 This option is not intended for use by external callers. It is used internally
3871 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3872 connection is being proxied by a parent process for handling TLS encryption.
3873 The arguments give the local address and port being proxied, and the TLS cipher.
3874
3875 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3876 .oindex "&%-Mc%&"
3877 .cindex "hints database" "not overridden by &%-Mc%&"
3878 .cindex "delivery" "manually started &-- not forced"
3879 This option requests Exim to run a delivery attempt on each message in turn,
3880 but unlike the &%-M%& option, it does check for retry hints, and respects any
3881 that are found. This option is not very useful to external callers. It is
3882 provided mainly for internal use by Exim when it needs to re-invoke itself in
3883 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3884 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3885 respects retry times and other options such as &%hold_domains%& that are
3886 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3887 If you want to run a specific delivery as if in a queue run, you should use
3888 &%-q%& with a message id argument. A distinction between queue run deliveries
3889 and other deliveries is made in one or two places.
3890
3891 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3892 .oindex "&%-Mes%&"
3893 .cindex "message" "changing sender"
3894 .cindex "sender" "changing"
3895 This option requests Exim to change the sender address in the message to the
3896 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3897 &"edit sender"&). There must be exactly two arguments. The first argument must
3898 be a message id, and the second one an email address. However, if the message
3899 is active (in the middle of a delivery attempt), its status is not altered.
3900 This option can be used only by an admin user.
3901
3902 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3903 .oindex "&%-Mf%&"
3904 .cindex "freezing messages"
3905 .cindex "message" "manually freezing"
3906 This option requests Exim to mark each listed message as &"frozen"&. This
3907 prevents any delivery attempts taking place until the message is &"thawed"&,
3908 either manually or as a result of the &%auto_thaw%& configuration option.
3909 However, if any of the messages are active (in the middle of a delivery
3910 attempt), their status is not altered. This option can be used only by an admin
3911 user.
3912
3913 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3914 .oindex "&%-Mg%&"
3915 .cindex "giving up on messages"
3916 .cindex "message" "abandoning delivery attempts"
3917 .cindex "delivery" "abandoning further attempts"
3918 This option requests Exim to give up trying to deliver the listed messages,
3919 including any that are frozen. However, if any of the messages are active,
3920 their status is not altered. For non-bounce messages, a delivery error message
3921 is sent to the sender, containing the text &"cancelled by administrator"&.
3922 Bounce messages are just discarded. This option can be used only by an admin
3923 user.
3924
3925 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3926 .oindex "&%-Mmad%&"
3927 .cindex "delivery" "cancelling all"
3928 This option requests Exim to mark all the recipient addresses in the messages
3929 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3930 message is active (in the middle of a delivery attempt), its status is not
3931 altered. This option can be used only by an admin user.
3932
3933 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3934 .oindex "&%-Mmd%&"
3935 .cindex "delivery" "cancelling by address"
3936 .cindex "recipient" "removing"
3937 .cindex "removing recipients"
3938 This option requests Exim to mark the given addresses as already delivered
3939 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3940 the remaining ones must be email addresses. These are matched to recipient
3941 addresses in the message in a case-sensitive manner. If the message is active
3942 (in the middle of a delivery attempt), its status is not altered. This option
3943 can be used only by an admin user.
3944
3945 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3946 .oindex "&%-Mrm%&"
3947 .cindex "removing messages"
3948 .cindex "abandoning mail"
3949 .cindex "message" "manually discarding"
3950 This option requests Exim to remove the given messages from the queue. No
3951 bounce messages are sent; each message is simply forgotten. However, if any of
3952 the messages are active, their status is not altered. This option can be used
3953 only by an admin user or by the user who originally caused the message to be
3954 placed on the queue.
3955
3956 .vitem &%-Mset%&&~<&'message&~id'&>
3957 .oindex "&%-Mset%&
3958 .cindex "testing" "string expansion"
3959 .cindex "expansion" "testing"
3960 This option is useful only in conjunction with &%-be%& (that is, when testing
3961 string expansions). Exim loads the given message from its spool before doing
3962 the test expansions, thus setting message-specific variables such as
3963 &$message_size$& and the header variables. The &$recipients$& variable is made
3964 available. This feature is provided to make it easier to test expansions that
3965 make use of these variables. However, this option can be used only by an admin
3966 user. See also &%-bem%&.
3967
3968 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3969 .oindex "&%-Mt%&"
3970 .cindex "thawing messages"
3971 .cindex "unfreezing messages"
3972 .cindex "frozen messages" "thawing"
3973 .cindex "message" "thawing frozen"
3974 This option requests Exim to &"thaw"& any of the listed messages that are
3975 &"frozen"&, so that delivery attempts can resume. However, if any of the
3976 messages are active, their status is not altered. This option can be used only
3977 by an admin user.
3978
3979 .vitem &%-Mvb%&&~<&'message&~id'&>
3980 .oindex "&%-Mvb%&"
3981 .cindex "listing" "message body"
3982 .cindex "message" "listing body of"
3983 This option causes the contents of the message body (-D) spool file to be
3984 written to the standard output. This option can be used only by an admin user.
3985
3986 .vitem &%-Mvc%&&~<&'message&~id'&>
3987 .oindex "&%-Mvc%&"
3988 .cindex "message" "listing in RFC 2822 format"
3989 .cindex "listing" "message in RFC 2822 format"
3990 This option causes a copy of the complete message (header lines plus body) to
3991 be written to the standard output in RFC 2822 format. This option can be used
3992 only by an admin user.
3993
3994 .vitem &%-Mvh%&&~<&'message&~id'&>
3995 .oindex "&%-Mvh%&"
3996 .cindex "listing" "message headers"
3997 .cindex "header lines" "listing"
3998 .cindex "message" "listing header lines"
3999 This option causes the contents of the message headers (-H) spool file to be
4000 written to the standard output. This option can be used only by an admin user.
4001
4002 .vitem &%-Mvl%&&~<&'message&~id'&>
4003 .oindex "&%-Mvl%&"
4004 .cindex "listing" "message log"
4005 .cindex "message" "listing message log"
4006 This option causes the contents of the message log spool file to be written to
4007 the standard output. This option can be used only by an admin user.
4008
4009 .vitem &%-m%&
4010 .oindex "&%-m%&"
4011 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4012 treats it that way too.
4013
4014 .vitem &%-N%&
4015 .oindex "&%-N%&"
4016 .cindex "debugging" "&%-N%& option"
4017 .cindex "debugging" "suppressing delivery"
4018 This is a debugging option that inhibits delivery of a message at the transport
4019 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4020 it just doesn't actually transport the message, but instead behaves as if it
4021 had successfully done so. However, it does not make any updates to the retry
4022 database, and the log entries for deliveries are flagged with &"*>"& rather
4023 than &"=>"&.
4024
4025 Because &%-N%& discards any message to which it applies, only root or the Exim
4026 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4027 words, an ordinary user can use it only when supplying an incoming message to
4028 which it will apply. Although transportation never fails when &%-N%& is set, an
4029 address may be deferred because of a configuration problem on a transport, or a
4030 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4031 the message, and applies to any subsequent delivery attempts that may happen
4032 for that message.
4033
4034 .vitem &%-n%&
4035 .oindex "&%-n%&"
4036 This option is interpreted by Sendmail to mean &"no aliasing"&.
4037 For normal modes of operation, it is ignored by Exim.
4038 When combined with &%-bP%& it makes the output more terse (suppresses
4039 option names, environment values and config pretty printing).
4040
4041 .vitem &%-O%&&~<&'data'&>
4042 .oindex "&%-O%&"
4043 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4044 Exim.
4045
4046 .vitem &%-oA%&&~<&'file&~name'&>
4047 .oindex "&%-oA%&"
4048 .cindex "Sendmail compatibility" "&%-oA%& option"
4049 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4050 alternative alias file name. Exim handles &%-bi%& differently; see the
4051 description above.
4052
4053 .vitem &%-oB%&&~<&'n'&>
4054 .oindex "&%-oB%&"
4055 .cindex "SMTP" "passed connection"
4056 .cindex "SMTP" "multiple deliveries"
4057 .cindex "multiple SMTP deliveries"
4058 This is a debugging option which limits the maximum number of messages that can
4059 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4060 transport. If <&'n'&> is omitted, the limit is set to 1.
4061
4062 .vitem &%-odb%&
4063 .oindex "&%-odb%&"
4064 .cindex "background delivery"
4065 .cindex "delivery" "in the background"
4066 This option applies to all modes in which Exim accepts incoming messages,
4067 including the listening daemon. It requests &"background"& delivery of such
4068 messages, which means that the accepting process automatically starts a
4069 delivery process for each message received, but does not wait for the delivery
4070 processes to finish.
4071
4072 When all the messages have been received, the reception process exits,
4073 leaving the delivery processes to finish in their own time. The standard output
4074 and error streams are closed at the start of each delivery process.
4075 This is the default action if none of the &%-od%& options are present.
4076
4077 If one of the queueing options in the configuration file
4078 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4079 overrides it if &%queue_only_override%& is set true, which is the default
4080 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4081
4082 .vitem &%-odf%&
4083 .oindex "&%-odf%&"
4084 .cindex "foreground delivery"
4085 .cindex "delivery" "in the foreground"
4086 This option requests &"foreground"& (synchronous) delivery when Exim has
4087 accepted a locally-generated message. (For the daemon it is exactly the same as
4088 &%-odb%&.) A delivery process is automatically started to deliver the message,
4089 and Exim waits for it to complete before proceeding.
4090
4091 The original Exim reception process does not finish until the delivery
4092 process for the final message has ended. The standard error stream is left open
4093 during deliveries.
4094
4095 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4096 false and one of the queueing options in the configuration file is in effect.
4097
4098 If there is a temporary delivery error during foreground delivery, the
4099 message is left on the queue for later delivery, and the original reception
4100 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4101 restricted configuration that never queues messages.
4102
4103
4104 .vitem &%-odi%&
4105 .oindex "&%-odi%&"
4106 This option is synonymous with &%-odf%&. It is provided for compatibility with
4107 Sendmail.
4108
4109 .vitem &%-odq%&
4110 .oindex "&%-odq%&"
4111 .cindex "non-immediate delivery"
4112 .cindex "delivery" "suppressing immediate"
4113 .cindex "queueing incoming messages"
4114 This option applies to all modes in which Exim accepts incoming messages,
4115 including the listening daemon. It specifies that the accepting process should
4116 not automatically start a delivery process for each message received. Messages
4117 are placed on the queue, and remain there until a subsequent queue runner
4118 process encounters them. There are several configuration options (such as
4119 &%queue_only%&) that can be used to queue incoming messages under certain
4120 conditions. This option overrides all of them and also &%-odqs%&. It always
4121 forces queueing.
4122
4123 .vitem &%-odqs%&
4124 .oindex "&%-odqs%&"
4125 .cindex "SMTP" "delaying delivery"
4126 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4127 However, like &%-odb%& and &%-odi%&, this option has no effect if
4128 &%queue_only_override%& is false and one of the queueing options in the
4129 configuration file is in effect.
4130
4131 When &%-odqs%& does operate, a delivery process is started for each incoming
4132 message, in the background by default, but in the foreground if &%-odi%& is
4133 also present. The recipient addresses are routed, and local deliveries are done
4134 in the normal way. However, if any SMTP deliveries are required, they are not
4135 done at this time, so the message remains on the queue until a subsequent queue
4136 runner process encounters it. Because routing was done, Exim knows which
4137 messages are waiting for which hosts, and so a number of messages for the same
4138 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4139 configuration option has the same effect for specific domains. See also the
4140 &%-qq%& option.
4141
4142 .vitem &%-oee%&
4143 .oindex "&%-oee%&"
4144 .cindex "error" "reporting"
4145 If an error is detected while a non-SMTP message is being received (for
4146 example, a malformed address), the error is reported to the sender in a mail
4147 message.
4148
4149 .cindex "return code" "for &%-oee%&"
4150 Provided
4151 this error message is successfully sent, the Exim receiving process
4152 exits with a return code of zero. If not, the return code is 2 if the problem
4153 is that the original message has no recipients, or 1 for any other error.
4154 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4155
4156 .vitem &%-oem%&
4157 .oindex "&%-oem%&"
4158 .cindex "error" "reporting"
4159 .cindex "return code" "for &%-oem%&"
4160 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4161 return code, whether or not the error message was successfully sent.
4162 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4163
4164 .vitem &%-oep%&
4165 .oindex "&%-oep%&"
4166 .cindex "error" "reporting"
4167 If an error is detected while a non-SMTP message is being received, the
4168 error is reported by writing a message to the standard error file (stderr).
4169 .cindex "return code" "for &%-oep%&"
4170 The return code is 1 for all errors.
4171
4172 .vitem &%-oeq%&
4173 .oindex "&%-oeq%&"
4174 .cindex "error" "reporting"
4175 This option is supported for compatibility with Sendmail, but has the same
4176 effect as &%-oep%&.
4177
4178 .vitem &%-oew%&
4179 .oindex "&%-oew%&"
4180 .cindex "error" "reporting"
4181 This option is supported for compatibility with Sendmail, but has the same
4182 effect as &%-oem%&.
4183
4184 .vitem &%-oi%&
4185 .oindex "&%-oi%&"
4186 .cindex "dot" "in incoming non-SMTP message"
4187 This option, which has the same effect as &%-i%&, specifies that a dot on a
4188 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4189 single dot does terminate, though Exim does no special processing for other
4190 lines that start with a dot. This option is set by default if Exim is called as
4191 &'rmail'&. See also &%-ti%&.
4192
4193 .vitem &%-oitrue%&
4194 .oindex "&%-oitrue%&"
4195 This option is treated as synonymous with &%-oi%&.
4196
4197 .vitem &%-oMa%&&~<&'host&~address'&>
4198 .oindex "&%-oMa%&"
4199 .cindex "sender" "host address, specifying for local message"
4200 A number of options starting with &%-oM%& can be used to set values associated
4201 with remote hosts on locally-submitted messages (that is, messages not received
4202 over TCP/IP). These options can be used by any caller in conjunction with the
4203 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4204 other circumstances, they are ignored unless the caller is trusted.
4205
4206 The &%-oMa%& option sets the sender host address. This may include a port
4207 number at the end, after a full stop (period). For example:
4208 .code
4209 exim -bs -oMa 10.9.8.7.1234
4210 .endd
4211 An alternative syntax is to enclose the IP address in square brackets,
4212 followed by a colon and the port number:
4213 .code
4214 exim -bs -oMa [10.9.8.7]:1234
4215 .endd
4216 The IP address is placed in the &$sender_host_address$& variable, and the
4217 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4218 are present on the command line, the sender host IP address is taken from
4219 whichever one is last.
4220
4221 .vitem &%-oMaa%&&~<&'name'&>
4222 .oindex "&%-oMaa%&"
4223 .cindex "authentication" "name, specifying for local message"
4224 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4225 option sets the value of &$sender_host_authenticated$& (the authenticator
4226 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4227 This option can be used with &%-bh%& and &%-bs%& to set up an
4228 authenticated SMTP session without actually using the SMTP AUTH command.
4229
4230 .vitem &%-oMai%&&~<&'string'&>
4231 .oindex "&%-oMai%&"
4232 .cindex "authentication" "id, specifying for local message"
4233 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4234 option sets the value of &$authenticated_id$& (the id that was authenticated).
4235 This overrides the default value (the caller's login id, except with &%-bh%&,
4236 where there is no default) for messages from local sources. See chapter
4237 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4238
4239 .vitem &%-oMas%&&~<&'address'&>
4240 .oindex "&%-oMas%&"
4241 .cindex "authentication" "sender, specifying for local message"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4243 option sets the authenticated sender value in &$authenticated_sender$&. It
4244 overrides the sender address that is created from the caller's login id for
4245 messages from local sources, except when &%-bh%& is used, when there is no
4246 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4247 specified on a MAIL command overrides this value. See chapter
4248 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4249
4250 .vitem &%-oMi%&&~<&'interface&~address'&>
4251 .oindex "&%-oMi%&"
4252 .cindex "interface" "address, specifying for local message"
4253 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4254 option sets the IP interface address value. A port number may be included,
4255 using the same syntax as for &%-oMa%&. The interface address is placed in
4256 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4257
4258 .vitem &%-oMm%&&~<&'message&~reference'&>
4259 .oindex "&%-oMm%&"
4260 .cindex "message reference" "message reference, specifying for local message"
4261 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4262 option sets the message reference, e.g. message-id, and is logged during
4263 delivery. This is useful when some kind of audit trail is required to tie
4264 messages together. The format of the message reference is checked and will
4265 abort if the format is invalid. The option will only be accepted if exim is
4266 running in trusted mode, not as any regular user.
4267
4268 The best example of a message reference is when Exim sends a bounce message.
4269 The message reference is the message-id of the original message for which Exim
4270 is sending the bounce.
4271
4272 .vitem &%-oMr%&&~<&'protocol&~name'&>
4273 .oindex "&%-oMr%&"
4274 .cindex "protocol, specifying for local message"
4275 .vindex "&$received_protocol$&"
4276 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4277 option sets the received protocol value that is stored in
4278 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4279 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4280 SMTP protocol names (see the description of &$received_protocol$& in section
4281 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4282 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4283 be set by &%-oMr%&. Repeated use of this option is not supported.
4284
4285 .vitem &%-oMs%&&~<&'host&~name'&>
4286 .oindex "&%-oMs%&"
4287 .cindex "sender" "host name, specifying for local message"
4288 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4289 option sets the sender host name in &$sender_host_name$&. When this option is
4290 present, Exim does not attempt to look up a host name from an IP address; it
4291 uses the name it is given.
4292
4293 .vitem &%-oMt%&&~<&'ident&~string'&>
4294 .oindex "&%-oMt%&"
4295 .cindex "sender" "ident string, specifying for local message"
4296 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4297 option sets the sender ident value in &$sender_ident$&. The default setting for
4298 local callers is the login id of the calling process, except when &%-bh%& is
4299 used, when there is no default.
4300
4301 .vitem &%-om%&
4302 .oindex "&%-om%&"
4303 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4304 In Sendmail, this option means &"me too"&, indicating that the sender of a
4305 message should receive a copy of the message if the sender appears in an alias
4306 expansion. Exim always does this, so the option does nothing.
4307
4308 .vitem &%-oo%&
4309 .oindex "&%-oo%&"
4310 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4311 This option is ignored. In Sendmail it specifies &"old style headers"&,
4312 whatever that means.
4313
4314 .vitem &%-oP%&&~<&'path'&>
4315 .oindex "&%-oP%&"
4316 .cindex "pid (process id)" "of daemon"
4317 .cindex "daemon" "process id (pid)"
4318 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4319 value. The option specifies the file to which the process id of the daemon is
4320 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4321 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4322 because in those cases, the normal pid file is not used.
4323
4324 .vitem &%-or%&&~<&'time'&>
4325 .oindex "&%-or%&"
4326 .cindex "timeout" "for non-SMTP input"
4327 This option sets a timeout value for incoming non-SMTP messages. If it is not
4328 set, Exim will wait forever for the standard input. The value can also be set
4329 by the &%receive_timeout%& option. The format used for specifying times is
4330 described in section &<<SECTtimeformat>>&.
4331
4332 .vitem &%-os%&&~<&'time'&>
4333 .oindex "&%-os%&"
4334 .cindex "timeout" "for SMTP input"
4335 .cindex "SMTP" "input timeout"
4336 This option sets a timeout value for incoming SMTP messages. The timeout
4337 applies to each SMTP command and block of data. The value can also be set by
4338 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4339 for specifying times is described in section &<<SECTtimeformat>>&.
4340
4341 .vitem &%-ov%&
4342 .oindex "&%-ov%&"
4343 This option has exactly the same effect as &%-v%&.
4344
4345 .vitem &%-oX%&&~<&'number&~or&~string'&>
4346 .oindex "&%-oX%&"
4347 .cindex "TCP/IP" "setting listening ports"
4348 .cindex "TCP/IP" "setting listening interfaces"
4349 .cindex "port" "receiving TCP/IP"
4350 This option is relevant only when the &%-bd%& (start listening daemon) option
4351 is also given. It controls which ports and interfaces the daemon uses. Details
4352 of the syntax, and how it interacts with configuration file options, are given
4353 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4354 file is written unless &%-oP%& is also present to specify a pid file name.
4355
4356 .vitem &%-pd%&
4357 .oindex "&%-pd%&"
4358 .cindex "Perl" "starting the interpreter"
4359 This option applies when an embedded Perl interpreter is linked with Exim (see
4360 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4361 option, forcing the starting of the interpreter to be delayed until it is
4362 needed.
4363
4364 .vitem &%-ps%&
4365 .oindex "&%-ps%&"
4366 .cindex "Perl" "starting the interpreter"
4367 This option applies when an embedded Perl interpreter is linked with Exim (see
4368 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4369 option, forcing the starting of the interpreter to occur as soon as Exim is
4370 started.
4371
4372 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4373 .oindex "&%-p%&"
4374 For compatibility with Sendmail, this option is equivalent to
4375 .display
4376 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4377 .endd
4378 It sets the incoming protocol and host name (for trusted callers). The
4379 host name and its colon can be omitted when only the protocol is to be set.
4380 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4381 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4382 or &`s`& using this option (but that does not seem a real limitation).
4383 Repeated use of this option is not supported.
4384
4385 .vitem &%-q%&
4386 .oindex "&%-q%&"
4387 .cindex "queue runner" "starting manually"
4388 This option is normally restricted to admin users. However, there is a
4389 configuration option called &%prod_requires_admin%& which can be set false to
4390 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4391 and &%-S%& options).
4392
4393 .cindex "queue runner" "description of operation"
4394 If other commandline options do not specify an action,
4395 the &%-q%& option starts one queue runner process. This scans the queue of
4396 waiting messages, and runs a delivery process for each one in turn. It waits
4397 for each delivery process to finish before starting the next one. A delivery
4398 process may not actually do any deliveries if the retry times for the addresses
4399 have not been reached. Use &%-qf%& (see below) if you want to override this.
4400
4401 If
4402 .cindex "SMTP" "passed connection"
4403 .cindex "SMTP" "multiple deliveries"
4404 .cindex "multiple SMTP deliveries"
4405 the delivery process spawns other processes to deliver other messages down
4406 passed SMTP connections, the queue runner waits for these to finish before
4407 proceeding.
4408
4409 When all the queued messages have been considered, the original queue runner
4410 process terminates. In other words, a single pass is made over the waiting
4411 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4412 this to be repeated periodically.
4413
4414 Exim processes the waiting messages in an unpredictable order. It isn't very
4415 random, but it is likely to be different each time, which is all that matters.
4416 If one particular message screws up a remote MTA, other messages to the same
4417 MTA have a chance of getting through if they get tried first.
4418
4419 It is possible to cause the messages to be processed in lexical message id
4420 order, which is essentially the order in which they arrived, by setting the
4421 &%queue_run_in_order%& option, but this is not recommended for normal use.
4422
4423 .vitem &%-q%&<&'qflags'&>
4424 The &%-q%& option may be followed by one or more flag letters that change its
4425 behaviour. They are all optional, but if more than one is present, they must
4426 appear in the correct order. Each flag is described in a separate item below.
4427
4428 .vitem &%-qq...%&
4429 .oindex "&%-qq%&"
4430 .cindex "queue" "double scanning"
4431 .cindex "queue" "routing"
4432 .cindex "routing" "whole queue before delivery"
4433 An option starting with &%-qq%& requests a two-stage queue run. In the first
4434 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4435 every domain. Addresses are routed, local deliveries happen, but no remote
4436 transports are run.
4437
4438 .cindex "hints database" "remembering routing"
4439 The hints database that remembers which messages are waiting for specific hosts
4440 is updated, as if delivery to those hosts had been deferred. After this is
4441 complete, a second, normal queue scan happens, with routing and delivery taking
4442 place as normal. Messages that are routed to the same host should mostly be
4443 delivered down a single SMTP
4444 .cindex "SMTP" "passed connection"
4445 .cindex "SMTP" "multiple deliveries"
4446 .cindex "multiple SMTP deliveries"
4447 connection because of the hints that were set up during the first queue scan.
4448 This option may be useful for hosts that are connected to the Internet
4449 intermittently.
4450
4451 .vitem &%-q[q]i...%&
4452 .oindex "&%-qi%&"
4453 .cindex "queue" "initial delivery"
4454 If the &'i'& flag is present, the queue runner runs delivery processes only for
4455 those messages that haven't previously been tried. (&'i'& stands for &"initial
4456 delivery"&.) This can be helpful if you are putting messages on the queue using
4457 &%-odq%& and want a queue runner just to process the new messages.
4458
4459 .vitem &%-q[q][i]f...%&
4460 .oindex "&%-qf%&"
4461 .cindex "queue" "forcing delivery"
4462 .cindex "delivery" "forcing in queue run"
4463 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4464 message, whereas without &'f'& only those non-frozen addresses that have passed
4465 their retry times are tried.
4466
4467 .vitem &%-q[q][i]ff...%&
4468 .oindex "&%-qff%&"
4469 .cindex "frozen messages" "forcing delivery"
4470 If &'ff'& is present, a delivery attempt is forced for every message, whether
4471 frozen or not.
4472
4473 .vitem &%-q[q][i][f[f]]l%&
4474 .oindex "&%-ql%&"
4475 .cindex "queue" "local deliveries only"
4476 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4477 be done. If a message requires any remote deliveries, it remains on the queue
4478 for later delivery.
4479
4480 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4481 .oindex "&%-qG%&"
4482 .cindex queue named
4483 .cindex "named queues"
4484 .cindex "queue" "delivering specific messages"
4485 If the &'G'& flag and a name is present, the queue runner operates on the
4486 queue with the given name rather than the default queue.
4487 The name should not contain a &'/'& character.
4488 For a periodic queue run (see below)
4489 append to the name a slash and a time value.
4490
4491 If other commandline options specify an action, a &'-qG<name>'& option
4492 will specify a queue to operate on.
4493 For example:
4494 .code
4495 exim -bp -qGquarantine
4496 mailq -qGquarantine
4497 exim -qGoffpeak -Rf @special.domain.example
4498 .endd
4499
4500 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4501 When scanning the queue, Exim can be made to skip over messages whose ids are
4502 lexically less than a given value by following the &%-q%& option with a
4503 starting message id. For example:
4504 .code
4505 exim -q 0t5C6f-0000c8-00
4506 .endd
4507 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4508 second message id is given, messages whose ids are lexically greater than it
4509 are also skipped. If the same id is given twice, for example,
4510 .code
4511 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4512 .endd
4513 just one delivery process is started, for that message. This differs from
4514 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4515 that it counts as a delivery from a queue run. Note that the selection
4516 mechanism does not affect the order in which the messages are scanned. There
4517 are also other ways of selecting specific sets of messages for delivery in a
4518 queue run &-- see &%-R%& and &%-S%&.
4519
4520 .vitem &%-q%&<&'qflags'&><&'time'&>
4521 .cindex "queue runner" "starting periodically"
4522 .cindex "periodic queue running"
4523 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4524 starting a queue runner process at intervals specified by the given time value
4525 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4526 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4527 single daemon process handles both functions. A common way of starting up a
4528 combined daemon at system boot time is to use a command such as
4529 .code
4530 /usr/exim/bin/exim -bd -q30m
4531 .endd
4532 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4533 process every 30 minutes.
4534
4535 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4536 pid file is written unless one is explicitly requested by the &%-oP%& option.
4537
4538 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4539 .oindex "&%-qR%&"
4540 This option is synonymous with &%-R%&. It is provided for Sendmail
4541 compatibility.
4542
4543 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4544 .oindex "&%-qS%&"
4545 This option is synonymous with &%-S%&.
4546
4547 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4548 .oindex "&%-R%&"
4549 .cindex "queue runner" "for specific recipients"
4550 .cindex "delivery" "to given domain"
4551 .cindex "domain" "delivery to"
4552 The <&'rsflags'&> may be empty, in which case the white space before the string
4553 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4554 which are the possible values for <&'rsflags'&>. White space is required if
4555 <&'rsflags'&> is not empty.
4556
4557 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4558 perform a single queue run, except that, when scanning the messages on the
4559 queue, Exim processes only those that have at least one undelivered recipient
4560 address containing the given string, which is checked in a case-independent
4561 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4562 regular expression; otherwise it is a literal string.
4563
4564 If you want to do periodic queue runs for messages with specific recipients,
4565 you can combine &%-R%& with &%-q%& and a time value. For example:
4566 .code
4567 exim -q25m -R @special.domain.example
4568 .endd
4569 This example does a queue run for messages with recipients in the given domain
4570 every 25 minutes. Any additional flags that are specified with &%-q%& are
4571 applied to each queue run.
4572
4573 Once a message is selected for delivery by this mechanism, all its addresses
4574 are processed. For the first selected message, Exim overrides any retry
4575 information and forces a delivery attempt for each undelivered address. This
4576 means that if delivery of any address in the first message is successful, any
4577 existing retry information is deleted, and so delivery attempts for that
4578 address in subsequently selected messages (which are processed without forcing)
4579 will run. However, if delivery of any address does not succeed, the retry
4580 information is updated, and in subsequently selected messages, the failing
4581 address will be skipped.
4582
4583 .cindex "frozen messages" "forcing delivery"
4584 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4585 all selected messages, not just the first; frozen messages are included when
4586 &'ff'& is present.
4587
4588 The &%-R%& option makes it straightforward to initiate delivery of all messages
4589 to a given domain after a host has been down for some time. When the SMTP
4590 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4591 effect is to run Exim with the &%-R%& option, but it can be configured to run
4592 an arbitrary command instead.
4593
4594 .vitem &%-r%&
4595 .oindex "&%-r%&"
4596 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4597
4598 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4599 .oindex "&%-S%&"
4600 .cindex "delivery" "from given sender"
4601 .cindex "queue runner" "for specific senders"
4602 This option acts like &%-R%& except that it checks the string against each
4603 message's sender instead of against the recipients. If &%-R%& is also set, both
4604 conditions must be met for a message to be selected. If either of the options
4605 has &'f'& or &'ff'& in its flags, the associated action is taken.
4606
4607 .vitem &%-Tqt%&&~<&'times'&>
4608 .oindex "&%-Tqt%&"
4609 This is an option that is exclusively for use by the Exim testing suite. It is not
4610 recognized when Exim is run normally. It allows for the setting up of explicit
4611 &"queue times"& so that various warning/retry features can be tested.
4612
4613 .vitem &%-t%&
4614 .oindex "&%-t%&"
4615 .cindex "recipient" "extracting from header lines"
4616 .cindex "&'Bcc:'& header line"
4617 .cindex "&'Cc:'& header line"
4618 .cindex "&'To:'& header line"
4619 When Exim is receiving a locally-generated, non-SMTP message on its standard
4620 input, the &%-t%& option causes the recipients of the message to be obtained
4621 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4622 from the command arguments. The addresses are extracted before any rewriting
4623 takes place and the &'Bcc:'& header line, if present, is then removed.
4624
4625 .cindex "Sendmail compatibility" "&%-t%& option"
4626 If the command has any arguments, they specify addresses to which the message
4627 is &'not'& to be delivered. That is, the argument addresses are removed from
4628 the recipients list obtained from the headers. This is compatible with Smail 3
4629 and in accordance with the documented behaviour of several versions of
4630 Sendmail, as described in man pages on a number of operating systems (e.g.
4631 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4632 argument addresses to those obtained from the headers, and the O'Reilly
4633 Sendmail book documents it that way. Exim can be made to add argument addresses
4634 instead of subtracting them by setting the option
4635 &%extract_addresses_remove_arguments%& false.
4636
4637 .cindex "&%Resent-%& header lines" "with &%-t%&"
4638 If there are any &%Resent-%& header lines in the message, Exim extracts
4639 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4640 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4641 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4642 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4643
4644 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4645 message is resent several times). The RFC also specifies that they should be
4646 added at the front of the message, and separated by &'Received:'& lines. It is
4647 not at all clear how &%-t%& should operate in the present of multiple sets,
4648 nor indeed exactly what constitutes a &"set"&.
4649 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4650 are often added at the end of the header, and if a message is resent more than
4651 once, it is common for the original set of &%Resent-%& headers to be renamed as
4652 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4653
4654 .vitem &%-ti%&
4655 .oindex "&%-ti%&"
4656 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4657 compatibility with Sendmail.
4658
4659 .vitem &%-tls-on-connect%&
4660 .oindex "&%-tls-on-connect%&"
4661 .cindex "TLS" "use without STARTTLS"
4662 .cindex "TLS" "automatic start"
4663 This option is available when Exim is compiled with TLS support. It forces all
4664 incoming SMTP connections to behave as if the incoming port is listed in the
4665 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4666 &<<CHAPTLS>>& for further details.
4667
4668
4669 .vitem &%-U%&
4670 .oindex "&%-U%&"
4671 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4672 Sendmail uses this option for &"initial message submission"&, and its
4673 documentation states that in future releases, it may complain about
4674 syntactically invalid messages rather than fixing them when this flag is not
4675 set. Exim ignores this option.
4676
4677 .vitem &%-v%&
4678 .oindex "&%-v%&"
4679 This option causes Exim to write information to the standard error stream,
4680 describing what it is doing. In particular, it shows the log lines for
4681 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4682 dialogue is shown. Some of the log lines shown may not actually be written to
4683 the log if the setting of &%log_selector%& discards them. Any relevant
4684 selectors are shown with each log line. If none are shown, the logging is
4685 unconditional.
4686
4687 .vitem &%-x%&
4688 .oindex "&%-x%&"
4689 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4690 National Language Support extended characters in the body of the mail item"&).
4691 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4692 this option.
4693
4694 .vitem &%-X%&&~<&'logfile'&>
4695 .oindex "&%-X%&"
4696 This option is interpreted by Sendmail to cause debug information to be sent
4697 to the named file.  It is ignored by Exim.
4698
4699 .vitem &%-z%&&~<&'log-line'&>
4700 .oindex "&%-z%&"
4701 This option writes its argument to Exim's logfile.
4702 Use is restricted to administrators; the intent is for operational notes.
4703 Quotes should be used to maintain a multi-word item as a single argument,
4704 under most shells.
4705 .endlist
4706
4707 .ecindex IIDclo1
4708 .ecindex IIDclo2
4709
4710
4711 . ////////////////////////////////////////////////////////////////////////////
4712 . Insert a stylized DocBook comment here, to identify the end of the command
4713 . line options. This is for the benefit of the Perl script that automatically
4714 . creates a man page for the options.
4715 . ////////////////////////////////////////////////////////////////////////////
4716
4717 .literal xml
4718 <!-- === End of command line options === -->
4719 .literal off
4720
4721
4722
4723
4724
4725 . ////////////////////////////////////////////////////////////////////////////
4726 . ////////////////////////////////////////////////////////////////////////////
4727
4728
4729 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4730          "The runtime configuration file"
4731
4732 .cindex "run time configuration"
4733 .cindex "configuration file" "general description"
4734 .cindex "CONFIGURE_FILE"
4735 .cindex "configuration file" "errors in"
4736 .cindex "error" "in configuration file"
4737 .cindex "return code" "for bad configuration"
4738 Exim uses a single run time configuration file that is read whenever an Exim
4739 binary is executed. Note that in normal operation, this happens frequently,
4740 because Exim is designed to operate in a distributed manner, without central
4741 control.
4742
4743 If a syntax error is detected while reading the configuration file, Exim
4744 writes a message on the standard error, and exits with a non-zero return code.
4745 The message is also written to the panic log. &*Note*&: Only simple syntax
4746 errors can be detected at this time. The values of any expanded options are
4747 not checked until the expansion happens, even when the expansion does not
4748 actually alter the string.
4749
4750 The name of the configuration file is compiled into the binary for security
4751 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4752 most configurations, this specifies a single file. However, it is permitted to
4753 give a colon-separated list of file names, in which case Exim uses the first
4754 existing file in the list.
4755
4756 .cindex "EXIM_USER"
4757 .cindex "EXIM_GROUP"
4758 .cindex "CONFIGURE_OWNER"
4759 .cindex "CONFIGURE_GROUP"
4760 .cindex "configuration file" "ownership"
4761 .cindex "ownership" "configuration file"
4762 The run time configuration file must be owned by root or by the user that is
4763 specified at compile time by the CONFIGURE_OWNER option (if set). The
4764 configuration file must not be world-writeable, or group-writeable unless its
4765 group is the root group or the one specified at compile time by the
4766 CONFIGURE_GROUP option.
4767
4768 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4769 to root, anybody who is able to edit the run time configuration file has an
4770 easy way to run commands as root. If you specify a user or group in the
4771 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4772 who are members of that group will trivially be able to obtain root privileges.
4773
4774 Up to Exim version 4.72, the run time configuration file was also permitted to
4775 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4776 since it offered a simple privilege escalation for any attacker who managed to
4777 compromise the Exim user account.
4778
4779 A default configuration file, which will work correctly in simple situations,
4780 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4781 defines just one file name, the installation process copies the default
4782 configuration to a new file of that name if it did not previously exist. If
4783 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4784 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4785 configuration.
4786
4787
4788
4789 .section "Using a different configuration file" "SECID40"
4790 .cindex "configuration file" "alternate"
4791 A one-off alternate configuration can be specified by the &%-C%& command line
4792 option, which may specify a single file or a list of files. However, when
4793 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4794 unless the argument for &%-C%& is identical to the built-in value from
4795 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4796 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4797 is useful mainly for checking the syntax of configuration files before
4798 installing them. No owner or group checks are done on a configuration file
4799 specified by &%-C%&, if root privilege has been dropped.
4800
4801 Even the Exim user is not trusted to specify an arbitrary configuration file
4802 with the &%-C%& option to be used with root privileges, unless that file is
4803 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4804 testing a configuration using &%-C%& right through message reception and
4805 delivery, even if the caller is root. The reception works, but by that time,
4806 Exim is running as the Exim user, so when it re-execs to regain privilege for
4807 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4808 can test reception and delivery using two separate commands (one to put a
4809 message on the queue, using &%-odq%&, and another to do the delivery, using
4810 &%-M%&).
4811
4812 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4813 prefix string with which any file named in a &%-C%& command line option must
4814 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4815 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4816 name can be used with &%-C%&.
4817
4818 One-off changes to a configuration can be specified by the &%-D%& command line
4819 option, which defines and overrides values for macros used inside the
4820 configuration file. However, like &%-C%&, the use of this option by a
4821 non-privileged user causes Exim to discard its root privilege.
4822 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4823 completely disabled, and its use causes an immediate error exit.
4824
4825 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4826 to declare certain macro names trusted, such that root privilege will not
4827 necessarily be discarded.
4828 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4829 considered safe and, if &%-D%& only supplies macros from this list, and the
4830 values are acceptable, then Exim will not give up root privilege if the caller
4831 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4832 transition mechanism and is expected to be removed in the future.  Acceptable
4833 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4834
4835 Some sites may wish to use the same Exim binary on different machines that
4836 share a file system, but to use different configuration files on each machine.
4837 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4838 looks for a file whose name is the configuration file name followed by a dot
4839 and the machine's node name, as obtained from the &[uname()]& function. If this
4840 file does not exist, the standard name is tried. This processing occurs for
4841 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4842
4843 In some esoteric situations different versions of Exim may be run under
4844 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4845 help with this. See the comments in &_src/EDITME_& for details.
4846
4847
4848
4849 .section "Configuration file format" "SECTconffilfor"
4850 .cindex "configuration file" "format of"
4851 .cindex "format" "configuration file"
4852 Exim's configuration file is divided into a number of different parts. General
4853 option settings must always appear at the start of the file. The other parts
4854 are all optional, and may appear in any order. Each part other than the first
4855 is introduced by the word &"begin"& followed by at least one literal
4856 space, and the name of the part. The optional parts are:
4857
4858 .ilist
4859 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4860 &<<CHAPACL>>&).
4861 .next
4862 .cindex "AUTH" "configuration"
4863 &'authenticators'&: Configuration settings for the authenticator drivers. These
4864 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4865 .next
4866 &'routers'&: Configuration settings for the router drivers. Routers process
4867 addresses and determine how the message is to be delivered (see chapters
4868 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4869 .next
4870 &'transports'&: Configuration settings for the transport drivers. Transports
4871 define mechanisms for copying messages to destinations (see chapters
4872 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4873 .next
4874 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4875 If there is no retry section, or if it is empty (that is, no retry rules are
4876 defined), Exim will not retry deliveries. In this situation, temporary errors
4877 are treated the same as permanent errors. Retry rules are discussed in chapter
4878 &<<CHAPretry>>&.
4879 .next
4880 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4881 when new addresses are generated during delivery. Rewriting is discussed in
4882 chapter &<<CHAPrewrite>>&.
4883 .next
4884 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4885 want to use this feature, you must set
4886 .code
4887 LOCAL_SCAN_HAS_OPTIONS=yes
4888 .endd
4889 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4890 facility are given in chapter &<<CHAPlocalscan>>&.
4891 .endlist
4892
4893 .cindex "configuration file" "leading white space in"
4894 .cindex "configuration file" "trailing white space in"
4895 .cindex "white space" "in configuration file"
4896 Leading and trailing white space in configuration lines is always ignored.
4897
4898 Blank lines in the file, and lines starting with a # character (ignoring
4899 leading white space) are treated as comments and are ignored. &*Note*&: A
4900 # character other than at the beginning of a line is not treated specially,
4901 and does not introduce a comment.
4902
4903 Any non-comment line can be continued by ending it with a backslash. Note that
4904 the general rule for white space means that trailing white space after the
4905 backslash and leading white space at the start of continuation
4906 lines is ignored. Comment lines beginning with # (but not empty lines) may
4907 appear in the middle of a sequence of continuation lines.
4908
4909 A convenient way to create a configuration file is to start from the
4910 default, which is supplied in &_src/configure.default_&, and add, delete, or
4911 change settings as required.
4912
4913 The ACLs, retry rules, and rewriting rules have their own syntax which is
4914 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4915 respectively. The other parts of the configuration file have some syntactic
4916 items in common, and these are described below, from section &<<SECTcos>>&
4917 onwards. Before that, the inclusion, macro, and conditional facilities are
4918 described.
4919
4920
4921
4922 .section "File inclusions in the configuration file" "SECID41"
4923 .cindex "inclusions in configuration file"
4924 .cindex "configuration file" "including other files"
4925 .cindex "&`.include`& in configuration file"
4926 .cindex "&`.include_if_exists`& in configuration file"
4927 You can include other files inside Exim's run time configuration file by
4928 using this syntax:
4929 .display
4930 &`.include`& <&'file name'&>
4931 &`.include_if_exists`& <&'file name'&>
4932 .endd
4933 on a line by itself. Double quotes round the file name are optional. If you use
4934 the first form, a configuration error occurs if the file does not exist; the
4935 second form does nothing for non-existent files.
4936 The first form allows a relative name. It is resolved relative to
4937 the directory of the including file. For the second form an absolute file
4938 name is required.
4939
4940 Includes may be nested to any depth, but remember that Exim reads its
4941 configuration file often, so it is a good idea to keep them to a minimum.
4942 If you change the contents of an included file, you must HUP the daemon,
4943 because an included file is read only when the configuration itself is read.
4944
4945 The processing of inclusions happens early, at a physical line level, so, like
4946 comment lines, an inclusion can be used in the middle of an option setting,
4947 for example:
4948 .code
4949 hosts_lookup = a.b.c \
4950                .include /some/file
4951 .endd
4952 Include processing happens after macro processing (see below). Its effect is to
4953 process the lines of the included file as if they occurred inline where the
4954 inclusion appears.
4955
4956
4957
4958 .section "Macros in the configuration file" "SECTmacrodefs"
4959 .cindex "macro" "description of"
4960 .cindex "configuration file" "macros"
4961 If a line in the main part of the configuration (that is, before the first
4962 &"begin"& line) begins with an upper case letter, it is taken as a macro
4963 definition, and must be of the form
4964 .display
4965 <&'name'&> = <&'rest of line'&>
4966 .endd
4967 The name must consist of letters, digits, and underscores, and need not all be
4968 in upper case, though that is recommended. The rest of the line, including any
4969 continuations, is the replacement text, and has leading and trailing white
4970 space removed. Quotes are not removed. The replacement text can never end with
4971 a backslash character, but this doesn't seem to be a serious limitation.
4972
4973 Macros may also be defined between router, transport, authenticator, or ACL
4974 definitions. They may not, however, be defined within an individual driver or
4975 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4976
4977 .section "Macro substitution" "SECID42"
4978 Once a macro is defined, all subsequent lines in the file (and any included
4979 files) are scanned for the macro name; if there are several macros, the line is
4980 scanned for each in turn, in the order in which the macros are defined. The
4981 replacement text is not re-scanned for the current macro, though it is scanned
4982 for subsequently defined macros. For this reason, a macro name may not contain
4983 the name of a previously defined macro as a substring. You could, for example,
4984 define
4985 .display
4986 &`ABCD_XYZ = `&<&'something'&>
4987 &`ABCD = `&<&'something else'&>
4988 .endd
4989 but putting the definitions in the opposite order would provoke a configuration
4990 error. Macro expansion is applied to individual physical lines from the file,
4991 before checking for line continuation or file inclusion (see above). If a line
4992 consists solely of a macro name, and the expansion of the macro is empty, the
4993 line is ignored. A macro at the start of a line may turn the line into a
4994 comment line or a &`.include`& line.
4995
4996
4997 .section "Redefining macros" "SECID43"
4998 Once defined, the value of a macro can be redefined later in the configuration
4999 (or in an included file). Redefinition is specified by using &'=='& instead of
5000 &'='&. For example:
5001 .code
5002 MAC =  initial value
5003 ...
5004 MAC == updated value
5005 .endd
5006 Redefinition does not alter the order in which the macros are applied to the
5007 subsequent lines of the configuration file. It is still the same order in which
5008 the macros were originally defined. All that changes is the macro's value.
5009 Redefinition makes it possible to accumulate values. For example:
5010 .code
5011 MAC =  initial value
5012 ...
5013 MAC == MAC and something added
5014 .endd
5015 This can be helpful in situations where the configuration file is built
5016 from a number of other files.
5017
5018 .section "Overriding macro values" "SECID44"
5019 The values set for macros in the configuration file can be overridden by the
5020 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5021 used, unless called by root or the Exim user. A definition on the command line
5022 using the &%-D%& option causes all definitions and redefinitions within the
5023 file to be ignored.
5024
5025
5026
5027 .section "Example of macro usage" "SECID45"
5028 As an example of macro usage, consider a configuration where aliases are looked
5029 up in a MySQL database. It helps to keep the file less cluttered if long
5030 strings such as SQL statements are defined separately as macros, for example:
5031 .code
5032 ALIAS_QUERY = select mailbox from user where \
5033               login='${quote_mysql:$local_part}';
5034 .endd
5035 This can then be used in a &(redirect)& router setting like this:
5036 .code
5037 data = ${lookup mysql{ALIAS_QUERY}}
5038 .endd
5039 In earlier versions of Exim macros were sometimes used for domain, host, or
5040 address lists. In Exim 4 these are handled better by named lists &-- see
5041 section &<<SECTnamedlists>>&.
5042
5043
5044 .section "Builtin macros" "SECTbuiltinmacros"
5045 Exim defines some macros depending on facilities available, which may
5046 differ due to build-time definitions and from one release to another.
5047 All of these macros start with an underscore.
5048 They can be used to conditionally include parts of a configuration
5049 (see below).
5050
5051 The following classes of macros are defined:
5052 .display
5053 &` _HAVE_*                    `&  build-time defines
5054 &` _DRIVER_ROUTER_*           `&  router drivers
5055 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5056 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5057 &` _OPT_MAIN_*                `&  main config options
5058 &` _OPT_ROUTERS_*             `&  generic router options
5059 &` _OPT_TRANSPORTS_*          `&  generic transport options
5060 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5061 &` _OPT_ROUTER_*_*            `&  private router options
5062 &` _OPT_TRANSPORT_*_*         `&  private transport options
5063 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5064 .endd
5065
5066 Use an &"exim -bP macros"& command to get the list of macros.
5067
5068
5069 .section "Conditional skips in the configuration file" "SECID46"
5070 .cindex "configuration file" "conditional skips"
5071 .cindex "&`.ifdef`&"
5072 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5073 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5074 portions of the configuration file. The processing happens whenever the file is
5075 read (that is, when an Exim binary starts to run).
5076
5077 The implementation is very simple. Instances of the first four directives must
5078 be followed by text that includes the names of one or macros. The condition
5079 that is tested is whether or not any macro substitution has taken place in the
5080 line. Thus:
5081 .code
5082 .ifdef AAA
5083 message_size_limit = 50M
5084 .else
5085 message_size_limit = 100M
5086 .endif
5087 .endd
5088 sets a message size limit of 50M if the macro &`AAA`& is defined
5089 (or &`A`& or &`AA`&), and 100M
5090 otherwise. If there is more than one macro named on the line, the condition
5091 is true if any of them are defined. That is, it is an &"or"& condition. To
5092 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5093
5094 Although you can use a macro expansion to generate one of these directives,
5095 it is not very useful, because the condition &"there was a macro substitution
5096 in this line"& will always be true.
5097
5098 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5099 to clarify complicated nestings.
5100
5101
5102
5103 .section "Common option syntax" "SECTcos"
5104 .cindex "common option syntax"
5105 .cindex "syntax of common options"
5106 .cindex "configuration file" "common option syntax"
5107 For the main set of options, driver options, and &[local_scan()]& options,
5108 each setting is on a line by itself, and starts with a name consisting of
5109 lower-case letters and underscores. Many options require a data value, and in
5110 these cases the name must be followed by an equals sign (with optional white
5111 space) and then the value. For example:
5112 .code
5113 qualify_domain = mydomain.example.com
5114 .endd
5115 .cindex "hiding configuration option values"
5116 .cindex "configuration options" "hiding value of"
5117 .cindex "options" "hiding value of"
5118 Some option settings may contain sensitive data, for example, passwords for
5119 accessing databases. To stop non-admin users from using the &%-bP%& command
5120 line option to read these values, you can precede the option settings with the
5121 word &"hide"&. For example:
5122 .code
5123 hide mysql_servers = localhost/users/admin/secret-password
5124 .endd
5125 For non-admin users, such options are displayed like this:
5126 .code
5127 mysql_servers = <value not displayable>
5128 .endd
5129 If &"hide"& is used on a driver option, it hides the value of that option on
5130 all instances of the same driver.
5131
5132 The following sections describe the syntax used for the different data types
5133 that are found in option settings.
5134
5135
5136 .section "Boolean options" "SECID47"
5137 .cindex "format" "boolean"
5138 .cindex "boolean configuration values"
5139 .oindex "&%no_%&&'xxx'&"
5140 .oindex "&%not_%&&'xxx'&"
5141 Options whose type is given as boolean are on/off switches. There are two
5142 different ways of specifying such options: with and without a data value. If
5143 the option name is specified on its own without data, the switch is turned on;
5144 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5145 boolean options may be followed by an equals sign and one of the words
5146 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5147 the following two settings have exactly the same effect:
5148 .code
5149 queue_only
5150 queue_only = true
5151 .endd
5152 The following two lines also have the same (opposite) effect:
5153 .code
5154 no_queue_only
5155 queue_only = false
5156 .endd
5157 You can use whichever syntax you prefer.
5158
5159
5160
5161
5162 .section "Integer values" "SECID48"
5163 .cindex "integer configuration values"
5164 .cindex "format" "integer"
5165 If an option's type is given as &"integer"&, the value can be given in decimal,
5166 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5167 number is assumed. Otherwise, it is treated as an octal number unless it starts
5168 with the characters &"0x"&, in which case the remainder is interpreted as a
5169 hexadecimal number.
5170
5171 If an integer value is followed by the letter K, it is multiplied by 1024; if
5172 it is followed by the letter M, it is multiplied by 1024x1024;
5173 if by the letter G, 1024x1024x1024.
5174 When the values
5175 of integer option settings are output, values which are an exact multiple of
5176 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5177 and M. The printing style is independent of the actual input format that was
5178 used.
5179
5180
5181 .section "Octal integer values" "SECID49"
5182 .cindex "integer format"
5183 .cindex "format" "octal integer"
5184 If an option's type is given as &"octal integer"&, its value is always
5185 interpreted as an octal number, whether or not it starts with the digit zero.
5186 Such options are always output in octal.
5187
5188
5189 .section "Fixed point numbers" "SECID50"
5190 .cindex "fixed point configuration values"
5191 .cindex "format" "fixed point"
5192 If an option's type is given as &"fixed-point"&, its value must be a decimal
5193 integer, optionally followed by a decimal point and up to three further digits.
5194
5195
5196
5197 .section "Time intervals" "SECTtimeformat"
5198 .cindex "time interval" "specifying in configuration"
5199 .cindex "format" "time interval"
5200 A time interval is specified as a sequence of numbers, each followed by one of
5201 the following letters, with no intervening white space:
5202
5203 .table2 30pt
5204 .irow &%s%& seconds
5205 .irow &%m%& minutes
5206 .irow &%h%& hours
5207 .irow &%d%& days
5208 .irow &%w%& weeks
5209 .endtable
5210
5211 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5212 intervals are output in the same format. Exim does not restrict the values; it
5213 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5214
5215
5216
5217 .section "String values" "SECTstrings"
5218 .cindex "string" "format of configuration values"
5219 .cindex "format" "string"
5220 If an option's type is specified as &"string"&, the value can be specified with
5221 or without double-quotes. If it does not start with a double-quote, the value
5222 consists of the remainder of the line plus any continuation lines, starting at
5223 the first character after any leading white space, with trailing white space
5224 removed, and with no interpretation of the characters in the string. Because
5225 Exim removes comment lines (those beginning with #) at an early stage, they can
5226 appear in the middle of a multi-line string. The following two settings are
5227 therefore equivalent:
5228 .code
5229 trusted_users = uucp:mail
5230 trusted_users = uucp:\
5231                 # This comment line is ignored
5232                 mail
5233 .endd
5234 .cindex "string" "quoted"
5235 .cindex "escape characters in quoted strings"
5236 If a string does start with a double-quote, it must end with a closing
5237 double-quote, and any backslash characters other than those used for line
5238 continuation are interpreted as escape characters, as follows:
5239
5240 .table2 100pt
5241 .irow &`\\`&                     "single backslash"
5242 .irow &`\n`&                     "newline"
5243 .irow &`\r`&                     "carriage return"
5244 .irow &`\t`&                     "tab"
5245 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5246 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5247                                    character"
5248 .endtable
5249
5250 If a backslash is followed by some other character, including a double-quote
5251 character, that character replaces the pair.
5252
5253 Quoting is necessary only if you want to make use of the backslash escapes to
5254 insert special characters, or if you need to specify a value with leading or
5255 trailing spaces. These cases are rare, so quoting is almost never needed in
5256 current versions of Exim. In versions of Exim before 3.14, quoting was required
5257 in order to continue lines, so you may come across older configuration files
5258 and examples that apparently quote unnecessarily.
5259
5260
5261 .section "Expanded strings" "SECID51"
5262 .cindex "expansion" "definition of"
5263 Some strings in the configuration file are subjected to &'string expansion'&,
5264 by which means various parts of the string may be changed according to the
5265 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5266 is as just described; in particular, the handling of backslashes in quoted
5267 strings is done as part of the input process, before expansion takes place.
5268 However, backslash is also an escape character for the expander, so any
5269 backslashes that are required for that reason must be doubled if they are
5270 within a quoted configuration string.
5271
5272
5273 .section "User and group names" "SECID52"
5274 .cindex "user name" "format of"
5275 .cindex "format" "user name"
5276 .cindex "groups" "name format"
5277 .cindex "format" "group name"
5278 User and group names are specified as strings, using the syntax described
5279 above, but the strings are interpreted specially. A user or group name must
5280 either consist entirely of digits, or be a name that can be looked up using the
5281 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5282
5283
5284 .section "List construction" "SECTlistconstruct"
5285 .cindex "list" "syntax of in configuration"
5286 .cindex "format" "list item in configuration"
5287 .cindex "string" "list, definition of"
5288 The data for some configuration options is a list of items, with colon as the
5289 default separator. Many of these options are shown with type &"string list"& in
5290 the descriptions later in this document. Others are listed as &"domain list"&,
5291 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5292 are all the same; however, those other than &"string list"& are subject to
5293 particular kinds of interpretation, as described in chapter
5294 &<<CHAPdomhosaddlists>>&.
5295
5296 In all these cases, the entire list is treated as a single string as far as the
5297 input syntax is concerned. The &%trusted_users%& setting in section
5298 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5299 in a list, it must be entered as two colons. Leading and trailing white space
5300 on each item in a list is ignored. This makes it possible to include items that
5301 start with a colon, and in particular, certain forms of IPv6 address. For
5302 example, the list
5303 .code
5304 local_interfaces = 127.0.0.1 : ::::1
5305 .endd
5306 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5307
5308 &*Note*&: Although leading and trailing white space is ignored in individual
5309 list items, it is not ignored when parsing the list. The space after the first
5310 colon in the example above is necessary. If it were not there, the list would
5311 be interpreted as the two items 127.0.0.1:: and 1.
5312
5313 .section "Changing list separators" "SECTlistsepchange"
5314 .cindex "list separator" "changing"
5315 .cindex "IPv6" "addresses in lists"
5316 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5317 introduced to allow the separator character to be changed. If a list begins
5318 with a left angle bracket, followed by any punctuation character, that
5319 character is used instead of colon as the list separator. For example, the list
5320 above can be rewritten to use a semicolon separator like this:
5321 .code
5322 local_interfaces = <; 127.0.0.1 ; ::1
5323 .endd
5324 This facility applies to all lists, with the exception of the list in
5325 &%log_file_path%&. It is recommended that the use of non-colon separators be
5326 confined to circumstances where they really are needed.
5327
5328 .cindex "list separator" "newline as"
5329 .cindex "newline" "as list separator"
5330 It is also possible to use newline and other control characters (those with
5331 code values less than 32, plus DEL) as separators in lists. Such separators
5332 must be provided literally at the time the list is processed. For options that
5333 are string-expanded, you can write the separator using a normal escape
5334 sequence. This will be processed by the expander before the string is
5335 interpreted as a list. For example, if a newline-separated list of domains is
5336 generated by a lookup, you can process it directly by a line such as this:
5337 .code
5338 domains = <\n ${lookup mysql{.....}}
5339 .endd
5340 This avoids having to change the list separator in such data. You are unlikely
5341 to want to use a control character as a separator in an option that is not
5342 expanded, because the value is literal text. However, it can be done by giving
5343 the value in quotes. For example:
5344 .code
5345 local_interfaces = "<\n 127.0.0.1 \n ::1"
5346 .endd
5347 Unlike printing character separators, which can be included in list items by
5348 doubling, it is not possible to include a control character as data when it is
5349 set as the separator. Two such characters in succession are interpreted as
5350 enclosing an empty list item.
5351
5352
5353
5354 .section "Empty items in lists" "SECTempitelis"
5355 .cindex "list" "empty item in"
5356 An empty item at the end of a list is always ignored. In other words, trailing
5357 separator characters are ignored. Thus, the list in
5358 .code
5359 senders = user@domain :
5360 .endd
5361 contains only a single item. If you want to include an empty string as one item
5362 in a list, it must not be the last item. For example, this list contains three
5363 items, the second of which is empty:
5364 .code
5365 senders = user1@domain : : user2@domain
5366 .endd
5367 &*Note*&: There must be white space between the two colons, as otherwise they
5368 are interpreted as representing a single colon data character (and the list
5369 would then contain just one item). If you want to specify a list that contains
5370 just one, empty item, you can do it as in this example:
5371 .code
5372 senders = :
5373 .endd
5374 In this case, the first item is empty, and the second is discarded because it
5375 is at the end of the list.
5376
5377
5378
5379
5380 .section "Format of driver configurations" "SECTfordricon"
5381 .cindex "drivers" "configuration format"
5382 There are separate parts in the configuration for defining routers, transports,
5383 and authenticators. In each part, you are defining a number of driver
5384 instances, each with its own set of options. Each driver instance is defined by
5385 a sequence of lines like this:
5386 .display
5387 <&'instance name'&>:
5388   <&'option'&>
5389   ...
5390   <&'option'&>
5391 .endd
5392 In the following example, the instance name is &(localuser)&, and it is
5393 followed by three options settings:
5394 .code
5395 localuser:
5396   driver = accept
5397   check_local_user
5398   transport = local_delivery
5399 .endd
5400 For each driver instance, you specify which Exim code module it uses &-- by the
5401 setting of the &%driver%& option &-- and (optionally) some configuration
5402 settings. For example, in the case of transports, if you want a transport to
5403 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5404 a local file you would use the &(appendfile)& driver. Each of the drivers is
5405 described in detail in its own separate chapter later in this manual.
5406
5407 You can have several routers, transports, or authenticators that are based on
5408 the same underlying driver (each must have a different instance name).
5409
5410 The order in which routers are defined is important, because addresses are
5411 passed to individual routers one by one, in order. The order in which
5412 transports are defined does not matter at all. The order in which
5413 authenticators are defined is used only when Exim, as a client, is searching
5414 them to find one that matches an authentication mechanism offered by the
5415 server.
5416
5417 .cindex "generic options"
5418 .cindex "options" "generic &-- definition of"
5419 Within a driver instance definition, there are two kinds of option: &'generic'&
5420 and &'private'&. The generic options are those that apply to all drivers of the
5421 same type (that is, all routers, all transports or all authenticators). The
5422 &%driver%& option is a generic option that must appear in every definition.
5423 .cindex "private options"
5424 The private options are special for each driver, and none need appear, because
5425 they all have default values.
5426
5427 The options may appear in any order, except that the &%driver%& option must
5428 precede any private options, since these depend on the particular driver. For
5429 this reason, it is recommended that &%driver%& always be the first option.
5430
5431 Driver instance names, which are used for reference in log entries and
5432 elsewhere, can be any sequence of letters, digits, and underscores (starting
5433 with a letter) and must be unique among drivers of the same type. A router and
5434 a transport (for example) can each have the same name, but no two router
5435 instances can have the same name. The name of a driver instance should not be
5436 confused with the name of the underlying driver module. For example, the
5437 configuration lines:
5438 .code
5439 remote_smtp:
5440   driver = smtp
5441 .endd
5442 create an instance of the &(smtp)& transport driver whose name is
5443 &(remote_smtp)&. The same driver code can be used more than once, with
5444 different instance names and different option settings each time. A second
5445 instance of the &(smtp)& transport, with different options, might be defined
5446 thus:
5447 .code
5448 special_smtp:
5449   driver = smtp
5450   port = 1234
5451   command_timeout = 10s
5452 .endd
5453 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5454 these transport instances from routers, and these names would appear in log
5455 lines.
5456
5457 Comment lines may be present in the middle of driver specifications. The full
5458 list of option settings for any particular driver instance, including all the
5459 defaulted values, can be extracted by making use of the &%-bP%& command line
5460 option.
5461
5462
5463
5464
5465
5466
5467 . ////////////////////////////////////////////////////////////////////////////
5468 . ////////////////////////////////////////////////////////////////////////////
5469
5470 .chapter "The default configuration file" "CHAPdefconfil"
5471 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5472 .cindex "default" "configuration file &""walk through""&"
5473 The default configuration file supplied with Exim as &_src/configure.default_&
5474 is sufficient for a host with simple mail requirements. As an introduction to
5475 the way Exim is configured, this chapter &"walks through"& the default
5476 configuration, giving brief explanations of the settings. Detailed descriptions
5477 of the options are given in subsequent chapters. The default configuration file
5478 itself contains extensive comments about ways you might want to modify the
5479 initial settings. However, note that there are many options that are not
5480 mentioned at all in the default configuration.
5481
5482
5483
5484 .section "Main configuration settings" "SECTdefconfmain"
5485 The main (global) configuration option settings must always come first in the
5486 file. The first thing you'll see in the file, after some initial comments, is
5487 the line
5488 .code
5489 # primary_hostname =
5490 .endd
5491 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5492 to know the official, fully qualified name of your host, and this is where you
5493 can specify it. However, in most cases you do not need to set this option. When
5494 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5495
5496 The first three non-comment configuration lines are as follows:
5497 .code
5498 domainlist local_domains    = @
5499 domainlist relay_to_domains =
5500 hostlist   relay_from_hosts = 127.0.0.1
5501 .endd
5502 These are not, in fact, option settings. They are definitions of two named
5503 domain lists and one named host list. Exim allows you to give names to lists of
5504 domains, hosts, and email addresses, in order to make it easier to manage the
5505 configuration file (see section &<<SECTnamedlists>>&).
5506
5507 The first line defines a domain list called &'local_domains'&; this is used
5508 later in the configuration to identify domains that are to be delivered
5509 on the local host.
5510
5511 .cindex "@ in a domain list"
5512 There is just one item in this list, the string &"@"&. This is a special form
5513 of entry which means &"the name of the local host"&. Thus, if the local host is
5514 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5515 be delivered locally. Because the local host's name is referenced indirectly,
5516 the same configuration file can be used on different hosts.
5517
5518 The second line defines a domain list called &'relay_to_domains'&, but the
5519 list itself is empty. Later in the configuration we will come to the part that
5520 controls mail relaying through the local host; it allows relaying to any
5521 domains in this list. By default, therefore, no relaying on the basis of a mail
5522 domain is permitted.
5523
5524 The third line defines a host list called &'relay_from_hosts'&. This list is
5525 used later in the configuration to permit relaying from any host or IP address
5526 that matches the list. The default contains just the IP address of the IPv4
5527 loopback interface, which means that processes on the local host are able to
5528 submit mail for relaying by sending it over TCP/IP to that interface. No other
5529 hosts are permitted to submit messages for relaying.
5530
5531 Just to be sure there's no misunderstanding: at this point in the configuration
5532 we aren't actually setting up any controls. We are just defining some domains
5533 and hosts that will be used in the controls that are specified later.
5534
5535 The next two configuration lines are genuine option settings:
5536 .code
5537 acl_smtp_rcpt = acl_check_rcpt
5538 acl_smtp_data = acl_check_data
5539 .endd
5540 These options specify &'Access Control Lists'& (ACLs) that are to be used
5541 during an incoming SMTP session for every recipient of a message (every RCPT
5542 command), and after the contents of the message have been received,
5543 respectively. The names of the lists are &'acl_check_rcpt'& and
5544 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5545 section of the configuration. The RCPT ACL controls which recipients are
5546 accepted for an incoming message &-- if a configuration does not provide an ACL
5547 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5548 contents of a message to be checked.
5549
5550 Two commented-out option settings are next:
5551 .code
5552 # av_scanner = clamd:/tmp/clamd
5553 # spamd_address = 127.0.0.1 783
5554 .endd
5555 These are example settings that can be used when Exim is compiled with the
5556 content-scanning extension. The first specifies the interface to the virus
5557 scanner, and the second specifies the interface to SpamAssassin. Further
5558 details are given in chapter &<<CHAPexiscan>>&.
5559
5560 Three more commented-out option settings follow:
5561 .code
5562 # tls_advertise_hosts = *
5563 # tls_certificate = /etc/ssl/exim.crt
5564 # tls_privatekey = /etc/ssl/exim.pem
5565 .endd
5566 These are example settings that can be used when Exim is compiled with
5567 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5568 first one specifies the list of clients that are allowed to use TLS when
5569 connecting to this server; in this case the wildcard means all clients. The
5570 other options specify where Exim should find its TLS certificate and private
5571 key, which together prove the server's identity to any clients that connect.
5572 More details are given in chapter &<<CHAPTLS>>&.
5573
5574 Another two commented-out option settings follow:
5575 .code
5576 # daemon_smtp_ports = 25 : 465 : 587
5577 # tls_on_connect_ports = 465
5578 .endd
5579 .cindex "port" "465 and 587"
5580 .cindex "port" "for message submission"
5581 .cindex "message" "submission, ports for"
5582 .cindex "ssmtp protocol"
5583 .cindex "smtps protocol"
5584 .cindex "SMTP" "ssmtp protocol"
5585 .cindex "SMTP" "smtps protocol"
5586 These options provide better support for roaming users who wish to use this
5587 server for message submission. They are not much use unless you have turned on
5588 TLS (as described in the previous paragraph) and authentication (about which
5589 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5590 on end-user networks, so RFC 4409 specifies that message submission should use
5591 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5592 configured to use port 587 correctly, so these settings also enable the
5593 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5594 &<<SECTsupobssmt>>&).
5595
5596 Two more commented-out options settings follow:
5597 .code
5598 # qualify_domain =
5599 # qualify_recipient =
5600 .endd
5601 The first of these specifies a domain that Exim uses when it constructs a
5602 complete email address from a local login name. This is often needed when Exim
5603 receives a message from a local process. If you do not set &%qualify_domain%&,
5604 the value of &%primary_hostname%& is used. If you set both of these options,
5605 you can have different qualification domains for sender and recipient
5606 addresses. If you set only the first one, its value is used in both cases.
5607
5608 .cindex "domain literal" "recognizing format"
5609 The following line must be uncommented if you want Exim to recognize
5610 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5611 (an IP address within square brackets) instead of a named domain.
5612 .code
5613 # allow_domain_literals
5614 .endd
5615 The RFCs still require this form, but many people think that in the modern
5616 Internet it makes little sense to permit mail to be sent to specific hosts by
5617 quoting their IP addresses. This ancient format has been used by people who
5618 try to abuse hosts by using them for unwanted relaying. However, some
5619 people believe there are circumstances (for example, messages addressed to
5620 &'postmaster'&) where domain literals are still useful.
5621
5622 The next configuration line is a kind of trigger guard:
5623 .code
5624 never_users = root
5625 .endd
5626 It specifies that no delivery must ever be run as the root user. The normal
5627 convention is to set up &'root'& as an alias for the system administrator. This
5628 setting is a guard against slips in the configuration.
5629 The list of users specified by &%never_users%& is not, however, the complete
5630 list; the build-time configuration in &_Local/Makefile_& has an option called
5631 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5632 contents of &%never_users%& are added to this list. By default
5633 FIXED_NEVER_USERS also specifies root.
5634
5635 When a remote host connects to Exim in order to send mail, the only information
5636 Exim has about the host's identity is its IP address. The next configuration
5637 line,
5638 .code
5639 host_lookup = *
5640 .endd
5641 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5642 in order to get a host name. This improves the quality of the logging
5643 information, but if you feel it is too expensive, you can remove it entirely,
5644 or restrict the lookup to hosts on &"nearby"& networks.
5645 Note that it is not always possible to find a host name from an IP address,
5646 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5647 unreachable.
5648
5649 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5650 1413 (hence their names):
5651 .code
5652 rfc1413_hosts = *
5653 rfc1413_query_timeout = 0s
5654 .endd
5655 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5656 Few hosts offer RFC1413 service these days; calls have to be
5657 terminated by a timeout and this needlessly delays the startup
5658 of an incoming SMTP connection.
5659 If you have hosts for which you trust RFC1413 and need this
5660 information, you can change this.
5661
5662 This line enables an efficiency SMTP option.  It is negotiated by clients
5663 and not expected to cause problems but can be disabled if needed.
5664 .code
5665 prdr_enable = true
5666 .endd
5667
5668 When Exim receives messages over SMTP connections, it expects all addresses to
5669 be fully qualified with a domain, as required by the SMTP definition. However,
5670 if you are running a server to which simple clients submit messages, you may
5671 find that they send unqualified addresses. The two commented-out options:
5672 .code
5673 # sender_unqualified_hosts =
5674 # recipient_unqualified_hosts =
5675 .endd
5676 show how you can specify hosts that are permitted to send unqualified sender
5677 and recipient addresses, respectively.
5678
5679 The &%log_selector%& option is used to increase the detail of logging
5680 over the default:
5681 .code
5682 log_selector = +smtp_protocol_error +smtp_syntax_error \
5683                +tls_certificate_verified
5684 .endd
5685
5686 The &%percent_hack_domains%& option is also commented out:
5687 .code
5688 # percent_hack_domains =
5689 .endd
5690 It provides a list of domains for which the &"percent hack"& is to operate.
5691 This is an almost obsolete form of explicit email routing. If you do not know
5692 anything about it, you can safely ignore this topic.
5693
5694 The next two settings in the main part of the default configuration are
5695 concerned with messages that have been &"frozen"& on Exim's queue. When a
5696 message is frozen, Exim no longer continues to try to deliver it. Freezing
5697 occurs when a bounce message encounters a permanent failure because the sender
5698 address of the original message that caused the bounce is invalid, so the
5699 bounce cannot be delivered. This is probably the most common case, but there
5700 are also other conditions that cause freezing, and frozen messages are not
5701 always bounce messages.
5702 .code
5703 ignore_bounce_errors_after = 2d
5704 timeout_frozen_after = 7d
5705 .endd
5706 The first of these options specifies that failing bounce messages are to be
5707 discarded after 2 days on the queue. The second specifies that any frozen
5708 message (whether a bounce message or not) is to be timed out (and discarded)
5709 after a week. In this configuration, the first setting ensures that no failing
5710 bounce message ever lasts a week.
5711
5712 Exim queues it's messages in a spool directory. If you expect to have
5713 large queues, you may consider using this option. It splits the spool
5714 directory into subdirectories to avoid file system degradation from
5715 many files in a single directory, resulting in better performance.
5716 Manual manipulation of queued messages becomes more complex (though fortunately
5717 not often needed).
5718 .code
5719 # split_spool_directory = true
5720 .endd
5721
5722 In an ideal world everybody follows the standards. For non-ASCII
5723 messages RFC 2047 is a standard, allowing a maximum line length of 76
5724 characters. Exim adheres that standard and won't process messages which
5725 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5726 In particular, the Exim maintainers have had multiple reports of
5727 problems from Russian administrators of issues until they disable this
5728 check, because of some popular, yet buggy, mail composition software.
5729 .code
5730 # check_rfc2047_length = false
5731 .endd
5732
5733 If you need to be strictly RFC compliant you may wish to disable the
5734 8BITMIME advertisement. Use this, if you exchange mails with systems
5735 that are not 8-bit clean.
5736 .code
5737 # accept_8bitmime = false
5738 .endd
5739
5740 Libraries you use may depend on specific environment settings.  This
5741 imposes a security risk (e.g. PATH). There are two lists:
5742 &%keep_environment%& for the variables to import as they are, and
5743 &%add_environment%& for variables we want to set to a fixed value.
5744 Note that TZ is handled separately, by the $%timezone%$ runtime
5745 option and by the TIMEZONE_DEFAULT buildtime option.
5746 .code
5747 # keep_environment = ^LDAP
5748 # add_environment = PATH=/usr/bin::/bin
5749 .endd
5750
5751
5752 .section "ACL configuration" "SECID54"
5753 .cindex "default" "ACLs"
5754 .cindex "&ACL;" "default configuration"
5755 In the default configuration, the ACL section follows the main configuration.
5756 It starts with the line
5757 .code
5758 begin acl
5759 .endd
5760 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5761 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5762 and &%acl_smtp_data%& above.
5763
5764 .cindex "RCPT" "ACL for"
5765 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5766 RCPT command specifies one of the message's recipients. The ACL statements
5767 are considered in order, until the recipient address is either accepted or
5768 rejected. The RCPT command is then accepted or rejected, according to the
5769 result of the ACL processing.
5770 .code
5771 acl_check_rcpt:
5772 .endd
5773 This line, consisting of a name terminated by a colon, marks the start of the
5774 ACL, and names it.
5775 .code
5776 accept  hosts = :
5777 .endd
5778 This ACL statement accepts the recipient if the sending host matches the list.
5779 But what does that strange list mean? It doesn't actually contain any host
5780 names or IP addresses. The presence of the colon puts an empty item in the
5781 list; Exim matches this only if the incoming message did not come from a remote
5782 host, because in that case, the remote hostname is empty. The colon is
5783 important. Without it, the list itself is empty, and can never match anything.
5784
5785 What this statement is doing is to accept unconditionally all recipients in
5786 messages that are submitted by SMTP from local processes using the standard
5787 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5788 manner.
5789 .code
5790 deny    message       = Restricted characters in address
5791         domains       = +local_domains
5792         local_parts   = ^[.] : ^.*[@%!/|]
5793
5794 deny    message       = Restricted characters in address
5795         domains       = !+local_domains
5796         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5797 .endd
5798 These statements are concerned with local parts that contain any of the
5799 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5800 Although these characters are entirely legal in local parts (in the case of
5801 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5802 in Internet mail addresses.
5803
5804 The first three have in the past been associated with explicitly routed
5805 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5806 option). Addresses containing these characters are regularly tried by spammers
5807 in an attempt to bypass relaying restrictions, and also by open relay testing
5808 programs. Unless you really need them it is safest to reject these characters
5809 at this early stage. This configuration is heavy-handed in rejecting these
5810 characters for all messages it accepts from remote hosts. This is a deliberate
5811 policy of being as safe as possible.
5812
5813 The first rule above is stricter, and is applied to messages that are addressed
5814 to one of the local domains handled by this host. This is implemented by the
5815 first condition, which restricts it to domains that are listed in the
5816 &'local_domains'& domain list. The &"+"& character is used to indicate a
5817 reference to a named list. In this configuration, there is just one domain in
5818 &'local_domains'&, but in general there may be many.
5819
5820 The second condition on the first statement uses two regular expressions to
5821 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5822 or &"|"&. If you have local accounts that include these characters, you will
5823 have to modify this rule.
5824
5825 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5826 allows them because they have been encountered in practice. (Consider the
5827 common convention of local parts constructed as
5828 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5829 the author of Exim, who has no second initial.) However, a local part starting
5830 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5831 file name (for example, for a mailing list). This is also true for local parts
5832 that contain slashes. A pipe symbol can also be troublesome if the local part
5833 is incorporated unthinkingly into a shell command line.
5834
5835 The second rule above applies to all other domains, and is less strict. This
5836 allows your own users to send outgoing messages to sites that use slashes
5837 and vertical bars in their local parts. It blocks local parts that begin
5838 with a dot, slash, or vertical bar, but allows these characters within the
5839 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5840 and &"!"& is blocked, as before. The motivation here is to prevent your users
5841 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5842 .code
5843 accept  local_parts   = postmaster
5844         domains       = +local_domains
5845 .endd
5846 This statement, which has two conditions, accepts an incoming address if the
5847 local part is &'postmaster'& and the domain is one of those listed in the
5848 &'local_domains'& domain list. The &"+"& character is used to indicate a
5849 reference to a named list. In this configuration, there is just one domain in
5850 &'local_domains'&, but in general there may be many.
5851
5852 The presence of this statement means that mail to postmaster is never blocked
5853 by any of the subsequent tests. This can be helpful while sorting out problems
5854 in cases where the subsequent tests are incorrectly denying access.
5855 .code
5856 require verify        = sender
5857 .endd
5858 This statement requires the sender address to be verified before any subsequent
5859 ACL statement can be used. If verification fails, the incoming recipient
5860 address is refused. Verification consists of trying to route the address, to
5861 see if a bounce message could be delivered to it. In the case of remote
5862 addresses, basic verification checks only the domain, but &'callouts'& can be
5863 used for more verification if required. Section &<<SECTaddressverification>>&
5864 discusses the details of address verification.
5865 .code
5866 accept  hosts         = +relay_from_hosts
5867         control       = submission
5868 .endd
5869 This statement accepts the address if the message is coming from one of the
5870 hosts that are defined as being allowed to relay through this host. Recipient
5871 verification is omitted here, because in many cases the clients are dumb MUAs
5872 that do not cope well with SMTP error responses. For the same reason, the
5873 second line specifies &"submission mode"& for messages that are accepted. This
5874 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5875 messages that are deficient in some way, for example, because they lack a
5876 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5877 probably add recipient verification here, and disable submission mode.
5878 .code
5879 accept  authenticated = *
5880         control       = submission
5881 .endd
5882 This statement accepts the address if the client host has authenticated itself.
5883 Submission mode is again specified, on the grounds that such messages are most
5884 likely to come from MUAs. The default configuration does not define any
5885 authenticators, though it does include some nearly complete commented-out
5886 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5887 fact authenticate until you complete the authenticator definitions.
5888 .code
5889 require message = relay not permitted
5890         domains = +local_domains : +relay_to_domains
5891 .endd
5892 This statement rejects the address if its domain is neither a local domain nor
5893 one of the domains for which this host is a relay.
5894 .code
5895 require verify = recipient
5896 .endd
5897 This statement requires the recipient address to be verified; if verification
5898 fails, the address is rejected.
5899 .code
5900 # deny    message     = rejected because $sender_host_address \
5901 #                       is in a black list at $dnslist_domain\n\
5902 #                       $dnslist_text
5903 #         dnslists    = black.list.example
5904 #
5905 # warn    dnslists    = black.list.example
5906 #         add_header  = X-Warning: $sender_host_address is in \
5907 #                       a black list at $dnslist_domain
5908 #         log_message = found in $dnslist_domain
5909 .endd
5910 These commented-out lines are examples of how you could configure Exim to check
5911 sending hosts against a DNS black list. The first statement rejects messages
5912 from blacklisted hosts, whereas the second just inserts a warning header
5913 line.
5914 .code
5915 # require verify = csa
5916 .endd
5917 This commented-out line is an example of how you could turn on client SMTP
5918 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5919 records.
5920 .code
5921 accept
5922 .endd
5923 The final statement in the first ACL unconditionally accepts any recipient
5924 address that has successfully passed all the previous tests.
5925 .code
5926 acl_check_data:
5927 .endd
5928 This line marks the start of the second ACL, and names it. Most of the contents
5929 of this ACL are commented out:
5930 .code
5931 # deny    malware   = *
5932 #         message   = This message contains a virus \
5933 #                     ($malware_name).
5934 .endd
5935 These lines are examples of how to arrange for messages to be scanned for
5936 viruses when Exim has been compiled with the content-scanning extension, and a
5937 suitable virus scanner is installed. If the message is found to contain a
5938 virus, it is rejected with the given custom error message.
5939 .code
5940 # warn    spam      = nobody
5941 #         message   = X-Spam_score: $spam_score\n\
5942 #                     X-Spam_score_int: $spam_score_int\n\
5943 #                     X-Spam_bar: $spam_bar\n\
5944 #                     X-Spam_report: $spam_report
5945 .endd
5946 These lines are an example of how to arrange for messages to be scanned by
5947 SpamAssassin when Exim has been compiled with the content-scanning extension,
5948 and SpamAssassin has been installed. The SpamAssassin check is run with
5949 &`nobody`& as its user parameter, and the results are added to the message as a
5950 series of extra header line. In this case, the message is not rejected,
5951 whatever the spam score.
5952 .code
5953 accept
5954 .endd
5955 This final line in the DATA ACL accepts the message unconditionally.
5956
5957
5958 .section "Router configuration" "SECID55"
5959 .cindex "default" "routers"
5960 .cindex "routers" "default"
5961 The router configuration comes next in the default configuration, introduced
5962 by the line
5963 .code
5964 begin routers
5965 .endd
5966 Routers are the modules in Exim that make decisions about where to send
5967 messages. An address is passed to each router in turn, until it is either
5968 accepted, or failed. This means that the order in which you define the routers
5969 matters. Each router is fully described in its own chapter later in this
5970 manual. Here we give only brief overviews.
5971 .code
5972 # domain_literal:
5973 #   driver = ipliteral
5974 #   domains = !+local_domains
5975 #   transport = remote_smtp
5976 .endd
5977 .cindex "domain literal" "default router"
5978 This router is commented out because the majority of sites do not want to
5979 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5980 you uncomment this router, you also need to uncomment the setting of
5981 &%allow_domain_literals%& in the main part of the configuration.
5982 .code
5983 dnslookup:
5984   driver = dnslookup
5985   domains = ! +local_domains
5986   transport = remote_smtp
5987   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5988   no_more
5989 .endd
5990 The first uncommented router handles addresses that do not involve any local
5991 domains. This is specified by the line
5992 .code
5993 domains = ! +local_domains
5994 .endd
5995 The &%domains%& option lists the domains to which this router applies, but the
5996 exclamation mark is a negation sign, so the router is used only for domains
5997 that are not in the domain list called &'local_domains'& (which was defined at
5998 the start of the configuration). The plus sign before &'local_domains'&
5999 indicates that it is referring to a named list. Addresses in other domains are
6000 passed on to the following routers.
6001
6002 The name of the router driver is &(dnslookup)&,
6003 and is specified by the &%driver%& option. Do not be confused by the fact that
6004 the name of this router instance is the same as the name of the driver. The
6005 instance name is arbitrary, but the name set in the &%driver%& option must be
6006 one of the driver modules that is in the Exim binary.
6007
6008 The &(dnslookup)& router routes addresses by looking up their domains in the
6009 DNS in order to obtain a list of hosts to which the address is routed. If the
6010 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6011 specified by the &%transport%& option. If the router does not find the domain
6012 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6013 the address fails and is bounced.
6014
6015 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6016 be entirely ignored. This option is present because a number of cases have been
6017 encountered where MX records in the DNS point to host names
6018 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6019 Completely ignoring these IP addresses causes Exim to fail to route the
6020 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6021 continue to try to deliver the message periodically until the address timed
6022 out.
6023 .code
6024 system_aliases:
6025   driver = redirect
6026   allow_fail
6027   allow_defer
6028   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6029 # user = exim
6030   file_transport = address_file
6031   pipe_transport = address_pipe
6032 .endd
6033 Control reaches this and subsequent routers only for addresses in the local
6034 domains. This router checks to see whether the local part is defined as an
6035 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6036 data that it looks up from that file. If no data is found for the local part,
6037 the value of the &%data%& option is empty, causing the address to be passed to
6038 the next router.
6039
6040 &_/etc/aliases_& is a conventional name for the system aliases file that is
6041 often used. That is why it is referenced by from the default configuration
6042 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6043 &_Local/Makefile_& before building Exim.
6044 .code
6045 userforward:
6046   driver = redirect
6047   check_local_user
6048 # local_part_suffix = +* : -*
6049 # local_part_suffix_optional
6050   file = $home/.forward
6051 # allow_filter
6052   no_verify
6053   no_expn
6054   check_ancestor
6055   file_transport = address_file
6056   pipe_transport = address_pipe
6057   reply_transport = address_reply
6058 .endd
6059 This is the most complicated router in the default configuration. It is another
6060 redirection router, but this time it is looking for forwarding data set up by
6061 individual users. The &%check_local_user%& setting specifies a check that the
6062 local part of the address is the login name of a local user. If it is not, the
6063 router is skipped. The two commented options that follow &%check_local_user%&,
6064 namely:
6065 .code
6066 # local_part_suffix = +* : -*
6067 # local_part_suffix_optional
6068 .endd
6069 .vindex "&$local_part_suffix$&"
6070 show how you can specify the recognition of local part suffixes. If the first
6071 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6072 by any sequence of characters, is removed from the local part and placed in the
6073 variable &$local_part_suffix$&. The second suffix option specifies that the
6074 presence of a suffix in the local part is optional. When a suffix is present,
6075 the check for a local login uses the local part with the suffix removed.
6076
6077 When a local user account is found, the file called &_.forward_& in the user's
6078 home directory is consulted. If it does not exist, or is empty, the router
6079 declines. Otherwise, the contents of &_.forward_& are interpreted as
6080 redirection data (see chapter &<<CHAPredirect>>& for more details).
6081
6082 .cindex "Sieve filter" "enabling in default router"
6083 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6084 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6085 is commented out by default), the contents of the file are interpreted as a set
6086 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6087 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6088 separate document entitled &'Exim's interfaces to mail filtering'&.
6089
6090 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6091 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6092 There are two reasons for doing this:
6093
6094 .olist
6095 Whether or not a local user has a &_.forward_& file is not really relevant when
6096 checking an address for validity; it makes sense not to waste resources doing
6097 unnecessary work.
6098 .next
6099 More importantly, when Exim is verifying addresses or handling an EXPN
6100 command during an SMTP session, it is running as the Exim user, not as root.
6101 The group is the Exim group, and no additional groups are set up.
6102 It may therefore not be possible for Exim to read users' &_.forward_& files at
6103 this time.
6104 .endlist
6105
6106 The setting of &%check_ancestor%& prevents the router from generating a new
6107 address that is the same as any previous address that was redirected. (This
6108 works round a problem concerning a bad interaction between aliasing and
6109 forwarding &-- see section &<<SECTredlocmai>>&).
6110
6111 The final three option settings specify the transports that are to be used when
6112 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6113 auto-reply, respectively. For example, if a &_.forward_& file contains
6114 .code
6115 a.nother@elsewhere.example, /home/spqr/archive
6116 .endd
6117 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6118 transport.
6119 .code
6120 localuser:
6121   driver = accept
6122   check_local_user
6123 # local_part_suffix = +* : -*
6124 # local_part_suffix_optional
6125   transport = local_delivery
6126 .endd
6127 The final router sets up delivery into local mailboxes, provided that the local
6128 part is the name of a local login, by accepting the address and assigning it to
6129 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6130 routers, so the address is bounced. The commented suffix settings fulfil the
6131 same purpose as they do for the &(userforward)& router.
6132
6133
6134 .section "Transport configuration" "SECID56"
6135 .cindex "default" "transports"
6136 .cindex "transports" "default"
6137 Transports define mechanisms for actually delivering messages. They operate
6138 only when referenced from routers, so the order in which they are defined does
6139 not matter. The transports section of the configuration starts with
6140 .code
6141 begin transports
6142 .endd
6143 One remote transport and four local transports are defined.
6144 .code
6145 remote_smtp:
6146   driver = smtp
6147   hosts_try_prdr = *
6148 .endd
6149 This transport is used for delivering messages over SMTP connections.
6150 The list of remote hosts comes from the router.
6151 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6152 It is negotiated between client and server
6153 and not expected to cause problems but can be disabled if needed.
6154 All other options are defaulted.
6155 .code
6156 local_delivery:
6157   driver = appendfile
6158   file = /var/mail/$local_part
6159   delivery_date_add
6160   envelope_to_add
6161   return_path_add
6162 # group = mail
6163 # mode = 0660
6164 .endd
6165 This &(appendfile)& transport is used for local delivery to user mailboxes in
6166 traditional BSD mailbox format. By default it runs under the uid and gid of the
6167 local user, which requires the sticky bit to be set on the &_/var/mail_&
6168 directory. Some systems use the alternative approach of running mail deliveries
6169 under a particular group instead of using the sticky bit. The commented options
6170 show how this can be done.
6171
6172 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6173 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6174 similarly-named options above.
6175 .code
6176 address_pipe:
6177   driver = pipe
6178   return_output
6179 .endd
6180 This transport is used for handling deliveries to pipes that are generated by
6181 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6182 option specifies that any output on stdout or stderr generated by the pipe is to
6183 be returned to the sender.
6184 .code
6185 address_file:
6186   driver = appendfile
6187   delivery_date_add
6188   envelope_to_add
6189   return_path_add
6190 .endd
6191 This transport is used for handling deliveries to files that are generated by
6192 redirection. The name of the file is not specified in this instance of
6193 &(appendfile)&, because it comes from the &(redirect)& router.
6194 .code
6195 address_reply:
6196   driver = autoreply
6197 .endd
6198 This transport is used for handling automatic replies generated by users'
6199 filter files.
6200
6201
6202
6203 .section "Default retry rule" "SECID57"
6204 .cindex "retry" "default rule"
6205 .cindex "default" "retry rule"
6206 The retry section of the configuration file contains rules which affect the way
6207 Exim retries deliveries that cannot be completed at the first attempt. It is
6208 introduced by the line
6209 .code
6210 begin retry
6211 .endd
6212 In the default configuration, there is just one rule, which applies to all
6213 errors:
6214 .code
6215 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6216 .endd
6217 This causes any temporarily failing address to be retried every 15 minutes for
6218 2 hours, then at intervals starting at one hour and increasing by a factor of
6219 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6220 is not delivered after 4 days of temporary failure, it is bounced. The time is
6221 measured from first failure, not from the time the message was received.
6222
6223 If the retry section is removed from the configuration, or is empty (that is,
6224 if no retry rules are defined), Exim will not retry deliveries. This turns
6225 temporary errors into permanent errors.
6226
6227
6228 .section "Rewriting configuration" "SECID58"
6229 The rewriting section of the configuration, introduced by
6230 .code
6231 begin rewrite
6232 .endd
6233 contains rules for rewriting addresses in messages as they arrive. There are no
6234 rewriting rules in the default configuration file.
6235
6236
6237
6238 .section "Authenticators configuration" "SECTdefconfauth"
6239 .cindex "AUTH" "configuration"
6240 The authenticators section of the configuration, introduced by
6241 .code
6242 begin authenticators
6243 .endd
6244 defines mechanisms for the use of the SMTP AUTH command. The default
6245 configuration file contains two commented-out example authenticators
6246 which support plaintext username/password authentication using the
6247 standard PLAIN mechanism and the traditional but non-standard LOGIN
6248 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6249 to support most MUA software.
6250
6251 The example PLAIN authenticator looks like this:
6252 .code
6253 #PLAIN:
6254 #  driver                  = plaintext
6255 #  server_set_id           = $auth2
6256 #  server_prompts          = :
6257 #  server_condition        = Authentication is not yet configured
6258 #  server_advertise_condition = ${if def:tls_in_cipher }
6259 .endd
6260 And the example LOGIN authenticator looks like this:
6261 .code
6262 #LOGIN:
6263 #  driver                  = plaintext
6264 #  server_set_id           = $auth1
6265 #  server_prompts          = <| Username: | Password:
6266 #  server_condition        = Authentication is not yet configured
6267 #  server_advertise_condition = ${if def:tls_in_cipher }
6268 .endd
6269
6270 The &%server_set_id%& option makes Exim remember the authenticated username
6271 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6272 &%server_prompts%& option configures the &(plaintext)& authenticator so
6273 that it implements the details of the specific authentication mechanism,
6274 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6275 when Exim offers authentication to clients; in the examples, this is only
6276 when TLS or SSL has been started, so to enable the authenticators you also
6277 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6278
6279 The &%server_condition%& setting defines how to verify that the username and
6280 password are correct. In the examples it just produces an error message.
6281 To make the authenticators work, you can use a string expansion
6282 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6283
6284 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6285 usercode and password are in different positions.
6286 Chapter &<<CHAPplaintext>>& covers both.
6287
6288 .ecindex IIDconfiwal
6289
6290
6291
6292 . ////////////////////////////////////////////////////////////////////////////
6293 . ////////////////////////////////////////////////////////////////////////////
6294
6295 .chapter "Regular expressions" "CHAPregexp"
6296
6297 .cindex "regular expressions" "library"
6298 .cindex "PCRE"
6299 Exim supports the use of regular expressions in many of its options. It
6300 uses the PCRE regular expression library; this provides regular expression
6301 matching that is compatible with Perl 5. The syntax and semantics of
6302 regular expressions is discussed in
6303 online Perl manpages, in
6304 many Perl reference books, and also in
6305 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6306 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6307
6308 The documentation for the syntax and semantics of the regular expressions that
6309 are supported by PCRE is included in the PCRE distribution, and no further
6310 description is included here. The PCRE functions are called from Exim using
6311 the default option settings (that is, with no PCRE options set), except that
6312 the PCRE_CASELESS option is set when the matching is required to be
6313 case-insensitive.
6314
6315 In most cases, when a regular expression is required in an Exim configuration,
6316 it has to start with a circumflex, in order to distinguish it from plain text
6317 or an &"ends with"& wildcard. In this example of a configuration setting, the
6318 second item in the colon-separated list is a regular expression.
6319 .code
6320 domains = a.b.c : ^\\d{3} : *.y.z : ...
6321 .endd
6322 The doubling of the backslash is required because of string expansion that
6323 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6324 of this issue, and a way of avoiding the need for doubling backslashes. The
6325 regular expression that is eventually used in this example contains just one
6326 backslash. The circumflex is included in the regular expression, and has the
6327 normal effect of &"anchoring"& it to the start of the string that is being
6328 matched.
6329
6330 There are, however, two cases where a circumflex is not required for the
6331 recognition of a regular expression: these are the &%match%& condition in a
6332 string expansion, and the &%matches%& condition in an Exim filter file. In
6333 these cases, the relevant string is always treated as a regular expression; if
6334 it does not start with a circumflex, the expression is not anchored, and can
6335 match anywhere in the subject string.
6336
6337 In all cases, if you want a regular expression to match at the end of a string,
6338 you must code the $ metacharacter to indicate this. For example:
6339 .code
6340 domains = ^\\d{3}\\.example
6341 .endd
6342 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6343 You need to use:
6344 .code
6345 domains = ^\\d{3}\\.example\$
6346 .endd
6347 if you want &'example'& to be the top-level domain. The backslash before the
6348 $ is needed because string expansion also interprets dollar characters.
6349
6350
6351
6352 . ////////////////////////////////////////////////////////////////////////////
6353 . ////////////////////////////////////////////////////////////////////////////
6354
6355 .chapter "File and database lookups" "CHAPfdlookup"
6356 .scindex IIDfidalo1 "file" "lookups"
6357 .scindex IIDfidalo2 "database" "lookups"
6358 .cindex "lookup" "description of"
6359 Exim can be configured to look up data in files or databases as it processes
6360 messages. Two different kinds of syntax are used:
6361
6362 .olist
6363 A string that is to be expanded may contain explicit lookup requests. These
6364 cause parts of the string to be replaced by data that is obtained from the
6365 lookup. Lookups of this type are conditional expansion items. Different results
6366 can be defined for the cases of lookup success and failure. See chapter
6367 &<<CHAPexpand>>&, where string expansions are described in detail.
6368 The key for the lookup is specified as part of the string expansion.
6369 .next
6370 Lists of domains, hosts, and email addresses can contain lookup requests as a
6371 way of avoiding excessively long linear lists. In this case, the data that is
6372 returned by the lookup is often (but not always) discarded; whether the lookup
6373 succeeds or fails is what really counts. These kinds of list are described in
6374 chapter &<<CHAPdomhosaddlists>>&.
6375 The key for the lookup is given by the context in which the list is expanded.
6376 .endlist
6377
6378 String expansions, lists, and lookups interact with each other in such a way
6379 that there is no order in which to describe any one of them that does not
6380 involve references to the others. Each of these three chapters makes more sense
6381 if you have read the other two first. If you are reading this for the first
6382 time, be aware that some of it will make a lot more sense after you have read
6383 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6384
6385 .section "Examples of different lookup syntax" "SECID60"
6386 It is easy to confuse the two different kinds of lookup, especially as the
6387 lists that may contain the second kind are always expanded before being
6388 processed as lists. Therefore, they may also contain lookups of the first kind.
6389 Be careful to distinguish between the following two examples:
6390 .code
6391 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6392 domains = lsearch;/some/file
6393 .endd
6394 The first uses a string expansion, the result of which must be a domain list.
6395 No strings have been specified for a successful or a failing lookup; the
6396 defaults in this case are the looked-up data and an empty string, respectively.
6397 The expansion takes place before the string is processed as a list, and the
6398 file that is searched could contain lines like this:
6399 .code
6400 192.168.3.4: domain1:domain2:...
6401 192.168.1.9: domain3:domain4:...
6402 .endd
6403 When the lookup succeeds, the result of the expansion is a list of domains (and
6404 possibly other types of item that are allowed in domain lists).
6405
6406 In the second example, the lookup is a single item in a domain list. It causes
6407 Exim to use a lookup to see if the domain that is being processed can be found
6408 in the file. The file could contains lines like this:
6409 .code
6410 domain1:
6411 domain2:
6412 .endd
6413 Any data that follows the keys is not relevant when checking that the domain
6414 matches the list item.
6415
6416 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6417 Consider a file containing lines like this:
6418 .code
6419 192.168.5.6: lsearch;/another/file
6420 .endd
6421 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6422 first &%domains%& setting above generates the second setting, which therefore
6423 causes a second lookup to occur.
6424
6425 The rest of this chapter describes the different lookup types that are
6426 available. Any of them can be used in any part of the configuration where a
6427 lookup is permitted.
6428
6429
6430 .section "Lookup types" "SECID61"
6431 .cindex "lookup" "types of"
6432 .cindex "single-key lookup" "definition of"
6433 Two different types of data lookup are implemented:
6434
6435 .ilist
6436 The &'single-key'& type requires the specification of a file in which to look,
6437 and a single key to search for. The key must be a non-empty string for the
6438 lookup to succeed. The lookup type determines how the file is searched.
6439 .next
6440 .cindex "query-style lookup" "definition of"
6441 The &'query-style'& type accepts a generalized database query. No particular
6442 key value is assumed by Exim for query-style lookups. You can use whichever
6443 Exim variables you need to construct the database query.
6444 .endlist
6445
6446 The code for each lookup type is in a separate source file that is included in
6447 the binary of Exim only if the corresponding compile-time option is set. The
6448 default settings in &_src/EDITME_& are:
6449 .code
6450 LOOKUP_DBM=yes
6451 LOOKUP_LSEARCH=yes
6452 .endd
6453 which means that only linear searching and DBM lookups are included by default.
6454 For some types of lookup (e.g. SQL databases), you need to install appropriate
6455 libraries and header files before building Exim.
6456
6457
6458
6459
6460 .section "Single-key lookup types" "SECTsinglekeylookups"
6461 .cindex "lookup" "single-key types"
6462 .cindex "single-key lookup" "list of types"
6463 The following single-key lookup types are implemented:
6464
6465 .ilist
6466 .cindex "cdb" "description of"
6467 .cindex "lookup" "cdb"
6468 .cindex "binary zero" "in lookup key"
6469 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6470 string without a terminating binary zero. The cdb format is designed for
6471 indexed files that are read frequently and never updated, except by total
6472 re-creation. As such, it is particularly suitable for large files containing
6473 aliases or other indexed data referenced by an MTA. Information about cdb can
6474 be found in several places:
6475 .display
6476 &url(http://www.pobox.com/~djb/cdb.html)
6477 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6478 &url(http://packages.debian.org/stable/utils/freecdb.html)
6479 .endd
6480 A cdb distribution is not needed in order to build Exim with cdb support,
6481 because the code for reading cdb files is included directly in Exim itself.
6482 However, no means of building or testing cdb files is provided with Exim, so
6483 you need to obtain a cdb distribution in order to do this.
6484 .next
6485 .cindex "DBM" "lookup type"
6486 .cindex "lookup" "dbm"
6487 .cindex "binary zero" "in lookup key"
6488 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6489 DBM file by looking up the record with the given key. A terminating binary
6490 zero is included in the key that is passed to the DBM library. See section
6491 &<<SECTdb>>& for a discussion of DBM libraries.
6492
6493 .cindex "Berkeley DB library" "file format"
6494 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6495 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6496 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6497 the DB_UNKNOWN option. This enables it to handle any of the types of database
6498 that the library supports, and can be useful for accessing DBM files created by
6499 other applications. (For earlier DB versions, DB_HASH is always used.)
6500 .next
6501 .cindex "lookup" "dbmjz"
6502 .cindex "lookup" "dbm &-- embedded NULs"
6503 .cindex "sasldb2"
6504 .cindex "dbmjz lookup type"
6505 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6506 interpreted as an Exim list; the elements of the list are joined together with
6507 ASCII NUL characters to form the lookup key.  An example usage would be to
6508 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6509 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6510 &(cram_md5)& authenticator.
6511 .next
6512 .cindex "lookup" "dbmnz"
6513 .cindex "lookup" "dbm &-- terminating zero"
6514 .cindex "binary zero" "in lookup key"
6515 .cindex "Courier"
6516 .cindex "&_/etc/userdbshadow.dat_&"
6517 .cindex "dbmnz lookup type"
6518 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6519 is not included in the key that is passed to the DBM library. You may need this
6520 if you want to look up data in files that are created by or shared with some
6521 other application that does not use terminating zeros. For example, you need to
6522 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6523 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6524 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6525 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6526 .next
6527 .cindex "lookup" "dsearch"
6528 .cindex "dsearch lookup type"
6529 &(dsearch)&: The given file must be a directory; this is searched for an entry
6530 whose name is the key by calling the &[lstat()]& function. The key may not
6531 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6532 the lookup is the name of the entry, which may be a file, directory,
6533 symbolic link, or any other kind of directory entry. An example of how this
6534 lookup can be used to support virtual domains is given in section
6535 &<<SECTvirtualdomains>>&.
6536 .next
6537 .cindex "lookup" "iplsearch"
6538 .cindex "iplsearch lookup type"
6539 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6540 terminated by a colon or white space or the end of the line. The keys in the
6541 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6542 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6543 being interpreted as a key terminator. For example:
6544 .code
6545 1.2.3.4:           data for 1.2.3.4
6546 192.168.0.0/16:    data for 192.168.0.0/16
6547 "abcd::cdab":      data for abcd::cdab
6548 "abcd:abcd::/32"   data for abcd:abcd::/32
6549 .endd
6550 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6551 file is searched linearly, using the CIDR masks where present, until a matching
6552 key is found. The first key that matches is used; there is no attempt to find a
6553 &"best"& match. Apart from the way the keys are matched, the processing for
6554 &(iplsearch)& is the same as for &(lsearch)&.
6555
6556 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6557 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6558 lookup types support only literal keys.
6559
6560 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6561 the implicit key is the host's IP address rather than its name (see section
6562 &<<SECThoslispatsikey>>&).
6563 .next
6564 .cindex "linear search"
6565 .cindex "lookup" "lsearch"
6566 .cindex "lsearch lookup type"
6567 .cindex "case sensitivity" "in lsearch lookup"
6568 &(lsearch)&: The given file is a text file that is searched linearly for a
6569 line beginning with the search key, terminated by a colon or white space or the
6570 end of the line. The search is case-insensitive; that is, upper and lower case
6571 letters are treated as the same. The first occurrence of the key that is found
6572 in the file is used.
6573
6574 White space between the key and the colon is permitted. The remainder of the
6575 line, with leading and trailing white space removed, is the data. This can be
6576 continued onto subsequent lines by starting them with any amount of white
6577 space, but only a single space character is included in the data at such a
6578 junction. If the data begins with a colon, the key must be terminated by a
6579 colon, for example:
6580 .code
6581 baduser:  :fail:
6582 .endd
6583 Empty lines and lines beginning with # are ignored, even if they occur in the
6584 middle of an item. This is the traditional textual format of alias files. Note
6585 that the keys in an &(lsearch)& file are literal strings. There is no
6586 wildcarding of any kind.
6587
6588 .cindex "lookup" "lsearch &-- colons in keys"
6589 .cindex "white space" "in lsearch key"
6590 In most &(lsearch)& files, keys are not required to contain colons or #
6591 characters, or white space. However, if you need this feature, it is available.
6592 If a key begins with a doublequote character, it is terminated only by a
6593 matching quote (or end of line), and the normal escaping rules apply to its
6594 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6595 quoted keys (exactly as for unquoted keys). There is no special handling of
6596 quotes for the data part of an &(lsearch)& line.
6597
6598 .next
6599 .cindex "NIS lookup type"
6600 .cindex "lookup" "NIS"
6601 .cindex "binary zero" "in lookup key"
6602 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6603 the given key, without a terminating binary zero. There is a variant called
6604 &(nis0)& which does include the terminating binary zero in the key. This is
6605 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6606 aliases; the full map names must be used.
6607
6608 .next
6609 .cindex "wildlsearch lookup type"
6610 .cindex "lookup" "wildlsearch"
6611 .cindex "nwildlsearch lookup type"
6612 .cindex "lookup" "nwildlsearch"
6613 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6614 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6615 the file may be wildcarded. The difference between these two lookup types is
6616 that for &(wildlsearch)&, each key in the file is string-expanded before being
6617 used, whereas for &(nwildlsearch)&, no expansion takes place.
6618
6619 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6620 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6621 file that are regular expressions can be made case-sensitive by the use of
6622 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6623
6624 . ==== As this is a nested list, any displays it contains must be indented
6625 . ==== as otherwise they are too far to the left.
6626
6627 .olist
6628 The string may begin with an asterisk to mean &"ends with"&. For example:
6629 .code
6630     *.a.b.c       data for anything.a.b.c
6631     *fish         data for anythingfish
6632 .endd
6633 .next
6634 The string may begin with a circumflex to indicate a regular expression. For
6635 example, for &(wildlsearch)&:
6636 .code
6637     ^\N\d+\.a\.b\N    data for <digits>.a.b
6638 .endd
6639 Note the use of &`\N`& to disable expansion of the contents of the regular
6640 expression. If you are using &(nwildlsearch)&, where the keys are not
6641 string-expanded, the equivalent entry is:
6642 .code
6643     ^\d+\.a\.b        data for <digits>.a.b
6644 .endd
6645 The case-insensitive flag is set at the start of compiling the regular
6646 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6647 For example, to make the entire pattern case-sensitive:
6648 .code
6649     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6650 .endd
6651
6652 If the regular expression contains white space or colon characters, you must
6653 either quote it (see &(lsearch)& above), or represent these characters in other
6654 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6655 colon. This may be easier than quoting, because if you quote, you have to
6656 escape all the backslashes inside the quotes.
6657
6658 &*Note*&: It is not possible to capture substrings in a regular expression
6659 match for later use, because the results of all lookups are cached. If a lookup
6660 is repeated, the result is taken from the cache, and no actual pattern matching
6661 takes place. The values of all the numeric variables are unset after a
6662 &((n)wildlsearch)& match.
6663
6664 .next
6665 Although I cannot see it being of much use, the general matching function that
6666 is used to implement &((n)wildlsearch)& means that the string may begin with a
6667 lookup name terminated by a semicolon, and followed by lookup data. For
6668 example:
6669 .code
6670     cdb;/some/file  data for keys that match the file
6671 .endd
6672 The data that is obtained from the nested lookup is discarded.
6673 .endlist olist
6674
6675 Keys that do not match any of these patterns are interpreted literally. The
6676 continuation rules for the data are the same as for &(lsearch)&, and keys may
6677 be followed by optional colons.
6678
6679 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6680 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6681 lookup types support only literal keys.
6682 .endlist ilist
6683
6684
6685 .section "Query-style lookup types" "SECTquerystylelookups"
6686 .cindex "lookup" "query-style types"
6687 .cindex "query-style lookup" "list of types"
6688 The supported query-style lookup types are listed below. Further details about
6689 many of them are given in later sections.
6690
6691 .ilist
6692 .cindex "DNS" "as a lookup type"
6693 .cindex "lookup" "DNS"
6694 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6695 are given in the supplied query. The resulting data is the contents of the
6696 records. See section &<<SECTdnsdb>>&.
6697 .next
6698 .cindex "InterBase lookup type"
6699 .cindex "lookup" "InterBase"
6700 &(ibase)&: This does a lookup in an InterBase database.
6701 .next
6702 .cindex "LDAP" "lookup type"
6703 .cindex "lookup" "LDAP"
6704 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6705 returns attributes from a single entry. There is a variant called &(ldapm)&
6706 that permits values from multiple entries to be returned. A third variant
6707 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6708 any attribute values. See section &<<SECTldap>>&.
6709 .next
6710 .cindex "MySQL" "lookup type"
6711 .cindex "lookup" "MySQL"
6712 &(mysql)&: The format of the query is an SQL statement that is passed to a
6713 MySQL database. See section &<<SECTsql>>&.
6714 .next
6715 .cindex "NIS+ lookup type"
6716 .cindex "lookup" "NIS+"
6717 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6718 the field to be returned. See section &<<SECTnisplus>>&.
6719 .next
6720 .cindex "Oracle" "lookup type"
6721 .cindex "lookup" "Oracle"
6722 &(oracle)&: The format of the query is an SQL statement that is passed to an
6723 Oracle database. See section &<<SECTsql>>&.
6724 .next
6725 .cindex "lookup" "passwd"
6726 .cindex "passwd lookup type"
6727 .cindex "&_/etc/passwd_&"
6728 &(passwd)& is a query-style lookup with queries that are just user names. The
6729 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6730 success, the result string is the same as you would get from an &(lsearch)&
6731 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6732 password value. For example:
6733 .code
6734 *:42:42:King Rat:/home/kr:/bin/bash
6735 .endd
6736 .next
6737 .cindex "PostgreSQL lookup type"
6738 .cindex "lookup" "PostgreSQL"
6739 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6740 PostgreSQL database. See section &<<SECTsql>>&.
6741
6742 .next
6743 .cindex "Redis lookup type"
6744 .cindex lookup Redis
6745 &(redis)&: The format of the query is either a simple get or simple set,
6746 passed to a Redis database. See section &<<SECTsql>>&.
6747
6748 .next
6749 .cindex "sqlite lookup type"
6750 .cindex "lookup" "sqlite"
6751 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6752 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6753
6754 .next
6755 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6756 not likely to be useful in normal operation.
6757 .next
6758 .cindex "whoson lookup type"
6759 .cindex "lookup" "whoson"
6760 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6761 allows a server to check whether a particular (dynamically allocated) IP
6762 address is currently allocated to a known (trusted) user and, optionally, to
6763 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6764 at one time for &"POP before SMTP"& authentication, but that approach has been
6765 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6766 &"POP before SMTP"& checking using ACL statements such as
6767 .code
6768 require condition = \
6769   ${lookup whoson {$sender_host_address}{yes}{no}}
6770 .endd
6771 The query consists of a single IP address. The value returned is the name of
6772 the authenticated user, which is stored in the variable &$value$&. However, in
6773 this example, the data in &$value$& is not used; the result of the lookup is
6774 one of the fixed strings &"yes"& or &"no"&.
6775 .endlist
6776
6777
6778
6779 .section "Temporary errors in lookups" "SECID63"
6780 .cindex "lookup" "temporary error in"
6781 Lookup functions can return temporary error codes if the lookup cannot be
6782 completed. For example, an SQL or LDAP database might be unavailable. For this
6783 reason, it is not advisable to use a lookup that might do this for critical
6784 options such as a list of local domains.
6785
6786 When a lookup cannot be completed in a router or transport, delivery
6787 of the message (to the relevant address) is deferred, as for any other
6788 temporary error. In other circumstances Exim may assume the lookup has failed,
6789 or may give up altogether.
6790
6791
6792
6793 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6794 .cindex "wildcard lookups"
6795 .cindex "lookup" "default values"
6796 .cindex "lookup" "wildcard"
6797 .cindex "lookup" "* added to type"
6798 .cindex "default" "in single-key lookups"
6799 In this context, a &"default value"& is a value specified by the administrator
6800 that is to be used if a lookup fails.
6801
6802 &*Note:*& This section applies only to single-key lookups. For query-style
6803 lookups, the facilities of the query language must be used. An attempt to
6804 specify a default for a query-style lookup provokes an error.
6805
6806 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6807 and the initial lookup fails, the key &"*"& is looked up in the file to
6808 provide a default value. See also the section on partial matching below.
6809
6810 .cindex "*@ with single-key lookup"
6811 .cindex "lookup" "*@ added to type"
6812 .cindex "alias file" "per-domain default"
6813 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6814 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6815 character, a second lookup is done with everything before the last @ replaced
6816 by *. This makes it possible to provide per-domain defaults in alias files
6817 that include the domains in the keys. If the second lookup fails (or doesn't
6818 take place because there is no @ in the key), &"*"& is looked up.
6819 For example, a &(redirect)& router might contain:
6820 .code
6821 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6822 .endd
6823 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6824 looks up these keys, in this order:
6825 .code
6826 jane@eyre.example
6827 *@eyre.example
6828 *
6829 .endd
6830 The data is taken from whichever key it finds first. &*Note*&: In an
6831 &(lsearch)& file, this does not mean the first of these keys in the file. A
6832 complete scan is done for each key, and only if it is not found at all does
6833 Exim move on to try the next key.
6834
6835
6836
6837 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6838 .cindex "partial matching"
6839 .cindex "wildcard lookups"
6840 .cindex "lookup" "partial matching"
6841 .cindex "lookup" "wildcard"
6842 .cindex "asterisk" "in search type"
6843 The normal operation of a single-key lookup is to search the file for an exact
6844 match with the given key. However, in a number of situations where domains are
6845 being looked up, it is useful to be able to do partial matching. In this case,
6846 information in the file that has a key starting with &"*."& is matched by any
6847 domain that ends with the components that follow the full stop. For example, if
6848 a key in a DBM file is
6849 .code
6850 *.dates.fict.example
6851 .endd
6852 then when partial matching is enabled this is matched by (amongst others)
6853 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6854 by &'dates.fict.example'&, if that does not appear as a separate key in the
6855 file.
6856
6857 &*Note*&: Partial matching is not available for query-style lookups. It is
6858 also not available for any lookup items in address lists (see section
6859 &<<SECTaddresslist>>&).
6860
6861 Partial matching is implemented by doing a series of separate lookups using
6862 keys constructed by modifying the original subject key. This means that it can
6863 be used with any of the single-key lookup types, provided that
6864 partial matching keys
6865 beginning with a special prefix (default &"*."&) are included in the data file.
6866 Keys in the file that do not begin with the prefix are matched only by
6867 unmodified subject keys when partial matching is in use.
6868
6869 Partial matching is requested by adding the string &"partial-"& to the front of
6870 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6871 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6872 is added at the start of the subject key, and it is looked up again. If that
6873 fails, further lookups are tried with dot-separated components removed from the
6874 start of the subject key, one-by-one, and &"*."& added on the front of what
6875 remains.
6876
6877 A minimum number of two non-* components are required. This can be adjusted
6878 by including a number before the hyphen in the search type. For example,
6879 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6880 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6881 subject key is &'2250.dates.fict.example'& then the following keys are looked
6882 up when the minimum number of non-* components is two:
6883 .code
6884 2250.dates.fict.example
6885 *.2250.dates.fict.example
6886 *.dates.fict.example
6887 *.fict.example
6888 .endd
6889 As soon as one key in the sequence is successfully looked up, the lookup
6890 finishes.
6891
6892 .cindex "lookup" "partial matching &-- changing prefix"
6893 .cindex "prefix" "for partial matching"
6894 The use of &"*."& as the partial matching prefix is a default that can be
6895 changed. The motivation for this feature is to allow Exim to operate with file
6896 formats that are used by other MTAs. A different prefix can be supplied in
6897 parentheses instead of the hyphen after &"partial"&. For example:
6898 .code
6899 domains = partial(.)lsearch;/some/file
6900 .endd
6901 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6902 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6903 components is unchanged). The prefix may consist of any punctuation characters
6904 other than a closing parenthesis. It may be empty, for example:
6905 .code
6906 domains = partial1()cdb;/some/file
6907 .endd
6908 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6909 &`a.b.c`&, &`b.c`&, and &`c`&.
6910
6911 If &"partial0"& is specified, what happens at the end (when the lookup with
6912 just one non-wild component has failed, and the original key is shortened right
6913 down to the null string) depends on the prefix:
6914
6915 .ilist
6916 If the prefix has zero length, the whole lookup fails.
6917 .next
6918 If the prefix has length 1, a lookup for just the prefix is done. For
6919 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6920 .next
6921 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6922 remainder is looked up. With the default prefix, therefore, the final lookup is
6923 for &"*"& on its own.
6924 .next
6925 Otherwise, the whole prefix is looked up.
6926 .endlist
6927
6928
6929 If the search type ends in &"*"& or &"*@"& (see section
6930 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6931 this implies happens after all partial lookups have failed. If &"partial0"& is
6932 specified, adding &"*"& to the search type has no effect with the default
6933 prefix, because the &"*"& key is already included in the sequence of partial
6934 lookups. However, there might be a use for lookup types such as
6935 &"partial0(.)lsearch*"&.
6936
6937 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6938 in domain lists and the like. Partial matching works only in terms of
6939 dot-separated components; a key such as &`*fict.example`&
6940 in a database file is useless, because the asterisk in a partial matching
6941 subject key is always followed by a dot.
6942
6943
6944
6945
6946 .section "Lookup caching" "SECID64"
6947 .cindex "lookup" "caching"
6948 .cindex "caching" "lookup data"
6949 Exim caches all lookup results in order to avoid needless repetition of
6950 lookups. However, because (apart from the daemon) Exim operates as a collection
6951 of independent, short-lived processes, this caching applies only within a
6952 single Exim process. There is no inter-process lookup caching facility.
6953
6954 For single-key lookups, Exim keeps the relevant files open in case there is
6955 another lookup that needs them. In some types of configuration this can lead to
6956 many files being kept open for messages with many recipients. To avoid hitting
6957 the operating system limit on the number of simultaneously open files, Exim
6958 closes the least recently used file when it needs to open more files than its
6959 own internal limit, which can be changed via the &%lookup_open_max%& option.
6960
6961 The single-key lookup files are closed and the lookup caches are flushed at
6962 strategic points during delivery &-- for example, after all routing is
6963 complete.
6964
6965
6966
6967
6968 .section "Quoting lookup data" "SECID65"
6969 .cindex "lookup" "quoting"
6970 .cindex "quoting" "in lookups"
6971 When data from an incoming message is included in a query-style lookup, there
6972 is the possibility of special characters in the data messing up the syntax of
6973 the query. For example, a NIS+ query that contains
6974 .code
6975 [name=$local_part]
6976 .endd
6977 will be broken if the local part happens to contain a closing square bracket.
6978 For NIS+, data can be enclosed in double quotes like this:
6979 .code
6980 [name="$local_part"]
6981 .endd
6982 but this still leaves the problem of a double quote in the data. The rule for
6983 NIS+ is that double quotes must be doubled. Other lookup types have different
6984 rules, and to cope with the differing requirements, an expansion operator
6985 of the following form is provided:
6986 .code
6987 ${quote_<lookup-type>:<string>}
6988 .endd
6989 For example, the safest way to write the NIS+ query is
6990 .code
6991 [name="${quote_nisplus:$local_part}"]
6992 .endd
6993 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6994 operator can be used for all lookup types, but has no effect for single-key
6995 lookups, since no quoting is ever needed in their key strings.
6996
6997
6998
6999
7000 .section "More about dnsdb" "SECTdnsdb"
7001 .cindex "dnsdb lookup"
7002 .cindex "lookup" "dnsdb"
7003 .cindex "DNS" "as a lookup type"
7004 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7005 of a record type and a domain name, separated by an equals sign. For example,
7006 an expansion string could contain:
7007 .code
7008 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7009 .endd
7010 If the lookup succeeds, the result is placed in &$value$&, which in this case
7011 is used on its own as the result. If the lookup does not succeed, the
7012 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7013 &<<SECTforexpfai>>& for an explanation of what this means.
7014
7015 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7016 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7017 If no type is given, TXT is assumed.
7018
7019 For any record type, if multiple records are found, the data is returned as a
7020 concatenation, with newline as the default separator. The order, of course,
7021 depends on the DNS resolver. You can specify a different separator character
7022 between multiple records by putting a right angle-bracket followed immediately
7023 by the new separator at the start of the query. For example:
7024 .code
7025 ${lookup dnsdb{>: a=host1.example}}
7026 .endd
7027 It is permitted to specify a space as the separator character. Further
7028 white space is ignored.
7029 For lookup types that return multiple fields per record,
7030 an alternate field separator can be specified using a comma after the main
7031 separator character, followed immediately by the field separator.
7032
7033 .cindex "PTR record" "in &(dnsdb)& lookup"
7034 When the type is PTR,
7035 the data can be an IP address, written as normal; inversion and the addition of
7036 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7037 .code
7038 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7039 .endd
7040 If the data for a PTR record is not a syntactically valid IP address, it is not
7041 altered and nothing is added.
7042
7043 .cindex "MX record" "in &(dnsdb)& lookup"
7044 .cindex "SRV record" "in &(dnsdb)& lookup"
7045 For an MX lookup, both the preference value and the host name are returned for
7046 each record, separated by a space. For an SRV lookup, the priority, weight,
7047 port, and host name are returned for each record, separated by spaces.
7048 The field separator can be modified as above.
7049
7050 .cindex "TXT record" "in &(dnsdb)& lookup"
7051 .cindex "SPF record" "in &(dnsdb)& lookup"
7052 For TXT records with multiple items of data, only the first item is returned,
7053 unless a field separator is specified.
7054 To concatenate items without a separator, use a semicolon instead.
7055 For SPF records the
7056 default behaviour is to concatenate multiple items without using a separator.
7057 .code
7058 ${lookup dnsdb{>\n,: txt=a.b.example}}
7059 ${lookup dnsdb{>\n; txt=a.b.example}}
7060 ${lookup dnsdb{spf=example.org}}
7061 .endd
7062 It is permitted to specify a space as the separator character. Further
7063 white space is ignored.
7064
7065 .cindex "SOA record" "in &(dnsdb)& lookup"
7066 For an SOA lookup, while no result is obtained the lookup is redone with
7067 successively more leading components dropped from the given domain.
7068 Only the primary-nameserver field is returned unless a field separator is
7069 specified.
7070 .code
7071 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7072 .endd
7073
7074 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7075 .cindex "dnsdb modifiers"
7076 .cindex "modifiers" "dnsdb"
7077 .cindex "options" "dnsdb"
7078 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7079 each followed by a comma,
7080 that may appear before the record type.
7081
7082 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7083 temporary DNS error for any of them, the behaviour is controlled by
7084 a defer-option modifier.
7085 The possible keywords are
7086 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7087 With &"strict"& behaviour, any temporary DNS error causes the
7088 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7089 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7090 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7091 error causes the whole lookup to defer only if none of the other lookups
7092 succeed. The default is &"lax"&, so the following lookups are equivalent:
7093 .code
7094 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7095 ${lookup dnsdb{a=one.host.com:two.host.com}}
7096 .endd
7097 Thus, in the default case, as long as at least one of the DNS lookups
7098 yields some data, the lookup succeeds.
7099
7100 .cindex "DNSSEC" "dns lookup"
7101 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7102 The possible keywords are
7103 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7104 With &"strict"& or &"lax"& DNSSEC information is requested
7105 with the lookup.
7106 With &"strict"& a response from the DNS resolver that
7107 is not labelled as authenticated data
7108 is treated as equivalent to a temporary DNS error.
7109 The default is &"never"&.
7110
7111 See also the &$lookup_dnssec_authenticated$& variable.
7112
7113 .cindex timeout "dns lookup"
7114 .cindex "DNS" timeout
7115 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7116 The form is &"retrans_VAL"& where VAL is an Exim time specification
7117 (e.g. &"5s"&).
7118 The default value is set by the main configuration option &%dns_retrans%&.
7119
7120 Retries for the dnsdb lookup can be controlled by a retry modifier.
7121 The form if &"retry_VAL"& where VAL is an integer.
7122 The default count is set by the main configuration option &%dns_retry%&.
7123
7124 .cindex caching "of dns lookup"
7125 .cindex TTL "of dns lookup"
7126 .cindex DNS TTL
7127 Dnsdb lookup results are cached within a single process (and its children).
7128 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7129 value of the set of returned DNS records.
7130
7131
7132 .section "Pseudo dnsdb record types" "SECID66"
7133 .cindex "MX record" "in &(dnsdb)& lookup"
7134 By default, both the preference value and the host name are returned for
7135 each MX record, separated by a space. If you want only host names, you can use
7136 the pseudo-type MXH:
7137 .code
7138 ${lookup dnsdb{mxh=a.b.example}}
7139 .endd
7140 In this case, the preference values are omitted, and just the host names are
7141 returned.
7142
7143 .cindex "name server for enclosing domain"
7144 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7145 records on the given domain, but if none are found, it removes the first
7146 component of the domain name, and tries again. This process continues until NS
7147 records are found or there are no more components left (or there is a DNS
7148 error). In other words, it may return the name servers for a top-level domain,
7149 but it never returns the root name servers. If there are no NS records for the
7150 top-level domain, the lookup fails. Consider these examples:
7151 .code
7152 ${lookup dnsdb{zns=xxx.quercite.com}}
7153 ${lookup dnsdb{zns=xxx.edu}}
7154 .endd
7155 Assuming that in each case there are no NS records for the full domain name,
7156 the first returns the name servers for &%quercite.com%&, and the second returns
7157 the name servers for &%edu%&.
7158
7159 You should be careful about how you use this lookup because, unless the
7160 top-level domain does not exist, the lookup always returns some host names. The
7161 sort of use to which this might be put is for seeing if the name servers for a
7162 given domain are on a blacklist. You can probably assume that the name servers
7163 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7164 such a list.
7165
7166 .cindex "CSA" "in &(dnsdb)& lookup"
7167 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7168 records according to the CSA rules, which are described in section
7169 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7170 not sufficient because of the extra parent domain search behaviour of CSA. The
7171 result of a successful lookup such as:
7172 .code
7173 ${lookup dnsdb {csa=$sender_helo_name}}
7174 .endd
7175 has two space-separated fields: an authorization code and a target host name.
7176 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7177 authorization required but absent, or &"?"& for unknown.
7178
7179 .cindex "A+" "in &(dnsdb)& lookup"
7180 The pseudo-type A+ performs an AAAA
7181 and then an A lookup.  All results are returned; defer processing
7182 (see below) is handled separately for each lookup.  Example:
7183 .code
7184 ${lookup dnsdb {>; a+=$sender_helo_name}}
7185 .endd
7186
7187
7188 .section "Multiple dnsdb lookups" "SECID67"
7189 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7190 However, you can specify a list of domains or IP addresses in a single
7191 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7192 the default separator, but with the ability to change this. For example:
7193 .code
7194 ${lookup dnsdb{one.domain.com:two.domain.com}}
7195 ${lookup dnsdb{a=one.host.com:two.host.com}}
7196 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7197 .endd
7198 In order to retain backwards compatibility, there is one special case: if
7199 the lookup type is PTR and no change of separator is specified, Exim looks
7200 to see if the rest of the string is precisely one IPv6 address. In this
7201 case, it does not treat it as a list.
7202
7203 The data from each lookup is concatenated, with newline separators by default,
7204 in the same way that multiple DNS records for a single item are handled. A
7205 different separator can be specified, as described above.
7206
7207
7208
7209
7210 .section "More about LDAP" "SECTldap"
7211 .cindex "LDAP" "lookup, more about"
7212 .cindex "lookup" "LDAP"
7213 .cindex "Solaris" "LDAP"
7214 The original LDAP implementation came from the University of Michigan; this has
7215 become &"Open LDAP"&, and there are now two different releases. Another
7216 implementation comes from Netscape, and Solaris 7 and subsequent releases
7217 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7218 the lookup function level, their error handling is different. For this reason
7219 it is necessary to set a compile-time variable when building Exim with LDAP, to
7220 indicate which LDAP library is in use. One of the following should appear in
7221 your &_Local/Makefile_&:
7222 .code
7223 LDAP_LIB_TYPE=UMICHIGAN
7224 LDAP_LIB_TYPE=OPENLDAP1
7225 LDAP_LIB_TYPE=OPENLDAP2
7226 LDAP_LIB_TYPE=NETSCAPE
7227 LDAP_LIB_TYPE=SOLARIS
7228 .endd
7229 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7230 same interface as the University of Michigan version.
7231
7232 There are three LDAP lookup types in Exim. These behave slightly differently in
7233 the way they handle the results of a query:
7234
7235 .ilist
7236 &(ldap)& requires the result to contain just one entry; if there are more, it
7237 gives an error.
7238 .next
7239 &(ldapdn)& also requires the result to contain just one entry, but it is the
7240 Distinguished Name that is returned rather than any attribute values.
7241 .next
7242 &(ldapm)& permits the result to contain more than one entry; the attributes
7243 from all of them are returned.
7244 .endlist
7245
7246
7247 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7248 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7249 the data returned by a successful lookup is described in the next section.
7250 First we explain how LDAP queries are coded.
7251
7252
7253 .section "Format of LDAP queries" "SECTforldaque"
7254 .cindex "LDAP" "query format"
7255 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7256 the configuration of a &(redirect)& router one might have this setting:
7257 .code
7258 data = ${lookup ldap \
7259   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7260   c=UK?mailbox?base?}}
7261 .endd
7262 .cindex "LDAP" "with TLS"
7263 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7264 secure (encrypted) LDAP connections. The second of these ensures that an
7265 encrypted TLS connection is used.
7266
7267 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7268 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7269 See the &%ldap_start_tls%& option.
7270
7271 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7272 controlled. Every part of the TLS configuration can be configured by settings in
7273 &_exim.conf_&. Depending on the version of the client libraries installed on
7274 your system, some of the initialization may have required setting options in
7275 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7276 certificates. This revealed a nuance where the current UID that exim was
7277 running as could affect which config files it read. With Exim 4.83, these
7278 methods become optional, only taking effect if not specifically set in
7279 &_exim.conf_&.
7280
7281
7282 .section "LDAP quoting" "SECID68"
7283 .cindex "LDAP" "quoting"
7284 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7285 and the second because the LDAP query is represented as a URL. Furthermore,
7286 within an LDAP query, two different kinds of quoting are required. For this
7287 reason, there are two different LDAP-specific quoting operators.
7288
7289 The &%quote_ldap%& operator is designed for use on strings that are part of
7290 filter specifications. Conceptually, it first does the following conversions on
7291 the string:
7292 .code
7293 *   =>   \2A
7294 (   =>   \28
7295 )   =>   \29
7296 \   =>   \5C
7297 .endd
7298 in accordance with RFC 2254. The resulting string is then quoted according
7299 to the rules for URLs, that is, all non-alphanumeric characters except
7300 .code
7301 ! $ ' - . _ ( ) * +
7302 .endd
7303 are converted to their hex values, preceded by a percent sign. For example:
7304 .code
7305 ${quote_ldap: a(bc)*, a<yz>; }
7306 .endd
7307 yields
7308 .code
7309 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7310 .endd
7311 Removing the URL quoting, this is (with a leading and a trailing space):
7312 .code
7313 a\28bc\29\2A, a<yz>;
7314 .endd
7315 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7316 base DN specifications in queries. Conceptually, it first converts the string
7317 by inserting a backslash in front of any of the following characters:
7318 .code
7319 , + " \ < > ;
7320 .endd
7321 It also inserts a backslash before any leading spaces or # characters, and
7322 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7323 is then quoted according to the rules for URLs. For example:
7324 .code
7325 ${quote_ldap_dn: a(bc)*, a<yz>; }
7326 .endd
7327 yields
7328 .code
7329 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7330 .endd
7331 Removing the URL quoting, this is (with a trailing space):
7332 .code
7333 \ a(bc)*\, a\<yz\>\;\
7334 .endd
7335 There are some further comments about quoting in the section on LDAP
7336 authentication below.
7337
7338
7339 .section "LDAP connections" "SECID69"
7340 .cindex "LDAP" "connections"
7341 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7342 is in use, via a Unix domain socket. The example given above does not specify
7343 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7344 by starting it with
7345 .code
7346 ldap://<hostname>:<port>/...
7347 .endd
7348 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7349 used. When no server is specified in a query, a list of default servers is
7350 taken from the &%ldap_default_servers%& configuration option. This supplies a
7351 colon-separated list of servers which are tried in turn until one successfully
7352 handles a query, or there is a serious error. Successful handling either
7353 returns the requested data, or indicates that it does not exist. Serious errors
7354 are syntactical, or multiple values when only a single value is expected.
7355 Errors which cause the next server to be tried are connection failures, bind
7356 failures, and timeouts.
7357
7358 For each server name in the list, a port number can be given. The standard way
7359 of specifying a host and port is to use a colon separator (RFC 1738). Because
7360 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7361 doubled. For example
7362 .code
7363 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7364 .endd
7365 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7366 to the LDAP library with no server name, and the library's default (normally
7367 the local host) is used.
7368
7369 If you are using the OpenLDAP library, you can connect to an LDAP server using
7370 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7371 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7372 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7373 not available.
7374
7375 For this type of connection, instead of a host name for the server, a pathname
7376 for the socket is required, and the port number is not relevant. The pathname
7377 can be specified either as an item in &%ldap_default_servers%&, or inline in
7378 the query. In the former case, you can have settings such as
7379 .code
7380 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7381 .endd
7382 When the pathname is given in the query, you have to escape the slashes as
7383 &`%2F`& to fit in with the LDAP URL syntax. For example:
7384 .code
7385 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7386 .endd
7387 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7388 a pathname, it uses the Unix domain socket code, even if the query actually
7389 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7390 socket connection. This behaviour means that you can use a setting of
7391 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7392 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7393 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7394 backup host.
7395
7396 If an explicit &`ldapi`& type is given in a query when a host name is
7397 specified, an error is diagnosed. However, if there are more items in
7398 &%ldap_default_servers%&, they are tried. In other words:
7399
7400 .ilist
7401 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7402 interface.
7403 .next
7404 Using &`ldapi`& with a host name causes an error.
7405 .endlist
7406
7407
7408 Using &`ldapi`& with no host or path in the query, and no setting of
7409 &%ldap_default_servers%&, does whatever the library does by default.
7410
7411
7412
7413 .section "LDAP authentication and control information" "SECID70"
7414 .cindex "LDAP" "authentication"
7415 The LDAP URL syntax provides no way of passing authentication and other control
7416 information to the server. To make this possible, the URL in an LDAP query may
7417 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7418 spaces. If a value contains spaces it must be enclosed in double quotes, and
7419 when double quotes are used, backslash is interpreted in the usual way inside
7420 them. The following names are recognized:
7421 .display
7422 &`DEREFERENCE`&  set the dereferencing parameter
7423 &`NETTIME    `&  set a timeout for a network operation
7424 &`USER       `&  set the DN, for authenticating the LDAP bind
7425 &`PASS       `&  set the password, likewise
7426 &`REFERRALS  `&  set the referrals parameter
7427 &`SERVERS    `&  set alternate server list for this query only
7428 &`SIZE       `&  set the limit for the number of entries returned
7429 &`TIME       `&  set the maximum waiting time for a query
7430 .endd
7431 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7432 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7433 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7434 library from trying to follow referrals issued by the LDAP server.
7435
7436 .cindex LDAP timeout
7437 .cindex timeout "LDAP lookup"
7438 The name CONNECT is an obsolete name for NETTIME, retained for
7439 backwards compatibility. This timeout (specified as a number of seconds) is
7440 enforced from the client end for operations that can be carried out over a
7441 network. Specifically, it applies to network connections and calls to the
7442 &'ldap_result()'& function. If the value is greater than zero, it is used if
7443 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7444 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7445 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7446 Netscape SDK; for OpenLDAP no action is taken.
7447
7448 The TIME parameter (also a number of seconds) is passed to the server to
7449 set a server-side limit on the time taken to complete a search.
7450
7451 The SERVERS parameter allows you to specify an alternate list of ldap servers
7452 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7453 default list of ldap servers, and a single lookup can specify a single ldap
7454 server to use.  But when you need to do a lookup with a list of servers that is
7455 different than the default list (maybe different order, maybe a completely
7456 different set of servers), the SERVERS parameter allows you to specify this
7457 alternate list (colon-separated).
7458
7459 Here is an example of an LDAP query in an Exim lookup that uses some of these
7460 values. This is a single line, folded to fit on the page:
7461 .code
7462 ${lookup ldap
7463   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7464   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7465   {$value}fail}
7466 .endd
7467 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7468 any of the auxiliary data. Exim configuration settings that include lookups
7469 which contain password information should be preceded by &"hide"& to prevent
7470 non-admin users from using the &%-bP%& option to see their values.
7471
7472 The auxiliary data items may be given in any order. The default is no
7473 connection timeout (the system timeout is used), no user or password, no limit
7474 on the number of entries returned, and no time limit on queries.
7475
7476 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7477 removes any URL quoting that it may contain before passing it LDAP. Apparently
7478 some libraries do this for themselves, but some do not. Removing the URL
7479 quoting has two advantages:
7480
7481 .ilist
7482 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7483 DNs as with DNs inside actual queries.
7484 .next
7485 It permits spaces inside USER= DNs.
7486 .endlist
7487
7488 For example, a setting such as
7489 .code
7490 USER=cn=${quote_ldap_dn:$1}
7491 .endd
7492 should work even if &$1$& contains spaces.
7493
7494 Expanded data for the PASS= value should be quoted using the &%quote%&
7495 expansion operator, rather than the LDAP quote operators. The only reason this
7496 field needs quoting is to ensure that it conforms to the Exim syntax, which
7497 does not allow unquoted spaces. For example:
7498 .code
7499 PASS=${quote:$3}
7500 .endd
7501 The LDAP authentication mechanism can be used to check passwords as part of
7502 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7503 &<<CHAPexpand>>&.
7504
7505
7506
7507 .section "Format of data returned by LDAP" "SECID71"
7508 .cindex "LDAP" "returned data formats"
7509 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7510 as a sequence of values, for example
7511 .code
7512 cn=manager,o=University of Cambridge,c=UK
7513 .endd
7514 The &(ldap)& lookup type generates an error if more than one entry matches the
7515 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7516 the result between the data from different entries. It is possible for multiple
7517 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7518 you know that whatever values are returned all came from a single entry in the
7519 directory.
7520
7521 In the common case where you specify a single attribute in your LDAP query, the
7522 result is not quoted, and does not contain the attribute name. If the attribute
7523 has multiple values, they are separated by commas. Any comma that is
7524 part of an attribute's value is doubled.
7525
7526 If you specify multiple attributes, the result contains space-separated, quoted
7527 strings, each preceded by the attribute name and an equals sign. Within the
7528 quotes, the quote character, backslash, and newline are escaped with
7529 backslashes, and commas are used to separate multiple values for the attribute.
7530 Any commas in attribute values are doubled
7531 (permitting treatment of the values as a comma-separated list).
7532 Apart from the escaping, the string within quotes takes the same form as the
7533 output when a single attribute is requested. Specifying no attributes is the
7534 same as specifying all of an entry's attributes.
7535
7536 Here are some examples of the output format. The first line of each pair is an
7537 LDAP query, and the second is the data that is returned. The attribute called
7538 &%attr1%& has two values, one of them with an embedded comma, whereas
7539 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7540 (they have SUP &%attr%& in their schema definitions).
7541
7542 .code
7543 ldap:///o=base?attr1?sub?(uid=fred)
7544 value1.1,value1,,2
7545
7546 ldap:///o=base?attr2?sub?(uid=fred)
7547 value two
7548
7549 ldap:///o=base?attr?sub?(uid=fred)
7550 value1.1,value1,,2,value two
7551
7552 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7553 attr1="value1.1,value1,,2" attr2="value two"
7554
7555 ldap:///o=base??sub?(uid=fred)
7556 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7557 .endd
7558 You can
7559 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7560 results of LDAP lookups.
7561 The &%extract%& operator in string expansions can be used to pick out
7562 individual fields from data that consists of &'key'&=&'value'& pairs.
7563 The &%listextract%& operator should be used to pick out individual values
7564 of attributes, even when only a single value is expected.
7565 The doubling of embedded commas allows you to use the returned data as a
7566 comma separated list (using the "<," syntax for changing the input list separator).
7567
7568
7569
7570
7571 .section "More about NIS+" "SECTnisplus"
7572 .cindex "NIS+ lookup type"
7573 .cindex "lookup" "NIS+"
7574 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7575 and field name. If this is given, the result of a successful query is the
7576 contents of the named field; otherwise the result consists of a concatenation
7577 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7578 values containing spaces are quoted. For example, the query
7579 .code
7580 [name=mg1456],passwd.org_dir
7581 .endd
7582 might return the string
7583 .code
7584 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7585 home=/home/mg1456 shell=/bin/bash shadow=""
7586 .endd
7587 (split over two lines here to fit on the page), whereas
7588 .code
7589 [name=mg1456],passwd.org_dir:gcos
7590 .endd
7591 would just return
7592 .code
7593 Martin Guerre
7594 .endd
7595 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7596 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7597 operator is to double any quote characters within the text.
7598
7599
7600
7601 .section "SQL lookups" "SECTsql"
7602 .cindex "SQL lookup types"
7603 .cindex "MySQL" "lookup type"
7604 .cindex "PostgreSQL lookup type"
7605 .cindex "lookup" "MySQL"
7606 .cindex "lookup" "PostgreSQL"
7607 .cindex "Oracle" "lookup type"
7608 .cindex "lookup" "Oracle"
7609 .cindex "InterBase lookup type"
7610 .cindex "lookup" "InterBase"
7611 .cindex "Redis lookup type"
7612 .cindex lookup Redis
7613 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7614 and SQLite
7615 databases. Queries for these databases contain SQL statements, so an example
7616 might be
7617 .code
7618 ${lookup mysql{select mailbox from users where id='userx'}\
7619   {$value}fail}
7620 .endd
7621 If the result of the query contains more than one field, the data for each
7622 field in the row is returned, preceded by its name, so the result of
7623 .code
7624 ${lookup pgsql{select home,name from users where id='userx'}\
7625   {$value}}
7626 .endd
7627 might be
7628 .code
7629 home=/home/userx name="Mister X"
7630 .endd
7631 Empty values and values containing spaces are double quoted, with embedded
7632 quotes escaped by a backslash. If the result of the query contains just one
7633 field, the value is passed back verbatim, without a field name, for example:
7634 .code
7635 Mister X
7636 .endd
7637 If the result of the query yields more than one row, it is all concatenated,
7638 with a newline between the data for each row.
7639
7640
7641 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7642 .cindex "MySQL" "lookup type"
7643 .cindex "PostgreSQL lookup type"
7644 .cindex "lookup" "MySQL"
7645 .cindex "lookup" "PostgreSQL"
7646 .cindex "Oracle" "lookup type"
7647 .cindex "lookup" "Oracle"
7648 .cindex "InterBase lookup type"
7649 .cindex "lookup" "InterBase"
7650 .cindex "Redis lookup type"
7651 .cindex lookup Redis
7652 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7653 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7654 or &%redis_servers%&
7655 option (as appropriate) must be set to a colon-separated list of server
7656 information.
7657 (For MySQL and PostgreSQL, the global option need not be set if all
7658 queries contain their own server information &-- see section
7659 &<<SECTspeserque>>&.)
7660 For all but Redis
7661 each item in the list is a slash-separated list of four
7662 items: host name, database name, user name, and password. In the case of
7663 Oracle, the host name field is used for the &"service name"&, and the database
7664 name field is not used and should be empty. For example:
7665 .code
7666 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7667 .endd
7668 Because password data is sensitive, you should always precede the setting with
7669 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7670 option. Here is an example where two MySQL servers are listed:
7671 .code
7672 hide mysql_servers = localhost/users/root/secret:\
7673                      otherhost/users/root/othersecret
7674 .endd
7675 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7676 because this is a colon-separated list, the colon has to be doubled. For each
7677 query, these parameter groups are tried in order until a connection is made and
7678 a query is successfully processed. The result of a query may be that no data is
7679 found, but that is still a successful query. In other words, the list of
7680 servers provides a backup facility, not a list of different places to look.
7681
7682 For Redis the global option need not be specified if all queries contain their
7683 own server information &-- see section &<<SECTspeserque>>&.
7684 If specified, the option must be set to a colon-separated list of server
7685 information.
7686 Each item in the list is a slash-separated list of three items:
7687 host, database number, and password.
7688 .olist
7689 The host is required and may be either an IPv4 address and optional
7690 port number (separated by a colon, which needs doubling due to the
7691 higher-level list), or a Unix socket pathname enclosed in parentheses
7692 .next
7693 The database number is optional; if present that number is selected in the backend
7694 .next
7695 The password is optional; if present it is used to authenticate to the backend
7696 .endlist
7697
7698 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7699 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7700 respectively, and the characters single-quote, double-quote, and backslash
7701 itself are escaped with backslashes.
7702
7703 The &%quote_redis%& expansion operator
7704 escapes whitespace and backslash characters with a backslash.
7705
7706 .section "Specifying the server in the query" "SECTspeserque"
7707 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7708 it is possible to specify a list of servers with an individual query. This is
7709 done by starting the query with
7710 .display
7711 &`servers=`&&'server1:server2:server3:...'&&`;`&
7712 .endd
7713 Each item in the list may take one of two forms:
7714 .olist
7715 If it contains no slashes it is assumed to be just a host name. The appropriate
7716 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7717 of the same name, and the remaining parameters (database, user, password) are
7718 taken from there.
7719 .next
7720 If it contains any slashes, it is taken as a complete parameter set.
7721 .endlist
7722 The list of servers is used in exactly the same way as the global list.
7723 Once a connection to a server has happened and a query has been
7724 successfully executed, processing of the lookup ceases.
7725
7726 This feature is intended for use in master/slave situations where updates
7727 are occurring and you want to update the master rather than a slave. If the
7728 master is in the list as a backup for reading, you might have a global setting
7729 like this:
7730 .code
7731 mysql_servers = slave1/db/name/pw:\
7732                 slave2/db/name/pw:\
7733                 master/db/name/pw
7734 .endd
7735 In an updating lookup, you could then write:
7736 .code
7737 ${lookup mysql{servers=master; UPDATE ...} }
7738 .endd
7739 That query would then be sent only to the master server. If, on the other hand,
7740 the master is not to be used for reading, and so is not present in the global
7741 option, you can still update it by a query of this form:
7742 .code
7743 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7744 .endd
7745
7746
7747 .section "Special MySQL features" "SECID73"
7748 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7749 causes a connection to the server on the local host by means of a Unix domain
7750 socket. An alternate socket can be specified in parentheses.
7751 An option group name for MySQL option files can be specified in square brackets;
7752 the default value is &"exim"&.
7753 The full syntax of each item in &%mysql_servers%& is:
7754 .display
7755 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7756   <&'database'&>/<&'user'&>/<&'password'&>
7757 .endd
7758 Any of the four sub-parts of the first field can be omitted. For normal use on
7759 the local host it can be left blank or set to just &"localhost"&.
7760
7761 No database need be supplied &-- but if it is absent here, it must be given in
7762 the queries.
7763
7764 If a MySQL query is issued that does not request any data (an insert, update,
7765 or delete command), the result of the lookup is the number of rows affected.
7766
7767 &*Warning*&: This can be misleading. If an update does not actually change
7768 anything (for example, setting a field to the value it already has), the result
7769 is zero because no rows are affected.
7770
7771
7772 .section "Special PostgreSQL features" "SECID74"
7773 PostgreSQL lookups can also use Unix domain socket connections to the database.
7774 This is usually faster and costs less CPU time than a TCP/IP connection.
7775 However it can be used only if the mail server runs on the same machine as the
7776 database server. A configuration line for PostgreSQL via Unix domain sockets
7777 looks like this:
7778 .code
7779 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7780 .endd
7781 In other words, instead of supplying a host name, a path to the socket is
7782 given. The path name is enclosed in parentheses so that its slashes aren't
7783 visually confused with the delimiters for the other server parameters.
7784
7785 If a PostgreSQL query is issued that does not request any data (an insert,
7786 update, or delete command), the result of the lookup is the number of rows
7787 affected.
7788
7789 .section "More about SQLite" "SECTsqlite"
7790 .cindex "lookup" "SQLite"
7791 .cindex "sqlite lookup type"
7792 SQLite is different to the other SQL lookups because a file name is required in
7793 addition to the SQL query. An SQLite database is a single file, and there is no
7794 daemon as in the other SQL databases. The interface to Exim requires the name
7795 of the file, as an absolute path, to be given at the start of the query. It is
7796 separated from the query by white space. This means that the path name cannot
7797 contain white space. Here is a lookup expansion example:
7798 .code
7799 ${lookup sqlite {/some/thing/sqlitedb \
7800   select name from aliases where id='userx';}}
7801 .endd
7802 In a list, the syntax is similar. For example:
7803 .code
7804 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7805    select * from relays where ip='$sender_host_address';
7806 .endd
7807 The only character affected by the &%quote_sqlite%& operator is a single
7808 quote, which it doubles.
7809
7810 .cindex timeout SQLite
7811 .cindex sqlite "lookup timeout"
7812 The SQLite library handles multiple simultaneous accesses to the database
7813 internally. Multiple readers are permitted, but only one process can
7814 update at once. Attempts to access the database while it is being updated
7815 are rejected after a timeout period, during which the SQLite library
7816 waits for the lock to be released. In Exim, the default timeout is set
7817 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7818 option.
7819
7820 .section "More about Redis" "SECTredis"
7821 .cindex "lookup" "Redis"
7822 .cindex "redis lookup type"
7823 Redis is a non-SQL database. Commands are simple get and set.
7824 Examples:
7825 .code
7826 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
7827 ${lookup redis{get keyname}}
7828 .endd
7829
7830 .ecindex IIDfidalo1
7831 .ecindex IIDfidalo2
7832
7833
7834 . ////////////////////////////////////////////////////////////////////////////
7835 . ////////////////////////////////////////////////////////////////////////////
7836
7837 .chapter "Domain, host, address, and local part lists" &&&
7838          "CHAPdomhosaddlists" &&&
7839          "Domain, host, and address lists"
7840 .scindex IIDdohoadli "lists of domains; hosts; etc."
7841 A number of Exim configuration options contain lists of domains, hosts,
7842 email addresses, or local parts. For example, the &%hold_domains%& option
7843 contains a list of domains whose delivery is currently suspended. These lists
7844 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7845 arguments to expansion conditions such as &%match_domain%&.
7846
7847 Each item in one of these lists is a pattern to be matched against a domain,
7848 host, email address, or local part, respectively. In the sections below, the
7849 different types of pattern for each case are described, but first we cover some
7850 general facilities that apply to all four kinds of list.
7851
7852 Note that other parts of Exim use a &'string list'& which does not
7853 support all the complexity available in
7854 domain, host, address and local part lists.
7855
7856
7857
7858 .section "Expansion of lists" "SECTlistexpand"
7859 .cindex "expansion" "of lists"
7860 Each list is expanded as a single string before it is used.
7861
7862 &'Exception: the router headers_remove option, where list-item
7863 splitting is done before string-expansion.'&
7864
7865 The result of
7866 expansion must be a list, possibly containing empty items, which is split up
7867 into separate items for matching. By default, colon is the separator character,
7868 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7869 &<<SECTempitelis>>& for details of the list syntax; the second of these
7870 discusses the way to specify empty list items.
7871
7872
7873 If the string expansion is forced to fail, Exim behaves as if the item it is
7874 testing (domain, host, address, or local part) is not in the list. Other
7875 expansion failures cause temporary errors.
7876
7877 If an item in a list is a regular expression, backslashes, dollars and possibly
7878 other special characters in the expression must be protected against
7879 misinterpretation by the string expander. The easiest way to do this is to use
7880 the &`\N`& expansion feature to indicate that the contents of the regular
7881 expression should not be expanded. For example, in an ACL you might have:
7882 .code
7883 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7884                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7885 .endd
7886 The first item is a regular expression that is protected from expansion by
7887 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7888 senders based on the receiving domain.
7889
7890
7891
7892
7893 .section "Negated items in lists" "SECID76"
7894 .cindex "list" "negation"
7895 .cindex "negation" "in lists"
7896 Items in a list may be positive or negative. Negative items are indicated by a
7897 leading exclamation mark, which may be followed by optional white space. A list
7898 defines a set of items (domains, etc). When Exim processes one of these lists,
7899 it is trying to find out whether a domain, host, address, or local part
7900 (respectively) is in the set that is defined by the list. It works like this:
7901
7902 The list is scanned from left to right. If a positive item is matched, the
7903 subject that is being checked is in the set; if a negative item is matched, the
7904 subject is not in the set. If the end of the list is reached without the
7905 subject having matched any of the patterns, it is in the set if the last item
7906 was a negative one, but not if it was a positive one. For example, the list in
7907 .code
7908 domainlist relay_to_domains = !a.b.c : *.b.c
7909 .endd
7910 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7911 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7912 list is positive. However, if the setting were
7913 .code
7914 domainlist relay_to_domains = !a.b.c
7915 .endd
7916 then all domains other than &'a.b.c'& would match because the last item in the
7917 list is negative. In other words, a list that ends with a negative item behaves
7918 as if it had an extra item &`:*`& on the end.
7919
7920 Another way of thinking about positive and negative items in lists is to read
7921 the connector as &"or"& after a positive item and as &"and"& after a negative
7922 item.
7923
7924
7925
7926 .section "File names in lists" "SECTfilnamlis"
7927 .cindex "list" "file name in"
7928 If an item in a domain, host, address, or local part list is an absolute file
7929 name (beginning with a slash character), each line of the file is read and
7930 processed as if it were an independent item in the list, except that further
7931 file names are not allowed,
7932 and no expansion of the data from the file takes place.
7933 Empty lines in the file are ignored, and the file may also contain comment
7934 lines:
7935
7936 .ilist
7937 For domain and host lists, if a # character appears anywhere in a line of the
7938 file, it and all following characters are ignored.
7939 .next
7940 Because local parts may legitimately contain # characters, a comment in an
7941 address list or local part list file is recognized only if # is preceded by
7942 white space or the start of the line. For example:
7943 .code
7944 not#comment@x.y.z   # but this is a comment
7945 .endd
7946 .endlist
7947
7948 Putting a file name in a list has the same effect as inserting each line of the
7949 file as an item in the list (blank lines and comments excepted). However, there
7950 is one important difference: the file is read each time the list is processed,
7951 so if its contents vary over time, Exim's behaviour changes.
7952
7953 If a file name is preceded by an exclamation mark, the sense of any match
7954 within the file is inverted. For example, if
7955 .code
7956 hold_domains = !/etc/nohold-domains
7957 .endd
7958 and the file contains the lines
7959 .code
7960 !a.b.c
7961 *.b.c
7962 .endd
7963 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7964 any domain matching &`*.b.c`& is not.
7965
7966
7967
7968 .section "An lsearch file is not an out-of-line list" "SECID77"
7969 As will be described in the sections that follow, lookups can be used in lists
7970 to provide indexed methods of checking list membership. There has been some
7971 confusion about the way &(lsearch)& lookups work in lists. Because
7972 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7973 sometimes thought that it is allowed to contain wild cards and other kinds of
7974 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7975 always fixed strings, just as for any other single-key lookup type.
7976
7977 If you want to use a file to contain wild-card patterns that form part of a
7978 list, just give the file name on its own, without a search type, as described
7979 in the previous section. You could also use the &(wildlsearch)& or
7980 &(nwildlsearch)&, but there is no advantage in doing this.
7981
7982
7983
7984
7985 .section "Named lists" "SECTnamedlists"
7986 .cindex "named lists"
7987 .cindex "list" "named"
7988 A list of domains, hosts, email addresses, or local parts can be given a name
7989 which is then used to refer to the list elsewhere in the configuration. This is
7990 particularly convenient if the same list is required in several different
7991 places. It also allows lists to be given meaningful names, which can improve
7992 the readability of the configuration. For example, it is conventional to define
7993 a domain list called &'local_domains'& for all the domains that are handled
7994 locally on a host, using a configuration line such as
7995 .code
7996 domainlist local_domains = localhost:my.dom.example
7997 .endd
7998 Named lists are referenced by giving their name preceded by a plus sign, so,
7999 for example, a router that is intended to handle local domains would be
8000 configured with the line
8001 .code
8002 domains = +local_domains
8003 .endd
8004 The first router in a configuration is often one that handles all domains
8005 except the local ones, using a configuration with a negated item like this:
8006 .code
8007 dnslookup:
8008   driver = dnslookup
8009   domains = ! +local_domains
8010   transport = remote_smtp
8011   no_more
8012 .endd
8013 The four kinds of named list are created by configuration lines starting with
8014 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8015 respectively. Then there follows the name that you are defining, followed by an
8016 equals sign and the list itself. For example:
8017 .code
8018 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8019 addresslist bad_senders = cdb;/etc/badsenders
8020 .endd
8021 A named list may refer to other named lists:
8022 .code
8023 domainlist  dom1 = first.example : second.example
8024 domainlist  dom2 = +dom1 : third.example
8025 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8026 .endd
8027 &*Warning*&: If the last item in a referenced list is a negative one, the
8028 effect may not be what you intended, because the negation does not propagate
8029 out to the higher level. For example, consider:
8030 .code
8031 domainlist  dom1 = !a.b
8032 domainlist  dom2 = +dom1 : *.b
8033 .endd
8034 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8035 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8036 means it matches the second list as well. The effect is not the same as
8037 .code
8038 domainlist  dom2 = !a.b : *.b
8039 .endd
8040 where &'x.y'& does not match. It's best to avoid negation altogether in
8041 referenced lists if you can.
8042
8043 Named lists may have a performance advantage. When Exim is routing an
8044 address or checking an incoming message, it caches the result of tests on named
8045 lists. So, if you have a setting such as
8046 .code
8047 domains = +local_domains
8048 .endd
8049 on several of your routers
8050 or in several ACL statements,
8051 the actual test is done only for the first one. However, the caching works only
8052 if there are no expansions within the list itself or any sublists that it
8053 references. In other words, caching happens only for lists that are known to be
8054 the same each time they are referenced.
8055
8056 By default, there may be up to 16 named lists of each type. This limit can be
8057 extended by changing a compile-time variable. The use of domain and host lists
8058 is recommended for concepts such as local domains, relay domains, and relay
8059 hosts. The default configuration is set up like this.
8060
8061
8062
8063 .section "Named lists compared with macros" "SECID78"
8064 .cindex "list" "named compared with macro"
8065 .cindex "macro" "compared with named list"
8066 At first sight, named lists might seem to be no different from macros in the
8067 configuration file. However, macros are just textual substitutions. If you
8068 write
8069 .code
8070 ALIST = host1 : host2
8071 auth_advertise_hosts = !ALIST
8072 .endd
8073 it probably won't do what you want, because that is exactly the same as
8074 .code
8075 auth_advertise_hosts = !host1 : host2
8076 .endd
8077 Notice that the second host name is not negated. However, if you use a host
8078 list, and write
8079 .code
8080 hostlist alist = host1 : host2
8081 auth_advertise_hosts = ! +alist
8082 .endd
8083 the negation applies to the whole list, and so that is equivalent to
8084 .code
8085 auth_advertise_hosts = !host1 : !host2
8086 .endd
8087
8088
8089 .section "Named list caching" "SECID79"
8090 .cindex "list" "caching of named"
8091 .cindex "caching" "named lists"
8092 While processing a message, Exim caches the result of checking a named list if
8093 it is sure that the list is the same each time. In practice, this means that
8094 the cache operates only if the list contains no $ characters, which guarantees
8095 that it will not change when it is expanded. Sometimes, however, you may have
8096 an expanded list that you know will be the same each time within a given
8097 message. For example:
8098 .code
8099 domainlist special_domains = \
8100            ${lookup{$sender_host_address}cdb{/some/file}}
8101 .endd
8102 This provides a list of domains that depends only on the sending host's IP
8103 address. If this domain list is referenced a number of times (for example,
8104 in several ACL lines, or in several routers) the result of the check is not
8105 cached by default, because Exim does not know that it is going to be the
8106 same list each time.
8107
8108 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8109 cache the result anyway. For example:
8110 .code
8111 domainlist_cache special_domains = ${lookup{...
8112 .endd
8113 If you do this, you should be absolutely sure that caching is going to do
8114 the right thing in all cases. When in doubt, leave it out.
8115
8116
8117
8118 .section "Domain lists" "SECTdomainlist"
8119 .cindex "domain list" "patterns for"
8120 .cindex "list" "domain list"
8121 Domain lists contain patterns that are to be matched against a mail domain.
8122 The following types of item may appear in domain lists:
8123
8124 .ilist
8125 .cindex "primary host name"
8126 .cindex "host name" "matched in domain list"
8127 .oindex "&%primary_hostname%&"
8128 .cindex "domain list" "matching primary host name"
8129 .cindex "@ in a domain list"
8130 If a pattern consists of a single @ character, it matches the local host name,
8131 as set by the &%primary_hostname%& option (or defaulted). This makes it
8132 possible to use the same configuration file on several different hosts that
8133 differ only in their names.
8134 .next
8135 .cindex "@[] in a domain list"
8136 .cindex "domain list" "matching local IP interfaces"
8137 .cindex "domain literal"
8138 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8139 in square brackets (as in an email address that contains a domain literal), but
8140 only if that IP address is recognized as local for email routing purposes. The
8141 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8142 control which of a host's several IP addresses are treated as local.
8143 In today's Internet, the use of domain literals is controversial.
8144 .next
8145 .cindex "@mx_any"
8146 .cindex "@mx_primary"
8147 .cindex "@mx_secondary"
8148 .cindex "domain list" "matching MX pointers to local host"
8149 If a pattern consists of the string &`@mx_any`& it matches any domain that
8150 has an MX record pointing to the local host or to any host that is listed in
8151 .oindex "&%hosts_treat_as_local%&"
8152 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8153 are similar, except that the first matches only when a primary MX target is the
8154 local host, and the second only when no primary MX target is the local host,
8155 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8156 preference value &-- there may of course be more than one of them.
8157
8158 The MX lookup that takes place when matching a pattern of this type is
8159 performed with the resolver options for widening names turned off. Thus, for
8160 example, a single-component domain will &'not'& be expanded by adding the
8161 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8162 options of the &(dnslookup)& router for a discussion of domain widening.
8163
8164 Sometimes you may want to ignore certain IP addresses when using one of these
8165 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8166 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8167 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8168 on a router). For example:
8169 .code
8170 domains = @mx_any/ignore=127.0.0.1
8171 .endd
8172 This example matches any domain that has an MX record pointing to one of
8173 the local host's IP addresses other than 127.0.0.1.
8174
8175 The list of IP addresses is in fact processed by the same code that processes
8176 host lists, so it may contain CIDR-coded network specifications and it may also
8177 contain negative items.
8178
8179 Because the list of IP addresses is a sublist within a domain list, you have to
8180 be careful about delimiters if there is more than one address. Like any other
8181 list, the default delimiter can be changed. Thus, you might have:
8182 .code
8183 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8184           an.other.domain : ...
8185 .endd
8186 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8187 involved, it is easiest to change the delimiter for the main list as well:
8188 .code
8189 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8190           an.other.domain ? ...
8191 .endd
8192 .next
8193 .cindex "asterisk" "in domain list"
8194 .cindex "domain list" "asterisk in"
8195 .cindex "domain list" "matching &""ends with""&"
8196 If a pattern starts with an asterisk, the remaining characters of the pattern
8197 are compared with the terminating characters of the domain. The use of &"*"& in
8198 domain lists differs from its use in partial matching lookups. In a domain
8199 list, the character following the asterisk need not be a dot, whereas partial
8200 matching works only in terms of dot-separated components. For example, a domain
8201 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8202 &'cipher.key.ex'&.
8203
8204 .next
8205 .cindex "regular expressions" "in domain list"
8206 .cindex "domain list" "matching regular expression"
8207 If a pattern starts with a circumflex character, it is treated as a regular
8208 expression, and matched against the domain using a regular expression matching
8209 function. The circumflex is treated as part of the regular expression.
8210 Email domains are case-independent, so this regular expression match is by
8211 default case-independent, but you can make it case-dependent by starting it
8212 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8213 are given in chapter &<<CHAPregexp>>&.
8214
8215 &*Warning*&: Because domain lists are expanded before being processed, you
8216 must escape any backslash and dollar characters in the regular expression, or
8217 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8218 it is not to be expanded (unless you really do want to build a regular
8219 expression by expansion, of course).
8220 .next
8221 .cindex "lookup" "in domain list"
8222 .cindex "domain list" "matching by lookup"
8223 If a pattern starts with the name of a single-key lookup type followed by a
8224 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8225 must be a file name in a suitable format for the lookup type. For example, for
8226 &"cdb;"& it must be an absolute path:
8227 .code
8228 domains = cdb;/etc/mail/local_domains.cdb
8229 .endd
8230 The appropriate type of lookup is done on the file using the domain name as the
8231 key. In most cases, the data that is looked up is not used; Exim is interested
8232 only in whether or not the key is present in the file. However, when a lookup
8233 is used for the &%domains%& option on a router
8234 or a &%domains%& condition in an ACL statement, the data is preserved in the
8235 &$domain_data$& variable and can be referred to in other router options or
8236 other statements in the same ACL.
8237
8238 .next
8239 Any of the single-key lookup type names may be preceded by
8240 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8241 .code
8242 domains = partial-dbm;/partial/domains
8243 .endd
8244 This causes partial matching logic to be invoked; a description of how this
8245 works is given in section &<<SECTpartiallookup>>&.
8246
8247 .next
8248 .cindex "asterisk" "in lookup type"
8249 Any of the single-key lookup types may be followed by an asterisk. This causes
8250 a default lookup for a key consisting of a single asterisk to be done if the
8251 original lookup fails. This is not a useful feature when using a domain list to
8252 select particular domains (because any domain would match), but it might have
8253 value if the result of the lookup is being used via the &$domain_data$&
8254 expansion variable.
8255 .next
8256 If the pattern starts with the name of a query-style lookup type followed by a
8257 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8258 pattern must be an appropriate query for the lookup type, as described in
8259 chapter &<<CHAPfdlookup>>&. For example:
8260 .code
8261 hold_domains = mysql;select domain from holdlist \
8262   where domain = '${quote_mysql:$domain}';
8263 .endd
8264 In most cases, the data that is looked up is not used (so for an SQL query, for
8265 example, it doesn't matter what field you select). Exim is interested only in
8266 whether or not the query succeeds. However, when a lookup is used for the
8267 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8268 variable and can be referred to in other options.
8269 .next
8270 .cindex "domain list" "matching literal domain name"
8271 If none of the above cases apply, a caseless textual comparison is made
8272 between the pattern and the domain.
8273 .endlist
8274
8275 Here is an example that uses several different kinds of pattern:
8276 .code
8277 domainlist funny_domains = \
8278   @ : \
8279   lib.unseen.edu : \
8280   *.foundation.fict.example : \
8281   \N^[1-2]\d{3}\.fict\.example$\N : \
8282   partial-dbm;/opt/data/penguin/book : \
8283   nis;domains.byname : \
8284   nisplus;[name=$domain,status=local],domains.org_dir
8285 .endd
8286 There are obvious processing trade-offs among the various matching modes. Using
8287 an asterisk is faster than a regular expression, and listing a few names
8288 explicitly probably is too. The use of a file or database lookup is expensive,
8289 but may be the only option if hundreds of names are required. Because the
8290 patterns are tested in order, it makes sense to put the most commonly matched
8291 patterns earlier.
8292
8293
8294
8295 .section "Host lists" "SECThostlist"
8296 .cindex "host list" "patterns in"
8297 .cindex "list" "host list"
8298 Host lists are used to control what remote hosts are allowed to do. For
8299 example, some hosts may be allowed to use the local host as a relay, and some
8300 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8301 two different ways, by name or by IP address. In a host list, some types of
8302 pattern are matched to a host name, and some are matched to an IP address.
8303 You need to be particularly careful with this when single-key lookups are
8304 involved, to ensure that the right value is being used as the key.
8305
8306
8307 .section "Special host list patterns" "SECID80"
8308 .cindex "empty item in hosts list"
8309 .cindex "host list" "empty string in"
8310 If a host list item is the empty string, it matches only when no remote host is
8311 involved. This is the case when a message is being received from a local
8312 process using SMTP on the standard input, that is, when a TCP/IP connection is
8313 not used.
8314
8315 .cindex "asterisk" "in host list"
8316 The special pattern &"*"& in a host list matches any host or no host. Neither
8317 the IP address nor the name is actually inspected.
8318
8319
8320
8321 .section "Host list patterns that match by IP address" "SECThoslispatip"
8322 .cindex "host list" "matching IP addresses"
8323 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8324 the incoming address actually appears in the IPv6 host as
8325 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8326 list, it is converted into a traditional IPv4 address first. (Not all operating
8327 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8328 concerns.)
8329
8330 The following types of pattern in a host list check the remote host by
8331 inspecting its IP address:
8332
8333 .ilist
8334 If the pattern is a plain domain name (not a regular expression, not starting
8335 with *, not a lookup of any kind), Exim calls the operating system function
8336 to find the associated IP address(es). Exim uses the newer
8337 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8338 This typically causes a forward DNS lookup of the name. The result is compared
8339 with the IP address of the subject host.
8340
8341 If there is a temporary problem (such as a DNS timeout) with the host name
8342 lookup, a temporary error occurs. For example, if the list is being used in an
8343 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8344 temporary SMTP error code. If no IP address can be found for the host name,
8345 what happens is described in section &<<SECTbehipnot>>& below.
8346
8347 .next
8348 .cindex "@ in a host list"
8349 If the pattern is &"@"&, the primary host name is substituted and used as a
8350 domain name, as just described.
8351
8352 .next
8353 If the pattern is an IP address, it is matched against the IP address of the
8354 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8355 IPv6 addresses can be given in colon-separated format, but the colons have to
8356 be doubled so as not to be taken as item separators when the default list
8357 separator is used. IPv6 addresses are recognized even when Exim is compiled
8358 without IPv6 support. This means that if they appear in a host list on an
8359 IPv4-only host, Exim will not treat them as host names. They are just addresses
8360 that can never match a client host.
8361
8362 .next
8363 .cindex "@[] in a host list"
8364 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8365 the local host. For example, if the local host is an IPv4 host with one
8366 interface address 10.45.23.56, these two ACL statements have the same effect:
8367 .code
8368 accept hosts = 127.0.0.1 : 10.45.23.56
8369 accept hosts = @[]
8370 .endd
8371 .next
8372 .cindex "CIDR notation"
8373 If the pattern is an IP address followed by a slash and a mask length (for
8374 example 10.11.42.0/24), it is matched against the IP address of the subject
8375 host under the given mask. This allows, an entire network of hosts to be
8376 included (or excluded) by a single item. The mask uses CIDR notation; it
8377 specifies the number of address bits that must match, starting from the most
8378 significant end of the address.
8379
8380 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8381 of a range of addresses. It is the number of bits in the network portion of the
8382 address. The above example specifies a 24-bit netmask, so it matches all 256
8383 addresses in the 10.11.42.0 network. An item such as
8384 .code
8385 192.168.23.236/31
8386 .endd
8387 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8388 32 for an IPv4 address is the same as no mask at all; just a single address
8389 matches.
8390
8391 Here is another example which shows an IPv4 and an IPv6 network:
8392 .code
8393 recipient_unqualified_hosts = 192.168.0.0/16: \
8394                               3ffe::ffff::836f::::/48
8395 .endd
8396 The doubling of list separator characters applies only when these items
8397 appear inline in a host list. It is not required when indirecting via a file.
8398 For example:
8399 .code
8400 recipient_unqualified_hosts = /opt/exim/unqualnets
8401 .endd
8402 could make use of a file containing
8403 .code
8404 172.16.0.0/12
8405 3ffe:ffff:836f::/48
8406 .endd
8407 to have exactly the same effect as the previous example. When listing IPv6
8408 addresses inline, it is usually more convenient to use the facility for
8409 changing separator characters. This list contains the same two networks:
8410 .code
8411 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8412                                  3ffe:ffff:836f::/48
8413 .endd
8414 The separator is changed to semicolon by the leading &"<;"& at the start of the
8415 list.
8416 .endlist
8417
8418
8419
8420 .section "Host list patterns for single-key lookups by host address" &&&
8421          "SECThoslispatsikey"
8422 .cindex "host list" "lookup of IP address"
8423 When a host is to be identified by a single-key lookup of its complete IP
8424 address, the pattern takes this form:
8425 .display
8426 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8427 .endd
8428 For example:
8429 .code
8430 hosts_lookup = net-cdb;/hosts-by-ip.db
8431 .endd
8432 The text form of the IP address of the subject host is used as the lookup key.
8433 IPv6 addresses are converted to an unabbreviated form, using lower case
8434 letters, with dots as separators because colon is the key terminator in
8435 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8436 quoting the keys, but this is a facility that was added later.] The data
8437 returned by the lookup is not used.
8438
8439 .cindex "IP address" "masking"
8440 .cindex "host list" "masked IP address"
8441 Single-key lookups can also be performed using masked IP addresses, using
8442 patterns of this form:
8443 .display
8444 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8445 .endd
8446 For example:
8447 .code
8448 net24-dbm;/networks.db
8449 .endd
8450 The IP address of the subject host is masked using <&'number'&> as the mask
8451 length. A textual string is constructed from the masked value, followed by the
8452 mask, and this is used as the lookup key. For example, if the host's IP address
8453 is 192.168.34.6, the key that is looked up for the above example is
8454 &"192.168.34.0/24"&.
8455
8456 When an IPv6 address is converted to a string, dots are normally used instead
8457 of colons, so that keys in &(lsearch)& files need not contain colons (which
8458 terminate &(lsearch)& keys). This was implemented some time before the ability
8459 to quote keys was made available in &(lsearch)& files. However, the more
8460 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8461 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8462 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8463 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8464 addresses are always used.
8465
8466 Ideally, it would be nice to tidy up this anomalous situation by changing to
8467 colons in all cases, given that quoting is now available for &(lsearch)&.
8468 However, this would be an incompatible change that might break some existing
8469 configurations.
8470
8471 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8472 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8473 the former case the key strings include the mask value, whereas in the latter
8474 case the IP address is used on its own.
8475
8476
8477
8478 .section "Host list patterns that match by host name" "SECThoslispatnam"
8479 .cindex "host" "lookup failures"
8480 .cindex "unknown host name"
8481 .cindex "host list" "matching host name"
8482 There are several types of pattern that require Exim to know the name of the
8483 remote host. These are either wildcard patterns or lookups by name. (If a
8484 complete hostname is given without any wildcarding, it is used to find an IP
8485 address to match against, as described in section &<<SECThoslispatip>>&
8486 above.)
8487
8488 If the remote host name is not already known when Exim encounters one of these
8489 patterns, it has to be found from the IP address.
8490 Although many sites on the Internet are conscientious about maintaining reverse
8491 DNS data for their hosts, there are also many that do not do this.
8492 Consequently, a name cannot always be found, and this may lead to unwanted
8493 effects. Take care when configuring host lists with wildcarded name patterns.
8494 Consider what will happen if a name cannot be found.
8495
8496 Because of the problems of determining host names from IP addresses, matching
8497 against host names is not as common as matching against IP addresses.
8498
8499 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8500 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8501 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8502 are done can be changed by setting the &%host_lookup_order%& option. For
8503 security, once Exim has found one or more names, it looks up the IP addresses
8504 for these names and compares them with the IP address that it started with.
8505 Only those names whose IP addresses match are accepted. Any other names are
8506 discarded. If no names are left, Exim behaves as if the host name cannot be
8507 found. In the most common case there is only one name and one IP address.
8508
8509 There are some options that control what happens if a host name cannot be
8510 found. These are described in section &<<SECTbehipnot>>& below.
8511
8512 .cindex "host" "alias for"
8513 .cindex "alias for host"
8514 As a result of aliasing, hosts may have more than one name. When processing any
8515 of the following types of pattern, all the host's names are checked:
8516
8517 .ilist
8518 .cindex "asterisk" "in host list"
8519 If a pattern starts with &"*"& the remainder of the item must match the end of
8520 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8521 &'.b.c'&. This special simple form is provided because this is a very common
8522 requirement. Other kinds of wildcarding require the use of a regular
8523 expression.
8524 .next
8525 .cindex "regular expressions" "in host list"
8526 .cindex "host list" "regular expression in"
8527 If the item starts with &"^"& it is taken to be a regular expression which is
8528 matched against the host name. Host names are case-independent, so this regular
8529 expression match is by default case-independent, but you can make it
8530 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8531 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8532 example,
8533 .code
8534 ^(a|b)\.c\.d$
8535 .endd
8536 is a regular expression that matches either of the two hosts &'a.c.d'& or
8537 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8538 that backslash and dollar characters are not misinterpreted as part of the
8539 string expansion. The simplest way to do this is to use &`\N`& to mark that
8540 part of the string as non-expandable. For example:
8541 .code
8542 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8543 .endd
8544 &*Warning*&: If you want to match a complete host name, you must include the
8545 &`$`& terminating metacharacter in the regular expression, as in the above
8546 example. Without it, a match at the start of the host name is all that is
8547 required.
8548 .endlist
8549
8550
8551
8552
8553 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8554 .cindex "host" "lookup failures, permanent"
8555 While processing a host list, Exim may need to look up an IP address from a
8556 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8557 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8558 behaviour when it fails to find the information it is seeking is the same.
8559
8560 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8561 apply to temporary DNS errors, whose handling is described in the next section.
8562
8563 .cindex "&`+include_unknown`&"
8564 .cindex "&`+ignore_unknown`&"
8565 Exim parses a host list from left to right. If it encounters a permanent
8566 lookup failure in any item in the host list before it has found a match,
8567 Exim treats it as a failure and the default behavior is as if the host
8568 does not match the list. This may not always be what you want to happen.
8569 To change Exim's behaviour, the special items &`+include_unknown`& or
8570 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8571 not recognized in an indirected file).
8572
8573 .ilist
8574 If any item that follows &`+include_unknown`& requires information that
8575 cannot found, Exim behaves as if the host does match the list. For example,
8576 .code
8577 host_reject_connection = +include_unknown:*.enemy.ex
8578 .endd
8579 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8580 any hosts whose name it cannot find.
8581
8582 .next
8583 If any item that follows &`+ignore_unknown`& requires information that cannot
8584 be found, Exim ignores that item and proceeds to the rest of the list. For
8585 example:
8586 .code
8587 accept hosts = +ignore_unknown : friend.example : \
8588                192.168.4.5
8589 .endd
8590 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8591 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8592 name can be found for 192.168.4.5, it is rejected.
8593 .endlist
8594
8595 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8596 list. The effect of each one lasts until the next, or until the end of the
8597 list.
8598
8599 .section "Mixing wildcarded host names and addresses in host lists" &&&
8600          "SECTmixwilhos"
8601 .cindex "host list" "mixing names and addresses in"
8602
8603 This section explains the host/ip processing logic with the same concepts
8604 as the previous section, but specifically addresses what happens when a
8605 wildcarded hostname is one of the items in the hostlist.
8606
8607 .ilist
8608 If you have name lookups or wildcarded host names and
8609 IP addresses in the same host list, you should normally put the IP
8610 addresses first. For example, in an ACL you could have:
8611 .code
8612 accept hosts = 10.9.8.7 : *.friend.example
8613 .endd
8614 The reason you normally would order it this way lies in the
8615 left-to-right way that Exim processes lists.  It can test IP addresses
8616 without doing any DNS lookups, but when it reaches an item that requires
8617 a host name, it fails if it cannot find a host name to compare with the
8618 pattern. If the above list is given in the opposite order, the
8619 &%accept%& statement fails for a host whose name cannot be found, even
8620 if its IP address is 10.9.8.7.
8621
8622 .next
8623 If you really do want to do the name check first, and still recognize the IP
8624 address, you can rewrite the ACL like this:
8625 .code
8626 accept hosts = *.friend.example
8627 accept hosts = 10.9.8.7
8628 .endd
8629 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8630 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8631 &`+ignore_unknown`&, which was discussed in depth in the first example in
8632 this section.
8633 .endlist
8634
8635
8636 .section "Temporary DNS errors when looking up host information" &&&
8637          "SECTtemdnserr"
8638 .cindex "host" "lookup failures, temporary"
8639 .cindex "&`+include_defer`&"
8640 .cindex "&`+ignore_defer`&"
8641 A temporary DNS lookup failure normally causes a defer action (except when
8642 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8643 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8644 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8645 section. These options should be used with care, probably only in non-critical
8646 host lists such as whitelists.
8647
8648
8649
8650 .section "Host list patterns for single-key lookups by host name" &&&
8651          "SECThoslispatnamsk"
8652 .cindex "unknown host name"
8653 .cindex "host list" "matching host name"
8654 If a pattern is of the form
8655 .display
8656 <&'single-key-search-type'&>;<&'search-data'&>
8657 .endd
8658 for example
8659 .code
8660 dbm;/host/accept/list
8661 .endd
8662 a single-key lookup is performed, using the host name as its key. If the
8663 lookup succeeds, the host matches the item. The actual data that is looked up
8664 is not used.
8665
8666 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8667 keys in the file, not IP addresses. If you want to do lookups based on IP
8668 addresses, you must precede the search type with &"net-"& (see section
8669 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8670 two items in the same list, one doing an address lookup and one doing a name
8671 lookup, both using the same file.
8672
8673
8674
8675 .section "Host list patterns for query-style lookups" "SECID81"
8676 If a pattern is of the form
8677 .display
8678 <&'query-style-search-type'&>;<&'query'&>
8679 .endd
8680 the query is obeyed, and if it succeeds, the host matches the item. The actual
8681 data that is looked up is not used. The variables &$sender_host_address$& and
8682 &$sender_host_name$& can be used in the query. For example:
8683 .code
8684 hosts_lookup = pgsql;\
8685   select ip from hostlist where ip='$sender_host_address'
8686 .endd
8687 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8688 can use the &%sg%& expansion item to change this if you need to. If you want to
8689 use masked IP addresses in database queries, you can use the &%mask%& expansion
8690 operator.
8691
8692 If the query contains a reference to &$sender_host_name$&, Exim automatically
8693 looks up the host name if it has not already done so. (See section
8694 &<<SECThoslispatnam>>& for comments on finding host names.)
8695
8696 Historical note: prior to release 4.30, Exim would always attempt to find a
8697 host name before running the query, unless the search type was preceded by
8698 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8699 still recognized for query-style lookups, but its presence or absence has no
8700 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8701 See section &<<SECThoslispatsikey>>&.)
8702
8703
8704
8705
8706
8707 .section "Address lists" "SECTaddresslist"
8708 .cindex "list" "address list"
8709 .cindex "address list" "empty item"
8710 .cindex "address list" "patterns"
8711 Address lists contain patterns that are matched against mail addresses. There
8712 is one special case to be considered: the sender address of a bounce message is
8713 always empty. You can test for this by providing an empty item in an address
8714 list. For example, you can set up a router to process bounce messages by
8715 using this option setting:
8716 .code
8717 senders = :
8718 .endd
8719 The presence of the colon creates an empty item. If you do not provide any
8720 data, the list is empty and matches nothing. The empty sender can also be
8721 detected by a regular expression that matches an empty string,
8722 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8723
8724 Non-empty items in an address list can be straightforward email addresses. For
8725 example:
8726 .code
8727 senders = jbc@askone.example : hs@anacreon.example
8728 .endd
8729 A certain amount of wildcarding is permitted. If a pattern contains an @
8730 character, but is not a regular expression and does not begin with a
8731 semicolon-terminated lookup type (described below), the local part of the
8732 subject address is compared with the local part of the pattern, which may start
8733 with an asterisk. If the local parts match, the domain is checked in exactly
8734 the same way as for a pattern in a domain list. For example, the domain can be
8735 wildcarded, refer to a named list, or be a lookup:
8736 .code
8737 deny senders = *@*.spamming.site:\
8738                *@+hostile_domains:\
8739                bozo@partial-lsearch;/list/of/dodgy/sites:\
8740                *@dbm;/bad/domains.db
8741 .endd
8742 .cindex "local part" "starting with !"
8743 .cindex "address list" "local part starting with !"
8744 If a local part that begins with an exclamation mark is required, it has to be
8745 specified using a regular expression, because otherwise the exclamation mark is
8746 treated as a sign of negation, as is standard in lists.
8747
8748 If a non-empty pattern that is not a regular expression or a lookup does not
8749 contain an @ character, it is matched against the domain part of the subject
8750 address. The only two formats that are recognized this way are a literal
8751 domain, or a domain pattern that starts with *. In both these cases, the effect
8752 is the same as if &`*@`& preceded the pattern. For example:
8753 .code
8754 deny senders = enemy.domain : *.enemy.domain
8755 .endd
8756
8757 The following kinds of more complicated address list pattern can match any
8758 address, including the empty address that is characteristic of bounce message
8759 senders:
8760
8761 .ilist
8762 .cindex "regular expressions" "in address list"
8763 .cindex "address list" "regular expression in"
8764 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8765 done against the complete address, with the pattern as the regular expression.
8766 You must take care that backslash and dollar characters are not misinterpreted
8767 as part of the string expansion. The simplest way to do this is to use &`\N`&
8768 to mark that part of the string as non-expandable. For example:
8769 .code
8770 deny senders = \N^.*this.*@example\.com$\N : \
8771                \N^\d{8}.+@spamhaus.example$\N : ...
8772 .endd
8773 The &`\N`& sequences are removed by the expansion, so these items do indeed
8774 start with &"^"& by the time they are being interpreted as address patterns.
8775
8776 .next
8777 .cindex "address list" "lookup for complete address"
8778 Complete addresses can be looked up by using a pattern that starts with a
8779 lookup type terminated by a semicolon, followed by the data for the lookup. For
8780 example:
8781 .code
8782 deny senders = cdb;/etc/blocked.senders : \
8783   mysql;select address from blocked where \
8784   address='${quote_mysql:$sender_address}'
8785 .endd
8786 Both query-style and single-key lookup types can be used. For a single-key
8787 lookup type, Exim uses the complete address as the key. However, empty keys are
8788 not supported for single-key lookups, so a match against the empty address
8789 always fails. This restriction does not apply to query-style lookups.
8790
8791 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8792 cannot be used, and is ignored if specified, with an entry being written to the
8793 panic log.
8794 .cindex "*@ with single-key lookup"
8795 However, you can configure lookup defaults, as described in section
8796 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8797 default. For example, with this lookup:
8798 .code
8799 accept senders = lsearch*@;/some/file
8800 .endd
8801 the file could contains lines like this:
8802 .code
8803 user1@domain1.example
8804 *@domain2.example
8805 .endd
8806 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8807 that are tried is:
8808 .code
8809 nimrod@jaeger.example
8810 *@jaeger.example
8811 *
8812 .endd
8813 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8814 would mean that every address matches, thus rendering the test useless.
8815
8816 &*Warning 2*&: Do not confuse these two kinds of item:
8817 .code
8818 deny recipients = dbm*@;/some/file
8819 deny recipients = *@dbm;/some/file
8820 .endd
8821 The first does a whole address lookup, with defaulting, as just described,
8822 because it starts with a lookup type. The second matches the local part and
8823 domain independently, as described in a bullet point below.
8824 .endlist
8825
8826
8827 The following kinds of address list pattern can match only non-empty addresses.
8828 If the subject address is empty, a match against any of these pattern types
8829 always fails.
8830
8831
8832 .ilist
8833 .cindex "@@ with single-key lookup"
8834 .cindex "address list" "@@ lookup type"
8835 .cindex "address list" "split local part and domain"
8836 If a pattern starts with &"@@"& followed by a single-key lookup item
8837 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8838 split into a local part and a domain. The domain is looked up in the file. If
8839 it is not found, there is no match. If it is found, the data that is looked up
8840 from the file is treated as a colon-separated list of local part patterns, each
8841 of which is matched against the subject local part in turn.
8842
8843 .cindex "asterisk" "in address list"
8844 The lookup may be a partial one, and/or one involving a search for a default
8845 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8846 patterns that are looked up can be regular expressions or begin with &"*"&, or
8847 even be further lookups. They may also be independently negated. For example,
8848 with
8849 .code
8850 deny senders = @@dbm;/etc/reject-by-domain
8851 .endd
8852 the data from which the DBM file is built could contain lines like
8853 .code
8854 baddomain.com:  !postmaster : *
8855 .endd
8856 to reject all senders except &%postmaster%& from that domain.
8857
8858 .cindex "local part" "starting with !"
8859 If a local part that actually begins with an exclamation mark is required, it
8860 has to be specified using a regular expression. In &(lsearch)& files, an entry
8861 may be split over several lines by indenting the second and subsequent lines,
8862 but the separating colon must still be included at line breaks. White space
8863 surrounding the colons is ignored. For example:
8864 .code
8865 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8866   spammer3 : spammer4
8867 .endd
8868 As in all colon-separated lists in Exim, a colon can be included in an item by
8869 doubling.
8870
8871 If the last item in the list starts with a right angle-bracket, the remainder
8872 of the item is taken as a new key to look up in order to obtain a continuation
8873 list of local parts. The new key can be any sequence of characters. Thus one
8874 might have entries like
8875 .code
8876 aol.com: spammer1 : spammer 2 : >*
8877 xyz.com: spammer3 : >*
8878 *:       ^\d{8}$
8879 .endd
8880 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8881 local parts for all domains, in addition to the specific local parts listed for
8882 each domain. Of course, using this feature costs another lookup each time a
8883 chain is followed, but the effort needed to maintain the data is reduced.
8884
8885 .cindex "loop" "in lookups"
8886 It is possible to construct loops using this facility, and in order to catch
8887 them, the chains may be no more than fifty items long.
8888
8889 .next
8890 The @@<&'lookup'&> style of item can also be used with a query-style
8891 lookup, but in this case, the chaining facility is not available. The lookup
8892 can only return a single list of local parts.
8893 .endlist
8894
8895 &*Warning*&: There is an important difference between the address list items
8896 in these two examples:
8897 .code
8898 senders = +my_list
8899 senders = *@+my_list
8900 .endd
8901 In the first one, &`my_list`& is a named address list, whereas in the second
8902 example it is a named domain list.
8903
8904
8905
8906
8907 .section "Case of letters in address lists" "SECTcasletadd"
8908 .cindex "case of local parts"
8909 .cindex "address list" "case forcing"
8910 .cindex "case forcing in address lists"
8911 Domains in email addresses are always handled caselessly, but for local parts
8912 case may be significant on some systems (see &%caseful_local_part%& for how
8913 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8914 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8915 blocking lists should be done in a case-independent manner. Since most address
8916 lists in Exim are used for this kind of control, Exim attempts to do this by
8917 default.
8918
8919 The domain portion of an address is always lowercased before matching it to an
8920 address list. The local part is lowercased by default, and any string
8921 comparisons that take place are done caselessly. This means that the data in
8922 the address list itself, in files included as plain file names, and in any file
8923 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8924 keys in files that are looked up by a search type other than &(lsearch)& (which
8925 works caselessly) must be in lower case, because these lookups are not
8926 case-independent.
8927
8928 .cindex "&`+caseful`&"
8929 To allow for the possibility of caseful address list matching, if an item in
8930 an address list is the string &"+caseful"&, the original case of the local
8931 part is restored for any comparisons that follow, and string comparisons are no
8932 longer case-independent. This does not affect the domain, which remains in
8933 lower case. However, although independent matches on the domain alone are still
8934 performed caselessly, regular expressions that match against an entire address
8935 become case-sensitive after &"+caseful"& has been seen.
8936
8937
8938
8939 .section "Local part lists" "SECTlocparlis"
8940 .cindex "list" "local part list"
8941 .cindex "local part" "list"
8942 Case-sensitivity in local part lists is handled in the same way as for address
8943 lists, as just described. The &"+caseful"& item can be used if required. In a
8944 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8945 set false, the subject is lowercased and the matching is initially
8946 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8947 matching in the local part list, but not elsewhere in the router. If
8948 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8949 option is case-sensitive from the start.
8950
8951 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8952 comments are handled in the same way as address lists &-- they are recognized
8953 only if the # is preceded by white space or the start of the line.
8954 Otherwise, local part lists are matched in the same way as domain lists, except
8955 that the special items that refer to the local host (&`@`&, &`@[]`&,
8956 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8957 Refer to section &<<SECTdomainlist>>& for details of the other available item
8958 types.
8959 .ecindex IIDdohoadli
8960
8961
8962
8963
8964 . ////////////////////////////////////////////////////////////////////////////
8965 . ////////////////////////////////////////////////////////////////////////////
8966
8967 .chapter "String expansions" "CHAPexpand"
8968 .scindex IIDstrexp "expansion" "of strings"
8969 Many strings in Exim's run time configuration are expanded before use. Some of
8970 them are expanded every time they are used; others are expanded only once.
8971
8972 When a string is being expanded it is copied verbatim from left to right except
8973 when a dollar or backslash character is encountered. A dollar specifies the
8974 start of a portion of the string that is interpreted and replaced as described
8975 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8976 escape character, as described in the following section.
8977
8978 Whether a string is expanded depends upon the context.  Usually this is solely
8979 dependent upon the option for which a value is sought; in this documentation,
8980 options for which string expansion is performed are marked with &dagger; after
8981 the data type.  ACL rules always expand strings.  A couple of expansion
8982 conditions do not expand some of the brace-delimited branches, for security
8983 reasons.
8984
8985
8986
8987 .section "Literal text in expanded strings" "SECTlittext"
8988 .cindex "expansion" "including literal text"
8989 An uninterpreted dollar can be included in an expanded string by putting a
8990 backslash in front of it. A backslash can be used to prevent any special
8991 character being treated specially in an expansion, including backslash itself.
8992 If the string appears in quotes in the configuration file, two backslashes are
8993 required because the quotes themselves cause interpretation of backslashes when
8994 the string is read in (see section &<<SECTstrings>>&).
8995
8996 .cindex "expansion" "non-expandable substrings"
8997 A portion of the string can specified as non-expandable by placing it between
8998 two occurrences of &`\N`&. This is particularly useful for protecting regular
8999 expressions, which often contain backslashes and dollar signs. For example:
9000 .code
9001 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9002 .endd
9003 On encountering the first &`\N`&, the expander copies subsequent characters
9004 without interpretation until it reaches the next &`\N`& or the end of the
9005 string.
9006
9007
9008
9009 .section "Character escape sequences in expanded strings" "SECID82"
9010 .cindex "expansion" "escape sequences"
9011 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9012 expanded string is recognized as an escape sequence for the character newline,
9013 carriage return, or tab, respectively. A backslash followed by up to three
9014 octal digits is recognized as an octal encoding for a single character, and a
9015 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9016 encoding.
9017
9018 These escape sequences are also recognized in quoted strings when they are read
9019 in. Their interpretation in expansions as well is useful for unquoted strings,
9020 and for other cases such as looked-up strings that are then expanded.
9021
9022
9023 .section "Testing string expansions" "SECID83"
9024 .cindex "expansion" "testing"
9025 .cindex "testing" "string expansion"
9026 .oindex "&%-be%&"
9027 Many expansions can be tested by calling Exim with the &%-be%& option. This
9028 takes the command arguments, or lines from the standard input if there are no
9029 arguments, runs them through the string expansion code, and writes the results
9030 to the standard output. Variables based on configuration values are set up, but
9031 since no message is being processed, variables such as &$local_part$& have no
9032 value. Nevertheless the &%-be%& option can be useful for checking out file and
9033 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9034 and &%nhash%&.
9035
9036 Exim gives up its root privilege when it is called with the &%-be%& option, and
9037 instead runs under the uid and gid it was called with, to prevent users from
9038 using &%-be%& for reading files to which they do not have access.
9039
9040 .oindex "&%-bem%&"
9041 If you want to test expansions that include variables whose values are taken
9042 from a message, there are two other options that can be used. The &%-bem%&
9043 option is like &%-be%& except that it is followed by a file name. The file is
9044 read as a message before doing the test expansions. For example:
9045 .code
9046 exim -bem /tmp/test.message '$h_subject:'
9047 .endd
9048 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9049 Exim message identifier. For example:
9050 .code
9051 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9052 .endd
9053 This loads the message from Exim's spool before doing the test expansions, and
9054 is therefore restricted to admin users.
9055
9056
9057 .section "Forced expansion failure" "SECTforexpfai"
9058 .cindex "expansion" "forced failure"
9059 A number of expansions that are described in the following section have
9060 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9061 (which are sometimes called &"curly brackets"&). Which of the two strings is
9062 used depends on some condition that is evaluated as part of the expansion. If,
9063 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9064 the entire string expansion fails in a way that can be detected by the code
9065 that requested the expansion. This is called &"forced expansion failure"&, and
9066 its consequences depend on the circumstances. In some cases it is no different
9067 from any other expansion failure, but in others a different action may be
9068 taken. Such variations are mentioned in the documentation of the option that is
9069 being expanded.
9070
9071
9072
9073
9074 .section "Expansion items" "SECTexpansionitems"
9075 The following items are recognized in expanded strings. White space may be used
9076 between sub-items that are keywords or substrings enclosed in braces inside an
9077 outer set of braces, to improve readability. &*Warning*&: Within braces,
9078 white space is significant.
9079
9080 .vlist
9081 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9082 .cindex "expansion" "variables"
9083 Substitute the contents of the named variable, for example:
9084 .code
9085 $local_part
9086 ${domain}
9087 .endd
9088 The second form can be used to separate the name from subsequent alphanumeric
9089 characters. This form (using braces) is available only for variables; it does
9090 &'not'& apply to message headers. The names of the variables are given in
9091 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9092 given, the expansion fails.
9093
9094 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9095 .cindex "expansion" "operators"
9096 The string is first itself expanded, and then the operation specified by
9097 <&'op'&> is applied to it. For example:
9098 .code
9099 ${lc:$local_part}
9100 .endd
9101 The string starts with the first character after the colon, which may be
9102 leading white space. A list of operators is given in section &<<SECTexpop>>&
9103 below. The operator notation is used for simple expansion items that have just
9104 one argument, because it reduces the number of braces and therefore makes the
9105 string easier to understand.
9106
9107 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9108 This item inserts &"basic"& header lines. It is described with the &%header%&
9109 expansion item below.
9110
9111
9112 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9113 .cindex "expansion" "calling an acl"
9114 .cindex "&%acl%&" "call from expansion"
9115 The name and zero to nine argument strings are first expanded separately.  The expanded
9116 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9117 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9118 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9119 and may use the variables; if another acl expansion is used the values
9120 are restored after it returns.  If the ACL sets
9121 a value using a "message =" modifier and returns accept or deny, the value becomes
9122 the result of the expansion.
9123 If no message is set and the ACL returns accept or deny
9124 the expansion result is an empty string.
9125 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9126
9127
9128 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9129        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9130 .cindex "expansion" "extracting certificate fields"
9131 .cindex "&%certextract%&" "certificate fields"
9132 .cindex "certificate" "extracting fields"
9133 The <&'certificate'&> must be a variable of type certificate.
9134 The field name is expanded and used to retrieve the relevant field from
9135 the certificate.  Supported fields are:
9136 .display
9137 &`version        `&
9138 &`serial_number  `&
9139 &`subject        `& RFC4514 DN
9140 &`issuer         `& RFC4514 DN
9141 &`notbefore      `& time
9142 &`notafter       `& time
9143 &`sig_algorithm  `&
9144 &`signature      `&
9145 &`subj_altname   `& tagged list
9146 &`ocsp_uri       `& list
9147 &`crl_uri        `& list
9148 .endd
9149 If the field is found,
9150 <&'string2'&> is expanded, and replaces the whole item;
9151 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9152 variable &$value$& contains the value that has been extracted. Afterwards, it
9153 is restored to any previous value it might have had.
9154
9155 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9156 key is not found. If {<&'string2'&>} is also omitted, the value that was
9157 extracted is used.
9158
9159 Some field names take optional modifiers, appended and separated by commas.
9160
9161 The field selectors marked as "RFC4514" above
9162 output a Distinguished Name string which is
9163 not quite
9164 parseable by Exim as a comma-separated tagged list
9165 (the exceptions being elements containing commas).
9166 RDN elements of a single type may be selected by
9167 a modifier of the type label; if so the expansion
9168 result is a list (newline-separated by default).
9169 The separator may be changed by another modifier of
9170 a right angle-bracket followed immediately by the new separator.
9171 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9172
9173 The field selectors marked as "time" above
9174 take an optional modifier of "int"
9175 for which the result is the number of seconds since epoch.
9176 Otherwise the result is a human-readable string
9177 in the timezone selected by the main "timezone" option.
9178
9179 The field selectors marked as "list" above return a list,
9180 newline-separated by default,
9181 (embedded separator characters in elements are doubled).
9182 The separator may be changed by a modifier of
9183 a right angle-bracket followed immediately by the new separator.
9184
9185 The field selectors marked as "tagged" above
9186 prefix each list element with a type string and an equals sign.
9187 Elements of only one type may be selected by a modifier
9188 which is one of "dns", "uri" or "mail";
9189 if so the element tags are omitted.
9190
9191 If not otherwise noted field values are presented in human-readable form.
9192
9193 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9194        {*&<&'arg'&>&*}...}*&"
9195 .cindex &%dlfunc%&
9196 This expansion dynamically loads and then calls a locally-written C function.
9197 This functionality is available only if Exim is compiled with
9198 .code
9199 EXPAND_DLFUNC=yes
9200 .endd
9201 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9202 object so that it doesn't reload the same object file in the same Exim process
9203 (but of course Exim does start new processes frequently).
9204
9205 There may be from zero to eight arguments to the function. When compiling
9206 a local function that is to be called in this way, &_local_scan.h_& should be
9207 included. The Exim variables and functions that are defined by that API
9208 are also available for dynamically loaded functions. The function itself
9209 must have the following type:
9210 .code
9211 int dlfunction(uschar **yield, int argc, uschar *argv[])
9212 .endd
9213 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9214 function should return one of the following values:
9215
9216 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9217 into the expanded string that is being built.
9218
9219 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9220 from &'yield'&, if it is set.
9221
9222 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9223 taken from &'yield'& if it is set.
9224
9225 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9226
9227 When compiling a function that is to be used in this way with gcc,
9228 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9229 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9230
9231
9232 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9233 .cindex "expansion" "extracting value from environment"
9234 .cindex "environment" "values from"
9235 The key is first expanded separately, and leading and trailing white space
9236 removed.
9237 This is then searched for as a name in the environment.
9238 If a variable is found then its value is placed in &$value$&
9239 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9240
9241 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9242 appear, for example:
9243 .code
9244 ${env{USER}{$value} fail }
9245 .endd
9246 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9247 {<&'string1'&>} must be present for &"fail"& to be recognized.
9248
9249 If {<&'string2'&>} is omitted an empty string is substituted on
9250 search failure.
9251 If {<&'string1'&>} is omitted the search result is substituted on
9252 search success.
9253
9254 The environment is adjusted by the &%keep_environment%& and
9255 &%add_environment%& main section options.
9256
9257
9258 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9259        {*&<&'string3'&>&*}}*&"
9260 .cindex "expansion" "extracting substrings by key"
9261 .cindex "&%extract%&" "substrings by key"
9262 The key and <&'string1'&> are first expanded separately. Leading and trailing
9263 white space is removed from the key (but not from any of the strings). The key
9264 must not be empty and must not consist entirely of digits.
9265 The expanded <&'string1'&> must be of the form:
9266 .display
9267 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9268 .endd
9269 .vindex "&$value$&"
9270 where the equals signs and spaces (but not both) are optional. If any of the
9271 values contain white space, they must be enclosed in double quotes, and any
9272 values that are enclosed in double quotes are subject to escape processing as
9273 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9274 for the value that corresponds to the key. The search is case-insensitive. If
9275 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9276 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9277 variable &$value$& contains the value that has been extracted. Afterwards, it
9278 is restored to any previous value it might have had.
9279
9280 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9281 key is not found. If {<&'string2'&>} is also omitted, the value that was
9282 extracted is used. Thus, for example, these two expansions are identical, and
9283 yield &"2001"&:
9284 .code
9285 ${extract{gid}{uid=1984 gid=2001}}
9286 ${extract{gid}{uid=1984 gid=2001}{$value}}
9287 .endd
9288 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9289 appear, for example:
9290 .code
9291 ${extract{Z}{A=... B=...}{$value} fail }
9292 .endd
9293 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9294 {<&'string2'&>} must be present for &"fail"& to be recognized.
9295
9296
9297 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9298         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9299 .cindex "expansion" "extracting substrings by number"
9300 .cindex "&%extract%&" "substrings by number"
9301 The <&'number'&> argument must consist entirely of decimal digits,
9302 apart from leading and trailing white space, which is ignored.
9303 This is what distinguishes this form of &%extract%& from the previous kind. It
9304 behaves in the same way, except that, instead of extracting a named field, it
9305 extracts from <&'string1'&> the field whose number is given as the first
9306 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9307 <&'string3'&> as before.
9308
9309 The fields in the string are separated by any one of the characters in the
9310 separator string. These may include space or tab characters.
9311 The first field is numbered one. If the number is negative, the fields are
9312 counted from the end of the string, with the rightmost one numbered -1. If the
9313 number given is zero, the entire string is returned. If the modulus of the
9314 number is greater than the number of fields in the string, the result is the
9315 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9316 provided. For example:
9317 .code
9318 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9319 .endd
9320 yields &"42"&, and
9321 .code
9322 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9323 .endd
9324 yields &"99"&. Two successive separators mean that the field between them is
9325 empty (for example, the fifth field above).
9326
9327
9328 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9329 .cindex "list" "selecting by condition"
9330 .cindex "expansion" "selecting from list by condition"
9331 .vindex "&$item$&"
9332 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9333 default, but the separator can be changed in the usual way. For each item
9334 in this list, its value is place in &$item$&, and then the condition is
9335 evaluated. If the condition is true, &$item$& is added to the output as an
9336 item in a new list; if the condition is false, the item is discarded. The
9337 separator used for the output list is the same as the one used for the
9338 input, but a separator setting is not included in the output. For example:
9339 .code
9340 ${filter{a:b:c}{!eq{$item}{b}}
9341 .endd
9342 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9343 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9344
9345
9346 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9347 .cindex "hash function" "textual"
9348 .cindex "expansion" "textual hash"
9349 This is a textual hashing function, and was the first to be implemented in
9350 early versions of Exim. In current releases, there are other hashing functions
9351 (numeric, MD5, and SHA-1), which are described below.
9352
9353 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9354 <&'n'&>. If you are using fixed values for these numbers, that is, if
9355 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9356 use the simpler operator notation that avoids some of the braces:
9357 .code
9358 ${hash_<n>_<m>:<string>}
9359 .endd
9360 The second number is optional (in both notations). If <&'n'&> is greater than
9361 or equal to the length of the string, the expansion item returns the string.
9362 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9363 function to the string. The new string consists of characters taken from the
9364 first <&'m'&> characters of the string
9365 .code
9366 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9367 .endd
9368 If <&'m'&> is not present the value 26 is used, so that only lower case
9369 letters appear. For example:
9370 .display
9371 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9372 &`$hash{5}{monty}}           `&   yields  &`monty`&
9373 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9374 .endd
9375
9376 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9377         &*$h_*&<&'header&~name'&>&*:*&" &&&
9378        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9379         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9380        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9381         &*$rh_*&<&'header&~name'&>&*:*&"
9382 .cindex "expansion" "header insertion"
9383 .vindex "&$header_$&"
9384 .vindex "&$bheader_$&"
9385 .vindex "&$rheader_$&"
9386 .cindex "header lines" "in expansion strings"
9387 .cindex "header lines" "character sets"
9388 .cindex "header lines" "decoding"
9389 Substitute the contents of the named message header line, for example
9390 .code
9391 $header_reply-to:
9392 .endd
9393 The newline that terminates a header line is not included in the expansion, but
9394 internal newlines (caused by splitting the header line over several physical
9395 lines) may be present.
9396
9397 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9398 the data in the header line is interpreted.
9399
9400 .ilist
9401 .cindex "white space" "in header lines"
9402 &%rheader%& gives the original &"raw"& content of the header line, with no
9403 processing at all, and without the removal of leading and trailing white space.
9404
9405 .next
9406 .cindex "base64 encoding" "in header lines"
9407 &%bheader%& removes leading and trailing white space, and then decodes base64
9408 or quoted-printable MIME &"words"& within the header text, but does no
9409 character set translation. If decoding of what looks superficially like a MIME
9410 &"word"& fails, the raw string is returned. If decoding
9411 .cindex "binary zero" "in header line"
9412 produces a binary zero character, it is replaced by a question mark &-- this is
9413 what Exim does for binary zeros that are actually received in header lines.
9414
9415 .next
9416 &%header%& tries to translate the string as decoded by &%bheader%& to a
9417 standard character set. This is an attempt to produce the same string as would
9418 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9419 returned. Translation is attempted only on operating systems that support the
9420 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9421 a system Makefile or in &_Local/Makefile_&.
9422 .endlist ilist
9423
9424 In a filter file, the target character set for &%header%& can be specified by a
9425 command of the following form:
9426 .code
9427 headers charset "UTF-8"
9428 .endd
9429 This command affects all references to &$h_$& (or &$header_$&) expansions in
9430 subsequently obeyed filter commands. In the absence of this command, the target
9431 character set in a filter is taken from the setting of the &%headers_charset%&
9432 option in the runtime configuration. The value of this option defaults to the
9433 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9434 ISO-8859-1.
9435
9436 Header names follow the syntax of RFC 2822, which states that they may contain
9437 any printing characters except space and colon. Consequently, curly brackets
9438 &'do not'& terminate header names, and should not be used to enclose them as
9439 if they were variables. Attempting to do so causes a syntax error.
9440
9441 Only header lines that are common to all copies of a message are visible to
9442 this mechanism. These are the original header lines that are received with the
9443 message, and any that are added by an ACL statement or by a system
9444 filter. Header lines that are added to a particular copy of a message by a
9445 router or transport are not accessible.
9446
9447 For incoming SMTP messages, no header lines are visible in
9448 ACLs that are obeyed before the data phase completes,
9449 because the header structure is not set up until the message is received.
9450 They are visible in DKIM, PRDR and DATA ACLs.
9451 Header lines that are added in a RCPT ACL (for example)
9452 are saved until the message's incoming header lines are available, at which
9453 point they are added.
9454 When any of the above ACLs ar
9455 running, however, header lines added by earlier ACLs are visible.
9456
9457 Upper case and lower case letters are synonymous in header names. If the
9458 following character is white space, the terminating colon may be omitted, but
9459 this is not recommended, because you may then forget it when it is needed. When
9460 white space terminates the header name, this white space is included in the
9461 expanded string.  If the message does not contain the given header, the
9462 expansion item is replaced by an empty string. (See the &%def%& condition in
9463 section &<<SECTexpcond>>& for a means of testing for the existence of a
9464 header.)
9465
9466 If there is more than one header with the same name, they are all concatenated
9467 to form the substitution string, up to a maximum length of 64K. Unless
9468 &%rheader%& is being used, leading and trailing white space is removed from
9469 each header before concatenation, and a completely empty header is ignored. A
9470 newline character is then inserted between non-empty headers, but there is no
9471 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9472 those headers that contain lists of addresses, a comma is also inserted at the
9473 junctions between headers. This does not happen for the &%rheader%& expansion.
9474
9475
9476 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9477 .cindex "expansion" "hmac hashing"
9478 .cindex &%hmac%&
9479 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9480 shared secret and some text into a message authentication code, as specified in
9481 RFC 2104. This differs from &`${md5:secret_text...}`& or
9482 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9483 cryptographic hash, allowing for authentication that is not possible with MD5
9484 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9485 present. For example:
9486 .code
9487 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9488 .endd
9489 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9490 produces:
9491 .code
9492 dd97e3ba5d1a61b5006108f8c8252953
9493 .endd
9494 As an example of how this might be used, you might put in the main part of
9495 an Exim configuration:
9496 .code
9497 SPAMSCAN_SECRET=cohgheeLei2thahw
9498 .endd
9499 In a router or a transport you could then have:
9500 .code
9501 headers_add = \
9502   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9503   ${hmac{md5}{SPAMSCAN_SECRET}\
9504   {${primary_hostname},${message_exim_id},$h_message-id:}}
9505 .endd
9506 Then given a message, you can check where it was scanned by looking at the
9507 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9508 this header line is authentic by recomputing the authentication code from the
9509 host name, message ID and the &'Message-id:'& header line. This can be done
9510 using Exim's &%-be%& option, or by other means, for example by using the
9511 &'hmac_md5_hex()'& function in Perl.
9512
9513
9514 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9515 .cindex "expansion" "conditional"
9516 .cindex "&%if%&, expansion item"
9517 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9518 item; otherwise <&'string2'&> is used. The available conditions are described
9519 in section &<<SECTexpcond>>& below. For example:
9520 .code
9521 ${if eq {$local_part}{postmaster} {yes}{no} }
9522 .endd
9523 The second string need not be present; if it is not and the condition is not
9524 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9525 be present instead of the second string (without any curly brackets). In this
9526 case, the expansion is forced to fail if the condition is not true (see section
9527 &<<SECTforexpfai>>&).
9528
9529 If both strings are omitted, the result is the string &`true`& if the condition
9530 is true, and the empty string if the condition is false. This makes it less
9531 cumbersome to write custom ACL and router conditions. For example, instead of
9532 .code
9533 condition = ${if >{$acl_m4}{3}{true}{false}}
9534 .endd
9535 you can use
9536 .code
9537 condition = ${if >{$acl_m4}{3}}
9538 .endd
9539
9540
9541
9542 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9543 .cindex expansion "imap folder"
9544 .cindex "&%imapfolder%& expansion item"
9545 This item converts a (possibly multilevel, or with non-ASCII characters)
9546 folder specification to a Maildir name for filesystem use.
9547 For information on internationalisation support see &<<SECTi18nMDA>>&.
9548
9549
9550
9551 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9552 .cindex "expansion" "string truncation"
9553 .cindex "&%length%& expansion item"
9554 The &%length%& item is used to extract the initial portion of a string. Both
9555 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9556 you are using a fixed value for the number, that is, if <&'string1'&> does not
9557 change when expanded, you can use the simpler operator notation that avoids
9558 some of the braces:
9559 .code
9560 ${length_<n>:<string>}
9561 .endd
9562 The result of this item is either the first <&'n'&> characters or the whole
9563 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9564 &%strlen%&, which gives the length of a string.
9565
9566
9567 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9568         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9569 .cindex "expansion" "extracting list elements by number"
9570 .cindex "&%listextract%&" "extract list elements by number"
9571 .cindex "list" "extracting elements by number"
9572 The <&'number'&> argument must consist entirely of decimal digits,
9573 apart from an optional leading minus,
9574 and leading and trailing white space (which is ignored).
9575
9576 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9577 default, but the separator can be changed in the usual way.
9578
9579 The first field of the list is numbered one.
9580 If the number is negative, the fields are
9581 counted from the end of the list, with the rightmost one numbered -1.
9582 The numbered element of the list is extracted and placed in &$value$&,
9583 then <&'string2'&> is expanded as the result.
9584
9585 If the modulus of the
9586 number is zero or greater than the number of fields in the string,
9587 the result is the expansion of <&'string3'&>.
9588
9589 For example:
9590 .code
9591 ${listextract{2}{x:42:99}}
9592 .endd
9593 yields &"42"&, and
9594 .code
9595 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9596 .endd
9597 yields &"result: 42"&.
9598
9599 If {<&'string3'&>} is omitted, an empty string is used for string3.
9600 If {<&'string2'&>} is also omitted, the value that was
9601 extracted is used.
9602 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9603
9604
9605 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9606         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9607 This is the first of one of two different types of lookup item, which are both
9608 described in the next item.
9609
9610 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9611         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9612 .cindex "expansion" "lookup in"
9613 .cindex "file" "lookups"
9614 .cindex "lookup" "in expanded string"
9615 The two forms of lookup item specify data lookups in files and databases, as
9616 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9617 lookups, and the second is used for query-style lookups. The <&'key'&>,
9618 <&'file'&>, and <&'query'&> strings are expanded before use.
9619
9620 If there is any white space in a lookup item which is part of a filter command,
9621 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9622 other place where white space is significant, the lookup item must be enclosed
9623 in double quotes. The use of data lookups in users' filter files may be locked
9624 out by the system administrator.
9625
9626 .vindex "&$value$&"
9627 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9628 During its expansion, the variable &$value$& contains the data returned by the
9629 lookup. Afterwards it reverts to the value it had previously (at the outer
9630 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9631 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9632 string on failure. If <&'string2'&> is provided, it can itself be a nested
9633 lookup, thus providing a mechanism for looking up a default value when the
9634 original lookup fails.
9635
9636 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9637 data for the outer lookup while the parameters of the second lookup are
9638 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9639 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9640 appear, and in this case, if the lookup fails, the entire expansion is forced
9641 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9642 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9643 successful lookup, and nothing in the case of failure.
9644
9645 For single-key lookups, the string &"partial"& is permitted to precede the
9646 search type in order to do partial matching, and * or *@ may follow a search
9647 type to request default lookups if the key does not match (see sections
9648 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9649
9650 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9651 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9652 and non-wild parts of the key during the expansion of the replacement text.
9653 They return to their previous values at the end of the lookup item.
9654
9655 This example looks up the postmaster alias in the conventional alias file:
9656 .code
9657 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9658 .endd
9659 This example uses NIS+ to look up the full name of the user corresponding to
9660 the local part of an address, forcing the expansion to fail if it is not found:
9661 .code
9662 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9663   {$value}fail}
9664 .endd
9665
9666
9667 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9668 .cindex "expansion" "list creation"
9669 .vindex "&$item$&"
9670 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9671 default, but the separator can be changed in the usual way. For each item
9672 in this list, its value is place in &$item$&, and then <&'string2'&> is
9673 expanded and added to the output as an item in a new list. The separator used
9674 for the output list is the same as the one used for the input, but a separator
9675 setting is not included in the output. For example:
9676 .code
9677 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9678 .endd
9679 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9680 value of &$item$& is restored to what it was before. See also the &*filter*&
9681 and &*reduce*& expansion items.
9682
9683 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9684 .cindex "expansion" "numeric hash"
9685 .cindex "hash function" "numeric"
9686 The three strings are expanded; the first two must yield numbers. Call them
9687 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9688 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9689 can use the simpler operator notation that avoids some of the braces:
9690 .code
9691 ${nhash_<n>_<m>:<string>}
9692 .endd
9693 The second number is optional (in both notations). If there is only one number,
9694 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9695 processed by a div/mod hash function that returns two numbers, separated by a
9696 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9697 example,
9698 .code
9699 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9700 .endd
9701 returns the string &"6/33"&.
9702
9703
9704
9705 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9706 .cindex "Perl" "use in expanded string"
9707 .cindex "expansion" "calling Perl from"
9708 This item is available only if Exim has been built to include an embedded Perl
9709 interpreter. The subroutine name and the arguments are first separately
9710 expanded, and then the Perl subroutine is called with those arguments. No
9711 additional arguments need be given; the maximum number permitted, including the
9712 name of the subroutine, is nine.
9713
9714 The return value of the subroutine is inserted into the expanded string, unless
9715 the return value is &%undef%&. In that case, the expansion fails in the same
9716 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9717 Whatever you return is evaluated in a scalar context. For example, if you
9718 return the name of a Perl vector, the return value is the size of the vector,
9719 not its contents.
9720
9721 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9722 with the error message that was passed to &%die%&. More details of the embedded
9723 Perl facility are given in chapter &<<CHAPperl>>&.
9724
9725 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9726 out the use of this expansion item in filter files.
9727
9728
9729 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9730 .cindex "&%prvs%& expansion item"
9731 The first argument is a complete email address and the second is secret
9732 keystring. The third argument, specifying a key number, is optional. If absent,
9733 it defaults to 0. The result of the expansion is a prvs-signed email address,
9734 to be typically used with the &%return_path%& option on an &(smtp)& transport
9735 as part of a bounce address tag validation (BATV) scheme. For more discussion
9736 and an example, see section &<<SECTverifyPRVS>>&.
9737
9738 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9739         {*&<&'string'&>&*}}*&"
9740 .cindex "&%prvscheck%& expansion item"
9741 This expansion item is the complement of the &%prvs%& item. It is used for
9742 checking prvs-signed addresses. If the expansion of the first argument does not
9743 yield a syntactically valid prvs-signed address, the whole item expands to the
9744 empty string. When the first argument does expand to a syntactically valid
9745 prvs-signed address, the second argument is expanded, with the prvs-decoded
9746 version of the address and the key number extracted from the address in the
9747 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9748
9749 These two variables can be used in the expansion of the second argument to
9750 retrieve the secret. The validity of the prvs-signed address is then checked
9751 against the secret. The result is stored in the variable &$prvscheck_result$&,
9752 which is empty for failure or &"1"& for success.
9753
9754 The third argument is optional; if it is missing, it defaults to an empty
9755 string. This argument is now expanded. If the result is an empty string, the
9756 result of the expansion is the decoded version of the address. This is the case
9757 whether or not the signature was valid. Otherwise, the result of the expansion
9758 is the expansion of the third argument.
9759
9760 All three variables can be used in the expansion of the third argument.
9761 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9762 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9763
9764 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9765 .cindex "expansion" "inserting an entire file"
9766 .cindex "file" "inserting into expansion"
9767 .cindex "&%readfile%& expansion item"
9768 The file name and end-of-line string are first expanded separately. The file is
9769 then read, and its contents replace the entire item. All newline characters in
9770 the file are replaced by the end-of-line string if it is present. Otherwise,
9771 newlines are left in the string.
9772 String expansion is not applied to the contents of the file. If you want this,
9773 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9774 the string expansion fails.
9775
9776 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9777 locks out the use of this expansion item in filter files.
9778
9779
9780
9781 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9782         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9783 .cindex "expansion" "inserting from a socket"
9784 .cindex "socket, use of in expansion"
9785 .cindex "&%readsocket%& expansion item"
9786 This item inserts data from a Unix domain or TCP socket into the expanded
9787 string. The minimal way of using it uses just two arguments, as in these
9788 examples:
9789 .code
9790 ${readsocket{/socket/name}{request string}}
9791 ${readsocket{inet:some.host:1234}{request string}}
9792 .endd
9793 For a Unix domain socket, the first substring must be the path to the socket.
9794 For an Internet socket, the first substring must contain &`inet:`& followed by
9795 a host name or IP address, followed by a colon and a port, which can be a
9796 number or the name of a TCP port in &_/etc/services_&. An IP address may
9797 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9798 example:
9799 .code
9800 ${readsocket{inet:[::1]:1234}{request string}}
9801 .endd
9802 Only a single host name may be given, but if looking it up yields more than
9803 one IP address, they are each tried in turn until a connection is made. For
9804 both kinds of socket, Exim makes a connection, writes the request string
9805 unless it is an empty string; and no terminating NUL is ever sent)
9806 and reads from the socket until an end-of-file
9807 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9808 extend what can be done. Firstly, you can vary the timeout. For example:
9809 .code
9810 ${readsocket{/socket/name}{request string}{3s}}
9811 .endd
9812 The third argument is a list of options, of which the first element is the timeout
9813 and must be present if the argument is given.
9814 Further elements are options of form &'name=value'&.
9815 One option type is currently recognised, defining whether (the default)
9816 or not a shutdown is done on the connection after sending the request.
9817 Example, to not do so (preferred, eg. by some webservers):
9818 .code
9819 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
9820 .endd
9821 A fourth argument allows you to change any newlines that are in the data
9822 that is read, in the same way as for &%readfile%& (see above). This example
9823 turns them into spaces:
9824 .code
9825 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9826 .endd
9827 As with all expansions, the substrings are expanded before the processing
9828 happens. Errors in these sub-expansions cause the expansion to fail. In
9829 addition, the following errors can occur:
9830
9831 .ilist
9832 Failure to create a socket file descriptor;
9833 .next
9834 Failure to connect the socket;
9835 .next
9836 Failure to write the request string;
9837 .next
9838 Timeout on reading from the socket.
9839 .endlist
9840
9841 By default, any of these errors causes the expansion to fail. However, if
9842 you supply a fifth substring, it is expanded and used when any of the above
9843 errors occurs. For example:
9844 .code
9845 ${readsocket{/socket/name}{request string}{3s}{\n}\
9846   {socket failure}}
9847 .endd
9848 You can test for the existence of a Unix domain socket by wrapping this
9849 expansion in &`${if exists`&, but there is a race condition between that test
9850 and the actual opening of the socket, so it is safer to use the fifth argument
9851 if you want to be absolutely sure of avoiding an expansion error for a
9852 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9853
9854 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9855 locks out the use of this expansion item in filter files.
9856
9857
9858 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9859 .cindex "expansion" "reducing a list to a scalar"
9860 .cindex "list" "reducing to a scalar"
9861 .vindex "&$value$&"
9862 .vindex "&$item$&"
9863 This operation reduces a list to a single, scalar string. After expansion,
9864 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9865 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9866 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9867 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9868 them. The result of that expansion is assigned to &$value$& before the next
9869 iteration. When the end of the list is reached, the final value of &$value$& is
9870 added to the expansion output. The &*reduce*& expansion item can be used in a
9871 number of ways. For example, to add up a list of numbers:
9872 .code
9873 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9874 .endd
9875 The result of that expansion would be &`6`&. The maximum of a list of numbers
9876 can be found:
9877 .code
9878 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9879 .endd
9880 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9881 restored to what they were before. See also the &*filter*& and &*map*&
9882 expansion items.
9883
9884 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9885 This item inserts &"raw"& header lines. It is described with the &%header%&
9886 expansion item above.
9887
9888 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9889         {*&<&'string2'&>&*}}*&"
9890 .cindex "expansion" "running a command"
9891 .cindex "&%run%& expansion item"
9892 The command and its arguments are first expanded as one string. The string is
9893 split apart into individual arguments by spaces, and then the command is run
9894 in a separate process, but under the same uid and gid.  As in other command
9895 executions from Exim, a shell is not used by default. If the command requires
9896 a shell, you must explicitly code it.
9897
9898 Since the arguments are split by spaces, when there is a variable expansion
9899 which has an empty result, it will cause the situation that the argument will
9900 simply be omitted when the program is actually executed by Exim. If the
9901 script/program requires a specific number of arguments and the expanded
9902 variable could possibly result in this empty expansion, the variable must be
9903 quoted. This is more difficult if the expanded variable itself could result
9904 in a string containing quotes, because it would interfere with the quotes
9905 around the command arguments. A possible guard against this is to wrap the
9906 variable in the &%sg%& operator to change any quote marks to some other
9907 character.
9908
9909 The standard input for the command exists, but is empty. The standard output
9910 and standard error are set to the same file descriptor.
9911 .cindex "return code" "from &%run%& expansion"
9912 .vindex "&$value$&"
9913 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9914 and replaces the entire item; during this expansion, the standard output/error
9915 from the command is in the variable &$value$&. If the command fails,
9916 <&'string2'&>, if present, is expanded and used. Once again, during the
9917 expansion, the standard output/error from the command is in the variable
9918 &$value$&.
9919
9920 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9921 can be the word &"fail"& (not in braces) to force expansion failure if the
9922 command does not succeed. If both strings are omitted, the result is contents
9923 of the standard output/error on success, and nothing on failure.
9924
9925 .vindex "&$run_in_acl$&"
9926 The standard output/error of the command is put in the variable &$value$&.
9927 In this ACL example, the output of a command is logged for the admin to
9928 troubleshoot:
9929 .code
9930 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9931       log_message  = Output of id: $value
9932 .endd
9933 If the command requires shell idioms, such as the > redirect operator, the
9934 shell must be invoked directly, such as with:
9935 .code
9936 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9937 .endd
9938
9939 .vindex "&$runrc$&"
9940 The return code from the command is put in the variable &$runrc$&, and this
9941 remains set afterwards, so in a filter file you can do things like this:
9942 .code
9943 if "${run{x y z}{}}$runrc" is 1 then ...
9944   elif $runrc is 2 then ...
9945   ...
9946 endif
9947 .endd
9948 If execution of the command fails (for example, the command does not exist),
9949 the return code is 127 &-- the same code that shells use for non-existent
9950 commands.
9951
9952 &*Warning*&: In a router or transport, you cannot assume the order in which
9953 option values are expanded, except for those preconditions whose order of
9954 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9955 by the expansion of one option, and use it in another.
9956
9957 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9958 out the use of this expansion item in filter files.
9959
9960
9961 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9962 .cindex "expansion" "string substitution"
9963 .cindex "&%sg%& expansion item"
9964 This item works like Perl's substitution operator (s) with the global (/g)
9965 option; hence its name. However, unlike the Perl equivalent, Exim does not
9966 modify the subject string; instead it returns the modified string for insertion
9967 into the overall expansion. The item takes three arguments: the subject string,
9968 a regular expression, and a substitution string. For example:
9969 .code
9970 ${sg{abcdefabcdef}{abc}{xyz}}
9971 .endd
9972 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9973 if any $, } or \ characters are required in the regular expression or in the
9974 substitution string, they have to be escaped. For example:
9975 .code
9976 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9977 .endd
9978 yields &"defabc"&, and
9979 .code
9980 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9981 .endd
9982 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9983 the regular expression from string expansion.
9984
9985
9986
9987 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9988 .cindex sorting "a list"
9989 .cindex list sorting
9990 .cindex expansion "list sorting"
9991 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9992 default, but the separator can be changed in the usual way.
9993 The <&'comparator'&> argument is interpreted as the operator
9994 of a two-argument expansion condition.
9995 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9996 The comparison should return true when applied to two values
9997 if the first value should sort before the second value.
9998 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9999 the element being placed in &$item$&,
10000 to give values for comparison.
10001
10002 The item result is a sorted list,
10003 with the original list separator,
10004 of the list elements (in full) of the original.
10005
10006 Examples:
10007 .code
10008 ${sort{3:2:1:4}{<}{$item}}
10009 .endd
10010 sorts a list of numbers, and
10011 .code
10012 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10013 .endd
10014 will sort an MX lookup into priority order.
10015
10016
10017 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10018 .cindex "&%substr%& expansion item"
10019 .cindex "substring extraction"
10020 .cindex "expansion" "substring extraction"
10021 The three strings are expanded; the first two must yield numbers. Call them
10022 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10023 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10024 can use the simpler operator notation that avoids some of the braces:
10025 .code
10026 ${substr_<n>_<m>:<string>}
10027 .endd
10028 The second number is optional (in both notations).
10029 If it is absent in the simpler format, the preceding underscore must also be
10030 omitted.
10031
10032 The &%substr%& item can be used to extract more general substrings than
10033 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10034 length required. For example
10035 .code
10036 ${substr{3}{2}{$local_part}}
10037 .endd
10038 If the starting offset is greater than the string length the result is the
10039 null string; if the length plus starting offset is greater than the string
10040 length, the result is the right-hand part of the string, starting from the
10041 given offset. The first character in the string has offset zero.
10042
10043 The &%substr%& expansion item can take negative offset values to count
10044 from the right-hand end of its operand. The last character is offset -1, the
10045 second-last is offset -2, and so on. Thus, for example,
10046 .code
10047 ${substr{-5}{2}{1234567}}
10048 .endd
10049 yields &"34"&. If the absolute value of a negative offset is greater than the
10050 length of the string, the substring starts at the beginning of the string, and
10051 the length is reduced by the amount of overshoot. Thus, for example,
10052 .code
10053 ${substr{-5}{2}{12}}
10054 .endd
10055 yields an empty string, but
10056 .code
10057 ${substr{-3}{2}{12}}
10058 .endd
10059 yields &"1"&.
10060
10061 When the second number is omitted from &%substr%&, the remainder of the string
10062 is taken if the offset is positive. If it is negative, all characters in the
10063 string preceding the offset point are taken. For example, an offset of -1 and
10064 no length, as in these semantically identical examples:
10065 .code
10066 ${substr_-1:abcde}
10067 ${substr{-1}{abcde}}
10068 .endd
10069 yields all but the last character of the string, that is, &"abcd"&.
10070
10071
10072
10073 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10074         {*&<&'replacements'&>&*}}*&"
10075 .cindex "expansion" "character translation"
10076 .cindex "&%tr%& expansion item"
10077 This item does single-character translation on its subject string. The second
10078 argument is a list of characters to be translated in the subject string. Each
10079 matching character is replaced by the corresponding character from the
10080 replacement list. For example
10081 .code
10082 ${tr{abcdea}{ac}{13}}
10083 .endd
10084 yields &`1b3de1`&. If there are duplicates in the second character string, the
10085 last occurrence is used. If the third string is shorter than the second, its
10086 last character is replicated. However, if it is empty, no translation takes
10087 place.
10088 .endlist
10089
10090
10091
10092 .section "Expansion operators" "SECTexpop"
10093 .cindex "expansion" "operators"
10094 For expansion items that perform transformations on a single argument string,
10095 the &"operator"& notation is used because it is simpler and uses fewer braces.
10096 The substring is first expanded before the operation is applied to it. The
10097 following operations can be performed:
10098
10099 .vlist
10100 .vitem &*${address:*&<&'string'&>&*}*&
10101 .cindex "expansion" "RFC 2822 address handling"
10102 .cindex "&%address%& expansion item"
10103 The string is interpreted as an RFC 2822 address, as it might appear in a
10104 header line, and the effective address is extracted from it. If the string does
10105 not parse successfully, the result is empty.
10106
10107
10108 .vitem &*${addresses:*&<&'string'&>&*}*&
10109 .cindex "expansion" "RFC 2822 address handling"
10110 .cindex "&%addresses%& expansion item"
10111 The string (after expansion) is interpreted as a list of addresses in RFC
10112 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10113 operative address (&'local-part@domain'&) is extracted from each item, and the
10114 result of the expansion is a colon-separated list, with appropriate
10115 doubling of colons should any happen to be present in the email addresses.
10116 Syntactically invalid RFC2822 address items are omitted from the output.
10117
10118 It is possible to specify a character other than colon for the output
10119 separator by starting the string with > followed by the new separator
10120 character. For example:
10121 .code
10122 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10123 .endd
10124 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10125 first, so if the expanded string starts with >, it may change the output
10126 separator unintentionally. This can be avoided by setting the output
10127 separator explicitly:
10128 .code
10129 ${addresses:>:$h_from:}
10130 .endd
10131
10132 Compare the &*address*& (singular)
10133 expansion item, which extracts the working address from a single RFC2822
10134 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10135 processing lists.
10136
10137 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10138 a strict interpretation of header line formatting.  Exim parses the bare,
10139 unquoted portion of an email address and if it finds a comma, treats it as an
10140 email address separator. For the example header line:
10141 .code
10142 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10143 .endd
10144 The first example below demonstrates that Q-encoded email addresses are parsed
10145 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10146 It does not see the comma because it's still encoded as "=2C".  The second
10147 example below is passed the contents of &`$header_from:`&, meaning it gets
10148 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10149 The third example shows that the presence of a comma is skipped when it is
10150 quoted.
10151 .code
10152 # exim -be '${addresses:From: \
10153 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10154 user@example.com
10155 # exim -be '${addresses:From: Last, First <user@example.com>}'
10156 Last:user@example.com
10157 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10158 user@example.com
10159 .endd
10160
10161 .vitem &*${base32:*&<&'digits'&>&*}*&
10162 .cindex "&%base32%& expansion item"
10163 .cindex "expansion" "conversion to base 32"
10164 The string must consist entirely of decimal digits. The number is converted to
10165 base 32 and output as a (empty, for zero) string of characters.
10166 Only lowercase letters are used.
10167
10168 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10169 .cindex "&%base32d%& expansion item"
10170 .cindex "expansion" "conversion to base 32"
10171 The string must consist entirely of base-32 digits.
10172 The number is converted to decimal and output as a string.
10173
10174 .vitem &*${base62:*&<&'digits'&>&*}*&
10175 .cindex "&%base62%& expansion item"
10176 .cindex "expansion" "conversion to base 62"
10177 The string must consist entirely of decimal digits. The number is converted to
10178 base 62 and output as a string of six characters, including leading zeros. In
10179 the few operating environments where Exim uses base 36 instead of base 62 for
10180 its message identifiers (because those systems do not have case-sensitive file
10181 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10182 be absolutely clear: this is &'not'& base64 encoding.
10183
10184 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10185 .cindex "&%base62d%& expansion item"
10186 .cindex "expansion" "conversion to base 62"
10187 The string must consist entirely of base-62 digits, or, in operating
10188 environments where Exim uses base 36 instead of base 62 for its message
10189 identifiers, base-36 digits. The number is converted to decimal and output as a
10190 string.
10191
10192 .vitem &*${base64:*&<&'string'&>&*}*&
10193 .cindex "expansion" "base64 encoding"
10194 .cindex "base64 encoding" "in string expansion"
10195 .cindex "&%base64%& expansion item"
10196 .cindex certificate "base64 of DER"
10197 This operator converts a string into one that is base64 encoded.
10198
10199 If the string is a single variable of type certificate,
10200 returns the base64 encoding of the DER form of the certificate.
10201
10202
10203 .vitem &*${base64d:*&<&'string'&>&*}*&
10204 .cindex "expansion" "base64 decoding"
10205 .cindex "base64 decoding" "in string expansion"
10206 .cindex "&%base64d%& expansion item"
10207 This operator converts a base64-encoded string into the un-coded form.
10208
10209
10210 .vitem &*${domain:*&<&'string'&>&*}*&
10211 .cindex "domain" "extraction"
10212 .cindex "expansion" "domain extraction"
10213 The string is interpreted as an RFC 2822 address and the domain is extracted
10214 from it. If the string does not parse successfully, the result is empty.
10215
10216
10217 .vitem &*${escape:*&<&'string'&>&*}*&
10218 .cindex "expansion" "escaping non-printing characters"
10219 .cindex "&%escape%& expansion item"
10220 If the string contains any non-printing characters, they are converted to
10221 escape sequences starting with a backslash. Whether characters with the most
10222 significant bit set (so-called &"8-bit characters"&) count as printing or not
10223 is controlled by the &%print_topbitchars%& option.
10224
10225 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10226 .cindex "expansion" "escaping 8-bit characters"
10227 .cindex "&%escape8bit%& expansion item"
10228 If the string contains and characters with the most significant bit set,
10229 they are converted to escape sequences starting with a backslash.
10230 Backslashes and DEL characters are also converted.
10231
10232
10233 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10234 .cindex "expansion" "expression evaluation"
10235 .cindex "expansion" "arithmetic expression"
10236 .cindex "&%eval%& expansion item"
10237 These items supports simple arithmetic and bitwise logical operations in
10238 expansion strings. The string (after expansion) must be a conventional
10239 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10240 logical operators, and parentheses. All operations are carried out using
10241 integer arithmetic. The operator priorities are as follows (the same as in the
10242 C programming language):
10243 .table2 70pt 300pt
10244 .irow &'highest:'& "not (~), negate (-)"
10245 .irow ""   "multiply (*), divide (/), remainder (%)"
10246 .irow ""   "plus (+), minus (-)"
10247 .irow ""   "shift-left (<<), shift-right (>>)"
10248 .irow ""   "and (&&)"
10249 .irow ""   "xor (^)"
10250 .irow &'lowest:'&  "or (|)"
10251 .endtable
10252 Binary operators with the same priority are evaluated from left to right. White
10253 space is permitted before or after operators.
10254
10255 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10256 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10257 decimal, even if they start with a leading zero; hexadecimal numbers are not
10258 permitted. This can be useful when processing numbers extracted from dates or
10259 times, which often do have leading zeros.
10260
10261 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10262 or 1024*1024*1024,
10263 respectively. Negative numbers are supported. The result of the computation is
10264 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10265
10266 .display
10267 &`${eval:1+1}            `&  yields 2
10268 &`${eval:1+2*3}          `&  yields 7
10269 &`${eval:(1+2)*3}        `&  yields 9
10270 &`${eval:2+42%5}         `&  yields 4
10271 &`${eval:0xc&amp;5}          `&  yields 4
10272 &`${eval:0xc|5}          `&  yields 13
10273 &`${eval:0xc^5}          `&  yields 9
10274 &`${eval:0xc>>1}         `&  yields 6
10275 &`${eval:0xc<<1}         `&  yields 24
10276 &`${eval:~255&amp;0x1234}    `&  yields 4608
10277 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10278 .endd
10279
10280 As a more realistic example, in an ACL you might have
10281 .code
10282 deny   message = Too many bad recipients
10283        condition =                    \
10284          ${if and {                   \
10285            {>{$rcpt_count}{10}}       \
10286            {                          \
10287            <                          \
10288              {$recipients_count}      \
10289              {${eval:$rcpt_count/2}}  \
10290            }                          \
10291          }{yes}{no}}
10292 .endd
10293 The condition is true if there have been more than 10 RCPT commands and
10294 fewer than half of them have resulted in a valid recipient.
10295
10296
10297 .vitem &*${expand:*&<&'string'&>&*}*&
10298 .cindex "expansion" "re-expansion of substring"
10299 The &%expand%& operator causes a string to be expanded for a second time. For
10300 example,
10301 .code
10302 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10303 .endd
10304 first looks up a string in a file while expanding the operand for &%expand%&,
10305 and then re-expands what it has found.
10306
10307
10308 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10309 .cindex "Unicode"
10310 .cindex "UTF-8" "conversion from"
10311 .cindex "expansion" "UTF-8 conversion"
10312 .cindex "&%from_utf8%& expansion item"
10313 The world is slowly moving towards Unicode, although there are no standards for
10314 email yet. However, other applications (including some databases) are starting
10315 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10316 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10317 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10318 the result is an undefined sequence of bytes.
10319
10320 Unicode code points with values less than 256 are compatible with ASCII and
10321 ISO-8859-1 (also known as Latin-1).
10322 For example, character 169 is the copyright symbol in both cases, though the
10323 way it is encoded is different. In UTF-8, more than one byte is needed for
10324 characters with code values greater than 127, whereas ISO-8859-1 is a
10325 single-byte encoding (but thereby limited to 256 characters). This makes
10326 translation from UTF-8 to ISO-8859-1 straightforward.
10327
10328
10329 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10330 .cindex "hash function" "textual"
10331 .cindex "expansion" "textual hash"
10332 The &%hash%& operator is a simpler interface to the hashing function that can
10333 be used when the two parameters are fixed numbers (as opposed to strings that
10334 change when expanded). The effect is the same as
10335 .code
10336 ${hash{<n>}{<m>}{<string>}}
10337 .endd
10338 See the description of the general &%hash%& item above for details. The
10339 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10340
10341
10342
10343 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10344 .cindex "base64 encoding" "conversion from hex"
10345 .cindex "expansion" "hex to base64"
10346 .cindex "&%hex2b64%& expansion item"
10347 This operator converts a hex string into one that is base64 encoded. This can
10348 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10349
10350
10351
10352 .vitem &*${hexquote:*&<&'string'&>&*}*&
10353 .cindex "quoting" "hex-encoded unprintable characters"
10354 .cindex "&%hexquote%& expansion item"
10355 This operator converts non-printable characters in a string into a hex
10356 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10357 as is, and other byte values are converted to &`\xNN`&, for example a
10358 byte value 127 is converted to &`\x7f`&.
10359
10360
10361 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10362 .cindex "&%ipv6denorm%& expansion item"
10363 .cindex "IP address" normalisation
10364 This expands an IPv6 address to a full eight-element colon-separated set
10365 of hex digits including leading zeroes.
10366 A trailing ipv4-style dotted-decimal set is converted to hex.
10367 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10368
10369 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10370 .cindex "&%ipv6norm%& expansion item"
10371 .cindex "IP address" normalisation
10372 .cindex "IP address" "canonical form"
10373 This converts an IPv6 address to canonical form.
10374 Leading zeroes of groups are omitted, and the longest
10375 set of zero-valued groups is replaced with a double colon.
10376 A trailing ipv4-style dotted-decimal set is converted to hex.
10377 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10378
10379
10380 .vitem &*${lc:*&<&'string'&>&*}*&
10381 .cindex "case forcing in strings"
10382 .cindex "string" "case forcing"
10383 .cindex "lower casing"
10384 .cindex "expansion" "case forcing"
10385 .cindex "&%lc%& expansion item"
10386 This forces the letters in the string into lower-case, for example:
10387 .code
10388 ${lc:$local_part}
10389 .endd
10390
10391 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10392 .cindex "expansion" "string truncation"
10393 .cindex "&%length%& expansion item"
10394 The &%length%& operator is a simpler interface to the &%length%& function that
10395 can be used when the parameter is a fixed number (as opposed to a string that
10396 changes when expanded). The effect is the same as
10397 .code
10398 ${length{<number>}{<string>}}
10399 .endd
10400 See the description of the general &%length%& item above for details. Note that
10401 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10402 when &%length%& is used as an operator.
10403
10404
10405 .vitem &*${listcount:*&<&'string'&>&*}*&
10406 .cindex "expansion" "list item count"
10407 .cindex "list" "item count"
10408 .cindex "list" "count of items"
10409 .cindex "&%listcount%& expansion item"
10410 The string is interpreted as a list and the number of items is returned.
10411
10412
10413 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10414 .cindex "expansion" "named list"
10415 .cindex "&%listnamed%& expansion item"
10416 The name is interpreted as a named list and the content of the list is returned,
10417 expanding any referenced lists, re-quoting as needed for colon-separation.
10418 If the optional type is given it must be one of "a", "d", "h" or "l"
10419 and selects address-, domain-, host- or localpart- lists to search among respectively.
10420 Otherwise all types are searched in an undefined order and the first
10421 matching list is returned.
10422
10423
10424 .vitem &*${local_part:*&<&'string'&>&*}*&
10425 .cindex "expansion" "local part extraction"
10426 .cindex "&%local_part%& expansion item"
10427 The string is interpreted as an RFC 2822 address and the local part is
10428 extracted from it. If the string does not parse successfully, the result is
10429 empty.
10430
10431
10432 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10433 .cindex "masked IP address"
10434 .cindex "IP address" "masking"
10435 .cindex "CIDR notation"
10436 .cindex "expansion" "IP address masking"
10437 .cindex "&%mask%& expansion item"
10438 If the form of the string to be operated on is not an IP address followed by a
10439 slash and an integer (that is, a network address in CIDR notation), the
10440 expansion fails. Otherwise, this operator converts the IP address to binary,
10441 masks off the least significant bits according to the bit count, and converts
10442 the result back to text, with mask appended. For example,
10443 .code
10444 ${mask:10.111.131.206/28}
10445 .endd
10446 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10447 be mostly used for looking up masked addresses in files, the result for an IPv6
10448 address uses dots to separate components instead of colons, because colon
10449 terminates a key string in lsearch files. So, for example,
10450 .code
10451 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10452 .endd
10453 returns the string
10454 .code
10455 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10456 .endd
10457 Letters in IPv6 addresses are always output in lower case.
10458
10459
10460 .vitem &*${md5:*&<&'string'&>&*}*&
10461 .cindex "MD5 hash"
10462 .cindex "expansion" "MD5 hash"
10463 .cindex certificate fingerprint
10464 .cindex "&%md5%& expansion item"
10465 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10466 as a 32-digit hexadecimal number, in which any letters are in lower case.
10467
10468 If the string is a single variable of type certificate,
10469 returns the MD5 hash fingerprint of the certificate.
10470
10471
10472 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10473 .cindex "expansion" "numeric hash"
10474 .cindex "hash function" "numeric"
10475 The &%nhash%& operator is a simpler interface to the numeric hashing function
10476 that can be used when the two parameters are fixed numbers (as opposed to
10477 strings that change when expanded). The effect is the same as
10478 .code
10479 ${nhash{<n>}{<m>}{<string>}}
10480 .endd
10481 See the description of the general &%nhash%& item above for details.
10482
10483
10484 .vitem &*${quote:*&<&'string'&>&*}*&
10485 .cindex "quoting" "in string expansions"
10486 .cindex "expansion" "quoting"
10487 .cindex "&%quote%& expansion item"
10488 The &%quote%& operator puts its argument into double quotes if it
10489 is an empty string or
10490 contains anything other than letters, digits, underscores, dots, and hyphens.
10491 Any occurrences of double quotes and backslashes are escaped with a backslash.
10492 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10493 respectively For example,
10494 .code
10495 ${quote:ab"*"cd}
10496 .endd
10497 becomes
10498 .code
10499 "ab\"*\"cd"
10500 .endd
10501 The place where this is useful is when the argument is a substitution from a
10502 variable or a message header.
10503
10504 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10505 .cindex "&%quote_local_part%& expansion item"
10506 This operator is like &%quote%&, except that it quotes the string only if
10507 required to do so by the rules of RFC 2822 for quoting local parts. For
10508 example, a plus sign would not cause quoting (but it would for &%quote%&).
10509 If you are creating a new email address from the contents of &$local_part$&
10510 (or any other unknown data), you should always use this operator.
10511
10512
10513 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10514 .cindex "quoting" "lookup-specific"
10515 This operator applies lookup-specific quoting rules to the string. Each
10516 query-style lookup type has its own quoting rules which are described with
10517 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10518 .code
10519 ${quote_ldap:two * two}
10520 .endd
10521 returns
10522 .code
10523 two%20%5C2A%20two
10524 .endd
10525 For single-key lookup types, no quoting is ever necessary and this operator
10526 yields an unchanged string.
10527
10528
10529 .vitem &*${randint:*&<&'n'&>&*}*&
10530 .cindex "random number"
10531 This operator returns a somewhat random number which is less than the
10532 supplied number and is at least 0.  The quality of this randomness depends
10533 on how Exim was built; the values are not suitable for keying material.
10534 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10535 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10536 for versions of GnuTLS with that function.
10537 Otherwise, the implementation may be arc4random(), random() seeded by
10538 srandomdev() or srandom(), or a custom implementation even weaker than
10539 random().
10540
10541
10542 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10543 .cindex "expansion" "IP address"
10544 This operator reverses an IP address; for IPv4 addresses, the result is in
10545 dotted-quad decimal form, while for IPv6 addresses the result is in
10546 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10547 for DNS.  For example,
10548 .code
10549 ${reverse_ip:192.0.2.4}
10550 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10551 .endd
10552 returns
10553 .code
10554 4.2.0.192
10555 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
10556 .endd
10557
10558
10559 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10560 .cindex "expansion" "RFC 2047"
10561 .cindex "RFC 2047" "expansion operator"
10562 .cindex "&%rfc2047%& expansion item"
10563 This operator encodes text according to the rules of RFC 2047. This is an
10564 encoding that is used in header lines to encode non-ASCII characters. It is
10565 assumed that the input string is in the encoding specified by the
10566 &%headers_charset%& option, which gets its default at build time. If the string
10567 contains only characters in the range 33&--126, and no instances of the
10568 characters
10569 .code
10570 ? = ( ) < > @ , ; : \ " . [ ] _
10571 .endd
10572 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10573 string, using as many &"encoded words"& as necessary to encode all the
10574 characters.
10575
10576
10577 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10578 .cindex "expansion" "RFC 2047"
10579 .cindex "RFC 2047" "decoding"
10580 .cindex "&%rfc2047d%& expansion item"
10581 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10582 bytes are replaced by question marks. Characters are converted into the
10583 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10584 not recognized unless &%check_rfc2047_length%& is set false.
10585
10586 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10587 access a header line, RFC 2047 decoding is done automatically. You do not need
10588 to use this operator as well.
10589
10590
10591
10592 .vitem &*${rxquote:*&<&'string'&>&*}*&
10593 .cindex "quoting" "in regular expressions"
10594 .cindex "regular expressions" "quoting"
10595 .cindex "&%rxquote%& expansion item"
10596 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10597 characters in its argument. This is useful when substituting the values of
10598 variables or headers inside regular expressions.
10599
10600
10601 .vitem &*${sha1:*&<&'string'&>&*}*&
10602 .cindex "SHA-1 hash"
10603 .cindex "expansion" "SHA-1 hashing"
10604 .cindex certificate fingerprint
10605 .cindex "&%sha1%& expansion item"
10606 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10607 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10608
10609 If the string is a single variable of type certificate,
10610 returns the SHA-1 hash fingerprint of the certificate.
10611
10612
10613 .vitem &*${sha256:*&<&'string'&>&*}*&
10614 .cindex "SHA-256 hash"
10615 .cindex certificate fingerprint
10616 .cindex "expansion" "SHA-256 hashing"
10617 .cindex "&%sha256%& expansion item"
10618 The &%sha256%& operator computes the SHA-256 hash value of the string
10619 and returns
10620 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10621
10622 If the string is a single variable of type certificate,
10623 returns the SHA-256 hash fingerprint of the certificate.
10624
10625
10626 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10627        &*${sha3_<n>:*&<&'string'&>&*}*&
10628 .cindex "SHA3 hash"
10629 .cindex "expansion" "SHA3 hashing"
10630 .cindex "&%sha3%& expansion item"
10631 The &%sha3%& operator computes the SHA3-256 hash value of the string
10632 and returns
10633 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10634
10635 If a number is appended, separated by an underbar, it specifies
10636 the output length.  Values of 224, 256, 384 and 512 are accepted;
10637 with 256 being the default.
10638
10639 The &%sha3%& expansion item is only supported if Exim has been
10640 compiled with GnuTLS 3.5.0 or later.
10641
10642
10643 .vitem &*${stat:*&<&'string'&>&*}*&
10644 .cindex "expansion" "statting a file"
10645 .cindex "file" "extracting characteristics"
10646 .cindex "&%stat%& expansion item"
10647 The string, after expansion, must be a file path. A call to the &[stat()]&
10648 function is made for this path. If &[stat()]& fails, an error occurs and the
10649 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10650 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10651 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10652 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10653 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10654 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10655 can extract individual fields using the &%extract%& expansion item.
10656
10657 The use of the &%stat%& expansion in users' filter files can be locked out by
10658 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10659 systems for files larger than 2GB.
10660
10661 .vitem &*${str2b64:*&<&'string'&>&*}*&
10662 .cindex "&%str2b64%& expansion item"
10663 Now deprecated, a synonym for the &%base64%& expansion operator.
10664
10665
10666
10667 .vitem &*${strlen:*&<&'string'&>&*}*&
10668 .cindex "expansion" "string length"
10669 .cindex "string" "length in expansion"
10670 .cindex "&%strlen%& expansion item"
10671 The item is replace by the length of the expanded string, expressed as a
10672 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10673
10674
10675 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10676 .cindex "&%substr%& expansion item"
10677 .cindex "substring extraction"
10678 .cindex "expansion" "substring expansion"
10679 The &%substr%& operator is a simpler interface to the &%substr%& function that
10680 can be used when the two parameters are fixed numbers (as opposed to strings
10681 that change when expanded). The effect is the same as
10682 .code
10683 ${substr{<start>}{<length>}{<string>}}
10684 .endd
10685 See the description of the general &%substr%& item above for details. The
10686 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10687
10688 .vitem &*${time_eval:*&<&'string'&>&*}*&
10689 .cindex "&%time_eval%& expansion item"
10690 .cindex "time interval" "decoding"
10691 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10692 seconds.
10693
10694 .vitem &*${time_interval:*&<&'string'&>&*}*&
10695 .cindex "&%time_interval%& expansion item"
10696 .cindex "time interval" "formatting"
10697 The argument (after sub-expansion) must be a sequence of decimal digits that
10698 represents an interval of time as a number of seconds. It is converted into a
10699 number of larger units and output in Exim's normal time format, for example,
10700 &`1w3d4h2m6s`&.
10701
10702 .vitem &*${uc:*&<&'string'&>&*}*&
10703 .cindex "case forcing in strings"
10704 .cindex "string" "case forcing"
10705 .cindex "upper casing"
10706 .cindex "expansion" "case forcing"
10707 .cindex "&%uc%& expansion item"
10708 This forces the letters in the string into upper-case.
10709
10710 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10711 .cindex "correction of invalid utf-8 sequences in strings"
10712 .cindex "utf-8" "utf-8 sequences"
10713 .cindex "incorrect utf-8"
10714 .cindex "expansion" "utf-8 forcing"
10715 .cindex "&%utf8clean%& expansion item"
10716 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10717
10718 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10719        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10720        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10721        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10722 .cindex expansion UTF-8
10723 .cindex UTF-8 expansion
10724 .cindex EAI
10725 .cindex internationalisation
10726 .cindex "&%utf8_domain_to_alabel%& expansion item"
10727 .cindex "&%utf8_domain_from_alabel%& expansion item"
10728 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10729 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10730 These convert EAI mail name components between UTF-8 and a-label forms.
10731 For information on internationalisation support see &<<SECTi18nMTA>>&.
10732 .endlist
10733
10734
10735
10736
10737
10738
10739 .section "Expansion conditions" "SECTexpcond"
10740 .scindex IIDexpcond "expansion" "conditions"
10741 The following conditions are available for testing by the &%${if%& construct
10742 while expanding strings:
10743
10744 .vlist
10745 .vitem &*!*&<&'condition'&>
10746 .cindex "expansion" "negating a condition"
10747 .cindex "negation" "in expansion condition"
10748 Preceding any condition with an exclamation mark negates the result of the
10749 condition.
10750
10751 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10752 .cindex "numeric comparison"
10753 .cindex "expansion" "numeric comparison"
10754 There are a number of symbolic operators for doing numeric comparisons. They
10755 are:
10756 .display
10757 &`=   `&   equal
10758 &`==  `&   equal
10759 &`>   `&   greater
10760 &`>=  `&   greater or equal
10761 &`<   `&   less
10762 &`<=  `&   less or equal
10763 .endd
10764 For example:
10765 .code
10766 ${if >{$message_size}{10M} ...
10767 .endd
10768 Note that the general negation operator provides for inequality testing. The
10769 two strings must take the form of optionally signed decimal integers,
10770 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10771 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10772 As a special case, the numerical value of an empty string is taken as
10773 zero.
10774
10775 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10776 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10777 10M, not if 10M is larger than &$message_size$&.
10778
10779
10780 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10781         {*&<&'arg2'&>&*}...}*&
10782 .cindex "expansion" "calling an acl"
10783 .cindex "&%acl%&" "expansion condition"
10784 The name and zero to nine argument strings are first expanded separately.  The expanded
10785 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10786 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10787 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10788 and may use the variables; if another acl expansion is used the values
10789 are restored after it returns.  If the ACL sets
10790 a value using a "message =" modifier the variable $value becomes
10791 the result of the expansion, otherwise it is empty.
10792 If the ACL returns accept the condition is true; if deny, false.
10793 If the ACL returns defer the result is a forced-fail.
10794
10795 .vitem &*bool&~{*&<&'string'&>&*}*&
10796 .cindex "expansion" "boolean parsing"
10797 .cindex "&%bool%& expansion condition"
10798 This condition turns a string holding a true or false representation into
10799 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10800 (case-insensitively); also integer numbers map to true if non-zero,
10801 false if zero.
10802 An empty string is treated as false.
10803 Leading and trailing whitespace is ignored;
10804 thus a string consisting only of whitespace is false.
10805 All other string values will result in expansion failure.
10806
10807 When combined with ACL variables, this expansion condition will let you
10808 make decisions in one place and act on those decisions in another place.
10809 For example:
10810 .code
10811 ${if bool{$acl_m_privileged_sender} ...
10812 .endd
10813
10814
10815 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10816 .cindex "expansion" "boolean parsing"
10817 .cindex "&%bool_lax%& expansion condition"
10818 Like &%bool%&, this condition turns a string into a boolean state.  But
10819 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10820 loose definition that the Router &%condition%& option uses.  The empty string
10821 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10822 true.  Leading and trailing whitespace is ignored.
10823
10824 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10825
10826 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10827 .cindex "expansion" "encrypted comparison"
10828 .cindex "encrypted strings, comparing"
10829 .cindex "&%crypteq%& expansion condition"
10830 This condition is included in the Exim binary if it is built to support any
10831 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10832 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10833 included in the binary.
10834
10835 The &%crypteq%& condition has two arguments. The first is encrypted and
10836 compared against the second, which is already encrypted. The second string may
10837 be in the LDAP form for storing encrypted strings, which starts with the
10838 encryption type in curly brackets, followed by the data. If the second string
10839 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10840 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10841 Typically this will be a field from a password file. An example of an encrypted
10842 string in LDAP form is:
10843 .code
10844 {md5}CY9rzUYh03PK3k6DJie09g==
10845 .endd
10846 If such a string appears directly in an expansion, the curly brackets have to
10847 be quoted, because they are part of the expansion syntax. For example:
10848 .code
10849 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10850 .endd
10851 The following encryption types (whose names are matched case-independently) are
10852 supported:
10853
10854 .ilist
10855 .cindex "MD5 hash"
10856 .cindex "base64 encoding" "in encrypted password"
10857 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10858 printable characters to compare with the remainder of the second string. If the
10859 length of the comparison string is 24, Exim assumes that it is base64 encoded
10860 (as in the above example). If the length is 32, Exim assumes that it is a
10861 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10862 comparison fails.
10863
10864 .next
10865 .cindex "SHA-1 hash"
10866 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10867 printable characters to compare with the remainder of the second string. If the
10868 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10869 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10870 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10871
10872 .next
10873 .cindex "&[crypt()]&"
10874 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10875 only the first eight characters of the password. However, in modern operating
10876 systems this is no longer true, and in many cases the entire password is used,
10877 whatever its length.
10878
10879 .next
10880 .cindex "&[crypt16()]&"
10881 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10882 use up to 16 characters of the password in some operating systems. Again, in
10883 modern operating systems, more characters may be used.
10884 .endlist
10885 Exim has its own version of &[crypt16()]&, which is just a double call to
10886 &[crypt()]&. For operating systems that have their own version, setting
10887 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10888 operating system version instead of its own. This option is set by default in
10889 the OS-dependent &_Makefile_& for those operating systems that are known to
10890 support &[crypt16()]&.
10891
10892 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10893 it was not using the same algorithm as some operating systems' versions. It
10894 turns out that as well as &[crypt16()]& there is a function called
10895 &[bigcrypt()]& in some operating systems. This may or may not use the same
10896 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10897
10898 However, since there is now a move away from the traditional &[crypt()]&
10899 functions towards using SHA1 and other algorithms, tidying up this area of
10900 Exim is seen as very low priority.
10901
10902 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10903 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10904 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10905 default is &`{crypt}`&. Whatever the default, you can always use either
10906 function by specifying it explicitly in curly brackets.
10907
10908 .vitem &*def:*&<&'variable&~name'&>
10909 .cindex "expansion" "checking for empty variable"
10910 .cindex "&%def%& expansion condition"
10911 The &%def%& condition must be followed by the name of one of the expansion
10912 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10913 variable does not contain the empty string. For example:
10914 .code
10915 ${if def:sender_ident {from $sender_ident}}
10916 .endd
10917 Note that the variable name is given without a leading &%$%& character. If the
10918 variable does not exist, the expansion fails.
10919
10920 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10921         &~&*def:h_*&<&'header&~name'&>&*:*&"
10922 .cindex "expansion" "checking header line existence"
10923 This condition is true if a message is being processed and the named header
10924 exists in the message. For example,
10925 .code
10926 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10927 .endd
10928 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10929 the header name must be terminated by a colon if white space does not follow.
10930
10931 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10932        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10933 .cindex "string" "comparison"
10934 .cindex "expansion" "string comparison"
10935 .cindex "&%eq%& expansion condition"
10936 .cindex "&%eqi%& expansion condition"
10937 The two substrings are first expanded. The condition is true if the two
10938 resulting strings are identical. For &%eq%& the comparison includes the case of
10939 letters, whereas for &%eqi%& the comparison is case-independent.
10940
10941 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10942 .cindex "expansion" "file existence test"
10943 .cindex "file" "existence test"
10944 .cindex "&%exists%&, expansion condition"
10945 The substring is first expanded and then interpreted as an absolute path. The
10946 condition is true if the named file (or directory) exists. The existence test
10947 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10948 users' filter files may be locked out by the system administrator.
10949
10950 .vitem &*first_delivery*&
10951 .cindex "delivery" "first"
10952 .cindex "first delivery"
10953 .cindex "expansion" "first delivery test"
10954 .cindex "&%first_delivery%& expansion condition"
10955 This condition, which has no data, is true during a message's first delivery
10956 attempt. It is false during any subsequent delivery attempts.
10957
10958
10959 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10960        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10961 .cindex "list" "iterative conditions"
10962 .cindex "expansion" "&*forall*& condition"
10963 .cindex "expansion" "&*forany*& condition"
10964 .vindex "&$item$&"
10965 These conditions iterate over a list. The first argument is expanded to form
10966 the list. By default, the list separator is a colon, but it can be changed by
10967 the normal method. The second argument is interpreted as a condition that is to
10968 be applied to each item in the list in turn. During the interpretation of the
10969 condition, the current list item is placed in a variable called &$item$&.
10970 .ilist
10971 For &*forany*&, interpretation stops if the condition is true for any item, and
10972 the result of the whole condition is true. If the condition is false for all
10973 items in the list, the overall condition is false.
10974 .next
10975 For &*forall*&, interpretation stops if the condition is false for any item,
10976 and the result of the whole condition is false. If the condition is true for
10977 all items in the list, the overall condition is true.
10978 .endlist
10979 Note that negation of &*forany*& means that the condition must be false for all
10980 items for the overall condition to succeed, and negation of &*forall*& means
10981 that the condition must be false for at least one item. In this example, the
10982 list separator is changed to a comma:
10983 .code
10984 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10985 .endd
10986 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10987 being processed, to enable these expansion items to be nested.
10988
10989 To scan a named list, expand it with the &*listnamed*& operator.
10990
10991
10992 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10993        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10994 .cindex "string" "comparison"
10995 .cindex "expansion" "string comparison"
10996 .cindex "&%ge%& expansion condition"
10997 .cindex "&%gei%& expansion condition"
10998 The two substrings are first expanded. The condition is true if the first
10999 string is lexically greater than or equal to the second string. For &%ge%& the
11000 comparison includes the case of letters, whereas for &%gei%& the comparison is
11001 case-independent.
11002
11003 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11004        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11005 .cindex "string" "comparison"
11006 .cindex "expansion" "string comparison"
11007 .cindex "&%gt%& expansion condition"
11008 .cindex "&%gti%& expansion condition"
11009 The two substrings are first expanded. The condition is true if the first
11010 string is lexically greater than the second string. For &%gt%& the comparison
11011 includes the case of letters, whereas for &%gti%& the comparison is
11012 case-independent.
11013
11014 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11015        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11016 .cindex "string" "comparison"
11017 .cindex "list" "iterative conditions"
11018 Both strings are expanded; the second string is treated as a list of simple
11019 strings; if the first string is a member of the second, then the condition
11020 is true.
11021
11022 These are simpler to use versions of the more powerful &*forany*& condition.
11023 Examples, and the &*forany*& equivalents:
11024 .code
11025 ${if inlist{needle}{foo:needle:bar}}
11026   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11027 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11028   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11029 .endd
11030
11031 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11032        &*isip4&~{*&<&'string'&>&*}*& &&&
11033        &*isip6&~{*&<&'string'&>&*}*&
11034 .cindex "IP address" "testing string format"
11035 .cindex "string" "testing for IP address"
11036 .cindex "&%isip%& expansion condition"
11037 .cindex "&%isip4%& expansion condition"
11038 .cindex "&%isip6%& expansion condition"
11039 The substring is first expanded, and then tested to see if it has the form of
11040 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11041 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11042
11043 For an IPv4 address, the test is for four dot-separated components, each of
11044 which consists of from one to three digits. For an IPv6 address, up to eight
11045 colon-separated components are permitted, each containing from one to four
11046 hexadecimal digits. There may be fewer than eight components if an empty
11047 component (adjacent colons) is present. Only one empty component is permitted.
11048
11049 &*Note*&: The checks used to be just on the form of the address; actual numerical
11050 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11051 check.
11052 This is no longer the case.
11053
11054 The main use of these tests is to distinguish between IP addresses and
11055 host names, or between IPv4 and IPv6 addresses. For example, you could use
11056 .code
11057 ${if isip4{$sender_host_address}...
11058 .endd
11059 to test which IP version an incoming SMTP connection is using.
11060
11061 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11062 .cindex "LDAP" "use for authentication"
11063 .cindex "expansion" "LDAP authentication test"
11064 .cindex "&%ldapauth%& expansion condition"
11065 This condition supports user authentication using LDAP. See section
11066 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11067 queries. For this use, the query must contain a user name and password. The
11068 query itself is not used, and can be empty. The condition is true if the
11069 password is not empty, and the user name and password are accepted by the LDAP
11070 server. An empty password is rejected without calling LDAP because LDAP binds
11071 with an empty password are considered anonymous regardless of the username, and
11072 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11073 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11074 this can be used.
11075
11076
11077 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11078        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11079 .cindex "string" "comparison"
11080 .cindex "expansion" "string comparison"
11081 .cindex "&%le%& expansion condition"
11082 .cindex "&%lei%& expansion condition"
11083 The two substrings are first expanded. The condition is true if the first
11084 string is lexically less than or equal to the second string. For &%le%& the
11085 comparison includes the case of letters, whereas for &%lei%& the comparison is
11086 case-independent.
11087
11088 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11089        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11090 .cindex "string" "comparison"
11091 .cindex "expansion" "string comparison"
11092 .cindex "&%lt%& expansion condition"
11093 .cindex "&%lti%& expansion condition"
11094 The two substrings are first expanded. The condition is true if the first
11095 string is lexically less than the second string. For &%lt%& the comparison
11096 includes the case of letters, whereas for &%lti%& the comparison is
11097 case-independent.
11098
11099
11100 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11101 .cindex "expansion" "regular expression comparison"
11102 .cindex "regular expressions" "match in expanded string"
11103 .cindex "&%match%& expansion condition"
11104 The two substrings are first expanded. The second is then treated as a regular
11105 expression and applied to the first. Because of the pre-expansion, if the
11106 regular expression contains dollar, or backslash characters, they must be
11107 escaped. Care must also be taken if the regular expression contains braces
11108 (curly brackets). A closing brace must be escaped so that it is not taken as a
11109 premature termination of <&'string2'&>. The easiest approach is to use the
11110 &`\N`& feature to disable expansion of the regular expression.
11111 For example,
11112 .code
11113 ${if match {$local_part}{\N^\d{3}\N} ...
11114 .endd
11115 If the whole expansion string is in double quotes, further escaping of
11116 backslashes is also required.
11117
11118 The condition is true if the regular expression match succeeds.
11119 The regular expression is not required to begin with a circumflex
11120 metacharacter, but if there is no circumflex, the expression is not anchored,
11121 and it may match anywhere in the subject, not just at the start. If you want
11122 the pattern to match at the end of the subject, you must include the &`$`&
11123 metacharacter at an appropriate point.
11124
11125 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11126 At the start of an &%if%& expansion the values of the numeric variable
11127 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11128 succeeds causes them to be reset to the substrings of that condition and they
11129 will have these values during the expansion of the success string. At the end
11130 of the &%if%& expansion, the previous values are restored. After testing a
11131 combination of conditions using &%or%&, the subsequent values of the numeric
11132 variables are those of the condition that succeeded.
11133
11134 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11135 .cindex "&%match_address%& expansion condition"
11136 See &*match_local_part*&.
11137
11138 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11139 .cindex "&%match_domain%& expansion condition"
11140 See &*match_local_part*&.
11141
11142 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11143 .cindex "&%match_ip%& expansion condition"
11144 This condition matches an IP address to a list of IP address patterns. It must
11145 be followed by two argument strings. The first (after expansion) must be an IP
11146 address or an empty string. The second (not expanded) is a restricted host
11147 list that can match only an IP address, not a host name. For example:
11148 .code
11149 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11150 .endd
11151 The specific types of host list item that are permitted in the list are:
11152
11153 .ilist
11154 An IP address, optionally with a CIDR mask.
11155 .next
11156 A single asterisk, which matches any IP address.
11157 .next
11158 An empty item, which matches only if the IP address is empty. This could be
11159 useful for testing for a locally submitted message or one from specific hosts
11160 in a single test such as
11161 . ==== As this is a nested list, any displays it contains must be indented
11162 . ==== as otherwise they are too far to the left. This comment applies to
11163 . ==== the use of xmlto plus fop. There's no problem when formatting with
11164 . ==== sdop, with or without the extra indent.
11165 .code
11166   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11167 .endd
11168 where the first item in the list is the empty string.
11169 .next
11170 The item @[] matches any of the local host's interface addresses.
11171 .next
11172 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11173 even if &`net-`& is not specified. There is never any attempt to turn the IP
11174 address into a host name. The most common type of linear search for
11175 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11176 masks. For example:
11177 .code
11178   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11179 .endd
11180 It is of course possible to use other kinds of lookup, and in such a case, you
11181 do need to specify the &`net-`& prefix if you want to specify a specific
11182 address mask, for example:
11183 .code
11184   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11185 .endd
11186 However, unless you are combining a &%match_ip%& condition with others, it is
11187 just as easy to use the fact that a lookup is itself a condition, and write:
11188 .code
11189   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11190 .endd
11191 .endlist ilist
11192
11193 Note that <&'string2'&> is not itself subject to string expansion, unless
11194 Exim was built with the EXPAND_LISTMATCH_RHS option.
11195
11196 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11197
11198 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11199 .cindex "domain list" "in expansion condition"
11200 .cindex "address list" "in expansion condition"
11201 .cindex "local part" "list, in expansion condition"
11202 .cindex "&%match_local_part%& expansion condition"
11203 This condition, together with &%match_address%& and &%match_domain%&, make it
11204 possible to test domain, address, and local part lists within expansions. Each
11205 condition requires two arguments: an item and a list to match. A trivial
11206 example is:
11207 .code
11208 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11209 .endd
11210 In each case, the second argument may contain any of the allowable items for a
11211 list of the appropriate type. Also, because the second argument
11212 is a standard form of list, it is possible to refer to a named list.
11213 Thus, you can use conditions like this:
11214 .code
11215 ${if match_domain{$domain}{+local_domains}{...
11216 .endd
11217 .cindex "&`+caseful`&"
11218 For address lists, the matching starts off caselessly, but the &`+caseful`&
11219 item can be used, as in all address lists, to cause subsequent items to
11220 have their local parts matched casefully. Domains are always matched
11221 caselessly.
11222
11223 Note that <&'string2'&> is not itself subject to string expansion, unless
11224 Exim was built with the EXPAND_LISTMATCH_RHS option.
11225
11226 &*Note*&: Host lists are &'not'& supported in this way. This is because
11227 hosts have two identities: a name and an IP address, and it is not clear
11228 how to specify cleanly how such a test would work. However, IP addresses can be
11229 matched using &%match_ip%&.
11230
11231 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11232 .cindex "PAM authentication"
11233 .cindex "AUTH" "with PAM"
11234 .cindex "Solaris" "PAM support"
11235 .cindex "expansion" "PAM authentication test"
11236 .cindex "&%pam%& expansion condition"
11237 &'Pluggable Authentication Modules'&
11238 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11239 available in the latest releases of Solaris and in some GNU/Linux
11240 distributions. The Exim support, which is intended for use in conjunction with
11241 the SMTP AUTH command, is available only if Exim is compiled with
11242 .code
11243 SUPPORT_PAM=yes
11244 .endd
11245 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11246 in some releases of GNU/Linux &%-ldl%& is also needed.
11247
11248 The argument string is first expanded, and the result must be a
11249 colon-separated list of strings. Leading and trailing white space is ignored.
11250 The PAM module is initialized with the service name &"exim"& and the user name
11251 taken from the first item in the colon-separated data string (<&'string1'&>).
11252 The remaining items in the data string are passed over in response to requests
11253 from the authentication function. In the simple case there will only be one
11254 request, for a password, so the data consists of just two strings.
11255
11256 There can be problems if any of the strings are permitted to contain colon
11257 characters. In the usual way, these have to be doubled to avoid being taken as
11258 separators. If the data is being inserted from a variable, the &%sg%& expansion
11259 item can be used to double any existing colons. For example, the configuration
11260 of a LOGIN authenticator might contain this setting:
11261 .code
11262 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11263 .endd
11264 For a PLAIN authenticator you could use:
11265 .code
11266 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11267 .endd
11268 In some operating systems, PAM authentication can be done only from a process
11269 running as root. Since Exim is running as the Exim user when receiving
11270 messages, this means that PAM cannot be used directly in those systems.
11271 A patched version of the &'pam_unix'& module that comes with the
11272 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11273 The patched module allows one special uid/gid combination, in addition to root,
11274 to authenticate. If you build the patched module to allow the Exim user and
11275 group, PAM can then be used from an Exim authenticator.
11276
11277
11278 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11279 .cindex "&'pwcheck'& daemon"
11280 .cindex "Cyrus"
11281 .cindex "expansion" "&'pwcheck'& authentication test"
11282 .cindex "&%pwcheck%& expansion condition"
11283 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11284 This is one way of making it possible for passwords to be checked by a process
11285 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11286 deprecated. Its replacement is &'saslauthd'& (see below).
11287
11288 The pwcheck support is not included in Exim by default. You need to specify
11289 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11290 building Exim. For example:
11291 .code
11292 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11293 .endd
11294 You do not need to install the full Cyrus software suite in order to use
11295 the pwcheck daemon. You can compile and install just the daemon alone
11296 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11297 access to the &_/var/pwcheck_& directory.
11298
11299 The &%pwcheck%& condition takes one argument, which must be the user name and
11300 password, separated by a colon. For example, in a LOGIN authenticator
11301 configuration, you might have this:
11302 .code
11303 server_condition = ${if pwcheck{$auth1:$auth2}}
11304 .endd
11305 Again, for a PLAIN authenticator configuration, this would be:
11306 .code
11307 server_condition = ${if pwcheck{$auth2:$auth3}}
11308 .endd
11309 .vitem &*queue_running*&
11310 .cindex "queue runner" "detecting when delivering from"
11311 .cindex "expansion" "queue runner test"
11312 .cindex "&%queue_running%& expansion condition"
11313 This condition, which has no data, is true during delivery attempts that are
11314 initiated by queue runner processes, and false otherwise.
11315
11316
11317 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11318 .cindex "Radius"
11319 .cindex "expansion" "Radius authentication"
11320 .cindex "&%radius%& expansion condition"
11321 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11322 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11323 the Radius client configuration file in order to build Exim with Radius
11324 support.
11325
11326 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11327 library, using the original API. If you are using release 0.4.0 or later of
11328 this library, you need to set
11329 .code
11330 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11331 .endd
11332 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11333 &%libradius%& library that comes with FreeBSD. To do this, set
11334 .code
11335 RADIUS_LIB_TYPE=RADLIB
11336 .endd
11337 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11338 You may also have to supply a suitable setting in EXTRALIBS so that the
11339 Radius library can be found when Exim is linked.
11340
11341 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11342 Radius client library, which calls the Radius server. The condition is true if
11343 the authentication is successful. For example:
11344 .code
11345 server_condition = ${if radius{<arguments>}}
11346 .endd
11347
11348
11349 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11350         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11351 .cindex "&'saslauthd'& daemon"
11352 .cindex "Cyrus"
11353 .cindex "expansion" "&'saslauthd'& authentication test"
11354 .cindex "&%saslauthd%& expansion condition"
11355 This condition supports user authentication using the Cyrus &'saslauthd'&
11356 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11357 Using this daemon is one way of making it possible for passwords to be checked
11358 by a process that is not running as root.
11359
11360 The saslauthd support is not included in Exim by default. You need to specify
11361 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11362 building Exim. For example:
11363 .code
11364 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11365 .endd
11366 You do not need to install the full Cyrus software suite in order to use
11367 the saslauthd daemon. You can compile and install just the daemon alone
11368 from the Cyrus SASL library.
11369
11370 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11371 two are mandatory. For example:
11372 .code
11373 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11374 .endd
11375 The service and the realm are optional (which is why the arguments are enclosed
11376 in their own set of braces). For details of the meaning of the service and
11377 realm, and how to run the daemon, consult the Cyrus documentation.
11378 .endlist vlist
11379
11380
11381
11382 .section "Combining expansion conditions" "SECID84"
11383 .cindex "expansion" "combining conditions"
11384 Several conditions can be tested at once by combining them using the &%and%&
11385 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11386 conditions on their own, and precede their lists of sub-conditions. Each
11387 sub-condition must be enclosed in braces within the overall braces that contain
11388 the list. No repetition of &%if%& is used.
11389
11390
11391 .vlist
11392 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11393 .cindex "&""or""& expansion condition"
11394 .cindex "expansion" "&""or""& of conditions"
11395 The sub-conditions are evaluated from left to right. The condition is true if
11396 any one of the sub-conditions is true.
11397 For example,
11398 .code
11399 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11400 .endd
11401 When a true sub-condition is found, the following ones are parsed but not
11402 evaluated. If there are several &"match"& sub-conditions the values of the
11403 numeric variables afterwards are taken from the first one that succeeds.
11404
11405 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11406 .cindex "&""and""& expansion condition"
11407 .cindex "expansion" "&""and""& of conditions"
11408 The sub-conditions are evaluated from left to right. The condition is true if
11409 all of the sub-conditions are true. If there are several &"match"&
11410 sub-conditions, the values of the numeric variables afterwards are taken from
11411 the last one. When a false sub-condition is found, the following ones are
11412 parsed but not evaluated.
11413 .endlist
11414 .ecindex IIDexpcond
11415
11416
11417
11418
11419 .section "Expansion variables" "SECTexpvar"
11420 .cindex "expansion" "variables, list of"
11421 This section contains an alphabetical list of all the expansion variables. Some
11422 of them are available only when Exim is compiled with specific options such as
11423 support for TLS or the content scanning extension.
11424
11425 .vlist
11426 .vitem "&$0$&, &$1$&, etc"
11427 .cindex "numerical variables (&$1$& &$2$& etc)"
11428 When a &%match%& expansion condition succeeds, these variables contain the
11429 captured substrings identified by the regular expression during subsequent
11430 processing of the success string of the containing &%if%& expansion item.
11431 In the expansion condition case
11432 they do not retain their values afterwards; in fact, their previous
11433 values are restored at the end of processing an &%if%& item. The numerical
11434 variables may also be set externally by some other matching process which
11435 precedes the expansion of the string. For example, the commands available in
11436 Exim filter files include an &%if%& command with its own regular expression
11437 matching condition.
11438
11439 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11440 Within an acl condition, expansion condition or expansion item
11441 any arguments are copied to these variables,
11442 any unused variables being made empty.
11443
11444 .vitem "&$acl_c...$&"
11445 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11446 can be given any name that starts with &$acl_c$& and is at least six characters
11447 long, but the sixth character must be either a digit or an underscore. For
11448 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11449 variables persist throughout the lifetime of an SMTP connection. They can be
11450 used to pass information between ACLs and between different invocations of the
11451 same ACL. When a message is received, the values of these variables are saved
11452 with the message, and can be accessed by filters, routers, and transports
11453 during subsequent delivery.
11454
11455 .vitem "&$acl_m...$&"
11456 These variables are like the &$acl_c...$& variables, except that their values
11457 are reset after a message has been received. Thus, if several messages are
11458 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11459 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11460 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11461 message is received, the values of these variables are saved with the message,
11462 and can be accessed by filters, routers, and transports during subsequent
11463 delivery.
11464
11465 .vitem &$acl_narg$&
11466 Within an acl condition, expansion condition or expansion item
11467 this variable has the number of arguments.
11468
11469 .vitem &$acl_verify_message$&
11470 .vindex "&$acl_verify_message$&"
11471 After an address verification has failed, this variable contains the failure
11472 message. It retains its value for use in subsequent modifiers. The message can
11473 be preserved by coding like this:
11474 .code
11475 warn !verify = sender
11476      set acl_m0 = $acl_verify_message
11477 .endd
11478 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11479 &%log_message%& modifiers, to include information about the verification
11480 failure.
11481
11482 .vitem &$address_data$&
11483 .vindex "&$address_data$&"
11484 This variable is set by means of the &%address_data%& option in routers. The
11485 value then remains with the address while it is processed by subsequent routers
11486 and eventually a transport. If the transport is handling multiple addresses,
11487 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11488 for more details. &*Note*&: The contents of &$address_data$& are visible in
11489 user filter files.
11490
11491 If &$address_data$& is set when the routers are called from an ACL to verify
11492 a recipient address, the final value is still in the variable for subsequent
11493 conditions and modifiers of the ACL statement. If routing the address caused it
11494 to be redirected to just one address, the child address is also routed as part
11495 of the verification, and in this case the final value of &$address_data$& is
11496 from the child's routing.
11497
11498 If &$address_data$& is set when the routers are called from an ACL to verify a
11499 sender address, the final value is also preserved, but this time in
11500 &$sender_address_data$&, to distinguish it from data from a recipient
11501 address.
11502
11503 In both cases (recipient and sender verification), the value does not persist
11504 after the end of the current ACL statement. If you want to preserve
11505 these values for longer, you can save them in ACL variables.
11506
11507 .vitem &$address_file$&
11508 .vindex "&$address_file$&"
11509 When, as a result of aliasing, forwarding, or filtering, a message is directed
11510 to a specific file, this variable holds the name of the file when the transport
11511 is running. At other times, the variable is empty. For example, using the
11512 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11513 .code
11514 /home/r2d2/savemail
11515 .endd
11516 then when the &(address_file)& transport is running, &$address_file$&
11517 contains the text string &`/home/r2d2/savemail`&.
11518 .cindex "Sieve filter" "value of &$address_file$&"
11519 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11520 then up to the transport configuration to generate an appropriate absolute path
11521 to the relevant file.
11522
11523 .vitem &$address_pipe$&
11524 .vindex "&$address_pipe$&"
11525 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11526 this variable holds the pipe command when the transport is running.
11527
11528 .vitem "&$auth1$& &-- &$auth3$&"
11529 .vindex "&$auth1$&, &$auth2$&, etc"
11530 These variables are used in SMTP authenticators (see chapters
11531 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11532
11533 .vitem &$authenticated_id$&
11534 .cindex "authentication" "id"
11535 .vindex "&$authenticated_id$&"
11536 When a server successfully authenticates a client it may be configured to
11537 preserve some of the authentication information in the variable
11538 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11539 user/password authenticator configuration might preserve the user name for use
11540 in the routers. Note that this is not the same information that is saved in
11541 &$sender_host_authenticated$&.
11542 When a message is submitted locally (that is, not over a TCP connection)
11543 the value of &$authenticated_id$& is normally the login name of the calling
11544 process. However, a trusted user can override this by means of the &%-oMai%&
11545 command line option.
11546
11547 .vitem &$authenticated_fail_id$&
11548 .cindex "authentication" "fail" "id"
11549 .vindex "&$authenticated_fail_id$&"
11550 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11551 will contain the failed authentication id. If more than one authentication
11552 id is attempted, it will contain only the last one. The variable is
11553 available for processing in the ACL's, generally the quit or notquit ACL.
11554 A message to a local recipient could still be accepted without requiring
11555 authentication, which means this variable could also be visible in all of
11556 the ACL's as well.
11557
11558
11559 .vitem &$authenticated_sender$&
11560 .cindex "sender" "authenticated"
11561 .cindex "authentication" "sender"
11562 .cindex "AUTH" "on MAIL command"
11563 .vindex "&$authenticated_sender$&"
11564 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11565 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11566 described in section &<<SECTauthparamail>>&. Unless the data is the string
11567 &"<>"&, it is set as the authenticated sender of the message, and the value is
11568 available during delivery in the &$authenticated_sender$& variable. If the
11569 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11570
11571 .vindex "&$qualify_domain$&"
11572 When a message is submitted locally (that is, not over a TCP connection), the
11573 value of &$authenticated_sender$& is an address constructed from the login
11574 name of the calling process and &$qualify_domain$&, except that a trusted user
11575 can override this by means of the &%-oMas%& command line option.
11576
11577
11578 .vitem &$authentication_failed$&
11579 .cindex "authentication" "failure"
11580 .vindex "&$authentication_failed$&"
11581 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11582 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11583 possible to distinguish between &"did not try to authenticate"&
11584 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11585 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11586 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11587 negative response to an AUTH command, including (for example) an attempt to use
11588 an undefined mechanism.
11589
11590 .vitem &$av_failed$&
11591 .cindex "content scanning" "AV scanner failure"
11592 This variable is available when Exim is compiled with the content-scanning
11593 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11594 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11595 the ACL malware condition.
11596
11597 .vitem &$body_linecount$&
11598 .cindex "message body" "line count"
11599 .cindex "body of message" "line count"
11600 .vindex "&$body_linecount$&"
11601 When a message is being received or delivered, this variable contains the
11602 number of lines in the message's body. See also &$message_linecount$&.
11603
11604 .vitem &$body_zerocount$&
11605 .cindex "message body" "binary zero count"
11606 .cindex "body of message" "binary zero count"
11607 .cindex "binary zero" "in message body"
11608 .vindex "&$body_zerocount$&"
11609 When a message is being received or delivered, this variable contains the
11610 number of binary zero bytes (ASCII NULs) in the message's body.
11611
11612 .vitem &$bounce_recipient$&
11613 .vindex "&$bounce_recipient$&"
11614 This is set to the recipient address of a bounce message while Exim is creating
11615 it. It is useful if a customized bounce message text file is in use (see
11616 chapter &<<CHAPemsgcust>>&).
11617
11618 .vitem &$bounce_return_size_limit$&
11619 .vindex "&$bounce_return_size_limit$&"
11620 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11621 up to a multiple of 1000. It is useful when a customized error message text
11622 file is in use (see chapter &<<CHAPemsgcust>>&).
11623
11624 .vitem &$caller_gid$&
11625 .cindex "gid (group id)" "caller"
11626 .vindex "&$caller_gid$&"
11627 The real group id under which the process that called Exim was running. This is
11628 not the same as the group id of the originator of a message (see
11629 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11630 incarnation normally contains the Exim gid.
11631
11632 .vitem &$caller_uid$&
11633 .cindex "uid (user id)" "caller"
11634 .vindex "&$caller_uid$&"
11635 The real user id under which the process that called Exim was running. This is
11636 not the same as the user id of the originator of a message (see
11637 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11638 incarnation normally contains the Exim uid.
11639
11640 .vitem &$callout_address$&
11641 .vindex "&$callout_address$&"
11642 After a callout for verification, spamd or malware daemon service, the
11643 address that was connected to.
11644
11645 .vitem &$compile_number$&
11646 .vindex "&$compile_number$&"
11647 The building process for Exim keeps a count of the number
11648 of times it has been compiled. This serves to distinguish different
11649 compilations of the same version of the program.
11650
11651 .vitem &$config_dir$&
11652 .vindex "&$config_dir$&"
11653 The directory name of the main configuration file. That is, the content of
11654 &$config_file$& with the last component stripped. The value does not
11655 contain the trailing slash. If &$config_file$& does not contain a slash,
11656 &$config_dir$& is ".".
11657
11658 .vitem &$config_file$&
11659 .vindex "&$config_file$&"
11660 The name of the main configuration file Exim is using.
11661
11662 .vitem &$dkim_verify_status$& &&&
11663 Results of DKIM verification.
11664 For details see chapter &<<CHAPdkim>>&.
11665
11666 .vitem &$dkim_cur_signer$& &&&
11667        &$dkim_verify_reason$& &&&
11668        &$dkim_domain$& &&&
11669        &$dkim_identity$& &&&
11670        &$dkim_selector$& &&&
11671        &$dkim_algo$& &&&
11672        &$dkim_canon_body$& &&&
11673        &$dkim_canon_headers$& &&&
11674        &$dkim_copiedheaders$& &&&
11675        &$dkim_bodylength$& &&&
11676        &$dkim_created$& &&&
11677        &$dkim_expires$& &&&
11678        &$dkim_headernames$& &&&
11679        &$dkim_key_testing$& &&&
11680        &$dkim_key_nosubdomains$& &&&
11681        &$dkim_key_srvtype$& &&&
11682        &$dkim_key_granularity$& &&&
11683        &$dkim_key_notes$& &&&
11684        &$dkim_key_length$&
11685 These variables are only available within the DKIM ACL.
11686 For details see chapter &<<CHAPdkim>>&.
11687
11688 .vitem &$dkim_signers$&
11689 .vindex &$dkim_signers$&
11690 When a message has been received this variable contains
11691 a colon-separated list of signer domains and identities for the message.
11692 For details see chapter &<<CHAPdkim>>&.
11693
11694 .vitem &$dnslist_domain$& &&&
11695        &$dnslist_matched$& &&&
11696        &$dnslist_text$& &&&
11697        &$dnslist_value$&
11698 .vindex "&$dnslist_domain$&"
11699 .vindex "&$dnslist_matched$&"
11700 .vindex "&$dnslist_text$&"
11701 .vindex "&$dnslist_value$&"
11702 .cindex "black list (DNS)"
11703 When a DNS (black) list lookup succeeds, these variables are set to contain
11704 the following data from the lookup: the list's domain name, the key that was
11705 looked up, the contents of any associated TXT record, and the value from the
11706 main A record. See section &<<SECID204>>& for more details.
11707
11708 .vitem &$domain$&
11709 .vindex "&$domain$&"
11710 When an address is being routed, or delivered on its own, this variable
11711 contains the domain. Uppercase letters in the domain are converted into lower
11712 case for &$domain$&.
11713
11714 Global address rewriting happens when a message is received, so the value of
11715 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11716 is set during user filtering, but not during system filtering, because a
11717 message may have many recipients and the system filter is called just once.
11718
11719 When more than one address is being delivered at once (for example, several
11720 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11721 have the same domain. Transports can be restricted to handling only one domain
11722 at a time if the value of &$domain$& is required at transport time &-- this is
11723 the default for local transports. For further details of the environment in
11724 which local transports are run, see chapter &<<CHAPenvironment>>&.
11725
11726 .oindex "&%delay_warning_condition%&"
11727 At the end of a delivery, if all deferred addresses have the same domain, it is
11728 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11729
11730 The &$domain$& variable is also used in some other circumstances:
11731
11732 .ilist
11733 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11734 the recipient address. The domain of the &'sender'& address is in
11735 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11736 normally set during the running of the MAIL ACL. However, if the sender address
11737 is verified with a callout during the MAIL ACL, the sender domain is placed in
11738 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11739 the &(smtp)& transport.
11740
11741 .next
11742 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11743 &$domain$& contains the domain portion of the address that is being rewritten;
11744 it can be used in the expansion of the replacement address, for example, to
11745 rewrite domains by file lookup.
11746
11747 .next
11748 With one important exception, whenever a domain list is being scanned,
11749 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11750 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11751 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11752 that, in a RCPT ACL, the sender domain list can be dependent on the
11753 recipient domain (which is what is in &$domain$& at this time).
11754
11755 .next
11756 .cindex "ETRN" "value of &$domain$&"
11757 .oindex "&%smtp_etrn_command%&"
11758 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11759 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11760 .endlist
11761
11762
11763 .vitem &$domain_data$&
11764 .vindex "&$domain_data$&"
11765 When the &%domains%& option on a router matches a domain by
11766 means of a lookup, the data read by the lookup is available during the running
11767 of the router as &$domain_data$&. In addition, if the driver routes the
11768 address to a transport, the value is available in that transport. If the
11769 transport is handling multiple addresses, the value from the first address is
11770 used.
11771
11772 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11773 domain by means of a lookup. The data read by the lookup is available during
11774 the rest of the ACL statement. In all other situations, this variable expands
11775 to nothing.
11776
11777 .vitem &$exim_gid$&
11778 .vindex "&$exim_gid$&"
11779 This variable contains the numerical value of the Exim group id.
11780
11781 .vitem &$exim_path$&
11782 .vindex "&$exim_path$&"
11783 This variable contains the path to the Exim binary.
11784
11785 .vitem &$exim_uid$&
11786 .vindex "&$exim_uid$&"
11787 This variable contains the numerical value of the Exim user id.
11788
11789 .vitem &$exim_version$&
11790 .vindex "&$exim_version$&"
11791 This variable contains the version string of the Exim build.
11792 The first character is a major version number, currently 4.
11793 Then after a dot, the next group of digits is a minor version number.
11794 There may be other characters following the minor version.
11795
11796 .vitem &$header_$&<&'name'&>
11797 This is not strictly an expansion variable. It is expansion syntax for
11798 inserting the message header line with the given name. Note that the name must
11799 be terminated by colon or white space, because it may contain a wide variety of
11800 characters. Note also that braces must &'not'& be used.
11801
11802 .vitem &$headers_added$&
11803 .vindex "&$headers_added$&"
11804 Within an ACL this variable contains the headers added so far by
11805 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11806 The headers are a newline-separated list.
11807
11808 .vitem &$home$&
11809 .vindex "&$home$&"
11810 When the &%check_local_user%& option is set for a router, the user's home
11811 directory is placed in &$home$& when the check succeeds. In particular, this
11812 means it is set during the running of users' filter files. A router may also
11813 explicitly set a home directory for use by a transport; this can be overridden
11814 by a setting on the transport itself.
11815
11816 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11817 of the environment variable HOME, which is subject to the
11818 &%keep_environment%& and &%add_environment%& main config options.
11819
11820 .vitem &$host$&
11821 .vindex "&$host$&"
11822 If a router assigns an address to a transport (any transport), and passes a
11823 list of hosts with the address, the value of &$host$& when the transport starts
11824 to run is the name of the first host on the list. Note that this applies both
11825 to local and remote transports.
11826
11827 .cindex "transport" "filter"
11828 .cindex "filter" "transport filter"
11829 For the &(smtp)& transport, if there is more than one host, the value of
11830 &$host$& changes as the transport works its way through the list. In
11831 particular, when the &(smtp)& transport is expanding its options for encryption
11832 using TLS, or for specifying a transport filter (see chapter
11833 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11834 is connected.
11835
11836 When used in the client part of an authenticator configuration (see chapter
11837 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11838 client is connected.
11839
11840
11841 .vitem &$host_address$&
11842 .vindex "&$host_address$&"
11843 This variable is set to the remote host's IP address whenever &$host$& is set
11844 for a remote connection. It is also set to the IP address that is being checked
11845 when the &%ignore_target_hosts%& option is being processed.
11846
11847 .vitem &$host_data$&
11848 .vindex "&$host_data$&"
11849 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11850 result of the lookup is made available in the &$host_data$& variable. This
11851 allows you, for example, to do things like this:
11852 .code
11853 deny  hosts = net-lsearch;/some/file
11854 message = $host_data
11855 .endd
11856 .vitem &$host_lookup_deferred$&
11857 .cindex "host name" "lookup, failure of"
11858 .vindex "&$host_lookup_deferred$&"
11859 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11860 message comes from a remote host and there is an attempt to look up the host's
11861 name from its IP address, and the attempt is not successful, one of these
11862 variables is set to &"1"&.
11863
11864 .ilist
11865 If the lookup receives a definite negative response (for example, a DNS lookup
11866 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11867
11868 .next
11869 If there is any kind of problem during the lookup, such that Exim cannot
11870 tell whether or not the host name is defined (for example, a timeout for a DNS
11871 lookup), &$host_lookup_deferred$& is set to &"1"&.
11872 .endlist ilist
11873
11874 Looking up a host's name from its IP address consists of more than just a
11875 single reverse lookup. Exim checks that a forward lookup of at least one of the
11876 names it receives from a reverse lookup yields the original IP address. If this
11877 is not the case, Exim does not accept the looked up name(s), and
11878 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11879 IP address (for example, the existence of a PTR record in the DNS) is not
11880 sufficient on its own for the success of a host name lookup. If the reverse
11881 lookup succeeds, but there is a lookup problem such as a timeout when checking
11882 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11883 &"1"&. See also &$sender_host_name$&.
11884
11885 .vitem &$host_lookup_failed$&
11886 .vindex "&$host_lookup_failed$&"
11887 See &$host_lookup_deferred$&.
11888
11889 .vitem &$host_port$&
11890 .vindex "&$host_port$&"
11891 This variable is set to the remote host's TCP port whenever &$host$& is set
11892 for an outbound connection.
11893
11894 .vitem &$initial_cwd$&
11895 .vindex "&$initial_cwd$&
11896 This variable contains the full path name of the initial working
11897 directory of the current Exim process. This may differ from the current
11898 working directory, as Exim changes this to "/" during early startup, and
11899 to &$spool_directory$& later.
11900
11901 .vitem &$inode$&
11902 .vindex "&$inode$&"
11903 The only time this variable is set is while expanding the &%directory_file%&
11904 option in the &(appendfile)& transport. The variable contains the inode number
11905 of the temporary file which is about to be renamed. It can be used to construct
11906 a unique name for the file.
11907
11908 .vitem &$interface_address$&
11909 .vindex "&$interface_address$&"
11910 This is an obsolete name for &$received_ip_address$&.
11911
11912 .vitem &$interface_port$&
11913 .vindex "&$interface_port$&"
11914 This is an obsolete name for &$received_port$&.
11915
11916 .vitem &$item$&
11917 .vindex "&$item$&"
11918 This variable is used during the expansion of &*forall*& and &*forany*&
11919 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11920 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11921 empty.
11922
11923 .vitem &$ldap_dn$&
11924 .vindex "&$ldap_dn$&"
11925 This variable, which is available only when Exim is compiled with LDAP support,
11926 contains the DN from the last entry in the most recently successful LDAP
11927 lookup.
11928
11929 .vitem &$load_average$&
11930 .vindex "&$load_average$&"
11931 This variable contains the system load average, multiplied by 1000 so that it
11932 is an integer. For example, if the load average is 0.21, the value of the
11933 variable is 210. The value is recomputed every time the variable is referenced.
11934
11935 .vitem &$local_part$&
11936 .vindex "&$local_part$&"
11937 When an address is being routed, or delivered on its own, this
11938 variable contains the local part. When a number of addresses are being
11939 delivered together (for example, multiple RCPT commands in an SMTP
11940 session), &$local_part$& is not set.
11941
11942 Global address rewriting happens when a message is received, so the value of
11943 &$local_part$& during routing and delivery is the value after rewriting.
11944 &$local_part$& is set during user filtering, but not during system filtering,
11945 because a message may have many recipients and the system filter is called just
11946 once.
11947
11948 .vindex "&$local_part_prefix$&"
11949 .vindex "&$local_part_suffix$&"
11950 If a local part prefix or suffix has been recognized, it is not included in the
11951 value of &$local_part$& during routing and subsequent delivery. The values of
11952 any prefix or suffix are in &$local_part_prefix$& and
11953 &$local_part_suffix$&, respectively.
11954
11955 When a message is being delivered to a file, pipe, or autoreply transport as a
11956 result of aliasing or forwarding, &$local_part$& is set to the local part of
11957 the parent address, not to the file name or command (see &$address_file$& and
11958 &$address_pipe$&).
11959
11960 When an ACL is running for a RCPT command, &$local_part$& contains the
11961 local part of the recipient address.
11962
11963 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11964 &$local_part$& contains the local part of the address that is being rewritten;
11965 it can be used in the expansion of the replacement address, for example.
11966
11967 In all cases, all quoting is removed from the local part. For example, for both
11968 the addresses
11969 .code
11970 "abc:xyz"@test.example
11971 abc\:xyz@test.example
11972 .endd
11973 the value of &$local_part$& is
11974 .code
11975 abc:xyz
11976 .endd
11977 If you use &$local_part$& to create another address, you should always wrap it
11978 inside a quoting operator. For example, in a &(redirect)& router you could
11979 have:
11980 .code
11981 data = ${quote_local_part:$local_part}@new.domain.example
11982 .endd
11983 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11984 to process local parts in a case-dependent manner in a router, you can set the
11985 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11986
11987 .vitem &$local_part_data$&
11988 .vindex "&$local_part_data$&"
11989 When the &%local_parts%& option on a router matches a local part by means of a
11990 lookup, the data read by the lookup is available during the running of the
11991 router as &$local_part_data$&. In addition, if the driver routes the address
11992 to a transport, the value is available in that transport. If the transport is
11993 handling multiple addresses, the value from the first address is used.
11994
11995 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11996 matches a local part by means of a lookup. The data read by the lookup is
11997 available during the rest of the ACL statement. In all other situations, this
11998 variable expands to nothing.
11999
12000 .vitem &$local_part_prefix$&
12001 .vindex "&$local_part_prefix$&"
12002 When an address is being routed or delivered, and a
12003 specific prefix for the local part was recognized, it is available in this
12004 variable, having been removed from &$local_part$&.
12005
12006 .vitem &$local_part_suffix$&
12007 .vindex "&$local_part_suffix$&"
12008 When an address is being routed or delivered, and a
12009 specific suffix for the local part was recognized, it is available in this
12010 variable, having been removed from &$local_part$&.
12011
12012 .vitem &$local_scan_data$&
12013 .vindex "&$local_scan_data$&"
12014 This variable contains the text returned by the &[local_scan()]& function when
12015 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12016
12017 .vitem &$local_user_gid$&
12018 .vindex "&$local_user_gid$&"
12019 See &$local_user_uid$&.
12020
12021 .vitem &$local_user_uid$&
12022 .vindex "&$local_user_uid$&"
12023 This variable and &$local_user_gid$& are set to the uid and gid after the
12024 &%check_local_user%& router precondition succeeds. This means that their values
12025 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12026 and &%condition%&), for the &%address_data%& expansion, and for any
12027 router-specific expansions. At all other times, the values in these variables
12028 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12029
12030 .vitem &$localhost_number$&
12031 .vindex "&$localhost_number$&"
12032 This contains the expanded value of the
12033 &%localhost_number%& option. The expansion happens after the main options have
12034 been read.
12035
12036 .vitem &$log_inodes$&
12037 .vindex "&$log_inodes$&"
12038 The number of free inodes in the disk partition where Exim's
12039 log files are being written. The value is recalculated whenever the variable is
12040 referenced. If the relevant file system does not have the concept of inodes,
12041 the value of is -1. See also the &%check_log_inodes%& option.
12042
12043 .vitem &$log_space$&
12044 .vindex "&$log_space$&"
12045 The amount of free space (as a number of kilobytes) in the disk
12046 partition where Exim's log files are being written. The value is recalculated
12047 whenever the variable is referenced. If the operating system does not have the
12048 ability to find the amount of free space (only true for experimental systems),
12049 the space value is -1. See also the &%check_log_space%& option.
12050
12051
12052 .vitem &$lookup_dnssec_authenticated$&
12053 .vindex "&$lookup_dnssec_authenticated$&"
12054 This variable is set after a DNS lookup done by
12055 a dnsdb lookup expansion, dnslookup router or smtp transport.
12056 .cindex "DNS" "DNSSEC"
12057 It will be empty if &(DNSSEC)& was not requested,
12058 &"no"& if the result was not labelled as authenticated data
12059 and &"yes"& if it was.
12060 Results that are labelled as authoritative answer that match
12061 the &%dns_trust_aa%& configuration variable count also
12062 as authenticated data.
12063
12064 .vitem &$mailstore_basename$&
12065 .vindex "&$mailstore_basename$&"
12066 This variable is set only when doing deliveries in &"mailstore"& format in the
12067 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12068 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12069 contains the basename of the files that are being written, that is, the name
12070 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12071 variable is empty.
12072
12073 .vitem &$malware_name$&
12074 .vindex "&$malware_name$&"
12075 This variable is available when Exim is compiled with the
12076 content-scanning extension. It is set to the name of the virus that was found
12077 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12078
12079 .vitem &$max_received_linelength$&
12080 .vindex "&$max_received_linelength$&"
12081 .cindex "maximum" "line length"
12082 .cindex "line length" "maximum"
12083 This variable contains the number of bytes in the longest line that was
12084 received as part of the message, not counting the line termination
12085 character(s).
12086 It is not valid if the &%spool_files_wireformat%& option is used.
12087
12088 .vitem &$message_age$&
12089 .cindex "message" "age of"
12090 .vindex "&$message_age$&"
12091 This variable is set at the start of a delivery attempt to contain the number
12092 of seconds since the message was received. It does not change during a single
12093 delivery attempt.
12094
12095 .vitem &$message_body$&
12096 .cindex "body of message" "expansion variable"
12097 .cindex "message body" "in expansion"
12098 .cindex "binary zero" "in message body"
12099 .vindex "&$message_body$&"
12100 .oindex "&%message_body_visible%&"
12101 This variable contains the initial portion of a message's body while it is
12102 being delivered, and is intended mainly for use in filter files. The maximum
12103 number of characters of the body that are put into the variable is set by the
12104 &%message_body_visible%& configuration option; the default is 500.
12105
12106 .oindex "&%message_body_newlines%&"
12107 By default, newlines are converted into spaces in &$message_body$&, to make it
12108 easier to search for phrases that might be split over a line break. However,
12109 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12110 zeros are always converted into spaces.
12111
12112 .vitem &$message_body_end$&
12113 .cindex "body of message" "expansion variable"
12114 .cindex "message body" "in expansion"
12115 .vindex "&$message_body_end$&"
12116 This variable contains the final portion of a message's
12117 body while it is being delivered. The format and maximum size are as for
12118 &$message_body$&.
12119
12120 .vitem &$message_body_size$&
12121 .cindex "body of message" "size"
12122 .cindex "message body" "size"
12123 .vindex "&$message_body_size$&"
12124 When a message is being delivered, this variable contains the size of the body
12125 in bytes. The count starts from the character after the blank line that
12126 separates the body from the header. Newlines are included in the count. See
12127 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12128
12129 If the spool file is wireformat
12130 (see the &%spool_files_wireformat%& main option)
12131 the CRLF line-terminators are included in the count.
12132
12133 .vitem &$message_exim_id$&
12134 .vindex "&$message_exim_id$&"
12135 When a message is being received or delivered, this variable contains the
12136 unique message id that is generated and used by Exim to identify the message.
12137 An id is not created for a message until after its header has been successfully
12138 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12139 line; it is the local id that Exim assigns to the message, for example:
12140 &`1BXTIK-0001yO-VA`&.
12141
12142 .vitem &$message_headers$&
12143 .vindex &$message_headers$&
12144 This variable contains a concatenation of all the header lines when a message
12145 is being processed, except for lines added by routers or transports. The header
12146 lines are separated by newline characters. Their contents are decoded in the
12147 same way as a header line that is inserted by &%bheader%&.
12148
12149 .vitem &$message_headers_raw$&
12150 .vindex &$message_headers_raw$&
12151 This variable is like &$message_headers$& except that no processing of the
12152 contents of header lines is done.
12153
12154 .vitem &$message_id$&
12155 This is an old name for &$message_exim_id$&. It is now deprecated.
12156
12157 .vitem &$message_linecount$&
12158 .vindex "&$message_linecount$&"
12159 This variable contains the total number of lines in the header and body of the
12160 message. Compare &$body_linecount$&, which is the count for the body only.
12161 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12162 number of lines received. Before delivery happens (that is, before filters,
12163 routers, and transports run) the count is increased to include the
12164 &'Received:'& header line that Exim standardly adds, and also any other header
12165 lines that are added by ACLs. The blank line that separates the message header
12166 from the body is not counted.
12167
12168 As with the special case of &$message_size$&, during the expansion of the
12169 appendfile transport's maildir_tag option in maildir format, the value of
12170 &$message_linecount$& is the precise size of the number of newlines in the
12171 file that has been written (minus one for the blank line between the
12172 header and the body).
12173
12174 Here is an example of the use of this variable in a DATA ACL:
12175 .code
12176 deny message   = Too many lines in message header
12177      condition = \
12178       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12179 .endd
12180 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12181 message has not yet been received.
12182
12183 This variable is not valid if the &%spool_files_wireformat%& option is used.
12184
12185 .vitem &$message_size$&
12186 .cindex "size" "of message"
12187 .cindex "message" "size"
12188 .vindex "&$message_size$&"
12189 When a message is being processed, this variable contains its size in bytes. In
12190 most cases, the size includes those headers that were received with the
12191 message, but not those (such as &'Envelope-to:'&) that are added to individual
12192 deliveries as they are written. However, there is one special case: during the
12193 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12194 doing a delivery in maildir format, the value of &$message_size$& is the
12195 precise size of the file that has been written. See also
12196 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12197
12198 .cindex "RCPT" "value of &$message_size$&"
12199 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12200 contains the size supplied on the MAIL command, or -1 if no size was given. The
12201 value may not, of course, be truthful.
12202
12203 .vitem &$mime_$&&'xxx'&
12204 A number of variables whose names start with &$mime$& are
12205 available when Exim is compiled with the content-scanning extension. For
12206 details, see section &<<SECTscanmimepart>>&.
12207
12208 .vitem "&$n0$& &-- &$n9$&"
12209 These variables are counters that can be incremented by means
12210 of the &%add%& command in filter files.
12211
12212 .vitem &$original_domain$&
12213 .vindex "&$domain$&"
12214 .vindex "&$original_domain$&"
12215 When a top-level address is being processed for delivery, this contains the
12216 same value as &$domain$&. However, if a &"child"& address (for example,
12217 generated by an alias, forward, or filter file) is being processed, this
12218 variable contains the domain of the original address (lower cased). This
12219 differs from &$parent_domain$& only when there is more than one level of
12220 aliasing or forwarding. When more than one address is being delivered in a
12221 single transport run, &$original_domain$& is not set.
12222
12223 If a new address is created by means of a &%deliver%& command in a system
12224 filter, it is set up with an artificial &"parent"& address. This has the local
12225 part &'system-filter'& and the default qualify domain.
12226
12227 .vitem &$original_local_part$&
12228 .vindex "&$local_part$&"
12229 .vindex "&$original_local_part$&"
12230 When a top-level address is being processed for delivery, this contains the
12231 same value as &$local_part$&, unless a prefix or suffix was removed from the
12232 local part, because &$original_local_part$& always contains the full local
12233 part. When a &"child"& address (for example, generated by an alias, forward, or
12234 filter file) is being processed, this variable contains the full local part of
12235 the original address.
12236
12237 If the router that did the redirection processed the local part
12238 case-insensitively, the value in &$original_local_part$& is in lower case.
12239 This variable differs from &$parent_local_part$& only when there is more than
12240 one level of aliasing or forwarding. When more than one address is being
12241 delivered in a single transport run, &$original_local_part$& is not set.
12242
12243 If a new address is created by means of a &%deliver%& command in a system
12244 filter, it is set up with an artificial &"parent"& address. This has the local
12245 part &'system-filter'& and the default qualify domain.
12246
12247 .vitem &$originator_gid$&
12248 .cindex "gid (group id)" "of originating user"
12249 .cindex "sender" "gid"
12250 .vindex "&$caller_gid$&"
12251 .vindex "&$originator_gid$&"
12252 This variable contains the value of &$caller_gid$& that was set when the
12253 message was received. For messages received via the command line, this is the
12254 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12255 normally the gid of the Exim user.
12256
12257 .vitem &$originator_uid$&
12258 .cindex "uid (user id)" "of originating user"
12259 .cindex "sender" "uid"
12260 .vindex "&$caller_uid$&"
12261 .vindex "&$originator_uid$&"
12262 The value of &$caller_uid$& that was set when the message was received. For
12263 messages received via the command line, this is the uid of the sending user.
12264 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12265 user.
12266
12267 .vitem &$parent_domain$&
12268 .vindex "&$parent_domain$&"
12269 This variable is similar to &$original_domain$& (see
12270 above), except that it refers to the immediately preceding parent address.
12271
12272 .vitem &$parent_local_part$&
12273 .vindex "&$parent_local_part$&"
12274 This variable is similar to &$original_local_part$&
12275 (see above), except that it refers to the immediately preceding parent address.
12276
12277 .vitem &$pid$&
12278 .cindex "pid (process id)" "of current process"
12279 .vindex "&$pid$&"
12280 This variable contains the current process id.
12281
12282 .vitem &$pipe_addresses$&
12283 .cindex "filter" "transport filter"
12284 .cindex "transport" "filter"
12285 .vindex "&$pipe_addresses$&"
12286 This is not an expansion variable, but is mentioned here because the string
12287 &`$pipe_addresses`& is handled specially in the command specification for the
12288 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12289 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12290 It cannot be used in general expansion strings, and provokes an &"unknown
12291 variable"& error if encountered.
12292
12293 .vitem &$primary_hostname$&
12294 .vindex "&$primary_hostname$&"
12295 This variable contains the value set by &%primary_hostname%& in the
12296 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12297 a single-component name, Exim calls &[gethostbyname()]& (or
12298 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12299 qualified host name. See also &$smtp_active_hostname$&.
12300
12301
12302 .vitem &$proxy_external_address$& &&&
12303        &$proxy_external_port$& &&&
12304        &$proxy_local_address$& &&&
12305        &$proxy_local_port$& &&&
12306        &$proxy_session$&
12307 These variables are only available when built with Proxy Protocol
12308 or SOCKS5 support.
12309 For details see chapter &<<SECTproxyInbound>>&.
12310
12311 .vitem &$prdr_requested$&
12312 .cindex "PRDR" "variable for"
12313 This variable is set to &"yes"& if PRDR was requested by the client for the
12314 current message, otherwise &"no"&.
12315
12316 .vitem &$prvscheck_address$&
12317 This variable is used in conjunction with the &%prvscheck%& expansion item,
12318 which is described in sections &<<SECTexpansionitems>>& and
12319 &<<SECTverifyPRVS>>&.
12320
12321 .vitem &$prvscheck_keynum$&
12322 This variable is used in conjunction with the &%prvscheck%& expansion item,
12323 which is described in sections &<<SECTexpansionitems>>& and
12324 &<<SECTverifyPRVS>>&.
12325
12326 .vitem &$prvscheck_result$&
12327 This variable is used in conjunction with the &%prvscheck%& expansion item,
12328 which is described in sections &<<SECTexpansionitems>>& and
12329 &<<SECTverifyPRVS>>&.
12330
12331 .vitem &$qualify_domain$&
12332 .vindex "&$qualify_domain$&"
12333 The value set for the &%qualify_domain%& option in the configuration file.
12334
12335 .vitem &$qualify_recipient$&
12336 .vindex "&$qualify_recipient$&"
12337 The value set for the &%qualify_recipient%& option in the configuration file,
12338 or if not set, the value of &$qualify_domain$&.
12339
12340 .vitem &$queue_name$&
12341 .vindex &$queue_name$&
12342 .cindex "named queues"
12343 .cindex queues named
12344 The name of the spool queue in use; empty for the default queue.
12345
12346 .vitem &$rcpt_count$&
12347 .vindex "&$rcpt_count$&"
12348 When a message is being received by SMTP, this variable contains the number of
12349 RCPT commands received for the current message. If this variable is used in a
12350 RCPT ACL, its value includes the current command.
12351
12352 .vitem &$rcpt_defer_count$&
12353 .vindex "&$rcpt_defer_count$&"
12354 .cindex "4&'xx'& responses" "count of"
12355 When a message is being received by SMTP, this variable contains the number of
12356 RCPT commands in the current message that have previously been rejected with a
12357 temporary (4&'xx'&) response.
12358
12359 .vitem &$rcpt_fail_count$&
12360 .vindex "&$rcpt_fail_count$&"
12361 When a message is being received by SMTP, this variable contains the number of
12362 RCPT commands in the current message that have previously been rejected with a
12363 permanent (5&'xx'&) response.
12364
12365 .vitem &$received_count$&
12366 .vindex "&$received_count$&"
12367 This variable contains the number of &'Received:'& header lines in the message,
12368 including the one added by Exim (so its value is always greater than zero). It
12369 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12370 delivering.
12371
12372 .vitem &$received_for$&
12373 .vindex "&$received_for$&"
12374 If there is only a single recipient address in an incoming message, this
12375 variable contains that address when the &'Received:'& header line is being
12376 built. The value is copied after recipient rewriting has happened, but before
12377 the &[local_scan()]& function is run.
12378
12379 .vitem &$received_ip_address$&
12380 .vindex "&$received_ip_address$&"
12381 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12382 variable is set to the address of the local IP interface, and &$received_port$&
12383 is set to the local port number. (The remote IP address and port are in
12384 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12385 the port value is -1 unless it has been set using the &%-oMi%& command line
12386 option.
12387
12388 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12389 could be used, for example, to make the file name for a TLS certificate depend
12390 on which interface and/or port is being used for the incoming connection. The
12391 values of &$received_ip_address$& and &$received_port$& are saved with any
12392 messages that are received, thus making these variables available at delivery
12393 time.
12394 For outbound connections see &$sending_ip_address$&.
12395
12396 .vitem &$received_port$&
12397 .vindex "&$received_port$&"
12398 See &$received_ip_address$&.
12399
12400 .vitem &$received_protocol$&
12401 .vindex "&$received_protocol$&"
12402 When a message is being processed, this variable contains the name of the
12403 protocol by which it was received. Most of the names used by Exim are defined
12404 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12405 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12406 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12407 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12408 connection and the client was successfully authenticated.
12409
12410 Exim uses the protocol name &"smtps"& for the case when encryption is
12411 automatically set up on connection without the use of STARTTLS (see
12412 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12413 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12414 where the client initially uses EHLO, sets up an encrypted connection using
12415 STARTTLS, and then uses HELO afterwards.
12416
12417 The &%-oMr%& option provides a way of specifying a custom protocol name for
12418 messages that are injected locally by trusted callers. This is commonly used to
12419 identify messages that are being re-injected after some kind of scanning.
12420
12421 .vitem &$received_time$&
12422 .vindex "&$received_time$&"
12423 This variable contains the date and time when the current message was received,
12424 as a number of seconds since the start of the Unix epoch.
12425
12426 .vitem &$recipient_data$&
12427 .vindex "&$recipient_data$&"
12428 This variable is set after an indexing lookup success in an ACL &%recipients%&
12429 condition. It contains the data from the lookup, and the value remains set
12430 until the next &%recipients%& test. Thus, you can do things like this:
12431 .display
12432 &`require recipients  = cdb*@;/some/file`&
12433 &`deny    `&&'some further test involving'& &`$recipient_data`&
12434 .endd
12435 &*Warning*&: This variable is set only when a lookup is used as an indexing
12436 method in the address list, using the semicolon syntax as in the example above.
12437 The variable is not set for a lookup that is used as part of the string
12438 expansion that all such lists undergo before being interpreted.
12439
12440 .vitem &$recipient_verify_failure$&
12441 .vindex "&$recipient_verify_failure$&"
12442 In an ACL, when a recipient verification fails, this variable contains
12443 information about the failure. It is set to one of the following words:
12444
12445 .ilist
12446 &"qualify"&: The address was unqualified (no domain), and the message
12447 was neither local nor came from an exempted host.
12448
12449 .next
12450 &"route"&: Routing failed.
12451
12452 .next
12453 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12454 or before the MAIL command (that is, on initial connection, HELO, or
12455 MAIL).
12456
12457 .next
12458 &"recipient"&: The RCPT command in a callout was rejected.
12459 .next
12460
12461 &"postmaster"&: The postmaster check in a callout was rejected.
12462 .endlist
12463
12464 The main use of this variable is expected to be to distinguish between
12465 rejections of MAIL and rejections of RCPT.
12466
12467 .vitem &$recipients$&
12468 .vindex "&$recipients$&"
12469 This variable contains a list of envelope recipients for a message. A comma and
12470 a space separate the addresses in the replacement text. However, the variable
12471 is not generally available, to prevent exposure of Bcc recipients in
12472 unprivileged users' filter files. You can use &$recipients$& only in these
12473 cases:
12474
12475 .olist
12476 In a system filter file.
12477 .next
12478 In the ACLs associated with the DATA command and with non-SMTP messages, that
12479 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12480 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12481 &%acl_not_smtp_mime%&.
12482 .next
12483 From within a &[local_scan()]& function.
12484 .endlist
12485
12486
12487 .vitem &$recipients_count$&
12488 .vindex "&$recipients_count$&"
12489 When a message is being processed, this variable contains the number of
12490 envelope recipients that came with the message. Duplicates are not excluded
12491 from the count. While a message is being received over SMTP, the number
12492 increases for each accepted recipient. It can be referenced in an ACL.
12493
12494
12495 .vitem &$regex_match_string$&
12496 .vindex "&$regex_match_string$&"
12497 This variable is set to contain the matching regular expression after a
12498 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12499
12500 .vitem "&$regex1$&, &$regex2$&, etc"
12501 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12502 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12503 these variables contain the
12504 captured substrings identified by the regular expression.
12505
12506
12507 .vitem &$reply_address$&
12508 .vindex "&$reply_address$&"
12509 When a message is being processed, this variable contains the contents of the
12510 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12511 contents of the &'From:'& header line. Apart from the removal of leading
12512 white space, the value is not processed in any way. In particular, no RFC 2047
12513 decoding or character code translation takes place.
12514
12515 .vitem &$return_path$&
12516 .vindex "&$return_path$&"
12517 When a message is being delivered, this variable contains the return path &--
12518 the sender field that will be sent as part of the envelope. It is not enclosed
12519 in <> characters. At the start of routing an address, &$return_path$& has the
12520 same value as &$sender_address$&, but if, for example, an incoming message to a
12521 mailing list has been expanded by a router which specifies a different address
12522 for bounce messages, &$return_path$& subsequently contains the new bounce
12523 address, whereas &$sender_address$& always contains the original sender address
12524 that was received with the message. In other words, &$sender_address$& contains
12525 the incoming envelope sender, and &$return_path$& contains the outgoing
12526 envelope sender.
12527
12528 .vitem &$return_size_limit$&
12529 .vindex "&$return_size_limit$&"
12530 This is an obsolete name for &$bounce_return_size_limit$&.
12531
12532 .vitem &$router_name$&
12533 .cindex "router" "name"
12534 .cindex "name" "of router"
12535 .vindex "&$router_name$&"
12536 During the running of a router this variable contains its name.
12537
12538 .vitem &$runrc$&
12539 .cindex "return code" "from &%run%& expansion"
12540 .vindex "&$runrc$&"
12541 This variable contains the return code from a command that is run by the
12542 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12543 assume the order in which option values are expanded, except for those
12544 preconditions whose order of testing is documented. Therefore, you cannot
12545 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12546 another.
12547
12548 .vitem &$self_hostname$&
12549 .oindex "&%self%&" "value of host name"
12550 .vindex "&$self_hostname$&"
12551 When an address is routed to a supposedly remote host that turns out to be the
12552 local host, what happens is controlled by the &%self%& generic router option.
12553 One of its values causes the address to be passed to another router. When this
12554 happens, &$self_hostname$& is set to the name of the local host that the
12555 original router encountered. In other circumstances its contents are null.
12556
12557 .vitem &$sender_address$&
12558 .vindex "&$sender_address$&"
12559 When a message is being processed, this variable contains the sender's address
12560 that was received in the message's envelope. The case of letters in the address
12561 is retained, in both the local part and the domain. For bounce messages, the
12562 value of this variable is the empty string. See also &$return_path$&.
12563
12564 .vitem &$sender_address_data$&
12565 .vindex "&$address_data$&"
12566 .vindex "&$sender_address_data$&"
12567 If &$address_data$& is set when the routers are called from an ACL to verify a
12568 sender address, the final value is preserved in &$sender_address_data$&, to
12569 distinguish it from data from a recipient address. The value does not persist
12570 after the end of the current ACL statement. If you want to preserve it for
12571 longer, you can save it in an ACL variable.
12572
12573 .vitem &$sender_address_domain$&
12574 .vindex "&$sender_address_domain$&"
12575 The domain portion of &$sender_address$&.
12576
12577 .vitem &$sender_address_local_part$&
12578 .vindex "&$sender_address_local_part$&"
12579 The local part portion of &$sender_address$&.
12580
12581 .vitem &$sender_data$&
12582 .vindex "&$sender_data$&"
12583 This variable is set after a lookup success in an ACL &%senders%& condition or
12584 in a router &%senders%& option. It contains the data from the lookup, and the
12585 value remains set until the next &%senders%& test. Thus, you can do things like
12586 this:
12587 .display
12588 &`require senders      = cdb*@;/some/file`&
12589 &`deny    `&&'some further test involving'& &`$sender_data`&
12590 .endd
12591 &*Warning*&: This variable is set only when a lookup is used as an indexing
12592 method in the address list, using the semicolon syntax as in the example above.
12593 The variable is not set for a lookup that is used as part of the string
12594 expansion that all such lists undergo before being interpreted.
12595
12596 .vitem &$sender_fullhost$&
12597 .vindex "&$sender_fullhost$&"
12598 When a message is received from a remote host, this variable contains the host
12599 name and IP address in a single string. It ends with the IP address in square
12600 brackets, followed by a colon and a port number if the logging of ports is
12601 enabled. The format of the rest of the string depends on whether the host
12602 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12603 looking up its IP address. (Looking up the IP address can be forced by the
12604 &%host_lookup%& option, independent of verification.) A plain host name at the
12605 start of the string is a verified host name; if this is not present,
12606 verification either failed or was not requested. A host name in parentheses is
12607 the argument of a HELO or EHLO command. This is omitted if it is identical to
12608 the verified host name or to the host's IP address in square brackets.
12609
12610 .vitem &$sender_helo_dnssec$&
12611 .vindex "&$sender_helo_dnssec$&"
12612 This boolean variable is true if a successful HELO verification was
12613 .cindex "DNS" "DNSSEC"
12614 done using DNS information the resolver library stated was authenticated data.
12615
12616 .vitem &$sender_helo_name$&
12617 .vindex "&$sender_helo_name$&"
12618 When a message is received from a remote host that has issued a HELO or EHLO
12619 command, the argument of that command is placed in this variable. It is also
12620 set if HELO or EHLO is used when a message is received using SMTP locally via
12621 the &%-bs%& or &%-bS%& options.
12622
12623 .vitem &$sender_host_address$&
12624 .vindex "&$sender_host_address$&"
12625 When a message is received from a remote host using SMTP,
12626 this variable contains that
12627 host's IP address. For locally non-SMTP submitted messages, it is empty.
12628
12629 .vitem &$sender_host_authenticated$&
12630 .vindex "&$sender_host_authenticated$&"
12631 This variable contains the name (not the public name) of the authenticator
12632 driver that successfully authenticated the client from which the message was
12633 received. It is empty if there was no successful authentication. See also
12634 &$authenticated_id$&.
12635
12636 .vitem &$sender_host_dnssec$&
12637 .vindex "&$sender_host_dnssec$&"
12638 If an attempt to populate &$sender_host_name$& has been made
12639 (by reference, &%hosts_lookup%& or
12640 otherwise) then this boolean will have been set true if, and only if, the
12641 resolver library states that both
12642 the reverse and forward DNS were authenticated data.  At all
12643 other times, this variable is false.
12644
12645 .cindex "DNS" "DNSSEC"
12646 It is likely that you will need to coerce DNSSEC support on in the resolver
12647 library, by setting:
12648 .code
12649 dns_dnssec_ok = 1
12650 .endd
12651
12652 Exim does not perform DNSSEC validation itself, instead leaving that to a
12653 validating resolver (e.g. unbound, or bind with suitable configuration).
12654
12655 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12656 mechanism in the list, then this variable will be false.
12657
12658 This requires that your system resolver library support EDNS0 (and that
12659 DNSSEC flags exist in the system headers).  If the resolver silently drops
12660 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
12661 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
12662
12663
12664 .vitem &$sender_host_name$&
12665 .vindex "&$sender_host_name$&"
12666 When a message is received from a remote host, this variable contains the
12667 host's name as obtained by looking up its IP address. For messages received by
12668 other means, this variable is empty.
12669
12670 .vindex "&$host_lookup_failed$&"
12671 If the host name has not previously been looked up, a reference to
12672 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12673 A looked up name is accepted only if it leads back to the original IP address
12674 via a forward lookup. If either the reverse or the forward lookup fails to find
12675 any data, or if the forward lookup does not yield the original IP address,
12676 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12677
12678 .vindex "&$host_lookup_deferred$&"
12679 However, if either of the lookups cannot be completed (for example, there is a
12680 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12681 &$host_lookup_failed$& remains set to &"0"&.
12682
12683 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12684 host name again if there is a subsequent reference to &$sender_host_name$&
12685 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12686 is set to &"1"&.
12687
12688 Exim does not automatically look up every calling host's name. If you want
12689 maximum efficiency, you should arrange your configuration so that it avoids
12690 these lookups altogether. The lookup happens only if one or more of the
12691 following are true:
12692
12693 .ilist
12694 A string containing &$sender_host_name$& is expanded.
12695 .next
12696 The calling host matches the list in &%host_lookup%&. In the default
12697 configuration, this option is set to *, so it must be changed if lookups are
12698 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12699 .next
12700 Exim needs the host name in order to test an item in a host list. The items
12701 that require this are described in sections &<<SECThoslispatnam>>& and
12702 &<<SECThoslispatnamsk>>&.
12703 .next
12704 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12705 In this case, the host name is required to compare with the name quoted in any
12706 EHLO or HELO commands that the client issues.
12707 .next
12708 The remote host issues a EHLO or HELO command that quotes one of the
12709 domains in &%helo_lookup_domains%&. The default value of this option is
12710 . ==== As this is a nested list, any displays it contains must be indented
12711 . ==== as otherwise they are too far to the left.
12712 .code
12713   helo_lookup_domains = @ : @[]
12714 .endd
12715 which causes a lookup if a remote host (incorrectly) gives the server's name or
12716 IP address in an EHLO or HELO command.
12717 .endlist
12718
12719
12720 .vitem &$sender_host_port$&
12721 .vindex "&$sender_host_port$&"
12722 When a message is received from a remote host, this variable contains the port
12723 number that was used on the remote host.
12724
12725 .vitem &$sender_ident$&
12726 .vindex "&$sender_ident$&"
12727 When a message is received from a remote host, this variable contains the
12728 identification received in response to an RFC 1413 request. When a message has
12729 been received locally, this variable contains the login name of the user that
12730 called Exim.
12731
12732 .vitem &$sender_rate_$&&'xxx'&
12733 A number of variables whose names begin &$sender_rate_$& are set as part of the
12734 &%ratelimit%& ACL condition. Details are given in section
12735 &<<SECTratelimiting>>&.
12736
12737 .vitem &$sender_rcvhost$&
12738 .cindex "DNS" "reverse lookup"
12739 .cindex "reverse DNS lookup"
12740 .vindex "&$sender_rcvhost$&"
12741 This is provided specifically for use in &'Received:'& headers. It starts with
12742 either the verified host name (as obtained from a reverse DNS lookup) or, if
12743 there is no verified host name, the IP address in square brackets. After that
12744 there may be text in parentheses. When the first item is a verified host name,
12745 the first thing in the parentheses is the IP address in square brackets,
12746 followed by a colon and a port number if port logging is enabled. When the
12747 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12748 the parentheses.
12749
12750 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12751 was used and its argument was not identical to the real host name or IP
12752 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12753 all three items are present in the parentheses, a newline and tab are inserted
12754 into the string, to improve the formatting of the &'Received:'& header.
12755
12756 .vitem &$sender_verify_failure$&
12757 .vindex "&$sender_verify_failure$&"
12758 In an ACL, when a sender verification fails, this variable contains information
12759 about the failure. The details are the same as for
12760 &$recipient_verify_failure$&.
12761
12762 .vitem &$sending_ip_address$&
12763 .vindex "&$sending_ip_address$&"
12764 This variable is set whenever an outgoing SMTP connection to another host has
12765 been set up. It contains the IP address of the local interface that is being
12766 used. This is useful if a host that has more than one IP address wants to take
12767 on different personalities depending on which one is being used. For incoming
12768 connections, see &$received_ip_address$&.
12769
12770 .vitem &$sending_port$&
12771 .vindex "&$sending_port$&"
12772 This variable is set whenever an outgoing SMTP connection to another host has
12773 been set up. It contains the local port that is being used. For incoming
12774 connections, see &$received_port$&.
12775
12776 .vitem &$smtp_active_hostname$&
12777 .vindex "&$smtp_active_hostname$&"
12778 During an incoming SMTP session, this variable contains the value of the active
12779 host name, as specified by the &%smtp_active_hostname%& option. The value of
12780 &$smtp_active_hostname$& is saved with any message that is received, so its
12781 value can be consulted during routing and delivery.
12782
12783 .vitem &$smtp_command$&
12784 .vindex "&$smtp_command$&"
12785 During the processing of an incoming SMTP command, this variable contains the
12786 entire command. This makes it possible to distinguish between HELO and EHLO in
12787 the HELO ACL, and also to distinguish between commands such as these:
12788 .code
12789 MAIL FROM:<>
12790 MAIL FROM: <>
12791 .endd
12792 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12793 command, the address in &$smtp_command$& is the original address before any
12794 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12795 the address after SMTP-time rewriting.
12796
12797 .vitem &$smtp_command_argument$&
12798 .cindex "SMTP" "command, argument for"
12799 .vindex "&$smtp_command_argument$&"
12800 While an ACL is running to check an SMTP command, this variable contains the
12801 argument, that is, the text that follows the command name, with leading white
12802 space removed. Following the introduction of &$smtp_command$&, this variable is
12803 somewhat redundant, but is retained for backwards compatibility.
12804
12805 .vitem &$smtp_command_history$&
12806 .cindex SMTP "command history"
12807 .vindex "&$smtp_command_history$&"
12808 A comma-separated list (with no whitespace) of the most-recent SMTP commands
12809 received, in time-order left to right.  Only a limited number of commands
12810 are remembered.
12811
12812 .vitem &$smtp_count_at_connection_start$&
12813 .vindex "&$smtp_count_at_connection_start$&"
12814 This variable is set greater than zero only in processes spawned by the Exim
12815 daemon for handling incoming SMTP connections. The name is deliberately long,
12816 in order to emphasize what the contents are. When the daemon accepts a new
12817 connection, it increments this variable. A copy of the variable is passed to
12818 the child process that handles the connection, but its value is fixed, and
12819 never changes. It is only an approximation of how many incoming connections
12820 there actually are, because many other connections may come and go while a
12821 single connection is being processed. When a child process terminates, the
12822 daemon decrements its copy of the variable.
12823
12824 .vitem "&$sn0$& &-- &$sn9$&"
12825 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12826 that were current at the end of the system filter file. This allows a system
12827 filter file to set values that can be tested in users' filter files. For
12828 example, a system filter could set a value indicating how likely it is that a
12829 message is junk mail.
12830
12831 .vitem &$spam_$&&'xxx'&
12832 A number of variables whose names start with &$spam$& are available when Exim
12833 is compiled with the content-scanning extension. For details, see section
12834 &<<SECTscanspamass>>&.
12835
12836
12837 .vitem &$spool_directory$&
12838 .vindex "&$spool_directory$&"
12839 The name of Exim's spool directory.
12840
12841 .vitem &$spool_inodes$&
12842 .vindex "&$spool_inodes$&"
12843 The number of free inodes in the disk partition where Exim's spool files are
12844 being written. The value is recalculated whenever the variable is referenced.
12845 If the relevant file system does not have the concept of inodes, the value of
12846 is -1. See also the &%check_spool_inodes%& option.
12847
12848 .vitem &$spool_space$&
12849 .vindex "&$spool_space$&"
12850 The amount of free space (as a number of kilobytes) in the disk partition where
12851 Exim's spool files are being written. The value is recalculated whenever the
12852 variable is referenced. If the operating system does not have the ability to
12853 find the amount of free space (only true for experimental systems), the space
12854 value is -1. For example, to check in an ACL that there is at least 50
12855 megabytes free on the spool, you could write:
12856 .code
12857 condition = ${if > {$spool_space}{50000}}
12858 .endd
12859 See also the &%check_spool_space%& option.
12860
12861
12862 .vitem &$thisaddress$&
12863 .vindex "&$thisaddress$&"
12864 This variable is set only during the processing of the &%foranyaddress%&
12865 command in a filter file. Its use is explained in the description of that
12866 command, which can be found in the separate document entitled &'Exim's
12867 interfaces to mail filtering'&.
12868
12869 .vitem &$tls_in_bits$&
12870 .vindex "&$tls_in_bits$&"
12871 Contains an approximation of the TLS cipher's bit-strength
12872 on the inbound connection; the meaning of
12873 this depends upon the TLS implementation used.
12874 If TLS has not been negotiated, the value will be 0.
12875 The value of this is automatically fed into the Cyrus SASL authenticator
12876 when acting as a server, to specify the "external SSF" (a SASL term).
12877
12878 The deprecated &$tls_bits$& variable refers to the inbound side
12879 except when used in the context of an outbound SMTP delivery, when it refers to
12880 the outbound.
12881
12882 .vitem &$tls_out_bits$&
12883 .vindex "&$tls_out_bits$&"
12884 Contains an approximation of the TLS cipher's bit-strength
12885 on an outbound SMTP connection; the meaning of
12886 this depends upon the TLS implementation used.
12887 If TLS has not been negotiated, the value will be 0.
12888
12889 .vitem &$tls_in_ourcert$&
12890 .vindex "&$tls_in_ourcert$&"
12891 .cindex certificate variables
12892 This variable refers to the certificate presented to the peer of an
12893 inbound connection when the message was received.
12894 It is only useful as the argument of a
12895 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12896 or a &%def%& condition.
12897
12898 &*Note*&: Under current versions of OpenSSL, when a list of more than one
12899 file is used for &%tls_certificate%&, this variable is not reliable.
12900
12901 .vitem &$tls_in_peercert$&
12902 .vindex "&$tls_in_peercert$&"
12903 This variable refers to the certificate presented by the peer of an
12904 inbound connection when the message was received.
12905 It is only useful as the argument of a
12906 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12907 or a &%def%& condition.
12908 If certificate verification fails it may refer to a failing chain element
12909 which is not the leaf.
12910
12911 .vitem &$tls_out_ourcert$&
12912 .vindex "&$tls_out_ourcert$&"
12913 This variable refers to the certificate presented to the peer of an
12914 outbound connection.  It is only useful as the argument of a
12915 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12916 or a &%def%& condition.
12917
12918 .vitem &$tls_out_peercert$&
12919 .vindex "&$tls_out_peercert$&"
12920 This variable refers to the certificate presented by the peer of an
12921 outbound connection.  It is only useful as the argument of a
12922 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12923 or a &%def%& condition.
12924 If certificate verification fails it may refer to a failing chain element
12925 which is not the leaf.
12926
12927 .vitem &$tls_in_certificate_verified$&
12928 .vindex "&$tls_in_certificate_verified$&"
12929 This variable is set to &"1"& if a TLS certificate was verified when the
12930 message was received, and &"0"& otherwise.
12931
12932 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12933 except when used in the context of an outbound SMTP delivery, when it refers to
12934 the outbound.
12935
12936 .vitem &$tls_out_certificate_verified$&
12937 .vindex "&$tls_out_certificate_verified$&"
12938 This variable is set to &"1"& if a TLS certificate was verified when an
12939 outbound SMTP connection was made,
12940 and &"0"& otherwise.
12941
12942 .vitem &$tls_in_cipher$&
12943 .vindex "&$tls_in_cipher$&"
12944 .vindex "&$tls_cipher$&"
12945 When a message is received from a remote host over an encrypted SMTP
12946 connection, this variable is set to the cipher suite that was negotiated, for
12947 example DES-CBC3-SHA. In other circumstances, in particular, for message
12948 received over unencrypted connections, the variable is empty. Testing
12949 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
12950 non-encrypted connections during ACL processing.
12951
12952 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12953 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12954 becomes the same as &$tls_out_cipher$&.
12955
12956 .vitem &$tls_out_cipher$&
12957 .vindex "&$tls_out_cipher$&"
12958 This variable is
12959 cleared before any outgoing SMTP connection is made,
12960 and then set to the outgoing cipher suite if one is negotiated. See chapter
12961 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12962 details of the &(smtp)& transport.
12963
12964 .vitem &$tls_in_ocsp$&
12965 .vindex "&$tls_in_ocsp$&"
12966 When a message is received from a remote client connection
12967 the result of any OCSP request from the client is encoded in this variable:
12968 .code
12969 0 OCSP proof was not requested (default value)
12970 1 No response to request
12971 2 Response not verified
12972 3 Verification failed
12973 4 Verification succeeded
12974 .endd
12975
12976 .vitem &$tls_out_ocsp$&
12977 .vindex "&$tls_out_ocsp$&"
12978 When a message is sent to a remote host connection
12979 the result of any OCSP request made is encoded in this variable.
12980 See &$tls_in_ocsp$& for values.
12981
12982 .vitem &$tls_in_peerdn$&
12983 .vindex "&$tls_in_peerdn$&"
12984 .vindex "&$tls_peerdn$&"
12985 .cindex certificate "extracting fields"
12986 When a message is received from a remote host over an encrypted SMTP
12987 connection, and Exim is configured to request a certificate from the client,
12988 the value of the Distinguished Name of the certificate is made available in the
12989 &$tls_in_peerdn$& during subsequent processing.
12990 If certificate verification fails it may refer to a failing chain element
12991 which is not the leaf.
12992
12993 The deprecated &$tls_peerdn$& variable refers to the inbound side
12994 except when used in the context of an outbound SMTP delivery, when it refers to
12995 the outbound.
12996
12997 .vitem &$tls_out_peerdn$&
12998 .vindex "&$tls_out_peerdn$&"
12999 When a message is being delivered to a remote host over an encrypted SMTP
13000 connection, and Exim is configured to request a certificate from the server,
13001 the value of the Distinguished Name of the certificate is made available in the
13002 &$tls_out_peerdn$& during subsequent processing.
13003 If certificate verification fails it may refer to a failing chain element
13004 which is not the leaf.
13005
13006 .vitem &$tls_in_sni$&
13007 .vindex "&$tls_in_sni$&"
13008 .vindex "&$tls_sni$&"
13009 .cindex "TLS" "Server Name Indication"
13010 When a TLS session is being established, if the client sends the Server
13011 Name Indication extension, the value will be placed in this variable.
13012 If the variable appears in &%tls_certificate%& then this option and
13013 some others, described in &<<SECTtlssni>>&,
13014 will be re-expanded early in the TLS session, to permit
13015 a different certificate to be presented (and optionally a different key to be
13016 used) to the client, based upon the value of the SNI extension.
13017
13018 The deprecated &$tls_sni$& variable refers to the inbound side
13019 except when used in the context of an outbound SMTP delivery, when it refers to
13020 the outbound.
13021
13022 .vitem &$tls_out_sni$&
13023 .vindex "&$tls_out_sni$&"
13024 .cindex "TLS" "Server Name Indication"
13025 During outbound
13026 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13027 the transport.
13028
13029 .vitem &$tod_bsdinbox$&
13030 .vindex "&$tod_bsdinbox$&"
13031 The time of day and the date, in the format required for BSD-style mailbox
13032 files, for example: Thu Oct 17 17:14:09 1995.
13033
13034 .vitem &$tod_epoch$&
13035 .vindex "&$tod_epoch$&"
13036 The time and date as a number of seconds since the start of the Unix epoch.
13037
13038 .vitem &$tod_epoch_l$&
13039 .vindex "&$tod_epoch_l$&"
13040 The time and date as a number of microseconds since the start of the Unix epoch.
13041
13042 .vitem &$tod_full$&
13043 .vindex "&$tod_full$&"
13044 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13045 +0100. The timezone is always given as a numerical offset from UTC, with
13046 positive values used for timezones that are ahead (east) of UTC, and negative
13047 values for those that are behind (west).
13048
13049 .vitem &$tod_log$&
13050 .vindex "&$tod_log$&"
13051 The time and date in the format used for writing Exim's log files, for example:
13052 1995-10-12 15:32:29, but without a timezone.
13053
13054 .vitem &$tod_logfile$&
13055 .vindex "&$tod_logfile$&"
13056 This variable contains the date in the format yyyymmdd. This is the format that
13057 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13058 flag.
13059
13060 .vitem &$tod_zone$&
13061 .vindex "&$tod_zone$&"
13062 This variable contains the numerical value of the local timezone, for example:
13063 -0500.
13064
13065 .vitem &$tod_zulu$&
13066 .vindex "&$tod_zulu$&"
13067 This variable contains the UTC date and time in &"Zulu"& format, as specified
13068 by ISO 8601, for example: 20030221154023Z.
13069
13070 .vitem &$transport_name$&
13071 .cindex "transport" "name"
13072 .cindex "name" "of transport"
13073 .vindex "&$transport_name$&"
13074 During the running of a transport, this variable contains its name.
13075
13076 .vitem &$value$&
13077 .vindex "&$value$&"
13078 This variable contains the result of an expansion lookup, extraction operation,
13079 or external command, as described above. It is also used during a
13080 &*reduce*& expansion.
13081
13082 .vitem &$verify_mode$&
13083 .vindex "&$verify_mode$&"
13084 While a router or transport is being run in verify mode or for cutthrough delivery,
13085 contains "S" for sender-verification or "R" for recipient-verification.
13086 Otherwise, empty.
13087
13088 .vitem &$version_number$&
13089 .vindex "&$version_number$&"
13090 The version number of Exim.
13091
13092 .vitem &$warn_message_delay$&
13093 .vindex "&$warn_message_delay$&"
13094 This variable is set only during the creation of a message warning about a
13095 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13096
13097 .vitem &$warn_message_recipients$&
13098 .vindex "&$warn_message_recipients$&"
13099 This variable is set only during the creation of a message warning about a
13100 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13101 .endlist
13102 .ecindex IIDstrexp
13103
13104
13105
13106 . ////////////////////////////////////////////////////////////////////////////
13107 . ////////////////////////////////////////////////////////////////////////////
13108
13109 .chapter "Embedded Perl" "CHAPperl"
13110 .scindex IIDperl "Perl" "calling from Exim"
13111 Exim can be built to include an embedded Perl interpreter. When this is done,
13112 Perl subroutines can be called as part of the string expansion process. To make
13113 use of the Perl support, you need version 5.004 or later of Perl installed on
13114 your system. To include the embedded interpreter in the Exim binary, include
13115 the line
13116 .code
13117 EXIM_PERL = perl.o
13118 .endd
13119 in your &_Local/Makefile_& and then build Exim in the normal way.
13120
13121
13122 .section "Setting up so Perl can be used" "SECID85"
13123 .oindex "&%perl_startup%&"
13124 Access to Perl subroutines is via a global configuration option called
13125 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13126 no &%perl_startup%& option in the Exim configuration file then no Perl
13127 interpreter is started and there is almost no overhead for Exim (since none of
13128 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13129 option then the associated value is taken to be Perl code which is executed in
13130 a newly created Perl interpreter.
13131
13132 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13133 need backslashes before any characters to escape special meanings. The option
13134 should usually be something like
13135 .code
13136 perl_startup = do '/etc/exim.pl'
13137 .endd
13138 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13139 use from Exim. Exim can be configured either to start up a Perl interpreter as
13140 soon as it is entered, or to wait until the first time it is needed. Starting
13141 the interpreter at the beginning ensures that it is done while Exim still has
13142 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13143 fact used in a particular run. Also, note that this does not mean that Exim is
13144 necessarily running as root when Perl is called at a later time. By default,
13145 the interpreter is started only when it is needed, but this can be changed in
13146 two ways:
13147
13148 .ilist
13149 .oindex "&%perl_at_start%&"
13150 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13151 a startup when Exim is entered.
13152 .next
13153 The command line option &%-ps%& also requests a startup when Exim is entered,
13154 overriding the setting of &%perl_at_start%&.
13155 .endlist
13156
13157 There is also a command line option &%-pd%& (for delay) which suppresses the
13158 initial startup, even if &%perl_at_start%& is set.
13159
13160 .ilist
13161 .oindex "&%perl_taintmode%&"
13162 .cindex "Perl" "taintmode"
13163 To provide more security executing Perl code via the embedded Perl
13164 interpreter, the &%perl_taintmode%& option can be set. This enables the
13165 taint mode of the Perl interpreter. You are encouraged to set this
13166 option to a true value. To avoid breaking existing installations, it
13167 defaults to false.
13168
13169
13170 .section "Calling Perl subroutines" "SECID86"
13171 When the configuration file includes a &%perl_startup%& option you can make use
13172 of the string expansion item to call the Perl subroutines that are defined
13173 by the &%perl_startup%& code. The operator is used in any of the following
13174 forms:
13175 .code
13176 ${perl{foo}}
13177 ${perl{foo}{argument}}
13178 ${perl{foo}{argument1}{argument2} ... }
13179 .endd
13180 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13181 arguments may be passed. Passing more than this results in an expansion failure
13182 with an error message of the form
13183 .code
13184 Too many arguments passed to Perl subroutine "foo" (max is 8)
13185 .endd
13186 The return value of the Perl subroutine is evaluated in a scalar context before
13187 it is passed back to Exim to be inserted into the expanded string. If the
13188 return value is &'undef'&, the expansion is forced to fail in the same way as
13189 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13190 by obeying Perl's &%die%& function, the expansion fails with the error message
13191 that was passed to &%die%&.
13192
13193
13194 .section "Calling Exim functions from Perl" "SECID87"
13195 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13196 is available to call back into Exim's string expansion function. For example,
13197 the Perl code
13198 .code
13199 my $lp = Exim::expand_string('$local_part');
13200 .endd
13201 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13202 Note those are single quotes and not double quotes to protect against
13203 &$local_part$& being interpolated as a Perl variable.
13204
13205 If the string expansion is forced to fail by a &"fail"& item, the result of
13206 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13207 expansion string, the Perl call from the original expansion string fails with
13208 an appropriate error message, in the same way as if &%die%& were used.
13209
13210 .cindex "debugging" "from embedded Perl"
13211 .cindex "log" "writing from embedded Perl"
13212 Two other Exim functions are available for use from within Perl code.
13213 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13214 debugging is enabled. If you want a newline at the end, you must supply it.
13215 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13216 timestamp. In this case, you should not supply a terminating newline.
13217
13218
13219 .section "Use of standard output and error by Perl" "SECID88"
13220 .cindex "Perl" "standard output and error"
13221 You should not write to the standard error or output streams from within your
13222 Perl code, as it is not defined how these are set up. In versions of Exim
13223 before 4.50, it is possible for the standard output or error to refer to the
13224 SMTP connection during message reception via the daemon. Writing to this stream
13225 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13226 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13227 avoided, but the output is lost.
13228
13229 .cindex "Perl" "use of &%warn%&"
13230 The Perl &%warn%& statement writes to the standard error stream by default.
13231 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13232 you have no control. When Exim starts up the Perl interpreter, it arranges for
13233 output from the &%warn%& statement to be written to the Exim main log. You can
13234 change this by including appropriate Perl magic somewhere in your Perl code.
13235 For example, to discard &%warn%& output completely, you need this:
13236 .code
13237 $SIG{__WARN__} = sub { };
13238 .endd
13239 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13240 example, the code for the subroutine is empty, so it does nothing, but you can
13241 include any Perl code that you like. The text of the &%warn%& message is passed
13242 as the first subroutine argument.
13243 .ecindex IIDperl
13244
13245
13246 . ////////////////////////////////////////////////////////////////////////////
13247 . ////////////////////////////////////////////////////////////////////////////
13248
13249 .chapter "Starting the daemon and the use of network interfaces" &&&
13250          "CHAPinterfaces" &&&
13251          "Starting the daemon"
13252 .cindex "daemon" "starting"
13253 .cindex "interface" "listening"
13254 .cindex "network interface"
13255 .cindex "interface" "network"
13256 .cindex "IP address" "for listening"
13257 .cindex "daemon" "listening IP addresses"
13258 .cindex "TCP/IP" "setting listening interfaces"
13259 .cindex "TCP/IP" "setting listening ports"
13260 A host that is connected to a TCP/IP network may have one or more physical
13261 hardware network interfaces. Each of these interfaces may be configured as one
13262 or more &"logical"& interfaces, which are the entities that a program actually
13263 works with. Each of these logical interfaces is associated with an IP address.
13264 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13265 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13266 knowledge about the host's interfaces for use in three different circumstances:
13267
13268 .olist
13269 When a listening daemon is started, Exim needs to know which interfaces
13270 and ports to listen on.
13271 .next
13272 When Exim is routing an address, it needs to know which IP addresses
13273 are associated with local interfaces. This is required for the correct
13274 processing of MX lists by removing the local host and others with the
13275 same or higher priority values. Also, Exim needs to detect cases
13276 when an address is routed to an IP address that in fact belongs to the
13277 local host. Unless the &%self%& router option or the &%allow_localhost%&
13278 option of the smtp transport is set (as appropriate), this is treated
13279 as an error situation.
13280 .next
13281 When Exim connects to a remote host, it may need to know which interface to use
13282 for the outgoing connection.
13283 .endlist
13284
13285
13286 Exim's default behaviour is likely to be appropriate in the vast majority
13287 of cases. If your host has only one interface, and you want all its IP
13288 addresses to be treated in the same way, and you are using only the
13289 standard SMTP port, you should not need to take any special action. The
13290 rest of this chapter does not apply to you.
13291
13292 In a more complicated situation you may want to listen only on certain
13293 interfaces, or on different ports, and for this reason there are a number of
13294 options that can be used to influence Exim's behaviour. The rest of this
13295 chapter describes how they operate.
13296
13297 When a message is received over TCP/IP, the interface and port that were
13298 actually used are set in &$received_ip_address$& and &$received_port$&.
13299
13300
13301
13302 .section "Starting a listening daemon" "SECID89"
13303 When a listening daemon is started (by means of the &%-bd%& command line
13304 option), the interfaces and ports on which it listens are controlled by the
13305 following options:
13306
13307 .ilist
13308 &%daemon_smtp_ports%& contains a list of default ports
13309 or service names.
13310 (For backward compatibility, this option can also be specified in the singular.)
13311 .next
13312 &%local_interfaces%& contains list of interface IP addresses on which to
13313 listen. Each item may optionally also specify a port.
13314 .endlist
13315
13316 The default list separator in both cases is a colon, but this can be changed as
13317 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13318 it is usually best to change the separator to avoid having to double all the
13319 colons. For example:
13320 .code
13321 local_interfaces = <; 127.0.0.1 ; \
13322                       192.168.23.65 ; \
13323                       ::1 ; \
13324                       3ffe:ffff:836f::fe86:a061
13325 .endd
13326 There are two different formats for specifying a port along with an IP address
13327 in &%local_interfaces%&:
13328
13329 .olist
13330 The port is added onto the address with a dot separator. For example, to listen
13331 on port 1234 on two different IP addresses:
13332 .code
13333 local_interfaces = <; 192.168.23.65.1234 ; \
13334                       3ffe:ffff:836f::fe86:a061.1234
13335 .endd
13336 .next
13337 The IP address is enclosed in square brackets, and the port is added
13338 with a colon separator, for example:
13339 .code
13340 local_interfaces = <; [192.168.23.65]:1234 ; \
13341                       [3ffe:ffff:836f::fe86:a061]:1234
13342 .endd
13343 .endlist
13344
13345 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13346 default setting contains just one port:
13347 .code
13348 daemon_smtp_ports = smtp
13349 .endd
13350 If more than one port is listed, each interface that does not have its own port
13351 specified listens on all of them. Ports that are listed in
13352 &%daemon_smtp_ports%& can be identified either by name (defined in
13353 &_/etc/services_&) or by number. However, when ports are given with individual
13354 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13355
13356
13357
13358 .section "Special IP listening addresses" "SECID90"
13359 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13360 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13361 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13362 instead of setting up separate listening sockets for each interface. The
13363 default value of &%local_interfaces%& is
13364 .code
13365 local_interfaces = 0.0.0.0
13366 .endd
13367 when Exim is built without IPv6 support; otherwise it is:
13368 .code
13369 local_interfaces = <; ::0 ; 0.0.0.0
13370 .endd
13371 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13372
13373
13374
13375 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13376 The &%-oX%& command line option can be used to override the values of
13377 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13378 instance. Another way of doing this would be to use macros and the &%-D%&
13379 option. However, &%-oX%& can be used by any admin user, whereas modification of
13380 the runtime configuration by &%-D%& is allowed only when the caller is root or
13381 exim.
13382
13383 The value of &%-oX%& is a list of items. The default colon separator can be
13384 changed in the usual way if required. If there are any items that do not
13385 contain dots or colons (that is, are not IP addresses), the value of
13386 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13387 items that do contain dots or colons, the value of &%local_interfaces%& is
13388 replaced by those items. Thus, for example,
13389 .code
13390 -oX 1225
13391 .endd
13392 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13393 whereas
13394 .code
13395 -oX 192.168.34.5.1125
13396 .endd
13397 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13398 (However, since &%local_interfaces%& now contains no items without ports, the
13399 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13400
13401
13402
13403 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13404 .cindex "ssmtp protocol"
13405 .cindex "smtps protocol"
13406 .cindex "SMTP" "ssmtp protocol"
13407 .cindex "SMTP" "smtps protocol"
13408 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13409 before the STARTTLS command was standardized for SMTP. Some legacy clients
13410 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13411 list of port numbers or service names,
13412 connections to those ports must use SSMTP. The most
13413 common use of this option is expected to be
13414 .code
13415 tls_on_connect_ports = 465
13416 .endd
13417 because 465 is the usual port number used by the legacy clients. There is also
13418 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13419 this way when a daemon is started.
13420
13421 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13422 daemon to listen on those ports. You must still specify them in
13423 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13424 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13425 connections via the daemon.)
13426
13427
13428
13429
13430 .section "IPv6 address scopes" "SECID92"
13431 .cindex "IPv6" "address scopes"
13432 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13433 can, in principle, have the same link-local IPv6 address on different
13434 interfaces. Thus, additional information is needed, over and above the IP
13435 address, to distinguish individual interfaces. A convention of using a
13436 percent sign followed by something (often the interface name) has been
13437 adopted in some cases, leading to addresses like this:
13438 .code
13439 fe80::202:b3ff:fe03:45c1%eth0
13440 .endd
13441 To accommodate this usage, a percent sign followed by an arbitrary string is
13442 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13443 to convert a textual IPv6 address for actual use. This function recognizes the
13444 percent convention in operating systems that support it, and it processes the
13445 address appropriately. Unfortunately, some older libraries have problems with
13446 &[getaddrinfo()]&. If
13447 .code
13448 IPV6_USE_INET_PTON=yes
13449 .endd
13450 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13451 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13452 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13453 function.) Of course, this means that the additional functionality of
13454 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13455
13456 .section "Disabling IPv6" "SECID93"
13457 .cindex "IPv6" "disabling"
13458 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13459 run on a host whose kernel does not support IPv6. The binary will fall back to
13460 using IPv4, but it may waste resources looking up AAAA records, and trying to
13461 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13462 .oindex "&%disable_ipv6%&"
13463 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13464 activities take place. AAAA records are never looked up, and any IPv6 addresses
13465 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13466 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13467 to handle IPv6 literal addresses.
13468
13469 On the other hand, when IPv6 is in use, there may be times when you want to
13470 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13471 option to globally suppress the lookup of AAAA records for specified domains,
13472 and you can use the &%ignore_target_hosts%& generic router option to ignore
13473 IPv6 addresses in an individual router.
13474
13475
13476
13477 .section "Examples of starting a listening daemon" "SECID94"
13478 The default case in an IPv6 environment is
13479 .code
13480 daemon_smtp_ports = smtp
13481 local_interfaces = <; ::0 ; 0.0.0.0
13482 .endd
13483 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13484 Either one or two sockets may be used, depending on the characteristics of
13485 the TCP/IP stack. (This is complicated and messy; for more information,
13486 read the comments in the &_daemon.c_& source file.)
13487
13488 To specify listening on ports 25 and 26 on all interfaces:
13489 .code
13490 daemon_smtp_ports = 25 : 26
13491 .endd
13492 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13493 .code
13494 local_interfaces = <; ::0.25     ; ::0.26 \
13495                       0.0.0.0.25 ; 0.0.0.0.26
13496 .endd
13497 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13498 IPv4 loopback address only:
13499 .code
13500 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13501 .endd
13502 To specify listening on the default port on specific interfaces only:
13503 .code
13504 local_interfaces = 10.0.0.67 : 192.168.34.67
13505 .endd
13506 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13507
13508
13509
13510 .section "Recognizing the local host" "SECTreclocipadd"
13511 The &%local_interfaces%& option is also used when Exim needs to determine
13512 whether or not an IP address refers to the local host. That is, the IP
13513 addresses of all the interfaces on which a daemon is listening are always
13514 treated as local.
13515
13516 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13517 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13518 available interfaces from the operating system, and extracts the relevant
13519 (that is, IPv4 or IPv6) addresses to use for checking.
13520
13521 Some systems set up large numbers of virtual interfaces in order to provide
13522 many virtual web servers. In this situation, you may want to listen for
13523 email on only a few of the available interfaces, but nevertheless treat all
13524 interfaces as local when routing. You can do this by setting
13525 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13526 &"all"& wildcard values. These addresses are recognized as local, but are not
13527 used for listening. Consider this example:
13528 .code
13529 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13530                       192.168.53.235 ; \
13531                       3ffe:2101:12:1:a00:20ff:fe86:a061
13532
13533 extra_local_interfaces = <; ::0 ; 0.0.0.0
13534 .endd
13535 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13536 address, but all available interface addresses are treated as local when
13537 Exim is routing.
13538
13539 In some environments the local host name may be in an MX list, but with an IP
13540 address that is not assigned to any local interface. In other cases it may be
13541 desirable to treat other host names as if they referred to the local host. Both
13542 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13543 This contains host names rather than IP addresses. When a host is referenced
13544 during routing, either via an MX record or directly, it is treated as the local
13545 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13546 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13547
13548
13549
13550 .section "Delivering to a remote host" "SECID95"
13551 Delivery to a remote host is handled by the smtp transport. By default, it
13552 allows the system's TCP/IP functions to choose which interface to use (if
13553 there is more than one) when connecting to a remote host. However, the
13554 &%interface%& option can be set to specify which interface is used. See the
13555 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13556 details.
13557
13558
13559
13560
13561 . ////////////////////////////////////////////////////////////////////////////
13562 . ////////////////////////////////////////////////////////////////////////////
13563
13564 .chapter "Main configuration" "CHAPmainconfig"
13565 .scindex IIDconfima "configuration file" "main section"
13566 .scindex IIDmaiconf "main configuration"
13567 The first part of the run time configuration file contains three types of item:
13568
13569 .ilist
13570 Macro definitions: These lines start with an upper case letter. See section
13571 &<<SECTmacrodefs>>& for details of macro processing.
13572 .next
13573 Named list definitions: These lines start with one of the words &"domainlist"&,
13574 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13575 section &<<SECTnamedlists>>&.
13576 .next
13577 Main configuration settings: Each setting occupies one line of the file
13578 (with possible continuations). If any setting is preceded by the word
13579 &"hide"&, the &%-bP%& command line option displays its value to admin users
13580 only. See section &<<SECTcos>>& for a description of the syntax of these option
13581 settings.
13582 .endlist
13583
13584 This chapter specifies all the main configuration options, along with their
13585 types and default values. For ease of finding a particular option, they appear
13586 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13587 are now so many options, they are first listed briefly in functional groups, as
13588 an aid to finding the name of the option you are looking for. Some options are
13589 listed in more than one group.
13590
13591 .section "Miscellaneous" "SECID96"
13592 .table2
13593 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13594 .row &%debug_store%&                 "do extra internal checks"
13595 .row &%disable_ipv6%&                "do no IPv6 processing"
13596 .row &%keep_malformed%&              "for broken files &-- should not happen"
13597 .row &%localhost_number%&            "for unique message ids in clusters"
13598 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13599 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13600 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13601 .row &%print_topbitchars%&           "top-bit characters are printing"
13602 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
13603 .row &%timezone%&                    "force time zone"
13604 .endtable
13605
13606
13607 .section "Exim parameters" "SECID97"
13608 .table2
13609 .row &%exim_group%&                  "override compiled-in value"
13610 .row &%exim_path%&                   "override compiled-in value"
13611 .row &%exim_user%&                   "override compiled-in value"
13612 .row &%primary_hostname%&            "default from &[uname()]&"
13613 .row &%split_spool_directory%&       "use multiple directories"
13614 .row &%spool_directory%&             "override compiled-in value"
13615 .endtable
13616
13617
13618
13619 .section "Privilege controls" "SECID98"
13620 .table2
13621 .row &%admin_groups%&                "groups that are Exim admin users"
13622 .row &%commandline_checks_require_admin%& "require admin for various checks"
13623 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13624 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13625 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13626 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13627 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13628 .row &%never_users%&                 "do not run deliveries as these"
13629 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13630 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13631 .row &%trusted_groups%&              "groups that are trusted"
13632 .row &%trusted_users%&               "users that are trusted"
13633 .endtable
13634
13635
13636
13637 .section "Logging" "SECID99"
13638 .table2
13639 .row &%event_action%&                "custom logging"
13640 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13641 .row &%log_file_path%&               "override compiled-in value"
13642 .row &%log_selector%&                "set/unset optional logging"
13643 .row &%log_timezone%&                "add timezone to log lines"
13644 .row &%message_logs%&                "create per-message logs"
13645 .row &%preserve_message_logs%&       "after message completion"
13646 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13647 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13648 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13649 .row &%syslog_facility%&             "set syslog &""facility""& field"
13650 .row &%syslog_pid%&                  "pid in syslog lines"
13651 .row &%syslog_processname%&          "set syslog &""ident""& field"
13652 .row &%syslog_timestamp%&            "timestamp syslog lines"
13653 .row &%write_rejectlog%&             "control use of message log"
13654 .endtable
13655
13656
13657
13658 .section "Frozen messages" "SECID100"
13659 .table2
13660 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13661 .row &%freeze_tell%&                 "send message when freezing"
13662 .row &%move_frozen_messages%&        "to another directory"
13663 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13664 .endtable
13665
13666
13667
13668 .section "Data lookups" "SECID101"
13669 .table2
13670 .row &%ibase_servers%&               "InterBase servers"
13671 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13672 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13673 .row &%ldap_cert_file%&              "client cert file for LDAP"
13674 .row &%ldap_cert_key%&               "client key file for LDAP"
13675 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13676 .row &%ldap_default_servers%&        "used if no server in query"
13677 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13678 .row &%ldap_start_tls%&              "require TLS within LDAP"
13679 .row &%ldap_version%&                "set protocol version"
13680 .row &%lookup_open_max%&             "lookup files held open"
13681 .row &%mysql_servers%&               "default MySQL servers"
13682 .row &%oracle_servers%&              "Oracle servers"
13683 .row &%pgsql_servers%&               "default PostgreSQL servers"
13684 .row &%sqlite_lock_timeout%&         "as it says"
13685 .endtable
13686
13687
13688
13689 .section "Message ids" "SECID102"
13690 .table2
13691 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13692 .row &%message_id_header_text%&      "ditto"
13693 .endtable
13694
13695
13696
13697 .section "Embedded Perl Startup" "SECID103"
13698 .table2
13699 .row &%perl_at_start%&               "always start the interpreter"
13700 .row &%perl_startup%&                "code to obey when starting Perl"
13701 .row &%perl_taintmode%&              "enable taint mode in Perl"
13702 .endtable
13703
13704
13705
13706 .section "Daemon" "SECID104"
13707 .table2
13708 .row &%daemon_smtp_ports%&           "default ports"
13709 .row &%daemon_startup_retries%&      "number of times to retry"
13710 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13711 .row &%extra_local_interfaces%&      "not necessarily listened on"
13712 .row &%local_interfaces%&            "on which to listen, with optional ports"
13713 .row &%pid_file_path%&               "override compiled-in value"
13714 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13715 .endtable
13716
13717
13718
13719 .section "Resource control" "SECID105"
13720 .table2
13721 .row &%check_log_inodes%&            "before accepting a message"
13722 .row &%check_log_space%&             "before accepting a message"
13723 .row &%check_spool_inodes%&          "before accepting a message"
13724 .row &%check_spool_space%&           "before accepting a message"
13725 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13726 .row &%queue_only_load%&             "queue incoming if load high"
13727 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13728 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13729 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13730 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13731 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13732 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13733 .row &%smtp_accept_max_per_connection%& "messages per connection"
13734 .row &%smtp_accept_max_per_host%&    "connections from one host"
13735 .row &%smtp_accept_queue%&           "queue mail if more connections"
13736 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13737                                            connection"
13738 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13739 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13740 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13741 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13742 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13743 .endtable
13744
13745
13746
13747 .section "Policy controls" "SECID106"
13748 .table2
13749 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13750 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13751 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13752 .row &%acl_smtp_auth%&               "ACL for AUTH"
13753 .row &%acl_smtp_connect%&            "ACL for connection"
13754 .row &%acl_smtp_data%&               "ACL for DATA"
13755 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13756 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13757 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13758 .row &%acl_smtp_expn%&               "ACL for EXPN"
13759 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13760 .row &%acl_smtp_mail%&               "ACL for MAIL"
13761 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13762 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13763 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13764 .row &%acl_smtp_predata%&            "ACL for start of data"
13765 .row &%acl_smtp_quit%&               "ACL for QUIT"
13766 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13767 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13768 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13769 .row &%av_scanner%&                  "specify virus scanner"
13770 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13771                                       words""&"
13772 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13773 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13774 .row &%header_maxsize%&              "total size of message header"
13775 .row &%header_line_maxsize%&         "individual header line limit"
13776 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13777 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13778 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13779 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13780 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13781 .row &%host_lookup%&                 "host name looked up for these hosts"
13782 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13783 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13784 .row &%host_reject_connection%&      "reject connection from these hosts"
13785 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13786 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13787 .row &%message_size_limit%&          "for all messages"
13788 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13789 .row &%spamd_address%&               "set interface to SpamAssassin"
13790 .row &%strict_acl_vars%&             "object to unset ACL variables"
13791 .endtable
13792
13793
13794
13795 .section "Callout cache" "SECID107"
13796 .table2
13797 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13798                                          item"
13799 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13800                                          item"
13801 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13802 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13803 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13804 .endtable
13805
13806
13807
13808 .section "TLS" "SECID108"
13809 .table2
13810 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13811 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13812 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13813 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13814 .row &%tls_certificate%&             "location of server certificate"
13815 .row &%tls_crl%&                     "certificate revocation list"
13816 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13817 .row &%tls_dhparam%&                 "DH parameters for server"
13818 .row &%tls_eccurve%&                 "EC curve selection for server"
13819 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13820 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13821 .row &%tls_privatekey%&              "location of server private key"
13822 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13823 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13824 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13825 .row &%tls_verify_certificates%&     "expected client certificates"
13826 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13827 .endtable
13828
13829
13830
13831 .section "Local user handling" "SECID109"
13832 .table2
13833 .row &%finduser_retries%&            "useful in NIS environments"
13834 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13835 .row &%gecos_pattern%&               "ditto"
13836 .row &%max_username_length%&         "for systems that truncate"
13837 .row &%unknown_login%&               "used when no login name found"
13838 .row &%unknown_username%&            "ditto"
13839 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13840 .row &%uucp_from_sender%&            "ditto"
13841 .endtable
13842
13843
13844
13845 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13846 .table2
13847 .row &%header_maxsize%&              "total size of message header"
13848 .row &%header_line_maxsize%&         "individual header line limit"
13849 .row &%message_size_limit%&          "applies to all messages"
13850 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13851 .row &%received_header_text%&        "expanded to make &'Received:'&"
13852 .row &%received_headers_max%&        "for mail loop detection"
13853 .row &%recipients_max%&              "limit per message"
13854 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13855 .endtable
13856
13857
13858
13859
13860 .section "Non-SMTP incoming messages" "SECID111"
13861 .table2
13862 .row &%receive_timeout%&             "for non-SMTP messages"
13863 .endtable
13864
13865
13866
13867
13868
13869 .section "Incoming SMTP messages" "SECID112"
13870 See also the &'Policy controls'& section above.
13871
13872 .table2
13873 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13874 .row &%host_lookup%&                 "host name looked up for these hosts"
13875 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13876 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13877 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13878 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13879 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13880 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13881 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13882 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13883 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13884 .row &%smtp_accept_max_per_connection%& "messages per connection"
13885 .row &%smtp_accept_max_per_host%&    "connections from one host"
13886 .row &%smtp_accept_queue%&           "queue mail if more connections"
13887 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13888                                            connection"
13889 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13890 .row &%smtp_active_hostname%&        "host name to use in messages"
13891 .row &%smtp_banner%&                 "text for welcome banner"
13892 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13893 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13894 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13895 .row &%smtp_etrn_command%&           "what to run for ETRN"
13896 .row &%smtp_etrn_serialize%&         "only one at once"
13897 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13898 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13899 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13900 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13901 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13902 .row &%smtp_receive_timeout%&        "per command or data line"
13903 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13904 .row &%smtp_return_error_details%&   "give detail on rejections"
13905 .endtable
13906
13907
13908
13909 .section "SMTP extensions" "SECID113"
13910 .table2
13911 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13912 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13913 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
13914 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13915 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13916 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13917 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13918 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13919 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13920 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13921 .endtable
13922
13923
13924
13925 .section "Processing messages" "SECID114"
13926 .table2
13927 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13928 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13929 .row &%allow_utf8_domains%&          "in addresses"
13930 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13931                                       words""&"
13932 .row &%delivery_date_remove%&        "from incoming messages"
13933 .row &%envelope_to_remove%&          "from incoming messages"
13934 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13935 .row &%headers_charset%&             "default for translations"
13936 .row &%qualify_domain%&              "default for senders"
13937 .row &%qualify_recipient%&           "default for recipients"
13938 .row &%return_path_remove%&          "from incoming messages"
13939 .row &%strip_excess_angle_brackets%& "in addresses"
13940 .row &%strip_trailing_dot%&          "at end of addresses"
13941 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13942 .endtable
13943
13944
13945
13946 .section "System filter" "SECID115"
13947 .table2
13948 .row &%system_filter%&               "locate system filter"
13949 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13950                                             directory"
13951 .row &%system_filter_file_transport%& "transport for delivery to a file"
13952 .row &%system_filter_group%&         "group for filter running"
13953 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13954 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13955 .row &%system_filter_user%&          "user for filter running"
13956 .endtable
13957
13958
13959
13960 .section "Routing and delivery" "SECID116"
13961 .table2
13962 .row &%disable_ipv6%&                "do no IPv6 processing"
13963 .row &%dns_again_means_nonexist%&    "for broken domains"
13964 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13965 .row &%dns_dnssec_ok%&               "parameter for resolver"
13966 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13967 .row &%dns_retrans%&                 "parameter for resolver"
13968 .row &%dns_retry%&                   "parameter for resolver"
13969 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13970 .row &%dns_use_edns0%&               "parameter for resolver"
13971 .row &%hold_domains%&                "hold delivery for these domains"
13972 .row &%local_interfaces%&            "for routing checks"
13973 .row &%queue_domains%&               "no immediate delivery for these"
13974 .row &%queue_only%&                  "no immediate delivery at all"
13975 .row &%queue_only_file%&             "no immediate delivery if file exists"
13976 .row &%queue_only_load%&             "no immediate delivery if load is high"
13977 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13978 .row &%queue_only_override%&         "allow command line to override"
13979 .row &%queue_run_in_order%&          "order of arrival"
13980 .row &%queue_run_max%&               "of simultaneous queue runners"
13981 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13982 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13983 .row &%remote_sort_domains%&         "order of remote deliveries"
13984 .row &%retry_data_expire%&           "timeout for retry data"
13985 .row &%retry_interval_max%&          "safety net for retry rules"
13986 .endtable
13987
13988
13989
13990 .section "Bounce and warning messages" "SECID117"
13991 .table2
13992 .row &%bounce_message_file%&         "content of bounce"
13993 .row &%bounce_message_text%&         "content of bounce"
13994 .row &%bounce_return_body%&          "include body if returning message"
13995 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13996 .row &%bounce_return_message%&       "include original message in bounce"
13997 .row &%bounce_return_size_limit%&    "limit on returned message"
13998 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13999 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14000 .row &%errors_copy%&                 "copy bounce messages"
14001 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14002 .row &%delay_warning%&               "time schedule"
14003 .row &%delay_warning_condition%&     "condition for warning messages"
14004 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14005 .row &%smtp_return_error_details%&   "give detail on rejections"
14006 .row &%warn_message_file%&           "content of warning message"
14007 .endtable
14008
14009
14010
14011 .section "Alphabetical list of main options" "SECTalomo"
14012 Those options that undergo string expansion before use are marked with
14013 &dagger;.
14014
14015 .option accept_8bitmime main boolean true
14016 .cindex "8BITMIME"
14017 .cindex "8-bit characters"
14018 .cindex "log" "selectors"
14019 .cindex "log" "8BITMIME"
14020 This option causes Exim to send 8BITMIME in its response to an SMTP
14021 EHLO command, and to accept the BODY= parameter on MAIL commands.
14022 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14023 takes no steps to do anything special with messages received by this route.
14024
14025 Historically Exim kept this option off by default, but the maintainers
14026 feel that in today's Internet, this causes more problems than it solves.
14027 It now defaults to true.
14028 A more detailed analysis of the issues is provided by Dan Bernstein:
14029 .display
14030 &url(http://cr.yp.to/smtp/8bitmime.html)
14031 .endd
14032
14033 To log received 8BITMIME status use
14034 .code
14035 log_selector = +8bitmime
14036 .endd
14037
14038 .option acl_not_smtp main string&!! unset
14039 .cindex "&ACL;" "for non-SMTP messages"
14040 .cindex "non-SMTP messages" "ACLs for"
14041 This option defines the ACL that is run when a non-SMTP message has been
14042 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14043 further details.
14044
14045 .option acl_not_smtp_mime main string&!! unset
14046 This option defines the ACL that is run for individual MIME parts of non-SMTP
14047 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14048 SMTP messages.
14049
14050 .option acl_not_smtp_start main string&!! unset
14051 .cindex "&ACL;" "at start of non-SMTP message"
14052 .cindex "non-SMTP messages" "ACLs for"
14053 This option defines the ACL that is run before Exim starts reading a
14054 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14055
14056 .option acl_smtp_auth main string&!! unset
14057 .cindex "&ACL;" "setting up for SMTP commands"
14058 .cindex "AUTH" "ACL for"
14059 This option defines the ACL that is run when an SMTP AUTH command is
14060 received. See chapter &<<CHAPACL>>& for further details.
14061
14062 .option acl_smtp_connect main string&!! unset
14063 .cindex "&ACL;" "on SMTP connection"
14064 This option defines the ACL that is run when an SMTP connection is received.
14065 See chapter &<<CHAPACL>>& for further details.
14066
14067 .option acl_smtp_data main string&!! unset
14068 .cindex "DATA" "ACL for"
14069 This option defines the ACL that is run after an SMTP DATA command has been
14070 processed and the message itself has been received, but before the final
14071 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14072
14073 .option acl_smtp_data_prdr main string&!! accept
14074 .cindex "PRDR" "ACL for"
14075 .cindex "DATA" "PRDR ACL for"
14076 .cindex "&ACL;" "PRDR-related"
14077 .cindex "&ACL;" "per-user data processing"
14078 This option defines the ACL that,
14079 if the PRDR feature has been negotiated,
14080 is run for each recipient after an SMTP DATA command has been
14081 processed and the message itself has been received, but before the
14082 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14083
14084 .option acl_smtp_dkim main string&!! unset
14085 .cindex DKIM "ACL for"
14086 This option defines the ACL that is run for each DKIM signature
14087 (by default, or as specified in the dkim_verify_signers option)
14088 of a received message.
14089 See chapter &<<CHAPdkim>>& for further details.
14090
14091 .option acl_smtp_etrn main string&!! unset
14092 .cindex "ETRN" "ACL for"
14093 This option defines the ACL that is run when an SMTP ETRN command is
14094 received. See chapter &<<CHAPACL>>& for further details.
14095
14096 .option acl_smtp_expn main string&!! unset
14097 .cindex "EXPN" "ACL for"
14098 This option defines the ACL that is run when an SMTP EXPN command is
14099 received. See chapter &<<CHAPACL>>& for further details.
14100
14101 .option acl_smtp_helo main string&!! unset
14102 .cindex "EHLO" "ACL for"
14103 .cindex "HELO" "ACL for"
14104 This option defines the ACL that is run when an SMTP EHLO or HELO
14105 command is received. See chapter &<<CHAPACL>>& for further details.
14106
14107
14108 .option acl_smtp_mail main string&!! unset
14109 .cindex "MAIL" "ACL for"
14110 This option defines the ACL that is run when an SMTP MAIL command is
14111 received. See chapter &<<CHAPACL>>& for further details.
14112
14113 .option acl_smtp_mailauth main string&!! unset
14114 .cindex "AUTH" "on MAIL command"
14115 This option defines the ACL that is run when there is an AUTH parameter on
14116 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14117 &<<CHAPSMTPAUTH>>& for details of authentication.
14118
14119 .option acl_smtp_mime main string&!! unset
14120 .cindex "MIME content scanning" "ACL for"
14121 This option is available when Exim is built with the content-scanning
14122 extension. It defines the ACL that is run for each MIME part in a message. See
14123 section &<<SECTscanmimepart>>& for details.
14124
14125 .option acl_smtp_notquit main string&!! unset
14126 .cindex "not-QUIT, ACL for"
14127 This option defines the ACL that is run when an SMTP session
14128 ends without a QUIT command being received.
14129 See chapter &<<CHAPACL>>& for further details.
14130
14131 .option acl_smtp_predata main string&!! unset
14132 This option defines the ACL that is run when an SMTP DATA command is
14133 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14134 further details.
14135
14136 .option acl_smtp_quit main string&!! unset
14137 .cindex "QUIT, ACL for"
14138 This option defines the ACL that is run when an SMTP QUIT command is
14139 received. See chapter &<<CHAPACL>>& for further details.
14140
14141 .option acl_smtp_rcpt main string&!! unset
14142 .cindex "RCPT" "ACL for"
14143 This option defines the ACL that is run when an SMTP RCPT command is
14144 received. See chapter &<<CHAPACL>>& for further details.
14145
14146 .option acl_smtp_starttls main string&!! unset
14147 .cindex "STARTTLS, ACL for"
14148 This option defines the ACL that is run when an SMTP STARTTLS command is
14149 received. See chapter &<<CHAPACL>>& for further details.
14150
14151 .option acl_smtp_vrfy main string&!! unset
14152 .cindex "VRFY" "ACL for"
14153 This option defines the ACL that is run when an SMTP VRFY command is
14154 received. See chapter &<<CHAPACL>>& for further details.
14155
14156 .option add_environment main "string list" empty
14157 .cindex "environment" "set values"
14158 This option allows to set individual environment variables that the
14159 currently linked libraries and programs in child processes use.
14160 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14161
14162 .option admin_groups main "string list&!!" unset
14163 .cindex "admin user"
14164 This option is expanded just once, at the start of Exim's processing. If the
14165 current group or any of the supplementary groups of an Exim caller is in this
14166 colon-separated list, the caller has admin privileges. If all your system
14167 programmers are in a specific group, for example, you can give them all Exim
14168 admin privileges by putting that group in &%admin_groups%&. However, this does
14169 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14170 To permit this, you have to add individuals to the Exim group.
14171
14172 .option allow_domain_literals main boolean false
14173 .cindex "domain literal"
14174 If this option is set, the RFC 2822 domain literal format is permitted in
14175 email addresses. The option is not set by default, because the domain literal
14176 format is not normally required these days, and few people know about it. It
14177 has, however, been exploited by mail abusers.
14178
14179 Unfortunately, it seems that some DNS black list maintainers are using this
14180 format to report black listing to postmasters. If you want to accept messages
14181 addressed to your hosts by IP address, you need to set
14182 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14183 domains (defined in the named domain list &%local_domains%& in the default
14184 configuration). This &"magic string"& matches the domain literal form of all
14185 the local host's IP addresses.
14186
14187
14188 .option allow_mx_to_ip main boolean false
14189 .cindex "MX record" "pointing to IP address"
14190 It appears that more and more DNS zone administrators are breaking the rules
14191 and putting domain names that look like IP addresses on the right hand side of
14192 MX records. Exim follows the rules and rejects this, giving an error message
14193 that explains the misconfiguration. However, some other MTAs support this
14194 practice, so to avoid &"Why can't Exim do this?"& complaints,
14195 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14196 recommended, except when you have no other choice.
14197
14198 .option allow_utf8_domains main boolean false
14199 .cindex "domain" "UTF-8 characters in"
14200 .cindex "UTF-8" "in domain name"
14201 Lots of discussion is going on about internationalized domain names. One
14202 camp is strongly in favour of just using UTF-8 characters, and it seems
14203 that at least two other MTAs permit this. This option allows Exim users to
14204 experiment if they wish.
14205
14206 If it is set true, Exim's domain parsing function allows valid
14207 UTF-8 multicharacters to appear in domain name components, in addition to
14208 letters, digits, and hyphens. However, just setting this option is not
14209 enough; if you want to look up these domain names in the DNS, you must also
14210 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14211 suitable setting is:
14212 .code
14213 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14214   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14215 .endd
14216 Alternatively, you can just disable this feature by setting
14217 .code
14218 dns_check_names_pattern =
14219 .endd
14220 That is, set the option to an empty string so that no check is done.
14221
14222
14223 .option auth_advertise_hosts main "host list&!!" *
14224 .cindex "authentication" "advertising"
14225 .cindex "AUTH" "advertising"
14226 If any server authentication mechanisms are configured, Exim advertises them in
14227 response to an EHLO command only if the calling host matches this list.
14228 Otherwise, Exim does not advertise AUTH.
14229 Exim does not accept AUTH commands from clients to which it has not
14230 advertised the availability of AUTH. The advertising of individual
14231 authentication mechanisms can be controlled by the use of the
14232 &%server_advertise_condition%& generic authenticator option on the individual
14233 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14234
14235 Certain mail clients (for example, Netscape) require the user to provide a name
14236 and password for authentication if AUTH is advertised, even though it may
14237 not be needed (the host may accept messages from hosts on its local LAN without
14238 authentication, for example). The &%auth_advertise_hosts%& option can be used
14239 to make these clients more friendly by excluding them from the set of hosts to
14240 which Exim advertises AUTH.
14241
14242 .cindex "AUTH" "advertising when encrypted"
14243 If you want to advertise the availability of AUTH only when the connection
14244 is encrypted using TLS, you can make use of the fact that the value of this
14245 option is expanded, with a setting like this:
14246 .code
14247 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14248 .endd
14249 .vindex "&$tls_in_cipher$&"
14250 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14251 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14252 expansion is *, which matches all hosts.
14253
14254
14255 .option auto_thaw main time 0s
14256 .cindex "thawing messages"
14257 .cindex "unfreezing messages"
14258 If this option is set to a time greater than zero, a queue runner will try a
14259 new delivery attempt on any frozen message, other than a bounce message, if
14260 this much time has passed since it was frozen. This may result in the message
14261 being re-frozen if nothing has changed since the last attempt. It is a way of
14262 saying &"keep on trying, even though there are big problems"&.
14263
14264 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14265 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14266 thought to be very useful any more, and its use should probably be avoided.
14267
14268
14269 .option av_scanner main string "see below"
14270 This option is available if Exim is built with the content-scanning extension.
14271 It specifies which anti-virus scanner to use. The default value is:
14272 .code
14273 sophie:/var/run/sophie
14274 .endd
14275 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14276 before use. See section &<<SECTscanvirus>>& for further details.
14277
14278
14279 .option bi_command main string unset
14280 .oindex "&%-bi%&"
14281 This option supplies the name of a command that is run when Exim is called with
14282 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14283 just the command name, it is not a complete command line. If an argument is
14284 required, it must come from the &%-oA%& command line option.
14285
14286
14287 .option bounce_message_file main string unset
14288 .cindex "bounce message" "customizing"
14289 .cindex "customizing" "bounce message"
14290 This option defines a template file containing paragraphs of text to be used
14291 for constructing bounce messages.  Details of the file's contents are given in
14292 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14293
14294
14295 .option bounce_message_text main string unset
14296 When this option is set, its contents are included in the default bounce
14297 message immediately after &"This message was created automatically by mail
14298 delivery software."& It is not used if &%bounce_message_file%& is set.
14299
14300 .option bounce_return_body main boolean true
14301 .cindex "bounce message" "including body"
14302 This option controls whether the body of an incoming message is included in a
14303 bounce message when &%bounce_return_message%& is true. The default setting
14304 causes the entire message, both header and body, to be returned (subject to the
14305 value of &%bounce_return_size_limit%&). If this option is false, only the
14306 message header is included. In the case of a non-SMTP message containing an
14307 error that is detected during reception, only those header lines preceding the
14308 point at which the error was detected are returned.
14309 .cindex "bounce message" "including original"
14310
14311 .option bounce_return_linesize_limit main integer 998
14312 .cindex "size" "of bounce lines, limit"
14313 .cindex "bounce message" "line length limit"
14314 .cindex "limit" "bounce message line length"
14315 This option sets a limit in bytes on the line length of messages
14316 that are returned to senders due to delivery problems,
14317 when &%bounce_return_message%& is true.
14318 The default value corresponds to RFC limits.
14319 If the message being returned has lines longer than this value it is
14320 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14321
14322 The option also applies to bounces returned when an error is detected
14323 during reception of a message.
14324 In this case lines from the original are truncated.
14325
14326 The option does not apply to messages generated by an &(autoreply)& transport.
14327
14328
14329 .option bounce_return_message main boolean true
14330 If this option is set false, none of the original message is included in
14331 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14332 &%bounce_return_body%&.
14333
14334
14335 .option bounce_return_size_limit main integer 100K
14336 .cindex "size" "of bounce, limit"
14337 .cindex "bounce message" "size limit"
14338 .cindex "limit" "bounce message size"
14339 This option sets a limit in bytes on the size of messages that are returned to
14340 senders as part of bounce messages when &%bounce_return_message%& is true. The
14341 limit should be less than the value of the global &%message_size_limit%& and of
14342 any &%message_size_limit%& settings on transports, to allow for the bounce text
14343 that Exim generates. If this option is set to zero there is no limit.
14344
14345 When the body of any message that is to be included in a bounce message is
14346 greater than the limit, it is truncated, and a comment pointing this out is
14347 added at the top. The actual cutoff may be greater than the value given, owing
14348 to the use of buffering for transferring the message in chunks (typically 8K in
14349 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14350 messages.
14351
14352 .option bounce_sender_authentication main string unset
14353 .cindex "bounce message" "sender authentication"
14354 .cindex "authentication" "bounce message"
14355 .cindex "AUTH" "on bounce message"
14356 This option provides an authenticated sender address that is sent with any
14357 bounce messages generated by Exim that are sent over an authenticated SMTP
14358 connection. A typical setting might be:
14359 .code
14360 bounce_sender_authentication = mailer-daemon@my.domain.example
14361 .endd
14362 which would cause bounce messages to be sent using the SMTP command:
14363 .code
14364 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14365 .endd
14366 The value of &%bounce_sender_authentication%& must always be a complete email
14367 address.
14368
14369 .option callout_domain_negative_expire main time 3h
14370 .cindex "caching" "callout timeouts"
14371 .cindex "callout" "caching timeouts"
14372 This option specifies the expiry time for negative callout cache data for a
14373 domain. See section &<<SECTcallver>>& for details of callout verification, and
14374 section &<<SECTcallvercache>>& for details of the caching.
14375
14376
14377 .option callout_domain_positive_expire main time 7d
14378 This option specifies the expiry time for positive callout cache data for a
14379 domain. See section &<<SECTcallver>>& for details of callout verification, and
14380 section &<<SECTcallvercache>>& for details of the caching.
14381
14382
14383 .option callout_negative_expire main time 2h
14384 This option specifies the expiry time for negative callout cache data for an
14385 address. See section &<<SECTcallver>>& for details of callout verification, and
14386 section &<<SECTcallvercache>>& for details of the caching.
14387
14388
14389 .option callout_positive_expire main time 24h
14390 This option specifies the expiry time for positive callout cache data for an
14391 address. See section &<<SECTcallver>>& for details of callout verification, and
14392 section &<<SECTcallvercache>>& for details of the caching.
14393
14394
14395 .option callout_random_local_part main string&!! "see below"
14396 This option defines the &"random"& local part that can be used as part of
14397 callout verification. The default value is
14398 .code
14399 $primary_hostname-$tod_epoch-testing
14400 .endd
14401 See section &<<CALLaddparcall>>& for details of how this value is used.
14402
14403
14404 .option check_log_inodes main integer 100
14405 See &%check_spool_space%& below.
14406
14407
14408 .option check_log_space main integer 10M
14409 See &%check_spool_space%& below.
14410
14411 .oindex "&%check_rfc2047_length%&"
14412 .cindex "RFC 2047" "disabling length check"
14413 .option check_rfc2047_length main boolean true
14414 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14415 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14416 word; strings to be encoded that exceed this length are supposed to use
14417 multiple encoded words. By default, Exim does not recognize encoded words that
14418 exceed the maximum length. However, it seems that some software, in violation
14419 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14420 set false, Exim recognizes encoded words of any length.
14421
14422
14423 .option check_spool_inodes main integer 100
14424 See &%check_spool_space%& below.
14425
14426
14427 .option check_spool_space main integer 10M
14428 .cindex "checking disk space"
14429 .cindex "disk space, checking"
14430 .cindex "spool directory" "checking space"
14431 The four &%check_...%& options allow for checking of disk resources before a
14432 message is accepted.
14433
14434 .vindex "&$log_inodes$&"
14435 .vindex "&$log_space$&"
14436 .vindex "&$spool_inodes$&"
14437 .vindex "&$spool_space$&"
14438 When any of these options are nonzero, they apply to all incoming messages. If you
14439 want to apply different checks to different kinds of message, you can do so by
14440 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14441 &$spool_space$& in an ACL with appropriate additional conditions.
14442
14443
14444 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14445 either value is greater than zero, for example:
14446 .code
14447 check_spool_space = 100M
14448 check_spool_inodes = 100
14449 .endd
14450 The spool partition is the one that contains the directory defined by
14451 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14452 transit.
14453
14454 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14455 files are written if either is greater than zero. These should be set only if
14456 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14457
14458 If there is less space or fewer inodes than requested, Exim refuses to accept
14459 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14460 error response to the MAIL command. If ESMTP is in use and there was a
14461 SIZE parameter on the MAIL command, its value is added to the
14462 &%check_spool_space%& value, and the check is performed even if
14463 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14464
14465 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14466 number of kilobytes (though specified in bytes).
14467 If a non-multiple of 1024 is specified, it is rounded up.
14468
14469 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14470 failure a message is written to stderr and Exim exits with a non-zero code, as
14471 it obviously cannot send an error message of any kind.
14472
14473 There is a slight performance penalty for these checks.
14474 Versions of Exim preceding 4.88 had these disabled by default;
14475 high-rate installations confident they will never run out of resources
14476 may wish to deliberately disable them.
14477
14478 .option chunking_advertise_hosts main "host list&!!" *
14479 .cindex CHUNKING advertisement
14480 .cindex "RFC 3030" "CHUNKING"
14481 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14482 these hosts.
14483 Hosts may use the BDAT command as an alternate to DATA.
14484
14485 .option commandline_checks_require_admin main boolean &`false`&
14486 .cindex "restricting access to features"
14487 This option restricts various basic checking features to require an
14488 administrative user.
14489 This affects most of the &%-b*%& options, such as &%-be%&.
14490
14491 .option debug_store main boolean &`false`&
14492 .cindex debugging "memory corruption"
14493 .cindex memory debugging
14494 This option, when true, enables extra checking in Exim's internal memory
14495 management.  For use when a memory corruption issue is being investigated,
14496 it should normally be left as default.
14497
14498 .option daemon_smtp_ports main string &`smtp`&
14499 .cindex "port" "for daemon"
14500 .cindex "TCP/IP" "setting listening ports"
14501 This option specifies one or more default SMTP ports on which the Exim daemon
14502 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14503 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14504
14505 .option daemon_startup_retries main integer 9
14506 .cindex "daemon startup, retrying"
14507 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14508 the daemon at startup when it cannot immediately bind a listening socket
14509 (typically because the socket is already in use): &%daemon_startup_retries%&
14510 defines the number of retries after the first failure, and
14511 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14512
14513 .option daemon_startup_sleep main time 30s
14514 See &%daemon_startup_retries%&.
14515
14516 .option delay_warning main "time list" 24h
14517 .cindex "warning of delay"
14518 .cindex "delay warning, specifying"
14519 .cindex "queue" "delay warning"
14520 When a message is delayed, Exim sends a warning message to the sender at
14521 intervals specified by this option. The data is a colon-separated list of times
14522 after which to send warning messages. If the value of the option is an empty
14523 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14524 message has been on the queue for longer than the last time, the last interval
14525 between the times is used to compute subsequent warning times. For example,
14526 with
14527 .code
14528 delay_warning = 4h:8h:24h
14529 .endd
14530 the first message is sent after 4 hours, the second after 8 hours, and
14531 the third one after 24 hours. After that, messages are sent every 16 hours,
14532 because that is the interval between the last two times on the list. If you set
14533 just one time, it specifies the repeat interval. For example, with:
14534 .code
14535 delay_warning = 6h
14536 .endd
14537 messages are repeated every six hours. To stop warnings after a given time, set
14538 a very large time at the end of the list. For example:
14539 .code
14540 delay_warning = 2h:12h:99d
14541 .endd
14542 Note that the option is only evaluated at the time a delivery attempt fails,
14543 which depends on retry and queue-runner configuration.
14544 Typically retries will be configured more frequently than warning messages.
14545
14546 .option delay_warning_condition main string&!! "see below"
14547 .vindex "&$domain$&"
14548 The string is expanded at the time a warning message might be sent. If all the
14549 deferred addresses have the same domain, it is set in &$domain$& during the
14550 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14551 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14552 &"false"& (the comparison being done caselessly) then the warning message is
14553 not sent. The default is:
14554 .code
14555 delay_warning_condition = ${if or {\
14556   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14557   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14558   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14559   } {no}{yes}}
14560 .endd
14561 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14562 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14563 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14564 &"auto-replied"& in an &'Auto-Submitted:'& header.
14565
14566 .option deliver_drop_privilege main boolean false
14567 .cindex "unprivileged delivery"
14568 .cindex "delivery" "unprivileged"
14569 If this option is set true, Exim drops its root privilege at the start of a
14570 delivery process, and runs as the Exim user throughout. This severely restricts
14571 the kinds of local delivery that are possible, but is viable in certain types
14572 of configuration. There is a discussion about the use of root privilege in
14573 chapter &<<CHAPsecurity>>&.
14574
14575 .option deliver_queue_load_max main fixed-point unset
14576 .cindex "load average"
14577 .cindex "queue runner" "abandoning"
14578 When this option is set, a queue run is abandoned if the system load average
14579 becomes greater than the value of the option. The option has no effect on
14580 ancient operating systems on which Exim cannot determine the load average.
14581 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14582
14583
14584 .option delivery_date_remove main boolean true
14585 .cindex "&'Delivery-date:'& header line"
14586 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14587 message when it is delivered, in exactly the same way as &'Return-path:'& is
14588 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14589 should not be present in incoming messages, and this option causes them to be
14590 removed at the time the message is received, to avoid any problems that might
14591 occur when a delivered message is subsequently sent on to some other recipient.
14592
14593 .option disable_fsync main boolean false
14594 .cindex "&[fsync()]&, disabling"
14595 This option is available only if Exim was built with the compile-time option
14596 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14597 a runtime configuration generates an &"unknown option"& error. You should not
14598 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14599 really, really, really understand what you are doing. &'No pre-compiled
14600 distributions of Exim should ever make this option available.'&
14601
14602 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14603 updated files' data to be written to disc before continuing. Unexpected events
14604 such as crashes and power outages may cause data to be lost or scrambled.
14605 Here be Dragons. &*Beware.*&
14606
14607
14608 .option disable_ipv6 main boolean false
14609 .cindex "IPv6" "disabling"
14610 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14611 activities take place. AAAA records are never looked up, and any IPv6 addresses
14612 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14613 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14614 to handle IPv6 literal addresses.
14615
14616
14617 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14618 .cindex DKIM "controlling calls to the ACL"
14619 This option gives a list of DKIM domains for which the DKIM ACL is run.
14620 It is expanded after the message is received; by default it runs
14621 the ACL once for each signature in the message.
14622 See chapter &<<CHAPdkim>>&.
14623
14624
14625 .option dns_again_means_nonexist main "domain list&!!" unset
14626 .cindex "DNS" "&""try again""& response; overriding"
14627 DNS lookups give a &"try again"& response for the DNS errors
14628 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14629 keep trying to deliver a message, or to give repeated temporary errors to
14630 incoming mail. Sometimes the effect is caused by a badly set up name server and
14631 may persist for a long time. If a domain which exhibits this problem matches
14632 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14633 This option should be used with care. You can make it apply to reverse lookups
14634 by a setting such as this:
14635 .code
14636 dns_again_means_nonexist = *.in-addr.arpa
14637 .endd
14638 This option applies to all DNS lookups that Exim does. It also applies when the
14639 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14640 since these are most likely to be caused by DNS lookup problems. The
14641 &(dnslookup)& router has some options of its own for controlling what happens
14642 when lookups for MX or SRV records give temporary errors. These more specific
14643 options are applied after this global option.
14644
14645 .option dns_check_names_pattern main string "see below"
14646 .cindex "DNS" "pre-check of name syntax"
14647 When this option is set to a non-empty string, it causes Exim to check domain
14648 names for characters that are not allowed in host names before handing them to
14649 the DNS resolver, because some resolvers give temporary errors for names that
14650 contain unusual characters. If a domain name contains any unwanted characters,
14651 a &"not found"& result is forced, and the resolver is not called. The check is
14652 done by matching the domain name against a regular expression, which is the
14653 value of this option. The default pattern is
14654 .code
14655 dns_check_names_pattern = \
14656   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14657 .endd
14658 which permits only letters, digits, slashes, and hyphens in components, but
14659 they must start and end with a letter or digit. Slashes are not, in fact,
14660 permitted in host names, but they are found in certain NS records (which can be
14661 accessed in Exim by using a &%dnsdb%& lookup). If you set
14662 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14663 empty string.
14664
14665 .option dns_csa_search_limit main integer 5
14666 This option controls the depth of parental searching for CSA SRV records in the
14667 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14668
14669 .option dns_csa_use_reverse main boolean true
14670 This option controls whether or not an IP address, given as a CSA domain, is
14671 reversed and looked up in the reverse DNS, as described in more detail in
14672 section &<<SECTverifyCSA>>&.
14673
14674
14675 .option dns_dnssec_ok main integer -1
14676 .cindex "DNS" "resolver options"
14677 .cindex "DNS" "DNSSEC"
14678 If this option is set to a non-negative number then Exim will initialise the
14679 DNS resolver library to either use or not use DNSSEC, overriding the system
14680 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14681
14682 If the resolver library does not support DNSSEC then this option has no effect.
14683
14684
14685 .option dns_ipv4_lookup main "domain list&!!" unset
14686 .cindex "IPv6" "DNS lookup for AAAA records"
14687 .cindex "DNS" "IPv6 lookup for AAAA records"
14688 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14689 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14690 (A records) when trying to find IP addresses for hosts, unless the host's
14691 domain matches this list.
14692
14693 This is a fudge to help with name servers that give big delays or otherwise do
14694 not work for the AAAA record type. In due course, when the world's name
14695 servers have all been upgraded, there should be no need for this option.
14696
14697
14698 .option dns_retrans main time 0s
14699 .cindex "DNS" "resolver options"
14700 .cindex timeout "dns lookup"
14701 .cindex "DNS" timeout
14702 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14703 retransmission and retry parameters for DNS lookups. Values of zero (the
14704 defaults) leave the system default settings unchanged. The first value is the
14705 time between retries, and the second is the number of retries. It isn't
14706 totally clear exactly how these settings affect the total time a DNS lookup may
14707 take. I haven't found any documentation about timeouts on DNS lookups; these
14708 parameter values are available in the external resolver interface structure,
14709 but nowhere does it seem to describe how they are used or what you might want
14710 to set in them.
14711 See also the &%slow_lookup_log%& option.
14712
14713
14714 .option dns_retry main integer 0
14715 See &%dns_retrans%& above.
14716
14717
14718 .option dns_trust_aa main "domain list&!!" unset
14719 .cindex "DNS" "resolver options"
14720 .cindex "DNS" "DNSSEC"
14721 If this option is set then lookup results marked with the AA bit
14722 (Authoritative Answer) are trusted the same way as if they were
14723 DNSSEC-verified. The authority section's name of the answer must
14724 match with this expanded domain list.
14725
14726 Use this option only if you talk directly to a resolver that is
14727 authoritative for some zones and does not set the AD (Authentic Data)
14728 bit in the answer. Some DNS servers may have an configuration option to
14729 mark the answers from their own zones as verified (they set the AD bit).
14730 Others do not have this option. It is considered as poor practice using
14731 a resolver that is an authoritative server for some zones.
14732
14733 Use this option only if you really have to (e.g. if you want
14734 to use DANE for remote delivery to a server that is listed in the DNS
14735 zones that your resolver is authoritative for).
14736
14737 If the DNS answer packet has the AA bit set and contains resource record
14738 in the answer section, the name of the first NS record appearing in the
14739 authority section is compared against the list. If the answer packet is
14740 authoritative but the answer section is empty, the name of the first SOA
14741 record in the authoritative section is used instead.
14742
14743 .cindex "DNS" "resolver options"
14744 .option dns_use_edns0 main integer -1
14745 .cindex "DNS" "resolver options"
14746 .cindex "DNS" "EDNS0"
14747 .cindex "DNS" "OpenBSD
14748 If this option is set to a non-negative number then Exim will initialise the
14749 DNS resolver library to either use or not use EDNS0 extensions, overriding
14750 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14751 on.
14752
14753 If the resolver library does not support EDNS0 then this option has no effect.
14754
14755 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
14756 means that DNSSEC will not work with Exim on that platform either, unless Exim
14757 is linked against an alternative DNS client library.
14758
14759
14760 .option drop_cr main boolean false
14761 This is an obsolete option that is now a no-op. It used to affect the way Exim
14762 handled CR and LF characters in incoming messages. What happens now is
14763 described in section &<<SECTlineendings>>&.
14764
14765 .option dsn_advertise_hosts main "host list&!!" unset
14766 .cindex "bounce messages" "success"
14767 .cindex "DSN" "success"
14768 .cindex "Delivery Status Notification" "success"
14769 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14770 and accepted from, these hosts.
14771 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14772 and RET and ORCPT options on MAIL FROM commands.
14773 A NOTIFY=SUCCESS option requests success-DSN messages.
14774 A NOTIFY= option with no argument requests that no delay or failure DSNs
14775 are sent.
14776
14777 .option dsn_from main "string&!!" "see below"
14778 .cindex "&'From:'& header line" "in bounces"
14779 .cindex "bounce messages" "&'From:'& line, specifying"
14780 This option can be used to vary the contents of &'From:'& header lines in
14781 bounces and other automatically generated messages (&"Delivery Status
14782 Notifications"& &-- hence the name of the option). The default setting is:
14783 .code
14784 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14785 .endd
14786 The value is expanded every time it is needed. If the expansion fails, a
14787 panic is logged, and the default value is used.
14788
14789 .option envelope_to_remove main boolean true
14790 .cindex "&'Envelope-to:'& header line"
14791 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14792 message when it is delivered, in exactly the same way as &'Return-path:'& is
14793 handled. &'Envelope-to:'& records the original recipient address from the
14794 message's envelope that caused the delivery to happen. Such headers should not
14795 be present in incoming messages, and this option causes them to be removed at
14796 the time the message is received, to avoid any problems that might occur when a
14797 delivered message is subsequently sent on to some other recipient.
14798
14799
14800 .option errors_copy main "string list&!!" unset
14801 .cindex "bounce message" "copy to other address"
14802 .cindex "copy of bounce message"
14803 Setting this option causes Exim to send bcc copies of bounce messages that it
14804 generates to other addresses. &*Note*&: This does not apply to bounce messages
14805 coming from elsewhere. The value of the option is a colon-separated list of
14806 items. Each item consists of a pattern, terminated by white space, followed by
14807 a comma-separated list of email addresses. If a pattern contains spaces, it
14808 must be enclosed in double quotes.
14809
14810 Each pattern is processed in the same way as a single item in an address list
14811 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14812 the bounce message, the message is copied to the addresses on the list. The
14813 items are scanned in order, and once a matching one is found, no further items
14814 are examined. For example:
14815 .code
14816 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14817               rqps@mydomain   hostmaster@mydomain.example,\
14818                               postmaster@mydomain.example
14819 .endd
14820 .vindex "&$domain$&"
14821 .vindex "&$local_part$&"
14822 The address list is expanded before use. The expansion variables &$local_part$&
14823 and &$domain$& are set from the original recipient of the error message, and if
14824 there was any wildcard matching in the pattern, the expansion
14825 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14826 variables &$0$&, &$1$&, etc. are set in the normal way.
14827
14828
14829 .option errors_reply_to main string unset
14830 .cindex "bounce message" "&'Reply-to:'& in"
14831 By default, Exim's bounce and delivery warning messages contain the header line
14832 .display
14833 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14834 .endd
14835 .oindex &%quota_warn_message%&
14836 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14837 A warning message that is generated by the &%quota_warn_message%& option in an
14838 &(appendfile)& transport may contain its own &'From:'& header line that
14839 overrides the default.
14840
14841 Experience shows that people reply to bounce messages. If the
14842 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14843 and warning messages. For example:
14844 .code
14845 errors_reply_to = postmaster@my.domain.example
14846 .endd
14847 The value of the option is not expanded. It must specify a valid RFC 2822
14848 address. However, if a warning message that is generated by the
14849 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14850 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14851 not used.
14852
14853
14854 .option event_action main string&!! unset
14855 .cindex events
14856 This option declares a string to be expanded for Exim's events mechanism.
14857 For details see chapter &<<CHAPevents>>&.
14858
14859
14860 .option exim_group main string "compile-time configured"
14861 .cindex "gid (group id)" "Exim's own"
14862 .cindex "Exim group"
14863 This option changes the gid under which Exim runs when it gives up root
14864 privilege. The default value is compiled into the binary. The value of this
14865 option is used only when &%exim_user%& is also set. Unless it consists entirely
14866 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14867 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14868 security issues.
14869
14870
14871 .option exim_path main string "see below"
14872 .cindex "Exim binary, path name"
14873 This option specifies the path name of the Exim binary, which is used when Exim
14874 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14875 the directory configured at compile time by the BIN_DIRECTORY setting. It
14876 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14877 other place.
14878 &*Warning*&: Do not use a macro to define the value of this option, because
14879 you will break those Exim utilities that scan the configuration file to find
14880 where the binary is. (They then use the &%-bP%& option to extract option
14881 settings such as the value of &%spool_directory%&.)
14882
14883
14884 .option exim_user main string "compile-time configured"
14885 .cindex "uid (user id)" "Exim's own"
14886 .cindex "Exim user"
14887 This option changes the uid under which Exim runs when it gives up root
14888 privilege. The default value is compiled into the binary. Ownership of the run
14889 time configuration file and the use of the &%-C%& and &%-D%& command line
14890 options is checked against the values in the binary, not what is set here.
14891
14892 Unless it consists entirely of digits, the string is looked up using
14893 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14894 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14895 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14896
14897
14898 .option extra_local_interfaces main "string list" unset
14899 This option defines network interfaces that are to be considered local when
14900 routing, but which are not used for listening by the daemon. See section
14901 &<<SECTreclocipadd>>& for details.
14902
14903
14904 . Allow this long option name to split; give it unsplit as a fifth argument
14905 . for the automatic .oindex that is generated by .option.
14906
14907 .option "extract_addresses_remove_arguments" main boolean true &&&
14908          extract_addresses_remove_arguments
14909 .oindex "&%-t%&"
14910 .cindex "command line" "addresses with &%-t%&"
14911 .cindex "Sendmail compatibility" "&%-t%& option"
14912 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14913 are present on the command line when the &%-t%& option is used to build an
14914 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14915 line addresses are removed from the recipients list. This is also how Smail
14916 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14917 command line addresses are added to those obtained from the header lines. When
14918 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14919 argument headers. If it is set false, Exim adds rather than removes argument
14920 addresses.
14921
14922
14923 .option finduser_retries main integer 0
14924 .cindex "NIS, retrying user lookups"
14925 On systems running NIS or other schemes in which user and group information is
14926 distributed from a remote system, there can be times when &[getpwnam()]& and
14927 related functions fail, even when given valid data, because things time out.
14928 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14929 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14930 many extra times to find a user or a group, waiting for one second between
14931 retries.
14932
14933 .cindex "&_/etc/passwd_&" "multiple reading of"
14934 You should not set this option greater than zero if your user information is in
14935 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14936 search the file multiple times for non-existent users, and also cause delay.
14937
14938
14939
14940 .option freeze_tell main "string list, comma separated" unset
14941 .cindex "freezing messages" "sending a message when freezing"
14942 On encountering certain errors, or when configured to do so in a system filter,
14943 ACL, or special router, Exim freezes a message. This means that no further
14944 delivery attempts take place until an administrator thaws the message, or the
14945 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14946 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14947 warning message whenever it freezes something, unless the message it is
14948 freezing is a locally-generated bounce message. (Without this exception there
14949 is the possibility of looping.) The warning message is sent to the addresses
14950 supplied as the comma-separated value of this option. If several of the
14951 message's addresses cause freezing, only a single message is sent. If the
14952 freezing was automatic, the reason(s) for freezing can be found in the message
14953 log. If you configure freezing in a filter or ACL, you must arrange for any
14954 logging that you require.
14955
14956
14957 .option gecos_name main string&!! unset
14958 .cindex "HP-UX"
14959 .cindex "&""gecos""& field, parsing"
14960 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14961 password file to hold other information in addition to users' real names. Exim
14962 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14963 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14964 of the field are used unchanged, except that, if an ampersand is encountered,
14965 it is replaced by the user's login name with the first character forced to
14966 upper case, since this is a convention that is observed on many systems.
14967
14968 When these options are set, &%gecos_pattern%& is treated as a regular
14969 expression that is to be applied to the field (again with && replaced by the
14970 login name), and if it matches, &%gecos_name%& is expanded and used as the
14971 user's name.
14972
14973 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14974 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14975 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14976 name terminates at the first comma, the following can be used:
14977 .code
14978 gecos_pattern = ([^,]*)
14979 gecos_name = $1
14980 .endd
14981
14982 .option gecos_pattern main string unset
14983 See &%gecos_name%& above.
14984
14985
14986 .option gnutls_compat_mode main boolean unset
14987 This option controls whether GnuTLS is used in compatibility mode in an Exim
14988 server. This reduces security slightly, but improves interworking with older
14989 implementations of TLS.
14990
14991
14992 option gnutls_allow_auto_pkcs11 main boolean unset
14993 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14994 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14995
14996 See
14997 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14998 for documentation.
14999
15000
15001
15002 .option headers_charset main string "see below"
15003 This option sets a default character set for translating from encoded MIME
15004 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15005 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15006 ultimate default is ISO-8859-1. For more details see the description of header
15007 insertions in section &<<SECTexpansionitems>>&.
15008
15009
15010
15011 .option header_maxsize main integer "see below"
15012 .cindex "header section" "maximum size of"
15013 .cindex "limit" "size of message header section"
15014 This option controls the overall maximum size of a message's header
15015 section. The default is the value of HEADER_MAXSIZE in
15016 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15017 sections are rejected.
15018
15019
15020 .option header_line_maxsize main integer 0
15021 .cindex "header lines" "maximum size of"
15022 .cindex "limit" "size of one header line"
15023 This option limits the length of any individual header line in a message, after
15024 all the continuations have been joined together. Messages with individual
15025 header lines that are longer than the limit are rejected. The default value of
15026 zero means &"no limit"&.
15027
15028
15029
15030
15031 .option helo_accept_junk_hosts main "host list&!!" unset
15032 .cindex "HELO" "accepting junk data"
15033 .cindex "EHLO" "accepting junk data"
15034 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15035 mail, and gives an error response for invalid data. Unfortunately, there are
15036 some SMTP clients that send syntactic junk. They can be accommodated by setting
15037 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15038 if you want to do semantic checking.
15039 See also &%helo_allow_chars%& for a way of extending the permitted character
15040 set.
15041
15042
15043 .option helo_allow_chars main string unset
15044 .cindex "HELO" "underscores in"
15045 .cindex "EHLO" "underscores in"
15046 .cindex "underscore in EHLO/HELO"
15047 This option can be set to a string of rogue characters that are permitted in
15048 all EHLO and HELO names in addition to the standard letters, digits,
15049 hyphens, and dots. If you really must allow underscores, you can set
15050 .code
15051 helo_allow_chars = _
15052 .endd
15053 Note that the value is one string, not a list.
15054
15055
15056 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15057 .cindex "HELO" "forcing reverse lookup"
15058 .cindex "EHLO" "forcing reverse lookup"
15059 If the domain given by a client in a HELO or EHLO command matches this
15060 list, a reverse lookup is done in order to establish the host's true name. The
15061 default forces a lookup if the client host gives the server's name or any of
15062 its IP addresses (in brackets), something that broken clients have been seen to
15063 do.
15064
15065
15066 .option helo_try_verify_hosts main "host list&!!" unset
15067 .cindex "HELO verifying" "optional"
15068 .cindex "EHLO" "verifying, optional"
15069 By default, Exim just checks the syntax of HELO and EHLO commands (see
15070 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15071 to do more extensive checking of the data supplied by these commands. The ACL
15072 condition &`verify = helo`& is provided to make this possible.
15073 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15074 to force the check to occur. From release 4.53 onwards, this is no longer
15075 necessary. If the check has not been done before &`verify = helo`& is
15076 encountered, it is done at that time. Consequently, this option is obsolete.
15077 Its specification is retained here for backwards compatibility.
15078
15079 When an EHLO or HELO command is received, if the calling host matches
15080 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15081 EHLO command either:
15082
15083 .ilist
15084 is an IP literal matching the calling address of the host, or
15085 .next
15086 .cindex "DNS" "reverse lookup"
15087 .cindex "reverse DNS lookup"
15088 matches the host name that Exim obtains by doing a reverse lookup of the
15089 calling host address, or
15090 .next
15091 when looked up in DNS yields the calling host address.
15092 .endlist
15093
15094 However, the EHLO or HELO command is not rejected if any of the checks
15095 fail. Processing continues, but the result of the check is remembered, and can
15096 be detected later in an ACL by the &`verify = helo`& condition.
15097
15098 If DNS was used for successful verification, the variable
15099 .cindex "DNS" "DNSSEC"
15100 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15101
15102 .option helo_verify_hosts main "host list&!!" unset
15103 .cindex "HELO verifying" "mandatory"
15104 .cindex "EHLO" "verifying, mandatory"
15105 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15106 backwards compatibility. For hosts that match this option, Exim checks the host
15107 name given in the HELO or EHLO in the same way as for
15108 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15109 rejected with a 550 error, and entries are written to the main and reject logs.
15110 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15111 error.
15112
15113 .option hold_domains main "domain list&!!" unset
15114 .cindex "domain" "delaying delivery"
15115 .cindex "delivery" "delaying certain domains"
15116 This option allows mail for particular domains to be held on the queue
15117 manually. The option is overridden if a message delivery is forced with the
15118 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15119 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15120 item in &%hold_domains%&, no routing or delivery for that address is done, and
15121 it is deferred every time the message is looked at.
15122
15123 This option is intended as a temporary operational measure for delaying the
15124 delivery of mail while some problem is being sorted out, or some new
15125 configuration tested. If you just want to delay the processing of some
15126 domains until a queue run occurs, you should use &%queue_domains%& or
15127 &%queue_smtp_domains%&, not &%hold_domains%&.
15128
15129 A setting of &%hold_domains%& does not override Exim's code for removing
15130 messages from the queue if they have been there longer than the longest retry
15131 time in any retry rule. If you want to hold messages for longer than the normal
15132 retry times, insert a dummy retry rule with a long retry time.
15133
15134
15135 .option host_lookup main "host list&!!" unset
15136 .cindex "host name" "lookup, forcing"
15137 Exim does not look up the name of a calling host from its IP address unless it
15138 is required to compare against some host list, or the host matches
15139 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15140 option (which normally contains IP addresses rather than host names). The
15141 default configuration file contains
15142 .code
15143 host_lookup = *
15144 .endd
15145 which causes a lookup to happen for all hosts. If the expense of these lookups
15146 is felt to be too great, the setting can be changed or removed.
15147
15148 After a successful reverse lookup, Exim does a forward lookup on the name it
15149 has obtained, to verify that it yields the IP address that it started with. If
15150 this check fails, Exim behaves as if the name lookup failed.
15151
15152 .vindex "&$host_lookup_failed$&"
15153 .vindex "&$sender_host_name$&"
15154 After any kind of failure, the host name (in &$sender_host_name$&) remains
15155 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15156 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15157 &`verify = reverse_host_lookup`& in ACLs.
15158
15159
15160 .option host_lookup_order main "string list" &`bydns:byaddr`&
15161 This option specifies the order of different lookup methods when Exim is trying
15162 to find a host name from an IP address. The default is to do a DNS lookup
15163 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15164 if that fails. You can change the order of these lookups, or omit one entirely,
15165 if you want.
15166
15167 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15168 multiple PTR records in the DNS and the IP address is not listed in
15169 &_/etc/hosts_&. Different operating systems give different results in this
15170 case. That is why the default tries a DNS lookup first.
15171
15172
15173
15174 .option host_reject_connection main "host list&!!" unset
15175 .cindex "host" "rejecting connections from"
15176 If this option is set, incoming SMTP calls from the hosts listed are rejected
15177 as soon as the connection is made.
15178 This option is obsolete, and retained only for backward compatibility, because
15179 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15180 connections immediately.
15181
15182 The ability to give an immediate rejection (either by this option or using an
15183 ACL) is provided for use in unusual cases. Many hosts will just try again,
15184 sometimes without much delay. Normally, it is better to use an ACL to reject
15185 incoming messages at a later stage, such as after RCPT commands. See
15186 chapter &<<CHAPACL>>&.
15187
15188
15189 .option hosts_connection_nolog main "host list&!!" unset
15190 .cindex "host" "not logging connections from"
15191 This option defines a list of hosts for which connection logging does not
15192 happen, even though the &%smtp_connection%& log selector is set. For example,
15193 you might want not to log SMTP connections from local processes, or from
15194 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15195 the daemon; you should therefore strive to restrict its value to a short inline
15196 list of IP addresses and networks. To disable logging SMTP connections from
15197 local processes, you must create a host list with an empty item. For example:
15198 .code
15199 hosts_connection_nolog = :
15200 .endd
15201 If the &%smtp_connection%& log selector is not set, this option has no effect.
15202
15203
15204
15205 .option hosts_proxy main "host list&!!" unset
15206 .cindex proxy "proxy protocol"
15207 This option enables use of Proxy Protocol proxies for incoming
15208 connections.  For details see section &<<SECTproxyInbound>>&.
15209
15210
15211 .option hosts_treat_as_local main "domain list&!!" unset
15212 .cindex "local host" "domains treated as"
15213 .cindex "host" "treated as local"
15214 If this option is set, any host names that match the domain list are treated as
15215 if they were the local host when Exim is scanning host lists obtained from MX
15216 records
15217 or other sources. Note that the value of this option is a domain list, not a
15218 host list, because it is always used to check host names, not IP addresses.
15219
15220 This option also applies when Exim is matching the special items
15221 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15222 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15223 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15224 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15225 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15226 interfaces and recognizing the local host.
15227
15228
15229 .option ibase_servers main "string list" unset
15230 .cindex "InterBase" "server list"
15231 This option provides a list of InterBase servers and associated connection data,
15232 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15233 The option is available only if Exim has been built with InterBase support.
15234
15235
15236
15237 .option ignore_bounce_errors_after main time 10w
15238 .cindex "bounce message" "discarding"
15239 .cindex "discarding bounce message"
15240 This option affects the processing of bounce messages that cannot be delivered,
15241 that is, those that suffer a permanent delivery failure. (Bounce messages that
15242 suffer temporary delivery failures are of course retried in the usual way.)
15243
15244 After a permanent delivery failure, bounce messages are frozen,
15245 because there is no sender to whom they can be returned. When a frozen bounce
15246 message has been on the queue for more than the given time, it is unfrozen at
15247 the next queue run, and a further delivery is attempted. If delivery fails
15248 again, the bounce message is discarded. This makes it possible to keep failed
15249 bounce messages around for a shorter time than the normal maximum retry time
15250 for frozen messages. For example,
15251 .code
15252 ignore_bounce_errors_after = 12h
15253 .endd
15254 retries failed bounce message deliveries after 12 hours, discarding any further
15255 failures. If the value of this option is set to a zero time period, bounce
15256 failures are discarded immediately. Setting a very long time (as in the default
15257 value) has the effect of disabling this option. For ways of automatically
15258 dealing with other kinds of frozen message, see &%auto_thaw%& and
15259 &%timeout_frozen_after%&.
15260
15261
15262 .option ignore_fromline_hosts main "host list&!!" unset
15263 .cindex "&""From""& line"
15264 .cindex "UUCP" "&""From""& line"
15265 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15266 the headers of a message. By default this is treated as the start of the
15267 message's body, which means that any following headers are not recognized as
15268 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15269 match those hosts that insist on sending it. If the sender is actually a local
15270 process rather than a remote host, and is using &%-bs%& to inject the messages,
15271 &%ignore_fromline_local%& must be set to achieve this effect.
15272
15273
15274 .option ignore_fromline_local main boolean false
15275 See &%ignore_fromline_hosts%& above.
15276
15277 .option keep_environment main "string list" unset
15278 .cindex "environment" "values from"
15279 This option contains a string list of environment variables to keep.
15280 You have to trust these variables or you have to be sure that
15281 these variables do not impose any security risk. Keep in mind that
15282 during the startup phase Exim is running with an effective UID 0 in most
15283 installations. As the default value is an empty list, the default
15284 environment for using libraries, running embedded Perl code, or running
15285 external binaries is empty, and does not not even contain PATH or HOME.
15286
15287 Actually the list is interpreted as a list of patterns
15288 (&<<SECTlistexpand>>&), except that it is not expanded first.
15289
15290 WARNING: Macro substitution is still done first, so having a macro
15291 FOO and having FOO_HOME in your &%keep_environment%& option may have
15292 unexpected results. You may work around this using a regular expression
15293 that does not match the macro name: ^[F]OO_HOME$.
15294
15295 Current versions of Exim issue a warning during startup if you do not mention
15296 &%keep_environment%& in your runtime configuration file and if your
15297 current environment is not empty. Future versions may not issue that warning
15298 anymore.
15299
15300 See the &%add_environment%& main config option for a way to set
15301 environment variables to a fixed value.  The environment for &(pipe)&
15302 transports is handled separately, see section &<<SECTpipeenv>>& for
15303 details.
15304
15305
15306 .option keep_malformed main time 4d
15307 This option specifies the length of time to keep messages whose spool files
15308 have been corrupted in some way. This should, of course, never happen. At the
15309 next attempt to deliver such a message, it gets removed. The incident is
15310 logged.
15311
15312
15313 .option ldap_ca_cert_dir main string unset
15314 .cindex "LDAP", "TLS CA certificate directory"
15315 .cindex certificate "directory for LDAP"
15316 This option indicates which directory contains CA certificates for verifying
15317 a TLS certificate presented by an LDAP server.
15318 While Exim does not provide a default value, your SSL library may.
15319 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15320 and constrained to be a directory.
15321
15322
15323 .option ldap_ca_cert_file main string unset
15324 .cindex "LDAP", "TLS CA certificate file"
15325 .cindex certificate "file for LDAP"
15326 This option indicates which file contains CA certificates for verifying
15327 a TLS certificate presented by an LDAP server.
15328 While Exim does not provide a default value, your SSL library may.
15329 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15330 and constrained to be a file.
15331
15332
15333 .option ldap_cert_file main string unset
15334 .cindex "LDAP" "TLS client certificate file"
15335 .cindex certificate "file for LDAP"
15336 This option indicates which file contains an TLS client certificate which
15337 Exim should present to the LDAP server during TLS negotiation.
15338 Should be used together with &%ldap_cert_key%&.
15339
15340
15341 .option ldap_cert_key main string unset
15342 .cindex "LDAP" "TLS client key file"
15343 .cindex certificate "key for LDAP"
15344 This option indicates which file contains the secret/private key to use
15345 to prove identity to the LDAP server during TLS negotiation.
15346 Should be used together with &%ldap_cert_file%&, which contains the
15347 identity to be proven.
15348
15349
15350 .option ldap_cipher_suite main string unset
15351 .cindex "LDAP" "TLS cipher suite"
15352 This controls the TLS cipher-suite negotiation during TLS negotiation with
15353 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15354 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15355
15356
15357 .option ldap_default_servers main "string list" unset
15358 .cindex "LDAP" "default servers"
15359 This option provides a list of LDAP servers which are tried in turn when an
15360 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15361 details of LDAP queries. This option is available only when Exim has been built
15362 with LDAP support.
15363
15364
15365 .option ldap_require_cert main string unset.
15366 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15367 This should be one of the values "hard", "demand", "allow", "try" or "never".
15368 A value other than one of these is interpreted as "never".
15369 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15370 Although Exim does not set a default, the LDAP library probably defaults
15371 to hard/demand.
15372
15373
15374 .option ldap_start_tls main boolean false
15375 .cindex "LDAP" "whether or not to negotiate TLS"
15376 If set, Exim will attempt to negotiate TLS with the LDAP server when
15377 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15378 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15379 of SSL-on-connect.
15380 In the event of failure to negotiate TLS, the action taken is controlled
15381 by &%ldap_require_cert%&.
15382 This option is ignored for &`ldapi`& connections.
15383
15384
15385 .option ldap_version main integer unset
15386 .cindex "LDAP" "protocol version, forcing"
15387 This option can be used to force Exim to set a specific protocol version for
15388 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15389 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15390 the LDAP headers; otherwise it is 2. This option is available only when Exim
15391 has been built with LDAP support.
15392
15393
15394
15395 .option local_from_check main boolean true
15396 .cindex "&'Sender:'& header line" "disabling addition of"
15397 .cindex "&'From:'& header line" "disabling checking of"
15398 When a message is submitted locally (that is, not over a TCP/IP connection) by
15399 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15400 checks that the &'From:'& header line matches the login of the calling user and
15401 the domain specified by &%qualify_domain%&.
15402
15403 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15404 locally submitted message is automatically qualified by Exim, unless the
15405 &%-bnq%& command line option is used.
15406
15407 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15408 on the local part. If the &'From:'& header line does not match, Exim adds a
15409 &'Sender:'& header with an address constructed from the calling user's login
15410 and the default qualify domain.
15411
15412 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15413 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15414 &'Sender:'& header lines supplied by untrusted users, you must also set
15415 &%local_sender_retain%& to be true.
15416
15417 .cindex "envelope sender"
15418 These options affect only the header lines in the message. The envelope sender
15419 is still forced to be the login id at the qualify domain unless
15420 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15421
15422 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15423 request similar header line checking. See section &<<SECTthesenhea>>&, which
15424 has more details about &'Sender:'& processing.
15425
15426
15427
15428
15429 .option local_from_prefix main string unset
15430 When Exim checks the &'From:'& header line of locally submitted messages for
15431 matching the login id (see &%local_from_check%& above), it can be configured to
15432 ignore certain prefixes and suffixes in the local part of the address. This is
15433 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15434 appropriate lists, in the same form as the &%local_part_prefix%& and
15435 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15436 example, if
15437 .code
15438 local_from_prefix = *-
15439 .endd
15440 is set, a &'From:'& line containing
15441 .code
15442 From: anything-user@your.domain.example
15443 .endd
15444 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15445 matches the actual sender address that is constructed from the login name and
15446 qualify domain.
15447
15448
15449 .option local_from_suffix main string unset
15450 See &%local_from_prefix%& above.
15451
15452
15453 .option local_interfaces main "string list" "see below"
15454 This option controls which network interfaces are used by the daemon for
15455 listening; they are also used to identify the local host when routing. Chapter
15456 &<<CHAPinterfaces>>& contains a full description of this option and the related
15457 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15458 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15459 &%local_interfaces%& is
15460 .code
15461 local_interfaces = 0.0.0.0
15462 .endd
15463 when Exim is built without IPv6 support; otherwise it is
15464 .code
15465 local_interfaces = <; ::0 ; 0.0.0.0
15466 .endd
15467
15468 .option local_scan_timeout main time 5m
15469 .cindex "timeout" "for &[local_scan()]& function"
15470 .cindex "&[local_scan()]& function" "timeout"
15471 This timeout applies to the &[local_scan()]& function (see chapter
15472 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15473 the incoming message is rejected with a temporary error if it is an SMTP
15474 message. For a non-SMTP message, the message is dropped and Exim ends with a
15475 non-zero code. The incident is logged on the main and reject logs.
15476
15477
15478
15479 .option local_sender_retain main boolean false
15480 .cindex "&'Sender:'& header line" "retaining from local submission"
15481 When a message is submitted locally (that is, not over a TCP/IP connection) by
15482 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15483 do not want this to happen, you must set &%local_sender_retain%&, and you must
15484 also set &%local_from_check%& to be false (Exim will complain if you do not).
15485 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15486 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15487
15488
15489
15490
15491 .option localhost_number main string&!! unset
15492 .cindex "host" "locally unique number for"
15493 .cindex "message ids" "with multiple hosts"
15494 .vindex "&$localhost_number$&"
15495 Exim's message ids are normally unique only within the local host. If
15496 uniqueness among a set of hosts is required, each host must set a different
15497 value for the &%localhost_number%& option. The string is expanded immediately
15498 after reading the configuration file (so that a number can be computed from the
15499 host name, for example) and the result of the expansion must be a number in the
15500 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15501 systems). This is available in subsequent string expansions via the variable
15502 &$localhost_number$&. When &%localhost_number is set%&, the final two
15503 characters of the message id, instead of just being a fractional part of the
15504 time, are computed from the time and the local host number as described in
15505 section &<<SECTmessiden>>&.
15506
15507
15508
15509 .option log_file_path main "string list&!!" "set at compile time"
15510 .cindex "log" "file path for"
15511 This option sets the path which is used to determine the names of Exim's log
15512 files, or indicates that logging is to be to syslog, or both. It is expanded
15513 when Exim is entered, so it can, for example, contain a reference to the host
15514 name. If no specific path is set for the log files at compile or run time,
15515 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15516 they are written in a sub-directory called &_log_& in Exim's spool directory.
15517 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15518 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15519 used. If this string is fixed at your installation (contains no expansion
15520 variables) it is recommended that you do not set this option in the
15521 configuration file, but instead supply the path using LOG_FILE_PATH in
15522 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15523 early on &-- in particular, failure to read the configuration file.
15524
15525
15526 .option log_selector main string unset
15527 .cindex "log" "selectors"
15528 This option can be used to reduce or increase the number of things that Exim
15529 writes to its log files. Its argument is made up of names preceded by plus or
15530 minus characters. For example:
15531 .code
15532 log_selector = +arguments -retry_defer
15533 .endd
15534 A list of possible names and what they control is given in the chapter on
15535 logging, in section &<<SECTlogselector>>&.
15536
15537
15538 .option log_timezone main boolean false
15539 .cindex "log" "timezone for entries"
15540 .vindex "&$tod_log$&"
15541 .vindex "&$tod_zone$&"
15542 By default, the timestamps on log lines are in local time without the
15543 timezone. This means that if your timezone changes twice a year, the timestamps
15544 in log lines are ambiguous for an hour when the clocks go back. One way of
15545 avoiding this problem is to set the timezone to UTC. An alternative is to set
15546 &%log_timezone%& true. This turns on the addition of the timezone offset to
15547 timestamps in log lines. Turning on this option can add quite a lot to the size
15548 of log files because each line is extended by 6 characters. Note that the
15549 &$tod_log$& variable contains the log timestamp without the zone, but there is
15550 another variable called &$tod_zone$& that contains just the timezone offset.
15551
15552
15553 .option lookup_open_max main integer 25
15554 .cindex "too many open files"
15555 .cindex "open files, too many"
15556 .cindex "file" "too many open"
15557 .cindex "lookup" "maximum open files"
15558 .cindex "limit" "open files for lookups"
15559 This option limits the number of simultaneously open files for single-key
15560 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15561 Exim normally keeps these files open during routing, because often the same
15562 file is required several times. If the limit is reached, Exim closes the least
15563 recently used file. Note that if you are using the &'ndbm'& library, it
15564 actually opens two files for each logical DBM database, though it still counts
15565 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15566 open files"& errors with NDBM, you need to reduce the value of
15567 &%lookup_open_max%&.
15568
15569
15570 .option max_username_length main integer 0
15571 .cindex "length of login name"
15572 .cindex "user name" "maximum length"
15573 .cindex "limit" "user name length"
15574 Some operating systems are broken in that they truncate long arguments to
15575 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15576 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15577 an argument that is longer behaves as if &[getpwnam()]& failed.
15578
15579
15580 .option message_body_newlines main bool false
15581 .cindex "message body" "newlines in variables"
15582 .cindex "newline" "in message body variables"
15583 .vindex "&$message_body$&"
15584 .vindex "&$message_body_end$&"
15585 By default, newlines in the message body are replaced by spaces when setting
15586 the &$message_body$& and &$message_body_end$& expansion variables. If this
15587 option is set true, this no longer happens.
15588
15589
15590 .option message_body_visible main integer 500
15591 .cindex "body of message" "visible size"
15592 .cindex "message body" "visible size"
15593 .vindex "&$message_body$&"
15594 .vindex "&$message_body_end$&"
15595 This option specifies how much of a message's body is to be included in the
15596 &$message_body$& and &$message_body_end$& expansion variables.
15597
15598
15599 .option message_id_header_domain main string&!! unset
15600 .cindex "&'Message-ID:'& header line"
15601 If this option is set, the string is expanded and used as the right hand side
15602 (domain) of the &'Message-ID:'& header that Exim creates if a
15603 locally-originated incoming message does not have one. &"Locally-originated"&
15604 means &"not received over TCP/IP."&
15605 Otherwise, the primary host name is used.
15606 Only letters, digits, dot and hyphen are accepted; any other characters are
15607 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15608 empty string, the option is ignored.
15609
15610
15611 .option message_id_header_text main string&!! unset
15612 If this variable is set, the string is expanded and used to augment the text of
15613 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15614 message does not have one. The text of this header is required by RFC 2822 to
15615 take the form of an address. By default, Exim uses its internal message id as
15616 the local part, and the primary host name as the domain. If this option is set,
15617 it is expanded, and provided the expansion is not forced to fail, and does not
15618 yield an empty string, the result is inserted into the header immediately
15619 before the @, separated from the internal message id by a dot. Any characters
15620 that are illegal in an address are automatically converted into hyphens. This
15621 means that variables such as &$tod_log$& can be used, because the spaces and
15622 colons will become hyphens.
15623
15624
15625 .option message_logs main boolean true
15626 .cindex "message logs" "disabling"
15627 .cindex "log" "message log; disabling"
15628 If this option is turned off, per-message log files are not created in the
15629 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15630 Exim, by reducing the number of files involved in handling a message from a
15631 minimum of four (header spool file, body spool file, delivery journal, and
15632 per-message log) to three. The other major I/O activity is Exim's main log,
15633 which is not affected by this option.
15634
15635
15636 .option message_size_limit main string&!! 50M
15637 .cindex "message" "size limit"
15638 .cindex "limit" "message size"
15639 .cindex "size" "of message, limit"
15640 This option limits the maximum size of message that Exim will process. The
15641 value is expanded for each incoming connection so, for example, it can be made
15642 to depend on the IP address of the remote host for messages arriving via
15643 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15644 optionally followed by K or M.
15645
15646 &*Note*&: This limit cannot be made to depend on a message's sender or any
15647 other properties of an individual message, because it has to be advertised in
15648 the server's response to EHLO. String expansion failure causes a temporary
15649 error. A value of zero means no limit, but its use is not recommended. See also
15650 &%bounce_return_size_limit%&.
15651
15652 Incoming SMTP messages are failed with a 552 error if the limit is
15653 exceeded; locally-generated messages either get a stderr message or a delivery
15654 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15655 an oversized message is logged in both the main and the reject logs. See also
15656 the generic transport option &%message_size_limit%&, which limits the size of
15657 message that an individual transport can process.
15658
15659 If you use a virus-scanner and set this option to to a value larger than the
15660 maximum size that your virus-scanner is configured to support, you may get
15661 failures triggered by large mails.  The right size to configure for the
15662 virus-scanner depends upon what data is passed and the options in use but it's
15663 probably safest to just set it to a little larger than this value.  E.g., with a
15664 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15665 some problems may result.
15666
15667 A value of 0 will disable size limit checking; Exim will still advertise the
15668 SIZE extension in an EHLO response, but without a limit, so as to permit
15669 SMTP clients to still indicate the message size along with the MAIL verb.
15670
15671
15672 .option move_frozen_messages main boolean false
15673 .cindex "frozen messages" "moving"
15674 This option, which is available only if Exim has been built with the setting
15675 .code
15676 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15677 .endd
15678 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15679 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15680 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15681 standard utilities for handling such moved messages, and they do not show up in
15682 lists generated by &%-bp%& or by the Exim monitor.
15683
15684
15685 .option mua_wrapper main boolean false
15686 Setting this option true causes Exim to run in a very restrictive mode in which
15687 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15688 contains a full description of this facility.
15689
15690
15691
15692 .option mysql_servers main "string list" unset
15693 .cindex "MySQL" "server list"
15694 This option provides a list of MySQL servers and associated connection data, to
15695 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15696 option is available only if Exim has been built with MySQL support.
15697
15698
15699 .option never_users main "string list&!!" unset
15700 This option is expanded just once, at the start of Exim's processing. Local
15701 message deliveries are normally run in processes that are setuid to the
15702 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15703 It is usually desirable to prevent any deliveries from running as root, as a
15704 safety precaution.
15705
15706 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15707 list of users that must not be used for local deliveries. This list is fixed in
15708 the binary and cannot be overridden by the configuration file. By default, it
15709 contains just the single user name &"root"&. The &%never_users%& runtime option
15710 can be used to add more users to the fixed list.
15711
15712 If a message is to be delivered as one of the users on the fixed list or the
15713 &%never_users%& list, an error occurs, and delivery is deferred. A common
15714 example is
15715 .code
15716 never_users = root:daemon:bin
15717 .endd
15718 Including root is redundant if it is also on the fixed list, but it does no
15719 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15720 transport driver.
15721
15722
15723 .option openssl_options main "string list" "+no_sslv2 +single_dh_use +no_ticket"
15724 .cindex "OpenSSL "compatibility options"
15725 This option allows an administrator to adjust the SSL options applied
15726 by OpenSSL to connections.  It is given as a space-separated list of items,
15727 each one to be +added or -subtracted from the current value.
15728
15729 This option is only available if Exim is built against OpenSSL.  The values
15730 available for this option vary according to the age of your OpenSSL install.
15731 The &"all"& value controls a subset of flags which are available, typically
15732 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15733 list the values known on your system and Exim should support all the
15734 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15735 names lose the leading &"SSL_OP_"& and are lower-cased.
15736
15737 Note that adjusting the options can have severe impact upon the security of
15738 SSL as used by Exim.  It is possible to disable safety checks and shoot
15739 yourself in the foot in various unpleasant ways.  This option should not be
15740 adjusted lightly.  An unrecognised item will be detected at startup, by
15741 invoking Exim with the &%-bV%& flag.
15742
15743 The option affects Exim operating both as a server and as a client.
15744
15745 Historical note: prior to release 4.80, Exim defaulted this value to
15746 "+dont_insert_empty_fragments", which may still be needed for compatibility
15747 with some clients, but which lowers security by increasing exposure to
15748 some now infamous attacks.
15749
15750 Examples:
15751 .code
15752 # Make both old MS and old Eudora happy:
15753 openssl_options = -all +microsoft_big_sslv3_buffer \
15754                        +dont_insert_empty_fragments
15755
15756 # Disable older protocol versions:
15757 openssl_options = +no_sslv2 +no_sslv3
15758 .endd
15759
15760 Possible options may include:
15761 .ilist
15762 &`all`&
15763 .next
15764 &`allow_unsafe_legacy_renegotiation`&
15765 .next
15766 &`cipher_server_preference`&
15767 .next
15768 &`dont_insert_empty_fragments`&
15769 .next
15770 &`ephemeral_rsa`&
15771 .next
15772 &`legacy_server_connect`&
15773 .next
15774 &`microsoft_big_sslv3_buffer`&
15775 .next
15776 &`microsoft_sess_id_bug`&
15777 .next
15778 &`msie_sslv2_rsa_padding`&
15779 .next
15780 &`netscape_challenge_bug`&
15781 .next
15782 &`netscape_reuse_cipher_change_bug`&
15783 .next
15784 &`no_compression`&
15785 .next
15786 &`no_session_resumption_on_renegotiation`&
15787 .next
15788 &`no_sslv2`&
15789 .next
15790 &`no_sslv3`&
15791 .next
15792 &`no_ticket`&
15793 .next
15794 &`no_tlsv1`&
15795 .next
15796 &`no_tlsv1_1`&
15797 .next
15798 &`no_tlsv1_2`&
15799 .next
15800 &`safari_ecdhe_ecdsa_bug`&
15801 .next
15802 &`single_dh_use`&
15803 .next
15804 &`single_ecdh_use`&
15805 .next
15806 &`ssleay_080_client_dh_bug`&
15807 .next
15808 &`sslref2_reuse_cert_type_bug`&
15809 .next
15810 &`tls_block_padding_bug`&
15811 .next
15812 &`tls_d5_bug`&
15813 .next
15814 &`tls_rollback_bug`&
15815 .endlist
15816
15817 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15818 all clients connecting using the MacOS SecureTransport TLS facility prior
15819 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15820 to negotiate TLS then this option value might help, provided that your OpenSSL
15821 release is new enough to contain this work-around.  This may be a situation
15822 where you have to upgrade OpenSSL to get buggy clients working.
15823
15824
15825 .option oracle_servers main "string list" unset
15826 .cindex "Oracle" "server list"
15827 This option provides a list of Oracle servers and associated connection data,
15828 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15829 The option is available only if Exim has been built with Oracle support.
15830
15831
15832 .option percent_hack_domains main "domain list&!!" unset
15833 .cindex "&""percent hack""&"
15834 .cindex "source routing" "in email address"
15835 .cindex "address" "source-routed"
15836 The &"percent hack"& is the convention whereby a local part containing a
15837 percent sign is re-interpreted as a new email address, with the percent
15838 replaced by @. This is sometimes called &"source routing"&, though that term is
15839 also applied to RFC 2822 addresses that begin with an @ character. If this
15840 option is set, Exim implements the percent facility for those domains listed,
15841 but no others. This happens before an incoming SMTP address is tested against
15842 an ACL.
15843
15844 &*Warning*&: The &"percent hack"& has often been abused by people who are
15845 trying to get round relaying restrictions. For this reason, it is best avoided
15846 if at all possible. Unfortunately, a number of less security-conscious MTAs
15847 implement it unconditionally. If you are running Exim on a gateway host, and
15848 routing mail through to internal MTAs without processing the local parts, it is
15849 a good idea to reject recipient addresses with percent characters in their
15850 local parts. Exim's default configuration does this.
15851
15852
15853 .option perl_at_start main boolean false
15854 .cindex "Perl"
15855 This option is available only when Exim is built with an embedded Perl
15856 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15857
15858
15859 .option perl_startup main string unset
15860 .cindex "Perl"
15861 This option is available only when Exim is built with an embedded Perl
15862 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15863
15864 .option perl_startup main boolean false
15865 .cindex "Perl"
15866 This Option enables the taint mode of the embedded Perl interpreter.
15867
15868
15869 .option pgsql_servers main "string list" unset
15870 .cindex "PostgreSQL lookup type" "server list"
15871 This option provides a list of PostgreSQL servers and associated connection
15872 data, to be used in conjunction with &(pgsql)& lookups (see section
15873 &<<SECID72>>&). The option is available only if Exim has been built with
15874 PostgreSQL support.
15875
15876
15877 .option pid_file_path main string&!! "set at compile time"
15878 .cindex "daemon" "pid file path"
15879 .cindex "pid file, path for"
15880 This option sets the name of the file to which the Exim daemon writes its
15881 process id. The string is expanded, so it can contain, for example, references
15882 to the host name:
15883 .code
15884 pid_file_path = /var/log/$primary_hostname/exim.pid
15885 .endd
15886 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15887 spool directory.
15888 The value set by the option can be overridden by the &%-oP%& command line
15889 option. A pid file is not written if a &"non-standard"& daemon is run by means
15890 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15891
15892
15893 .option pipelining_advertise_hosts main "host list&!!" *
15894 .cindex "PIPELINING" "suppressing advertising"
15895 This option can be used to suppress the advertisement of the SMTP
15896 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15897 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15898 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15899 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15900 that clients will use it; &"out of order"& commands that are &"expected"& do
15901 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15902
15903
15904 .option prdr_enable main boolean false
15905 .cindex "PRDR" "enabling on server"
15906 This option can be used to enable the Per-Recipient Data Response extension
15907 to SMTP, defined by Eric Hall.
15908 If the option is set, PRDR is advertised by Exim when operating as a server.
15909 If the client requests PRDR, and more than one recipient, for a message
15910 an additional ACL is called for each recipient after the message content
15911 is received.  See section &<<SECTPRDRACL>>&.
15912
15913 .option preserve_message_logs main boolean false
15914 .cindex "message logs" "preserving"
15915 If this option is set, message log files are not deleted when messages are
15916 completed. Instead, they are moved to a sub-directory of the spool directory
15917 called &_msglog.OLD_&, where they remain available for statistical or debugging
15918 purposes. This is a dangerous option to set on systems with any appreciable
15919 volume of mail. Use with care!
15920
15921
15922 .option primary_hostname main string "see below"
15923 .cindex "name" "of local host"
15924 .cindex "host" "name of local"
15925 .cindex "local host" "name of"
15926 .vindex "&$primary_hostname$&"
15927 This specifies the name of the current host. It is used in the default EHLO or
15928 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15929 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15930 The value is also used by default in some SMTP response messages from an Exim
15931 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15932
15933 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15934 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15935 contains only one component, Exim passes it to &[gethostbyname()]& (or
15936 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15937 version. The variable &$primary_hostname$& contains the host name, whether set
15938 explicitly by this option, or defaulted.
15939
15940
15941 .option print_topbitchars main boolean false
15942 .cindex "printing characters"
15943 .cindex "8-bit characters"
15944 By default, Exim considers only those characters whose codes lie in the range
15945 32&--126 to be printing characters. In a number of circumstances (for example,
15946 when writing log entries) non-printing characters are converted into escape
15947 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15948 is set, code values of 128 and above are also considered to be printing
15949 characters.
15950
15951 This option also affects the header syntax checks performed by the
15952 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15953 the user's full name when constructing From: and Sender: addresses (as
15954 described in section &<<SECTconstr>>&). Setting this option can cause
15955 Exim to generate eight bit message headers that do not conform to the
15956 standards.
15957
15958
15959 .option process_log_path main string unset
15960 .cindex "process log path"
15961 .cindex "log" "process log"
15962 .cindex "&'exiwhat'&"
15963 This option sets the name of the file to which an Exim process writes its
15964 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15965 utility script. If this option is unset, the file called &_exim-process.info_&
15966 in Exim's spool directory is used. The ability to specify the name explicitly
15967 can be useful in environments where two different Exims are running, using
15968 different spool directories.
15969
15970
15971 .option prod_requires_admin main boolean true
15972 .cindex "restricting access to features"
15973 .oindex "&%-M%&"
15974 .oindex "&%-R%&"
15975 .oindex "&%-q%&"
15976 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15977 admin user unless &%prod_requires_admin%& is set false. See also
15978 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
15979
15980
15981 .option qualify_domain main string "see below"
15982 .cindex "domain" "for qualifying addresses"
15983 .cindex "address" "qualification"
15984 This option specifies the domain name that is added to any envelope sender
15985 addresses that do not have a domain qualification. It also applies to
15986 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15987 are accepted by default only for locally-generated messages. Qualification is
15988 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15989 locally-generated messages, unless the &%-bnq%& command line option is used.
15990
15991 Messages from external sources must always contain fully qualified addresses,
15992 unless the sending host matches &%sender_unqualified_hosts%& or
15993 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15994 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15995 necessary. Internally, Exim always works with fully qualified envelope
15996 addresses. If &%qualify_domain%& is not set, it defaults to the
15997 &%primary_hostname%& value.
15998
15999
16000 .option qualify_recipient main string "see below"
16001 This option allows you to specify a different domain for qualifying recipient
16002 addresses to the one that is used for senders. See &%qualify_domain%& above.
16003
16004
16005
16006 .option queue_domains main "domain list&!!" unset
16007 .cindex "domain" "specifying non-immediate delivery"
16008 .cindex "queueing incoming messages"
16009 .cindex "message" "queueing certain domains"
16010 This option lists domains for which immediate delivery is not required.
16011 A delivery process is started whenever a message is received, but only those
16012 domains that do not match are processed. All other deliveries wait until the
16013 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16014
16015
16016 .option queue_list_requires_admin main boolean true
16017 .cindex "restricting access to features"
16018 .oindex "&%-bp%&"
16019 The &%-bp%& command-line option, which lists the messages that are on the
16020 queue, requires the caller to be an admin user unless
16021 &%queue_list_requires_admin%& is set false.
16022 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16023
16024
16025 .option queue_only main boolean false
16026 .cindex "queueing incoming messages"
16027 .cindex "message" "queueing unconditionally"
16028 If &%queue_only%& is set, a delivery process is not automatically started
16029 whenever a message is received. Instead, the message waits on the queue for the
16030 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16031 delivered immediately when certain conditions (such as heavy load) occur.
16032
16033 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16034 and &%-odi%& command line options override &%queue_only%& unless
16035 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16036 &%queue_only_load%&, and &%smtp_accept_queue%&.
16037
16038
16039 .option queue_only_file main string unset
16040 .cindex "queueing incoming messages"
16041 .cindex "message" "queueing by file existence"
16042 This option can be set to a colon-separated list of absolute path names, each
16043 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16044 it tests for the existence of each listed path using a call to &[stat()]&. For
16045 each path that exists, the corresponding queueing option is set.
16046 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16047 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16048 .code
16049 queue_only_file = smtp/some/file
16050 .endd
16051 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16052 &_/some/file_& exists.
16053
16054
16055 .option queue_only_load main fixed-point unset
16056 .cindex "load average"
16057 .cindex "queueing incoming messages"
16058 .cindex "message" "queueing by load"
16059 If the system load average is higher than this value, incoming messages from
16060 all sources are queued, and no automatic deliveries are started. If this
16061 happens during local or remote SMTP input, all subsequent messages received on
16062 the same SMTP connection are queued by default, whatever happens to the load in
16063 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16064 false.
16065
16066 Deliveries will subsequently be performed by queue runner processes. This
16067 option has no effect on ancient operating systems on which Exim cannot
16068 determine the load average. See also &%deliver_queue_load_max%& and
16069 &%smtp_load_reserve%&.
16070
16071
16072 .option queue_only_load_latch main boolean true
16073 .cindex "load average" "re-evaluating per message"
16074 When this option is true (the default), once one message has been queued
16075 because the load average is higher than the value set by &%queue_only_load%&,
16076 all subsequent messages received on the same SMTP connection are also queued.
16077 This is a deliberate choice; even though the load average may fall below the
16078 threshold, it doesn't seem right to deliver later messages on the same
16079 connection when not delivering earlier ones. However, there are special
16080 circumstances such as very long-lived connections from scanning appliances
16081 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16082 should be set false. This causes the value of the load average to be
16083 re-evaluated for each message.
16084
16085
16086 .option queue_only_override main boolean true
16087 .cindex "queueing incoming messages"
16088 When this option is true, the &%-od%&&'x'& command line options override the
16089 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16090 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16091 to override; they are accepted, but ignored.
16092
16093
16094 .option queue_run_in_order main boolean false
16095 .cindex "queue runner" "processing messages in order"
16096 If this option is set, queue runs happen in order of message arrival instead of
16097 in an arbitrary order. For this to happen, a complete list of the entire queue
16098 must be set up before the deliveries start. When the queue is all held in a
16099 single directory (the default), a single list is created for both the ordered
16100 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16101 single list is not created when &%queue_run_in_order%& is false. In this case,
16102 the sub-directories are processed one at a time (in a random order), and this
16103 avoids setting up one huge list for the whole queue. Thus, setting
16104 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16105 when the queue is large, because of the extra work in setting up the single,
16106 large list. In most situations, &%queue_run_in_order%& should not be set.
16107
16108
16109
16110 .option queue_run_max main integer&!! 5
16111 .cindex "queue runner" "maximum number of"
16112 This controls the maximum number of queue runner processes that an Exim daemon
16113 can run simultaneously. This does not mean that it starts them all at once,
16114 but rather that if the maximum number are still running when the time comes to
16115 start another one, it refrains from starting another one. This can happen with
16116 very large queues and/or very sluggish deliveries. This option does not,
16117 however, interlock with other processes, so additional queue runners can be
16118 started by other means, or by killing and restarting the daemon.
16119
16120 Setting this option to zero does not suppress queue runs; rather, it disables
16121 the limit, allowing any number of simultaneous queue runner processes to be
16122 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16123 the daemon's command line.
16124
16125 .cindex queues named
16126 .cindex "named queues"
16127 To set limits for different named queues use
16128 an expansion depending on the &$queue_name$& variable.
16129
16130 .option queue_smtp_domains main "domain list&!!" unset
16131 .cindex "queueing incoming messages"
16132 .cindex "message" "queueing remote deliveries"
16133 When this option is set, a delivery process is started whenever a message is
16134 received, routing is performed, and local deliveries take place.
16135 However, if any SMTP deliveries are required for domains that match
16136 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16137 message waits on the queue for the next queue run. Since routing of the message
16138 has taken place, Exim knows to which remote hosts it must be delivered, and so
16139 when the queue run happens, multiple messages for the same host are delivered
16140 over a single SMTP connection. The &%-odqs%& command line option causes all
16141 SMTP deliveries to be queued in this way, and is equivalent to setting
16142 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16143 &%queue_domains%&.
16144
16145
16146 .option receive_timeout main time 0s
16147 .cindex "timeout" "for non-SMTP input"
16148 This option sets the timeout for accepting a non-SMTP message, that is, the
16149 maximum time that Exim waits when reading a message on the standard input. If
16150 the value is zero, it will wait for ever. This setting is overridden by the
16151 &%-or%& command line option. The timeout for incoming SMTP messages is
16152 controlled by &%smtp_receive_timeout%&.
16153
16154 .option received_header_text main string&!! "see below"
16155 .cindex "customizing" "&'Received:'& header"
16156 .cindex "&'Received:'& header line" "customizing"
16157 This string defines the contents of the &'Received:'& message header that is
16158 added to each message, except for the timestamp, which is automatically added
16159 on at the end (preceded by a semicolon). The string is expanded each time it is
16160 used. If the expansion yields an empty string, no &'Received:'& header line is
16161 added to the message. Otherwise, the string should start with the text
16162 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16163 header lines. The default setting is:
16164
16165 .code
16166 received_header_text = Received: \
16167   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16168   {${if def:sender_ident \
16169   {from ${quote_local_part:$sender_ident} }}\
16170   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16171   by $primary_hostname \
16172   ${if def:received_protocol {with $received_protocol}} \
16173   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16174   (Exim $version_number)\n\t\
16175   ${if def:sender_address \
16176   {(envelope-from <$sender_address>)\n\t}}\
16177   id $message_exim_id\
16178   ${if def:received_for {\n\tfor $received_for}}
16179 .endd
16180
16181 The reference to the TLS cipher is omitted when Exim is built without TLS
16182 support. The use of conditional expansions ensures that this works for both
16183 locally generated messages and messages received from remote hosts, giving
16184 header lines such as the following:
16185 .code
16186 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16187 by marley.carol.example with esmtp (Exim 4.00)
16188 (envelope-from <bob@carol.example>)
16189 id 16IOWa-00019l-00
16190 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16191 Received: by scrooge.carol.example with local (Exim 4.00)
16192 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16193 .endd
16194 Until the body of the message has been received, the timestamp is the time when
16195 the message started to be received. Once the body has arrived, and all policy
16196 checks have taken place, the timestamp is updated to the time at which the
16197 message was accepted.
16198
16199
16200 .option received_headers_max main integer 30
16201 .cindex "loop" "prevention"
16202 .cindex "mail loop prevention"
16203 .cindex "&'Received:'& header line" "counting"
16204 When a message is to be delivered, the number of &'Received:'& headers is
16205 counted, and if it is greater than this parameter, a mail loop is assumed to
16206 have occurred, the delivery is abandoned, and an error message is generated.
16207 This applies to both local and remote deliveries.
16208
16209
16210 .option recipient_unqualified_hosts main "host list&!!" unset
16211 .cindex "unqualified addresses"
16212 .cindex "host" "unqualified addresses from"
16213 This option lists those hosts from which Exim is prepared to accept unqualified
16214 recipient addresses in message envelopes. The addresses are made fully
16215 qualified by the addition of the &%qualify_recipient%& value. This option also
16216 affects message header lines. Exim does not reject unqualified recipient
16217 addresses in headers, but it qualifies them only if the message came from a
16218 host that matches &%recipient_unqualified_hosts%&,
16219 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16220 option was not set.
16221
16222
16223 .option recipients_max main integer 0
16224 .cindex "limit" "number of recipients"
16225 .cindex "recipient" "maximum number"
16226 If this option is set greater than zero, it specifies the maximum number of
16227 original recipients for any message. Additional recipients that are generated
16228 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16229 all recipients over the limit; earlier recipients are delivered as normal.
16230 Non-SMTP messages with too many recipients are failed, and no deliveries are
16231 done.
16232
16233 .cindex "RCPT" "maximum number of incoming"
16234 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16235 RCPT commands in a single message.
16236
16237
16238 .option recipients_max_reject main boolean false
16239 If this option is set true, Exim rejects SMTP messages containing too many
16240 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16241 error to the eventual DATA command. Otherwise (the default) it gives a 452
16242 error to the surplus RCPT commands and accepts the message on behalf of the
16243 initial set of recipients. The remote server should then re-send the message
16244 for the remaining recipients at a later time.
16245
16246
16247 .option remote_max_parallel main integer 2
16248 .cindex "delivery" "parallelism for remote"
16249 This option controls parallel delivery of one message to a number of remote
16250 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16251 does all the remote deliveries for a message one by one. Otherwise, if a single
16252 message has to be delivered to more than one remote host, or if several copies
16253 have to be sent to the same remote host, up to &%remote_max_parallel%&
16254 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16255 deliveries are required, the maximum number of processes are started, and as
16256 each one finishes, another is begun. The order of starting processes is the
16257 same as if sequential delivery were being done, and can be controlled by the
16258 &%remote_sort_domains%& option. If parallel delivery takes place while running
16259 with debugging turned on, the debugging output from each delivery process is
16260 tagged with its process id.
16261
16262 This option controls only the maximum number of parallel deliveries for one
16263 message in one Exim delivery process. Because Exim has no central queue
16264 manager, there is no way of controlling the total number of simultaneous
16265 deliveries if the configuration allows a delivery attempt as soon as a message
16266 is received.
16267
16268 .cindex "number of deliveries"
16269 .cindex "delivery" "maximum number of"
16270 If you want to control the total number of deliveries on the system, you
16271 need to set the &%queue_only%& option. This ensures that all incoming messages
16272 are added to the queue without starting a delivery process. Then set up an Exim
16273 daemon to start queue runner processes at appropriate intervals (probably
16274 fairly often, for example, every minute), and limit the total number of queue
16275 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16276 delivers only one message at a time, the maximum number of deliveries that can
16277 then take place at once is &%queue_run_max%& multiplied by
16278 &%remote_max_parallel%&.
16279
16280 If it is purely remote deliveries you want to control, use
16281 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16282 doing the SMTP routing before queueing, so that several messages for the same
16283 host will eventually get delivered down the same connection.
16284
16285
16286 .option remote_sort_domains main "domain list&!!" unset
16287 .cindex "sorting remote deliveries"
16288 .cindex "delivery" "sorting remote"
16289 When there are a number of remote deliveries for a message, they are sorted by
16290 domain into the order given by this list. For example,
16291 .code
16292 remote_sort_domains = *.cam.ac.uk:*.uk
16293 .endd
16294 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16295 then to those in the &%uk%& domain, then to any others.
16296
16297
16298 .option retry_data_expire main time 7d
16299 .cindex "hints database" "data expiry"
16300 This option sets a &"use before"& time on retry information in Exim's hints
16301 database. Any older retry data is ignored. This means that, for example, once a
16302 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16303 past failures.
16304
16305
16306 .option retry_interval_max main time 24h
16307 .cindex "retry" "limit on interval"
16308 .cindex "limit" "on retry interval"
16309 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16310 intervals between delivery attempts for messages that cannot be delivered
16311 straight away. This option sets an overall limit to the length of time between
16312 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16313 the default value.
16314
16315
16316 .option return_path_remove main boolean true
16317 .cindex "&'Return-path:'& header line" "removing"
16318 RFC 2821, section 4.4, states that an SMTP server must insert a
16319 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16320 The &'Return-path:'& header preserves the sender address as received in the
16321 MAIL command. This description implies that this header should not be present
16322 in an incoming message. If &%return_path_remove%& is true, any existing
16323 &'Return-path:'& headers are removed from messages at the time they are
16324 received. Exim's transports have options for adding &'Return-path:'& headers at
16325 the time of delivery. They are normally used only for final local deliveries.
16326
16327
16328 .option return_size_limit main integer 100K
16329 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16330
16331
16332 .option rfc1413_hosts main "host list&!!" @[]
16333 .cindex "RFC 1413"
16334 .cindex "host" "for RFC 1413 calls"
16335 RFC 1413 identification calls are made to any client host which matches
16336 an item in the list.
16337 The default value specifies just this host, being any local interface
16338 for the system.
16339
16340 .option rfc1413_query_timeout main time 0s
16341 .cindex "RFC 1413" "query timeout"
16342 .cindex "timeout" "for RFC 1413 call"
16343 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16344 no RFC 1413 calls are ever made.
16345
16346
16347 .option sender_unqualified_hosts main "host list&!!" unset
16348 .cindex "unqualified addresses"
16349 .cindex "host" "unqualified addresses from"
16350 This option lists those hosts from which Exim is prepared to accept unqualified
16351 sender addresses. The addresses are made fully qualified by the addition of
16352 &%qualify_domain%&. This option also affects message header lines. Exim does
16353 not reject unqualified addresses in headers that contain sender addresses, but
16354 it qualifies them only if the message came from a host that matches
16355 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16356 using TCP/IP), and the &%-bnq%& option was not set.
16357
16358 .option set_environment main "string list" empty
16359 .cindex "environment"
16360 This option allows to set individual environment variables that the
16361 currently linked libraries and programs in child processes use. The
16362 default list is empty,
16363
16364
16365 .option slow_lookup_log main integer 0
16366 .cindex "logging" "slow lookups"
16367 .cindex "dns" "logging slow lookups"
16368 This option controls logging of slow lookups.
16369 If the value is nonzero it is taken as a number of milliseconds
16370 and lookups taking longer than this are logged.
16371 Currently this applies only to DNS lookups.
16372
16373
16374
16375 .option smtp_accept_keepalive main boolean true
16376 .cindex "keepalive" "on incoming connection"
16377 This option controls the setting of the SO_KEEPALIVE option on incoming
16378 TCP/IP socket connections. When set, it causes the kernel to probe idle
16379 connections periodically, by sending packets with &"old"& sequence numbers. The
16380 other end of the connection should send an acknowledgment if the connection is
16381 still okay or a reset if the connection has been aborted. The reason for doing
16382 this is that it has the beneficial effect of freeing up certain types of
16383 connection that can get stuck when the remote host is disconnected without
16384 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16385 hours to detect unreachable hosts.
16386
16387
16388
16389 .option smtp_accept_max main integer 20
16390 .cindex "limit" "incoming SMTP connections"
16391 .cindex "SMTP" "incoming connection count"
16392 .cindex "inetd"
16393 This option specifies the maximum number of simultaneous incoming SMTP calls
16394 that Exim will accept. It applies only to the listening daemon; there is no
16395 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16396 value is set to zero, no limit is applied. However, it is required to be
16397 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16398 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16399
16400 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16401 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16402 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16403 and &%smtp_load_reserve%& are then checked before accepting the connection.
16404
16405
16406 .option smtp_accept_max_nonmail main integer 10
16407 .cindex "limit" "non-mail SMTP commands"
16408 .cindex "SMTP" "limiting non-mail commands"
16409 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16410 the connection if there are too many. This option defines &"too many"&. The
16411 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16412 client looping sending EHLO, for example. The check is applied only if the
16413 client host matches &%smtp_accept_max_nonmail_hosts%&.
16414
16415 When a new message is expected, one occurrence of RSET is not counted. This
16416 allows a client to send one RSET between messages (this is not necessary,
16417 but some clients do it). Exim also allows one uncounted occurrence of HELO
16418 or EHLO, and one occurrence of STARTTLS between messages. After
16419 starting up a TLS session, another EHLO is expected, and so it too is not
16420 counted. The first occurrence of AUTH in a connection, or immediately
16421 following STARTTLS is not counted. Otherwise, all commands other than
16422 MAIL, RCPT, DATA, and QUIT are counted.
16423
16424
16425 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16426 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16427 check by setting this option. The default value makes it apply to all hosts. By
16428 changing the value, you can exclude any badly-behaved hosts that you have to
16429 live with.
16430
16431
16432 . Allow this long option name to split; give it unsplit as a fifth argument
16433 . for the automatic .oindex that is generated by .option.
16434 . We insert " &~&~" which is both pretty nasty visually and results in
16435 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16436 . zero-width-space, which would be nicer visually and results in (at least)
16437 . html that Firefox will split on when it's forced to reflow (rather than
16438 . inserting a horizontal scrollbar).  However, the text is still not
16439 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16440 . the option name to split.
16441
16442 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16443          smtp_accept_max_per_connection
16444 .cindex "SMTP" "limiting incoming message count"
16445 .cindex "limit" "messages per SMTP connection"
16446 The value of this option limits the number of MAIL commands that Exim is
16447 prepared to accept over a single SMTP connection, whether or not each command
16448 results in the transfer of a message. After the limit is reached, a 421
16449 response is given to subsequent MAIL commands. This limit is a safety
16450 precaution against a client that goes mad (incidents of this type have been
16451 seen).
16452
16453
16454 .option smtp_accept_max_per_host main string&!! unset
16455 .cindex "limit" "SMTP connections from one host"
16456 .cindex "host" "limiting SMTP connections from"
16457 This option restricts the number of simultaneous IP connections from a single
16458 host (strictly, from a single IP address) to the Exim daemon. The option is
16459 expanded, to enable different limits to be applied to different hosts by
16460 reference to &$sender_host_address$&. Once the limit is reached, additional
16461 connection attempts from the same host are rejected with error code 421. This
16462 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16463 of zero imposes no limit. If this option is set greater than zero, it is
16464 required that &%smtp_accept_max%& be non-zero.
16465
16466 &*Warning*&: When setting this option you should not use any expansion
16467 constructions that take an appreciable amount of time. The expansion and test
16468 happen in the main daemon loop, in order to reject additional connections
16469 without forking additional processes (otherwise a denial-of-service attack
16470 could cause a vast number or processes to be created). While the daemon is
16471 doing this processing, it cannot accept any other incoming connections.
16472
16473
16474
16475 .option smtp_accept_queue main integer 0
16476 .cindex "SMTP" "incoming connection count"
16477 .cindex "queueing incoming messages"
16478 .cindex "message" "queueing by SMTP connection count"
16479 If the number of simultaneous incoming SMTP connections being handled via the
16480 listening daemon exceeds this value, messages received by SMTP are just placed
16481 on the queue; no delivery processes are started automatically. The count is
16482 fixed at the start of an SMTP connection. It cannot be updated in the
16483 subprocess that receives messages, and so the queueing or not queueing applies
16484 to all messages received in the same connection.
16485
16486 A value of zero implies no limit, and clearly any non-zero value is useful only
16487 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16488 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16489 various &%-od%&&'x'& command line options.
16490
16491
16492 . See the comment on smtp_accept_max_per_connection
16493
16494 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16495          smtp_accept_queue_per_connection
16496 .cindex "queueing incoming messages"
16497 .cindex "message" "queueing by message count"
16498 This option limits the number of delivery processes that Exim starts
16499 automatically when receiving messages via SMTP, whether via the daemon or by
16500 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16501 and the number of messages received in a single SMTP session exceeds this
16502 number, subsequent messages are placed on the queue, but no delivery processes
16503 are started. This helps to limit the number of Exim processes when a server
16504 restarts after downtime and there is a lot of mail waiting for it on other
16505 systems. On large systems, the default should probably be increased, and on
16506 dial-in client systems it should probably be set to zero (that is, disabled).
16507
16508
16509 .option smtp_accept_reserve main integer 0
16510 .cindex "SMTP" "incoming call count"
16511 .cindex "host" "reserved"
16512 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16513 number of SMTP connections that are reserved for connections from the hosts
16514 that are specified in &%smtp_reserve_hosts%&. The value set in
16515 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16516 restricted to this number of connections; the option specifies a minimum number
16517 of connection slots for them, not a maximum. It is a guarantee that this group
16518 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16519 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16520 individual host.
16521
16522 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16523 set to 5, once there are 45 active connections (from any hosts), new
16524 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16525 provided the other criteria for acceptance are met.
16526
16527
16528 .option smtp_active_hostname main string&!! unset
16529 .cindex "host" "name in SMTP responses"
16530 .cindex "SMTP" "host name in responses"
16531 .vindex "&$primary_hostname$&"
16532 This option is provided for multi-homed servers that want to masquerade as
16533 several different hosts. At the start of an incoming SMTP connection, its value
16534 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16535 responses. For example, it is used as domain name in the response to an
16536 incoming HELO or EHLO command.
16537
16538 .vindex "&$smtp_active_hostname$&"
16539 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16540 is saved with any messages that are received. It is therefore available for use
16541 in routers and transports when the message is later delivered.
16542
16543 If this option is unset, or if its expansion is forced to fail, or if the
16544 expansion results in an empty string, the value of &$primary_hostname$& is
16545 used. Other expansion failures cause a message to be written to the main and
16546 panic logs, and the SMTP command receives a temporary error. Typically, the
16547 value of &%smtp_active_hostname%& depends on the incoming interface address.
16548 For example:
16549 .code
16550 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16551   {cox.mydomain}{box.mydomain}}
16552 .endd
16553
16554 Although &$smtp_active_hostname$& is primarily concerned with incoming
16555 messages, it is also used as the default for HELO commands in callout
16556 verification if there is no remote transport from which to obtain a
16557 &%helo_data%& value.
16558
16559 .option smtp_banner main string&!! "see below"
16560 .cindex "SMTP" "welcome banner"
16561 .cindex "banner for SMTP"
16562 .cindex "welcome banner for SMTP"
16563 .cindex "customizing" "SMTP banner"
16564 This string, which is expanded every time it is used, is output as the initial
16565 positive response to an SMTP connection. The default setting is:
16566 .code
16567 smtp_banner = $smtp_active_hostname ESMTP Exim \
16568   $version_number $tod_full
16569 .endd
16570 Failure to expand the string causes a panic error. If you want to create a
16571 multiline response to the initial SMTP connection, use &"\n"& in the string at
16572 appropriate points, but not at the end. Note that the 220 code is not included
16573 in this string. Exim adds it automatically (several times in the case of a
16574 multiline response).
16575
16576
16577 .option smtp_check_spool_space main boolean true
16578 .cindex "checking disk space"
16579 .cindex "disk space, checking"
16580 .cindex "spool directory" "checking space"
16581 When this option is set, if an incoming SMTP session encounters the SIZE
16582 option on a MAIL command, it checks that there is enough space in the
16583 spool directory's partition to accept a message of that size, while still
16584 leaving free the amount specified by &%check_spool_space%& (even if that value
16585 is zero). If there isn't enough space, a temporary error code is returned.
16586
16587
16588 .option smtp_connect_backlog main integer 20
16589 .cindex "connection backlog"
16590 .cindex "SMTP" "connection backlog"
16591 .cindex "backlog of connections"
16592 This option specifies a maximum number of waiting SMTP connections. Exim passes
16593 this value to the TCP/IP system when it sets up its listener. Once this number
16594 of connections are waiting for the daemon's attention, subsequent connection
16595 attempts are refused at the TCP/IP level. At least, that is what the manuals
16596 say; in some circumstances such connection attempts have been observed to time
16597 out instead. For large systems it is probably a good idea to increase the
16598 value (to 50, say). It also gives some protection against denial-of-service
16599 attacks by SYN flooding.
16600
16601
16602 .option smtp_enforce_sync main boolean true
16603 .cindex "SMTP" "synchronization checking"
16604 .cindex "synchronization checking in SMTP"
16605 The SMTP protocol specification requires the client to wait for a response from
16606 the server at certain points in the dialogue. Without PIPELINING these
16607 synchronization points are after every command; with PIPELINING they are
16608 fewer, but they still exist.
16609
16610 Some spamming sites send out a complete set of SMTP commands without waiting
16611 for any response. Exim protects against this by rejecting a message if the
16612 client has sent further input when it should not have. The error response &"554
16613 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16614 for this error cannot be perfect because of transmission delays (unexpected
16615 input may be on its way but not yet received when Exim checks). However, it
16616 does detect many instances.
16617
16618 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16619 If you want to disable the check selectively (for example, only for certain
16620 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16621 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16622
16623
16624
16625 .option smtp_etrn_command main string&!! unset
16626 .cindex "ETRN" "command to be run"
16627 .vindex "&$domain$&"
16628 If this option is set, the given command is run whenever an SMTP ETRN
16629 command is received from a host that is permitted to issue such commands (see
16630 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16631 are independently expanded. The expansion variable &$domain$& is set to the
16632 argument of the ETRN command, and no syntax checking is done on it. For
16633 example:
16634 .code
16635 smtp_etrn_command = /etc/etrn_command $domain \
16636                     $sender_host_address
16637 .endd
16638 A new process is created to run the command, but Exim does not wait for it to
16639 complete. Consequently, its status cannot be checked. If the command cannot be
16640 run, a line is written to the panic log, but the ETRN caller still receives
16641 a 250 success response. Exim is normally running under its own uid when
16642 receiving SMTP, so it is not possible for it to change the uid before running
16643 the command.
16644
16645
16646 .option smtp_etrn_serialize main boolean true
16647 .cindex "ETRN" "serializing"
16648 When this option is set, it prevents the simultaneous execution of more than
16649 one identical command as a result of ETRN in an SMTP connection. See
16650 section &<<SECTETRN>>& for details.
16651
16652
16653 .option smtp_load_reserve main fixed-point unset
16654 .cindex "load average"
16655 If the system load average ever gets higher than this, incoming SMTP calls are
16656 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16657 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16658 the load is over the limit. The option has no effect on ancient operating
16659 systems on which Exim cannot determine the load average. See also
16660 &%deliver_queue_load_max%& and &%queue_only_load%&.
16661
16662
16663
16664 .option smtp_max_synprot_errors main integer 3
16665 .cindex "SMTP" "limiting syntax and protocol errors"
16666 .cindex "limit" "SMTP syntax and protocol errors"
16667 Exim rejects SMTP commands that contain syntax or protocol errors. In
16668 particular, a syntactically invalid email address, as in this command:
16669 .code
16670 RCPT TO:<abc xyz@a.b.c>
16671 .endd
16672 causes immediate rejection of the command, before any other tests are done.
16673 (The ACL cannot be run if there is no valid address to set up for it.) An
16674 example of a protocol error is receiving RCPT before MAIL. If there are
16675 too many syntax or protocol errors in one SMTP session, the connection is
16676 dropped. The limit is set by this option.
16677
16678 .cindex "PIPELINING" "expected errors"
16679 When the PIPELINING extension to SMTP is in use, some protocol errors are
16680 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16681 Exim assumes that PIPELINING will be used if it advertises it (see
16682 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16683 not count towards the limit.
16684
16685
16686
16687 .option smtp_max_unknown_commands main integer 3
16688 .cindex "SMTP" "limiting unknown commands"
16689 .cindex "limit" "unknown SMTP commands"
16690 If there are too many unrecognized commands in an incoming SMTP session, an
16691 Exim server drops the connection. This is a defence against some kinds of abuse
16692 that subvert web
16693 clients
16694 into making connections to SMTP ports; in these circumstances, a number of
16695 non-SMTP command lines are sent first.
16696
16697
16698
16699 .option smtp_ratelimit_hosts main "host list&!!" unset
16700 .cindex "SMTP" "rate limiting"
16701 .cindex "limit" "rate of message arrival"
16702 .cindex "RCPT" "rate limiting"
16703 Some sites find it helpful to be able to limit the rate at which certain hosts
16704 can send them messages, and the rate at which an individual message can specify
16705 recipients.
16706
16707 Exim has two rate-limiting facilities. This section describes the older
16708 facility, which can limit rates within a single connection. The newer
16709 &%ratelimit%& ACL condition can limit rates across all connections. See section
16710 &<<SECTratelimiting>>& for details of the newer facility.
16711
16712 When a host matches &%smtp_ratelimit_hosts%&, the values of
16713 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16714 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16715 respectively. Each option, if set, must contain a set of four comma-separated
16716 values:
16717
16718 .ilist
16719 A threshold, before which there is no rate limiting.
16720 .next
16721 An initial time delay. Unlike other times in Exim, numbers with decimal
16722 fractional parts are allowed here.
16723 .next
16724 A factor by which to increase the delay each time.
16725 .next
16726 A maximum value for the delay. This should normally be less than 5 minutes,
16727 because after that time, the client is liable to timeout the SMTP command.
16728 .endlist
16729
16730 For example, these settings have been used successfully at the site which
16731 first suggested this feature, for controlling mail from their customers:
16732 .code
16733 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16734 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16735 .endd
16736 The first setting specifies delays that are applied to MAIL commands after
16737 two have been received over a single connection. The initial delay is 0.5
16738 seconds, increasing by a factor of 1.05 each time. The second setting applies
16739 delays to RCPT commands when more than four occur in a single message.
16740
16741
16742 .option smtp_ratelimit_mail main string unset
16743 See &%smtp_ratelimit_hosts%& above.
16744
16745
16746 .option smtp_ratelimit_rcpt main string unset
16747 See &%smtp_ratelimit_hosts%& above.
16748
16749
16750 .option smtp_receive_timeout main time&!! 5m
16751 .cindex "timeout" "for SMTP input"
16752 .cindex "SMTP" "input timeout"
16753 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16754 input, including batch SMTP. If a line of input (either an SMTP command or a
16755 data line) is not received within this time, the SMTP connection is dropped and
16756 the message is abandoned.
16757 A line is written to the log containing one of the following messages:
16758 .code
16759 SMTP command timeout on connection from...
16760 SMTP data timeout on connection from...
16761 .endd
16762 The former means that Exim was expecting to read an SMTP command; the latter
16763 means that it was in the DATA phase, reading the contents of a message.
16764
16765 If the first character of the option is a &"$"& the option is
16766 expanded before use and may depend on
16767 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16768
16769
16770 .oindex "&%-os%&"
16771 The value set by this option can be overridden by the
16772 &%-os%& command-line option. A setting of zero time disables the timeout, but
16773 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16774 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16775 timeout is controlled by &%receive_timeout%& and &%-or%&.
16776
16777
16778 .option smtp_reserve_hosts main "host list&!!" unset
16779 This option defines hosts for which SMTP connections are reserved; see
16780 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16781
16782
16783 .option smtp_return_error_details main boolean false
16784 .cindex "SMTP" "details policy failures"
16785 .cindex "policy control" "rejection, returning details"
16786 In the default state, Exim uses bland messages such as
16787 &"Administrative prohibition"& when it rejects SMTP commands for policy
16788 reasons. Many sysadmins like this because it gives away little information
16789 to spammers. However, some other sysadmins who are applying strict checking
16790 policies want to give out much fuller information about failures. Setting
16791 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16792 example, instead of &"Administrative prohibition"&, it might give:
16793 .code
16794 550-Rejected after DATA: '>' missing at end of address:
16795 550 failing address in "From" header is: <user@dom.ain
16796 .endd
16797
16798
16799 .option smtputf8_advertise_hosts main "host list&!!" *
16800 .cindex "SMTPUTF8" "advertising"
16801 When Exim is built with support for internationalised mail names,
16802 the availability thereof is advertised in
16803 response to EHLO only to those client hosts that match this option. See
16804 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16805
16806
16807 .option spamd_address main string "see below"
16808 This option is available when Exim is compiled with the content-scanning
16809 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16810 The default value is
16811 .code
16812 127.0.0.1 783
16813 .endd
16814 See section &<<SECTscanspamass>>& for more details.
16815
16816
16817
16818 .option split_spool_directory main boolean false
16819 .cindex "multiple spool directories"
16820 .cindex "spool directory" "split"
16821 .cindex "directories, multiple"
16822 If this option is set, it causes Exim to split its input directory into 62
16823 subdirectories, each with a single alphanumeric character as its name. The
16824 sixth character of the message id is used to allocate messages to
16825 subdirectories; this is the least significant base-62 digit of the time of
16826 arrival of the message.
16827
16828 Splitting up the spool in this way may provide better performance on systems
16829 where there are long mail queues, by reducing the number of files in any one
16830 directory. The msglog directory is also split up in a similar way to the input
16831 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16832 are still placed in the single directory &_msglog.OLD_&.
16833
16834 It is not necessary to take any special action for existing messages when
16835 changing &%split_spool_directory%&. Exim notices messages that are in the
16836 &"wrong"& place, and continues to process them. If the option is turned off
16837 after a period of being on, the subdirectories will eventually empty and be
16838 automatically deleted.
16839
16840 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16841 changes. Instead of creating a list of all messages in the queue, and then
16842 trying to deliver each one in turn, it constructs a list of those in one
16843 sub-directory and tries to deliver them, before moving on to the next
16844 sub-directory. The sub-directories are processed in a random order. This
16845 spreads out the scanning of the input directories, and uses less memory. It is
16846 particularly beneficial when there are lots of messages on the queue. However,
16847 if &%queue_run_in_order%& is set, none of this new processing happens. The
16848 entire queue has to be scanned and sorted before any deliveries can start.
16849
16850
16851 .option spool_directory main string&!! "set at compile time"
16852 .cindex "spool directory" "path to"
16853 This defines the directory in which Exim keeps its spool, that is, the messages
16854 it is waiting to deliver. The default value is taken from the compile-time
16855 configuration setting, if there is one. If not, this option must be set. The
16856 string is expanded, so it can contain, for example, a reference to
16857 &$primary_hostname$&.
16858
16859 If the spool directory name is fixed on your installation, it is recommended
16860 that you set it at build time rather than from this option, particularly if the
16861 log files are being written to the spool directory (see &%log_file_path%&).
16862 Otherwise log files cannot be used for errors that are detected early on, such
16863 as failures in the configuration file.
16864
16865 By using this option to override the compiled-in path, it is possible to run
16866 tests of Exim without using the standard spool.
16867
16868 .option spool_wireformat main boolean false
16869 .cindex "spool directory" "file formats"
16870 If this option is set, Exim may for some messages use an alternate format
16871 for data-files in the spool which matches the wire format.
16872 Doing this permits more efficient message reception and transmission.
16873 Currently it is only done for messages received using the EMSTP CHUNKING
16874 option.
16875
16876 The following variables will not have useful values:
16877 .code
16878 $max_received_linelength
16879 $body_linecount
16880 $body_zerocount
16881 .endd
16882
16883 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
16884 and any external programs which are passed a reference to a message data file
16885 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
16886 will need to be aware of the potential different format.
16887
16888 Using any of the ACL conditions noted will negate the reception benefit
16889 (as a Unix-mbox-format file is contructed for them).
16890 The transimssion benefit is maintained.
16891
16892 .option sqlite_lock_timeout main time 5s
16893 .cindex "sqlite lookup type" "lock timeout"
16894 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16895 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16896
16897 .option strict_acl_vars main boolean false
16898 .cindex "&ACL;" "variables, handling unset"
16899 This option controls what happens if a syntactically valid but undefined ACL
16900 variable is referenced. If it is false (the default), an empty string
16901 is substituted; if it is true, an error is generated. See section
16902 &<<SECTaclvariables>>& for details of ACL variables.
16903
16904 .option strip_excess_angle_brackets main boolean false
16905 .cindex "angle brackets, excess"
16906 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16907 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16908 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16909 passed on to another MTA, the excess angle brackets are not passed on. If this
16910 option is not set, multiple pairs of angle brackets cause a syntax error.
16911
16912
16913 .option strip_trailing_dot main boolean false
16914 .cindex "trailing dot on domain"
16915 .cindex "dot" "trailing on domain"
16916 If this option is set, a trailing dot at the end of a domain in an address is
16917 ignored. If this is in the envelope and the message is passed on to another
16918 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16919 domain causes a syntax error.
16920 However, addresses in header lines are checked only when an ACL requests header
16921 syntax checking.
16922
16923
16924 .option syslog_duplication main boolean true
16925 .cindex "syslog" "duplicate log lines; suppressing"
16926 When Exim is logging to syslog, it writes the log lines for its three
16927 separate logs at different syslog priorities so that they can in principle
16928 be separated on the logging hosts. Some installations do not require this
16929 separation, and in those cases, the duplication of certain log lines is a
16930 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16931 particular log line is written to syslog. For lines that normally go to
16932 both the main log and the reject log, the reject log version (possibly
16933 containing message header lines) is written, at LOG_NOTICE priority.
16934 Lines that normally go to both the main and the panic log are written at
16935 the LOG_ALERT priority.
16936
16937
16938 .option syslog_facility main string unset
16939 .cindex "syslog" "facility; setting"
16940 This option sets the syslog &"facility"& name, used when Exim is logging to
16941 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16942 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16943 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16944 details of Exim's logging.
16945
16946
16947 .option syslog_pid main boolean true
16948 .cindex "syslog" "pid"
16949 If &%syslog_pid%& is set false, the PID on Exim's log lines are
16950 omitted when these lines are sent to syslog. (Syslog normally prefixes
16951 the log lines with the PID of the logging process automatically.) You need
16952 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
16953 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
16954
16955
16956
16957 .option syslog_processname main string &`exim`&
16958 .cindex "syslog" "process name; setting"
16959 This option sets the syslog &"ident"& name, used when Exim is logging to
16960 syslog. The value must be no longer than 32 characters. See chapter
16961 &<<CHAPlog>>& for details of Exim's logging.
16962
16963
16964
16965 .option syslog_timestamp main boolean true
16966 .cindex "syslog" "timestamps"
16967 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16968 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16969 details of Exim's logging.
16970
16971
16972 .option system_filter main string&!! unset
16973 .cindex "filter" "system filter"
16974 .cindex "system filter" "specifying"
16975 .cindex "Sieve filter" "not available for system filter"
16976 This option specifies an Exim filter file that is applied to all messages at
16977 the start of each delivery attempt, before any routing is done. System filters
16978 must be Exim filters; they cannot be Sieve filters. If the system filter
16979 generates any deliveries to files or pipes, or any new mail messages, the
16980 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16981 which transports are to be used. Details of this facility are given in chapter
16982 &<<CHAPsystemfilter>>&.
16983 A forced expansion failure results in no filter operation.
16984
16985
16986 .option system_filter_directory_transport main string&!! unset
16987 .vindex "&$address_file$&"
16988 This sets the name of the transport driver that is to be used when the
16989 &%save%& command in a system message filter specifies a path ending in &"/"&,
16990 implying delivery of each message into a separate file in some directory.
16991 During the delivery, the variable &$address_file$& contains the path name.
16992
16993
16994 .option system_filter_file_transport main string&!! unset
16995 .cindex "file" "transport for system filter"
16996 This sets the name of the transport driver that is to be used when the &%save%&
16997 command in a system message filter specifies a path not ending in &"/"&. During
16998 the delivery, the variable &$address_file$& contains the path name.
16999
17000 .option system_filter_group main string unset
17001 .cindex "gid (group id)" "system filter"
17002 This option is used only when &%system_filter_user%& is also set. It sets the
17003 gid under which the system filter is run, overriding any gid that is associated
17004 with the user. The value may be numerical or symbolic.
17005
17006 .option system_filter_pipe_transport main string&!! unset
17007 .cindex "&(pipe)& transport" "for system filter"
17008 .vindex "&$address_pipe$&"
17009 This specifies the transport driver that is to be used when a &%pipe%& command
17010 is used in a system filter. During the delivery, the variable &$address_pipe$&
17011 contains the pipe command.
17012
17013
17014 .option system_filter_reply_transport main string&!! unset
17015 .cindex "&(autoreply)& transport" "for system filter"
17016 This specifies the transport driver that is to be used when a &%mail%& command
17017 is used in a system filter.
17018
17019
17020 .option system_filter_user main string unset
17021 .cindex "uid (user id)" "system filter"
17022 If this option is set to root, the system filter is run in the main Exim
17023 delivery process, as root.  Otherwise, the system filter runs in a separate
17024 process, as the given user, defaulting to the Exim run-time user.
17025 Unless the string consists entirely of digits, it
17026 is looked up in the password data. Failure to find the named user causes a
17027 configuration error. The gid is either taken from the password data, or
17028 specified by &%system_filter_group%&. When the uid is specified numerically,
17029 &%system_filter_group%& is required to be set.
17030
17031 If the system filter generates any pipe, file, or reply deliveries, the uid
17032 under which the filter is run is used when transporting them, unless a
17033 transport option overrides.
17034
17035
17036 .option tcp_nodelay main boolean true
17037 .cindex "daemon" "TCP_NODELAY on sockets"
17038 .cindex "Nagle algorithm"
17039 .cindex "TCP_NODELAY on listening sockets"
17040 If this option is set false, it stops the Exim daemon setting the
17041 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17042 turns off the &"Nagle algorithm"&, which is a way of improving network
17043 performance in interactive (character-by-character) situations. Turning it off
17044 should improve Exim's performance a bit, so that is what happens by default.
17045 However, it appears that some broken clients cannot cope, and time out. Hence
17046 this option. It affects only those sockets that are set up for listening by the
17047 daemon. Sockets created by the smtp transport for delivering mail always set
17048 TCP_NODELAY.
17049
17050
17051 .option timeout_frozen_after main time 0s
17052 .cindex "frozen messages" "timing out"
17053 .cindex "timeout" "frozen messages"
17054 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17055 message of any kind that has been on the queue for longer than the given time
17056 is automatically cancelled at the next queue run. If the frozen message is a
17057 bounce message, it is just discarded; otherwise, a bounce is sent to the
17058 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17059 If you want to timeout frozen bounce messages earlier than other kinds of
17060 frozen message, see &%ignore_bounce_errors_after%&.
17061
17062 &*Note:*& the default value of zero means no timeouts; with this setting,
17063 frozen messages remain on the queue forever (except for any frozen bounce
17064 messages that are released by &%ignore_bounce_errors_after%&).
17065
17066
17067 .option timezone main string unset
17068 .cindex "timezone, setting"
17069 .cindex "environment" "values from"
17070 The value of &%timezone%& is used to set the environment variable TZ while
17071 running Exim (if it is different on entry). This ensures that all timestamps
17072 created by Exim are in the required timezone. If you want all your timestamps
17073 to be in UTC (aka GMT) you should set
17074 .code
17075 timezone = UTC
17076 .endd
17077 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17078 or, if that is not set, from the value of the TZ environment variable when Exim
17079 is built. If &%timezone%& is set to the empty string, either at build or run
17080 time, any existing TZ variable is removed from the environment when Exim
17081 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17082 unfortunately not all, operating systems.
17083
17084
17085 .option tls_advertise_hosts main "host list&!!" *
17086 .cindex "TLS" "advertising"
17087 .cindex "encryption" "on SMTP connection"
17088 .cindex "SMTP" "encrypted connection"
17089 When Exim is built with support for TLS encrypted connections, the availability
17090 of the STARTTLS command to set up an encrypted session is advertised in
17091 response to EHLO only to those client hosts that match this option. See
17092 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17093 Note that the default value requires that a certificate be supplied
17094 using the &%tls_certificate%& option.  If TLS support for incoming connections
17095 is not required the &%tls_advertise_hosts%& option should be set empty.
17096
17097
17098 .option tls_certificate main string list&!! unset
17099 .cindex "TLS" "server certificate; location of"
17100 .cindex "certificate" "server, location of"
17101 The value of this option is expanded, and must then be a list of absolute paths to
17102 files which contains the server's certificates.  Commonly only one file is
17103 needed.
17104 The server's private key is also
17105 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17106 &<<CHAPTLS>>& for further details.
17107
17108 &*Note*&: The certificates defined by this option are used only when Exim is
17109 receiving incoming messages as a server. If you want to supply certificates for
17110 use when sending messages as a client, you must set the &%tls_certificate%&
17111 option in the relevant &(smtp)& transport.
17112
17113 &*Note*&: If you use filenames based on IP addresses, change the list
17114 separator in the usual way to avoid confusion under IPv6.
17115
17116 &*Note*&: Under current versions of OpenSSL, when a list of more than one
17117 file is used, the &$tls_in_ourcert$& veriable is unreliable.
17118
17119 &*Note*&: OCSP stapling is not usable under OpenSSL
17120 when a list of more than one file is used.
17121
17122 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17123 if the OpenSSL build supports TLS extensions and the TLS client sends the
17124 Server Name Indication extension, then this option and others documented in
17125 &<<SECTtlssni>>& will be re-expanded.
17126
17127 If this option is unset or empty a fresh self-signed certificate will be
17128 generated for every connection.
17129
17130 .option tls_crl main string&!! unset
17131 .cindex "TLS" "server certificate revocation list"
17132 .cindex "certificate" "revocation list for server"
17133 This option specifies a certificate revocation list. The expanded value must
17134 be the name of a file that contains CRLs in PEM format.
17135
17136 .new
17137 Under OpenSSL the option can specify a directory with CRL files.
17138
17139 &*Note: Under OpenSSL the option must, if given, supply a CRL
17140 for each signing element of the certificate chain (i.e. all but the leaf).
17141 For the file variant this can be multiple PEM blocks in the one file.
17142 .wen
17143
17144 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17145
17146
17147 .option tls_dh_max_bits main integer 2236
17148 .cindex "TLS" "D-H bit count"
17149 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17150 the chosen TLS library.  That value might prove to be too high for
17151 interoperability.  This option provides a maximum clamp on the value
17152 suggested, trading off security for interoperability.
17153
17154 The value must be at least 1024.
17155
17156 The value 2236 was chosen because, at time of adding the option, it was the
17157 hard-coded maximum value supported by the NSS cryptographic library, as used
17158 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17159
17160 If you prefer more security and are willing to break some clients, raise this
17161 number.
17162
17163 Note that the value passed to GnuTLS for *generating* a new prime may be a
17164 little less than this figure, because GnuTLS is inexact and may produce a
17165 larger prime than requested.
17166
17167
17168 .option tls_dhparam main string&!! unset
17169 .cindex "TLS" "D-H parameters for server"
17170 The value of this option is expanded and indicates the source of DH parameters
17171 to be used by Exim.
17172
17173 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17174 local DH parameters*&, which has been supported across all versions of Exim.  The
17175 other specific constants available are a fallback so that even when
17176 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17177
17178 If &%tls_dhparam%& is a filename starting with a &`/`&,
17179 then it names a file from which DH
17180 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17181 PKCS#3 representation of the DH prime.  If the file does not exist, for
17182 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17183 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17184 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17185 and treated as though the &%tls_dhparam%& were set to "none".
17186
17187 If this option expands to the string "none", then no DH parameters will be
17188 loaded by Exim.
17189
17190 If this option expands to the string "historic" and Exim is using GnuTLS, then
17191 Exim will attempt to load a file from inside the spool directory.  If the file
17192 does not exist, Exim will attempt to create it.
17193 See section &<<SECTgnutlsparam>>& for further details.
17194
17195 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17196 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17197
17198 In older versions of Exim the default was the 2048 bit prime described in section
17199 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17200 in IKE is assigned number 23.
17201
17202 Otherwise, the option must expand to the name used by Exim for any of a number
17203 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17204 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17205 the number used by IKE, or "default" which corresponds to
17206 &`exim.dev.20160529.3`&.
17207
17208 The available standard primes are:
17209 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17210 &`ike1`&, &`ike2`&, &`ike5`&,
17211 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17212 &`ike22`&, &`ike23`& and &`ike24`&.
17213
17214 The available additional primes are:
17215 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17216
17217 Some of these will be too small to be accepted by clients.
17218 Some may be too large to be accepted by clients.
17219 The open cryptographic community has suspicions about the integrity of some
17220 of the later IKE values, which led into RFC7919 providing new fixed constants
17221 (the "ffdhe" identifiers).
17222
17223 At this point, all of the "ike" values should be considered obsolete;
17224 they're still in Exim to avoid breaking unusual configurations, but are
17225 candidates for removal the next time we have backwards-incompatible changes.
17226
17227 The TLS protocol does not negotiate an acceptable size for this; clients tend
17228 to hard-drop connections if what is offered by the server is unacceptable,
17229 whether too large or too small, and there's no provision for the client to
17230 tell the server what these constraints are.  Thus, as a server operator, you
17231 need to make an educated guess as to what is most likely to work for your
17232 userbase.
17233
17234 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17235 is most likely to maximise interoperability.  The upper bound comes from
17236 applications using the Mozilla Network Security Services (NSS) library, which
17237 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17238 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17239 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17240 acceptable bound from 1024 to 2048.
17241
17242
17243 .option tls_eccurve main string&!! &`auto`&
17244 .cindex TLS "EC cryptography"
17245 This option selects a EC curve for use by Exim when used with OpenSSL.
17246 It has no effect when Exim is used with GnuTLS.
17247
17248 After expansion it must contain a valid EC curve parameter, such as
17249 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17250 for valid selections.
17251
17252 For OpenSSL versions before (and not including) 1.0.2, the string
17253 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17254 &`auto`& tells the library to choose.
17255
17256 If the option expands to an empty string, no EC curves will be enabled.
17257
17258
17259 .option tls_ocsp_file main string&!! unset
17260 .cindex TLS "certificate status"
17261 .cindex TLS "OCSP proof file"
17262 This option
17263 must if set expand to the absolute path to a file which contains a current
17264 status proof for the server's certificate, as obtained from the
17265 Certificate Authority.
17266
17267 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17268
17269 .new
17270 For GnuTLS 3.5.6 or later the expanded value of this option can be a list
17271 of files, to match a list given for the &%tls_certificate%& option.
17272 The ordering of the two lists must match.
17273 .wen
17274
17275
17276 .option tls_on_connect_ports main "string list" unset
17277 .cindex SSMTP
17278 .cindex SMTPS
17279 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17280 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17281 set up without waiting for the client to issue a STARTTLS command. For
17282 further details, see section &<<SECTsupobssmt>>&.
17283
17284
17285
17286 .option tls_privatekey main string list&!! unset
17287 .cindex "TLS" "server private key; location of"
17288 The value of this option is expanded, and must then be a list of absolute paths to
17289 files which contains the server's private keys.
17290 If this option is unset, or if
17291 the expansion is forced to fail, or the result is an empty string, the private
17292 key is assumed to be in the same file as the server's certificates. See chapter
17293 &<<CHAPTLS>>& for further details.
17294
17295 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17296
17297
17298 .option tls_remember_esmtp main boolean false
17299 .cindex "TLS" "esmtp state; remembering"
17300 .cindex "TLS" "broken clients"
17301 If this option is set true, Exim violates the RFCs by remembering that it is in
17302 &"esmtp"& state after successfully negotiating a TLS session. This provides
17303 support for broken clients that fail to send a new EHLO after starting a
17304 TLS session.
17305
17306
17307 .option tls_require_ciphers main string&!! unset
17308 .cindex "TLS" "requiring specific ciphers"
17309 .cindex "cipher" "requiring specific"
17310 This option controls which ciphers can be used for incoming TLS connections.
17311 The &(smtp)& transport has an option of the same name for controlling outgoing
17312 connections. This option is expanded for each connection, so can be varied for
17313 different clients if required. The value of this option must be a list of
17314 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17315 in somewhat different ways. If GnuTLS is being used, the client controls the
17316 preference order of the available ciphers. Details are given in sections
17317 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17318
17319
17320 .option tls_try_verify_hosts main "host list&!!" unset
17321 .cindex "TLS" "client certificate verification"
17322 .cindex "certificate" "verification of client"
17323 See &%tls_verify_hosts%& below.
17324
17325
17326 .option tls_verify_certificates main string&!! system
17327 .cindex "TLS" "client certificate verification"
17328 .cindex "certificate" "verification of client"
17329 The value of this option is expanded, and must then be either the
17330 word "system"
17331 or the absolute path to
17332 a file or directory containing permitted certificates for clients that
17333 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17334
17335 The "system" value for the option will use a
17336 system default location compiled into the SSL library.
17337 This is not available for GnuTLS versions preceding 3.0.20,
17338 and will be taken as empty; an explicit location
17339 must be specified.
17340
17341 The use of a directory for the option value is not available for GnuTLS versions
17342 preceding 3.3.6 and a single file must be used.
17343
17344 With OpenSSL the certificates specified
17345 explicitly
17346 either by file or directory
17347 are added to those given by the system default location.
17348
17349 These certificates should be for the certificate authorities trusted, rather
17350 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17351 the value is a file then the certificates are sent by Exim as a server to
17352 connecting clients, defining the list of accepted certificate authorities.
17353 Thus the values defined should be considered public data.  To avoid this,
17354 use the explicit directory version.
17355
17356 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17357
17358 A forced expansion failure or setting to an empty string is equivalent to
17359 being unset.
17360
17361
17362 .option tls_verify_hosts main "host list&!!" unset
17363 .cindex "TLS" "client certificate verification"
17364 .cindex "certificate" "verification of client"
17365 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17366 certificates from clients. The expected certificates are defined by
17367 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17368 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17369 &%tls_verify_certificates%& is not set.
17370
17371 Any client that matches &%tls_verify_hosts%& is constrained by
17372 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17373 present one of the listed certificates. If it does not, the connection is
17374 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17375 the host to use TLS. It can still send SMTP commands through unencrypted
17376 connections. Forcing a client to use TLS has to be done separately using an
17377 ACL to reject inappropriate commands when the connection is not encrypted.
17378
17379 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17380 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17381 certificate and checks it against &%tls_verify_certificates%&, but does not
17382 abort the connection if there is no certificate or if it does not match. This
17383 state can be detected in an ACL, which makes it possible to implement policies
17384 such as &"accept for relay only if a verified certificate has been received,
17385 but accept for local delivery if encrypted, even without a verified
17386 certificate"&.
17387
17388 Client hosts that match neither of these lists are not asked to present
17389 certificates.
17390
17391
17392 .option trusted_groups main "string list&!!" unset
17393 .cindex "trusted groups"
17394 .cindex "groups" "trusted"
17395 This option is expanded just once, at the start of Exim's processing. If this
17396 option is set, any process that is running in one of the listed groups, or
17397 which has one of them as a supplementary group, is trusted. The groups can be
17398 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17399 details of what trusted callers are permitted to do. If neither
17400 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17401 are trusted.
17402
17403 .option trusted_users main "string list&!!" unset
17404 .cindex "trusted users"
17405 .cindex "user" "trusted"
17406 This option is expanded just once, at the start of Exim's processing. If this
17407 option is set, any process that is running as one of the listed users is
17408 trusted. The users can be specified numerically or by name. See section
17409 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17410 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17411 Exim user are trusted.
17412
17413 .option unknown_login main string&!! unset
17414 .cindex "uid (user id)" "unknown caller"
17415 .vindex "&$caller_uid$&"
17416 This is a specialized feature for use in unusual configurations. By default, if
17417 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17418 gives up. The &%unknown_login%& option can be used to set a login name to be
17419 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17420 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17421 is used for the user's real name (gecos field), unless this has been set by the
17422 &%-F%& option.
17423
17424 .option unknown_username main string unset
17425 See &%unknown_login%&.
17426
17427 .option untrusted_set_sender main "address list&!!" unset
17428 .cindex "trusted users"
17429 .cindex "sender" "setting by untrusted user"
17430 .cindex "untrusted user setting sender"
17431 .cindex "user" "untrusted setting sender"
17432 .cindex "envelope sender"
17433 When an untrusted user submits a message to Exim using the standard input, Exim
17434 normally creates an envelope sender address from the user's login and the
17435 default qualification domain. Data from the &%-f%& option (for setting envelope
17436 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17437 is used) is ignored.
17438
17439 However, untrusted users are permitted to set an empty envelope sender address,
17440 to declare that a message should never generate any bounces. For example:
17441 .code
17442 exim -f '<>' user@domain.example
17443 .endd
17444 .vindex "&$sender_ident$&"
17445 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17446 other envelope sender addresses in a controlled way. When it is set, untrusted
17447 users are allowed to set envelope sender addresses that match any of the
17448 patterns in the list. Like all address lists, the string is expanded. The
17449 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17450 users to setting senders that start with their login ids
17451 followed by a hyphen
17452 by a setting like this:
17453 .code
17454 untrusted_set_sender = ^$sender_ident-
17455 .endd
17456 If you want to allow untrusted users to set envelope sender addresses without
17457 restriction, you can use
17458 .code
17459 untrusted_set_sender = *
17460 .endd
17461 The &%untrusted_set_sender%& option applies to all forms of local input, but
17462 only to the setting of the envelope sender. It does not permit untrusted users
17463 to use the other options which trusted user can use to override message
17464 parameters. Furthermore, it does not stop Exim from removing an existing
17465 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17466 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17467 overriding these actions. The handling of the &'Sender:'& header is also
17468 described in section &<<SECTthesenhea>>&.
17469
17470 The log line for a message's arrival shows the envelope sender following
17471 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17472 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17473 envelope sender address, the user's login is shown in parentheses after the
17474 sender address.
17475
17476
17477 .option uucp_from_pattern main string "see below"
17478 .cindex "&""From""& line"
17479 .cindex "UUCP" "&""From""& line"
17480 Some applications that pass messages to an MTA via a command line interface use
17481 an initial line starting with &"From&~"& to pass the envelope sender. In
17482 particular, this is used by UUCP software. Exim recognizes such a line by means
17483 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17484 matches, the sender address is constructed by expanding the contents of
17485 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17486 default pattern recognizes lines in the following two forms:
17487 .code
17488 From ph10 Fri Jan  5 12:35 GMT 1996
17489 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17490 .endd
17491 The pattern can be seen by running
17492 .code
17493 exim -bP uucp_from_pattern
17494 .endd
17495 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17496 year in the second case. The first word after &"From&~"& is matched in the
17497 regular expression by a parenthesized subpattern. The default value for
17498 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17499 (&"ph10"& in the example above) as the message's sender. See also
17500 &%ignore_fromline_hosts%&.
17501
17502
17503 .option uucp_from_sender main string&!! &`$1`&
17504 See &%uucp_from_pattern%& above.
17505
17506
17507 .option warn_message_file main string unset
17508 .cindex "warning of delay" "customizing the message"
17509 .cindex "customizing" "warning message"
17510 This option defines a template file containing paragraphs of text to be used
17511 for constructing the warning message which is sent by Exim when a message has
17512 been on the queue for a specified amount of time, as specified by
17513 &%delay_warning%&. Details of the file's contents are given in chapter
17514 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17515
17516
17517 .option write_rejectlog main boolean true
17518 .cindex "reject log" "disabling"
17519 If this option is set false, Exim no longer writes anything to the reject log.
17520 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17521 .ecindex IIDconfima
17522 .ecindex IIDmaiconf
17523
17524
17525
17526
17527 . ////////////////////////////////////////////////////////////////////////////
17528 . ////////////////////////////////////////////////////////////////////////////
17529
17530 .chapter "Generic options for routers" "CHAProutergeneric"
17531 .scindex IIDgenoprou1 "options" "generic; for routers"
17532 .scindex IIDgenoprou2 "generic options" "router"
17533 This chapter describes the generic options that apply to all routers.
17534 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17535
17536 For a general description of how a router operates, see sections
17537 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17538 which the preconditions are tested. The order of expansion of the options that
17539 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17540 &%headers_remove%&, &%transport%&.
17541
17542
17543
17544 .option address_data routers string&!! unset
17545 .cindex "router" "data attached to address"
17546 The string is expanded just before the router is run, that is, after all the
17547 precondition tests have succeeded. If the expansion is forced to fail, the
17548 router declines, the value of &%address_data%& remains unchanged, and the
17549 &%more%& option controls what happens next. Other expansion failures cause
17550 delivery of the address to be deferred.
17551
17552 .vindex "&$address_data$&"
17553 When the expansion succeeds, the value is retained with the address, and can be
17554 accessed using the variable &$address_data$& in the current router, subsequent
17555 routers, and the eventual transport.
17556
17557 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17558 that runs a user's filter file, the contents of &$address_data$& are accessible
17559 in the filter. This is not normally a problem, because such data is usually
17560 either not confidential or it &"belongs"& to the current user, but if you do
17561 put confidential data into &$address_data$& you need to remember this point.
17562
17563 Even if the router declines or passes, the value of &$address_data$& remains
17564 with the address, though it can be changed by another &%address_data%& setting
17565 on a subsequent router. If a router generates child addresses, the value of
17566 &$address_data$& propagates to them. This also applies to the special kind of
17567 &"child"& that is generated by a router with the &%unseen%& option.
17568
17569 The idea of &%address_data%& is that you can use it to look up a lot of data
17570 for the address once, and then pick out parts of the data later. For example,
17571 you could use a single LDAP lookup to return a string of the form
17572 .code
17573 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17574 .endd
17575 In the transport you could pick out the mailbox by a setting such as
17576 .code
17577 file = ${extract{mailbox}{$address_data}}
17578 .endd
17579 This makes the configuration file less messy, and also reduces the number of
17580 lookups (though Exim does cache lookups).
17581
17582 .vindex "&$sender_address_data$&"
17583 .vindex "&$address_data$&"
17584 The &%address_data%& facility is also useful as a means of passing information
17585 from one router to another, and from a router to a transport. In addition, if
17586 &$address_data$& is set by a router when verifying a recipient address from an
17587 ACL, it remains available for use in the rest of the ACL statement. After
17588 verifying a sender, the value is transferred to &$sender_address_data$&.
17589
17590
17591
17592 .option address_test routers&!? boolean true
17593 .oindex "&%-bt%&"
17594 .cindex "router" "skipping when address testing"
17595 If this option is set false, the router is skipped when routing is being tested
17596 by means of the &%-bt%& command line option. This can be a convenience when
17597 your first router sends messages to an external scanner, because it saves you
17598 having to set the &"already scanned"& indicator when testing real address
17599 routing.
17600
17601
17602
17603 .option cannot_route_message routers string&!! unset
17604 .cindex "router" "customizing &""cannot route""& message"
17605 .cindex "customizing" "&""cannot route""& message"
17606 This option specifies a text message that is used when an address cannot be
17607 routed because Exim has run out of routers. The default message is
17608 &"Unrouteable address"&. This option is useful only on routers that have
17609 &%more%& set false, or on the very last router in a configuration, because the
17610 value that is used is taken from the last router that is considered. This
17611 includes a router that is skipped because its preconditions are not met, as
17612 well as a router that declines. For example, using the default configuration,
17613 you could put:
17614 .code
17615 cannot_route_message = Remote domain not found in DNS
17616 .endd
17617 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17618 and
17619 .code
17620 cannot_route_message = Unknown local user
17621 .endd
17622 on the final router that checks for local users. If string expansion fails for
17623 this option, the default message is used. Unless the expansion failure was
17624 explicitly forced, a message about the failure is written to the main and panic
17625 logs, in addition to the normal message about the routing failure.
17626
17627
17628 .option caseful_local_part routers boolean false
17629 .cindex "case of local parts"
17630 .cindex "router" "case of local parts"
17631 By default, routers handle the local parts of addresses in a case-insensitive
17632 manner, though the actual case is preserved for transmission with the message.
17633 If you want the case of letters to be significant in a router, you must set
17634 this option true. For individual router options that contain address or local
17635 part lists (for example, &%local_parts%&), case-sensitive matching can be
17636 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17637 more details.
17638
17639 .vindex "&$local_part$&"
17640 .vindex "&$original_local_part$&"
17641 .vindex "&$parent_local_part$&"
17642 The value of the &$local_part$& variable is forced to lower case while a
17643 router is running unless &%caseful_local_part%& is set. When a router assigns
17644 an address to a transport, the value of &$local_part$& when the transport runs
17645 is the same as it was in the router. Similarly, when a router generates child
17646 addresses by aliasing or forwarding, the values of &$original_local_part$&
17647 and &$parent_local_part$& are those that were used by the redirecting router.
17648
17649 This option applies to the processing of an address by a router. When a
17650 recipient address is being processed in an ACL, there is a separate &%control%&
17651 modifier that can be used to specify case-sensitive processing within the ACL
17652 (see section &<<SECTcontrols>>&).
17653
17654
17655
17656 .option check_local_user routers&!? boolean false
17657 .cindex "local user, checking in router"
17658 .cindex "router" "checking for local user"
17659 .cindex "&_/etc/passwd_&"
17660 .vindex "&$home$&"
17661 When this option is true, Exim checks that the local part of the recipient
17662 address (with affixes removed if relevant) is the name of an account on the
17663 local system. The check is done by calling the &[getpwnam()]& function rather
17664 than trying to read &_/etc/passwd_& directly. This means that other methods of
17665 holding password data (such as NIS) are supported. If the local part is a local
17666 user, &$home$& is set from the password data, and can be tested in other
17667 preconditions that are evaluated after this one (the order of evaluation is
17668 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17669 overridden by &%router_home_directory%&. If the local part is not a local user,
17670 the router is skipped.
17671
17672 If you want to check that the local part is either the name of a local user
17673 or matches something else, you cannot combine &%check_local_user%& with a
17674 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17675 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17676 setting to achieve this. For example:
17677 .code
17678 local_parts = passwd;$local_part : lsearch;/etc/other/users
17679 .endd
17680 Note, however, that the side effects of &%check_local_user%& (such as setting
17681 up a home directory) do not occur when a &(passwd)& lookup is used in a
17682 &%local_parts%& (or any other) precondition.
17683
17684
17685
17686 .option condition routers&!? string&!! unset
17687 .cindex "router" "customized precondition"
17688 This option specifies a general precondition test that has to succeed for the
17689 router to be called. The &%condition%& option is the last precondition to be
17690 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17691 result is a forced failure, or an empty string, or one of the strings &"0"& or
17692 &"no"& or &"false"& (checked without regard to the case of the letters), the
17693 router is skipped, and the address is offered to the next one.
17694
17695 If the result is any other value, the router is run (as this is the last
17696 precondition to be evaluated, all the other preconditions must be true).
17697
17698 This option is unusual in that multiple &%condition%& options may be present.
17699 All &%condition%& options must succeed.
17700
17701 The &%condition%& option provides a means of applying custom conditions to the
17702 running of routers. Note that in the case of a simple conditional expansion,
17703 the default expansion values are exactly what is wanted. For example:
17704 .code
17705 condition = ${if >{$message_age}{600}}
17706 .endd
17707 Because of the default behaviour of the string expansion, this is equivalent to
17708 .code
17709 condition = ${if >{$message_age}{600}{true}{}}
17710 .endd
17711
17712 A multiple condition example, which succeeds:
17713 .code
17714 condition = ${if >{$message_age}{600}}
17715 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17716 condition = foobar
17717 .endd
17718
17719 If the expansion fails (other than forced failure) delivery is deferred. Some
17720 of the other precondition options are common special cases that could in fact
17721 be specified using &%condition%&.
17722
17723 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17724 are far older, and use one set of semantics.  ACLs are newer and when
17725 they were created, the ACL &%condition%& process was given far stricter
17726 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17727 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17728 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17729 Router rules processing behavior.
17730
17731 This is best illustrated in an example:
17732 .code
17733 # If used in an ACL condition will fail with a syntax error, but
17734 # in a router condition any extra characters are treated as a string
17735
17736 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17737 true {yes} {no}}
17738
17739 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17740  {yes} {no}}
17741 .endd
17742 In each example above, the &%if%& statement actually ends after
17743 &"{google.com}}"&.  Since no true or false braces were defined, the
17744 default &%if%& behavior is to return a boolean true or a null answer
17745 (which evaluates to false). The rest of the line is then treated as a
17746 string. So the first example resulted in the boolean answer &"true"&
17747 with the string &" {yes} {no}}"& appended to it. The second example
17748 resulted in the null output (indicating false) with the string
17749 &" {yes} {no}}"& appended to it.
17750
17751 In fact you can put excess forward braces in too.  In the router
17752 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17753 mean something, like after a &"$"& or when required as part of a
17754 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17755 string characters.
17756
17757 Thus, in a Router, the above expansion strings will both always evaluate
17758 true, as the result of expansion is a non-empty string which doesn't
17759 match an explicit false value.  This can be tricky to debug.  By
17760 contrast, in an ACL either of those strings will always result in an
17761 expansion error because the result doesn't look sufficiently boolean.
17762
17763
17764 .option debug_print routers string&!! unset
17765 .cindex "testing" "variables in drivers"
17766 If this option is set and debugging is enabled (see the &%-d%& command line
17767 option) or in address-testing mode (see the &%-bt%& command line option),
17768 the string is expanded and included in the debugging output.
17769 If expansion of the string fails, the error message is written to the debugging
17770 output, and Exim carries on processing.
17771 This option is provided to help with checking out the values of variables and
17772 so on when debugging router configurations. For example, if a &%condition%&
17773 option appears not to be working, &%debug_print%& can be used to output the
17774 variables it references. The output happens after checks for &%domains%&,
17775 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17776 are tested. A newline is added to the text if it does not end with one.
17777 The variable &$router_name$& contains the name of the router.
17778
17779
17780
17781 .option disable_logging routers boolean false
17782 If this option is set true, nothing is logged for any routing errors
17783 or for any deliveries caused by this router. You should not set this option
17784 unless you really, really know what you are doing. See also the generic
17785 transport option of the same name.
17786
17787 .option dnssec_request_domains routers "domain list&!!" unset
17788 .cindex "MX record" "security"
17789 .cindex "DNSSEC" "MX lookup"
17790 .cindex "security" "MX lookup"
17791 .cindex "DNS" "DNSSEC"
17792 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17793 the dnssec request bit set.
17794 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17795
17796 .option dnssec_require_domains routers "domain list&!!" unset
17797 .cindex "MX record" "security"
17798 .cindex "DNSSEC" "MX lookup"
17799 .cindex "security" "MX lookup"
17800 .cindex "DNS" "DNSSEC"
17801 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17802 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17803 (AD bit) set will be ignored and logged as a host-lookup failure.
17804 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17805
17806
17807 .option domains routers&!? "domain list&!!" unset
17808 .cindex "router" "restricting to specific domains"
17809 .vindex "&$domain_data$&"
17810 If this option is set, the router is skipped unless the current domain matches
17811 the list. If the match is achieved by means of a file lookup, the data that the
17812 lookup returned for the domain is placed in &$domain_data$& for use in string
17813 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17814 a list of the order in which preconditions are evaluated.
17815
17816
17817
17818 .option driver routers string unset
17819 This option must always be set. It specifies which of the available routers is
17820 to be used.
17821
17822
17823 .option dsn_lasthop routers boolean false
17824 .cindex "DSN" "success"
17825 .cindex "Delivery Status Notification" "success"
17826 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17827 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17828 instead send a success DSN as if the next hop does not support DSN.
17829 Not effective on redirect routers.
17830
17831
17832
17833 .option errors_to routers string&!! unset
17834 .cindex "envelope sender"
17835 .cindex "router" "changing address for errors"
17836 If a router successfully handles an address, it may assign the address to a
17837 transport for delivery or it may generate child addresses. In both cases, if
17838 there is a delivery problem during later processing, the resulting bounce
17839 message is sent to the address that results from expanding this string,
17840 provided that the address verifies successfully. The &%errors_to%& option is
17841 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17842
17843 The &%errors_to%& setting associated with an address can be overridden if it
17844 subsequently passes through other routers that have their own &%errors_to%&
17845 settings, or if the message is delivered by a transport with a &%return_path%&
17846 setting.
17847
17848 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17849 the expansion fails to verify, the errors address associated with the incoming
17850 address is used. At top level, this is the envelope sender. A non-forced
17851 expansion failure causes delivery to be deferred.
17852
17853 If an address for which &%errors_to%& has been set ends up being delivered over
17854 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17855 any bounces that are generated by other MTAs on the delivery route are also
17856 sent there. You can set &%errors_to%& to the empty string by either of these
17857 settings:
17858 .code
17859 errors_to =
17860 errors_to = ""
17861 .endd
17862 An expansion item that yields an empty string has the same effect. If you do
17863 this, a locally detected delivery error for addresses processed by this router
17864 no longer gives rise to a bounce message; the error is discarded. If the
17865 address is delivered to a remote host, the return path is set to &`<>`&, unless
17866 overridden by the &%return_path%& option on the transport.
17867
17868 .vindex "&$address_data$&"
17869 If for some reason you want to discard local errors, but use a non-empty
17870 MAIL command for remote delivery, you can preserve the original return
17871 path in &$address_data$& in the router, and reinstate it in the transport by
17872 setting &%return_path%&.
17873
17874 The most common use of &%errors_to%& is to direct mailing list bounces to the
17875 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17876 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17877
17878
17879
17880 .option expn routers&!? boolean true
17881 .cindex "address" "testing"
17882 .cindex "testing" "addresses"
17883 .cindex "EXPN" "router skipping"
17884 .cindex "router" "skipping for EXPN"
17885 If this option is turned off, the router is skipped when testing an address
17886 as a result of processing an SMTP EXPN command. You might, for example,
17887 want to turn it off on a router for users' &_.forward_& files, while leaving it
17888 on for the system alias file.
17889 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17890 are evaluated.
17891
17892 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17893 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17894 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17895
17896
17897
17898 .option fail_verify routers boolean false
17899 .cindex "router" "forcing verification failure"
17900 Setting this option has the effect of setting both &%fail_verify_sender%& and
17901 &%fail_verify_recipient%& to the same value.
17902
17903
17904
17905 .option fail_verify_recipient routers boolean false
17906 If this option is true and an address is accepted by this router when
17907 verifying a recipient, verification fails.
17908
17909
17910
17911 .option fail_verify_sender routers boolean false
17912 If this option is true and an address is accepted by this router when
17913 verifying a sender, verification fails.
17914
17915
17916
17917 .option fallback_hosts routers "string list" unset
17918 .cindex "router" "fallback hosts"
17919 .cindex "fallback" "hosts specified on router"
17920 String expansion is not applied to this option. The argument must be a
17921 colon-separated list of host names or IP addresses. The list separator can be
17922 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17923 each name or address. In fact, the format of each item is exactly the same as
17924 defined for the list of hosts in a &(manualroute)& router (see section
17925 &<<SECTformatonehostitem>>&).
17926
17927 If a router queues an address for a remote transport, this host list is
17928 associated with the address, and used instead of the transport's fallback host
17929 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17930 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17931 transport for further details.
17932
17933
17934 .option group routers string&!! "see below"
17935 .cindex "gid (group id)" "local delivery"
17936 .cindex "local transports" "uid and gid"
17937 .cindex "transport" "local"
17938 .cindex "router" "setting group"
17939 When a router queues an address for a transport, and the transport does not
17940 specify a group, the group given here is used when running the delivery
17941 process.
17942 The group may be specified numerically or by name. If expansion fails, the
17943 error is logged and delivery is deferred.
17944 The default is unset, unless &%check_local_user%& is set, when the default
17945 is taken from the password information. See also &%initgroups%& and &%user%&
17946 and the discussion in chapter &<<CHAPenvironment>>&.
17947
17948
17949
17950 .option headers_add routers list&!! unset
17951 .cindex "header lines" "adding"
17952 .cindex "router" "adding header lines"
17953 This option specifies a list of text headers,
17954 newline-separated (by default, changeable in the usual way),
17955 that is associated with any addresses that are accepted by the router.
17956 Each item is separately expanded, at routing time.  However, this
17957 option has no effect when an address is just being verified. The way in which
17958 the text is used to add header lines at transport time is described in section
17959 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17960 message is in the process of being transported. This means that references to
17961 header lines in string expansions in the transport's configuration do not
17962 &"see"& the added header lines.
17963
17964 The &%headers_add%& option is expanded after &%errors_to%&, but before
17965 &%headers_remove%& and &%transport%&. If an item is empty, or if
17966 an item expansion is forced to fail, the item has no effect. Other expansion
17967 failures are treated as configuration errors.
17968
17969 Unlike most options, &%headers_add%& can be specified multiple times
17970 for a router; all listed headers are added.
17971
17972 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17973 router that has the &%one_time%& option set.
17974
17975 .cindex "duplicate addresses"
17976 .oindex "&%unseen%&"
17977 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17978 additions are deleted when the address is passed on to subsequent routers.
17979 For a &%redirect%& router, if a generated address is the same as the incoming
17980 address, this can lead to duplicate addresses with different header
17981 modifications. Exim does not do duplicate deliveries (except, in certain
17982 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17983 which of the duplicates is discarded, so this ambiguous situation should be
17984 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17985
17986
17987
17988 .option headers_remove routers list&!! unset
17989 .cindex "header lines" "removing"
17990 .cindex "router" "removing header lines"
17991 This option specifies a list of text headers,
17992 colon-separated (by default, changeable in the usual way),
17993 that is associated with any addresses that are accepted by the router.
17994 Each item is separately expanded, at routing time.  However, this
17995 option has no effect when an address is just being verified. The way in which
17996 the text is used to remove header lines at transport time is described in
17997 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17998 the message is in the process of being transported. This means that references
17999 to header lines in string expansions in the transport's configuration still
18000 &"see"& the original header lines.
18001
18002 The &%headers_remove%& option is expanded after &%errors_to%& and
18003 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18004 the item has no effect. Other expansion failures are treated as configuration
18005 errors.
18006
18007 Unlike most options, &%headers_remove%& can be specified multiple times
18008 for a router; all listed headers are removed.
18009
18010 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18011 router that has the &%one_time%& option set.
18012
18013 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18014 removal requests are deleted when the address is passed on to subsequent
18015 routers, and this can lead to problems with duplicates -- see the similar
18016 warning for &%headers_add%& above.
18017
18018 &*Warning 3*&: Because of the separate expansion of the list items,
18019 items that contain a list separator must have it doubled.
18020 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18021
18022
18023
18024 .option ignore_target_hosts routers "host list&!!" unset
18025 .cindex "IP address" "discarding"
18026 .cindex "router" "discarding IP addresses"
18027 Although this option is a host list, it should normally contain IP address
18028 entries rather than names. If any host that is looked up by the router has an
18029 IP address that matches an item in this list, Exim behaves as if that IP
18030 address did not exist. This option allows you to cope with rogue DNS entries
18031 like
18032 .code
18033 remote.domain.example.  A  127.0.0.1
18034 .endd
18035 by setting
18036 .code
18037 ignore_target_hosts = 127.0.0.1
18038 .endd
18039 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18040 discarded in this way, the router declines. In a conventional configuration, an
18041 attempt to mail to such a domain would normally provoke the &"unrouteable
18042 domain"& error, and an attempt to verify an address in the domain would fail.
18043 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18044 router declines if presented with one of the listed addresses.
18045
18046 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18047 means of the first or the second of the following settings, respectively:
18048 .code
18049 ignore_target_hosts = 0.0.0.0/0
18050 ignore_target_hosts = <; 0::0/0
18051 .endd
18052 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18053 in the second line matches all IPv6 addresses.
18054
18055 This option may also be useful for ignoring link-local and site-local IPv6
18056 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18057 is expanded before use as a list, it is possible to make it dependent on the
18058 domain that is being routed.
18059
18060 .vindex "&$host_address$&"
18061 During its expansion, &$host_address$& is set to the IP address that is being
18062 checked.
18063
18064 .option initgroups routers boolean false
18065 .cindex "additional groups"
18066 .cindex "groups" "additional"
18067 .cindex "local transports" "uid and gid"
18068 .cindex "transport" "local"
18069 If the router queues an address for a transport, and this option is true, and
18070 the uid supplied by the router is not overridden by the transport, the
18071 &[initgroups()]& function is called when running the transport to ensure that
18072 any additional groups associated with the uid are set up. See also &%group%&
18073 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18074
18075
18076
18077 .option local_part_prefix routers&!? "string list" unset
18078 .cindex "router" "prefix for local part"
18079 .cindex "prefix" "for local part, used in router"
18080 If this option is set, the router is skipped unless the local part starts with
18081 one of the given strings, or &%local_part_prefix_optional%& is true. See
18082 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18083 evaluated.
18084
18085 The list is scanned from left to right, and the first prefix that matches is
18086 used. A limited form of wildcard is available; if the prefix begins with an
18087 asterisk, it matches the longest possible sequence of arbitrary characters at
18088 the start of the local part. An asterisk should therefore always be followed by
18089 some character that does not occur in normal local parts.
18090 .cindex "multiple mailboxes"
18091 .cindex "mailbox" "multiple"
18092 Wildcarding can be used to set up multiple user mailboxes, as described in
18093 section &<<SECTmulbox>>&.
18094
18095 .vindex "&$local_part$&"
18096 .vindex "&$local_part_prefix$&"
18097 During the testing of the &%local_parts%& option, and while the router is
18098 running, the prefix is removed from the local part, and is available in the
18099 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18100 the router accepts the address, this remains true during subsequent delivery by
18101 a transport. In particular, the local part that is transmitted in the RCPT
18102 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18103 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18104 the relevant transport.
18105
18106 When an address is being verified, &%local_part_prefix%& affects only the
18107 behaviour of the router. If the callout feature of verification is in use, this
18108 means that the full address, including the prefix, will be used during the
18109 callout.
18110
18111 The prefix facility is commonly used to handle local parts of the form
18112 &%owner-something%&. Another common use is to support local parts of the form
18113 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18114 to tell a user their forwarding is broken &-- by placing a router like this one
18115 immediately before the router that handles &_.forward_& files:
18116 .code
18117 real_localuser:
18118   driver = accept
18119   local_part_prefix = real-
18120   check_local_user
18121   transport = local_delivery
18122 .endd
18123 For security, it would probably be a good idea to restrict the use of this
18124 router to locally-generated messages, using a condition such as this:
18125 .code
18126   condition = ${if match {$sender_host_address}\
18127                          {\N^(|127\.0\.0\.1)$\N}}
18128 .endd
18129
18130 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18131 both conditions must be met if not optional. Care must be taken if wildcards
18132 are used in both a prefix and a suffix on the same router. Different
18133 separator characters must be used to avoid ambiguity.
18134
18135
18136 .option local_part_prefix_optional routers boolean false
18137 See &%local_part_prefix%& above.
18138
18139
18140
18141 .option local_part_suffix routers&!? "string list" unset
18142 .cindex "router" "suffix for local part"
18143 .cindex "suffix for local part" "used in router"
18144 This option operates in the same way as &%local_part_prefix%&, except that the
18145 local part must end (rather than start) with the given string, the
18146 &%local_part_suffix_optional%& option determines whether the suffix is
18147 mandatory, and the wildcard * character, if present, must be the last
18148 character of the suffix. This option facility is commonly used to handle local
18149 parts of the form &%something-request%& and multiple user mailboxes of the form
18150 &%username-foo%&.
18151
18152
18153 .option local_part_suffix_optional routers boolean false
18154 See &%local_part_suffix%& above.
18155
18156
18157
18158 .option local_parts routers&!? "local part list&!!" unset
18159 .cindex "router" "restricting to specific local parts"
18160 .cindex "local part" "checking in router"
18161 The router is run only if the local part of the address matches the list.
18162 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18163 are evaluated, and
18164 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18165 string is expanded, it is possible to make it depend on the domain, for
18166 example:
18167 .code
18168 local_parts = dbm;/usr/local/specials/$domain
18169 .endd
18170 .vindex "&$local_part_data$&"
18171 If the match is achieved by a lookup, the data that the lookup returned
18172 for the local part is placed in the variable &$local_part_data$& for use in
18173 expansions of the router's private options. You might use this option, for
18174 example, if you have a large number of local virtual domains, and you want to
18175 send all postmaster mail to the same place without having to set up an alias in
18176 each virtual domain:
18177 .code
18178 postmaster:
18179   driver = redirect
18180   local_parts = postmaster
18181   data = postmaster@real.domain.example
18182 .endd
18183
18184
18185 .option log_as_local routers boolean "see below"
18186 .cindex "log" "delivery line"
18187 .cindex "delivery" "log line format"
18188 Exim has two logging styles for delivery, the idea being to make local
18189 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18190 recipient address is given just as the local part, without a domain. The use of
18191 this style is controlled by this option. It defaults to true for the &(accept)&
18192 router, and false for all the others. This option applies only when a
18193 router assigns an address to a transport. It has no effect on routers that
18194 redirect addresses.
18195
18196
18197
18198 .option more routers boolean&!! true
18199 The result of string expansion for this option must be a valid boolean value,
18200 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18201 result causes an error, and delivery is deferred. If the expansion is forced to
18202 fail, the default value for the option (true) is used. Other failures cause
18203 delivery to be deferred.
18204
18205 If this option is set false, and the router declines to handle the address, no
18206 further routers are tried, routing fails, and the address is bounced.
18207 .oindex "&%self%&"
18208 However, if the router explicitly passes an address to the following router by
18209 means of the setting
18210 .code
18211 self = pass
18212 .endd
18213 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18214 does not affect the behaviour if one of the precondition tests fails. In that
18215 case, the address is always passed to the next router.
18216
18217 Note that &%address_data%& is not considered to be a precondition. If its
18218 expansion is forced to fail, the router declines, and the value of &%more%&
18219 controls what happens next.
18220
18221
18222 .option pass_on_timeout routers boolean false
18223 .cindex "timeout" "of router"
18224 .cindex "router" "timeout"
18225 If a router times out during a host lookup, it normally causes deferral of the
18226 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18227 router, overriding &%no_more%&. This may be helpful for systems that are
18228 intermittently connected to the Internet, or those that want to pass to a smart
18229 host any messages that cannot immediately be delivered.
18230
18231 There are occasional other temporary errors that can occur while doing DNS
18232 lookups. They are treated in the same way as a timeout, and this option
18233 applies to all of them.
18234
18235
18236
18237 .option pass_router routers string unset
18238 .cindex "router" "go to after &""pass""&"
18239 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18240 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18241 routing to continue, and overriding a false setting of &%more%&. When one of
18242 these routers returns &"pass"&, the address is normally handed on to the next
18243 router in sequence. This can be changed by setting &%pass_router%& to the name
18244 of another router. However (unlike &%redirect_router%&) the named router must
18245 be below the current router, to avoid loops. Note that this option applies only
18246 to the special case of &"pass"&. It does not apply when a router returns
18247 &"decline"& because it cannot handle an address.
18248
18249
18250
18251 .option redirect_router routers string unset
18252 .cindex "router" "start at after redirection"
18253 Sometimes an administrator knows that it is pointless to reprocess addresses
18254 generated from alias or forward files with the same router again. For
18255 example, if an alias file translates real names into login ids there is no
18256 point searching the alias file a second time, especially if it is a large file.
18257
18258 The &%redirect_router%& option can be set to the name of any router instance.
18259 It causes the routing of any generated addresses to start at the named router
18260 instead of at the first router. This option has no effect if the router in
18261 which it is set does not generate new addresses.
18262
18263
18264
18265 .option require_files routers&!? "string list&!!" unset
18266 .cindex "file" "requiring for router"
18267 .cindex "router" "requiring file existence"
18268 This option provides a general mechanism for predicating the running of a
18269 router on the existence or non-existence of certain files or directories.
18270 Before running a router, as one of its precondition tests, Exim works its way
18271 through the &%require_files%& list, expanding each item separately.
18272
18273 Because the list is split before expansion, any colons in expansion items must
18274 be doubled, or the facility for using a different list separator must be used.
18275 If any expansion is forced to fail, the item is ignored. Other expansion
18276 failures cause routing of the address to be deferred.
18277
18278 If any expanded string is empty, it is ignored. Otherwise, except as described
18279 below, each string must be a fully qualified file path, optionally preceded by
18280 &"!"&. The paths are passed to the &[stat()]& function to test for the
18281 existence of the files or directories. The router is skipped if any paths not
18282 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18283
18284 .cindex "NFS"
18285 If &[stat()]& cannot determine whether a file exists or not, delivery of
18286 the message is deferred. This can happen when NFS-mounted filesystems are
18287 unavailable.
18288
18289 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18290 options, so you cannot use it to check for the existence of a file in which to
18291 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18292 full list of the order in which preconditions are evaluated.) However, as
18293 these options are all expanded, you can use the &%exists%& expansion condition
18294 to make such tests. The &%require_files%& option is intended for checking files
18295 that the router may be going to use internally, or which are needed by a
18296 transport (for example &_.procmailrc_&).
18297
18298 During delivery, the &[stat()]& function is run as root, but there is a
18299 facility for some checking of the accessibility of a file by another user.
18300 This is not a proper permissions check, but just a &"rough"& check that
18301 operates as follows:
18302
18303 If an item in a &%require_files%& list does not contain any forward slash
18304 characters, it is taken to be the user (and optional group, separated by a
18305 comma) to be checked for subsequent files in the list. If no group is specified
18306 but the user is specified symbolically, the gid associated with the uid is
18307 used. For example:
18308 .code
18309 require_files = mail:/some/file
18310 require_files = $local_part:$home/.procmailrc
18311 .endd
18312 If a user or group name in a &%require_files%& list does not exist, the
18313 &%require_files%& condition fails.
18314
18315 Exim performs the check by scanning along the components of the file path, and
18316 checking the access for the given uid and gid. It checks for &"x"& access on
18317 directories, and &"r"& access on the final file. Note that this means that file
18318 access control lists, if the operating system has them, are ignored.
18319
18320 &*Warning 1*&: When the router is being run to verify addresses for an
18321 incoming SMTP message, Exim is not running as root, but under its own uid. This
18322 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18323 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18324 user is not permitted to read one of the directories on the file's path.
18325
18326 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18327 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18328 without root access. In this case, if a check for access by a particular user
18329 is requested, Exim creates a subprocess that runs as that user, and tries the
18330 check again in that process.
18331
18332 The default action for handling an unresolved EACCES is to consider it to
18333 be caused by a configuration error, and routing is deferred because the
18334 existence or non-existence of the file cannot be determined. However, in some
18335 circumstances it may be desirable to treat this condition as if the file did
18336 not exist. If the file name (or the exclamation mark that precedes the file
18337 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18338 as if the file did not exist. For example:
18339 .code
18340 require_files = +/some/file
18341 .endd
18342 If the router is not an essential part of verification (for example, it
18343 handles users' &_.forward_& files), another solution is to set the &%verify%&
18344 option false so that the router is skipped when verifying.
18345
18346
18347
18348 .option retry_use_local_part routers boolean "see below"
18349 .cindex "hints database" "retry keys"
18350 .cindex "local part" "in retry keys"
18351 When a delivery suffers a temporary routing failure, a retry record is created
18352 in Exim's hints database. For addresses whose routing depends only on the
18353 domain, the key for the retry record should not involve the local part, but for
18354 other addresses, both the domain and the local part should be included.
18355 Usually, remote routing is of the former kind, and local routing is of the
18356 latter kind.
18357
18358 This option controls whether the local part is used to form the key for retry
18359 hints for addresses that suffer temporary errors while being handled by this
18360 router. The default value is true for any router that has &%check_local_user%&
18361 set, and false otherwise. Note that this option does not apply to hints keys
18362 for transport delays; they are controlled by a generic transport option of the
18363 same name.
18364
18365 The setting of &%retry_use_local_part%& applies only to the router on which it
18366 appears. If the router generates child addresses, they are routed
18367 independently; this setting does not become attached to them.
18368
18369
18370
18371 .option router_home_directory routers string&!! unset
18372 .cindex "router" "home directory for"
18373 .cindex "home directory" "for router"
18374 .vindex "&$home$&"
18375 This option sets a home directory for use while the router is running. (Compare
18376 &%transport_home_directory%&, which sets a home directory for later
18377 transporting.) In particular, if used on a &(redirect)& router, this option
18378 sets a value for &$home$& while a filter is running. The value is expanded;
18379 forced expansion failure causes the option to be ignored &-- other failures
18380 cause the router to defer.
18381
18382 Expansion of &%router_home_directory%& happens immediately after the
18383 &%check_local_user%& test (if configured), before any further expansions take
18384 place.
18385 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18386 are evaluated.)
18387 While the router is running, &%router_home_directory%& overrides the value of
18388 &$home$& that came from &%check_local_user%&.
18389
18390 When a router accepts an address and assigns it to a local transport (including
18391 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18392 delivery), the home directory setting for the transport is taken from the first
18393 of these values that is set:
18394
18395 .ilist
18396 The &%home_directory%& option on the transport;
18397 .next
18398 The &%transport_home_directory%& option on the router;
18399 .next
18400 The password data if &%check_local_user%& is set on the router;
18401 .next
18402 The &%router_home_directory%& option on the router.
18403 .endlist
18404
18405 In other words, &%router_home_directory%& overrides the password data for the
18406 router, but not for the transport.
18407
18408
18409
18410 .option self routers string freeze
18411 .cindex "MX record" "pointing to local host"
18412 .cindex "local host" "MX pointing to"
18413 This option applies to those routers that use a recipient address to find a
18414 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18415 and &(manualroute)& routers.
18416 Certain configurations of the &(queryprogram)& router can also specify a list
18417 of remote hosts.
18418 Usually such routers are configured to send the message to a remote host via an
18419 &(smtp)& transport. The &%self%& option specifies what happens when the first
18420 host on the list turns out to be the local host.
18421 The way in which Exim checks for the local host is described in section
18422 &<<SECTreclocipadd>>&.
18423
18424 Normally this situation indicates either an error in Exim's configuration (for
18425 example, the router should be configured not to process this domain), or an
18426 error in the DNS (for example, the MX should not point to this host). For this
18427 reason, the default action is to log the incident, defer the address, and
18428 freeze the message. The following alternatives are provided for use in special
18429 cases:
18430
18431 .vlist
18432 .vitem &%defer%&
18433 Delivery of the message is tried again later, but the message is not frozen.
18434
18435 .vitem "&%reroute%&: <&'domain'&>"
18436 The domain is changed to the given domain, and the address is passed back to
18437 be reprocessed by the routers. No rewriting of headers takes place. This
18438 behaviour is essentially a redirection.
18439
18440 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18441 The domain is changed to the given domain, and the address is passed back to be
18442 reprocessed by the routers. Any headers that contain the original domain are
18443 rewritten.
18444
18445 .vitem &%pass%&
18446 .oindex "&%more%&"
18447 .vindex "&$self_hostname$&"
18448 The router passes the address to the next router, or to the router named in the
18449 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18450 subsequent routing and delivery, the variable &$self_hostname$& contains the
18451 name of the local host that the router encountered. This can be used to
18452 distinguish between different cases for hosts with multiple names. The
18453 combination
18454 .code
18455 self = pass
18456 no_more
18457 .endd
18458 ensures that only those addresses that routed to the local host are passed on.
18459 Without &%no_more%&, addresses that were declined for other reasons would also
18460 be passed to the next router.
18461
18462 .vitem &%fail%&
18463 Delivery fails and an error report is generated.
18464
18465 .vitem &%send%&
18466 .cindex "local host" "sending to"
18467 The anomaly is ignored and the address is queued for the transport. This
18468 setting should be used with extreme caution. For an &(smtp)& transport, it
18469 makes sense only in cases where the program that is listening on the SMTP port
18470 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18471 different configuration file that handles the domain in another way.
18472 .endlist
18473
18474
18475
18476 .option senders routers&!? "address list&!!" unset
18477 .cindex "router" "checking senders"
18478 If this option is set, the router is skipped unless the message's sender
18479 address matches something on the list.
18480 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18481 are evaluated.
18482
18483 There are issues concerning verification when the running of routers is
18484 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18485 setting, it sets the sender to the null string. When using the &%-bt%& option
18486 to check a configuration file, it is necessary also to use the &%-f%& option to
18487 set an appropriate sender. For incoming mail, the sender is unset when
18488 verifying the sender, but is available when verifying any recipients. If the
18489 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18490 matters.
18491
18492
18493 .option translate_ip_address routers string&!! unset
18494 .cindex "IP address" "translating"
18495 .cindex "packet radio"
18496 .cindex "router" "IP address translation"
18497 There exist some rare networking situations (for example, packet radio) where
18498 it is helpful to be able to translate IP addresses generated by normal routing
18499 mechanisms into other IP addresses, thus performing a kind of manual IP
18500 routing. This should be done only if the normal IP routing of the TCP/IP stack
18501 is inadequate or broken. Because this is an extremely uncommon requirement, the
18502 code to support this option is not included in the Exim binary unless
18503 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18504
18505 .vindex "&$host_address$&"
18506 The &%translate_ip_address%& string is expanded for every IP address generated
18507 by the router, with the generated address set in &$host_address$&. If the
18508 expansion is forced to fail, no action is taken.
18509 For any other expansion error, delivery of the message is deferred.
18510 If the result of the expansion is an IP address, that replaces the original
18511 address; otherwise the result is assumed to be a host name &-- this is looked
18512 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18513 produce one or more replacement IP addresses. For example, to subvert all IP
18514 addresses in some specific networks, this could be added to a router:
18515 .code
18516 translate_ip_address = \
18517   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18518     {$value}fail}}
18519 .endd
18520 The file would contain lines like
18521 .code
18522 10.2.3.128/26    some.host
18523 10.8.4.34/26     10.44.8.15
18524 .endd
18525 You should not make use of this facility unless you really understand what you
18526 are doing.
18527
18528
18529
18530 .option transport routers string&!! unset
18531 This option specifies the transport to be used when a router accepts an address
18532 and sets it up for delivery. A transport is never needed if a router is used
18533 only for verification. The value of the option is expanded at routing time,
18534 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18535 and result must be the name of one of the configured transports. If it is not,
18536 delivery is deferred.
18537
18538 The &%transport%& option is not used by the &(redirect)& router, but it does
18539 have some private options that set up transports for pipe and file deliveries
18540 (see chapter &<<CHAPredirect>>&).
18541
18542
18543
18544 .option transport_current_directory routers string&!! unset
18545 .cindex "current directory for local transport"
18546 This option associates a current directory with any address that is routed
18547 to a local transport. This can happen either because a transport is
18548 explicitly configured for the router, or because it generates a delivery to a
18549 file or a pipe. During the delivery process (that is, at transport time), this
18550 option string is expanded and is set as the current directory, unless
18551 overridden by a setting on the transport.
18552 If the expansion fails for any reason, including forced failure, an error is
18553 logged, and delivery is deferred.
18554 See chapter &<<CHAPenvironment>>& for details of the local delivery
18555 environment.
18556
18557
18558
18559
18560 .option transport_home_directory routers string&!! "see below"
18561 .cindex "home directory" "for local transport"
18562 This option associates a home directory with any address that is routed to a
18563 local transport. This can happen either because a transport is explicitly
18564 configured for the router, or because it generates a delivery to a file or a
18565 pipe. During the delivery process (that is, at transport time), the option
18566 string is expanded and is set as the home directory, unless overridden by a
18567 setting of &%home_directory%& on the transport.
18568 If the expansion fails for any reason, including forced failure, an error is
18569 logged, and delivery is deferred.
18570
18571 If the transport does not specify a home directory, and
18572 &%transport_home_directory%& is not set for the router, the home directory for
18573 the transport is taken from the password data if &%check_local_user%& is set for
18574 the router. Otherwise it is taken from &%router_home_directory%& if that option
18575 is set; if not, no home directory is set for the transport.
18576
18577 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18578 environment.
18579
18580
18581
18582
18583 .option unseen routers boolean&!! false
18584 .cindex "router" "carrying on after success"
18585 The result of string expansion for this option must be a valid boolean value,
18586 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18587 result causes an error, and delivery is deferred. If the expansion is forced to
18588 fail, the default value for the option (false) is used. Other failures cause
18589 delivery to be deferred.
18590
18591 When this option is set true, routing does not cease if the router accepts the
18592 address. Instead, a copy of the incoming address is passed to the next router,
18593 overriding a false setting of &%more%&. There is little point in setting
18594 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18595 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18596 sometimes true and sometimes false).
18597
18598 .cindex "copy of message (&%unseen%& option)"
18599 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18600 qualifier in filter files. It can be used to cause copies of messages to be
18601 delivered to some other destination, while also carrying out a normal delivery.
18602 In effect, the current address is made into a &"parent"& that has two children
18603 &-- one that is delivered as specified by this router, and a clone that goes on
18604 to be routed further. For this reason, &%unseen%& may not be combined with the
18605 &%one_time%& option in a &(redirect)& router.
18606
18607 &*Warning*&: Header lines added to the address (or specified for removal) by
18608 this router or by previous routers affect the &"unseen"& copy of the message
18609 only. The clone that continues to be processed by further routers starts with
18610 no added headers and none specified for removal. For a &%redirect%& router, if
18611 a generated address is the same as the incoming address, this can lead to
18612 duplicate addresses with different header modifications. Exim does not do
18613 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18614 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18615 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18616 &%redirect%& router may be of help.
18617
18618 Unlike the handling of header modifications, any data that was set by the
18619 &%address_data%& option in the current or previous routers &'is'& passed on to
18620 subsequent routers.
18621
18622
18623 .option user routers string&!! "see below"
18624 .cindex "uid (user id)" "local delivery"
18625 .cindex "local transports" "uid and gid"
18626 .cindex "transport" "local"
18627 .cindex "router" "user for filter processing"
18628 .cindex "filter" "user for processing"
18629 When a router queues an address for a transport, and the transport does not
18630 specify a user, the user given here is used when running the delivery process.
18631 The user may be specified numerically or by name. If expansion fails, the
18632 error is logged and delivery is deferred.
18633 This user is also used by the &(redirect)& router when running a filter file.
18634 The default is unset, except when &%check_local_user%& is set. In this case,
18635 the default is taken from the password information. If the user is specified as
18636 a name, and &%group%& is not set, the group associated with the user is used.
18637 See also &%initgroups%& and &%group%& and the discussion in chapter
18638 &<<CHAPenvironment>>&.
18639
18640
18641
18642 .option verify routers&!? boolean true
18643 Setting this option has the effect of setting &%verify_sender%& and
18644 &%verify_recipient%& to the same value.
18645
18646
18647 .option verify_only routers&!? boolean false
18648 .cindex "EXPN" "with &%verify_only%&"
18649 .oindex "&%-bv%&"
18650 .cindex "router" "used only when verifying"
18651 If this option is set, the router is used only when verifying an address,
18652 delivering in cutthrough mode or
18653 testing with the &%-bv%& option, not when actually doing a delivery, testing
18654 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18655 restricted to verifying only senders or recipients by means of
18656 &%verify_sender%& and &%verify_recipient%&.
18657
18658 &*Warning*&: When the router is being run to verify addresses for an incoming
18659 SMTP message, Exim is not running as root, but under its own uid. If the router
18660 accesses any files, you need to make sure that they are accessible to the Exim
18661 user or group.
18662
18663
18664 .option verify_recipient routers&!? boolean true
18665 If this option is false, the router is skipped when verifying recipient
18666 addresses,
18667 delivering in cutthrough mode
18668 or testing recipient verification using &%-bv%&.
18669 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18670 are evaluated.
18671 See also the &$verify_mode$& variable.
18672
18673
18674 .option verify_sender routers&!? boolean true
18675 If this option is false, the router is skipped when verifying sender addresses
18676 or testing sender verification using &%-bvs%&.
18677 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18678 are evaluated.
18679 See also the &$verify_mode$& variable.
18680 .ecindex IIDgenoprou1
18681 .ecindex IIDgenoprou2
18682
18683
18684
18685
18686
18687
18688 . ////////////////////////////////////////////////////////////////////////////
18689 . ////////////////////////////////////////////////////////////////////////////
18690
18691 .chapter "The accept router" "CHID4"
18692 .cindex "&(accept)& router"
18693 .cindex "routers" "&(accept)&"
18694 The &(accept)& router has no private options of its own. Unless it is being
18695 used purely for verification (see &%verify_only%&) a transport is required to
18696 be defined by the generic &%transport%& option. If the preconditions that are
18697 specified by generic options are met, the router accepts the address and queues
18698 it for the given transport. The most common use of this router is for setting
18699 up deliveries to local mailboxes. For example:
18700 .code
18701 localusers:
18702   driver = accept
18703   domains = mydomain.example
18704   check_local_user
18705   transport = local_delivery
18706 .endd
18707 The &%domains%& condition in this example checks the domain of the address, and
18708 &%check_local_user%& checks that the local part is the login of a local user.
18709 When both preconditions are met, the &(accept)& router runs, and queues the
18710 address for the &(local_delivery)& transport.
18711
18712
18713
18714
18715
18716
18717 . ////////////////////////////////////////////////////////////////////////////
18718 . ////////////////////////////////////////////////////////////////////////////
18719
18720 .chapter "The dnslookup router" "CHAPdnslookup"
18721 .scindex IIDdnsrou1 "&(dnslookup)& router"
18722 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18723 The &(dnslookup)& router looks up the hosts that handle mail for the
18724 recipient's domain in the DNS. A transport must always be set for this router,
18725 unless &%verify_only%& is set.
18726
18727 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18728 SRV records. If none are found, or if SRV support is not configured,
18729 MX records are looked up. If no MX records exist, address records are sought.
18730 However, &%mx_domains%& can be set to disable the direct use of address
18731 records.
18732
18733 MX records of equal priority are sorted by Exim into a random order. Exim then
18734 looks for address records for the host names obtained from MX or SRV records.
18735 When a host has more than one IP address, they are sorted into a random order,
18736 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18737 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18738 generic option, the router declines.
18739
18740 Unless they have the highest priority (lowest MX value), MX records that point
18741 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18742 are discarded, together with any other MX records of equal or lower priority.
18743
18744 .cindex "MX record" "pointing to local host"
18745 .cindex "local host" "MX pointing to"
18746 .oindex "&%self%&" "in &(dnslookup)& router"
18747 If the host pointed to by the highest priority MX record, or looked up as an
18748 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18749 happens is controlled by the generic &%self%& option.
18750
18751
18752 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18753 There have been problems with DNS servers when SRV records are looked up.
18754 Some misbehaving servers return a DNS error or timeout when a non-existent
18755 SRV record is sought. Similar problems have in the past been reported for
18756 MX records. The global &%dns_again_means_nonexist%& option can help with this
18757 problem, but it is heavy-handed because it is a global option.
18758
18759 For this reason, there are two options, &%srv_fail_domains%& and
18760 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18761 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18762 an attempt to look up an SRV or MX record causes one of these results, and the
18763 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18764 such record"&. In the case of an SRV lookup, this means that the router
18765 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18766 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18767 case routing fails.
18768
18769
18770 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18771 .cindex "&(dnslookup)& router" "declines"
18772 There are a few cases where a &(dnslookup)& router will decline to accept
18773 an address; if such a router is expected to handle "all remaining non-local
18774 domains", then it is important to set &%no_more%&.
18775
18776 The router will defer rather than decline if the domain
18777 is found in the &%fail_defer_domains%& router option.
18778
18779 Reasons for a &(dnslookup)& router to decline currently include:
18780 .ilist
18781 The domain does not exist in DNS
18782 .next
18783 The domain exists but the MX record's host part is just "."; this is a common
18784 convention (borrowed from SRV) used to indicate that there is no such service
18785 for this domain and to not fall back to trying A/AAAA records.
18786 .next
18787 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18788 .next
18789 MX record points to a non-existent host.
18790 .next
18791 MX record points to an IP address and the main section option
18792 &%allow_mx_to_ip%& is not set.
18793 .next
18794 MX records exist and point to valid hosts, but all hosts resolve only to
18795 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18796 .next
18797 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18798 &%dns_check_names_pattern%& for handling one variant of this)
18799 .next
18800 &%check_secondary_mx%& is set on this router but the local host can
18801 not be found in the MX records (see below)
18802 .endlist
18803
18804
18805
18806
18807 .section "Private options for dnslookup" "SECID118"
18808 .cindex "options" "&(dnslookup)& router"
18809 The private options for the &(dnslookup)& router are as follows:
18810
18811 .option check_secondary_mx dnslookup boolean false
18812 .cindex "MX record" "checking for secondary"
18813 If this option is set, the router declines unless the local host is found in
18814 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18815 process domains for which the local host is a secondary mail exchanger
18816 differently to other domains. The way in which Exim decides whether a host is
18817 the local host is described in section &<<SECTreclocipadd>>&.
18818
18819
18820 .option check_srv dnslookup string&!! unset
18821 .cindex "SRV record" "enabling use of"
18822 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18823 addition to MX and address records. The support is disabled by default. To
18824 enable SRV support, set the &%check_srv%& option to the name of the service
18825 required. For example,
18826 .code
18827 check_srv = smtp
18828 .endd
18829 looks for SRV records that refer to the normal smtp service. The option is
18830 expanded, so the service name can vary from message to message or address
18831 to address. This might be helpful if SRV records are being used for a
18832 submission service. If the expansion is forced to fail, the &%check_srv%&
18833 option is ignored, and the router proceeds to look for MX records in the
18834 normal way.
18835
18836 When the expansion succeeds, the router searches first for SRV records for
18837 the given service (it assumes TCP protocol). A single SRV record with a
18838 host name that consists of just a single dot indicates &"no such service for
18839 this domain"&; if this is encountered, the router declines. If other kinds of
18840 SRV record are found, they are used to construct a host list for delivery
18841 according to the rules of RFC 2782. MX records are not sought in this case.
18842
18843 When no SRV records are found, MX records (and address records) are sought in
18844 the traditional way. In other words, SRV records take precedence over MX
18845 records, just as MX records take precedence over address records. Note that
18846 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18847 defined it. It is apparently believed that MX records are sufficient for email
18848 and that SRV records should not be used for this purpose. However, SRV records
18849 have an additional &"weight"& feature which some people might find useful when
18850 trying to split an SMTP load between hosts of different power.
18851
18852 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18853 when there is a DNS lookup error.
18854
18855
18856
18857
18858 .option fail_defer_domains dnslookup "domain list&!!" unset
18859 .cindex "MX record" "not found"
18860 DNS lookups for domains matching &%fail_defer_domains%&
18861 which find no matching record will cause the router to defer
18862 rather than the default behaviour of decline.
18863 This maybe be useful for queueing messages for a newly created
18864 domain while the DNS configuration is not ready.
18865 However, it will result in any message with mistyped domains
18866 also being queued.
18867
18868
18869 .option mx_domains dnslookup "domain list&!!" unset
18870 .cindex "MX record" "required to exist"
18871 .cindex "SRV record" "required to exist"
18872 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18873 record in order to be recognized. (The name of this option could be improved.)
18874 For example, if all the mail hosts in &'fict.example'& are known to have MX
18875 records, except for those in &'discworld.fict.example'&, you could use this
18876 setting:
18877 .code
18878 mx_domains = ! *.discworld.fict.example : *.fict.example
18879 .endd
18880 This specifies that messages addressed to a domain that matches the list but
18881 has no MX record should be bounced immediately instead of being routed using
18882 the address record.
18883
18884
18885 .option mx_fail_domains dnslookup "domain list&!!" unset
18886 If the DNS lookup for MX records for one of the domains in this list causes a
18887 DNS lookup error, Exim behaves as if no MX records were found. See section
18888 &<<SECTprowitdnsloo>>& for more discussion.
18889
18890
18891
18892
18893 .option qualify_single dnslookup boolean true
18894 .cindex "DNS" "resolver options"
18895 .cindex "DNS" "qualifying single-component names"
18896 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18897 lookups. Typically, but not standardly, this causes the resolver to qualify
18898 single-component names with the default domain. For example, on a machine
18899 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18900 &'thesaurus.ref.example'& inside the resolver. For details of what your
18901 resolver actually does, consult your man pages for &'resolver'& and
18902 &'resolv.conf'&.
18903
18904
18905
18906 .option rewrite_headers dnslookup boolean true
18907 .cindex "rewriting" "header lines"
18908 .cindex "header lines" "rewriting"
18909 If the domain name in the address that is being processed is not fully
18910 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18911 an address is specified as &'dormouse@teaparty'&, the domain might be
18912 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18913 occur as a result of setting the &%widen_domains%& option. If
18914 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18915 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18916 header lines of the message are rewritten with the full domain name.
18917
18918 This option should be turned off only when it is known that no message is
18919 ever going to be sent outside an environment where the abbreviation makes
18920 sense.
18921
18922 When an MX record is looked up in the DNS and matches a wildcard record, name
18923 servers normally return a record containing the name that has been looked up,
18924 making it impossible to detect whether a wildcard was present or not. However,
18925 some name servers have recently been seen to return the wildcard entry. If the
18926 name returned by a DNS lookup begins with an asterisk, it is not used for
18927 header rewriting.
18928
18929
18930 .option same_domain_copy_routing dnslookup boolean false
18931 .cindex "address" "copying routing"
18932 Addresses with the same domain are normally routed by the &(dnslookup)& router
18933 to the same list of hosts. However, this cannot be presumed, because the router
18934 options and preconditions may refer to the local part of the address. By
18935 default, therefore, Exim routes each address in a message independently. DNS
18936 servers run caches, so repeated DNS lookups are not normally expensive, and in
18937 any case, personal messages rarely have more than a few recipients.
18938
18939 If you are running mailing lists with large numbers of subscribers at the same
18940 domain, and you are using a &(dnslookup)& router which is independent of the
18941 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18942 lookups for identical domains in one message. In this case, when &(dnslookup)&
18943 routes an address to a remote transport, any other unrouted addresses in the
18944 message that have the same domain are automatically given the same routing
18945 without processing them independently,
18946 provided the following conditions are met:
18947
18948 .ilist
18949 No router that processed the address specified &%headers_add%& or
18950 &%headers_remove%&.
18951 .next
18952 The router did not change the address in any way, for example, by &"widening"&
18953 the domain.
18954 .endlist
18955
18956
18957
18958
18959 .option search_parents dnslookup boolean false
18960 .cindex "DNS" "resolver options"
18961 When this option is true, the resolver option RES_DNSRCH is set for DNS
18962 lookups. This is different from the &%qualify_single%& option in that it
18963 applies to domains containing dots. Typically, but not standardly, it causes
18964 the resolver to search for the name in the current domain and in parent
18965 domains. For example, on a machine in the &'fict.example'& domain, if looking
18966 up &'teaparty.wonderland'& failed, the resolver would try
18967 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18968 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18969
18970 Setting this option true can cause problems in domains that have a wildcard MX
18971 record, because any domain that does not have its own MX record matches the
18972 local wildcard.
18973
18974
18975
18976 .option srv_fail_domains dnslookup "domain list&!!" unset
18977 If the DNS lookup for SRV records for one of the domains in this list causes a
18978 DNS lookup error, Exim behaves as if no SRV records were found. See section
18979 &<<SECTprowitdnsloo>>& for more discussion.
18980
18981
18982
18983
18984 .option widen_domains dnslookup "string list" unset
18985 .cindex "domain" "partial; widening"
18986 If a DNS lookup fails and this option is set, each of its strings in turn is
18987 added onto the end of the domain, and the lookup is tried again. For example,
18988 if
18989 .code
18990 widen_domains = fict.example:ref.example
18991 .endd
18992 is set and a lookup of &'klingon.dictionary'& fails,
18993 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18994 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18995 and &%search_parents%& options can cause some widening to be undertaken inside
18996 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18997 when verifying, unless &%rewrite_headers%& is false (not the default).
18998
18999
19000 .section "Effect of qualify_single and search_parents" "SECID119"
19001 When a domain from an envelope recipient is changed by the resolver as a result
19002 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19003 corresponding address in the message's header lines unless &%rewrite_headers%&
19004 is set false. Exim then re-routes the address, using the full domain.
19005
19006 These two options affect only the DNS lookup that takes place inside the router
19007 for the domain of the address that is being routed. They do not affect lookups
19008 such as that implied by
19009 .code
19010 domains = @mx_any
19011 .endd
19012 that may happen while processing a router precondition before the router is
19013 entered. No widening ever takes place for these lookups.
19014 .ecindex IIDdnsrou1
19015 .ecindex IIDdnsrou2
19016
19017
19018
19019
19020
19021
19022
19023
19024
19025 . ////////////////////////////////////////////////////////////////////////////
19026 . ////////////////////////////////////////////////////////////////////////////
19027
19028 .chapter "The ipliteral router" "CHID5"
19029 .cindex "&(ipliteral)& router"
19030 .cindex "domain literal" "routing"
19031 .cindex "routers" "&(ipliteral)&"
19032 This router has no private options. Unless it is being used purely for
19033 verification (see &%verify_only%&) a transport is required to be defined by the
19034 generic &%transport%& option. The router accepts the address if its domain part
19035 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19036 router handles the address
19037 .code
19038 root@[192.168.1.1]
19039 .endd
19040 by setting up delivery to the host with that IP address. IPv4 domain literals
19041 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19042 are similar, but the address is preceded by &`ipv6:`&. For example:
19043 .code
19044 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19045 .endd
19046 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19047 grounds that sooner or later somebody will try it.
19048
19049 .oindex "&%self%&" "in &(ipliteral)& router"
19050 If the IP address matches something in &%ignore_target_hosts%&, the router
19051 declines. If an IP literal turns out to refer to the local host, the generic
19052 &%self%& option determines what happens.
19053
19054 The RFCs require support for domain literals; however, their use is
19055 controversial in today's Internet. If you want to use this router, you must
19056 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19057 Exim will not recognize the domain literal syntax in addresses.
19058
19059
19060
19061 . ////////////////////////////////////////////////////////////////////////////
19062 . ////////////////////////////////////////////////////////////////////////////
19063
19064 .chapter "The iplookup router" "CHID6"
19065 .cindex "&(iplookup)& router"
19066 .cindex "routers" "&(iplookup)&"
19067 The &(iplookup)& router was written to fulfil a specific requirement in
19068 Cambridge University (which in fact no longer exists). For this reason, it is
19069 not included in the binary of Exim by default. If you want to include it, you
19070 must set
19071 .code
19072 ROUTER_IPLOOKUP=yes
19073 .endd
19074 in your &_Local/Makefile_& configuration file.
19075
19076 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19077 connection to one or more specific hosts. The host can then return the same or
19078 a different address &-- in effect rewriting the recipient address in the
19079 message's envelope. The new address is then passed on to subsequent routers. If
19080 this process fails, the address can be passed on to other routers, or delivery
19081 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19082 must not be specified for it.
19083
19084 .cindex "options" "&(iplookup)& router"
19085 .option hosts iplookup string unset
19086 This option must be supplied. Its value is a colon-separated list of host
19087 names. The hosts are looked up using &[gethostbyname()]&
19088 (or &[getipnodebyname()]& when available)
19089 and are tried in order until one responds to the query. If none respond, what
19090 happens is controlled by &%optional%&.
19091
19092
19093 .option optional iplookup boolean false
19094 If &%optional%& is true, if no response is obtained from any host, the address
19095 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19096 delivery to the address is deferred.
19097
19098
19099 .option port iplookup integer 0
19100 .cindex "port" "&(iplookup)& router"
19101 This option must be supplied. It specifies the port number for the TCP or UDP
19102 call.
19103
19104
19105 .option protocol iplookup string udp
19106 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19107 protocols is to be used.
19108
19109
19110 .option query iplookup string&!! "see below"
19111 This defines the content of the query that is sent to the remote hosts. The
19112 default value is:
19113 .code
19114 $local_part@$domain $local_part@$domain
19115 .endd
19116 The repetition serves as a way of checking that a response is to the correct
19117 query in the default case (see &%response_pattern%& below).
19118
19119
19120 .option reroute iplookup string&!! unset
19121 If this option is not set, the rerouted address is precisely the byte string
19122 returned by the remote host, up to the first white space, if any. If set, the
19123 string is expanded to form the rerouted address. It can include parts matched
19124 in the response by &%response_pattern%& by means of numeric variables such as
19125 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19126 whether or not a pattern is in use. In all cases, the rerouted address must end
19127 up in the form &'local_part@domain'&.
19128
19129
19130 .option response_pattern iplookup string unset
19131 This option can be set to a regular expression that is applied to the string
19132 returned from the remote host. If the pattern does not match the response, the
19133 router declines. If &%response_pattern%& is not set, no checking of the
19134 response is done, unless the query was defaulted, in which case there is a
19135 check that the text returned after the first white space is the original
19136 address. This checks that the answer that has been received is in response to
19137 the correct question. For example, if the response is just a new domain, the
19138 following could be used:
19139 .code
19140 response_pattern = ^([^@]+)$
19141 reroute = $local_part@$1
19142 .endd
19143
19144 .option timeout iplookup time 5s
19145 This specifies the amount of time to wait for a response from the remote
19146 machine. The same timeout is used for the &[connect()]& function for a TCP
19147 call. It does not apply to UDP.
19148
19149
19150
19151
19152 . ////////////////////////////////////////////////////////////////////////////
19153 . ////////////////////////////////////////////////////////////////////////////
19154
19155 .chapter "The manualroute router" "CHID7"
19156 .scindex IIDmanrou1 "&(manualroute)& router"
19157 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19158 .cindex "domain" "manually routing"
19159 The &(manualroute)& router is so-called because it provides a way of manually
19160 routing an address according to its domain. It is mainly used when you want to
19161 route addresses to remote hosts according to your own rules, bypassing the
19162 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19163 route to local transports, a facility that may be useful if you want to save
19164 messages for dial-in hosts in local files.
19165
19166 The &(manualroute)& router compares a list of domain patterns with the domain
19167 it is trying to route. If there is no match, the router declines. Each pattern
19168 has associated with it a list of hosts and some other optional data, which may
19169 include a transport. The combination of a pattern and its data is called a
19170 &"routing rule"&. For patterns that do not have an associated transport, the
19171 generic &%transport%& option must specify a transport, unless the router is
19172 being used purely for verification (see &%verify_only%&).
19173
19174 .vindex "&$host$&"
19175 In the case of verification, matching the domain pattern is sufficient for the
19176 router to accept the address. When actually routing an address for delivery,
19177 an address that matches a domain pattern is queued for the associated
19178 transport. If the transport is not a local one, a host list must be associated
19179 with the pattern; IP addresses are looked up for the hosts, and these are
19180 passed to the transport along with the mail address. For local transports, a
19181 host list is optional. If it is present, it is passed in &$host$& as a single
19182 text string.
19183
19184 The list of routing rules can be provided as an inline string in
19185 &%route_list%&, or the data can be obtained by looking up the domain in a file
19186 or database by setting &%route_data%&. Only one of these settings may appear in
19187 any one instance of &(manualroute)&. The format of routing rules is described
19188 below, following the list of private options.
19189
19190
19191 .section "Private options for manualroute" "SECTprioptman"
19192
19193 .cindex "options" "&(manualroute)& router"
19194 The private options for the &(manualroute)& router are as follows:
19195
19196 .option host_all_ignored manualroute string defer
19197 See &%host_find_failed%&.
19198
19199 .option host_find_failed manualroute string freeze
19200 This option controls what happens when &(manualroute)& tries to find an IP
19201 address for a host, and the host does not exist. The option can be set to one
19202 of the following values:
19203 .code
19204 decline
19205 defer
19206 fail
19207 freeze
19208 ignore
19209 pass
19210 .endd
19211 The default (&"freeze"&) assumes that this state is a serious configuration
19212 error. The difference between &"pass"& and &"decline"& is that the former
19213 forces the address to be passed to the next router (or the router defined by
19214 &%pass_router%&),
19215 .oindex "&%more%&"
19216 overriding &%no_more%&, whereas the latter passes the address to the next
19217 router only if &%more%& is true.
19218
19219 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19220 cannot be found. If all the hosts in the list are ignored, the behaviour is
19221 controlled by the &%host_all_ignored%& option. This takes the same values
19222 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19223
19224 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19225 state; if a host lookup gets a temporary error, delivery is deferred unless the
19226 generic &%pass_on_timeout%& option is set.
19227
19228
19229 .option hosts_randomize manualroute boolean false
19230 .cindex "randomized host list"
19231 .cindex "host" "list of; randomized"
19232 If this option is set, the order of the items in a host list in a routing rule
19233 is randomized each time the list is used, unless an option in the routing rule
19234 overrides (see below). Randomizing the order of a host list can be used to do
19235 crude load sharing. However, if more than one mail address is routed by the
19236 same router to the same host list, the host lists are considered to be the same
19237 (even though they may be randomized into different orders) for the purpose of
19238 deciding whether to batch the deliveries into a single SMTP transaction.
19239
19240 When &%hosts_randomize%& is true, a host list may be split
19241 into groups whose order is separately randomized. This makes it possible to
19242 set up MX-like behaviour. The boundaries between groups are indicated by an
19243 item that is just &`+`& in the host list. For example:
19244 .code
19245 route_list = * host1:host2:host3:+:host4:host5
19246 .endd
19247 The order of the first three hosts and the order of the last two hosts is
19248 randomized for each use, but the first three always end up before the last two.
19249 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19250 randomized host list is passed to an &(smtp)& transport that also has
19251 &%hosts_randomize set%&, the list is not re-randomized.
19252
19253
19254 .option route_data manualroute string&!! unset
19255 If this option is set, it must expand to yield the data part of a routing rule.
19256 Typically, the expansion string includes a lookup based on the domain. For
19257 example:
19258 .code
19259 route_data = ${lookup{$domain}dbm{/etc/routes}}
19260 .endd
19261 If the expansion is forced to fail, or the result is an empty string, the
19262 router declines. Other kinds of expansion failure cause delivery to be
19263 deferred.
19264
19265
19266 .option route_list manualroute "string list" unset
19267 This string is a list of routing rules, in the form defined below. Note that,
19268 unlike most string lists, the items are separated by semicolons. This is so
19269 that they may contain colon-separated host lists.
19270
19271
19272 .option same_domain_copy_routing manualroute boolean false
19273 .cindex "address" "copying routing"
19274 Addresses with the same domain are normally routed by the &(manualroute)&
19275 router to the same list of hosts. However, this cannot be presumed, because the
19276 router options and preconditions may refer to the local part of the address. By
19277 default, therefore, Exim routes each address in a message independently. DNS
19278 servers run caches, so repeated DNS lookups are not normally expensive, and in
19279 any case, personal messages rarely have more than a few recipients.
19280
19281 If you are running mailing lists with large numbers of subscribers at the same
19282 domain, and you are using a &(manualroute)& router which is independent of the
19283 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19284 lookups for identical domains in one message. In this case, when
19285 &(manualroute)& routes an address to a remote transport, any other unrouted
19286 addresses in the message that have the same domain are automatically given the
19287 same routing without processing them independently. However, this is only done
19288 if &%headers_add%& and &%headers_remove%& are unset.
19289
19290
19291
19292
19293 .section "Routing rules in route_list" "SECID120"
19294 The value of &%route_list%& is a string consisting of a sequence of routing
19295 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19296 entered as two semicolons. Alternatively, the list separator can be changed as
19297 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19298 Empty rules are ignored. The format of each rule is
19299 .display
19300 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19301 .endd
19302 The following example contains two rules, each with a simple domain pattern and
19303 no options:
19304 .code
19305 route_list = \
19306   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19307   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19308 .endd
19309 The three parts of a rule are separated by white space. The pattern and the
19310 list of hosts can be enclosed in quotes if necessary, and if they are, the
19311 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19312 single domain pattern, which is the only mandatory item in the rule. The
19313 pattern is in the same format as one item in a domain list (see section
19314 &<<SECTdomainlist>>&),
19315 except that it may not be the name of an interpolated file.
19316 That is, it may be wildcarded, or a regular expression, or a file or database
19317 lookup (with semicolons doubled, because of the use of semicolon as a separator
19318 in a &%route_list%&).
19319
19320 The rules in &%route_list%& are searched in order until one of the patterns
19321 matches the domain that is being routed. The list of hosts and then options are
19322 then used as described below. If there is no match, the router declines. When
19323 &%route_list%& is set, &%route_data%& must not be set.
19324
19325
19326
19327 .section "Routing rules in route_data" "SECID121"
19328 The use of &%route_list%& is convenient when there are only a small number of
19329 routing rules. For larger numbers, it is easier to use a file or database to
19330 hold the routing information, and use the &%route_data%& option instead.
19331 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19332 Most commonly, &%route_data%& is set as a string that contains an
19333 expansion lookup. For example, suppose we place two routing rules in a file
19334 like this:
19335 .code
19336 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19337 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19338 .endd
19339 This data can be accessed by setting
19340 .code
19341 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19342 .endd
19343 Failure of the lookup results in an empty string, causing the router to
19344 decline. However, you do not have to use a lookup in &%route_data%&. The only
19345 requirement is that the result of expanding the string is a list of hosts,
19346 possibly followed by options, separated by white space. The list of hosts must
19347 be enclosed in quotes if it contains white space.
19348
19349
19350
19351
19352 .section "Format of the list of hosts" "SECID122"
19353 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19354 always separately expanded before use. If the expansion fails, the router
19355 declines. The result of the expansion must be a colon-separated list of names
19356 and/or IP addresses, optionally also including ports. The format of each item
19357 in the list is described in the next section. The list separator can be changed
19358 as described in section &<<SECTlistconstruct>>&.
19359
19360 If the list of hosts was obtained from a &%route_list%& item, the following
19361 variables are set during its expansion:
19362
19363 .ilist
19364 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19365 If the domain was matched against a regular expression, the numeric variables
19366 &$1$&, &$2$&, etc. may be set. For example:
19367 .code
19368 route_list = ^domain(\d+)   host-$1.text.example
19369 .endd
19370 .next
19371 &$0$& is always set to the entire domain.
19372 .next
19373 &$1$& is also set when partial matching is done in a file lookup.
19374
19375 .next
19376 .vindex "&$value$&"
19377 If the pattern that matched the domain was a lookup item, the data that was
19378 looked up is available in the expansion variable &$value$&. For example:
19379 .code
19380 route_list = lsearch;;/some/file.routes  $value
19381 .endd
19382 .endlist
19383
19384 Note the doubling of the semicolon in the pattern that is necessary because
19385 semicolon is the default route list separator.
19386
19387
19388
19389 .section "Format of one host item" "SECTformatonehostitem"
19390 Each item in the list of hosts is either a host name or an IP address,
19391 optionally with an attached port number. When no port is given, an IP address
19392 is not enclosed in brackets. When a port is specified, it overrides the port
19393 specification on the transport. The port is separated from the name or address
19394 by a colon. This leads to some complications:
19395
19396 .ilist
19397 Because colon is the default separator for the list of hosts, either
19398 the colon that specifies a port must be doubled, or the list separator must
19399 be changed. The following two examples have the same effect:
19400 .code
19401 route_list = * "host1.tld::1225 : host2.tld::1226"
19402 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19403 .endd
19404 .next
19405 When IPv6 addresses are involved, it gets worse, because they contain
19406 colons of their own. To make this case easier, it is permitted to
19407 enclose an IP address (either v4 or v6) in square brackets if a port
19408 number follows. For example:
19409 .code
19410 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19411 .endd
19412 .endlist
19413
19414 .section "How the list of hosts is used" "SECThostshowused"
19415 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19416 the hosts is tried, in the order specified, when carrying out the SMTP
19417 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19418 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19419 transport.
19420
19421 Hosts may be listed by name or by IP address. An unadorned name in the list of
19422 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19423 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19424 records in the DNS. For example:
19425 .code
19426 route_list = *  x.y.z:p.q.r/MX:e.f.g
19427 .endd
19428 If this feature is used with a port specifier, the port must come last. For
19429 example:
19430 .code
19431 route_list = *  dom1.tld/mx::1225
19432 .endd
19433 If the &%hosts_randomize%& option is set, the order of the items in the list is
19434 randomized before any lookups are done. Exim then scans the list; for any name
19435 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19436 be an interface on the local host and the item is not the first in the list,
19437 Exim discards it and any subsequent items. If it is the first item, what
19438 happens is controlled by the
19439 .oindex "&%self%&" "in &(manualroute)& router"
19440 &%self%& option of the router.
19441
19442 A name on the list that is followed by &`/MX`& is replaced with the list of
19443 hosts obtained by looking up MX records for the name. This is always a DNS
19444 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19445 below) are not relevant here. The order of these hosts is determined by the
19446 preference values in the MX records, according to the usual rules. Because
19447 randomizing happens before the MX lookup, it does not affect the order that is
19448 defined by MX preferences.
19449
19450 If the local host is present in the sublist obtained from MX records, but is
19451 not the most preferred host in that list, it and any equally or less
19452 preferred hosts are removed before the sublist is inserted into the main list.
19453
19454 If the local host is the most preferred host in the MX list, what happens
19455 depends on where in the original list of hosts the &`/MX`& item appears. If it
19456 is not the first item (that is, there are previous hosts in the main list),
19457 Exim discards this name and any subsequent items in the main list.
19458
19459 If the MX item is first in the list of hosts, and the local host is the
19460 most preferred host, what happens is controlled by the &%self%& option of the
19461 router.
19462
19463 DNS failures when lookup up the MX records are treated in the same way as DNS
19464 failures when looking up IP addresses: &%pass_on_timeout%& and
19465 &%host_find_failed%& are used when relevant.
19466
19467 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19468 whether obtained from an MX lookup or not.
19469
19470
19471
19472 .section "How the options are used" "SECThowoptused"
19473 The options are a sequence of words; in practice no more than three are ever
19474 present. One of the words can be the name of a transport; this overrides the
19475 &%transport%& option on the router for this particular routing rule only. The
19476 other words (if present) control randomization of the list of hosts on a
19477 per-rule basis, and how the IP addresses of the hosts are to be found when
19478 routing to a remote transport. These options are as follows:
19479
19480 .ilist
19481 &%randomize%&: randomize the order of the hosts in this list, overriding the
19482 setting of &%hosts_randomize%& for this routing rule only.
19483 .next
19484 &%no_randomize%&: do not randomize the order of the hosts in this list,
19485 overriding the setting of &%hosts_randomize%& for this routing rule only.
19486 .next
19487 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19488 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19489 also look in &_/etc/hosts_& or other sources of information.
19490 .next
19491 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19492 no address records are found. If there is a temporary DNS error (such as a
19493 timeout), delivery is deferred.
19494 .endlist
19495
19496 For example:
19497 .code
19498 route_list = domain1  host1:host2:host3  randomize bydns;\
19499              domain2  host4:host5
19500 .endd
19501 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19502 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19503 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19504 or &[gethostbyname()]&, and the result of the lookup is the result of that
19505 call.
19506
19507 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19508 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19509 instead of TRY_AGAIN. That is why the default action is to try a DNS
19510 lookup first. Only if that gives a definite &"no such host"& is the local
19511 function called.
19512
19513 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
19514 inadvertent constraint that a transport name as an option had to be the last
19515 option specified.
19516
19517
19518
19519 If no IP address for a host can be found, what happens is controlled by the
19520 &%host_find_failed%& option.
19521
19522 .vindex "&$host$&"
19523 When an address is routed to a local transport, IP addresses are not looked up.
19524 The host list is passed to the transport in the &$host$& variable.
19525
19526
19527
19528 .section "Manualroute examples" "SECID123"
19529 In some of the examples that follow, the presence of the &%remote_smtp%&
19530 transport, as defined in the default configuration file, is assumed:
19531
19532 .ilist
19533 .cindex "smart host" "example router"
19534 The &(manualroute)& router can be used to forward all external mail to a
19535 &'smart host'&. If you have set up, in the main part of the configuration, a
19536 named domain list that contains your local domains, for example:
19537 .code
19538 domainlist local_domains = my.domain.example
19539 .endd
19540 You can arrange for all other domains to be routed to a smart host by making
19541 your first router something like this:
19542 .code
19543 smart_route:
19544   driver = manualroute
19545   domains = !+local_domains
19546   transport = remote_smtp
19547   route_list = * smarthost.ref.example
19548 .endd
19549 This causes all non-local addresses to be sent to the single host
19550 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19551 they are tried in order
19552 (but you can use &%hosts_randomize%& to vary the order each time).
19553 Another way of configuring the same thing is this:
19554 .code
19555 smart_route:
19556   driver = manualroute
19557   transport = remote_smtp
19558   route_list = !+local_domains  smarthost.ref.example
19559 .endd
19560 There is no difference in behaviour between these two routers as they stand.
19561 However, they behave differently if &%no_more%& is added to them. In the first
19562 example, the router is skipped if the domain does not match the &%domains%&
19563 precondition; the following router is always tried. If the router runs, it
19564 always matches the domain and so can never decline. Therefore, &%no_more%&
19565 would have no effect. In the second case, the router is never skipped; it
19566 always runs. However, if it doesn't match the domain, it declines. In this case
19567 &%no_more%& would prevent subsequent routers from running.
19568
19569 .next
19570 .cindex "mail hub example"
19571 A &'mail hub'& is a host which receives mail for a number of domains via MX
19572 records in the DNS and delivers it via its own private routing mechanism. Often
19573 the final destinations are behind a firewall, with the mail hub being the one
19574 machine that can connect to machines both inside and outside the firewall. The
19575 &(manualroute)& router is usually used on a mail hub to route incoming messages
19576 to the correct hosts. For a small number of domains, the routing can be inline,
19577 using the &%route_list%& option, but for a larger number a file or database
19578 lookup is easier to manage.
19579
19580 If the domain names are in fact the names of the machines to which the mail is
19581 to be sent by the mail hub, the configuration can be quite simple. For
19582 example:
19583 .code
19584 hub_route:
19585   driver = manualroute
19586   transport = remote_smtp
19587   route_list = *.rhodes.tvs.example  $domain
19588 .endd
19589 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19590 whose names are the same as the mail domains. A similar approach can be taken
19591 if the host name can be obtained from the domain name by a string manipulation
19592 that the expansion facilities can handle. Otherwise, a lookup based on the
19593 domain can be used to find the host:
19594 .code
19595 through_firewall:
19596   driver = manualroute
19597   transport = remote_smtp
19598   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19599 .endd
19600 The result of the lookup must be the name or IP address of the host (or
19601 hosts) to which the address is to be routed. If the lookup fails, the route
19602 data is empty, causing the router to decline. The address then passes to the
19603 next router.
19604
19605 .next
19606 .cindex "batched SMTP output example"
19607 .cindex "SMTP" "batched outgoing; example"
19608 You can use &(manualroute)& to deliver messages to pipes or files in batched
19609 SMTP format for onward transportation by some other means. This is one way of
19610 storing mail for a dial-up host when it is not connected. The route list entry
19611 can be as simple as a single domain name in a configuration like this:
19612 .code
19613 save_in_file:
19614   driver = manualroute
19615   transport = batchsmtp_appendfile
19616   route_list = saved.domain.example
19617 .endd
19618 though often a pattern is used to pick up more than one domain. If there are
19619 several domains or groups of domains with different transport requirements,
19620 different transports can be listed in the routing information:
19621 .code
19622 save_in_file:
19623   driver = manualroute
19624   route_list = \
19625     *.saved.domain1.example  $domain  batch_appendfile; \
19626     *.saved.domain2.example  \
19627       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19628       batch_pipe
19629 .endd
19630 .vindex "&$domain$&"
19631 .vindex "&$host$&"
19632 The first of these just passes the domain in the &$host$& variable, which
19633 doesn't achieve much (since it is also in &$domain$&), but the second does a
19634 file lookup to find a value to pass, causing the router to decline to handle
19635 the address if the lookup fails.
19636
19637 .next
19638 .cindex "UUCP" "example of router for"
19639 Routing mail directly to UUCP software is a specific case of the use of
19640 &(manualroute)& in a gateway to another mail environment. This is an example of
19641 one way it can be done:
19642 .code
19643 # Transport
19644 uucp:
19645   driver = pipe
19646   user = nobody
19647   command = /usr/local/bin/uux -r - \
19648     ${substr_-5:$host}!rmail ${local_part}
19649   return_fail_output = true
19650
19651 # Router
19652 uucphost:
19653   transport = uucp
19654   driver = manualroute
19655   route_data = \
19656     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19657 .endd
19658 The file &_/usr/local/exim/uucphosts_& contains entries like
19659 .code
19660 darksite.ethereal.example:           darksite.UUCP
19661 .endd
19662 It can be set up more simply without adding and removing &".UUCP"& but this way
19663 makes clear the distinction between the domain name
19664 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19665 .endlist
19666 .ecindex IIDmanrou1
19667 .ecindex IIDmanrou2
19668
19669
19670
19671
19672
19673
19674
19675
19676 . ////////////////////////////////////////////////////////////////////////////
19677 . ////////////////////////////////////////////////////////////////////////////
19678
19679 .chapter "The queryprogram router" "CHAPdriverlast"
19680 .scindex IIDquerou1 "&(queryprogram)& router"
19681 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19682 .cindex "routing" "by external program"
19683 The &(queryprogram)& router routes an address by running an external command
19684 and acting on its output. This is an expensive way to route, and is intended
19685 mainly for use in lightly-loaded systems, or for performing experiments.
19686 However, if it is possible to use the precondition options (&%domains%&,
19687 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19688 be used in special cases, even on a busy host. There are the following private
19689 options:
19690 .cindex "options" "&(queryprogram)& router"
19691
19692 .option command queryprogram string&!! unset
19693 This option must be set. It specifies the command that is to be run. The
19694 command is split up into a command name and arguments, and then each is
19695 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19696 &<<CHAPpipetransport>>&).
19697
19698
19699 .option command_group queryprogram string unset
19700 .cindex "gid (group id)" "in &(queryprogram)& router"
19701 This option specifies a gid to be set when running the command while routing an
19702 address for deliver. It must be set if &%command_user%& specifies a numerical
19703 uid. If it begins with a digit, it is interpreted as the numerical value of the
19704 gid. Otherwise it is looked up using &[getgrnam()]&.
19705
19706
19707 .option command_user queryprogram string unset
19708 .cindex "uid (user id)" "for &(queryprogram)&"
19709 This option must be set. It specifies the uid which is set when running the
19710 command while routing an address for delivery. If the value begins with a digit,
19711 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19712 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19713 not set, a value for the gid also.
19714
19715 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19716 root, which it does during a normal delivery in a conventional configuration.
19717 However, when an address is being verified during message reception, Exim is
19718 usually running as the Exim user, not as root. If the &(queryprogram)& router
19719 is called from a non-root process, Exim cannot change uid or gid before running
19720 the command. In this circumstance the command runs under the current uid and
19721 gid.
19722
19723
19724 .option current_directory queryprogram string /
19725 This option specifies an absolute path which is made the current directory
19726 before running the command.
19727
19728
19729 .option timeout queryprogram time 1h
19730 If the command does not complete within the timeout period, its process group
19731 is killed and the message is frozen. A value of zero time specifies no
19732 timeout.
19733
19734
19735 The standard output of the command is connected to a pipe, which is read when
19736 the command terminates. It should consist of a single line of output,
19737 containing up to five fields, separated by white space. The maximum length of
19738 the line is 1023 characters. Longer lines are silently truncated. The first
19739 field is one of the following words (case-insensitive):
19740
19741 .ilist
19742 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19743 below).
19744 .next
19745 &'Decline'&: the router declines; pass the address to the next router, unless
19746 &%no_more%& is set.
19747 .next
19748 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19749 subsequent text on the line is an error message. If the router is run as part
19750 of address verification during an incoming SMTP message, the message is
19751 included in the SMTP response.
19752 .next
19753 &'Defer'&: routing could not be completed at this time; try again later. Any
19754 subsequent text on the line is an error message which is logged. It is not
19755 included in any SMTP response.
19756 .next
19757 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19758 .next
19759 &'Pass'&: pass the address to the next router (or the router specified by
19760 &%pass_router%&), overriding &%no_more%&.
19761 .next
19762 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19763 new addresses, which are routed independently, starting with the first router,
19764 or the router specified by &%redirect_router%&, if set.
19765 .endlist
19766
19767 When the first word is &'accept'&, the remainder of the line consists of a
19768 number of keyed data values, as follows (split into two lines here, to fit on
19769 the page):
19770 .code
19771 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19772 LOOKUP=byname|bydns DATA=<text>
19773 .endd
19774 The data items can be given in any order, and all are optional. If no transport
19775 is included, the transport specified by the generic &%transport%& option is
19776 used. The list of hosts and the lookup type are needed only if the transport is
19777 an &(smtp)& transport that does not itself supply a list of hosts.
19778
19779 The format of the list of hosts is the same as for the &(manualroute)& router.
19780 As well as host names and IP addresses with optional port numbers, as described
19781 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19782 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19783 (see section &<<SECThostshowused>>&).
19784
19785 If the lookup type is not specified, Exim behaves as follows when trying to
19786 find an IP address for each host: First, a DNS lookup is done. If this yields
19787 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19788 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19789 result of the lookup is the result of that call.
19790
19791 .vindex "&$address_data$&"
19792 If the DATA field is set, its value is placed in the &$address_data$&
19793 variable. For example, this return line
19794 .code
19795 accept hosts=x1.y.example:x2.y.example data="rule1"
19796 .endd
19797 routes the address to the default transport, passing a list of two hosts. When
19798 the transport runs, the string &"rule1"& is in &$address_data$&.
19799 .ecindex IIDquerou1
19800 .ecindex IIDquerou2
19801
19802
19803
19804
19805 . ////////////////////////////////////////////////////////////////////////////
19806 . ////////////////////////////////////////////////////////////////////////////
19807
19808 .chapter "The redirect router" "CHAPredirect"
19809 .scindex IIDredrou1 "&(redirect)& router"
19810 .scindex IIDredrou2 "routers" "&(redirect)&"
19811 .cindex "alias file" "in a &(redirect)& router"
19812 .cindex "address redirection" "&(redirect)& router"
19813 The &(redirect)& router handles several kinds of address redirection. Its most
19814 common uses are for resolving local part aliases from a central alias file
19815 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19816 files, but it has many other potential uses. The incoming address can be
19817 redirected in several different ways:
19818
19819 .ilist
19820 It can be replaced by one or more new addresses which are themselves routed
19821 independently.
19822 .next
19823 It can be routed to be delivered to a given file or directory.
19824 .next
19825 It can be routed to be delivered to a specified pipe command.
19826 .next
19827 It can cause an automatic reply to be generated.
19828 .next
19829 It can be forced to fail, optionally with a custom error message.
19830 .next
19831 It can be temporarily deferred, optionally with a custom message.
19832 .next
19833 It can be discarded.
19834 .endlist
19835
19836 The generic &%transport%& option must not be set for &(redirect)& routers.
19837 However, there are some private options which define transports for delivery to
19838 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19839 &%pipe_transport%& and &%reply_transport%& descriptions below.
19840
19841 If success DSNs have been requested
19842 .cindex "DSN" "success"
19843 .cindex "Delivery Status Notification" "success"
19844 redirection triggers one and the DSN options are not passed any further.
19845
19846
19847
19848 .section "Redirection data" "SECID124"
19849 The router operates by interpreting a text string which it obtains either by
19850 expanding the contents of the &%data%& option, or by reading the entire
19851 contents of a file whose name is given in the &%file%& option. These two
19852 options are mutually exclusive. The first is commonly used for handling system
19853 aliases, in a configuration like this:
19854 .code
19855 system_aliases:
19856   driver = redirect
19857   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19858 .endd
19859 If the lookup fails, the expanded string in this example is empty. When the
19860 expansion of &%data%& results in an empty string, the router declines. A forced
19861 expansion failure also causes the router to decline; other expansion failures
19862 cause delivery to be deferred.
19863
19864 A configuration using &%file%& is commonly used for handling users'
19865 &_.forward_& files, like this:
19866 .code
19867 userforward:
19868   driver = redirect
19869   check_local_user
19870   file = $home/.forward
19871   no_verify
19872 .endd
19873 If the file does not exist, or causes no action to be taken (for example, it is
19874 empty or consists only of comments), the router declines. &*Warning*&: This
19875 is not the case when the file contains syntactically valid items that happen to
19876 yield empty addresses, for example, items containing only RFC 2822 address
19877 comments.
19878
19879
19880
19881 .section "Forward files and address verification" "SECID125"
19882 .cindex "address redirection" "while verifying"
19883 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19884 &_.forward_& files, as in the example above. There are two reasons for this:
19885
19886 .ilist
19887 When Exim is receiving an incoming SMTP message from a remote host, it is
19888 running under the Exim uid, not as root. Exim is unable to change uid to read
19889 the file as the user, and it may not be able to read it as the Exim user. So in
19890 practice the router may not be able to operate.
19891 .next
19892 However, even when the router can operate, the existence of a &_.forward_& file
19893 is unimportant when verifying an address. What should be checked is whether the
19894 local part is a valid user name or not. Cutting out the redirection processing
19895 saves some resources.
19896 .endlist
19897
19898
19899
19900
19901
19902
19903 .section "Interpreting redirection data" "SECID126"
19904 .cindex "Sieve filter" "specifying in redirection data"
19905 .cindex "filter" "specifying in redirection data"
19906 The contents of the data string, whether obtained from &%data%& or &%file%&,
19907 can be interpreted in two different ways:
19908
19909 .ilist
19910 If the &%allow_filter%& option is set true, and the data begins with the text
19911 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19912 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19913 respectively. Details of the syntax and semantics of filter files are described
19914 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19915 document is intended for use by end users.
19916 .next
19917 Otherwise, the data must be a comma-separated list of redirection items, as
19918 described in the next section.
19919 .endlist
19920
19921 When a message is redirected to a file (a &"mail folder"&), the file name given
19922 in a non-filter redirection list must always be an absolute path. A filter may
19923 generate a relative path &-- how this is handled depends on the transport's
19924 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19925 for the &(appendfile)& transport.
19926
19927
19928
19929 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19930 .cindex "address redirection" "non-filter list items"
19931 When the redirection data is not an Exim or Sieve filter, for example, if it
19932 comes from a conventional alias or forward file, it consists of a list of
19933 addresses, file names, pipe commands, or certain special items (see section
19934 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19935 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19936 depending on their default values. The items in the list are separated by
19937 commas or newlines.
19938 If a comma is required in an item, the entire item must be enclosed in double
19939 quotes.
19940
19941 Lines starting with a # character are comments, and are ignored, and # may
19942 also appear following a comma, in which case everything between the # and the
19943 next newline character is ignored.
19944
19945 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19946 double quotes are retained because some forms of mail address require their use
19947 (but never to enclose the entire address). In the following description,
19948 &"item"& refers to what remains after any surrounding double quotes have been
19949 removed.
19950
19951 .vindex "&$local_part$&"
19952 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19953 and the expansion contains a reference to &$local_part$&, you should make use
19954 of the &%quote_local_part%& expansion operator, in case the local part contains
19955 special characters. For example, to redirect all mail for the domain
19956 &'obsolete.example'&, retaining the existing local part, you could use this
19957 setting:
19958 .code
19959 data = ${quote_local_part:$local_part}@newdomain.example
19960 .endd
19961
19962
19963 .section "Redirecting to a local mailbox" "SECTredlocmai"
19964 .cindex "routing" "loops in"
19965 .cindex "loop" "while routing, avoidance of"
19966 .cindex "address redirection" "to local mailbox"
19967 A redirection item may safely be the same as the address currently under
19968 consideration. This does not cause a routing loop, because a router is
19969 automatically skipped if any ancestor of the address that is being processed
19970 is the same as the current address and was processed by the current router.
19971 Such an address is therefore passed to the following routers, so it is handled
19972 as if there were no redirection. When making this loop-avoidance test, the
19973 complete local part, including any prefix or suffix, is used.
19974
19975 .cindex "address redirection" "local part without domain"
19976 Specifying the same local part without a domain is a common usage in personal
19977 filter files when the user wants to have messages delivered to the local
19978 mailbox and also forwarded elsewhere. For example, the user whose login is
19979 &'cleo'& might have a &_.forward_& file containing this:
19980 .code
19981 cleo, cleopatra@egypt.example
19982 .endd
19983 .cindex "backslash in alias file"
19984 .cindex "alias file" "backslash in"
19985 For compatibility with other MTAs, such unqualified local parts may be
19986 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19987 it does make a difference if more than one domain is being handled
19988 synonymously.
19989
19990 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19991 2822 address that does not include a domain, the item is qualified using the
19992 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19993 addresses are qualified using the value in &%qualify_recipient%&, but you can
19994 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19995
19996 Care must be taken if there are alias names for local users.
19997 Consider an MTA handling a single local domain where the system alias file
19998 contains:
19999 .code
20000 Sam.Reman: spqr
20001 .endd
20002 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20003 messages in the local mailbox, and also forward copies elsewhere. He creates
20004 this forward file:
20005 .code
20006 Sam.Reman, spqr@reme.elsewhere.example
20007 .endd
20008 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20009 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20010 second time round, because it has previously routed it,
20011 and the following routers presumably cannot handle the alias. The forward file
20012 should really contain
20013 .code
20014 spqr, spqr@reme.elsewhere.example
20015 .endd
20016 but because this is such a common error, the &%check_ancestor%& option (see
20017 below) exists to provide a way to get round it. This is normally set on a
20018 &(redirect)& router that is handling users' &_.forward_& files.
20019
20020
20021
20022 .section "Special items in redirection lists" "SECTspecitredli"
20023 In addition to addresses, the following types of item may appear in redirection
20024 lists (that is, in non-filter redirection data):
20025
20026 .ilist
20027 .cindex "pipe" "in redirection list"
20028 .cindex "address redirection" "to pipe"
20029 An item is treated as a pipe command if it begins with &"|"& and does not parse
20030 as a valid RFC 2822 address that includes a domain. A transport for running the
20031 command must be specified by the &%pipe_transport%& option.
20032 Normally, either the router or the transport specifies a user and a group under
20033 which to run the delivery. The default is to use the Exim user and group.
20034
20035 Single or double quotes can be used for enclosing the individual arguments of
20036 the pipe command; no interpretation of escapes is done for single quotes. If
20037 the command contains a comma character, it is necessary to put the whole item
20038 in double quotes, for example:
20039 .code
20040 "|/some/command ready,steady,go"
20041 .endd
20042 since items in redirection lists are terminated by commas. Do not, however,
20043 quote just the command. An item such as
20044 .code
20045 |"/some/command ready,steady,go"
20046 .endd
20047 is interpreted as a pipe with a rather strange command name, and no arguments.
20048
20049 Note that the above example assumes that the text comes from a lookup source
20050 of some sort, so that the quotes are part of the data.  If composing a
20051 redirect router with a &%data%& option directly specifying this command, the
20052 quotes will be used by the configuration parser to define the extent of one
20053 string, but will not be passed down into the redirect router itself.  There
20054 are two main approaches to get around this: escape quotes to be part of the
20055 data itself, or avoid using this mechanism and instead create a custom
20056 transport with the &%command%& option set and reference that transport from
20057 an &%accept%& router.
20058
20059 .next
20060 .cindex "file" "in redirection list"
20061 .cindex "address redirection" "to file"
20062 An item is interpreted as a path name if it begins with &"/"& and does not
20063 parse as a valid RFC 2822 address that includes a domain. For example,
20064 .code
20065 /home/world/minbari
20066 .endd
20067 is treated as a file name, but
20068 .code
20069 /s=molari/o=babylon/@x400gate.way
20070 .endd
20071 is treated as an address. For a file name, a transport must be specified using
20072 the &%file_transport%& option. However, if the generated path name ends with a
20073 forward slash character, it is interpreted as a directory name rather than a
20074 file name, and &%directory_transport%& is used instead.
20075
20076 Normally, either the router or the transport specifies a user and a group under
20077 which to run the delivery. The default is to use the Exim user and group.
20078
20079 .cindex "&_/dev/null_&"
20080 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20081 bypassed at a high level, and the log entry shows &"**bypassed**"&
20082 instead of a transport name. In this case the user and group are not used.
20083
20084 .next
20085 .cindex "included address list"
20086 .cindex "address redirection" "included external list"
20087 If an item is of the form
20088 .code
20089 :include:<path name>
20090 .endd
20091 a list of further items is taken from the given file and included at that
20092 point. &*Note*&: Such a file can not be a filter file; it is just an
20093 out-of-line addition to the list. The items in the included list are separated
20094 by commas or newlines and are not subject to expansion. If this is the first
20095 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20096 the alias name. This example is incorrect:
20097 .code
20098 list1    :include:/opt/lists/list1
20099 .endd
20100 It must be given as
20101 .code
20102 list1:   :include:/opt/lists/list1
20103 .endd
20104 .next
20105 .cindex "address redirection" "to black hole"
20106 .cindex "delivery" "discard"
20107 .cindex "delivery" "blackhole"
20108 .cindex "black hole"
20109 .cindex "abandoning mail"
20110 Sometimes you want to throw away mail to a particular local part.  Making the
20111 &%data%& option expand to an empty string does not work, because that causes
20112 the router to decline. Instead, the alias item
20113 .code
20114 :blackhole:
20115 .endd
20116 can be used. It does what its name implies. No delivery is
20117 done, and no error message is generated. This has the same effect as specifying
20118 &_/dev/null_& as a destination, but it can be independently disabled.
20119
20120 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20121 delivery is done for the original local part, even if other redirection items
20122 are present. If you are generating a multi-item list (for example, by reading a
20123 database) and need the ability to provide a no-op item, you must use
20124 &_/dev/null_&.
20125
20126 .next
20127 .cindex "delivery" "forcing failure"
20128 .cindex "delivery" "forcing deferral"
20129 .cindex "failing delivery" "forcing"
20130 .cindex "deferred delivery, forcing"
20131 .cindex "customizing" "failure message"
20132 An attempt to deliver a particular address can be deferred or forced to fail by
20133 redirection items of the form
20134 .code
20135 :defer:
20136 :fail:
20137 .endd
20138 respectively. When a redirection list contains such an item, it applies
20139 to the entire redirection; any other items in the list are ignored. Any
20140 text following &':fail:'& or &':defer:'& is placed in the error text
20141 associated with the failure. For example, an alias file might contain:
20142 .code
20143 X.Employee:  :fail: Gone away, no forwarding address
20144 .endd
20145 In the case of an address that is being verified from an ACL or as the subject
20146 of a
20147 .cindex "VRFY" "error text, display of"
20148 VRFY command, the text is included in the SMTP error response by
20149 default.
20150 .cindex "EXPN" "error text, display of"
20151 The text is not included in the response to an EXPN command. In non-SMTP cases
20152 the text is included in the error message that Exim generates.
20153
20154 .cindex "SMTP" "error codes"
20155 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20156 &':fail:'&. However, if the message starts with three digits followed by a
20157 space, optionally followed by an extended code of the form &'n.n.n'&, also
20158 followed by a space, and the very first digit is the same as the default error
20159 code, the code from the message is used instead. If the very first digit is
20160 incorrect, a panic error is logged, and the default code is used. You can
20161 suppress the use of the supplied code in a redirect router by setting the
20162 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20163 ignored.
20164
20165 .vindex "&$acl_verify_message$&"
20166 In an ACL, an explicitly provided message overrides the default, but the
20167 default message is available in the variable &$acl_verify_message$& and can
20168 therefore be included in a custom message if this is desired.
20169
20170 Normally the error text is the rest of the redirection list &-- a comma does
20171 not terminate it &-- but a newline does act as a terminator. Newlines are not
20172 normally present in alias expansions. In &(lsearch)& lookups they are removed
20173 as part of the continuation process, but they may exist in other kinds of
20174 lookup and in &':include:'& files.
20175
20176 During routing for message delivery (as opposed to verification), a redirection
20177 containing &':fail:'& causes an immediate failure of the incoming address,
20178 whereas &':defer:'& causes the message to remain on the queue so that a
20179 subsequent delivery attempt can happen at a later time. If an address is
20180 deferred for too long, it will ultimately fail, because the normal retry
20181 rules still apply.
20182
20183 .next
20184 .cindex "alias file" "exception to default"
20185 Sometimes it is useful to use a single-key search type with a default (see
20186 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20187 for exceptions to the default. These can be handled by aliasing them to
20188 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20189 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20190 results in an empty redirection list has the same effect.
20191 .endlist
20192
20193
20194 .section "Duplicate addresses" "SECTdupaddr"
20195 .cindex "duplicate addresses"
20196 .cindex "address duplicate, discarding"
20197 .cindex "pipe" "duplicated"
20198 Exim removes duplicate addresses from the list to which it is delivering, so as
20199 to deliver just one copy to each address. This does not apply to deliveries
20200 routed to pipes by different immediate parent addresses, but an indirect
20201 aliasing scheme of the type
20202 .code
20203 pipe:       |/some/command $local_part
20204 localpart1: pipe
20205 localpart2: pipe
20206 .endd
20207 does not work with a message that is addressed to both local parts, because
20208 when the second is aliased to the intermediate local part &"pipe"& it gets
20209 discarded as being the same as a previously handled address. However, a scheme
20210 such as
20211 .code
20212 localpart1: |/some/command $local_part
20213 localpart2: |/some/command $local_part
20214 .endd
20215 does result in two different pipe deliveries, because the immediate parents of
20216 the pipes are distinct.
20217
20218
20219
20220 .section "Repeated redirection expansion" "SECID128"
20221 .cindex "repeated redirection expansion"
20222 .cindex "address redirection" "repeated for each delivery attempt"
20223 When a message cannot be delivered to all of its recipients immediately,
20224 leading to two or more delivery attempts, redirection expansion is carried out
20225 afresh each time for those addresses whose children were not all previously
20226 delivered. If redirection is being used as a mailing list, this can lead to new
20227 members of the list receiving copies of old messages. The &%one_time%& option
20228 can be used to avoid this.
20229
20230
20231 .section "Errors in redirection lists" "SECID129"
20232 .cindex "address redirection" "errors"
20233 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20234 error is skipped, and an entry is written to the main log. This may be useful
20235 for mailing lists that are automatically managed. Otherwise, if an error is
20236 detected while generating the list of new addresses, the original address is
20237 deferred. See also &%syntax_errors_to%&.
20238
20239
20240
20241 .section "Private options for the redirect router" "SECID130"
20242
20243 .cindex "options" "&(redirect)& router"
20244 The private options for the &(redirect)& router are as follows:
20245
20246
20247 .option allow_defer redirect boolean false
20248 Setting this option allows the use of &':defer:'& in non-filter redirection
20249 data, or the &%defer%& command in an Exim filter file.
20250
20251
20252 .option allow_fail redirect boolean false
20253 .cindex "failing delivery" "from filter"
20254 If this option is true, the &':fail:'& item can be used in a redirection list,
20255 and the &%fail%& command may be used in an Exim filter file.
20256
20257
20258 .option allow_filter redirect boolean false
20259 .cindex "filter" "enabling use of"
20260 .cindex "Sieve filter" "enabling use of"
20261 Setting this option allows Exim to interpret redirection data that starts with
20262 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20263 are some features of Exim filter files that some administrators may wish to
20264 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20265
20266 It is also possible to lock out Exim filters or Sieve filters while allowing
20267 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20268
20269
20270 The filter is run using the uid and gid set by the generic &%user%& and
20271 &%group%& options. These take their defaults from the password data if
20272 &%check_local_user%& is set, so in the normal case of users' personal filter
20273 files, the filter is run as the relevant user. When &%allow_filter%& is set
20274 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20275
20276
20277
20278 .option allow_freeze redirect boolean false
20279 .cindex "freezing messages" "allowing in filter"
20280 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20281 This command is more normally encountered in system filters, and is disabled by
20282 default for redirection filters because it isn't something you usually want to
20283 let ordinary users do.
20284
20285
20286
20287 .option check_ancestor redirect boolean false
20288 This option is concerned with handling generated addresses that are the same
20289 as some address in the list of redirection ancestors of the current address.
20290 Although it is turned off by default in the code, it is set in the default
20291 configuration file for handling users' &_.forward_& files. It is recommended
20292 for this use of the &(redirect)& router.
20293
20294 When &%check_ancestor%& is set, if a generated address (including the domain)
20295 is the same as any ancestor of the current address, it is replaced by a copy of
20296 the current address. This helps in the case where local part A is aliased to B,
20297 and B has a &_.forward_& file pointing back to A. For example, within a single
20298 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20299 &_&~jb/.forward_& contains:
20300 .code
20301 \Joe.Bloggs, <other item(s)>
20302 .endd
20303 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20304 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20305 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20306 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20307 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20308 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20309 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20310 original address. See also the &%repeat_use%& option below.
20311
20312
20313 .option check_group redirect boolean "see below"
20314 When the &%file%& option is used, the group owner of the file is checked only
20315 when this option is set. The permitted groups are those listed in the
20316 &%owngroups%& option, together with the user's default group if
20317 &%check_local_user%& is set. If the file has the wrong group, routing is
20318 deferred. The default setting for this option is true if &%check_local_user%&
20319 is set and the &%modemask%& option permits the group write bit, or if the
20320 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20321
20322
20323
20324 .option check_owner redirect boolean "see below"
20325 When the &%file%& option is used, the owner of the file is checked only when
20326 this option is set. If &%check_local_user%& is set, the local user is
20327 permitted; otherwise the owner must be one of those listed in the &%owners%&
20328 option. The default value for this option is true if &%check_local_user%& or
20329 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20330
20331
20332 .option data redirect string&!! unset
20333 This option is mutually exclusive with &%file%&. One or other of them must be
20334 set, but not both. The contents of &%data%& are expanded, and then used as the
20335 list of forwarding items, or as a set of filtering instructions. If the
20336 expansion is forced to fail, or the result is an empty string or a string that
20337 has no effect (consists entirely of comments), the router declines.
20338
20339 When filtering instructions are used, the string must begin with &"#Exim
20340 filter"&, and all comments in the string, including this initial one, must be
20341 terminated with newline characters. For example:
20342 .code
20343 data = #Exim filter\n\
20344        if $h_to: contains Exim then save $home/mail/exim endif
20345 .endd
20346 If you are reading the data from a database where newlines cannot be included,
20347 you can use the &${sg}$& expansion item to turn the escape string of your
20348 choice into a newline.
20349
20350
20351 .option directory_transport redirect string&!! unset
20352 A &(redirect)& router sets up a direct delivery to a directory when a path name
20353 ending with a slash is specified as a new &"address"&. The transport used is
20354 specified by this option, which, after expansion, must be the name of a
20355 configured transport. This should normally be an &(appendfile)& transport.
20356
20357
20358 .option file redirect string&!! unset
20359 This option specifies the name of a file that contains the redirection data. It
20360 is mutually exclusive with the &%data%& option. The string is expanded before
20361 use; if the expansion is forced to fail, the router declines. Other expansion
20362 failures cause delivery to be deferred. The result of a successful expansion
20363 must be an absolute path. The entire file is read and used as the redirection
20364 data. If the data is an empty string or a string that has no effect (consists
20365 entirely of comments), the router declines.
20366
20367 .cindex "NFS" "checking for file existence"
20368 If the attempt to open the file fails with a &"does not exist"& error, Exim
20369 runs a check on the containing directory,
20370 unless &%ignore_enotdir%& is true (see below).
20371 If the directory does not appear to exist, delivery is deferred. This can
20372 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20373 is a mount problem. If the containing directory does exist, but the file does
20374 not, the router declines.
20375
20376
20377 .option file_transport redirect string&!! unset
20378 .vindex "&$address_file$&"
20379 A &(redirect)& router sets up a direct delivery to a file when a path name not
20380 ending in a slash is specified as a new &"address"&. The transport used is
20381 specified by this option, which, after expansion, must be the name of a
20382 configured transport. This should normally be an &(appendfile)& transport. When
20383 it is running, the file name is in &$address_file$&.
20384
20385
20386 .option filter_prepend_home redirect boolean true
20387 When this option is true, if a &(save)& command in an Exim filter specifies a
20388 relative path, and &$home$& is defined, it is automatically prepended to the
20389 relative path. If this option is set false, this action does not happen. The
20390 relative path is then passed to the transport unmodified.
20391
20392
20393 .option forbid_blackhole redirect boolean false
20394 .cindex "restricting access to features"
20395 .cindex "filter" "locking out certain features"
20396 If this option is true, the &':blackhole:'& item may not appear in a
20397 redirection list.
20398
20399
20400 .option forbid_exim_filter redirect boolean false
20401 .cindex "restricting access to features"
20402 .cindex "filter" "locking out certain features"
20403 If this option is set true, only Sieve filters are permitted when
20404 &%allow_filter%& is true.
20405
20406
20407
20408
20409 .option forbid_file redirect boolean false
20410 .cindex "restricting access to features"
20411 .cindex "delivery" "to file; forbidding"
20412 .cindex "filter" "locking out certain features"
20413 .cindex "Sieve filter" "forbidding delivery to a file"
20414 .cindex "Sieve filter" "&""keep""& facility; disabling"
20415 If this option is true, this router may not generate a new address that
20416 specifies delivery to a local file or directory, either from a filter or from a
20417 conventional forward file. This option is forced to be true if &%one_time%& is
20418 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20419 locks out the Sieve's &"keep"& facility.
20420
20421
20422 .option forbid_filter_dlfunc redirect boolean false
20423 .cindex "restricting access to features"
20424 .cindex "filter" "locking out certain features"
20425 If this option is true, string expansions in Exim filters are not allowed to
20426 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20427 functions.
20428
20429 .option forbid_filter_existstest redirect boolean false
20430 .cindex "restricting access to features"
20431 .cindex "filter" "locking out certain features"
20432 .cindex "expansion" "statting a file"
20433 If this option is true, string expansions in Exim filters are not allowed to
20434 make use of the &%exists%& condition or the &%stat%& expansion item.
20435
20436 .option forbid_filter_logwrite redirect boolean false
20437 .cindex "restricting access to features"
20438 .cindex "filter" "locking out certain features"
20439 If this option is true, use of the logging facility in Exim filters is not
20440 permitted. Logging is in any case available only if the filter is being run
20441 under some unprivileged uid (which is normally the case for ordinary users'
20442 &_.forward_& files).
20443
20444
20445 .option forbid_filter_lookup redirect boolean false
20446 .cindex "restricting access to features"
20447 .cindex "filter" "locking out certain features"
20448 If this option is true, string expansions in Exim filter files are not allowed
20449 to make use of &%lookup%& items.
20450
20451
20452 .option forbid_filter_perl redirect boolean false
20453 .cindex "restricting access to features"
20454 .cindex "filter" "locking out certain features"
20455 This option has an effect only if Exim is built with embedded Perl support. If
20456 it is true, string expansions in Exim filter files are not allowed to make use
20457 of the embedded Perl support.
20458
20459
20460 .option forbid_filter_readfile redirect boolean false
20461 .cindex "restricting access to features"
20462 .cindex "filter" "locking out certain features"
20463 If this option is true, string expansions in Exim filter files are not allowed
20464 to make use of &%readfile%& items.
20465
20466
20467 .option forbid_filter_readsocket redirect boolean false
20468 .cindex "restricting access to features"
20469 .cindex "filter" "locking out certain features"
20470 If this option is true, string expansions in Exim filter files are not allowed
20471 to make use of &%readsocket%& items.
20472
20473
20474 .option forbid_filter_reply redirect boolean false
20475 .cindex "restricting access to features"
20476 .cindex "filter" "locking out certain features"
20477 If this option is true, this router may not generate an automatic reply
20478 message. Automatic replies can be generated only from Exim or Sieve filter
20479 files, not from traditional forward files. This option is forced to be true if
20480 &%one_time%& is set.
20481
20482
20483 .option forbid_filter_run redirect boolean false
20484 .cindex "restricting access to features"
20485 .cindex "filter" "locking out certain features"
20486 If this option is true, string expansions in Exim filter files are not allowed
20487 to make use of &%run%& items.
20488
20489
20490 .option forbid_include redirect boolean false
20491 .cindex "restricting access to features"
20492 .cindex "filter" "locking out certain features"
20493 If this option is true, items of the form
20494 .code
20495 :include:<path name>
20496 .endd
20497 are not permitted in non-filter redirection lists.
20498
20499
20500 .option forbid_pipe redirect boolean false
20501 .cindex "restricting access to features"
20502 .cindex "filter" "locking out certain features"
20503 .cindex "delivery" "to pipe; forbidding"
20504 If this option is true, this router may not generate a new address which
20505 specifies delivery to a pipe, either from an Exim filter or from a conventional
20506 forward file. This option is forced to be true if &%one_time%& is set.
20507
20508
20509 .option forbid_sieve_filter redirect boolean false
20510 .cindex "restricting access to features"
20511 .cindex "filter" "locking out certain features"
20512 If this option is set true, only Exim filters are permitted when
20513 &%allow_filter%& is true.
20514
20515
20516 .cindex "SMTP" "error codes"
20517 .option forbid_smtp_code redirect boolean false
20518 If this option is set true, any SMTP error codes that are present at the start
20519 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20520 the default codes (451 and 550, respectively) are always used.
20521
20522
20523
20524
20525 .option hide_child_in_errmsg redirect boolean false
20526 .cindex "bounce message" "redirection details; suppressing"
20527 If this option is true, it prevents Exim from quoting a child address if it
20528 generates a bounce or delay message for it. Instead it says &"an address
20529 generated from <&'the top level address'&>"&. Of course, this applies only to
20530 bounces generated locally. If a message is forwarded to another host, &'its'&
20531 bounce may well quote the generated address.
20532
20533
20534 .option ignore_eacces redirect boolean false
20535 .cindex "EACCES"
20536 If this option is set and an attempt to open a redirection file yields the
20537 EACCES error (permission denied), the &(redirect)& router behaves as if the
20538 file did not exist.
20539
20540
20541 .option ignore_enotdir redirect boolean false
20542 .cindex "ENOTDIR"
20543 If this option is set and an attempt to open a redirection file yields the
20544 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20545 router behaves as if the file did not exist.
20546
20547 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20548 router that has the &%file%& option set discovers that the file does not exist
20549 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20550 against unmounted NFS directories. If the parent can not be statted, delivery
20551 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20552 is set, because that option tells Exim to ignore &"something on the path is not
20553 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20554 that some operating systems give ENOENT where others give ENOTDIR.
20555
20556
20557
20558 .option include_directory redirect string unset
20559 If this option is set, the path names of any &':include:'& items in a
20560 redirection list must start with this directory.
20561
20562
20563 .option modemask redirect "octal integer" 022
20564 This specifies mode bits which must not be set for a file specified by the
20565 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20566
20567
20568 .option one_time redirect boolean false
20569 .cindex "one-time aliasing/forwarding expansion"
20570 .cindex "alias file" "one-time expansion"
20571 .cindex "forward file" "one-time expansion"
20572 .cindex "mailing lists" "one-time expansion"
20573 .cindex "address redirection" "one-time expansion"
20574 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20575 files each time it tries to deliver a message causes a problem when one or more
20576 of the generated addresses fails be delivered at the first attempt. The problem
20577 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20578 but of what happens when the redirection list changes during the time that the
20579 message is on Exim's queue. This is particularly true in the case of mailing
20580 lists, where new subscribers might receive copies of messages that were posted
20581 before they subscribed.
20582
20583 If &%one_time%& is set and any addresses generated by the router fail to
20584 deliver at the first attempt, the failing addresses are added to the message as
20585 &"top level"& addresses, and the parent address that generated them is marked
20586 &"delivered"&. Thus, redirection does not happen again at the next delivery
20587 attempt.
20588
20589 &*Warning 1*&: Any header line addition or removal that is specified by this
20590 router would be lost if delivery did not succeed at the first attempt. For this
20591 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20592 permitted when &%one_time%& is set.
20593
20594 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20595 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20596 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20597
20598 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20599 &%one_time%&.
20600
20601 The original top-level address is remembered with each of the generated
20602 addresses, and is output in any log messages. However, any intermediate parent
20603 addresses are not recorded. This makes a difference to the log only if
20604 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20605 typically be used for mailing lists, where there is normally just one level of
20606 expansion.
20607
20608
20609 .option owners redirect "string list" unset
20610 .cindex "ownership" "alias file"
20611 .cindex "ownership" "forward file"
20612 .cindex "alias file" "ownership"
20613 .cindex "forward file" "ownership"
20614 This specifies a list of permitted owners for the file specified by &%file%&.
20615 This list is in addition to the local user when &%check_local_user%& is set.
20616 See &%check_owner%& above.
20617
20618
20619 .option owngroups redirect "string list" unset
20620 This specifies a list of permitted groups for the file specified by &%file%&.
20621 The list is in addition to the local user's primary group when
20622 &%check_local_user%& is set. See &%check_group%& above.
20623
20624
20625 .option pipe_transport redirect string&!! unset
20626 .vindex "&$address_pipe$&"
20627 A &(redirect)& router sets up a direct delivery to a pipe when a string
20628 starting with a vertical bar character is specified as a new &"address"&. The
20629 transport used is specified by this option, which, after expansion, must be the
20630 name of a configured transport. This should normally be a &(pipe)& transport.
20631 When the transport is run, the pipe command is in &$address_pipe$&.
20632
20633
20634 .option qualify_domain redirect string&!! unset
20635 .vindex "&$qualify_recipient$&"
20636 If this option is set, and an unqualified address (one without a domain) is
20637 generated, and that address would normally be qualified by the global setting
20638 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20639 expanding this string. If the expansion fails, the router declines. If you want
20640 to revert to the default, you can have the expansion generate
20641 &$qualify_recipient$&.
20642
20643 This option applies to all unqualified addresses generated by Exim filters,
20644 but for traditional &_.forward_& files, it applies only to addresses that are
20645 not preceded by a backslash. Sieve filters cannot generate unqualified
20646 addresses.
20647
20648 .option qualify_preserve_domain redirect boolean false
20649 .cindex "domain" "in redirection; preserving"
20650 .cindex "preserving domain in redirection"
20651 .cindex "address redirection" "domain; preserving"
20652 If this option is set, the router's local &%qualify_domain%& option must not be
20653 set (a configuration error occurs if it is). If an unqualified address (one
20654 without a domain) is generated, it is qualified with the domain of the parent
20655 address (the immediately preceding ancestor) instead of the global
20656 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20657 this applies whether or not the address is preceded by a backslash.
20658
20659
20660 .option repeat_use redirect boolean true
20661 If this option is set false, the router is skipped for a child address that has
20662 any ancestor that was routed by this router. This test happens before any of
20663 the other preconditions are tested. Exim's default anti-looping rules skip
20664 only when the ancestor is the same as the current address. See also
20665 &%check_ancestor%& above and the generic &%redirect_router%& option.
20666
20667
20668 .option reply_transport redirect string&!! unset
20669 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20670 &%vacation%& command is used in a filter file. The transport used is specified
20671 by this option, which, after expansion, must be the name of a configured
20672 transport. This should normally be an &(autoreply)& transport. Other transports
20673 are unlikely to do anything sensible or useful.
20674
20675
20676 .option rewrite redirect boolean true
20677 .cindex "address redirection" "disabling rewriting"
20678 If this option is set false, addresses generated by the router are not
20679 subject to address rewriting. Otherwise, they are treated like new addresses
20680 and are rewritten according to the global rewriting rules.
20681
20682
20683 .option sieve_subaddress redirect string&!! unset
20684 The value of this option is passed to a Sieve filter to specify the
20685 :subaddress part of an address.
20686
20687 .option sieve_useraddress redirect string&!! unset
20688 The value of this option is passed to a Sieve filter to specify the :user part
20689 of an address. However, if it is unset, the entire original local part
20690 (including any prefix or suffix) is used for :user.
20691
20692
20693 .option sieve_vacation_directory redirect string&!! unset
20694 .cindex "Sieve filter" "vacation directory"
20695 To enable the &"vacation"& extension for Sieve filters, you must set
20696 &%sieve_vacation_directory%& to the directory where vacation databases are held
20697 (do not put anything else in that directory), and ensure that the
20698 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20699 needs their own directory; Exim will create it if necessary.
20700
20701
20702
20703 .option skip_syntax_errors redirect boolean false
20704 .cindex "forward file" "broken"
20705 .cindex "address redirection" "broken files"
20706 .cindex "alias file" "broken"
20707 .cindex "broken alias or forward files"
20708 .cindex "ignoring faulty addresses"
20709 .cindex "skipping faulty addresses"
20710 .cindex "error" "skipping bad syntax"
20711 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20712 non-filter redirection data are skipped, and each failing address is logged. If
20713 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20714 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20715 are expanded and placed at the head of the error message generated by
20716 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20717 be the same address as the generic &%errors_to%& option. The
20718 &%skip_syntax_errors%& option is often used when handling mailing lists.
20719
20720 If all the addresses in a redirection list are skipped because of syntax
20721 errors, the router declines to handle the original address, and it is passed to
20722 the following routers.
20723
20724 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20725 error in the filter causes filtering to be abandoned without any action being
20726 taken. The incident is logged, and the router declines to handle the address,
20727 so it is passed to the following routers.
20728
20729 .cindex "Sieve filter" "syntax errors in"
20730 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20731 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20732 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20733
20734 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20735 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20736 option, used with an address that does not get redirected, can be used to
20737 notify users of these errors, by means of a router like this:
20738 .code
20739 userforward:
20740   driver = redirect
20741   allow_filter
20742   check_local_user
20743   file = $home/.forward
20744   file_transport = address_file
20745   pipe_transport = address_pipe
20746   reply_transport = address_reply
20747   no_verify
20748   skip_syntax_errors
20749   syntax_errors_to = real-$local_part@$domain
20750   syntax_errors_text = \
20751    This is an automatically generated message. An error has\n\
20752    been found in your .forward file. Details of the error are\n\
20753    reported below. While this error persists, you will receive\n\
20754    a copy of this message for every message that is addressed\n\
20755    to you. If your .forward file is a filter file, or if it is\n\
20756    a non-filter file containing no valid forwarding addresses,\n\
20757    a copy of each incoming message will be put in your normal\n\
20758    mailbox. If a non-filter file contains at least one valid\n\
20759    forwarding address, forwarding to the valid addresses will\n\
20760    happen, and those will be the only deliveries that occur.
20761 .endd
20762 You also need a router to ensure that local addresses that are prefixed by
20763 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20764 put this immediately before the &(userforward)& router:
20765 .code
20766 real_localuser:
20767   driver = accept
20768   check_local_user
20769   local_part_prefix = real-
20770   transport = local_delivery
20771 .endd
20772 For security, it would probably be a good idea to restrict the use of this
20773 router to locally-generated messages, using a condition such as this:
20774 .code
20775   condition = ${if match {$sender_host_address}\
20776                          {\N^(|127\.0\.0\.1)$\N}}
20777 .endd
20778
20779
20780 .option syntax_errors_text redirect string&!! unset
20781 See &%skip_syntax_errors%& above.
20782
20783
20784 .option syntax_errors_to redirect string unset
20785 See &%skip_syntax_errors%& above.
20786 .ecindex IIDredrou1
20787 .ecindex IIDredrou2
20788
20789
20790
20791
20792
20793
20794 . ////////////////////////////////////////////////////////////////////////////
20795 . ////////////////////////////////////////////////////////////////////////////
20796
20797 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20798          "Environment for local transports"
20799 .scindex IIDenvlotra1 "local transports" "environment for"
20800 .scindex IIDenvlotra2 "environment" "local transports"
20801 .scindex IIDenvlotra3 "transport" "local; environment for"
20802 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20803 transport can be thought of as similar to a pipe.) Exim always runs transports
20804 in subprocesses, under specified uids and gids. Typical deliveries to local
20805 mailboxes run under the uid and gid of the local user.
20806
20807 Exim also sets a specific current directory while running the transport; for
20808 some transports a home directory setting is also relevant. The &(pipe)&
20809 transport is the only one that sets up environment variables; see section
20810 &<<SECTpipeenv>>& for details.
20811
20812 The values used for the uid, gid, and the directories may come from several
20813 different places. In many cases, the router that handles the address associates
20814 settings with that address as a result of its &%check_local_user%&, &%group%&,
20815 or &%user%& options. However, values may also be given in the transport's own
20816 configuration, and these override anything that comes from the router.
20817
20818
20819
20820 .section "Concurrent deliveries" "SECID131"
20821 .cindex "concurrent deliveries"
20822 .cindex "simultaneous deliveries"
20823 If two different messages for the same local recipient arrive more or less
20824 simultaneously, the two delivery processes are likely to run concurrently. When
20825 the &(appendfile)& transport is used to write to a file, Exim applies locking
20826 rules to stop concurrent processes from writing to the same file at the same
20827 time.
20828
20829 However, when you use a &(pipe)& transport, it is up to you to arrange any
20830 locking that is needed. Here is a silly example:
20831 .code
20832 my_transport:
20833   driver = pipe
20834   command = /bin/sh -c 'cat >>/some/file'
20835 .endd
20836 This is supposed to write the message at the end of the file. However, if two
20837 messages arrive at the same time, the file will be scrambled. You can use the
20838 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20839 file using the same algorithm that Exim itself uses.
20840
20841
20842
20843
20844 .section "Uids and gids" "SECTenvuidgid"
20845 .cindex "local transports" "uid and gid"
20846 .cindex "transport" "local; uid and gid"
20847 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20848 overrides any group that the router set in the address, even if &%user%& is not
20849 set for the transport. This makes it possible, for example, to run local mail
20850 delivery under the uid of the recipient (set by the router), but in a special
20851 group (set by the transport). For example:
20852 .code
20853 # Routers ...
20854 # User/group are set by check_local_user in this router
20855 local_users:
20856   driver = accept
20857   check_local_user
20858   transport = group_delivery
20859
20860 # Transports ...
20861 # This transport overrides the group
20862 group_delivery:
20863   driver = appendfile
20864   file = /var/spool/mail/$local_part
20865   group = mail
20866 .endd
20867 If &%user%& is set for a transport, its value overrides what is set in the
20868 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20869 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20870 set.
20871
20872 .oindex "&%initgroups%&"
20873 When the uid is taken from the transport's configuration, the &[initgroups()]&
20874 function is called for the groups associated with that uid if the
20875 &%initgroups%& option is set for the transport. When the uid is not specified
20876 by the transport, but is associated with the address by a router, the option
20877 for calling &[initgroups()]& is taken from the router configuration.
20878
20879 .cindex "&(pipe)& transport" "uid for"
20880 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20881 is set and &%user%& is not set, the uid of the process that called Exim to
20882 receive the message is used, and if &%group%& is not set, the corresponding
20883 original gid is also used.
20884
20885 This is the detailed preference order for obtaining a gid; the first of the
20886 following that is set is used:
20887
20888 .ilist
20889 A &%group%& setting of the transport;
20890 .next
20891 A &%group%& setting of the router;
20892 .next
20893 A gid associated with a user setting of the router, either as a result of
20894 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20895 .next
20896 The group associated with a non-numeric &%user%& setting of the transport;
20897 .next
20898 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20899 the uid is the creator's uid;
20900 .next
20901 The Exim gid if the Exim uid is being used as a default.
20902 .endlist
20903
20904 If, for example, the user is specified numerically on the router and there are
20905 no group settings, no gid is available. In this situation, an error occurs.
20906 This is different for the uid, for which there always is an ultimate default.
20907 The first of the following that is set is used:
20908
20909 .ilist
20910 A &%user%& setting of the transport;
20911 .next
20912 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20913 .next
20914 A &%user%& setting of the router;
20915 .next
20916 A &%check_local_user%& setting of the router;
20917 .next
20918 The Exim uid.
20919 .endlist
20920
20921 Of course, an error will still occur if the uid that is chosen is on the
20922 &%never_users%& list.
20923
20924
20925
20926
20927
20928 .section "Current and home directories" "SECID132"
20929 .cindex "current directory for local transport"
20930 .cindex "home directory" "for local transport"
20931 .cindex "transport" "local; home directory for"
20932 .cindex "transport" "local; current directory for"
20933 Routers may set current and home directories for local transports by means of
20934 the &%transport_current_directory%& and &%transport_home_directory%& options.
20935 However, if the transport's &%current_directory%& or &%home_directory%& options
20936 are set, they override the router's values. In detail, the home directory
20937 for a local transport is taken from the first of these values that is set:
20938
20939 .ilist
20940 The &%home_directory%& option on the transport;
20941 .next
20942 The &%transport_home_directory%& option on the router;
20943 .next
20944 The password data if &%check_local_user%& is set on the router;
20945 .next
20946 The &%router_home_directory%& option on the router.
20947 .endlist
20948
20949 The current directory is taken from the first of these values that is set:
20950
20951 .ilist
20952 The &%current_directory%& option on the transport;
20953 .next
20954 The &%transport_current_directory%& option on the router.
20955 .endlist
20956
20957
20958 If neither the router nor the transport sets a current directory, Exim uses the
20959 value of the home directory, if it is set. Otherwise it sets the current
20960 directory to &_/_& before running a local transport.
20961
20962
20963
20964 .section "Expansion variables derived from the address" "SECID133"
20965 .vindex "&$domain$&"
20966 .vindex "&$local_part$&"
20967 .vindex "&$original_domain$&"
20968 Normally a local delivery is handling a single address, and in that case the
20969 variables such as &$domain$& and &$local_part$& are set during local
20970 deliveries. However, in some circumstances more than one address may be handled
20971 at once (for example, while writing batch SMTP for onward transmission by some
20972 other means). In this case, the variables associated with the local part are
20973 never set, &$domain$& is set only if all the addresses have the same domain,
20974 and &$original_domain$& is never set.
20975 .ecindex IIDenvlotra1
20976 .ecindex IIDenvlotra2
20977 .ecindex IIDenvlotra3
20978
20979
20980
20981
20982
20983
20984
20985 . ////////////////////////////////////////////////////////////////////////////
20986 . ////////////////////////////////////////////////////////////////////////////
20987
20988 .chapter "Generic options for transports" "CHAPtransportgeneric"
20989 .scindex IIDgenoptra1 "generic options" "transport"
20990 .scindex IIDgenoptra2 "options" "generic; for transports"
20991 .scindex IIDgenoptra3 "transport" "generic options for"
20992 The following generic options apply to all transports:
20993
20994
20995 .option body_only transports boolean false
20996 .cindex "transport" "body only"
20997 .cindex "message" "transporting body only"
20998 .cindex "body of message" "transporting"
20999 If this option is set, the message's headers are not transported. It is
21000 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21001 or &(pipe)& transports, the settings of &%message_prefix%& and
21002 &%message_suffix%& should be checked, because this option does not
21003 automatically suppress them.
21004
21005
21006 .option current_directory transports string&!! unset
21007 .cindex "transport" "current directory for"
21008 This specifies the current directory that is to be set while running the
21009 transport, overriding any value that may have been set by the router.
21010 If the expansion fails for any reason, including forced failure, an error is
21011 logged, and delivery is deferred.
21012
21013
21014 .option disable_logging transports boolean false
21015 If this option is set true, nothing is logged for any
21016 deliveries by the transport or for any
21017 transport errors. You should not set this option unless you really, really know
21018 what you are doing.
21019
21020
21021 .option debug_print transports string&!! unset
21022 .cindex "testing" "variables in drivers"
21023 If this option is set and debugging is enabled (see the &%-d%& command line
21024 option), the string is expanded and included in the debugging output when the
21025 transport is run.
21026 If expansion of the string fails, the error message is written to the debugging
21027 output, and Exim carries on processing.
21028 This facility is provided to help with checking out the values of variables and
21029 so on when debugging driver configurations. For example, if a &%headers_add%&
21030 option is not working properly, &%debug_print%& could be used to output the
21031 variables it references. A newline is added to the text if it does not end with
21032 one.
21033 The variables &$transport_name$& and &$router_name$& contain the name of the
21034 transport and the router that called it.
21035
21036 .option delivery_date_add transports boolean false
21037 .cindex "&'Delivery-date:'& header line"
21038 If this option is true, a &'Delivery-date:'& header is added to the message.
21039 This gives the actual time the delivery was made. As this is not a standard
21040 header, Exim has a configuration option (&%delivery_date_remove%&) which
21041 requests its removal from incoming messages, so that delivered messages can
21042 safely be resent to other recipients.
21043
21044
21045 .option driver transports string unset
21046 This specifies which of the available transport drivers is to be used.
21047 There is no default, and this option must be set for every transport.
21048
21049
21050 .option envelope_to_add transports boolean false
21051 .cindex "&'Envelope-to:'& header line"
21052 If this option is true, an &'Envelope-to:'& header is added to the message.
21053 This gives the original address(es) in the incoming envelope that caused this
21054 delivery to happen. More than one address may be present if the transport is
21055 configured to handle several addresses at once, or if more than one original
21056 address was redirected to the same final address. As this is not a standard
21057 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21058 its removal from incoming messages, so that delivered messages can safely be
21059 resent to other recipients.
21060
21061
21062 .option event_action transports string&!! unset
21063 .cindex events
21064 This option declares a string to be expanded for Exim's events mechanism.
21065 For details see chapter &<<CHAPevents>>&.
21066
21067
21068 .option group transports string&!! "Exim group"
21069 .cindex "transport" "group; specifying"
21070 This option specifies a gid for running the transport process, overriding any
21071 value that the router supplies, and also overriding any value associated with
21072 &%user%& (see below).
21073
21074
21075 .option headers_add transports list&!! unset
21076 .cindex "header lines" "adding in transport"
21077 .cindex "transport" "header lines; adding"
21078 This option specifies a list of text headers,
21079 newline-separated (by default, changeable in the usual way),
21080 which are (separately) expanded and added to the header
21081 portion of a message as it is transported, as described in section
21082 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21083 routers. If the result of the expansion is an empty string, or if the expansion
21084 is forced to fail, no action is taken. Other expansion failures are treated as
21085 errors and cause the delivery to be deferred.
21086
21087 Unlike most options, &%headers_add%& can be specified multiple times
21088 for a transport; all listed headers are added.
21089
21090
21091 .option headers_only transports boolean false
21092 .cindex "transport" "header lines only"
21093 .cindex "message" "transporting headers only"
21094 .cindex "header lines" "transporting"
21095 If this option is set, the message's body is not transported. It is mutually
21096 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21097 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21098 checked, since this option does not automatically suppress them.
21099
21100
21101 .option headers_remove transports list&!! unset
21102 .cindex "header lines" "removing"
21103 .cindex "transport" "header lines; removing"
21104 This option specifies a list of header names,
21105 colon-separated (by default, changeable in the usual way);
21106 these headers are omitted from the message as it is transported, as described
21107 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21108 routers.
21109 Each list item is separately expanded.
21110 If the result of the expansion is an empty string, or if the expansion
21111 is forced to fail, no action is taken. Other expansion failures are treated as
21112 errors and cause the delivery to be deferred.
21113
21114 Unlike most options, &%headers_remove%& can be specified multiple times
21115 for a transport; all listed headers are removed.
21116
21117 &*Warning*&: Because of the separate expansion of the list items,
21118 items that contain a list separator must have it doubled.
21119 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21120
21121
21122
21123 .option headers_rewrite transports string unset
21124 .cindex "transport" "header lines; rewriting"
21125 .cindex "rewriting" "at transport time"
21126 This option allows addresses in header lines to be rewritten at transport time,
21127 that is, as the message is being copied to its destination. The contents of the
21128 option are a colon-separated list of rewriting rules. Each rule is in exactly
21129 the same form as one of the general rewriting rules that are applied when a
21130 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21131 example,
21132 .code
21133 headers_rewrite = a@b c@d f : \
21134                   x@y w@z
21135 .endd
21136 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21137 &'w@z'& in all address-bearing header lines. The rules are applied to the
21138 header lines just before they are written out at transport time, so they affect
21139 only those copies of the message that pass through the transport. However, only
21140 the message's original header lines, and any that were added by a system
21141 filter, are rewritten. If a router or transport adds header lines, they are not
21142 affected by this option. These rewriting rules are &'not'& applied to the
21143 envelope. You can change the return path using &%return_path%&, but you cannot
21144 change envelope recipients at this time.
21145
21146
21147 .option home_directory transports string&!! unset
21148 .cindex "transport" "home directory for"
21149 .vindex "&$home$&"
21150 This option specifies a home directory setting for a local transport,
21151 overriding any value that may be set by the router. The home directory is
21152 placed in &$home$& while expanding the transport's private options. It is also
21153 used as the current directory if no current directory is set by the
21154 &%current_directory%& option on the transport or the
21155 &%transport_current_directory%& option on the router. If the expansion fails
21156 for any reason, including forced failure, an error is logged, and delivery is
21157 deferred.
21158
21159
21160 .option initgroups transports boolean false
21161 .cindex "additional groups"
21162 .cindex "groups" "additional"
21163 .cindex "transport" "group; additional"
21164 If this option is true and the uid for the delivery process is provided by the
21165 transport, the &[initgroups()]& function is called when running the transport
21166 to ensure that any additional groups associated with the uid are set up.
21167
21168
21169 .option max_parallel transports integer&!! unset
21170 .cindex limit "transport parallelism"
21171 .cindex transport "parallel processes"
21172 .cindex transport "concurrency limit"
21173 .cindex "delivery" "parallelism for transport"
21174 If this option is set and expands to an integer greater than zero
21175 it limits the number of concurrent runs of the transport.
21176 The control does not apply to shadow transports.
21177
21178 .cindex "hints database" "transport concurrency control"
21179 Exim implements this control by means of a hints database in which a record is
21180 incremented whenever a transport process is being created. The record
21181 is decremented and possibly removed when the process terminates.
21182 Obviously there is scope for
21183 records to get left lying around if there is a system or program crash. To
21184 guard against this, Exim ignores any records that are more than six hours old.
21185
21186 If you use this option, you should also arrange to delete the
21187 relevant hints database whenever your system reboots. The names of the files
21188 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21189 may be one or two files, depending on the type of DBM in use. The same files
21190 are used for ETRN and smtp transport serialization.
21191
21192
21193 .option message_size_limit transports string&!! 0
21194 .cindex "limit" "message size per transport"
21195 .cindex "size" "of message, limit"
21196 .cindex "transport" "message size; limiting"
21197 This option controls the size of messages passed through the transport. It is
21198 expanded before use; the result of the expansion must be a sequence of decimal
21199 digits, optionally followed by K or M. If the expansion fails for any reason,
21200 including forced failure, or if the result is not of the required form,
21201 delivery is deferred. If the value is greater than zero and the size of a
21202 message exceeds this limit, the address is failed. If there is any chance that
21203 the resulting bounce message could be routed to the same transport, you should
21204 ensure that &%return_size_limit%& is less than the transport's
21205 &%message_size_limit%&, as otherwise the bounce message will fail to get
21206 delivered.
21207
21208
21209
21210 .option rcpt_include_affixes transports boolean false
21211 .cindex "prefix" "for local part, including in envelope"
21212 .cindex "suffix for local part" "including in envelope"
21213 .cindex "local part" "prefix"
21214 .cindex "local part" "suffix"
21215 When this option is false (the default), and an address that has had any
21216 affixes (prefixes or suffixes) removed from the local part is delivered by any
21217 form of SMTP or LMTP, the affixes are not included. For example, if a router
21218 that contains
21219 .code
21220 local_part_prefix = *-
21221 .endd
21222 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21223 is delivered with
21224 .code
21225 RCPT TO:<xyz@some.domain>
21226 .endd
21227 This is also the case when an ACL-time callout is being used to verify a
21228 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21229 whole local part is included in the RCPT command. This option applies to BSMTP
21230 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21231 &(lmtp)& and &(smtp)& transports.
21232
21233
21234 .option retry_use_local_part transports boolean "see below"
21235 .cindex "hints database" "retry keys"
21236 When a delivery suffers a temporary failure, a retry record is created
21237 in Exim's hints database. For remote deliveries, the key for the retry record
21238 is based on the name and/or IP address of the failing remote host. For local
21239 deliveries, the key is normally the entire address, including both the local
21240 part and the domain. This is suitable for most common cases of local delivery
21241 temporary failure &-- for example, exceeding a mailbox quota should delay only
21242 deliveries to that mailbox, not to the whole domain.
21243
21244 However, in some special cases you may want to treat a temporary local delivery
21245 as a failure associated with the domain, and not with a particular local part.
21246 (For example, if you are storing all mail for some domain in files.) You can do
21247 this by setting &%retry_use_local_part%& false.
21248
21249 For all the local transports, its default value is true. For remote transports,
21250 the default value is false for tidiness, but changing the value has no effect
21251 on a remote transport in the current implementation.
21252
21253
21254 .option return_path transports string&!! unset
21255 .cindex "envelope sender"
21256 .cindex "transport" "return path; changing"
21257 .cindex "return path" "changing in transport"
21258 If this option is set, the string is expanded at transport time and replaces
21259 the existing return path (envelope sender) value in the copy of the message
21260 that is being delivered. An empty return path is permitted. This feature is
21261 designed for remote deliveries, where the value of this option is used in the
21262 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21263 only effect is to change the address that is placed in the &'Return-path:'&
21264 header line, if one is added to the message (see the next option).
21265
21266 &*Note:*& A changed return path is not logged unless you add
21267 &%return_path_on_delivery%& to the log selector.
21268
21269 .vindex "&$return_path$&"
21270 The expansion can refer to the existing value via &$return_path$&. This is
21271 either the message's envelope sender, or an address set by the
21272 &%errors_to%& option on a router. If the expansion is forced to fail, no
21273 replacement occurs; if it fails for another reason, delivery is deferred. This
21274 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21275 section &<<SECTverp>>&.
21276
21277 &*Note*&: If a delivery error is detected locally, including the case when a
21278 remote server rejects a message at SMTP time, the bounce message is not sent to
21279 the value of this option. It is sent to the previously set errors address.
21280 This defaults to the incoming sender address, but can be changed by setting
21281 &%errors_to%& in a router.
21282
21283
21284
21285 .option return_path_add transports boolean false
21286 .cindex "&'Return-path:'& header line"
21287 If this option is true, a &'Return-path:'& header is added to the message.
21288 Although the return path is normally available in the prefix line of BSD
21289 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21290 have easy access to it.
21291
21292 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21293 the delivery SMTP server makes the final delivery"&. This implies that this
21294 header should not be present in incoming messages. Exim has a configuration
21295 option, &%return_path_remove%&, which requests removal of this header from
21296 incoming messages, so that delivered messages can safely be resent to other
21297 recipients.
21298
21299
21300 .option shadow_condition transports string&!! unset
21301 See &%shadow_transport%& below.
21302
21303
21304 .option shadow_transport transports string unset
21305 .cindex "shadow transport"
21306 .cindex "transport" "shadow"
21307 A local transport may set the &%shadow_transport%& option to the name of
21308 another local transport. Shadow remote transports are not supported.
21309
21310 Whenever a delivery to the main transport succeeds, and either
21311 &%shadow_condition%& is unset, or its expansion does not result in the empty
21312 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21313 passed to the shadow transport, with the same delivery address or addresses. If
21314 expansion fails, no action is taken except that non-forced expansion failures
21315 cause a log line to be written.
21316
21317 The result of the shadow transport is discarded and does not affect the
21318 subsequent processing of the message. Only a single level of shadowing is
21319 provided; the &%shadow_transport%& option is ignored on any transport when it
21320 is running as a shadow. Options concerned with output from pipes are also
21321 ignored. The log line for the successful delivery has an item added on the end,
21322 of the form
21323 .code
21324 ST=<shadow transport name>
21325 .endd
21326 If the shadow transport did not succeed, the error message is put in
21327 parentheses afterwards. Shadow transports can be used for a number of different
21328 purposes, including keeping more detailed log information than Exim normally
21329 provides, and implementing automatic acknowledgment policies based on message
21330 headers that some sites insist on.
21331
21332
21333 .option transport_filter transports string&!! unset
21334 .cindex "transport" "filter"
21335 .cindex "filter" "transport filter"
21336 This option sets up a filtering (in the Unix shell sense) process for messages
21337 at transport time. It should not be confused with mail filtering as set up by
21338 individual users or via a system filter.
21339 If unset, or expanding to an empty string, no filtering is done.
21340
21341 When the message is about to be written out, the command specified by
21342 &%transport_filter%& is started up in a separate, parallel process, and
21343 the entire message, including the header lines, is passed to it on its standard
21344 input (this in fact is done from a third process, to avoid deadlock). The
21345 command must be specified as an absolute path.
21346
21347 The lines of the message that are written to the transport filter are
21348 terminated by newline (&"\n"&). The message is passed to the filter before any
21349 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21350 lines beginning with a dot, and also before any processing implied by the
21351 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21352 &(pipe)& transports.
21353
21354 The standard error for the filter process is set to the same destination as its
21355 standard output; this is read and written to the message's ultimate
21356 destination. The process that writes the message to the filter, the
21357 filter itself, and the original process that reads the result and delivers it
21358 are all run in parallel, like a shell pipeline.
21359
21360 The filter can perform any transformations it likes, but of course should take
21361 care not to break RFC 2822 syntax. Exim does not check the result, except to
21362 test for a final newline when SMTP is in use. All messages transmitted over
21363 SMTP must end with a newline, so Exim supplies one if it is missing.
21364
21365 .cindex "content scanning" "per user"
21366 A transport filter can be used to provide content-scanning on a per-user basis
21367 at delivery time if the only required effect of the scan is to modify the
21368 message. For example, a content scan could insert a new header line containing
21369 a spam score. This could be interpreted by a filter in the user's MUA. It is
21370 not possible to discard a message at this stage.
21371
21372 .cindex "SMTP" "SIZE"
21373 A problem might arise if the filter increases the size of a message that is
21374 being sent down an SMTP connection. If the receiving SMTP server has indicated
21375 support for the SIZE parameter, Exim will have sent the size of the message
21376 at the start of the SMTP session. If what is actually sent is substantially
21377 more, the server might reject the message. This can be worked round by setting
21378 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21379 additions to the message, or to disable the use of SIZE altogether.
21380
21381 .vindex "&$pipe_addresses$&"
21382 The value of the &%transport_filter%& option is the command string for starting
21383 the filter, which is run directly from Exim, not under a shell. The string is
21384 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21385 Exim breaks it up into arguments and then expands each argument separately (see
21386 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21387 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21388 of arguments, one for each address that applies to this delivery. (This isn't
21389 an ideal name for this feature here, but as it was already implemented for the
21390 &(pipe)& transport, it seemed sensible not to change it.)
21391
21392 .vindex "&$host$&"
21393 .vindex "&$host_address$&"
21394 The expansion variables &$host$& and &$host_address$& are available when the
21395 transport is a remote one. They contain the name and IP address of the host to
21396 which the message is being sent. For example:
21397 .code
21398 transport_filter = /some/directory/transport-filter.pl \
21399   $host $host_address $sender_address $pipe_addresses
21400 .endd
21401
21402 Two problems arise if you want to use more complicated expansion items to
21403 generate transport filter commands, both of which due to the fact that the
21404 command is split up &'before'& expansion.
21405 .ilist
21406 If an expansion item contains white space, you must quote it, so that it is all
21407 part of the same command item. If the entire option setting is one such
21408 expansion item, you have to take care what kind of quoting you use. For
21409 example:
21410 .code
21411 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21412 .endd
21413 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21414 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21415 stripped by Exim when it read the option's value. When the value is used, if
21416 the single quotes were missing, the line would be split into two items,
21417 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21418 Exim tried to expand the first one.
21419 .next
21420 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21421 expansion cannot generate multiple arguments, or a command name followed by
21422 arguments. Consider this example:
21423 .code
21424 transport_filter = ${lookup{$host}lsearch{/a/file}\
21425                     {$value}{/bin/cat}}
21426 .endd
21427 The result of the lookup is interpreted as the name of the command, even
21428 if it contains white space. The simplest way round this is to use a shell:
21429 .code
21430 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21431                                {$value}{/bin/cat}}
21432 .endd
21433 .endlist
21434
21435 The filter process is run under the same uid and gid as the normal delivery.
21436 For remote deliveries this is the Exim uid/gid by default. The command should
21437 normally yield a zero return code. Transport filters are not supposed to fail.
21438 A non-zero code is taken to mean that the transport filter encountered some
21439 serious problem. Delivery of the message is deferred; the message remains on
21440 the queue and is tried again later. It is not possible to cause a message to be
21441 bounced from a transport filter.
21442
21443 If a transport filter is set on an autoreply transport, the original message is
21444 passed through the filter as it is being copied into the newly generated
21445 message, which happens if the &%return_message%& option is set.
21446
21447
21448 .option transport_filter_timeout transports time 5m
21449 .cindex "transport" "filter, timeout"
21450 When Exim is reading the output of a transport filter, it applies a timeout
21451 that can be set by this option. Exceeding the timeout is normally treated as a
21452 temporary delivery failure. However, if a transport filter is used with a
21453 &(pipe)& transport, a timeout in the transport filter is treated in the same
21454 way as a timeout in the pipe command itself. By default, a timeout is a hard
21455 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21456 becomes a temporary error.
21457
21458
21459 .option user transports string&!! "Exim user"
21460 .cindex "uid (user id)" "local delivery"
21461 .cindex "transport" "user, specifying"
21462 This option specifies the user under whose uid the delivery process is to be
21463 run, overriding any uid that may have been set by the router. If the user is
21464 given as a name, the uid is looked up from the password data, and the
21465 associated group is taken as the value of the gid to be used if the &%group%&
21466 option is not set.
21467
21468 For deliveries that use local transports, a user and group are normally
21469 specified explicitly or implicitly (for example, as a result of
21470 &%check_local_user%&) by the router or transport.
21471
21472 .cindex "hints database" "access by remote transport"
21473 For remote transports, you should leave this option unset unless you really are
21474 sure you know what you are doing. When a remote transport is running, it needs
21475 to be able to access Exim's hints databases, because each host may have its own
21476 retry data.
21477 .ecindex IIDgenoptra1
21478 .ecindex IIDgenoptra2
21479 .ecindex IIDgenoptra3
21480
21481
21482
21483
21484
21485
21486 . ////////////////////////////////////////////////////////////////////////////
21487 . ////////////////////////////////////////////////////////////////////////////
21488
21489 .chapter "Address batching in local transports" "CHAPbatching" &&&
21490          "Address batching"
21491 .cindex "transport" "local; address batching in"
21492 The only remote transport (&(smtp)&) is normally configured to handle more than
21493 one address at a time, so that when several addresses are routed to the same
21494 remote host, just one copy of the message is sent. Local transports, however,
21495 normally handle one address at a time. That is, a separate instance of the
21496 transport is run for each address that is routed to the transport. A separate
21497 copy of the message is delivered each time.
21498
21499 .cindex "batched local delivery"
21500 .oindex "&%batch_max%&"
21501 .oindex "&%batch_id%&"
21502 In special cases, it may be desirable to handle several addresses at once in a
21503 local transport, for example:
21504
21505 .ilist
21506 In an &(appendfile)& transport, when storing messages in files for later
21507 delivery by some other means, a single copy of the message with multiple
21508 recipients saves space.
21509 .next
21510 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21511 a single copy saves time, and is the normal way LMTP is expected to work.
21512 .next
21513 In a &(pipe)& transport, when passing the message
21514 to a scanner program or
21515 to some other delivery mechanism such as UUCP, multiple recipients may be
21516 acceptable.
21517 .endlist
21518
21519 These three local transports all have the same options for controlling multiple
21520 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21521 repeating the information for each transport, these options are described here.
21522
21523 The &%batch_max%& option specifies the maximum number of addresses that can be
21524 delivered together in a single run of the transport. Its default value is one
21525 (no batching). When more than one address is routed to a transport that has a
21526 &%batch_max%& value greater than one, the addresses are delivered in a batch
21527 (that is, in a single run of the transport with multiple recipients), subject
21528 to certain conditions:
21529
21530 .ilist
21531 .vindex "&$local_part$&"
21532 If any of the transport's options contain a reference to &$local_part$&, no
21533 batching is possible.
21534 .next
21535 .vindex "&$domain$&"
21536 If any of the transport's options contain a reference to &$domain$&, only
21537 addresses with the same domain are batched.
21538 .next
21539 .cindex "customizing" "batching condition"
21540 If &%batch_id%& is set, it is expanded for each address, and only those
21541 addresses with the same expanded value are batched. This allows you to specify
21542 customized batching conditions. Failure of the expansion for any reason,
21543 including forced failure, disables batching, but it does not stop the delivery
21544 from taking place.
21545 .next
21546 Batched addresses must also have the same errors address (where to send
21547 delivery errors), the same header additions and removals, the same user and
21548 group for the transport, and if a host list is present, the first host must
21549 be the same.
21550 .endlist
21551
21552 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21553 both when the file or pipe command is specified in the transport, and when it
21554 is specified by a &(redirect)& router, but all the batched addresses must of
21555 course be routed to the same file or pipe command. These two transports have an
21556 option called &%use_bsmtp%&, which causes them to deliver the message in
21557 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21558 &%check_string%& and &%escape_string%& options are forced to the values
21559 .code
21560 check_string = "."
21561 escape_string = ".."
21562 .endd
21563 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21564 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21565 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21566
21567 .cindex "&'Envelope-to:'& header line"
21568 If the generic &%envelope_to_add%& option is set for a batching transport, the
21569 &'Envelope-to:'& header that is added to the message contains all the addresses
21570 that are being processed together. If you are using a batching &(appendfile)&
21571 transport without &%use_bsmtp%&, the only way to preserve the recipient
21572 addresses is to set the &%envelope_to_add%& option.
21573
21574 .cindex "&(pipe)& transport" "with multiple addresses"
21575 .vindex "&$pipe_addresses$&"
21576 If you are using a &(pipe)& transport without BSMTP, and setting the
21577 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21578 the command. This is not a true variable; it is a bit of magic that causes each
21579 of the recipient addresses to be inserted into the command as a separate
21580 argument. This provides a way of accessing all the addresses that are being
21581 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21582 are specified by a &(redirect)& router.
21583
21584
21585
21586
21587 . ////////////////////////////////////////////////////////////////////////////
21588 . ////////////////////////////////////////////////////////////////////////////
21589
21590 .chapter "The appendfile transport" "CHAPappendfile"
21591 .scindex IIDapptra1 "&(appendfile)& transport"
21592 .scindex IIDapptra2 "transports" "&(appendfile)&"
21593 .cindex "directory creation"
21594 .cindex "creating directories"
21595 The &(appendfile)& transport delivers a message by appending it to an existing
21596 file, or by creating an entirely new file in a specified directory. Single
21597 files to which messages are appended can be in the traditional Unix mailbox
21598 format, or optionally in the MBX format supported by the Pine MUA and
21599 University of Washington IMAP daemon, &'inter alia'&. When each message is
21600 being delivered as a separate file, &"maildir"& format can optionally be used
21601 to give added protection against failures that happen part-way through the
21602 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21603 supported. For all file formats, Exim attempts to create as many levels of
21604 directory as necessary, provided that &%create_directory%& is set.
21605
21606 The code for the optional formats is not included in the Exim binary by
21607 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21608 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21609 included.
21610
21611 .cindex "quota" "system"
21612 Exim recognizes system quota errors, and generates an appropriate message. Exim
21613 also supports its own quota control within the transport, for use when the
21614 system facility is unavailable or cannot be used for some reason.
21615
21616 If there is an error while appending to a file (for example, quota exceeded or
21617 partition filled), Exim attempts to reset the file's length and last
21618 modification time back to what they were before. If there is an error while
21619 creating an entirely new file, the new file is removed.
21620
21621 Before appending to a file, a number of security checks are made, and the
21622 file is locked. A detailed description is given below, after the list of
21623 private options.
21624
21625 The &(appendfile)& transport is most commonly used for local deliveries to
21626 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21627 putting messages into files for remote delivery by some means other than Exim.
21628 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21629 option).
21630
21631
21632
21633 .section "The file and directory options" "SECTfildiropt"
21634 The &%file%& option specifies a single file, to which the message is appended;
21635 the &%directory%& option specifies a directory, in which a new file containing
21636 the message is created. Only one of these two options can be set, and for
21637 normal deliveries to mailboxes, one of them &'must'& be set.
21638
21639 .vindex "&$address_file$&"
21640 .vindex "&$local_part$&"
21641 However, &(appendfile)& is also used for delivering messages to files or
21642 directories whose names (or parts of names) are obtained from alias,
21643 forwarding, or filtering operations (for example, a &%save%& command in a
21644 user's Exim filter). When such a transport is running, &$local_part$& contains
21645 the local part that was aliased or forwarded, and &$address_file$& contains the
21646 name (or partial name) of the file or directory generated by the redirection
21647 operation. There are two cases:
21648
21649 .ilist
21650 If neither &%file%& nor &%directory%& is set, the redirection operation
21651 must specify an absolute path (one that begins with &`/`&). This is the most
21652 common case when users with local accounts use filtering to sort mail into
21653 different folders. See for example, the &(address_file)& transport in the
21654 default configuration. If the path ends with a slash, it is assumed to be the
21655 name of a directory. A delivery to a directory can also be forced by setting
21656 &%maildir_format%& or &%mailstore_format%&.
21657 .next
21658 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21659 used to determine the file or directory name for the delivery. Normally, the
21660 contents of &$address_file$& are used in some way in the string expansion.
21661 .endlist
21662
21663
21664 .cindex "Sieve filter" "configuring &(appendfile)&"
21665 .cindex "Sieve filter" "relative mailbox path handling"
21666 As an example of the second case, consider an environment where users do not
21667 have home directories. They may be permitted to use Exim filter commands of the
21668 form:
21669 .code
21670 save folder23
21671 .endd
21672 or Sieve filter commands of the form:
21673 .code
21674 require "fileinto";
21675 fileinto "folder23";
21676 .endd
21677 In this situation, the expansion of &%file%& or &%directory%& in the transport
21678 must transform the relative path into an appropriate absolute file name. In the
21679 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21680 is used as a result of a &"keep"& action in the filter. This example shows one
21681 way of handling this requirement:
21682 .code
21683 file = ${if eq{$address_file}{inbox} \
21684             {/var/mail/$local_part} \
21685             {${if eq{${substr_0_1:$address_file}}{/} \
21686                   {$address_file} \
21687                   {$home/mail/$address_file} \
21688             }} \
21689        }
21690 .endd
21691 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21692 location, absolute paths are used without change, and other folders are in the
21693 &_mail_& directory within the home directory.
21694
21695 &*Note 1*&: While processing an Exim filter, a relative path such as
21696 &_folder23_& is turned into an absolute path if a home directory is known to
21697 the router. In particular, this is the case if &%check_local_user%& is set. If
21698 you want to prevent this happening at routing time, you can set
21699 &%router_home_directory%& empty. This forces the router to pass the relative
21700 path to the transport.
21701
21702 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21703 the &%file%& or &%directory%& option is still used if it is set.
21704
21705
21706
21707
21708 .section "Private options for appendfile" "SECID134"
21709 .cindex "options" "&(appendfile)& transport"
21710
21711
21712
21713 .option allow_fifo appendfile boolean false
21714 .cindex "fifo (named pipe)"
21715 .cindex "named pipe (fifo)"
21716 .cindex "pipe" "named (fifo)"
21717 Setting this option permits delivery to named pipes (FIFOs) as well as to
21718 regular files. If no process is reading the named pipe at delivery time, the
21719 delivery is deferred.
21720
21721
21722 .option allow_symlink appendfile boolean false
21723 .cindex "symbolic link" "to mailbox"
21724 .cindex "mailbox" "symbolic link"
21725 By default, &(appendfile)& will not deliver if the path name for the file is
21726 that of a symbolic link. Setting this option relaxes that constraint, but there
21727 are security issues involved in the use of symbolic links. Be sure you know
21728 what you are doing if you set this. Details of exactly what this option affects
21729 are included in the discussion which follows this list of options.
21730
21731
21732 .option batch_id appendfile string&!! unset
21733 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21734 However, batching is automatically disabled for &(appendfile)& deliveries that
21735 happen as a result of forwarding or aliasing or other redirection directly to a
21736 file.
21737
21738
21739 .option batch_max appendfile integer 1
21740 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21741
21742
21743 .option check_group appendfile boolean false
21744 When this option is set, the group owner of the file defined by the &%file%&
21745 option is checked to see that it is the same as the group under which the
21746 delivery process is running. The default setting is false because the default
21747 file mode is 0600, which means that the group is irrelevant.
21748
21749
21750 .option check_owner appendfile boolean true
21751 When this option is set, the owner of the file defined by the &%file%& option
21752 is checked to ensure that it is the same as the user under which the delivery
21753 process is running.
21754
21755
21756 .option check_string appendfile string "see below"
21757 .cindex "&""From""& line"
21758 As &(appendfile)& writes the message, the start of each line is tested for
21759 matching &%check_string%&, and if it does, the initial matching characters are
21760 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21761 a literal string, not a regular expression, and the case of any letters it
21762 contains is significant.
21763
21764 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21765 are forced to &"."& and &".."& respectively, and any settings in the
21766 configuration are ignored. Otherwise, they default to &"From&~"& and
21767 &">From&~"& when the &%file%& option is set, and unset when any of the
21768 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21769
21770 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21771 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21772 &"From&~"& indicates the start of a new message. All four options need changing
21773 if another format is used. For example, to deliver to mailboxes in MMDF format:
21774 .cindex "MMDF format mailbox"
21775 .cindex "mailbox" "MMDF format"
21776 .code
21777 check_string = "\1\1\1\1\n"
21778 escape_string = "\1\1\1\1 \n"
21779 message_prefix = "\1\1\1\1\n"
21780 message_suffix = "\1\1\1\1\n"
21781 .endd
21782 .option create_directory appendfile boolean true
21783 .cindex "directory creation"
21784 When this option is true, Exim attempts to create any missing superior
21785 directories for the file that it is about to write. A created directory's mode
21786 is given by the &%directory_mode%& option.
21787
21788 The group ownership of a newly created directory is highly dependent on the
21789 operating system (and possibly the file system) that is being used. For
21790 example, in Solaris, if the parent directory has the setgid bit set, its group
21791 is propagated to the child; if not, the currently set group is used. However,
21792 in FreeBSD, the parent's group is always used.
21793
21794
21795
21796 .option create_file appendfile string anywhere
21797 This option constrains the location of files and directories that are created
21798 by this transport. It applies to files defined by the &%file%& option and
21799 directories defined by the &%directory%& option. In the case of maildir
21800 delivery, it applies to the top level directory, not the maildir directories
21801 beneath.
21802
21803 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21804 &"belowhome"&. In the second and third cases, a home directory must have been
21805 set for the transport. This option is not useful when an explicit file name is
21806 given for normal mailbox deliveries. It is intended for the case when file
21807 names are generated from users' &_.forward_& files. These are usually handled
21808 by an &(appendfile)& transport called &%address_file%&. See also
21809 &%file_must_exist%&.
21810
21811
21812 .option directory appendfile string&!! unset
21813 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21814 or &%directory%& must be set, unless the delivery is the direct result of a
21815 redirection (see section &<<SECTfildiropt>>&).
21816
21817 When &%directory%& is set, the string is expanded, and the message is delivered
21818 into a new file or files in or below the given directory, instead of being
21819 appended to a single mailbox file. A number of different formats are provided
21820 (see &%maildir_format%& and &%mailstore_format%&), and see section
21821 &<<SECTopdir>>& for further details of this form of delivery.
21822
21823
21824 .option directory_file appendfile string&!! "see below"
21825 .cindex "base62"
21826 .vindex "&$inode$&"
21827 When &%directory%& is set, but neither &%maildir_format%& nor
21828 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21829 whose name is obtained by expanding this string. The default value is:
21830 .code
21831 q${base62:$tod_epoch}-$inode
21832 .endd
21833 This generates a unique name from the current time, in base 62 form, and the
21834 inode of the file. The variable &$inode$& is available only when expanding this
21835 option.
21836
21837
21838 .option directory_mode appendfile "octal integer" 0700
21839 If &(appendfile)& creates any directories as a result of the
21840 &%create_directory%& option, their mode is specified by this option.
21841
21842
21843 .option escape_string appendfile string "see description"
21844 See &%check_string%& above.
21845
21846
21847 .option file appendfile string&!! unset
21848 This option is mutually exclusive with the &%directory%& option, but one of
21849 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21850 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21851 specifies a single file, to which the message is appended. One or more of
21852 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21853 &%file%&.
21854
21855 .cindex "NFS" "lock file"
21856 .cindex "locking files"
21857 .cindex "lock files"
21858 If you are using more than one host to deliver over NFS into the same
21859 mailboxes, you should always use lock files.
21860
21861 The string value is expanded for each delivery, and must yield an absolute
21862 path. The most common settings of this option are variations on one of these
21863 examples:
21864 .code
21865 file = /var/spool/mail/$local_part
21866 file = /home/$local_part/inbox
21867 file = $home/inbox
21868 .endd
21869 .cindex "&""sticky""& bit"
21870 In the first example, all deliveries are done into the same directory. If Exim
21871 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21872 create a file in the directory, so the &"sticky"& bit must be turned on for
21873 deliveries to be possible, or alternatively the &%group%& option can be used to
21874 run the delivery under a group id which has write access to the directory.
21875
21876
21877
21878 .option file_format appendfile string unset
21879 .cindex "file" "mailbox; checking existing format"
21880 This option requests the transport to check the format of an existing file
21881 before adding to it. The check consists of matching a specific string at the
21882 start of the file. The value of the option consists of an even number of
21883 colon-separated strings. The first of each pair is the test string, and the
21884 second is the name of a transport. If the transport associated with a matched
21885 string is not the current transport, control is passed over to the other
21886 transport. For example, suppose the standard &(local_delivery)& transport has
21887 this added to it:
21888 .code
21889 file_format = "From       : local_delivery :\
21890                \1\1\1\1\n : local_mmdf_delivery"
21891 .endd
21892 Mailboxes that begin with &"From"& are still handled by this transport, but if
21893 a mailbox begins with four binary ones followed by a newline, control is passed
21894 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21895 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21896 is assumed to match the current transport. If the start of a mailbox doesn't
21897 match any string, or if the transport named for a given string is not defined,
21898 delivery is deferred.
21899
21900
21901 .option file_must_exist appendfile boolean false
21902 If this option is true, the file specified by the &%file%& option must exist.
21903 A temporary error occurs if it does not, causing delivery to be deferred.
21904 If this option is false, the file is created if it does not exist.
21905
21906
21907 .option lock_fcntl_timeout appendfile time 0s
21908 .cindex "timeout" "mailbox locking"
21909 .cindex "mailbox" "locking, blocking and non-blocking"
21910 .cindex "locking files"
21911 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21912 when locking an open mailbox file. If the call fails, the delivery process
21913 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21914 Non-blocking calls are used so that the file is not kept open during the wait
21915 for the lock; the reason for this is to make it as safe as possible for
21916 deliveries over NFS in the case when processes might be accessing an NFS
21917 mailbox without using a lock file. This should not be done, but
21918 misunderstandings and hence misconfigurations are not unknown.
21919
21920 On a busy system, however, the performance of a non-blocking lock approach is
21921 not as good as using a blocking lock with a timeout. In this case, the waiting
21922 is done inside the system call, and Exim's delivery process acquires the lock
21923 and can proceed as soon as the previous lock holder releases it.
21924
21925 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21926 timeout, are used. There may still be some retrying: the maximum number of
21927 retries is
21928 .code
21929 (lock_retries * lock_interval) / lock_fcntl_timeout
21930 .endd
21931 rounded up to the next whole number. In other words, the total time during
21932 which &(appendfile)& is trying to get a lock is roughly the same, unless
21933 &%lock_fcntl_timeout%& is set very large.
21934
21935 You should consider setting this option if you are getting a lot of delayed
21936 local deliveries because of errors of the form
21937 .code
21938 failed to lock mailbox /some/file (fcntl)
21939 .endd
21940
21941 .option lock_flock_timeout appendfile time 0s
21942 This timeout applies to file locking when using &[flock()]& (see
21943 &%use_flock%&); the timeout operates in a similar manner to
21944 &%lock_fcntl_timeout%&.
21945
21946
21947 .option lock_interval appendfile time 3s
21948 This specifies the time to wait between attempts to lock the file. See below
21949 for details of locking.
21950
21951
21952 .option lock_retries appendfile integer 10
21953 This specifies the maximum number of attempts to lock the file. A value of zero
21954 is treated as 1. See below for details of locking.
21955
21956
21957 .option lockfile_mode appendfile "octal integer" 0600
21958 This specifies the mode of the created lock file, when a lock file is being
21959 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21960
21961
21962 .option lockfile_timeout appendfile time 30m
21963 .cindex "timeout" "mailbox locking"
21964 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21965 exists and is older than this value, it is assumed to have been left behind by
21966 accident, and Exim attempts to remove it.
21967
21968
21969 .option mailbox_filecount appendfile string&!! unset
21970 .cindex "mailbox" "specifying size of"
21971 .cindex "size" "of mailbox"
21972 If this option is set, it is expanded, and the result is taken as the current
21973 number of files in the mailbox. It must be a decimal number, optionally
21974 followed by K or M. This provides a way of obtaining this information from an
21975 external source that maintains the data.
21976
21977
21978 .option mailbox_size appendfile string&!! unset
21979 .cindex "mailbox" "specifying size of"
21980 .cindex "size" "of mailbox"
21981 If this option is set, it is expanded, and the result is taken as the current
21982 size the mailbox. It must be a decimal number, optionally followed by K or M.
21983 This provides a way of obtaining this information from an external source that
21984 maintains the data. This is likely to be helpful for maildir deliveries where
21985 it is computationally expensive to compute the size of a mailbox.
21986
21987
21988
21989 .option maildir_format appendfile boolean false
21990 .cindex "maildir format" "specifying"
21991 If this option is set with the &%directory%& option, the delivery is into a new
21992 file, in the &"maildir"& format that is used by other mail software. When the
21993 transport is activated directly from a &(redirect)& router (for example, the
21994 &(address_file)& transport in the default configuration), setting
21995 &%maildir_format%& causes the path received from the router to be treated as a
21996 directory, whether or not it ends with &`/`&. This option is available only if
21997 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21998 &<<SECTmaildirdelivery>>& below for further details.
21999
22000
22001 .option maildir_quota_directory_regex appendfile string "See below"
22002 .cindex "maildir format" "quota; directories included in"
22003 .cindex "quota" "maildir; directories included in"
22004 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22005 a regular expression for specifying directories, relative to the quota
22006 directory (see &%quota_directory%&), that should be included in the quota
22007 calculation. The default value is:
22008 .code
22009 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22010 .endd
22011 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22012 (directories whose names begin with a dot). If you want to exclude the
22013 &_Trash_&
22014 folder from the count (as some sites do), you need to change this setting to
22015 .code
22016 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22017 .endd
22018 This uses a negative lookahead in the regular expression to exclude the
22019 directory whose name is &_.Trash_&. When a directory is excluded from quota
22020 calculations, quota processing is bypassed for any messages that are delivered
22021 directly into that directory.
22022
22023
22024 .option maildir_retries appendfile integer 10
22025 This option specifies the number of times to retry when writing a file in
22026 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22027
22028
22029 .option maildir_tag appendfile string&!! unset
22030 This option applies only to deliveries in maildir format, and is described in
22031 section &<<SECTmaildirdelivery>>& below.
22032
22033
22034 .option maildir_use_size_file appendfile&!! boolean false
22035 .cindex "maildir format" "&_maildirsize_& file"
22036 The result of string expansion for this option must be a valid boolean value.
22037 If it is true, it enables support for &_maildirsize_& files. Exim
22038 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22039 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22040 value is zero. See &%maildir_quota_directory_regex%& above and section
22041 &<<SECTmaildirdelivery>>& below for further details.
22042
22043 .option maildirfolder_create_regex appendfile string unset
22044 .cindex "maildir format" "&_maildirfolder_& file"
22045 .cindex "&_maildirfolder_&, creating"
22046 The value of this option is a regular expression. If it is unset, it has no
22047 effect. Otherwise, before a maildir delivery takes place, the pattern is
22048 matched against the name of the maildir directory, that is, the directory
22049 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22050 delivery. If there is a match, Exim checks for the existence of a file called
22051 &_maildirfolder_& in the directory, and creates it if it does not exist.
22052 See section &<<SECTmaildirdelivery>>& for more details.
22053
22054
22055 .option mailstore_format appendfile boolean false
22056 .cindex "mailstore format" "specifying"
22057 If this option is set with the &%directory%& option, the delivery is into two
22058 new files in  &"mailstore"& format. The option is available only if
22059 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22060 below for further details.
22061
22062
22063 .option mailstore_prefix appendfile string&!! unset
22064 This option applies only to deliveries in mailstore format, and is described in
22065 section &<<SECTopdir>>& below.
22066
22067
22068 .option mailstore_suffix appendfile string&!! unset
22069 This option applies only to deliveries in mailstore format, and is described in
22070 section &<<SECTopdir>>& below.
22071
22072
22073 .option mbx_format appendfile boolean false
22074 .cindex "locking files"
22075 .cindex "file" "locking"
22076 .cindex "file" "MBX format"
22077 .cindex "MBX format, specifying"
22078 This option is available only if Exim has been compiled with SUPPORT_MBX
22079 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22080 the message is appended to the mailbox file in MBX format instead of
22081 traditional Unix format. This format is supported by Pine4 and its associated
22082 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22083
22084 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22085 automatically changed by the use of &%mbx_format%&. They should normally be set
22086 empty when using MBX format, so this option almost always appears in this
22087 combination:
22088 .code
22089 mbx_format = true
22090 message_prefix =
22091 message_suffix =
22092 .endd
22093 If none of the locking options are mentioned in the configuration,
22094 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22095 is possible to specify the other kinds of locking with &%mbx_format%&, but
22096 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22097 interworks with &'c-client'&, providing for shared access to the mailbox. It
22098 should not be used if any program that does not use this form of locking is
22099 going to access the mailbox, nor should it be used if the mailbox file is NFS
22100 mounted, because it works only when the mailbox is accessed from a single host.
22101
22102 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22103 the standard version of &'c-client'&, because as long as it has a mailbox open
22104 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22105 append messages to it.
22106
22107
22108 .option message_prefix appendfile string&!! "see below"
22109 .cindex "&""From""& line"
22110 The string specified here is expanded and output at the start of every message.
22111 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22112 in which case it is:
22113 .code
22114 message_prefix = "From ${if def:return_path{$return_path}\
22115   {MAILER-DAEMON}} $tod_bsdinbox\n"
22116 .endd
22117 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22118 &`\n`& to &`\r\n`& in &%message_prefix%&.
22119
22120 .option message_suffix appendfile string&!! "see below"
22121 The string specified here is expanded and output at the end of every message.
22122 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22123 in which case it is a single newline character. The suffix can be suppressed by
22124 setting
22125 .code
22126 message_suffix =
22127 .endd
22128 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22129 &`\n`& to &`\r\n`& in &%message_suffix%&.
22130
22131 .option mode appendfile "octal integer" 0600
22132 If the output file is created, it is given this mode. If it already exists and
22133 has wider permissions, they are reduced to this mode. If it has narrower
22134 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22135 if the delivery is the result of a &%save%& command in a filter file specifying
22136 a particular mode, the mode of the output file is always forced to take that
22137 value, and this option is ignored.
22138
22139
22140 .option mode_fail_narrower appendfile boolean true
22141 This option applies in the case when an existing mailbox file has a narrower
22142 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22143 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22144 continues with the delivery attempt, using the existing mode of the file.
22145
22146
22147 .option notify_comsat appendfile boolean false
22148 If this option is true, the &'comsat'& daemon is notified after every
22149 successful delivery to a user mailbox. This is the daemon that notifies logged
22150 on users about incoming mail.
22151
22152
22153 .option quota appendfile string&!! unset
22154 .cindex "quota" "imposed by Exim"
22155 This option imposes a limit on the size of the file to which Exim is appending,
22156 or to the total space used in the directory tree when the &%directory%& option
22157 is set. In the latter case, computation of the space used is expensive, because
22158 all the files in the directory (and any sub-directories) have to be
22159 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22160 &%maildir_use_size_file%& for ways to avoid this in environments where users
22161 have no shell access to their mailboxes).
22162
22163 As there is no interlock against two simultaneous deliveries into a
22164 multi-file mailbox, it is possible for the quota to be overrun in this case.
22165 For single-file mailboxes, of course, an interlock is a necessity.
22166
22167 A file's size is taken as its &'used'& value. Because of blocking effects, this
22168 may be a lot less than the actual amount of disk space allocated to the file.
22169 If the sizes of a number of files are being added up, the rounding effect can
22170 become quite noticeable, especially on systems that have large block sizes.
22171 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22172 the obvious value which users understand most easily.
22173
22174 The value of the option is expanded, and must then be a numerical value
22175 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22176 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22177 and further option modifiers. If Exim is running on a system with
22178 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22179 be handled.
22180
22181 The option modifier &%no_check%& can be used to force delivery even if the over
22182 quota condition is met. The quota gets updated as usual.
22183
22184 &*Note*&: A value of zero is interpreted as &"no quota"&.
22185
22186 The expansion happens while Exim is running as root, before it changes uid for
22187 the delivery. This means that files that are inaccessible to the end user can
22188 be used to hold quota values that are looked up in the expansion. When delivery
22189 fails because this quota is exceeded, the handling of the error is as for
22190 system quota failures.
22191
22192 By default, Exim's quota checking mimics system quotas, and restricts the
22193 mailbox to the specified maximum size, though the value is not accurate to the
22194 last byte, owing to separator lines and additional headers that may get added
22195 during message delivery. When a mailbox is nearly full, large messages may get
22196 refused even though small ones are accepted, because the size of the current
22197 message is added to the quota when the check is made. This behaviour can be
22198 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22199 for exceeding the quota does not include the current message. Thus, deliveries
22200 continue until the quota has been exceeded; thereafter, no further messages are
22201 delivered. See also &%quota_warn_threshold%&.
22202
22203
22204 .option quota_directory appendfile string&!! unset
22205 This option defines the directory to check for quota purposes when delivering
22206 into individual files. The default is the delivery directory, or, if a file
22207 called &_maildirfolder_& exists in a maildir directory, the parent of the
22208 delivery directory.
22209
22210
22211 .option quota_filecount appendfile string&!! 0
22212 This option applies when the &%directory%& option is set. It limits the total
22213 number of files in the directory (compare the inode limit in system quotas). It
22214 can only be used if &%quota%& is also set. The value is expanded; an expansion
22215 failure causes delivery to be deferred. A value of zero is interpreted as
22216 &"no quota"&.
22217
22218 The option modifier &%no_check%& can be used to force delivery even if the over
22219 quota condition is met. The quota gets updated as usual.
22220
22221 .option quota_is_inclusive appendfile boolean true
22222 See &%quota%& above.
22223
22224
22225 .option quota_size_regex appendfile string unset
22226 This option applies when one of the delivery modes that writes a separate file
22227 for each message is being used. When Exim wants to find the size of one of
22228 these files in order to test the quota, it first checks &%quota_size_regex%&.
22229 If this is set to a regular expression that matches the file name, and it
22230 captures one string, that string is interpreted as a representation of the
22231 file's size. The value of &%quota_size_regex%& is not expanded.
22232
22233 This feature is useful only when users have no shell access to their mailboxes
22234 &-- otherwise they could defeat the quota simply by renaming the files. This
22235 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22236 the file length to the file name. For example:
22237 .code
22238 maildir_tag = ,S=$message_size
22239 quota_size_regex = ,S=(\d+)
22240 .endd
22241 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22242 number of lines in the message.
22243
22244 The regular expression should not assume that the length is at the end of the
22245 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22246 sometimes add other information onto the ends of message file names.
22247
22248 Section &<<SECID136>>& contains further information.
22249
22250
22251 .option quota_warn_message appendfile string&!! "see below"
22252 See below for the use of this option. If it is not set when
22253 &%quota_warn_threshold%& is set, it defaults to
22254 .code
22255 quota_warn_message = "\
22256   To: $local_part@$domain\n\
22257   Subject: Your mailbox\n\n\
22258   This message is automatically created \
22259   by mail delivery software.\n\n\
22260   The size of your mailbox has exceeded \
22261   a warning threshold that is\n\
22262   set by the system administrator.\n"
22263 .endd
22264
22265
22266 .option quota_warn_threshold appendfile string&!! 0
22267 .cindex "quota" "warning threshold"
22268 .cindex "mailbox" "size warning"
22269 .cindex "size" "of mailbox"
22270 This option is expanded in the same way as &%quota%& (see above). If the
22271 resulting value is greater than zero, and delivery of the message causes the
22272 size of the file or total space in the directory tree to cross the given
22273 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22274 may be specified as a percentage of it by following the value with a percent
22275 sign. For example:
22276 .code
22277 quota = 10M
22278 quota_warn_threshold = 75%
22279 .endd
22280 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22281 percent sign is ignored.
22282
22283 The warning message itself is specified by the &%quota_warn_message%& option,
22284 and it must start with a &'To:'& header line containing the recipient(s) of the
22285 warning message. These do not necessarily have to include the recipient(s) of
22286 the original message. A &'Subject:'& line should also normally be supplied. You
22287 can include any other header lines that you want. If you do not include a
22288 &'From:'& line, the default is:
22289 .code
22290 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22291 .endd
22292 .oindex &%errors_reply_to%&
22293 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22294 option.
22295
22296 The &%quota%& option does not have to be set in order to use this option; they
22297 are independent of one another except when the threshold is specified as a
22298 percentage.
22299
22300
22301 .option use_bsmtp appendfile boolean false
22302 .cindex "envelope sender"
22303 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22304 format, with the envelope sender and recipient(s) included as SMTP commands. If
22305 you want to include a leading HELO command with such messages, you can do
22306 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22307 for details of batch SMTP.
22308
22309
22310 .option use_crlf appendfile boolean false
22311 .cindex "carriage return"
22312 .cindex "linefeed"
22313 This option causes lines to be terminated with the two-character CRLF sequence
22314 (carriage return, linefeed) instead of just a linefeed character. In the case
22315 of batched SMTP, the byte sequence written to the file is then an exact image
22316 of what would be sent down a real SMTP connection.
22317
22318 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22319 (which are used to supply the traditional &"From&~"& and blank line separators
22320 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22321 carriage return characters if these are needed. In cases where these options
22322 have non-empty defaults, the values end with a single linefeed, so they must be
22323 changed to end with &`\r\n`& if &%use_crlf%& is set.
22324
22325
22326 .option use_fcntl_lock appendfile boolean "see below"
22327 This option controls the use of the &[fcntl()]& function to lock a file for
22328 exclusive use when a message is being appended. It is set by default unless
22329 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22330 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22331 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22332
22333
22334 .option use_flock_lock appendfile boolean false
22335 This option is provided to support the use of &[flock()]& for file locking, for
22336 the few situations where it is needed. Most modern operating systems support
22337 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22338 each other. Exim uses &[fcntl()]& locking by default.
22339
22340 This option is required only if you are using an operating system where
22341 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22342 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22343 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22344
22345 .cindex "Solaris" "&[flock()]& support"
22346 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22347 have it (and some, I think, provide a not quite right version built on top of
22348 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22349 the ability to use it, and any attempt to do so will cause a configuration
22350 error.
22351
22352 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22353 is just being mapped onto &[fcntl()]& by the OS).
22354
22355
22356 .option use_lockfile appendfile boolean "see below"
22357 If this option is turned off, Exim does not attempt to create a lock file when
22358 appending to a mailbox file. In this situation, the only locking is by
22359 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22360 sure that every MUA that is ever going to look at your users' mailboxes uses
22361 &[fcntl()]& rather than a lock file, and even then only when you are not
22362 delivering over NFS from more than one host.
22363
22364 .cindex "NFS" "lock file"
22365 In order to append to an NFS file safely from more than one host, it is
22366 necessary to take out a lock &'before'& opening the file, and the lock file
22367 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22368 file corruption.
22369
22370 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22371 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22372 except when &%mbx_format%& is set.
22373
22374
22375 .option use_mbx_lock appendfile boolean "see below"
22376 This option is available only if Exim has been compiled with SUPPORT_MBX
22377 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22378 locking rules be used. It is set by default if &%mbx_format%& is set and none
22379 of the locking options are mentioned in the configuration. The locking rules
22380 are the same as are used by the &'c-client'& library that underlies Pine and
22381 the IMAP4 and POP daemons that come with it (see the discussion below). The
22382 rules allow for shared access to the mailbox. However, this kind of locking
22383 does not work when the mailbox is NFS mounted.
22384
22385 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22386 &%use_flock_lock%& to control what kind of locking is used in implementing the
22387 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22388 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22389
22390
22391
22392
22393 .section "Operational details for appending" "SECTopappend"
22394 .cindex "appending to a file"
22395 .cindex "file" "appending"
22396 Before appending to a file, the following preparations are made:
22397
22398 .ilist
22399 If the name of the file is &_/dev/null_&, no action is taken, and a success
22400 return is given.
22401
22402 .next
22403 .cindex "directory creation"
22404 If any directories on the file's path are missing, Exim creates them if the
22405 &%create_directory%& option is set. A created directory's mode is given by the
22406 &%directory_mode%& option.
22407
22408 .next
22409 If &%file_format%& is set, the format of an existing file is checked. If this
22410 indicates that a different transport should be used, control is passed to that
22411 transport.
22412
22413 .next
22414 .cindex "file" "locking"
22415 .cindex "locking files"
22416 .cindex "NFS" "lock file"
22417 If &%use_lockfile%& is set, a lock file is built in a way that will work
22418 reliably over NFS, as follows:
22419
22420 .olist
22421 Create a &"hitching post"& file whose name is that of the lock file with the
22422 current time, primary host name, and process id added, by opening for writing
22423 as a new file. If this fails with an access error, delivery is deferred.
22424 .next
22425 Close the hitching post file, and hard link it to the lock file name.
22426 .next
22427 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22428 Unlink the hitching post name.
22429 .next
22430 Otherwise, use &[stat()]& to get information about the hitching post file, and
22431 then unlink hitching post name. If the number of links is exactly two, creation
22432 of the lock file succeeded but something (for example, an NFS server crash and
22433 restart) caused this fact not to be communicated to the &[link()]& call.
22434 .next
22435 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22436 up to &%lock_retries%& times. However, since any program that writes to a
22437 mailbox should complete its task very quickly, it is reasonable to time out old
22438 lock files that are normally the result of user agent and system crashes. If an
22439 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22440 it before trying again.
22441 .endlist olist
22442
22443 .next
22444 A call is made to &[lstat()]& to discover whether the main file exists, and if
22445 so, what its characteristics are. If &[lstat()]& fails for any reason other
22446 than non-existence, delivery is deferred.
22447
22448 .next
22449 .cindex "symbolic link" "to mailbox"
22450 .cindex "mailbox" "symbolic link"
22451 If the file does exist and is a symbolic link, delivery is deferred, unless the
22452 &%allow_symlink%& option is set, in which case the ownership of the link is
22453 checked, and then &[stat()]& is called to find out about the real file, which
22454 is then subjected to the checks below. The check on the top-level link
22455 ownership prevents one user creating a link for another's mailbox in a sticky
22456 directory, though allowing symbolic links in this case is definitely not a good
22457 idea. If there is a chain of symbolic links, the intermediate ones are not
22458 checked.
22459
22460 .next
22461 If the file already exists but is not a regular file, or if the file's owner
22462 and group (if the group is being checked &-- see &%check_group%& above) are
22463 different from the user and group under which the delivery is running,
22464 delivery is deferred.
22465
22466 .next
22467 If the file's permissions are more generous than specified, they are reduced.
22468 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22469 is set false, in which case the delivery is tried using the existing
22470 permissions.
22471
22472 .next
22473 The file's inode number is saved, and the file is then opened for appending.
22474 If this fails because the file has vanished, &(appendfile)& behaves as if it
22475 hadn't existed (see below). For any other failures, delivery is deferred.
22476
22477 .next
22478 If the file is opened successfully, check that the inode number hasn't
22479 changed, that it is still a regular file, and that the owner and permissions
22480 have not changed. If anything is wrong, defer delivery and freeze the message.
22481
22482 .next
22483 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22484 option is set. Otherwise, check that the file is being created in a permitted
22485 directory if the &%create_file%& option is set (deferring on failure), and then
22486 open for writing as a new file, with the O_EXCL and O_CREAT options,
22487 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22488 set). In this case, which can happen if the link points to a non-existent file,
22489 the file is opened for writing using O_CREAT but not O_EXCL, because
22490 that prevents link following.
22491
22492 .next
22493 .cindex "loop" "while file testing"
22494 If opening fails because the file exists, obey the tests given above for
22495 existing files. However, to avoid looping in a situation where the file is
22496 being continuously created and destroyed, the exists/not-exists loop is broken
22497 after 10 repetitions, and the message is then frozen.
22498
22499 .next
22500 If opening fails with any other error, defer delivery.
22501
22502 .next
22503 .cindex "file" "locking"
22504 .cindex "locking files"
22505 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22506 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22507 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22508 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22509 file, and an exclusive lock on the file whose name is
22510 .code
22511 /tmp/.<device-number>.<inode-number>
22512 .endd
22513 using the device and inode numbers of the open mailbox file, in accordance with
22514 the MBX locking rules. This file is created with a mode that is specified by
22515 the &%lockfile_mode%& option.
22516
22517 If Exim fails to lock the file, there are two possible courses of action,
22518 depending on the value of the locking timeout. This is obtained from
22519 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22520
22521 If the timeout value is zero, the file is closed, Exim waits for
22522 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22523 to lock it again. This happens up to &%lock_retries%& times, after which the
22524 delivery is deferred.
22525
22526 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22527 &[flock()]& are used (with the given timeout), so there has already been some
22528 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22529 immediately. It retries up to
22530 .code
22531 (lock_retries * lock_interval) / <timeout>
22532 .endd
22533 times (rounded up).
22534 .endlist
22535
22536 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22537 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22538
22539
22540 .section "Operational details for delivery to a new file" "SECTopdir"
22541 .cindex "delivery" "to single file"
22542 .cindex "&""From""& line"
22543 When the &%directory%& option is set instead of &%file%&, each message is
22544 delivered into a newly-created file or set of files. When &(appendfile)& is
22545 activated directly from a &(redirect)& router, neither &%file%& nor
22546 &%directory%& is normally set, because the path for delivery is supplied by the
22547 router. (See for example, the &(address_file)& transport in the default
22548 configuration.) In this case, delivery is to a new file if either the path name
22549 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22550
22551 No locking is required while writing the message to a new file, so the various
22552 locking options of the transport are ignored. The &"From"& line that by default
22553 separates messages in a single file is not normally needed, nor is the escaping
22554 of message lines that start with &"From"&, and there is no need to ensure a
22555 newline at the end of each message. Consequently, the default values for
22556 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22557 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22558
22559 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22560 the files in the delivery directory by default. However, you can specify a
22561 different directory by setting &%quota_directory%&. Also, for maildir
22562 deliveries (see below) the &_maildirfolder_& convention is honoured.
22563
22564
22565 .cindex "maildir format"
22566 .cindex "mailstore format"
22567 There are three different ways in which delivery to individual files can be
22568 done, controlled by the settings of the &%maildir_format%& and
22569 &%mailstore_format%& options. Note that code to support maildir or mailstore
22570 formats is not included in the binary unless SUPPORT_MAILDIR or
22571 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22572
22573 .cindex "directory creation"
22574 In all three cases an attempt is made to create the directory and any necessary
22575 sub-directories if they do not exist, provided that the &%create_directory%&
22576 option is set (the default). The location of a created directory can be
22577 constrained by setting &%create_file%&. A created directory's mode is given by
22578 the &%directory_mode%& option. If creation fails, or if the
22579 &%create_directory%& option is not set when creation is required, delivery is
22580 deferred.
22581
22582
22583
22584 .section "Maildir delivery" "SECTmaildirdelivery"
22585 .cindex "maildir format" "description of"
22586 If the &%maildir_format%& option is true, Exim delivers each message by writing
22587 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22588 directory that is defined by the &%directory%& option (the &"delivery
22589 directory"&). If the delivery is successful, the file is renamed into the
22590 &_new_& subdirectory.
22591
22592 In the file name, <&'stime'&> is the current time of day in seconds, and
22593 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22594 Exim checks that the time-of-day clock has moved on by at least one microsecond
22595 before terminating the delivery process. This guarantees uniqueness for the
22596 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22597 opening it. If any response other than ENOENT (does not exist) is given,
22598 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22599
22600 Before Exim carries out a maildir delivery, it ensures that subdirectories
22601 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22602 do not exist, Exim tries to create them and any superior directories in their
22603 path, subject to the &%create_directory%& and &%create_file%& options. If the
22604 &%maildirfolder_create_regex%& option is set, and the regular expression it
22605 contains matches the delivery directory, Exim also ensures that a file called
22606 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22607 &_maildirfolder_& file cannot be created, delivery is deferred.
22608
22609 These features make it possible to use Exim to create all the necessary files
22610 and directories in a maildir mailbox, including subdirectories for maildir++
22611 folders. Consider this example:
22612 .code
22613 maildir_format = true
22614 directory = /var/mail/$local_part\
22615            ${if eq{$local_part_suffix}{}{}\
22616            {/.${substr_1:$local_part_suffix}}}
22617 maildirfolder_create_regex = /\.[^/]+$
22618 .endd
22619 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22620 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22621 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22622 not match this name, so Exim will not look for or create the file
22623 &_/var/mail/pimbo/maildirfolder_&, though it will create
22624 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22625
22626 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22627 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22628 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22629 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22630 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22631
22632 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22633 not inadvertently match the toplevel maildir directory, because a
22634 &_maildirfolder_& file at top level would completely break quota calculations.
22635
22636 .cindex "quota" "in maildir delivery"
22637 .cindex "maildir++"
22638 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22639 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22640 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22641 Exim assumes the directory is a maildir++ folder directory, which is one level
22642 down from the user's top level mailbox directory. This causes it to start at
22643 the parent directory instead of the current directory when calculating the
22644 amount of space used.
22645
22646 One problem with delivering into a multi-file mailbox is that it is
22647 computationally expensive to compute the size of the mailbox for quota
22648 checking. Various approaches have been taken to reduce the amount of work
22649 needed. The next two sections describe two of them. A third alternative is to
22650 use some external process for maintaining the size data, and use the expansion
22651 of the &%mailbox_size%& option as a way of importing it into Exim.
22652
22653
22654
22655
22656 .section "Using tags to record message sizes" "SECID135"
22657 If &%maildir_tag%& is set, the string is expanded for each delivery.
22658 When the maildir file is renamed into the &_new_& sub-directory, the
22659 tag is added to its name. However, if adding the tag takes the length of the
22660 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22661 the tag is dropped and the maildir file is created with no tag.
22662
22663
22664 .vindex "&$message_size$&"
22665 Tags can be used to encode the size of files in their names; see
22666 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22667 happens after the message has been written. The value of the &$message_size$&
22668 variable is set to the number of bytes actually written. If the expansion is
22669 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22670 be deferred. The expanded tag may contain any printing characters except &"/"&.
22671 Non-printing characters in the string are ignored; if the resulting string is
22672 empty, it is ignored. If it starts with an alphanumeric character, a leading
22673 colon is inserted; this default has not proven to be the path that popular
22674 maildir implementations have chosen (but changing it in Exim would break
22675 backwards compatibility).
22676
22677 For one common implementation, you might set:
22678 .code
22679 maildir_tag = ,S=${message_size}
22680 .endd
22681 but you should check the documentation of the other software to be sure.
22682
22683 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22684 as this allows Exim to extract the size from your tag, instead of having to
22685 &[stat()]& each message file.
22686
22687
22688 .section "Using a maildirsize file" "SECID136"
22689 .cindex "quota" "in maildir delivery"
22690 .cindex "maildir format" "&_maildirsize_& file"
22691 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22692 storing quota and message size information in a file called &_maildirsize_&
22693 within the toplevel maildir directory. If this file does not exist, Exim
22694 creates it, setting the quota from the &%quota%& option of the transport. If
22695 the maildir directory itself does not exist, it is created before any attempt
22696 to write a &_maildirsize_& file.
22697
22698 The &_maildirsize_& file is used to hold information about the sizes of
22699 messages in the maildir, thus speeding up quota calculations. The quota value
22700 in the file is just a cache; if the quota is changed in the transport, the new
22701 value overrides the cached value when the next message is delivered. The cache
22702 is maintained for the benefit of other programs that access the maildir and
22703 need to know the quota.
22704
22705 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22706 file is maintained (with a zero quota setting), but no quota is imposed.
22707
22708 A regular expression is available for controlling which directories in the
22709 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22710 See the description of the &%maildir_quota_directory_regex%& option above for
22711 details.
22712
22713
22714 .section "Mailstore delivery" "SECID137"
22715 .cindex "mailstore format" "description of"
22716 If the &%mailstore_format%& option is true, each message is written as two
22717 files in the given directory. A unique base name is constructed from the
22718 message id and the current delivery process, and the files that are written use
22719 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22720 contains the message's envelope, and the &_.msg_& file contains the message
22721 itself. The base name is placed in the variable &$mailstore_basename$&.
22722
22723 During delivery, the envelope is first written to a file with the suffix
22724 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22725 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22726 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22727 file before accessing either of them. An alternative approach is to wait for
22728 the absence of a &_.tmp_& file.
22729
22730 The envelope file starts with any text defined by the &%mailstore_prefix%&
22731 option, expanded and terminated by a newline if there isn't one. Then follows
22732 the sender address on one line, then all the recipient addresses, one per line.
22733 There can be more than one recipient only if the &%batch_max%& option is set
22734 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22735 appended to the file, followed by a newline if it does not end with one.
22736
22737 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22738 failure, it is ignored. Other expansion errors are treated as serious
22739 configuration errors, and delivery is deferred. The variable
22740 &$mailstore_basename$& is available for use during these expansions.
22741
22742
22743 .section "Non-special new file delivery" "SECID138"
22744 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22745 file is created directly in the named directory. For example, when delivering
22746 messages into files in batched SMTP format for later delivery to some host (see
22747 section &<<SECTbatchSMTP>>&), a setting such as
22748 .code
22749 directory = /var/bsmtp/$host
22750 .endd
22751 might be used. A message is written to a file with a temporary name, which is
22752 then renamed when the delivery is complete. The final name is obtained by
22753 expanding the contents of the &%directory_file%& option.
22754 .ecindex IIDapptra1
22755 .ecindex IIDapptra2
22756
22757
22758
22759
22760
22761
22762 . ////////////////////////////////////////////////////////////////////////////
22763 . ////////////////////////////////////////////////////////////////////////////
22764
22765 .chapter "The autoreply transport" "CHID8"
22766 .scindex IIDauttra1 "transports" "&(autoreply)&"
22767 .scindex IIDauttra2 "&(autoreply)& transport"
22768 The &(autoreply)& transport is not a true transport in that it does not cause
22769 the message to be transmitted. Instead, it generates a new mail message as an
22770 automatic reply to the incoming message. &'References:'& and
22771 &'Auto-Submitted:'& header lines are included. These are constructed according
22772 to the rules in RFCs 2822 and 3834, respectively.
22773
22774 If the router that passes the message to this transport does not have the
22775 &%unseen%& option set, the original message (for the current recipient) is not
22776 delivered anywhere. However, when the &%unseen%& option is set on the router
22777 that passes the message to this transport, routing of the address continues, so
22778 another router can set up a normal message delivery.
22779
22780
22781 The &(autoreply)& transport is usually run as the result of mail filtering, a
22782 &"vacation"& message being the standard example. However, it can also be run
22783 directly from a router like any other transport. To reduce the possibility of
22784 message cascades, messages created by the &(autoreply)& transport always have
22785 empty envelope sender addresses, like bounce messages.
22786
22787 The parameters of the message to be sent can be specified in the configuration
22788 by options described below. However, these are used only when the address
22789 passed to the transport does not contain its own reply information. When the
22790 transport is run as a consequence of a
22791 &%mail%&
22792 or &%vacation%& command in a filter file, the parameters of the message are
22793 supplied by the filter, and passed with the address. The transport's options
22794 that define the message are then ignored (so they are not usually set in this
22795 case). The message is specified entirely by the filter or by the transport; it
22796 is never built from a mixture of options. However, the &%file_optional%&,
22797 &%mode%&, and &%return_message%& options apply in all cases.
22798
22799 &(Autoreply)& is implemented as a local transport. When used as a result of a
22800 command in a user's filter file, &(autoreply)& normally runs under the uid and
22801 gid of the user, and with appropriate current and home directories (see chapter
22802 &<<CHAPenvironment>>&).
22803
22804 There is a subtle difference between routing a message to a &(pipe)& transport
22805 that generates some text to be returned to the sender, and routing it to an
22806 &(autoreply)& transport. This difference is noticeable only if more than one
22807 address from the same message is so handled. In the case of a pipe, the
22808 separate outputs from the different addresses are gathered up and returned to
22809 the sender in a single message, whereas if &(autoreply)& is used, a separate
22810 message is generated for each address that is passed to it.
22811
22812 Non-printing characters are not permitted in the header lines generated for the
22813 message that &(autoreply)& creates, with the exception of newlines that are
22814 immediately followed by white space. If any non-printing characters are found,
22815 the transport defers.
22816 Whether characters with the top bit set count as printing characters or not is
22817 controlled by the &%print_topbitchars%& global option.
22818
22819 If any of the generic options for manipulating headers (for example,
22820 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22821 of the original message that is included in the generated message when
22822 &%return_message%& is set. They do not apply to the generated message itself.
22823
22824 .vindex "&$sender_address$&"
22825 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22826 the message, indicating that there were no recipients, it does not treat this
22827 as an error. This means that autoreplies sent to &$sender_address$& when this
22828 is empty (because the incoming message is a bounce message) do not cause
22829 problems. They are just discarded.
22830
22831
22832
22833 .section "Private options for autoreply" "SECID139"
22834 .cindex "options" "&(autoreply)& transport"
22835
22836 .option bcc autoreply string&!! unset
22837 This specifies the addresses that are to receive &"blind carbon copies"& of the
22838 message when the message is specified by the transport.
22839
22840
22841 .option cc autoreply string&!! unset
22842 This specifies recipients of the message and the contents of the &'Cc:'& header
22843 when the message is specified by the transport.
22844
22845
22846 .option file autoreply string&!! unset
22847 The contents of the file are sent as the body of the message when the message
22848 is specified by the transport. If both &%file%& and &%text%& are set, the text
22849 string comes first.
22850
22851
22852 .option file_expand autoreply boolean false
22853 If this is set, the contents of the file named by the &%file%& option are
22854 subjected to string expansion as they are added to the message.
22855
22856
22857 .option file_optional autoreply boolean false
22858 If this option is true, no error is generated if the file named by the &%file%&
22859 option or passed with the address does not exist or cannot be read.
22860
22861
22862 .option from autoreply string&!! unset
22863 This specifies the contents of the &'From:'& header when the message is
22864 specified by the transport.
22865
22866
22867 .option headers autoreply string&!! unset
22868 This specifies additional RFC 2822 headers that are to be added to the message
22869 when the message is specified by the transport. Several can be given by using
22870 &"\n"& to separate them. There is no check on the format.
22871
22872
22873 .option log autoreply string&!! unset
22874 This option names a file in which a record of every message sent is logged when
22875 the message is specified by the transport.
22876
22877
22878 .option mode autoreply "octal integer" 0600
22879 If either the log file or the &"once"& file has to be created, this mode is
22880 used.
22881
22882
22883 .option never_mail autoreply "address list&!!" unset
22884 If any run of the transport creates a message with a recipient that matches any
22885 item in the list, that recipient is quietly discarded. If all recipients are
22886 discarded, no message is created. This applies both when the recipients are
22887 generated by a filter and when they are specified in the transport.
22888
22889
22890
22891 .option once autoreply string&!! unset
22892 This option names a file or DBM database in which a record of each &'To:'&
22893 recipient is kept when the message is specified by the transport. &*Note*&:
22894 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22895
22896 If &%once%& is unset, or is set to an empty string, the message is always sent.
22897 By default, if &%once%& is set to a non-empty file name, the message
22898 is not sent if a potential recipient is already listed in the database.
22899 However, if the &%once_repeat%& option specifies a time greater than zero, the
22900 message is sent if that much time has elapsed since a message was last sent to
22901 this recipient. A setting of zero time for &%once_repeat%& (the default)
22902 prevents a message from being sent a second time &-- in this case, zero means
22903 infinity.
22904
22905 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22906 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22907 greater than zero, it changes the way Exim implements the &%once%& option.
22908 Instead of using a DBM file to record every recipient it sends to, it uses a
22909 regular file, whose size will never get larger than the given value.
22910
22911 In the file, Exim keeps a linear list of recipient addresses and the times at
22912 which they were sent messages. If the file is full when a new address needs to
22913 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22914 means that a given recipient may receive multiple messages, but at
22915 unpredictable intervals that depend on the rate of turnover of addresses in the
22916 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22917
22918
22919 .option once_file_size autoreply integer 0
22920 See &%once%& above.
22921
22922
22923 .option once_repeat autoreply time&!! 0s
22924 See &%once%& above.
22925 After expansion, the value of this option must be a valid time value.
22926
22927
22928 .option reply_to autoreply string&!! unset
22929 This specifies the contents of the &'Reply-To:'& header when the message is
22930 specified by the transport.
22931
22932
22933 .option return_message autoreply boolean false
22934 If this is set, a copy of the original message is returned with the new
22935 message, subject to the maximum size set in the &%return_size_limit%& global
22936 configuration option.
22937
22938
22939 .option subject autoreply string&!! unset
22940 This specifies the contents of the &'Subject:'& header when the message is
22941 specified by the transport. It is tempting to quote the original subject in
22942 automatic responses. For example:
22943 .code
22944 subject = Re: $h_subject:
22945 .endd
22946 There is a danger in doing this, however. It may allow a third party to
22947 subscribe your users to an opt-in mailing list, provided that the list accepts
22948 bounce messages as subscription confirmations. Well-managed lists require a
22949 non-bounce message to confirm a subscription, so the danger is relatively
22950 small.
22951
22952
22953
22954 .option text autoreply string&!! unset
22955 This specifies a single string to be used as the body of the message when the
22956 message is specified by the transport. If both &%text%& and &%file%& are set,
22957 the text comes first.
22958
22959
22960 .option to autoreply string&!! unset
22961 This specifies recipients of the message and the contents of the &'To:'& header
22962 when the message is specified by the transport.
22963 .ecindex IIDauttra1
22964 .ecindex IIDauttra2
22965
22966
22967
22968
22969 . ////////////////////////////////////////////////////////////////////////////
22970 . ////////////////////////////////////////////////////////////////////////////
22971
22972 .chapter "The lmtp transport" "CHAPLMTP"
22973 .cindex "transports" "&(lmtp)&"
22974 .cindex "&(lmtp)& transport"
22975 .cindex "LMTP" "over a pipe"
22976 .cindex "LMTP" "over a socket"
22977 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22978 specified command
22979 or by interacting with a Unix domain socket.
22980 This transport is something of a cross between the &(pipe)& and &(smtp)&
22981 transports. Exim also has support for using LMTP over TCP/IP; this is
22982 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22983 to be of minority interest, the default build-time configure in &_src/EDITME_&
22984 has it commented out. You need to ensure that
22985 .code
22986 TRANSPORT_LMTP=yes
22987 .endd
22988 .cindex "options" "&(lmtp)& transport"
22989 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22990 included in the Exim binary. The private options of the &(lmtp)& transport are
22991 as follows:
22992
22993 .option batch_id lmtp string&!! unset
22994 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22995
22996
22997 .option batch_max lmtp integer 1
22998 This limits the number of addresses that can be handled in a single delivery.
22999 Most LMTP servers can handle several addresses at once, so it is normally a
23000 good idea to increase this value. See the description of local delivery
23001 batching in chapter &<<CHAPbatching>>&.
23002
23003
23004 .option command lmtp string&!! unset
23005 This option must be set if &%socket%& is not set. The string is a command which
23006 is run in a separate process. It is split up into a command name and list of
23007 arguments, each of which is separately expanded (so expansion cannot change the
23008 number of arguments). The command is run directly, not via a shell. The message
23009 is passed to the new process using the standard input and output to operate the
23010 LMTP protocol.
23011
23012 .option ignore_quota lmtp boolean false
23013 .cindex "LMTP" "ignoring quota errors"
23014 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23015 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23016 in its response to the LHLO command.
23017
23018 .option socket lmtp string&!! unset
23019 This option must be set if &%command%& is not set. The result of expansion must
23020 be the name of a Unix domain socket. The transport connects to the socket and
23021 delivers the message to it using the LMTP protocol.
23022
23023
23024 .option timeout lmtp time 5m
23025 The transport is aborted if the created process or Unix domain socket does not
23026 respond to LMTP commands or message input within this timeout. Delivery
23027 is deferred, and will be tried again later. Here is an example of a typical
23028 LMTP transport:
23029 .code
23030 lmtp:
23031   driver = lmtp
23032   command = /some/local/lmtp/delivery/program
23033   batch_max = 20
23034   user = exim
23035 .endd
23036 This delivers up to 20 addresses at a time, in a mixture of domains if
23037 necessary, running as the user &'exim'&.
23038
23039
23040
23041 . ////////////////////////////////////////////////////////////////////////////
23042 . ////////////////////////////////////////////////////////////////////////////
23043
23044 .chapter "The pipe transport" "CHAPpipetransport"
23045 .scindex IIDpiptra1 "transports" "&(pipe)&"
23046 .scindex IIDpiptra2 "&(pipe)& transport"
23047 The &(pipe)& transport is used to deliver messages via a pipe to a command
23048 running in another process. One example is the use of &(pipe)& as a
23049 pseudo-remote transport for passing messages to some other delivery mechanism
23050 (such as UUCP). Another is the use by individual users to automatically process
23051 their incoming messages. The &(pipe)& transport can be used in one of the
23052 following ways:
23053
23054 .ilist
23055 .vindex "&$local_part$&"
23056 A router routes one address to a transport in the normal way, and the
23057 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23058 contains the local part of the address (as usual), and the command that is run
23059 is specified by the &%command%& option on the transport.
23060 .next
23061 .vindex "&$pipe_addresses$&"
23062 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23063 transport can handle more than one address in a single run. In this case, when
23064 more than one address is routed to the transport, &$local_part$& is not set
23065 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23066 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23067 that are routed to the transport.
23068 .next
23069 .vindex "&$address_pipe$&"
23070 A router redirects an address directly to a pipe command (for example, from an
23071 alias or forward file). In this case, &$address_pipe$& contains the text of the
23072 pipe command, and the &%command%& option on the transport is ignored unless
23073 &%force_command%& is set. If only one address is being transported
23074 (&%batch_max%& is not greater than one, or only one address was redirected to
23075 this pipe command), &$local_part$& contains the local part that was redirected.
23076 .endlist
23077
23078
23079 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23080 deliver messages over pipes using the LMTP interactive protocol. This is
23081 implemented by the &(lmtp)& transport.
23082
23083 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23084 &_.forward_& file, the command runs under the uid and gid of that user. In
23085 other cases, the uid and gid have to be specified explicitly, either on the
23086 transport or on the router that handles the address. Current and &"home"&
23087 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23088 details of the local delivery environment and chapter &<<CHAPbatching>>&
23089 for a discussion of local delivery batching.
23090
23091
23092 .section "Concurrent delivery" "SECID140"
23093 If two messages arrive at almost the same time, and both are routed to a pipe
23094 delivery, the two pipe transports may be run concurrently. You must ensure that
23095 any pipe commands you set up are robust against this happening. If the commands
23096 write to a file, the &%exim_lock%& utility might be of use.
23097 Alternatively the &%max_parallel%& option could be used with a value
23098 of "1" to enforce serialization.
23099
23100
23101
23102
23103 .section "Returned status and data" "SECID141"
23104 .cindex "&(pipe)& transport" "returned data"
23105 If the command exits with a non-zero return code, the delivery is deemed to
23106 have failed, unless either the &%ignore_status%& option is set (in which case
23107 the return code is treated as zero), or the return code is one of those listed
23108 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23109 later"&. In this case, delivery is deferred. Details of a permanent failure are
23110 logged, but are not included in the bounce message, which merely contains
23111 &"local delivery failed"&.
23112
23113 If the command exits on a signal and the &%freeze_signal%& option is set then
23114 the message will be frozen in the queue. If that option is not set, a bounce
23115 will be sent as normal.
23116
23117 If the return code is greater than 128 and the command being run is a shell
23118 script, it normally means that the script was terminated by a signal whose
23119 value is the return code minus 128. The &%freeze_signal%& option does not
23120 apply in this case.
23121
23122 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23123 return code is set to 127. This is the value that a shell returns if it is
23124 asked to run a non-existent command. The wording for the log line suggests that
23125 a non-existent command may be the problem.
23126
23127 The &%return_output%& option can affect the result of a pipe delivery. If it is
23128 set and the command produces any output on its standard output or standard
23129 error streams, the command is considered to have failed, even if it gave a zero
23130 return code or if &%ignore_status%& is set. The output from the command is
23131 included as part of the bounce message. The &%return_fail_output%& option is
23132 similar, except that output is returned only when the command exits with a
23133 failure return code, that is, a value other than zero or a code that matches
23134 &%temp_errors%&.
23135
23136
23137
23138 .section "How the command is run" "SECThowcommandrun"
23139 .cindex "&(pipe)& transport" "path for command"
23140 The command line is (by default) broken down into a command name and arguments
23141 by the &(pipe)& transport itself. The &%allow_commands%& and
23142 &%restrict_to_path%& options can be used to restrict the commands that may be
23143 run.
23144
23145 .cindex "quoting" "in pipe command"
23146 Unquoted arguments are delimited by white space. If an argument appears in
23147 double quotes, backslash is interpreted as an escape character in the usual
23148 way. If an argument appears in single quotes, no escaping is done.
23149
23150 String expansion is applied to the command line except when it comes from a
23151 traditional &_.forward_& file (commands from a filter file are expanded). The
23152 expansion is applied to each argument in turn rather than to the whole line.
23153 For this reason, any string expansion item that contains white space must be
23154 quoted so as to be contained within a single argument. A setting such as
23155 .code
23156 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23157 .endd
23158 will not work, because the expansion item gets split between several
23159 arguments. You have to write
23160 .code
23161 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23162 .endd
23163 to ensure that it is all in one argument. The expansion is done in this way,
23164 argument by argument, so that the number of arguments cannot be changed as a
23165 result of expansion, and quotes or backslashes in inserted variables do not
23166 interact with external quoting. However, this leads to problems if you want to
23167 generate multiple arguments (or the command name plus arguments) from a single
23168 expansion. In this situation, the simplest solution is to use a shell. For
23169 example:
23170 .code
23171 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23172 .endd
23173
23174 .cindex "transport" "filter"
23175 .cindex "filter" "transport filter"
23176 .vindex "&$pipe_addresses$&"
23177 Special handling takes place when an argument consists of precisely the text
23178 &`$pipe_addresses`&. This is not a general expansion variable; the only
23179 place this string is recognized is when it appears as an argument for a pipe or
23180 transport filter command. It causes each address that is being handled to be
23181 inserted in the argument list at that point &'as a separate argument'&. This
23182 avoids any problems with spaces or shell metacharacters, and is of use when a
23183 &(pipe)& transport is handling groups of addresses in a batch.
23184
23185 If &%force_command%& is enabled on the transport, Special handling takes place
23186 for an argument that consists of precisely the text &`$address_pipe`&.  It
23187 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23188 argument is inserted in the argument list at that point
23189 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23190 the only item in the argument; in fact, if it were then &%force_command%&
23191 should behave as a no-op.  Rather, it should be used to adjust the command
23192 run while preserving the argument vector separation.
23193
23194 After splitting up into arguments and expansion, the resulting command is run
23195 in a subprocess directly from the transport, &'not'& under a shell. The
23196 message that is being delivered is supplied on the standard input, and the
23197 standard output and standard error are both connected to a single pipe that is
23198 read by Exim. The &%max_output%& option controls how much output the command
23199 may produce, and the &%return_output%& and &%return_fail_output%& options
23200 control what is done with it.
23201
23202 Not running the command under a shell (by default) lessens the security risks
23203 in cases when a command from a user's filter file is built out of data that was
23204 taken from an incoming message. If a shell is required, it can of course be
23205 explicitly specified as the command to be run. However, there are circumstances
23206 where existing commands (for example, in &_.forward_& files) expect to be run
23207 under a shell and cannot easily be modified. To allow for these cases, there is
23208 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23209 works. Instead of breaking up the command line as just described, it expands it
23210 as a single string and passes the result to &_/bin/sh_&. The
23211 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23212 with &%use_shell%&, and the whole mechanism is inherently less secure.
23213
23214
23215
23216 .section "Environment variables" "SECTpipeenv"
23217 .cindex "&(pipe)& transport" "environment for command"
23218 .cindex "environment" "&(pipe)& transport"
23219 The environment variables listed below are set up when the command is invoked.
23220 This list is a compromise for maximum compatibility with other MTAs. Note that
23221 the &%environment%& option can be used to add additional variables to this
23222 environment. The environment for the &(pipe)& transport is not subject
23223 to the &%add_environment%& and &%keep_environment%& main config options.
23224 .display
23225 &`DOMAIN            `&   the domain of the address
23226 &`HOME              `&   the home directory, if set
23227 &`HOST              `&   the host name when called from a router (see below)
23228 &`LOCAL_PART        `&   see below
23229 &`LOCAL_PART_PREFIX `&   see below
23230 &`LOCAL_PART_SUFFIX `&   see below
23231 &`LOGNAME           `&   see below
23232 &`MESSAGE_ID        `&   Exim's local ID for the message
23233 &`PATH              `&   as specified by the &%path%& option below
23234 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23235 &`RECIPIENT         `&   the complete recipient address
23236 &`SENDER            `&   the sender of the message (empty if a bounce)
23237 &`SHELL             `&   &`/bin/sh`&
23238 &`TZ                `&   the value of the &%timezone%& option, if set
23239 &`USER              `&   see below
23240 .endd
23241 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23242 router, LOCAL_PART is set to the local part of the address. When it is
23243 called as a result of a forward or alias expansion, LOCAL_PART is set to
23244 the local part of the address that was expanded. In both cases, any affixes are
23245 removed from the local part, and made available in LOCAL_PART_PREFIX and
23246 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23247 same value as LOCAL_PART for compatibility with other MTAs.
23248
23249 .cindex "HOST"
23250 HOST is set only when a &(pipe)& transport is called from a router that
23251 associates hosts with an address, typically when using &(pipe)& as a
23252 pseudo-remote transport. HOST is set to the first host name specified by
23253 the router.
23254
23255 .cindex "HOME"
23256 If the transport's generic &%home_directory%& option is set, its value is used
23257 for the HOME environment variable. Otherwise, a home directory may be set
23258 by the router's &%transport_home_directory%& option, which defaults to the
23259 user's home directory if &%check_local_user%& is set.
23260
23261
23262 .section "Private options for pipe" "SECID142"
23263 .cindex "options" "&(pipe)& transport"
23264
23265
23266
23267 .option allow_commands pipe "string list&!!" unset
23268 .cindex "&(pipe)& transport" "permitted commands"
23269 The string is expanded, and is then interpreted as a colon-separated list of
23270 permitted commands. If &%restrict_to_path%& is not set, the only commands
23271 permitted are those in the &%allow_commands%& list. They need not be absolute
23272 paths; the &%path%& option is still used for relative paths. If
23273 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23274 in the &%allow_commands%& list, or a name without any slashes that is found on
23275 the path. In other words, if neither &%allow_commands%& nor
23276 &%restrict_to_path%& is set, there is no restriction on the command, but
23277 otherwise only commands that are permitted by one or the other are allowed. For
23278 example, if
23279 .code
23280 allow_commands = /usr/bin/vacation
23281 .endd
23282 and &%restrict_to_path%& is not set, the only permitted command is
23283 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23284 &%use_shell%& is set.
23285
23286
23287 .option batch_id pipe string&!! unset
23288 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23289
23290
23291 .option batch_max pipe integer 1
23292 This limits the number of addresses that can be handled in a single delivery.
23293 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23294
23295
23296 .option check_string pipe string unset
23297 As &(pipe)& writes the message, the start of each line is tested for matching
23298 &%check_string%&, and if it does, the initial matching characters are replaced
23299 by the contents of &%escape_string%&, provided both are set. The value of
23300 &%check_string%& is a literal string, not a regular expression, and the case of
23301 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23302 of &%check_string%& and &%escape_string%& are forced to values that implement
23303 the SMTP escaping protocol. Any settings made in the configuration file are
23304 ignored.
23305
23306
23307 .option command pipe string&!! unset
23308 This option need not be set when &(pipe)& is being used to deliver to pipes
23309 obtained directly from address redirections. In other cases, the option must be
23310 set, to provide a command to be run. It need not yield an absolute path (see
23311 the &%path%& option below). The command is split up into separate arguments by
23312 Exim, and each argument is separately expanded, as described in section
23313 &<<SECThowcommandrun>>& above.
23314
23315
23316 .option environment pipe string&!! unset
23317 .cindex "&(pipe)& transport" "environment for command"
23318 .cindex "environment" "&(pipe)& transport"
23319 This option is used to add additional variables to the environment in which the
23320 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23321 a string which is expanded, and then interpreted as a colon-separated list of
23322 environment settings of the form <&'name'&>=<&'value'&>.
23323
23324
23325 .option escape_string pipe string unset
23326 See &%check_string%& above.
23327
23328
23329 .option freeze_exec_fail pipe boolean false
23330 .cindex "exec failure"
23331 .cindex "failure of exec"
23332 .cindex "&(pipe)& transport" "failure of exec"
23333 Failure to exec the command in a pipe transport is by default treated like
23334 any other failure while running the command. However, if &%freeze_exec_fail%&
23335 is set, failure to exec is treated specially, and causes the message to be
23336 frozen, whatever the setting of &%ignore_status%&.
23337
23338
23339 .option freeze_signal pipe boolean false
23340 .cindex "signal exit"
23341 .cindex "&(pipe)& transport", "signal exit"
23342 Normally if the process run by a command in a pipe transport exits on a signal,
23343 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23344 frozen in Exim's queue instead.
23345
23346
23347 .option force_command pipe boolean false
23348 .cindex "force command"
23349 .cindex "&(pipe)& transport", "force command"
23350 Normally when a router redirects an address directly to a pipe command
23351 the &%command%& option on the transport is ignored.  If &%force_command%&
23352 is set, the &%command%& option will used. This is especially
23353 useful for forcing a wrapper or additional argument to be added to the
23354 command. For example:
23355 .code
23356 command = /usr/bin/remote_exec myhost -- $address_pipe
23357 force_command
23358 .endd
23359
23360 Note that &$address_pipe$& is handled specially in &%command%& when
23361 &%force_command%& is set, expanding out to the original argument vector as
23362 separate items, similarly to a Unix shell &`"$@"`& construct.
23363
23364
23365 .option ignore_status pipe boolean false
23366 If this option is true, the status returned by the subprocess that is set up to
23367 run the command is ignored, and Exim behaves as if zero had been returned.
23368 Otherwise, a non-zero status or termination by signal causes an error return
23369 from the transport unless the status value is one of those listed in
23370 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23371
23372 &*Note*&: This option does not apply to timeouts, which do not return a status.
23373 See the &%timeout_defer%& option for how timeouts are handled.
23374
23375
23376 .option log_defer_output pipe boolean false
23377 .cindex "&(pipe)& transport" "logging output"
23378 If this option is set, and the status returned by the command is
23379 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23380 and any output was produced on stdout or stderr, the first line of it is
23381 written to the main log.
23382
23383
23384 .option log_fail_output pipe boolean false
23385 If this option is set, and the command returns any output on stdout or
23386 stderr, and also ends with a return code that is neither zero nor one of
23387 the return codes listed in &%temp_errors%& (that is, the delivery
23388 failed), the first line of output is written to the main log. This
23389 option and &%log_output%& are mutually exclusive.  Only one of them may
23390 be set.
23391
23392
23393 .option log_output pipe boolean false
23394 If this option is set and the command returns any output on stdout or
23395 stderr, the first line of output is written to the main log, whatever
23396 the return code. This option and &%log_fail_output%& are mutually
23397 exclusive. Only one of them may be set.
23398
23399
23400 .option max_output pipe integer 20K
23401 This specifies the maximum amount of output that the command may produce on its
23402 standard output and standard error file combined. If the limit is exceeded, the
23403 process running the command is killed. This is intended as a safety measure to
23404 catch runaway processes. The limit is applied independently of the settings of
23405 the options that control what is done with such output (for example,
23406 &%return_output%&). Because of buffering effects, the amount of output may
23407 exceed the limit by a small amount before Exim notices.
23408
23409
23410 .option message_prefix pipe string&!! "see below"
23411 The string specified here is expanded and output at the start of every message.
23412 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23413 .code
23414 message_prefix = \
23415   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23416   ${tod_bsdinbox}\n
23417 .endd
23418 .cindex "Cyrus"
23419 .cindex "&%tmail%&"
23420 .cindex "&""From""& line"
23421 This is required by the commonly used &_/usr/bin/vacation_& program.
23422 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23423 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23424 setting
23425 .code
23426 message_prefix =
23427 .endd
23428 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23429 &`\n`& to &`\r\n`& in &%message_prefix%&.
23430
23431
23432 .option message_suffix pipe string&!! "see below"
23433 The string specified here is expanded and output at the end of every message.
23434 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23435 The suffix can be suppressed by setting
23436 .code
23437 message_suffix =
23438 .endd
23439 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23440 &`\n`& to &`\r\n`& in &%message_suffix%&.
23441
23442
23443 .option path pipe string&!! "/bin:/usr/bin"
23444 This option is expanded and
23445 specifies the string that is set up in the PATH environment
23446 variable of the subprocess.
23447 If the &%command%& option does not yield an absolute path name, the command is
23448 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23449 apply to a command specified as a transport filter.
23450
23451
23452 .option permit_coredump pipe boolean false
23453 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23454 a core-dump of a pipe command, enable this command.  This enables core-dumps
23455 during delivery and affects both the Exim binary and the pipe command run.
23456 It is recommended that this option remain off unless and until you have a need
23457 for it and that this only be enabled when needed, as the risk of excessive
23458 resource consumption can be quite high.  Note also that Exim is typically
23459 installed as a setuid binary and most operating systems will inhibit coredumps
23460 of these by default, so further OS-specific action may be required.
23461
23462
23463 .option pipe_as_creator pipe boolean false
23464 .cindex "uid (user id)" "local delivery"
23465 If the generic &%user%& option is not set and this option is true, the delivery
23466 process is run under the uid that was in force when Exim was originally called
23467 to accept the message. If the group id is not otherwise set (via the generic
23468 &%group%& option), the gid that was in force when Exim was originally called to
23469 accept the message is used.
23470
23471
23472 .option restrict_to_path pipe boolean false
23473 When this option is set, any command name not listed in &%allow_commands%& must
23474 contain no slashes. The command is searched for only in the directories listed
23475 in the &%path%& option. This option is intended for use in the case when a pipe
23476 command has been generated from a user's &_.forward_& file. This is usually
23477 handled by a &(pipe)& transport called &%address_pipe%&.
23478
23479
23480 .option return_fail_output pipe boolean false
23481 If this option is true, and the command produced any output and ended with a
23482 return code other than zero or one of the codes listed in &%temp_errors%& (that
23483 is, the delivery failed), the output is returned in the bounce message.
23484 However, if the message has a null sender (that is, it is itself a bounce
23485 message), output from the command is discarded. This option and
23486 &%return_output%& are mutually exclusive. Only one of them may be set.
23487
23488
23489
23490 .option return_output pipe boolean false
23491 If this option is true, and the command produced any output, the delivery is
23492 deemed to have failed whatever the return code from the command, and the output
23493 is returned in the bounce message. Otherwise, the output is just discarded.
23494 However, if the message has a null sender (that is, it is a bounce message),
23495 output from the command is always discarded, whatever the setting of this
23496 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23497 of them may be set.
23498
23499
23500
23501 .option temp_errors pipe "string list" "see below"
23502 .cindex "&(pipe)& transport" "temporary failure"
23503 This option contains either a colon-separated list of numbers, or a single
23504 asterisk. If &%ignore_status%& is false
23505 and &%return_output%& is not set,
23506 and the command exits with a non-zero return code, the failure is treated as
23507 temporary and the delivery is deferred if the return code matches one of the
23508 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23509 codes are treated as permanent errors. The default setting contains the codes
23510 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23511 compiled on a system that does not define these macros, it assumes values of 75
23512 and 73, respectively.
23513
23514
23515 .option timeout pipe time 1h
23516 If the command fails to complete within this time, it is killed. This normally
23517 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23518 specifies no timeout. In order to ensure that any subprocesses created by the
23519 command are also killed, Exim makes the initial process a process group leader,
23520 and kills the whole process group on a timeout. However, this can be defeated
23521 if one of the processes starts a new process group.
23522
23523 .option timeout_defer pipe boolean false
23524 A timeout in a &(pipe)& transport, either in the command that the transport
23525 runs, or in a transport filter that is associated with it, is by default
23526 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23527 is set true, both kinds of timeout become temporary errors, causing the
23528 delivery to be deferred.
23529
23530 .option umask pipe "octal integer" 022
23531 This specifies the umask setting for the subprocess that runs the command.
23532
23533
23534 .option use_bsmtp pipe boolean false
23535 .cindex "envelope sender"
23536 If this option is set true, the &(pipe)& transport writes messages in &"batch
23537 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23538 commands. If you want to include a leading HELO command with such messages,
23539 you can do so by setting the &%message_prefix%& option. See section
23540 &<<SECTbatchSMTP>>& for details of batch SMTP.
23541
23542 .option use_classresources pipe boolean false
23543 .cindex "class resources (BSD)"
23544 This option is available only when Exim is running on FreeBSD, NetBSD, or
23545 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23546 resource limits when a &(pipe)& transport is run to perform a delivery. The
23547 limits for the uid under which the pipe is to run are obtained from the login
23548 class database.
23549
23550
23551 .option use_crlf pipe boolean false
23552 .cindex "carriage return"
23553 .cindex "linefeed"
23554 This option causes lines to be terminated with the two-character CRLF sequence
23555 (carriage return, linefeed) instead of just a linefeed character. In the case
23556 of batched SMTP, the byte sequence written to the pipe is then an exact image
23557 of what would be sent down a real SMTP connection.
23558
23559 The contents of the &%message_prefix%& and &%message_suffix%& options are
23560 written verbatim, so must contain their own carriage return characters if these
23561 are needed. When &%use_bsmtp%& is not set, the default values for both
23562 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23563 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23564
23565
23566 .option use_shell pipe boolean false
23567 .vindex "&$pipe_addresses$&"
23568 If this option is set, it causes the command to be passed to &_/bin/sh_&
23569 instead of being run directly from the transport, as described in section
23570 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23571 where the command is expected to be run under a shell and cannot easily be
23572 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23573 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23574 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23575 its &%-c%& option.
23576
23577
23578
23579 .section "Using an external local delivery agent" "SECID143"
23580 .cindex "local delivery" "using an external agent"
23581 .cindex "&'procmail'&"
23582 .cindex "external local delivery"
23583 .cindex "delivery" "&'procmail'&"
23584 .cindex "delivery" "by external agent"
23585 The &(pipe)& transport can be used to pass all messages that require local
23586 delivery to a separate local delivery agent such as &%procmail%&. When doing
23587 this, care must be taken to ensure that the pipe is run under an appropriate
23588 uid and gid. In some configurations one wants this to be a uid that is trusted
23589 by the delivery agent to supply the correct sender of the message. It may be
23590 necessary to recompile or reconfigure the delivery agent so that it trusts an
23591 appropriate user. The following is an example transport and router
23592 configuration for &%procmail%&:
23593 .code
23594 # transport
23595 procmail_pipe:
23596   driver = pipe
23597   command = /usr/local/bin/procmail -d $local_part
23598   return_path_add
23599   delivery_date_add
23600   envelope_to_add
23601   check_string = "From "
23602   escape_string = ">From "
23603   umask = 077
23604   user = $local_part
23605   group = mail
23606
23607 # router
23608 procmail:
23609   driver = accept
23610   check_local_user
23611   transport = procmail_pipe
23612 .endd
23613 In this example, the pipe is run as the local user, but with the group set to
23614 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23615 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23616 user to supply a correct sender address. If you do not specify either a
23617 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23618 home directory is the user's home directory by default.
23619
23620 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23621 .code
23622 IFS=" "
23623 .endd
23624 as shown in some &%procmail%& documentation, because Exim does not by default
23625 use a shell to run pipe commands.
23626
23627 .cindex "Cyrus"
23628 The next example shows a transport and a router for a system where local
23629 deliveries are handled by the Cyrus IMAP server.
23630 .code
23631 # transport
23632 local_delivery_cyrus:
23633   driver = pipe
23634   command = /usr/cyrus/bin/deliver \
23635             -m ${substr_1:$local_part_suffix} -- $local_part
23636   user = cyrus
23637   group = mail
23638   return_output
23639   log_output
23640   message_prefix =
23641   message_suffix =
23642
23643 # router
23644 local_user_cyrus:
23645   driver = accept
23646   check_local_user
23647   local_part_suffix = .*
23648   transport = local_delivery_cyrus
23649 .endd
23650 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23651 &%return_output%& to cause any text written by Cyrus to be returned to the
23652 sender.
23653 .ecindex IIDpiptra1
23654 .ecindex IIDpiptra2
23655
23656
23657 . ////////////////////////////////////////////////////////////////////////////
23658 . ////////////////////////////////////////////////////////////////////////////
23659
23660 .chapter "The smtp transport" "CHAPsmtptrans"
23661 .scindex IIDsmttra1 "transports" "&(smtp)&"
23662 .scindex IIDsmttra2 "&(smtp)& transport"
23663 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23664 or LMTP protocol. The list of hosts to try can either be taken from the address
23665 that is being processed (having been set up by the router), or specified
23666 explicitly for the transport. Timeout and retry processing (see chapter
23667 &<<CHAPretry>>&) is applied to each IP address independently.
23668
23669
23670 .section "Multiple messages on a single connection" "SECID144"
23671 The sending of multiple messages over a single TCP/IP connection can arise in
23672 two ways:
23673
23674 .ilist
23675 If a message contains more than &%max_rcpt%& (see below) addresses that are
23676 routed to the same host, more than one copy of the message has to be sent to
23677 that host. In this situation, multiple copies may be sent in a single run of
23678 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23679 does when it has too many addresses to send in one message also depends on the
23680 value of the global &%remote_max_parallel%& option. Details are given in
23681 section &<<SECToutSMTPTCP>>&.)
23682 .next
23683 .cindex "hints database" "remembering routing"
23684 When a message has been successfully delivered over a TCP/IP connection, Exim
23685 looks in its hints database to see if there are any other messages awaiting a
23686 connection to the same host. If there are, a new delivery process is started
23687 for one of them, and the current TCP/IP connection is passed on to it. The new
23688 process may in turn send multiple copies and possibly create yet another
23689 process.
23690 .endlist
23691
23692
23693 For each copy sent over the same TCP/IP connection, a sequence counter is
23694 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23695 no further messages are sent over that connection.
23696
23697
23698
23699 .section "Use of the $host and $host_address variables" "SECID145"
23700 .vindex "&$host$&"
23701 .vindex "&$host_address$&"
23702 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23703 &$host_address$& are the name and IP address of the first host on the host list
23704 passed by the router. However, when the transport is about to connect to a
23705 specific host, and while it is connected to that host, &$host$& and
23706 &$host_address$& are set to the values for that host. These are the values
23707 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23708 &%serialize_hosts%&, and the various TLS options are expanded.
23709
23710
23711 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23712 .vindex &$tls_bits$&
23713 .vindex &$tls_cipher$&
23714 .vindex &$tls_peerdn$&
23715 .vindex &$tls_sni$&
23716 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23717 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23718 are the values that were set when the message was received.
23719 These are the values that are used for options that are expanded before any
23720 SMTP connections are made. Just before each connection is made, these four
23721 variables are emptied. If TLS is subsequently started, they are set to the
23722 appropriate values for the outgoing connection, and these are the values that
23723 are in force when any authenticators are run and when the
23724 &%authenticated_sender%& option is expanded.
23725
23726 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23727 and will be removed in a future release.
23728
23729
23730 .section "Private options for smtp" "SECID146"
23731 .cindex "options" "&(smtp)& transport"
23732 The private options of the &(smtp)& transport are as follows:
23733
23734
23735 .option address_retry_include_sender smtp boolean true
23736 .cindex "4&'xx'& responses" "retrying after"
23737 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23738 is the combination of sender and recipient that is delayed in subsequent queue
23739 runs until the retry time is reached. You can delay the recipient without
23740 reference to the sender (which is what earlier versions of Exim did), by
23741 setting &%address_retry_include_sender%& false. However, this can lead to
23742 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23743
23744 .option allow_localhost smtp boolean false
23745 .cindex "local host" "sending to"
23746 .cindex "fallback" "hosts specified on transport"
23747 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23748 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23749 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23750 the delivery anyway. This should be used only in special cases when the
23751 configuration ensures that no looping will result (for example, a differently
23752 configured Exim is listening on the port to which the message is sent).
23753
23754
23755 .option authenticated_sender smtp string&!! unset
23756 .cindex "Cyrus"
23757 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23758 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23759 overriding any existing authenticated sender value. If the string expansion is
23760 forced to fail, the option is ignored. Other expansion failures cause delivery
23761 to be deferred. If the result of expansion is an empty string, that is also
23762 ignored.
23763
23764 The expansion happens after the outgoing connection has been made and TLS
23765 started, if required. This means that the &$host$&, &$host_address$&,
23766 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23767 particular connection.
23768
23769 If the SMTP session is not authenticated, the expansion of
23770 &%authenticated_sender%& still happens (and can cause the delivery to be
23771 deferred if it fails), but no AUTH= item is added to MAIL commands
23772 unless &%authenticated_sender_force%& is true.
23773
23774 This option allows you to use the &(smtp)& transport in LMTP mode to
23775 deliver mail to Cyrus IMAP and provide the proper local part as the
23776 &"authenticated sender"&, via a setting such as:
23777 .code
23778 authenticated_sender = $local_part
23779 .endd
23780 This removes the need for IMAP subfolders to be assigned special ACLs to
23781 allow direct delivery to those subfolders.
23782
23783 Because of expected uses such as that just described for Cyrus (when no
23784 domain is involved), there is no checking on the syntax of the provided
23785 value.
23786
23787
23788 .option authenticated_sender_force smtp boolean false
23789 If this option is set true, the &%authenticated_sender%& option's value
23790 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23791 authenticated as a client.
23792
23793
23794 .option command_timeout smtp time 5m
23795 This sets a timeout for receiving a response to an SMTP command that has been
23796 sent out. It is also used when waiting for the initial banner line from the
23797 remote host. Its value must not be zero.
23798
23799
23800 .option connect_timeout smtp time 5m
23801 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23802 to a remote host. A setting of zero allows the system timeout (typically
23803 several minutes) to act. To have any effect, the value of this option must be
23804 less than the system timeout. However, it has been observed that on some
23805 systems there is no system timeout, which is why the default value for this
23806 option is 5 minutes, a value recommended by RFC 1123.
23807
23808
23809 .option connection_max_messages smtp integer 500
23810 .cindex "SMTP" "passed connection"
23811 .cindex "SMTP" "multiple deliveries"
23812 .cindex "multiple SMTP deliveries"
23813 This controls the maximum number of separate message deliveries that are sent
23814 over a single TCP/IP connection. If the value is zero, there is no limit.
23815 For testing purposes, this value can be overridden by the &%-oB%& command line
23816 option.
23817
23818
23819 .option data_timeout smtp time 5m
23820 This sets a timeout for the transmission of each block in the data portion of
23821 the message. As a result, the overall timeout for a message depends on the size
23822 of the message. Its value must not be zero. See also &%final_timeout%&.
23823
23824
23825 .option dkim_domain smtp string list&!! unset
23826 .option dkim_selector smtp string&!! unset
23827 .option dkim_private_key smtp string&!! unset
23828 .option dkim_canon smtp string&!! unset
23829 .option dkim_strict smtp string&!! unset
23830 .option dkim_sign_headers smtp string&!! "per RFC"
23831 .option dkim_hash smtp string&!! sha256
23832 .option dkim_identity smtp string&!! unset
23833 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
23834
23835
23836 .option delay_after_cutoff smtp boolean true
23837 This option controls what happens when all remote IP addresses for a given
23838 domain have been inaccessible for so long that they have passed their retry
23839 cutoff times.
23840
23841 In the default state, if the next retry time has not been reached for any of
23842 them, the address is bounced without trying any deliveries. In other words,
23843 Exim delays retrying an IP address after the final cutoff time until a new
23844 retry time is reached, and can therefore bounce an address without ever trying
23845 a delivery, when machines have been down for a long time. Some people are
23846 unhappy at this prospect, so...
23847
23848 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23849 addresses are past their final cutoff time, Exim tries to deliver to those
23850 IP addresses that have not been tried since the message arrived. If there are
23851 none, of if they all fail, the address is bounced. In other words, it does not
23852 delay when a new message arrives, but immediately tries those expired IP
23853 addresses that haven't been tried since the message arrived. If there is a
23854 continuous stream of messages for the dead hosts, unsetting
23855 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23856 to them.
23857
23858
23859 .option dns_qualify_single smtp boolean true
23860 If the &%hosts%& or &%fallback_hosts%& option is being used,
23861 and the &%gethostbyname%& option is false,
23862 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23863 in chapter &<<CHAPdnslookup>>& for more details.
23864
23865
23866 .option dns_search_parents smtp boolean false
23867 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23868 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23869 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23870 details.
23871
23872
23873 .option dnssec_request_domains smtp "domain list&!!" unset
23874 .cindex "MX record" "security"
23875 .cindex "DNSSEC" "MX lookup"
23876 .cindex "security" "MX lookup"
23877 .cindex "DNS" "DNSSEC"
23878 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23879 the dnssec request bit set.
23880 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23881
23882
23883
23884 .option dnssec_require_domains smtp "domain list&!!" unset
23885 .cindex "MX record" "security"
23886 .cindex "DNSSEC" "MX lookup"
23887 .cindex "security" "MX lookup"
23888 .cindex "DNS" "DNSSEC"
23889 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
23890 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23891 (AD bit) set will be ignored and logged as a host-lookup failure.
23892 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23893
23894
23895
23896 .option dscp smtp string&!! unset
23897 .cindex "DCSP" "outbound"
23898 This option causes the DSCP value associated with a socket to be set to one
23899 of a number of fixed strings or to numeric value.
23900 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23901 Common values include &`throughput`&, &`mincost`&, and on newer systems
23902 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23903
23904 The outbound packets from Exim will be marked with this value in the header
23905 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23906 that these values will have any effect, not be stripped by networking
23907 equipment, or do much of anything without cooperation with your Network
23908 Engineer and those of all network operators between the source and destination.
23909
23910
23911 .option fallback_hosts smtp "string list" unset
23912 .cindex "fallback" "hosts specified on transport"
23913 String expansion is not applied to this option. The argument must be a
23914 colon-separated list of host names or IP addresses, optionally also including
23915 port numbers, though the separator can be changed, as described in section
23916 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23917 item in a &%route_list%& setting for the &(manualroute)& router, as described
23918 in section &<<SECTformatonehostitem>>&.
23919
23920 Fallback hosts can also be specified on routers, which associate them with the
23921 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23922 &%fallback_hosts%& specified on the transport is used only if the address does
23923 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23924 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23925 However, &%hosts_randomize%& does apply to fallback host lists.
23926
23927 If Exim is unable to deliver to any of the hosts for a particular address, and
23928 the errors are not permanent rejections, the address is put on a separate
23929 transport queue with its host list replaced by the fallback hosts, unless the
23930 address was routed via MX records and the current host was in the original MX
23931 list. In that situation, the fallback host list is not used.
23932
23933 Once normal deliveries are complete, the fallback queue is delivered by
23934 re-running the same transports with the new host lists. If several failing
23935 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23936 copy of the message is sent.
23937
23938 The resolution of the host names on the fallback list is controlled by the
23939 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23940 both to cases when the host list comes with the address and when it is taken
23941 from &%hosts%&. This option provides a &"use a smart host only if delivery
23942 fails"& facility.
23943
23944
23945 .option final_timeout smtp time 10m
23946 This is the timeout that applies while waiting for the response to the final
23947 line containing just &"."& that terminates a message. Its value must not be
23948 zero.
23949
23950 .option gethostbyname smtp boolean false
23951 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23952 being used, names are looked up using &[gethostbyname()]&
23953 (or &[getipnodebyname()]& when available)
23954 instead of using the DNS. Of course, that function may in fact use the DNS, but
23955 it may also consult other sources of information such as &_/etc/hosts_&.
23956
23957 .option gnutls_compat_mode smtp boolean unset
23958 This option controls whether GnuTLS is used in compatibility mode in an Exim
23959 server. This reduces security slightly, but improves interworking with older
23960 implementations of TLS.
23961
23962 .option helo_data smtp string&!! "see below"
23963 .cindex "HELO" "argument, setting"
23964 .cindex "EHLO" "argument, setting"
23965 .cindex "LHLO argument setting"
23966 The value of this option is expanded after a connection to a another host has
23967 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23968 command that starts the outgoing SMTP or LMTP session. The default value of the
23969 option is:
23970 .code
23971 $primary_hostname
23972 .endd
23973 During the expansion, the variables &$host$& and &$host_address$& are set to
23974 the identity of the remote host, and the variables &$sending_ip_address$& and
23975 &$sending_port$& are set to the local IP address and port number that are being
23976 used. These variables can be used to generate different values for different
23977 servers or different local IP addresses. For example, if you want the string
23978 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23979 interface address, you could use this:
23980 .code
23981 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23982   {$primary_hostname}}
23983 .endd
23984 The use of &%helo_data%& applies both to sending messages and when doing
23985 callouts.
23986
23987 .option hosts smtp "string list&!!" unset
23988 Hosts are associated with an address by a router such as &(dnslookup)&, which
23989 finds the hosts by looking up the address domain in the DNS, or by
23990 &(manualroute)&, which has lists of hosts in its configuration. However,
23991 email addresses can be passed to the &(smtp)& transport by any router, and not
23992 all of them can provide an associated list of hosts.
23993
23994 The &%hosts%& option specifies a list of hosts to be used if the address being
23995 processed does not have any hosts associated with it. The hosts specified by
23996 &%hosts%& are also used, whether or not the address has its own hosts, if
23997 &%hosts_override%& is set.
23998
23999 The string is first expanded, before being interpreted as a colon-separated
24000 list of host names or IP addresses, possibly including port numbers. The
24001 separator may be changed to something other than colon, as described in section
24002 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24003 item in a &%route_list%& setting for the &(manualroute)& router, as described
24004 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24005 of the &(manualroute)& router is not available here.
24006
24007 If the expansion fails, delivery is deferred. Unless the failure was caused by
24008 the inability to complete a lookup, the error is logged to the panic log as
24009 well as the main log. Host names are looked up either by searching directly for
24010 address records in the DNS or by calling &[gethostbyname()]& (or
24011 &[getipnodebyname()]& when available), depending on the setting of the
24012 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24013 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24014 address are used.
24015
24016 During delivery, the hosts are tried in order, subject to their retry status,
24017 unless &%hosts_randomize%& is set.
24018
24019
24020 .option hosts_avoid_esmtp smtp "host list&!!" unset
24021 .cindex "ESMTP, avoiding use of"
24022 .cindex "HELO" "forcing use of"
24023 .cindex "EHLO" "avoiding use of"
24024 .cindex "PIPELINING" "avoiding the use of"
24025 This option is for use with broken hosts that announce ESMTP facilities (for
24026 example, PIPELINING) and then fail to implement them properly. When a host
24027 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24028 start of the SMTP session. This means that it cannot use any of the ESMTP
24029 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24030
24031
24032 .option hosts_avoid_pipelining smtp "host list&!!" unset
24033 .cindex "PIPELINING" "avoiding the use of"
24034 Exim will not use the SMTP PIPELINING extension when delivering to any host
24035 that matches this list, even if the server host advertises PIPELINING support.
24036
24037
24038 .option hosts_avoid_tls smtp "host list&!!" unset
24039 .cindex "TLS" "avoiding for certain hosts"
24040 Exim will not try to start a TLS session when delivering to any host that
24041 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24042
24043 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24044 .cindex "TLS" "avoiding for certain hosts"
24045 Exim will not try to start a TLS session for a verify callout,
24046 or when delivering in cutthrough mode,
24047 to any host that matches this list.
24048
24049
24050 .option hosts_max_try smtp integer 5
24051 .cindex "host" "maximum number to try"
24052 .cindex "limit" "number of hosts tried"
24053 .cindex "limit" "number of MX tried"
24054 .cindex "MX record" "maximum tried"
24055 This option limits the number of IP addresses that are tried for any one
24056 delivery in cases where there are temporary delivery errors. Section
24057 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24058
24059
24060 .option hosts_max_try_hardlimit smtp integer 50
24061 This is an additional check on the maximum number of IP addresses that Exim
24062 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24063 why it exists.
24064
24065
24066
24067 .option hosts_nopass_tls smtp "host list&!!" unset
24068 .cindex "TLS" "passing connection"
24069 .cindex "multiple SMTP deliveries"
24070 .cindex "TLS" "multiple message deliveries"
24071 For any host that matches this list, a connection on which a TLS session has
24072 been started will not be passed to a new delivery process for sending another
24073 message on the same connection. See section &<<SECTmulmessam>>& for an
24074 explanation of when this might be needed.
24075
24076 .option hosts_noproxy_tls smtp "host list&!!" *
24077 .cindex "TLS" "passing connection"
24078 .cindex "multiple SMTP deliveries"
24079 .cindex "TLS" "multiple message deliveries"
24080 For any host that matches this list, a TLS session which has
24081 been started will not be passed to a new delivery process for sending another
24082 message on the same session.
24083
24084 The traditional implementation closes down TLS and re-starts it in the new
24085 process, on the same open TCP connection, for each successive message
24086 sent.  If permitted by this option a pipe to to the new process is set up
24087 instead, and the original process maintains the TLS connection and proxies
24088 the SMTP connection from and to the new process and any subsequents.
24089 The new process has no access to TLS information, so cannot include it in
24090 logging.
24091
24092
24093
24094 .option hosts_override smtp boolean false
24095 If this option is set and the &%hosts%& option is also set, any hosts that are
24096 attached to the address are ignored, and instead the hosts specified by the
24097 &%hosts%& option are always used. This option does not apply to
24098 &%fallback_hosts%&.
24099
24100
24101 .option hosts_randomize smtp boolean false
24102 .cindex "randomized host list"
24103 .cindex "host" "list of; randomized"
24104 .cindex "fallback" "randomized hosts"
24105 If this option is set, and either the list of hosts is taken from the
24106 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24107 were not obtained from MX records (this includes fallback hosts from the
24108 router), and were not randomized by the router, the order of trying the hosts
24109 is randomized each time the transport runs. Randomizing the order of a host
24110 list can be used to do crude load sharing.
24111
24112 When &%hosts_randomize%& is true, a host list may be split into groups whose
24113 order is separately randomized. This makes it possible to set up MX-like
24114 behaviour. The boundaries between groups are indicated by an item that is just
24115 &`+`& in the host list. For example:
24116 .code
24117 hosts = host1:host2:host3:+:host4:host5
24118 .endd
24119 The order of the first three hosts and the order of the last two hosts is
24120 randomized for each use, but the first three always end up before the last two.
24121 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24122
24123 .option hosts_require_auth smtp "host list&!!" unset
24124 .cindex "authentication" "required by client"
24125 This option provides a list of servers for which authentication must succeed
24126 before Exim will try to transfer a message. If authentication fails for
24127 servers which are not in this list, Exim tries to send unauthenticated. If
24128 authentication fails for one of these servers, delivery is deferred. This
24129 temporary error is detectable in the retry rules, so it can be turned into a
24130 hard failure if required. See also &%hosts_try_auth%&, and chapter
24131 &<<CHAPSMTPAUTH>>& for details of authentication.
24132
24133
24134 .option hosts_request_ocsp smtp "host list&!!" *
24135 .cindex "TLS" "requiring for certain servers"
24136 Exim will request a Certificate Status on a
24137 TLS session for any host that matches this list.
24138 &%tls_verify_certificates%& should also be set for the transport.
24139
24140 .option hosts_require_ocsp smtp "host list&!!" unset
24141 .cindex "TLS" "requiring for certain servers"
24142 Exim will request, and check for a valid Certificate Status being given, on a
24143 TLS session for any host that matches this list.
24144 &%tls_verify_certificates%& should also be set for the transport.
24145
24146 .option hosts_require_tls smtp "host list&!!" unset
24147 .cindex "TLS" "requiring for certain servers"
24148 Exim will insist on using a TLS session when delivering to any host that
24149 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24150 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24151 incoming messages, use an appropriate ACL.
24152
24153 .option hosts_try_auth smtp "host list&!!" unset
24154 .cindex "authentication" "optional in client"
24155 This option provides a list of servers to which, provided they announce
24156 authentication support, Exim will attempt to authenticate as a client when it
24157 connects. If authentication fails, Exim will try to transfer the message
24158 unauthenticated. See also &%hosts_require_auth%&, and chapter
24159 &<<CHAPSMTPAUTH>>& for details of authentication.
24160
24161 .option hosts_try_chunking smtp "host list&!!" *
24162 .cindex CHUNKING "enabling, in client"
24163 .cindex BDAT "SMTP command"
24164 .cindex "RFC 3030" "CHUNKING"
24165 This option provides a list of servers to which, provided they announce
24166 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24167 BDAT will not be used in conjunction with a transport filter.
24168
24169 .option hosts_try_fastopen smtp "host list&!!" unset
24170 .cindex "fast open, TCP" "enabling, in client"
24171 .cindex "TCP Fast Open" "enabling, in client"
24172 .cindex "RFC 7413" "TCP Fast Open"
24173 This option provides a list of servers to which, provided
24174 the facility is supported by this system, Exim will attempt to
24175 perform a TCP Fast Open.
24176 No data is sent on the SYN segment but, if the remote server also
24177 supports the facility, it can send its SMTP banner immediately after
24178 the SYN,ACK segment.  This can save up to one round-trip time.
24179
24180 The facility is only active for previously-contacted servers,
24181 as the initiator must present a cookie in the SYN segment.
24182
24183 On (at least some) current Linux distributions the facility must be enabled
24184 in the kernel by the sysadmin before the support is usable.
24185 There is no option for control of the server side; if the system supports
24186 it it is always enebled.  Note that legthy operations in the connect ACL,
24187 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24188
24189 .option hosts_try_prdr smtp "host list&!!" *
24190 .cindex "PRDR" "enabling, optional in client"
24191 This option provides a list of servers to which, provided they announce
24192 PRDR support, Exim will attempt to negotiate PRDR
24193 for multi-recipient messages.
24194 The option can usually be left as default.
24195
24196 .option interface smtp "string list&!!" unset
24197 .cindex "bind IP address"
24198 .cindex "IP address" "binding"
24199 .vindex "&$host$&"
24200 .vindex "&$host_address$&"
24201 This option specifies which interface to bind to when making an outgoing SMTP
24202 call. The value is an IP address, not an interface name such as
24203 &`eth0`&. Do not confuse this with the interface address that was used when a
24204 message was received, which is in &$received_ip_address$&, formerly known as
24205 &$interface_address$&. The name was changed to minimize confusion with the
24206 outgoing interface address. There is no variable that contains an outgoing
24207 interface address because, unless it is set by this option, its value is
24208 unknown.
24209
24210 During the expansion of the &%interface%& option the variables &$host$& and
24211 &$host_address$& refer to the host to which a connection is about to be made
24212 during the expansion of the string. Forced expansion failure, or an empty
24213 string result causes the option to be ignored. Otherwise, after expansion, the
24214 string must be a list of IP addresses, colon-separated by default, but the
24215 separator can be changed in the usual way. For example:
24216 .code
24217 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24218 .endd
24219 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24220 connection. If none of them are the correct type, the option is ignored. If
24221 &%interface%& is not set, or is ignored, the system's IP functions choose which
24222 interface to use if the host has more than one.
24223
24224
24225 .option keepalive smtp boolean true
24226 .cindex "keepalive" "on outgoing connection"
24227 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24228 connections. When set, it causes the kernel to probe idle connections
24229 periodically, by sending packets with &"old"& sequence numbers. The other end
24230 of the connection should send a acknowledgment if the connection is still okay
24231 or a reset if the connection has been aborted. The reason for doing this is
24232 that it has the beneficial effect of freeing up certain types of connection
24233 that can get stuck when the remote host is disconnected without tidying up the
24234 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24235 unreachable hosts.
24236
24237
24238 .option lmtp_ignore_quota smtp boolean false
24239 .cindex "LMTP" "ignoring quota errors"
24240 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24241 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24242 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24243
24244 .option max_rcpt smtp integer 100
24245 .cindex "RCPT" "maximum number of outgoing"
24246 This option limits the number of RCPT commands that are sent in a single
24247 SMTP message transaction. Each set of addresses is treated independently, and
24248 so can cause parallel connections to the same host if &%remote_max_parallel%&
24249 permits this.
24250
24251
24252 .option multi_domain smtp boolean&!! true
24253 .vindex "&$domain$&"
24254 When this option is set, the &(smtp)& transport can handle a number of
24255 addresses containing a mixture of different domains provided they all resolve
24256 to the same list of hosts. Turning the option off restricts the transport to
24257 handling only one domain at a time. This is useful if you want to use
24258 &$domain$& in an expansion for the transport, because it is set only when there
24259 is a single domain involved in a remote delivery.
24260
24261 It is expanded per-address and can depend on any of
24262 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24263 &$host$&, &$host_address$& and &$host_port$&.
24264
24265 .option port smtp string&!! "see below"
24266 .cindex "port" "sending TCP/IP"
24267 .cindex "TCP/IP" "setting outgoing port"
24268 This option specifies the TCP/IP port on the server to which Exim connects.
24269 &*Note:*& Do not confuse this with the port that was used when a message was
24270 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24271 The name was changed to minimize confusion with the outgoing port. There is no
24272 variable that contains an outgoing port.
24273
24274 If the value of this option begins with a digit it is taken as a port number;
24275 otherwise it is looked up using &[getservbyname()]&. The default value is
24276 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
24277 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
24278 is deferred.
24279
24280
24281
24282 .option protocol smtp string smtp
24283 .cindex "LMTP" "over TCP/IP"
24284 .cindex "ssmtp protocol" "outbound"
24285 .cindex "TLS" "SSL-on-connect outbound"
24286 .vindex "&$port$&"
24287 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24288 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24289 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24290 deliveries into closed message stores. Exim also has support for running LMTP
24291 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24292
24293 If this option is set to &"smtps"&, the default value for the &%port%& option
24294 changes to &"smtps"&, and the transport initiates TLS immediately after
24295 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24296 The Internet standards bodies strongly discourage use of this mode.
24297
24298
24299 .option retry_include_ip_address smtp boolean&!! true
24300 Exim normally includes both the host name and the IP address in the key it
24301 constructs for indexing retry data after a temporary delivery failure. This
24302 means that when one of several IP addresses for a host is failing, it gets
24303 tried periodically (controlled by the retry rules), but use of the other IP
24304 addresses is not affected.
24305
24306 However, in some dialup environments hosts are assigned a different IP address
24307 each time they connect. In this situation the use of the IP address as part of
24308 the retry key leads to undesirable behaviour. Setting this option false causes
24309 Exim to use only the host name.
24310 Since it is expanded it can be made to depend on the host or domain.
24311
24312
24313 .option serialize_hosts smtp "host list&!!" unset
24314 .cindex "serializing connections"
24315 .cindex "host" "serializing connections"
24316 Because Exim operates in a distributed manner, if several messages for the same
24317 host arrive at around the same time, more than one simultaneous connection to
24318 the remote host can occur. This is not usually a problem except when there is a
24319 slow link between the hosts. In that situation it may be helpful to restrict
24320 Exim to one connection at a time. This can be done by setting
24321 &%serialize_hosts%& to match the relevant hosts.
24322
24323 .cindex "hints database" "serializing deliveries to a host"
24324 Exim implements serialization by means of a hints database in which a record is
24325 written whenever a process connects to one of the restricted hosts. The record
24326 is deleted when the connection is completed. Obviously there is scope for
24327 records to get left lying around if there is a system or program crash. To
24328 guard against this, Exim ignores any records that are more than six hours old.
24329
24330 If you set up this kind of serialization, you should also arrange to delete the
24331 relevant hints database whenever your system reboots. The names of the files
24332 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24333 may be one or two files, depending on the type of DBM in use. The same files
24334 are used for ETRN serialization.
24335
24336 See also the &%max_parallel%& generic transport option.
24337
24338
24339 .option size_addition smtp integer 1024
24340 .cindex "SMTP" "SIZE"
24341 .cindex "message" "size issue for transport filter"
24342 .cindex "size" "of message"
24343 .cindex "transport" "filter"
24344 .cindex "filter" "transport filter"
24345 If a remote SMTP server indicates that it supports the SIZE option of the
24346 MAIL command, Exim uses this to pass over the message size at the start of
24347 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24348 sends, to allow for headers and other text that may be added during delivery by
24349 configuration options or in a transport filter. It may be necessary to increase
24350 this if a lot of text is added to messages.
24351
24352 Alternatively, if the value of &%size_addition%& is set negative, it disables
24353 the use of the SIZE option altogether.
24354
24355
24356 .option socks_proxy smtp string&!! unset
24357 .cindex proxy SOCKS
24358 This option enables use of SOCKS proxies for connections made by the
24359 transport.  For details see section &<<SECTproxySOCKS>>&.
24360
24361
24362 .option tls_certificate smtp string&!! unset
24363 .cindex "TLS" "client certificate, location of"
24364 .cindex "certificate" "client, location of"
24365 .vindex "&$host$&"
24366 .vindex "&$host_address$&"
24367 The value of this option must be the absolute path to a file which contains the
24368 client's certificate, for possible use when sending a message over an encrypted
24369 connection. The values of &$host$& and &$host_address$& are set to the name and
24370 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24371 details of TLS.
24372
24373 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24374 certificate when sending messages as a client. The global option of the same
24375 name specifies the certificate for Exim as a server; it is not automatically
24376 assumed that the same certificate should be used when Exim is operating as a
24377 client.
24378
24379
24380 .option tls_crl smtp string&!! unset
24381 .cindex "TLS" "client certificate revocation list"
24382 .cindex "certificate" "revocation list for client"
24383 This option specifies a certificate revocation list. The expanded value must
24384 be the name of a file that contains a CRL in PEM format.
24385
24386
24387 .option tls_dh_min_bits smtp integer 1024
24388 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24389 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24390 key agreement is negotiated, the server will provide a large prime number
24391 for use.  This option establishes the minimum acceptable size of that number.
24392 If the parameter offered by the server is too small, then the TLS handshake
24393 will fail.
24394
24395 Only supported when using GnuTLS.
24396
24397
24398 .option tls_privatekey smtp string&!! unset
24399 .cindex "TLS" "client private key, location of"
24400 .vindex "&$host$&"
24401 .vindex "&$host_address$&"
24402 The value of this option must be the absolute path to a file which contains the
24403 client's private key. This is used when sending a message over an encrypted
24404 connection using a client certificate. The values of &$host$& and
24405 &$host_address$& are set to the name and address of the server during the
24406 expansion. If this option is unset, or the expansion is forced to fail, or the
24407 result is an empty string, the private key is assumed to be in the same file as
24408 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24409
24410
24411 .option tls_require_ciphers smtp string&!! unset
24412 .cindex "TLS" "requiring specific ciphers"
24413 .cindex "cipher" "requiring specific"
24414 .vindex "&$host$&"
24415 .vindex "&$host_address$&"
24416 The value of this option must be a list of permitted cipher suites, for use
24417 when setting up an outgoing encrypted connection. (There is a global option of
24418 the same name for controlling incoming connections.) The values of &$host$& and
24419 &$host_address$& are set to the name and address of the server during the
24420 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24421 is used in different ways by OpenSSL and GnuTLS (see sections
24422 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24423 ciphers is a preference order.
24424
24425
24426
24427 .option tls_sni smtp string&!! unset
24428 .cindex "TLS" "Server Name Indication"
24429 .vindex "&$tls_sni$&"
24430 If this option is set then it sets the $tls_out_sni variable and causes any
24431 TLS session to pass this value as the Server Name Indication extension to
24432 the remote side, which can be used by the remote side to select an appropriate
24433 certificate and private key for the session.
24434
24435 See &<<SECTtlssni>>& for more information.
24436
24437 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24438 TLS extensions.
24439
24440
24441
24442
24443 .option tls_tempfail_tryclear smtp boolean true
24444 .cindex "4&'xx'& responses" "to STARTTLS"
24445 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24446 setting up a TLS session, this option determines whether or not Exim should try
24447 to deliver the message unencrypted. If it is set false, delivery to the
24448 current host is deferred; if there are other hosts, they are tried. If this
24449 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24450 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24451 TLS negotiation fails, Exim closes the current connection (because it is in an
24452 unknown state), opens a new one to the same host, and then tries the delivery
24453 in clear.
24454
24455
24456 .option tls_try_verify_hosts smtp "host list&!!" *
24457 .cindex "TLS" "server certificate verification"
24458 .cindex "certificate" "verification of server"
24459 This option gives a list of hosts for which, on encrypted connections,
24460 certificate verification will be tried but need not succeed.
24461 The &%tls_verify_certificates%& option must also be set.
24462 Note that unless the host is in this list
24463 TLS connections will be denied to hosts using self-signed certificates
24464 when &%tls_verify_certificates%& is matched.
24465 The &$tls_out_certificate_verified$& variable is set when
24466 certificate verification succeeds.
24467
24468
24469 .option tls_verify_cert_hostnames smtp "host list&!!" *
24470 .cindex "TLS" "server certificate hostname verification"
24471 .cindex "certificate" "verification of server"
24472 This option give a list of hosts for which,
24473 while verifying the server certificate,
24474 checks will be included on the host name
24475 (note that this will generally be the result of a DNS MX lookup)
24476 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24477 limited to being the initial component of a 3-or-more component FQDN.
24478
24479 There is no equivalent checking on client certificates.
24480
24481
24482 .option tls_verify_certificates smtp string&!! system
24483 .cindex "TLS" "server certificate verification"
24484 .cindex "certificate" "verification of server"
24485 .vindex "&$host$&"
24486 .vindex "&$host_address$&"
24487 The value of this option must be either the
24488 word "system"
24489 or the absolute path to
24490 a file or directory containing permitted certificates for servers,
24491 for use when setting up an encrypted connection.
24492
24493 The "system" value for the option will use a location compiled into the SSL library.
24494 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24495 is taken as empty and an explicit location
24496 must be specified.
24497
24498 The use of a directory for the option value is not available for GnuTLS versions
24499 preceding 3.3.6 and a single file must be used.
24500
24501 With OpenSSL the certificates specified
24502 explicitly
24503 either by file or directory
24504 are added to those given by the system default location.
24505
24506 The values of &$host$& and
24507 &$host_address$& are set to the name and address of the server during the
24508 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24509
24510 For back-compatibility,
24511 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24512 (a single-colon empty list counts as being set)
24513 and certificate verification fails the TLS connection is closed.
24514
24515
24516 .option tls_verify_hosts smtp "host list&!!" unset
24517 .cindex "TLS" "server certificate verification"
24518 .cindex "certificate" "verification of server"
24519 This option gives a list of hosts for which, on encrypted connections,
24520 certificate verification must succeed.
24521 The &%tls_verify_certificates%& option must also be set.
24522 If both this option and &%tls_try_verify_hosts%& are unset
24523 operation is as if this option selected all hosts.
24524
24525
24526
24527
24528 .section "How the limits for the number of hosts to try are used" &&&
24529          "SECTvalhosmax"
24530 .cindex "host" "maximum number to try"
24531 .cindex "limit" "hosts; maximum number tried"
24532 There are two options that are concerned with the number of hosts that are
24533 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24534 &%hosts_max_try_hardlimit%&.
24535
24536
24537 The &%hosts_max_try%& option limits the number of hosts that are tried
24538 for a single delivery. However, despite the term &"host"& in its name, the
24539 option actually applies to each IP address independently. In other words, a
24540 multihomed host is treated as several independent hosts, just as it is for
24541 retrying.
24542
24543 Many of the larger ISPs have multiple MX records which often point to
24544 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24545 created as a result of routing one of these domains.
24546
24547 Trying every single IP address on such a long list does not seem sensible; if
24548 several at the top of the list fail, it is reasonable to assume there is some
24549 problem that is likely to affect all of them. Roughly speaking, the value of
24550 &%hosts_max_try%& is the maximum number that are tried before deferring the
24551 delivery. However, the logic cannot be quite that simple.
24552
24553 Firstly, IP addresses that are skipped because their retry times have not
24554 arrived do not count, and in addition, addresses that are past their retry
24555 limits are also not counted, even when they are tried. This means that when
24556 some IP addresses are past their retry limits, more than the value of
24557 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24558 that all IP addresses are considered before timing out an email address (but
24559 see below for an exception).
24560
24561 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24562 list to see if there is a subsequent host with a different (higher valued) MX.
24563 If there is, that host is considered next, and the current IP address is used
24564 but not counted. This behaviour helps in the case of a domain with a retry rule
24565 that hardly ever delays any hosts, as is now explained:
24566
24567 Consider the case of a long list of hosts with one MX value, and a few with a
24568 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24569 hosts at the top of the list are tried at first. With the default retry rule,
24570 which specifies increasing retry times, the higher MX hosts are eventually
24571 tried when those at the top of the list are skipped because they have not
24572 reached their retry times.
24573
24574 However, it is common practice to put a fixed short retry time on domains for
24575 large ISPs, on the grounds that their servers are rarely down for very long.
24576 Unfortunately, these are exactly the domains that tend to resolve to long lists
24577 of hosts. The short retry time means that the lowest MX hosts are tried every
24578 time. The attempts may be in a different order because of random sorting, but
24579 without the special MX check, the higher MX hosts would never be tried until
24580 all the lower MX hosts had timed out (which might be several days), because
24581 there are always some lower MX hosts that have reached their retry times. With
24582 the special check, Exim considers at least one IP address from each MX value at
24583 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24584 reached.
24585
24586 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24587 particular, Exim normally eventually tries all the IP addresses before timing
24588 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24589 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24590 been set up with hundreds of IP addresses for some domains. It can
24591 take a very long time indeed for an address to time out in these cases.
24592
24593 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24594 Exim never tries more than this number of IP addresses; if it hits this limit
24595 and they are all timed out, the email address is bounced, even though not all
24596 possible IP addresses have been tried.
24597 .ecindex IIDsmttra1
24598 .ecindex IIDsmttra2
24599
24600
24601
24602
24603
24604 . ////////////////////////////////////////////////////////////////////////////
24605 . ////////////////////////////////////////////////////////////////////////////
24606
24607 .chapter "Address rewriting" "CHAPrewrite"
24608 .scindex IIDaddrew "rewriting" "addresses"
24609 There are some circumstances in which Exim automatically rewrites domains in
24610 addresses. The two most common are when an address is given without a domain
24611 (referred to as an &"unqualified address"&) or when an address contains an
24612 abbreviated domain that is expanded by DNS lookup.
24613
24614 Unqualified envelope addresses are accepted only for locally submitted
24615 messages, or for messages that are received from hosts matching
24616 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24617 appropriate. Unqualified addresses in header lines are qualified if they are in
24618 locally submitted messages, or messages from hosts that are permitted to send
24619 unqualified envelope addresses. Otherwise, unqualified addresses in header
24620 lines are neither qualified nor rewritten.
24621
24622 One situation in which Exim does &'not'& automatically rewrite a domain is
24623 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24624 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24625 do this. The new RFCs do not contain this suggestion.
24626
24627
24628 .section "Explicitly configured address rewriting" "SECID147"
24629 This chapter describes the rewriting rules that can be used in the
24630 main rewrite section of the configuration file, and also in the generic
24631 &%headers_rewrite%& option that can be set on any transport.
24632
24633 Some people believe that configured address rewriting is a Mortal Sin.
24634 Others believe that life is not possible without it. Exim provides the
24635 facility; you do not have to use it.
24636
24637 The main rewriting rules that appear in the &"rewrite"& section of the
24638 configuration file are applied to addresses in incoming messages, both envelope
24639 addresses and addresses in header lines. Each rule specifies the types of
24640 address to which it applies.
24641
24642 Whether or not addresses in header lines are rewritten depends on the origin of
24643 the headers and the type of rewriting. Global rewriting, that is, rewriting
24644 rules from the rewrite section of the configuration file, is applied only to
24645 those headers that were received with the message. Header lines that are added
24646 by ACLs or by a system filter or by individual routers or transports (which
24647 are specific to individual recipient addresses) are not rewritten by the global
24648 rules.
24649
24650 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24651 applies all headers except those added by routers and transports. That is, as
24652 well as the headers that were received with the message, it also applies to
24653 headers that were added by an ACL or a system filter.
24654
24655
24656 In general, rewriting addresses from your own system or domain has some
24657 legitimacy. Rewriting other addresses should be done only with great care and
24658 in special circumstances. The author of Exim believes that rewriting should be
24659 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24660 Although it can sometimes be used as a routing tool, this is very strongly
24661 discouraged.
24662
24663 There are two commonly encountered circumstances where rewriting is used, as
24664 illustrated by these examples:
24665
24666 .ilist
24667 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24668 exchange mail with each other behind a firewall, but there is only a single
24669 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24670 &'hitch.fict.example'& when sending mail off-site.
24671 .next
24672 A host rewrites the local parts of its own users so that, for example,
24673 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24674 .endlist
24675
24676
24677
24678 .section "When does rewriting happen?" "SECID148"
24679 .cindex "rewriting" "timing of"
24680 .cindex "&ACL;" "rewriting addresses in"
24681 Configured address rewriting can take place at several different stages of a
24682 message's processing.
24683
24684 .vindex "&$sender_address$&"
24685 At the start of an ACL for MAIL, the sender address may have been rewritten
24686 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24687 ordinary rewrite rules have yet been applied. If, however, the sender address
24688 is verified in the ACL, it is rewritten before verification, and remains
24689 rewritten thereafter. The subsequent value of &$sender_address$& is the
24690 rewritten address. This also applies if sender verification happens in a
24691 RCPT ACL. Otherwise, when the sender address is not verified, it is
24692 rewritten as soon as a message's header lines have been received.
24693
24694 .vindex "&$domain$&"
24695 .vindex "&$local_part$&"
24696 Similarly, at the start of an ACL for RCPT, the current recipient's address
24697 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24698 rewrite rules have yet been applied to it. However, the behaviour is different
24699 from the sender address when a recipient is verified. The address is rewritten
24700 for the verification, but the rewriting is not remembered at this stage. The
24701 value of &$local_part$& and &$domain$& after verification are always the same
24702 as they were before (that is, they contain the unrewritten &-- except for
24703 SMTP-time rewriting &-- address).
24704
24705 As soon as a message's header lines have been received, all the envelope
24706 recipient addresses are permanently rewritten, and rewriting is also applied to
24707 the addresses in the header lines (if configured). This happens before adding
24708 any header lines that were specified in MAIL or RCPT ACLs, and
24709 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24710 before the DATA ACL and &[local_scan()]& functions are run.
24711
24712 When an address is being routed, either for delivery or for verification,
24713 rewriting is applied immediately to child addresses that are generated by
24714 redirection, unless &%no_rewrite%& is set on the router.
24715
24716 .cindex "envelope sender" "rewriting at transport time"
24717 .cindex "rewriting" "at transport time"
24718 .cindex "header lines" "rewriting at transport time"
24719 At transport time, additional rewriting of addresses in header lines can be
24720 specified by setting the generic &%headers_rewrite%& option on a transport.
24721 This option contains rules that are identical in form to those in the rewrite
24722 section of the configuration file. They are applied to the original message
24723 header lines and any that were added by ACLs or a system filter. They are not
24724 applied to header lines that are added by routers or the transport.
24725
24726 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24727 transport option. However, it is not possible to rewrite envelope recipients at
24728 transport time.
24729
24730
24731
24732
24733 .section "Testing the rewriting rules that apply on input" "SECID149"
24734 .cindex "rewriting" "testing"
24735 .cindex "testing" "rewriting"
24736 Exim's input rewriting configuration appears in a part of the run time
24737 configuration file headed by &"begin rewrite"&. It can be tested by the
24738 &%-brw%& command line option. This takes an address (which can be a full RFC
24739 2822 address) as its argument. The output is a list of how the address would be
24740 transformed by the rewriting rules for each of the different places it might
24741 appear in an incoming message, that is, for each different header and for the
24742 envelope sender and recipient fields. For example,
24743 .code
24744 exim -brw ph10@exim.workshop.example
24745 .endd
24746 might produce the output
24747 .code
24748 sender: Philip.Hazel@exim.workshop.example
24749 from: Philip.Hazel@exim.workshop.example
24750 to: ph10@exim.workshop.example
24751 cc: ph10@exim.workshop.example
24752 bcc: ph10@exim.workshop.example
24753 reply-to: Philip.Hazel@exim.workshop.example
24754 env-from: Philip.Hazel@exim.workshop.example
24755 env-to: ph10@exim.workshop.example
24756 .endd
24757 which shows that rewriting has been set up for that address when used in any of
24758 the source fields, but not when it appears as a recipient address. At the
24759 present time, there is no equivalent way of testing rewriting rules that are
24760 set for a particular transport.
24761
24762
24763 .section "Rewriting rules" "SECID150"
24764 .cindex "rewriting" "rules"
24765 The rewrite section of the configuration file consists of lines of rewriting
24766 rules in the form
24767 .display
24768 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24769 .endd
24770 Rewriting rules that are specified for the &%headers_rewrite%& generic
24771 transport option are given as a colon-separated list. Each item in the list
24772 takes the same form as a line in the main rewriting configuration (except that
24773 any colons must be doubled, of course).
24774
24775 The formats of source patterns and replacement strings are described below.
24776 Each is terminated by white space, unless enclosed in double quotes, in which
24777 case normal quoting conventions apply inside the quotes. The flags are single
24778 characters which may appear in any order. Spaces and tabs between them are
24779 ignored.
24780
24781 For each address that could potentially be rewritten, the rules are scanned in
24782 order, and replacements for the address from earlier rules can themselves be
24783 replaced by later rules (but see the &"q"& and &"R"& flags).
24784
24785 The order in which addresses are rewritten is undefined, may change between
24786 releases, and must not be relied on, with one exception: when a message is
24787 received, the envelope sender is always rewritten first, before any header
24788 lines are rewritten. For example, the replacement string for a rewrite of an
24789 address in &'To:'& must not assume that the message's address in &'From:'& has
24790 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24791 that the envelope sender has already been rewritten.
24792
24793 .vindex "&$domain$&"
24794 .vindex "&$local_part$&"
24795 The variables &$local_part$& and &$domain$& can be used in the replacement
24796 string to refer to the address that is being rewritten. Note that lookup-driven
24797 rewriting can be done by a rule of the form
24798 .code
24799 *@*   ${lookup ...
24800 .endd
24801 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24802 refer to the address that is being rewritten.
24803
24804
24805 .section "Rewriting patterns" "SECID151"
24806 .cindex "rewriting" "patterns"
24807 .cindex "address list" "in a rewriting pattern"
24808 The source pattern in a rewriting rule is any item which may appear in an
24809 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24810 single-item address list, which means that it is expanded before being tested
24811 against the address. As always, if you use a regular expression as a pattern,
24812 you must take care to escape dollar and backslash characters, or use the &`\N`&
24813 facility to suppress string expansion within the regular expression.
24814
24815 Domains in patterns should be given in lower case. Local parts in patterns are
24816 case-sensitive. If you want to do case-insensitive matching of local parts, you
24817 can use a regular expression that starts with &`^(?i)`&.
24818
24819 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24820 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24821 depending on the type of match which occurred. These can be used in the
24822 replacement string to insert portions of the incoming address. &$0$& always
24823 refers to the complete incoming address. When a regular expression is used, the
24824 numerical variables are set from its capturing subexpressions. For other types
24825 of pattern they are set as follows:
24826
24827 .ilist
24828 If a local part or domain starts with an asterisk, the numerical variables
24829 refer to the character strings matched by asterisks, with &$1$& associated with
24830 the first asterisk, and &$2$& with the second, if present. For example, if the
24831 pattern
24832 .code
24833 *queen@*.fict.example
24834 .endd
24835 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24836 .code
24837 $0 = hearts-queen@wonderland.fict.example
24838 $1 = hearts-
24839 $2 = wonderland
24840 .endd
24841 Note that if the local part does not start with an asterisk, but the domain
24842 does, it is &$1$& that contains the wild part of the domain.
24843
24844 .next
24845 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24846 of the domain are placed in the next available numerical variables. Suppose,
24847 for example, that the address &'foo@bar.baz.example'& is processed by a
24848 rewriting rule of the form
24849 .display
24850 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24851 .endd
24852 and the key in the file that matches the domain is &`*.baz.example`&. Then
24853 .code
24854 $1 = foo
24855 $2 = bar
24856 $3 = baz.example
24857 .endd
24858 If the address &'foo@baz.example'& is looked up, this matches the same
24859 wildcard file entry, and in this case &$2$& is set to the empty string, but
24860 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24861 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24862 whole domain. For non-partial domain lookups, no numerical variables are set.
24863 .endlist
24864
24865
24866 .section "Rewriting replacements" "SECID152"
24867 .cindex "rewriting" "replacements"
24868 If the replacement string for a rule is a single asterisk, addresses that
24869 match the pattern and the flags are &'not'& rewritten, and no subsequent
24870 rewriting rules are scanned. For example,
24871 .code
24872 hatta@lookingglass.fict.example  *  f
24873 .endd
24874 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24875 &'From:'& headers.
24876
24877 .vindex "&$domain$&"
24878 .vindex "&$local_part$&"
24879 If the replacement string is not a single asterisk, it is expanded, and must
24880 yield a fully qualified address. Within the expansion, the variables
24881 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24882 Any letters they contain retain their original case &-- they are not lower
24883 cased. The numerical variables are set up according to the type of pattern that
24884 matched the address, as described above. If the expansion is forced to fail by
24885 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24886 current rule is abandoned, but subsequent rules may take effect. Any other
24887 expansion failure causes the entire rewriting operation to be abandoned, and an
24888 entry written to the panic log.
24889
24890
24891
24892 .section "Rewriting flags" "SECID153"
24893 There are three different kinds of flag that may appear on rewriting rules:
24894
24895 .ilist
24896 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24897 c, f, h, r, s, t.
24898 .next
24899 A flag that specifies rewriting at SMTP time: S.
24900 .next
24901 Flags that control the rewriting process: Q, q, R, w.
24902 .endlist
24903
24904 For rules that are part of the &%headers_rewrite%& generic transport option,
24905 E, F, T, and S are not permitted.
24906
24907
24908
24909 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24910          "SECID154"
24911 .cindex "rewriting" "flags"
24912 If none of the following flag letters, nor the &"S"& flag (see section
24913 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24914 and to both the sender and recipient fields of the envelope, whereas a
24915 transport-time rewriting rule just applies to all headers. Otherwise, the
24916 rewriting rule is skipped unless the relevant addresses are being processed.
24917 .display
24918 &`E`&       rewrite all envelope fields
24919 &`F`&       rewrite the envelope From field
24920 &`T`&       rewrite the envelope To field
24921 &`b`&       rewrite the &'Bcc:'& header
24922 &`c`&       rewrite the &'Cc:'& header
24923 &`f`&       rewrite the &'From:'& header
24924 &`h`&       rewrite all headers
24925 &`r`&       rewrite the &'Reply-To:'& header
24926 &`s`&       rewrite the &'Sender:'& header
24927 &`t`&       rewrite the &'To:'& header
24928 .endd
24929 "All headers" means all of the headers listed above that can be selected
24930 individually, plus their &'Resent-'& versions. It does not include
24931 other headers such as &'Subject:'& etc.
24932
24933 You should be particularly careful about rewriting &'Sender:'& headers, and
24934 restrict this to special known cases in your own domains.
24935
24936
24937 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24938 .cindex "SMTP" "rewriting malformed addresses"
24939 .cindex "RCPT" "rewriting argument of"
24940 .cindex "MAIL" "rewriting argument of"
24941 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24942 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24943 before any other processing; even before syntax checking. The pattern is
24944 required to be a regular expression, and it is matched against the whole of the
24945 data for the command, including any surrounding angle brackets.
24946
24947 .vindex "&$domain$&"
24948 .vindex "&$local_part$&"
24949 This form of rewrite rule allows for the handling of addresses that are not
24950 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24951 input). Because the input is not required to be a syntactically valid address,
24952 the variables &$local_part$& and &$domain$& are not available during the
24953 expansion of the replacement string. The result of rewriting replaces the
24954 original address in the MAIL or RCPT command.
24955
24956
24957 .section "Flags controlling the rewriting process" "SECID155"
24958 There are four flags which control the way the rewriting process works. These
24959 take effect only when a rule is invoked, that is, when the address is of the
24960 correct type (matches the flags) and matches the pattern:
24961
24962 .ilist
24963 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24964 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24965 absence of &"Q"& the rewritten address must always include a domain.
24966 .next
24967 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24968 even if no rewriting actually takes place because of a &"fail"& in the
24969 expansion. The &"q"& flag is not effective if the address is of the wrong type
24970 (does not match the flags) or does not match the pattern.
24971 .next
24972 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24973 address, up to ten times. It can be combined with the &"q"& flag, to stop
24974 rewriting once it fails to match (after at least one successful rewrite).
24975 .next
24976 .cindex "rewriting" "whole addresses"
24977 When an address in a header is rewritten, the rewriting normally applies only
24978 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24979 left unchanged. For example, rewriting might change
24980 .code
24981 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24982 .endd
24983 into
24984 .code
24985 From: Ford Prefect <prefectf@hitch.fict.example>
24986 .endd
24987 .cindex "RFC 2047"
24988 Sometimes there is a need to replace the whole address item, and this can be
24989 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24990 causes an address in a header line to be rewritten, the entire address is
24991 replaced, not just the working part. The replacement must be a complete RFC
24992 2822 address, including the angle brackets if necessary. If text outside angle
24993 brackets contains a character whose value is greater than 126 or less than 32
24994 (except for tab), the text is encoded according to RFC 2047. The character set
24995 is taken from &%headers_charset%&, which gets its default at build time.
24996
24997 When the &"w"& flag is set on a rule that causes an envelope address to be
24998 rewritten, all but the working part of the replacement address is discarded.
24999 .endlist
25000
25001
25002 .section "Rewriting examples" "SECID156"
25003 Here is an example of the two common rewriting paradigms:
25004 .code
25005 *@*.hitch.fict.example  $1@hitch.fict.example
25006 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25007                      {$value}fail}@hitch.fict.example bctfrF
25008 .endd
25009 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25010 the string expansion to fail if the lookup does not succeed. In this context it
25011 has the effect of leaving the original address unchanged, but Exim goes on to
25012 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25013 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25014 explicitly, which would cause the rewritten address to be the same as before,
25015 at the cost of a small bit of processing. Not supplying either of these is an
25016 error, since the rewritten address would then contain no local part.
25017
25018 The first example above replaces the domain with a superior, more general
25019 domain. This may not be desirable for certain local parts. If the rule
25020 .code
25021 root@*.hitch.fict.example  *
25022 .endd
25023 were inserted before the first rule, rewriting would be suppressed for the
25024 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25025
25026 Rewriting can be made conditional on a number of tests, by making use of
25027 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25028 messages that originate outside the local host:
25029 .code
25030 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25031                          {$1@hitch.fict.example}fail}"
25032 .endd
25033 The replacement string is quoted in this example because it contains white
25034 space.
25035
25036 .cindex "rewriting" "bang paths"
25037 .cindex "bang paths" "rewriting"
25038 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25039 an address it treats it as an unqualified local part which it qualifies with
25040 the local qualification domain (if the source of the message is local or if the
25041 remote host is permitted to send unqualified addresses). Rewriting can
25042 sometimes be used to handle simple bang paths with a fixed number of
25043 components. For example, the rule
25044 .code
25045 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25046 .endd
25047 rewrites a two-component bang path &'host.name!user'& as the domain address
25048 &'user@host.name'&. However, there is a security implication in using this as
25049 a global rewriting rule for envelope addresses. It can provide a backdoor
25050 method for using your system as a relay, because the incoming addresses appear
25051 to be local. If the bang path addresses are received via SMTP, it is safer to
25052 use the &"S"& flag to rewrite them as they are received, so that relay checking
25053 can be done on the rewritten addresses.
25054 .ecindex IIDaddrew
25055
25056
25057
25058
25059
25060 . ////////////////////////////////////////////////////////////////////////////
25061 . ////////////////////////////////////////////////////////////////////////////
25062
25063 .chapter "Retry configuration" "CHAPretry"
25064 .scindex IIDretconf1 "retry" "configuration, description of"
25065 .scindex IIDregconf2 "configuration file" "retry section"
25066 The &"retry"& section of the runtime configuration file contains a list of
25067 retry rules that control how often Exim tries to deliver messages that cannot
25068 be delivered at the first attempt. If there are no retry rules (the section is
25069 empty or not present), there are no retries. In this situation, temporary
25070 errors are treated as permanent. The default configuration contains a single,
25071 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25072 line option can be used to test which retry rule will be used for a given
25073 address, domain and error.
25074
25075 The most common cause of retries is temporary failure to deliver to a remote
25076 host because the host is down, or inaccessible because of a network problem.
25077 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25078 address) basis, not on a per-message basis. Thus, if one message has recently
25079 been delayed, delivery of a new message to the same host is not immediately
25080 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25081 log selector is set, the message
25082 .cindex "retry" "time not reached"
25083 &"retry time not reached"& is written to the main log whenever a delivery is
25084 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25085 the handling of errors during remote deliveries.
25086
25087 Retry processing applies to routing as well as to delivering, except as covered
25088 in the next paragraph. The retry rules do not distinguish between these
25089 actions. It is not possible, for example, to specify different behaviour for
25090 failures to route the domain &'snark.fict.example'& and failures to deliver to
25091 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25092 added complication, so did not implement it. However, although they share the
25093 same retry rule, the actual retry times for routing and transporting a given
25094 domain are maintained independently.
25095
25096 When a delivery is not part of a queue run (typically an immediate delivery on
25097 receipt of a message), the routers are always run, and local deliveries are
25098 always attempted, even if retry times are set for them. This makes for better
25099 behaviour if one particular message is causing problems (for example, causing
25100 quota overflow, or provoking an error in a filter file). If such a delivery
25101 suffers a temporary failure, the retry data is updated as normal, and
25102 subsequent delivery attempts from queue runs occur only when the retry time for
25103 the local address is reached.
25104
25105 .section "Changing retry rules" "SECID157"
25106 If you change the retry rules in your configuration, you should consider
25107 whether or not to delete the retry data that is stored in Exim's spool area in
25108 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25109 always safe; that is why they are called &"hints"&.
25110
25111 The hints retry data contains suggested retry times based on the previous
25112 rules. In the case of a long-running problem with a remote host, it might
25113 record the fact that the host has timed out. If your new rules increase the
25114 timeout time for such a host, you should definitely remove the old retry data
25115 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25116 messages that it should now be retaining.
25117
25118
25119
25120 .section "Format of retry rules" "SECID158"
25121 .cindex "retry" "rules"
25122 Each retry rule occupies one line and consists of three or four parts,
25123 separated by white space: a pattern, an error name, an optional list of sender
25124 addresses, and a list of retry parameters. The pattern and sender lists must be
25125 enclosed in double quotes if they contain white space. The rules are searched
25126 in order until one is found where the pattern, error name, and sender list (if
25127 present) match the failing host or address, the error that occurred, and the
25128 message's sender, respectively.
25129
25130
25131 The pattern is any single item that may appear in an address list (see section
25132 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25133 which means that it is expanded before being tested against the address that
25134 has been delayed. A negated address list item is permitted. Address
25135 list processing treats a plain domain name as if it were preceded by &"*@"&,
25136 which makes it possible for many retry rules to start with just a domain. For
25137 example,
25138 .code
25139 lookingglass.fict.example        *  F,24h,30m;
25140 .endd
25141 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25142 whereas
25143 .code
25144 alice@lookingglass.fict.example  *  F,24h,30m;
25145 .endd
25146 applies only to temporary failures involving the local part &%alice%&.
25147 In practice, almost all rules start with a domain name pattern without a local
25148 part.
25149
25150 .cindex "regular expressions" "in retry rules"
25151 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25152 must match a complete address, not just a domain, because that is how regular
25153 expressions work in address lists.
25154 .display
25155 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25156 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25157 .endd
25158
25159
25160 .section "Choosing which retry rule to use for address errors" "SECID159"
25161 When Exim is looking for a retry rule after a routing attempt has failed (for
25162 example, after a DNS timeout), each line in the retry configuration is tested
25163 against the complete address only if &%retry_use_local_part%& is set for the
25164 router. Otherwise, only the domain is used, except when matching against a
25165 regular expression, when the local part of the address is replaced with &"*"&.
25166 A domain on its own can match a domain pattern, or a pattern that starts with
25167 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25168 &%check_local_user%& is true, and false for other routers.
25169
25170 Similarly, when Exim is looking for a retry rule after a local delivery has
25171 failed (for example, after a mailbox full error), each line in the retry
25172 configuration is tested against the complete address only if
25173 &%retry_use_local_part%& is set for the transport (it defaults true for all
25174 local transports).
25175
25176 .cindex "4&'xx'& responses" "retry rules for"
25177 However, when Exim is looking for a retry rule after a remote delivery attempt
25178 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25179 whole address is always used as the key when searching the retry rules. The
25180 rule that is found is used to create a retry time for the combination of the
25181 failing address and the message's sender. It is the combination of sender and
25182 recipient that is delayed in subsequent queue runs until its retry time is
25183 reached. You can delay the recipient without regard to the sender by setting
25184 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25185 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25186 commands.
25187
25188
25189
25190 .section "Choosing which retry rule to use for host and message errors" &&&
25191          "SECID160"
25192 For a temporary error that is not related to an individual address (for
25193 example, a connection timeout), each line in the retry configuration is checked
25194 twice. First, the name of the remote host is used as a domain name (preceded by
25195 &"*@"& when matching a regular expression). If this does not match the line,
25196 the domain from the email address is tried in a similar fashion. For example,
25197 suppose the MX records for &'a.b.c.example'& are
25198 .code
25199 a.b.c.example  MX  5  x.y.z.example
25200                MX  6  p.q.r.example
25201                MX  7  m.n.o.example
25202 .endd
25203 and the retry rules are
25204 .code
25205 p.q.r.example    *      F,24h,30m;
25206 a.b.c.example    *      F,4d,45m;
25207 .endd
25208 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25209 first rule matches neither the host nor the domain, so Exim looks at the second
25210 rule. This does not match the host, but it does match the domain, so it is used
25211 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25212 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25213 first retry rule is used, because it matches the host.
25214
25215 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25216 first rule to determine retry times, but for all the other hosts for the domain
25217 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25218 routing to &'a.b.c.example'& suffers a temporary failure.
25219
25220 &*Note*&: The host name is used when matching the patterns, not its IP address.
25221 However, if a message is routed directly to an IP address without the use of a
25222 host name, for example, if a &(manualroute)& router contains a setting such as:
25223 .code
25224 route_list = *.a.example  192.168.34.23
25225 .endd
25226 then the &"host name"& that is used when searching for a retry rule is the
25227 textual form of the IP address.
25228
25229 .section "Retry rules for specific errors" "SECID161"
25230 .cindex "retry" "specific errors; specifying"
25231 The second field in a retry rule is the name of a particular error, or an
25232 asterisk, which matches any error. The errors that can be tested for are:
25233
25234 .vlist
25235 .vitem &%auth_failed%&
25236 Authentication failed when trying to send to a host in the
25237 &%hosts_require_auth%& list in an &(smtp)& transport.
25238
25239 .vitem &%data_4xx%&
25240 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25241 after the command, or after sending the message's data.
25242
25243 .vitem &%mail_4xx%&
25244 A 4&'xx'& error was received for an outgoing MAIL command.
25245
25246 .vitem &%rcpt_4xx%&
25247 A 4&'xx'& error was received for an outgoing RCPT command.
25248 .endlist
25249
25250 For the three 4&'xx'& errors, either the first or both of the x's can be given
25251 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25252 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25253 and have retries every ten minutes with a one-hour timeout, you could set up a
25254 retry rule of this form:
25255 .code
25256 the.domain.name  rcpt_452   F,1h,10m
25257 .endd
25258 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25259 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25260
25261 .vlist
25262 .vitem &%lost_connection%&
25263 A server unexpectedly closed the SMTP connection. There may, of course,
25264 legitimate reasons for this (host died, network died), but if it repeats a lot
25265 for the same host, it indicates something odd.
25266
25267 .vitem &%lookup%&
25268 A DNS lookup for a host failed.
25269 Note that a &%dnslookup%& router will need to have matched
25270 its &%fail_defer_domains%& option for this retry type to be usable.
25271 Also note that a &%manualroute%& router will probably need
25272 its &%host_find_failed%& option set to &%defer%&.
25273
25274 .vitem &%refused_MX%&
25275 A connection to a host obtained from an MX record was refused.
25276
25277 .vitem &%refused_A%&
25278 A connection to a host not obtained from an MX record was refused.
25279
25280 .vitem &%refused%&
25281 A connection was refused.
25282
25283 .vitem &%timeout_connect_MX%&
25284 A connection attempt to a host obtained from an MX record timed out.
25285
25286 .vitem &%timeout_connect_A%&
25287 A connection attempt to a host not obtained from an MX record timed out.
25288
25289 .vitem &%timeout_connect%&
25290 A connection attempt timed out.
25291
25292 .vitem &%timeout_MX%&
25293 There was a timeout while connecting or during an SMTP session with a host
25294 obtained from an MX record.
25295
25296 .vitem &%timeout_A%&
25297 There was a timeout while connecting or during an SMTP session with a host not
25298 obtained from an MX record.
25299
25300 .vitem &%timeout%&
25301 There was a timeout while connecting or during an SMTP session.
25302
25303 .vitem &%tls_required%&
25304 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25305 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25306 to STARTTLS, or there was a problem setting up the TLS connection.
25307
25308 .vitem &%quota%&
25309 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25310 transport.
25311
25312 .vitem &%quota_%&<&'time'&>
25313 .cindex "quota" "error testing in retry rule"
25314 .cindex "retry" "quota error testing"
25315 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25316 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25317 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25318 for four days.
25319 .endlist
25320
25321 .cindex "mailbox" "time of last read"
25322 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25323 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25324 it should be based on the last time that the user accessed the mailbox.
25325 However, it is not always possible to determine this. Exim uses the following
25326 heuristic rules:
25327
25328 .ilist
25329 If the mailbox is a single file, the time of last access (the &"atime"&) is
25330 used. As no new messages are being delivered (because the mailbox is over
25331 quota), Exim does not access the file, so this is the time of last user access.
25332 .next
25333 .cindex "maildir format" "time of last read"
25334 For a maildir delivery, the time of last modification of the &_new_&
25335 subdirectory is used. As the mailbox is over quota, no new files are created in
25336 the &_new_& subdirectory, because no new messages are being delivered. Any
25337 change to the &_new_& subdirectory is therefore assumed to be the result of an
25338 MUA moving a new message to the &_cur_& directory when it is first read. The
25339 time that is used is therefore the last time that the user read a new message.
25340 .next
25341 For other kinds of multi-file mailbox, the time of last access cannot be
25342 obtained, so a retry rule that uses this type of error field is never matched.
25343 .endlist
25344
25345 The quota errors apply both to system-enforced quotas and to Exim's own quota
25346 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25347 when a local delivery is deferred because a partition is full (the ENOSPC
25348 error).
25349
25350
25351
25352 .section "Retry rules for specified senders" "SECID162"
25353 .cindex "retry" "rules; sender-specific"
25354 You can specify retry rules that apply only when the failing message has a
25355 specific sender. In particular, this can be used to define retry rules that
25356 apply only to bounce messages. The third item in a retry rule can be of this
25357 form:
25358 .display
25359 &`senders=`&<&'address list'&>
25360 .endd
25361 The retry timings themselves are then the fourth item. For example:
25362 .code
25363 *   rcpt_4xx   senders=:   F,1h,30m
25364 .endd
25365 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25366 host. If the address list contains white space, it must be enclosed in quotes.
25367 For example:
25368 .code
25369 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25370 .endd
25371 &*Warning*&: This facility can be unhelpful if it is used for host errors
25372 (which do not depend on the recipient). The reason is that the sender is used
25373 only to match the retry rule. Once the rule has been found for a host error,
25374 its contents are used to set a retry time for the host, and this will apply to
25375 all messages, not just those with specific senders.
25376
25377 When testing retry rules using &%-brt%&, you can supply a sender using the
25378 &%-f%& command line option, like this:
25379 .code
25380 exim -f "" -brt user@dom.ain
25381 .endd
25382 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25383 list is never matched.
25384
25385
25386
25387
25388
25389 .section "Retry parameters" "SECID163"
25390 .cindex "retry" "parameters in rules"
25391 The third (or fourth, if a senders list is present) field in a retry rule is a
25392 sequence of retry parameter sets, separated by semicolons. Each set consists of
25393 .display
25394 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25395 .endd
25396 The letter identifies the algorithm for computing a new retry time; the cutoff
25397 time is the time beyond which this algorithm no longer applies, and the
25398 arguments vary the algorithm's action. The cutoff time is measured from the
25399 time that the first failure for the domain (combined with the local part if
25400 relevant) was detected, not from the time the message was received.
25401
25402 .cindex "retry" "algorithms"
25403 .cindex "retry" "fixed intervals"
25404 .cindex "retry" "increasing intervals"
25405 .cindex "retry" "random intervals"
25406 The available algorithms are:
25407
25408 .ilist
25409 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25410 the interval.
25411 .next
25412 &'G'&: retry at geometrically increasing intervals. The first argument
25413 specifies a starting value for the interval, and the second a multiplier, which
25414 is used to increase the size of the interval at each retry.
25415 .next
25416 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25417 retry, the previous interval is multiplied by the factor in order to get a
25418 maximum for the next interval. The minimum interval is the first argument of
25419 the parameter, and an actual interval is chosen randomly between them. Such a
25420 rule has been found to be helpful in cluster configurations when all the
25421 members of the cluster restart at once, and may therefore synchronize their
25422 queue processing times.
25423 .endlist
25424
25425 When computing the next retry time, the algorithm definitions are scanned in
25426 order until one whose cutoff time has not yet passed is reached. This is then
25427 used to compute a new retry time that is later than the current time. In the
25428 case of fixed interval retries, this simply means adding the interval to the
25429 current time. For geometrically increasing intervals, retry intervals are
25430 computed from the rule's parameters until one that is greater than the previous
25431 interval is found. The main configuration variable
25432 .cindex "limit" "retry interval"
25433 .cindex "retry" "interval, maximum"
25434 .oindex "&%retry_interval_max%&"
25435 &%retry_interval_max%& limits the maximum interval between retries. It
25436 cannot be set greater than &`24h`&, which is its default value.
25437
25438 A single remote domain may have a number of hosts associated with it, and each
25439 host may have more than one IP address. Retry algorithms are selected on the
25440 basis of the domain name, but are applied to each IP address independently. If,
25441 for example, a host has two IP addresses and one is unusable, Exim will
25442 generate retry times for it and will not try to use it until its next retry
25443 time comes. Thus the good IP address is likely to be tried first most of the
25444 time.
25445
25446 .cindex "hints database" "use for retrying"
25447 Retry times are hints rather than promises. Exim does not make any attempt to
25448 run deliveries exactly at the computed times. Instead, a queue runner process
25449 starts delivery processes for delayed messages periodically, and these attempt
25450 new deliveries only for those addresses that have passed their next retry time.
25451 If a new message arrives for a deferred address, an immediate delivery attempt
25452 occurs only if the address has passed its retry time. In the absence of new
25453 messages, the minimum time between retries is the interval between queue runner
25454 processes. There is not much point in setting retry times of five minutes if
25455 your queue runners happen only once an hour, unless there are a significant
25456 number of incoming messages (which might be the case on a system that is
25457 sending everything to a smart host, for example).
25458
25459 The data in the retry hints database can be inspected by using the
25460 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25461 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25462 &'exinext'& utility script can be used to find out what the next retry times
25463 are for the hosts associated with a particular mail domain, and also for local
25464 deliveries that have been deferred.
25465
25466
25467 .section "Retry rule examples" "SECID164"
25468 Here are some example retry rules:
25469 .code
25470 alice@wonderland.fict.example quota_5d  F,7d,3h
25471 wonderland.fict.example       quota_5d
25472 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25473 lookingglass.fict.example     *         F,24h,30m;
25474 *                 refused_A   F,2h,20m;
25475 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25476 .endd
25477 The first rule sets up special handling for mail to
25478 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25479 mailbox has not been read for at least 5 days. Retries continue every three
25480 hours for 7 days. The second rule handles over-quota errors for all other local
25481 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25482 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25483 fail are bounced immediately if the mailbox has not been read for at least 5
25484 days.
25485
25486 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25487 happen every 15 minutes for an hour, then with geometrically increasing
25488 intervals until two days have passed since a delivery first failed. After the
25489 first hour there is a delay of one hour, then two hours, then four hours, and
25490 so on (this is a rather extreme example).
25491
25492 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25493 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25494 all other domains, with special action for connection refusal from hosts that
25495 were not obtained from an MX record.
25496
25497 The final rule in a retry configuration should always have asterisks in the
25498 first two fields so as to provide a general catch-all for any addresses that do
25499 not have their own special handling. This example tries every 15 minutes for 2
25500 hours, then with intervals starting at one hour and increasing by a factor of
25501 1.5 up to 16 hours, then every 8 hours up to 5 days.
25502
25503
25504
25505 .section "Timeout of retry data" "SECID165"
25506 .cindex "timeout" "of retry data"
25507 .oindex "&%retry_data_expire%&"
25508 .cindex "hints database" "data expiry"
25509 .cindex "retry" "timeout of data"
25510 Exim timestamps the data that it writes to its retry hints database. When it
25511 consults the data during a delivery it ignores any that is older than the value
25512 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25513 been tried for 7 days, Exim will try to deliver to it immediately a message
25514 arrives, and if that fails, it will calculate a retry time as if it were
25515 failing for the first time.
25516
25517 This improves the behaviour for messages routed to rarely-used hosts such as MX
25518 backups. If such a host was down at one time, and happens to be down again when
25519 Exim tries a month later, using the old retry data would imply that it had been
25520 down all the time, which is not a justified assumption.
25521
25522 If a host really is permanently dead, this behaviour causes a burst of retries
25523 every now and again, but only if messages routed to it are rare. If there is a
25524 message at least once every 7 days the retry data never expires.
25525
25526
25527
25528
25529 .section "Long-term failures" "SECID166"
25530 .cindex "delivery failure, long-term"
25531 .cindex "retry" "after long-term failure"
25532 Special processing happens when an email address has been failing for so long
25533 that the cutoff time for the last algorithm is reached. For example, using the
25534 default retry rule:
25535 .code
25536 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25537 .endd
25538 the cutoff time is four days. Reaching the retry cutoff is independent of how
25539 long any specific message has been failing; it is the length of continuous
25540 failure for the recipient address that counts.
25541
25542 When the cutoff time is reached for a local delivery, or for all the IP
25543 addresses associated with a remote delivery, a subsequent delivery failure
25544 causes Exim to give up on the address, and a bounce message is generated.
25545 In order to cater for new messages that use the failing address, a next retry
25546 time is still computed from the final algorithm, and is used as follows:
25547
25548 For local deliveries, one delivery attempt is always made for any subsequent
25549 messages. If this delivery fails, the address fails immediately. The
25550 post-cutoff retry time is not used.
25551
25552 If the delivery is remote, there are two possibilities, controlled by the
25553 .oindex "&%delay_after_cutoff%&"
25554 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25555 default. Until the post-cutoff retry time for one of the IP addresses is
25556 reached, the failing email address is bounced immediately, without a delivery
25557 attempt taking place. After that time, one new delivery attempt is made to
25558 those IP addresses that are past their retry times, and if that still fails,
25559 the address is bounced and new retry times are computed.
25560
25561 In other words, when all the hosts for a given email address have been failing
25562 for a long time, Exim bounces rather then defers until one of the hosts' retry
25563 times is reached. Then it tries once, and bounces if that attempt fails. This
25564 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25565 to a broken destination, but if the host does recover, Exim will eventually
25566 notice.
25567
25568 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25569 addresses are past their final cutoff time, Exim tries to deliver to those IP
25570 addresses that have not been tried since the message arrived. If there are
25571 no suitable IP addresses, or if they all fail, the address is bounced. In other
25572 words, it does not delay when a new message arrives, but tries the expired
25573 addresses immediately, unless they have been tried since the message arrived.
25574 If there is a continuous stream of messages for the failing domains, setting
25575 &%delay_after_cutoff%& false means that there will be many more attempts to
25576 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25577 true.
25578
25579 .section "Deliveries that work intermittently" "SECID167"
25580 .cindex "retry" "intermittently working deliveries"
25581 Some additional logic is needed to cope with cases where a host is
25582 intermittently available, or when a message has some attribute that prevents
25583 its delivery when others to the same address get through. In this situation,
25584 because some messages are successfully delivered, the &"retry clock"& for the
25585 host or address keeps getting reset by the successful deliveries, and so
25586 failing messages remain on the queue for ever because the cutoff time is never
25587 reached.
25588
25589 Two exceptional actions are applied to prevent this happening. The first
25590 applies to errors that are related to a message rather than a remote host.
25591 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25592 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25593 commands, and quota failures. For this type of error, if a message's arrival
25594 time is earlier than the &"first failed"& time for the error, the earlier time
25595 is used when scanning the retry rules to decide when to try next and when to
25596 time out the address.
25597
25598 The exceptional second action applies in all cases. If a message has been on
25599 the queue for longer than the cutoff time of any applicable retry rule for a
25600 given address, a delivery is attempted for that address, even if it is not yet
25601 time, and if this delivery fails, the address is timed out. A new retry time is
25602 not computed in this case, so that other messages for the same address are
25603 considered immediately.
25604 .ecindex IIDretconf1
25605 .ecindex IIDregconf2
25606
25607
25608
25609
25610
25611
25612 . ////////////////////////////////////////////////////////////////////////////
25613 . ////////////////////////////////////////////////////////////////////////////
25614
25615 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25616 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25617 .scindex IIDauthconf2 "authentication"
25618 The &"authenticators"& section of Exim's run time configuration is concerned
25619 with SMTP authentication. This facility is an extension to the SMTP protocol,
25620 described in RFC 2554, which allows a client SMTP host to authenticate itself
25621 to a server. This is a common way for a server to recognize clients that are
25622 permitted to use it as a relay. SMTP authentication is not of relevance to the
25623 transfer of mail between servers that have no managerial connection with each
25624 other.
25625
25626 .cindex "AUTH" "description of"
25627 Very briefly, the way SMTP authentication works is as follows:
25628
25629 .ilist
25630 The server advertises a number of authentication &'mechanisms'& in response to
25631 the client's EHLO command.
25632 .next
25633 The client issues an AUTH command, naming a specific mechanism. The command
25634 may, optionally, contain some authentication data.
25635 .next
25636 The server may issue one or more &'challenges'&, to which the client must send
25637 appropriate responses. In simple authentication mechanisms, the challenges are
25638 just prompts for user names and passwords. The server does not have to issue
25639 any challenges &-- in some mechanisms the relevant data may all be transmitted
25640 with the AUTH command.
25641 .next
25642 The server either accepts or denies authentication.
25643 .next
25644 If authentication succeeds, the client may optionally make use of the AUTH
25645 option on the MAIL command to pass an authenticated sender in subsequent
25646 mail transactions. Authentication lasts for the remainder of the SMTP
25647 connection.
25648 .next
25649 If authentication fails, the client may give up, or it may try a different
25650 authentication mechanism, or it may try transferring mail over the
25651 unauthenticated connection.
25652 .endlist
25653
25654 If you are setting up a client, and want to know which authentication
25655 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25656 SMTP port) on the server, and issue an EHLO command. The response to this
25657 includes the list of supported mechanisms. For example:
25658 .display
25659 &`$ `&&*&`telnet server.example 25`&*&
25660 &`Trying 192.168.34.25...`&
25661 &`Connected to server.example.`&
25662 &`Escape character is &#x0027;^]&#x0027;.`&
25663 &`220 server.example ESMTP Exim 4.20 ...`&
25664 &*&`ehlo client.example`&*&
25665 &`250-server.example Hello client.example [10.8.4.5]`&
25666 &`250-SIZE 52428800`&
25667 &`250-PIPELINING`&
25668 &`250-AUTH PLAIN`&
25669 &`250 HELP`&
25670 .endd
25671 The second-last line of this example output shows that the server supports
25672 authentication using the PLAIN mechanism. In Exim, the different authentication
25673 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25674 routers and transports, which authenticators are included in the binary is
25675 controlled by build-time definitions. The following are currently available,
25676 included by setting
25677 .code
25678 AUTH_CRAM_MD5=yes
25679 AUTH_CYRUS_SASL=yes
25680 AUTH_DOVECOT=yes
25681 AUTH_GSASL=yes
25682 AUTH_HEIMDAL_GSSAPI=yes
25683 AUTH_PLAINTEXT=yes
25684 AUTH_SPA=yes
25685 AUTH_TLS=yes
25686 .endd
25687 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25688 authentication mechanism (RFC 2195), and the second provides an interface to
25689 the Cyrus SASL authentication library.
25690 The third is an interface to Dovecot's authentication system, delegating the
25691 work via a socket interface.
25692 The fourth provides an interface to the GNU SASL authentication library, which
25693 provides mechanisms but typically not data sources.
25694 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25695 supporting setting a server keytab.
25696 The sixth can be configured to support
25697 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25698 not formally documented, but used by several MUAs. The seventh authenticator
25699 supports Microsoft's &'Secure Password Authentication'& mechanism.
25700 The eighth is an Exim authenticator but not an SMTP one;
25701 instead it can use information from a TLS negotiation.
25702
25703 The authenticators are configured using the same syntax as other drivers (see
25704 section &<<SECTfordricon>>&). If no authenticators are required, no
25705 authentication section need be present in the configuration file. Each
25706 authenticator can in principle have both server and client functions. When Exim
25707 is receiving SMTP mail, it is acting as a server; when it is sending out
25708 messages over SMTP, it is acting as a client. Authenticator configuration
25709 options are provided for use in both these circumstances.
25710
25711 To make it clear which options apply to which situation, the prefixes
25712 &%server_%& and &%client_%& are used on option names that are specific to
25713 either the server or the client function, respectively. Server and client
25714 functions are disabled if none of their options are set. If an authenticator is
25715 to be used for both server and client functions, a single definition, using
25716 both sets of options, is required. For example:
25717 .code
25718 cram:
25719   driver = cram_md5
25720   public_name = CRAM-MD5
25721   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25722   client_name = ph10
25723   client_secret = secret2
25724 .endd
25725 The &%server_%& option is used when Exim is acting as a server, and the
25726 &%client_%& options when it is acting as a client.
25727
25728 Descriptions of the individual authenticators are given in subsequent chapters.
25729 The remainder of this chapter covers the generic options for the
25730 authenticators, followed by general discussion of the way authentication works
25731 in Exim.
25732
25733 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25734 per-mechanism basis.  Please read carefully to determine which variables hold
25735 account labels such as usercodes and which hold passwords or other
25736 authenticating data.
25737
25738 Note that some mechanisms support two different identifiers for accounts: the
25739 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25740 and &'authz'& are commonly encountered.  The American spelling is standard here.
25741 Conceptually, authentication data such as passwords are tied to the identifier
25742 used to authenticate; servers may have rules to permit one user to act as a
25743 second user, so that after login the session is treated as though that second
25744 user had logged in.  That second user is the &'authorization id'&.  A robust
25745 configuration might confirm that the &'authz'& field is empty or matches the
25746 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25747 as verified data, the &'authz'& as an unverified request which the server might
25748 choose to honour.
25749
25750 A &'realm'& is a text string, typically a domain name, presented by a server
25751 to a client to help it select an account and credentials to use.  In some
25752 mechanisms, the client and server provably agree on the realm, but clients
25753 typically can not treat the realm as secure data to be blindly trusted.
25754
25755
25756
25757 .section "Generic options for authenticators" "SECID168"
25758 .cindex "authentication" "generic options"
25759 .cindex "options" "generic; for authenticators"
25760
25761 .option client_condition authenticators string&!! unset
25762 When Exim is authenticating as a client, it skips any authenticator whose
25763 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25764 used, for example, to skip plain text authenticators when the connection is not
25765 encrypted by a setting such as:
25766 .code
25767 client_condition = ${if !eq{$tls_out_cipher}{}}
25768 .endd
25769
25770
25771 .option client_set_id authenticators string&!! unset
25772 When client authentication succeeds, this condition is expanded; the
25773 result is used in the log lines for outbound messages.
25774 Typically it will be the user name used for authentication.
25775
25776
25777 .option driver authenticators string unset
25778 This option must always be set. It specifies which of the available
25779 authenticators is to be used.
25780
25781
25782 .option public_name authenticators string unset
25783 This option specifies the name of the authentication mechanism that the driver
25784 implements, and by which it is known to the outside world. These names should
25785 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25786 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25787 defaults to the driver's instance name.
25788
25789
25790 .option server_advertise_condition authenticators string&!! unset
25791 When a server is about to advertise an authentication mechanism, the condition
25792 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25793 mechanism is not advertised.
25794 If the expansion fails, the mechanism is not advertised. If the failure was not
25795 forced, and was not caused by a lookup defer, the incident is logged.
25796 See section &<<SECTauthexiser>>& below for further discussion.
25797
25798
25799 .option server_condition authenticators string&!! unset
25800 This option must be set for a &%plaintext%& server authenticator, where it
25801 is used directly to control authentication. See section &<<SECTplainserver>>&
25802 for details.
25803
25804 For the &(gsasl)& authenticator, this option is required for various
25805 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25806
25807 For the other authenticators, &%server_condition%& can be used as an additional
25808 authentication or authorization mechanism that is applied after the other
25809 authenticator conditions succeed. If it is set, it is expanded when the
25810 authenticator would otherwise return a success code. If the expansion is forced
25811 to fail, authentication fails. Any other expansion failure causes a temporary
25812 error code to be returned. If the result of a successful expansion is an empty
25813 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25814 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25815 other result, a temporary error code is returned, with the expanded string as
25816 the error text.
25817
25818
25819 .option server_debug_print authenticators string&!! unset
25820 If this option is set and authentication debugging is enabled (see the &%-d%&
25821 command line option), the string is expanded and included in the debugging
25822 output when the authenticator is run as a server. This can help with checking
25823 out the values of variables.
25824 If expansion of the string fails, the error message is written to the debugging
25825 output, and Exim carries on processing.
25826
25827
25828 .option server_set_id authenticators string&!! unset
25829 .vindex "&$authenticated_id$&"
25830 When an Exim server successfully authenticates a client, this string is
25831 expanded using data from the authentication, and preserved for any incoming
25832 messages in the variable &$authenticated_id$&. It is also included in the log
25833 lines for incoming messages. For example, a user/password authenticator
25834 configuration might preserve the user name that was used to authenticate, and
25835 refer to it subsequently during delivery of the message.
25836 If expansion fails, the option is ignored.
25837
25838
25839 .option server_mail_auth_condition authenticators string&!! unset
25840 This option allows a server to discard authenticated sender addresses supplied
25841 as part of MAIL commands in SMTP connections that are authenticated by the
25842 driver on which &%server_mail_auth_condition%& is set. The option is not used
25843 as part of the authentication process; instead its (unexpanded) value is
25844 remembered for later use.
25845 How it is used is described in the following section.
25846
25847
25848
25849
25850
25851 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25852 .cindex "authentication" "sender; authenticated"
25853 .cindex "AUTH" "on MAIL command"
25854 When a client supplied an AUTH= item on a MAIL command, Exim applies
25855 the following checks before accepting it as the authenticated sender of the
25856 message:
25857
25858 .ilist
25859 If the connection is not using extended SMTP (that is, HELO was used rather
25860 than EHLO), the use of AUTH= is a syntax error.
25861 .next
25862 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25863 .next
25864 .vindex "&$authenticated_sender$&"
25865 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25866 running, the value of &$authenticated_sender$& is set to the value obtained
25867 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25868 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25869 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25870 given for the MAIL command.
25871 .next
25872 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25873 is accepted and placed in &$authenticated_sender$& only if the client has
25874 authenticated.
25875 .next
25876 If the AUTH= value was accepted by either of the two previous rules, and
25877 the client has authenticated, and the authenticator has a setting for the
25878 &%server_mail_auth_condition%&, the condition is checked at this point. The
25879 valued that was saved from the authenticator is expanded. If the expansion
25880 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25881 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25882 the value of &$authenticated_sender$& is retained and passed on with the
25883 message.
25884 .endlist
25885
25886
25887 When &$authenticated_sender$& is set for a message, it is passed on to other
25888 hosts to which Exim authenticates as a client. Do not confuse this value with
25889 &$authenticated_id$&, which is a string obtained from the authentication
25890 process, and which is not usually a complete email address.
25891
25892 .vindex "&$sender_address$&"
25893 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25894 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25895 therefore make use of &$authenticated_sender$&. The converse is not true: the
25896 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25897 ACL is run.
25898
25899
25900
25901 .section "Authentication on an Exim server" "SECTauthexiser"
25902 .cindex "authentication" "on an Exim server"
25903 When Exim receives an EHLO command, it advertises the public names of those
25904 authenticators that are configured as servers, subject to the following
25905 conditions:
25906
25907 .ilist
25908 The client host must match &%auth_advertise_hosts%& (default *).
25909 .next
25910 It the &%server_advertise_condition%& option is set, its expansion must not
25911 yield the empty string, &"0"&, &"no"&, or &"false"&.
25912 .endlist
25913
25914 The order in which the authenticators are defined controls the order in which
25915 the mechanisms are advertised.
25916
25917 Some mail clients (for example, some versions of Netscape) require the user to
25918 provide a name and password for authentication whenever AUTH is advertised,
25919 even though authentication may not in fact be needed (for example, Exim may be
25920 set up to allow unconditional relaying from the client by an IP address check).
25921 You can make such clients more friendly by not advertising AUTH to them.
25922 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25923 that runs for RCPT) to relay without authentication, you should set
25924 .code
25925 auth_advertise_hosts = ! 10.9.8.0/24
25926 .endd
25927 so that no authentication mechanisms are advertised to them.
25928
25929 The &%server_advertise_condition%& controls the advertisement of individual
25930 authentication mechanisms. For example, it can be used to restrict the
25931 advertisement of a particular mechanism to encrypted connections, by a setting
25932 such as:
25933 .code
25934 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25935 .endd
25936 .vindex "&$tls_in_cipher$&"
25937 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25938 yields &"yes"&, which allows the advertisement to happen.
25939
25940 When an Exim server receives an AUTH command from a client, it rejects it
25941 immediately if AUTH was not advertised in response to an earlier EHLO
25942 command. This is the case if
25943
25944 .ilist
25945 The client host does not match &%auth_advertise_hosts%&; or
25946 .next
25947 No authenticators are configured with server options; or
25948 .next
25949 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25950 server authenticators.
25951 .endlist
25952
25953
25954 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25955 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25956 AUTH is accepted from any client host.
25957
25958 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25959 server authentication mechanism that was advertised in response to EHLO and
25960 that matches the one named in the AUTH command. If it finds one, it runs
25961 the appropriate authentication protocol, and authentication either succeeds or
25962 fails. If there is no matching advertised mechanism, the AUTH command is
25963 rejected with a 504 error.
25964
25965 .vindex "&$received_protocol$&"
25966 .vindex "&$sender_host_authenticated$&"
25967 When a message is received from an authenticated host, the value of
25968 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25969 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25970 public name) of the authenticator driver that successfully authenticated the
25971 client from which the message was received. This variable is empty if there was
25972 no successful authentication.
25973
25974
25975
25976
25977 .section "Testing server authentication" "SECID169"
25978 .cindex "authentication" "testing a server"
25979 .cindex "AUTH" "testing a server"
25980 .cindex "base64 encoding" "creating authentication test data"
25981 Exim's &%-bh%& option can be useful for testing server authentication
25982 configurations. The data for the AUTH command has to be sent using base64
25983 encoding. A quick way to produce such data for testing is the following Perl
25984 script:
25985 .code
25986 use MIME::Base64;
25987 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25988 .endd
25989 .cindex "binary zero" "in authentication data"
25990 This interprets its argument as a Perl string, and then encodes it. The
25991 interpretation as a Perl string allows binary zeros, which are required for
25992 some kinds of authentication, to be included in the data. For example, a
25993 command line to run this script on such data might be
25994 .code
25995 encode '\0user\0password'
25996 .endd
25997 Note the use of single quotes to prevent the shell interpreting the
25998 backslashes, so that they can be interpreted by Perl to specify characters
25999 whose code value is zero.
26000
26001 &*Warning 1*&: If either of the user or password strings starts with an octal
26002 digit, you must use three zeros instead of one after the leading backslash. If
26003 you do not, the octal digit that starts your string will be incorrectly
26004 interpreted as part of the code for the first character.
26005
26006 &*Warning 2*&: If there are characters in the strings that Perl interprets
26007 specially, you must use a Perl escape to prevent them being misinterpreted. For
26008 example, a command such as
26009 .code
26010 encode '\0user@domain.com\0pas$$word'
26011 .endd
26012 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26013
26014 If you have the &%mimencode%& command installed, another way to do produce
26015 base64-encoded strings is to run the command
26016 .code
26017 echo -e -n `\0user\0password' | mimencode
26018 .endd
26019 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26020 in the argument, and the &%-n%& option specifies no newline at the end of its
26021 output. However, not all versions of &%echo%& recognize these options, so you
26022 should check your version before relying on this suggestion.
26023
26024
26025
26026 .section "Authentication by an Exim client" "SECID170"
26027 .cindex "authentication" "on an Exim client"
26028 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26029 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26030 announces support for authentication, and the host matches an entry in either
26031 of these options, Exim (as a client) tries to authenticate as follows:
26032
26033 .ilist
26034 For each authenticator that is configured as a client, in the order in which
26035 they are defined in the configuration, it searches the authentication
26036 mechanisms announced by the server for one whose name matches the public name
26037 of the authenticator.
26038 .next
26039 .vindex "&$host$&"
26040 .vindex "&$host_address$&"
26041 When it finds one that matches, it runs the authenticator's client code. The
26042 variables &$host$& and &$host_address$& are available for any string expansions
26043 that the client might do. They are set to the server's name and IP address. If
26044 any expansion is forced to fail, the authentication attempt is abandoned, and
26045 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26046 delivery to be deferred.
26047 .next
26048 If the result of the authentication attempt is a temporary error or a timeout,
26049 Exim abandons trying to send the message to the host for the moment. It will
26050 try again later. If there are any backup hosts available, they are tried in the
26051 usual way.
26052 .next
26053 If the response to authentication is a permanent error (5&'xx'& code), Exim
26054 carries on searching the list of authenticators and tries another one if
26055 possible. If all authentication attempts give permanent errors, or if there are
26056 no attempts because no mechanisms match (or option expansions force failure),
26057 what happens depends on whether the host matches &%hosts_require_auth%& or
26058 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26059 delivery is deferred. The error can be detected in the retry rules, and thereby
26060 turned into a permanent error if you wish. In the second case, Exim tries to
26061 deliver the message unauthenticated.
26062 .endlist
26063
26064 Note that the hostlist test for whether to do authentication can be
26065 confused if name-IP lookups change between the time the peer is decided
26066 on and the transport running.  For example, with a manualroute
26067 router given a host name, and DNS "round-robin" use by that name: if
26068 the local resolver cache times out between the router and the transport
26069 running, the transport may get an IP for the name for its authentication
26070 check which does not match the connection peer IP.
26071 No authentication will then be done, despite the names being identical.
26072
26073 For such cases use a separate transport which always authenticates.
26074
26075 .cindex "AUTH" "on MAIL command"
26076 When Exim has authenticated itself to a remote server, it adds the AUTH
26077 parameter to the MAIL commands it sends, if it has an authenticated sender for
26078 the message. If the message came from a remote host, the authenticated sender
26079 is the one that was receiving on an incoming MAIL command, provided that the
26080 incoming connection was authenticated and the &%server_mail_auth%& condition
26081 allowed the authenticated sender to be retained. If a local process calls Exim
26082 to send a message, the sender address that is built from the login name and
26083 &%qualify_domain%& is treated as authenticated. However, if the
26084 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26085 the authenticated sender that was received with the message.
26086 .ecindex IIDauthconf1
26087 .ecindex IIDauthconf2
26088
26089
26090
26091
26092
26093
26094 . ////////////////////////////////////////////////////////////////////////////
26095 . ////////////////////////////////////////////////////////////////////////////
26096
26097 .chapter "The plaintext authenticator" "CHAPplaintext"
26098 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26099 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26100 The &(plaintext)& authenticator can be configured to support the PLAIN and
26101 LOGIN authentication mechanisms, both of which transfer authentication data as
26102 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26103 security risk; you are strongly advised to insist on the use of SMTP encryption
26104 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26105 use unencrypted plain text, you should not use the same passwords for SMTP
26106 connections as you do for login accounts.
26107
26108 .section "Plaintext options" "SECID171"
26109 .cindex "options" "&(plaintext)& authenticator (server)"
26110 When configured as a server, &(plaintext)& uses the following options:
26111
26112 .option server_condition authenticators string&!! unset
26113 This is actually a global authentication option, but it must be set in order to
26114 configure the &(plaintext)& driver as a server. Its use is described below.
26115
26116 .option server_prompts plaintext string&!! unset
26117 The contents of this option, after expansion, must be a colon-separated list of
26118 prompt strings. If expansion fails, a temporary authentication rejection is
26119 given.
26120
26121 .section "Using plaintext in a server" "SECTplainserver"
26122 .cindex "AUTH" "in &(plaintext)& authenticator"
26123 .cindex "binary zero" "in &(plaintext)& authenticator"
26124 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26125         "in &(plaintext)& authenticator"
26126 .vindex "&$auth1$&, &$auth2$&, etc"
26127 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26128
26129 When running as a server, &(plaintext)& performs the authentication test by
26130 expanding a string. The data sent by the client with the AUTH command, or in
26131 response to subsequent prompts, is base64 encoded, and so may contain any byte
26132 values when decoded. If any data is supplied with the command, it is treated as
26133 a list of strings, separated by NULs (binary zeros), the first three of which
26134 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26135 (neither LOGIN nor PLAIN uses more than three strings).
26136
26137 For compatibility with previous releases of Exim, the values are also placed in
26138 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26139 variables for this purpose is now deprecated, as it can lead to confusion in
26140 string expansions that also use them for other things.
26141
26142 If there are more strings in &%server_prompts%& than the number of strings
26143 supplied with the AUTH command, the remaining prompts are used to obtain more
26144 data. Each response from the client may be a list of NUL-separated strings.
26145
26146 .vindex "&$authenticated_id$&"
26147 Once a sufficient number of data strings have been received,
26148 &%server_condition%& is expanded. If the expansion is forced to fail,
26149 authentication fails. Any other expansion failure causes a temporary error code
26150 to be returned. If the result of a successful expansion is an empty string,
26151 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26152 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26153 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26154 For any other result, a temporary error code is returned, with the expanded
26155 string as the error text
26156
26157 &*Warning*&: If you use a lookup in the expansion to find the user's
26158 password, be sure to make the authentication fail if the user is unknown.
26159 There are good and bad examples at the end of the next section.
26160
26161
26162
26163 .section "The PLAIN authentication mechanism" "SECID172"
26164 .cindex "PLAIN authentication mechanism"
26165 .cindex "authentication" "PLAIN mechanism"
26166 .cindex "binary zero" "in &(plaintext)& authenticator"
26167 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26168 sent as one item of data (that is, one combined string containing two NUL
26169 separators). The data is sent either as part of the AUTH command, or
26170 subsequently in response to an empty prompt from the server.
26171
26172 The second and third strings are a user name and a corresponding password.
26173 Using a single fixed user name and password as an example, this could be
26174 configured as follows:
26175 .code
26176 fixed_plain:
26177   driver = plaintext
26178   public_name = PLAIN
26179   server_prompts = :
26180   server_condition = \
26181     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26182   server_set_id = $auth2
26183 .endd
26184 Note that the default result strings from &%if%& (&"true"& or an empty string)
26185 are exactly what we want here, so they need not be specified. Obviously, if the
26186 password contains expansion-significant characters such as dollar, backslash,
26187 or closing brace, they have to be escaped.
26188
26189 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26190 the end of a string list are ignored). If all the data comes as part of the
26191 AUTH command, as is commonly the case, the prompt is not used. This
26192 authenticator is advertised in the response to EHLO as
26193 .code
26194 250-AUTH PLAIN
26195 .endd
26196 and a client host can authenticate itself by sending the command
26197 .code
26198 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26199 .endd
26200 As this contains three strings (more than the number of prompts), no further
26201 data is required from the client. Alternatively, the client may just send
26202 .code
26203 AUTH PLAIN
26204 .endd
26205 to initiate authentication, in which case the server replies with an empty
26206 prompt. The client must respond with the combined data string.
26207
26208 The data string is base64 encoded, as required by the RFC. This example,
26209 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26210 represents a zero byte. This is split up into three strings, the first of which
26211 is empty. The &%server_condition%& option in the authenticator checks that the
26212 second two are &`username`& and &`mysecret`& respectively.
26213
26214 Having just one fixed user name and password, as in this example, is not very
26215 realistic, though for a small organization with only a handful of
26216 authenticating clients it could make sense.
26217
26218 A more sophisticated instance of this authenticator could use the user name in
26219 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26220 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26221 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26222 This is an incorrect example:
26223 .code
26224 server_condition = \
26225   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26226 .endd
26227 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26228 which it then compares to the supplied password (&$auth3$&). Why is this example
26229 incorrect? It works fine for existing users, but consider what happens if a
26230 non-existent user name is given. The lookup fails, but as no success/failure
26231 strings are given for the lookup, it yields an empty string. Thus, to defeat
26232 the authentication, all a client has to do is to supply a non-existent user
26233 name and an empty password. The correct way of writing this test is:
26234 .code
26235 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26236   {${if eq{$value}{$auth3}}} {false}}
26237 .endd
26238 In this case, if the lookup succeeds, the result is checked; if the lookup
26239 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26240 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26241 always fails if its second argument is empty. However, the second way of
26242 writing the test makes the logic clearer.
26243
26244
26245 .section "The LOGIN authentication mechanism" "SECID173"
26246 .cindex "LOGIN authentication mechanism"
26247 .cindex "authentication" "LOGIN mechanism"
26248 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26249 in a number of programs. No data is sent with the AUTH command. Instead, a
26250 user name and password are supplied separately, in response to prompts. The
26251 plaintext authenticator can be configured to support this as in this example:
26252 .code
26253 fixed_login:
26254   driver = plaintext
26255   public_name = LOGIN
26256   server_prompts = User Name : Password
26257   server_condition = \
26258     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26259   server_set_id = $auth1
26260 .endd
26261 Because of the way plaintext operates, this authenticator accepts data supplied
26262 with the AUTH command (in contravention of the specification of LOGIN), but
26263 if the client does not supply it (as is the case for LOGIN clients), the prompt
26264 strings are used to obtain two data items.
26265
26266 Some clients are very particular about the precise text of the prompts. For
26267 example, Outlook Express is reported to recognize only &"Username:"& and
26268 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26269 strings. It uses the &%ldapauth%& expansion condition to check the user
26270 name and password by binding to an LDAP server:
26271 .code
26272 login:
26273   driver = plaintext
26274   public_name = LOGIN
26275   server_prompts = Username:: : Password::
26276   server_condition = ${if and{{ \
26277     !eq{}{$auth1} }{ \
26278     ldapauth{\
26279       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26280       pass=${quote:$auth2} \
26281       ldap://ldap.example.org/} }} }
26282   server_set_id = uid=$auth1,ou=people,o=example.org
26283 .endd
26284 We have to check that the username is not empty before using it, because LDAP
26285 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26286 operator to correctly quote the DN for authentication. However, the basic
26287 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26288 correct one to use for the password, because quoting is needed only to make
26289 the password conform to the Exim syntax. At the LDAP level, the password is an
26290 uninterpreted string.
26291
26292
26293 .section "Support for different kinds of authentication" "SECID174"
26294 A number of string expansion features are provided for the purpose of
26295 interfacing to different ways of user authentication. These include checking
26296 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26297 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26298 &<<SECTexpcond>>&.
26299
26300
26301
26302
26303 .section "Using plaintext in a client" "SECID175"
26304 .cindex "options" "&(plaintext)& authenticator (client)"
26305 The &(plaintext)& authenticator has two client options:
26306
26307 .option client_ignore_invalid_base64 plaintext boolean false
26308 If the client receives a server prompt that is not a valid base64 string,
26309 authentication is abandoned by default. However, if this option is set true,
26310 the error in the challenge is ignored and the client sends the response as
26311 usual.
26312
26313 .option client_send plaintext string&!! unset
26314 The string is a colon-separated list of authentication data strings. Each
26315 string is independently expanded before being sent to the server. The first
26316 string is sent with the AUTH command; any more strings are sent in response
26317 to prompts from the server. Before each string is expanded, the value of the
26318 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26319 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26320 way. Thus, the prompt that is received in response to sending the first string
26321 (with the AUTH command) can be used in the expansion of the second string, and
26322 so on. If an invalid base64 string is received when
26323 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26324 &$auth$&<&'n'&> variable.
26325
26326 &*Note*&: You cannot use expansion to create multiple strings, because
26327 splitting takes priority and happens first.
26328
26329 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26330 the data, further processing is applied to each string before it is sent. If
26331 there are any single circumflex characters in the string, they are converted to
26332 NULs. Should an actual circumflex be required as data, it must be doubled in
26333 the string.
26334
26335 This is an example of a client configuration that implements the PLAIN
26336 authentication mechanism with a fixed user name and password:
26337 .code
26338 fixed_plain:
26339   driver = plaintext
26340   public_name = PLAIN
26341   client_send = ^username^mysecret
26342 .endd
26343 The lack of colons means that the entire text is sent with the AUTH
26344 command, with the circumflex characters converted to NULs. A similar example
26345 that uses the LOGIN mechanism is:
26346 .code
26347 fixed_login:
26348   driver = plaintext
26349   public_name = LOGIN
26350   client_send = : username : mysecret
26351 .endd
26352 The initial colon means that the first string is empty, so no data is sent with
26353 the AUTH command itself. The remaining strings are sent in response to
26354 prompts.
26355 .ecindex IIDplaiauth1
26356 .ecindex IIDplaiauth2
26357
26358
26359
26360
26361 . ////////////////////////////////////////////////////////////////////////////
26362 . ////////////////////////////////////////////////////////////////////////////
26363
26364 .chapter "The cram_md5 authenticator" "CHID9"
26365 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26366 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26367 .cindex "CRAM-MD5 authentication mechanism"
26368 .cindex "authentication" "CRAM-MD5 mechanism"
26369 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26370 sends a challenge string to the client, and the response consists of a user
26371 name and the CRAM-MD5 digest of the challenge string combined with a secret
26372 string (password) which is known to both server and client. Thus, the secret
26373 is not sent over the network as plain text, which makes this authenticator more
26374 secure than &(plaintext)&. However, the downside is that the secret has to be
26375 available in plain text at either end.
26376
26377
26378 .section "Using cram_md5 as a server" "SECID176"
26379 .cindex "options" "&(cram_md5)& authenticator (server)"
26380 This authenticator has one server option, which must be set to configure the
26381 authenticator as a server:
26382
26383 .option server_secret cram_md5 string&!! unset
26384 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26385 When the server receives the client's response, the user name is placed in
26386 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26387 obtain the password for that user. The server then computes the CRAM-MD5 digest
26388 that the client should have sent, and checks that it received the correct
26389 string. If the expansion of &%server_secret%& is forced to fail, authentication
26390 fails. If the expansion fails for some other reason, a temporary error code is
26391 returned to the client.
26392
26393 For compatibility with previous releases of Exim, the user name is also placed
26394 in &$1$&. However, the use of this variables for this purpose is now
26395 deprecated, as it can lead to confusion in string expansions that also use
26396 numeric variables for other things.
26397
26398 For example, the following authenticator checks that the user name given by the
26399 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26400 user name, authentication fails.
26401 .code
26402 fixed_cram:
26403   driver = cram_md5
26404   public_name = CRAM-MD5
26405   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26406   server_set_id = $auth1
26407 .endd
26408 .vindex "&$authenticated_id$&"
26409 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26410 name in &$authenticated_id$&. A more typical configuration might look up the
26411 secret string in a file, using the user name as the key. For example:
26412 .code
26413 lookup_cram:
26414   driver = cram_md5
26415   public_name = CRAM-MD5
26416   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26417                   {$value}fail}
26418   server_set_id = $auth1
26419 .endd
26420 Note that this expansion explicitly forces failure if the lookup fails
26421 because &$auth1$& contains an unknown user name.
26422
26423 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26424 using the relevant libraries, you need to know the realm to specify in the
26425 lookup and then ask for the &"userPassword"& attribute for that user in that
26426 realm, with:
26427 .code
26428 cyrusless_crammd5:
26429   driver = cram_md5
26430   public_name = CRAM-MD5
26431   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26432                   dbmjz{/etc/sasldb2}{$value}fail}
26433   server_set_id = $auth1
26434 .endd
26435
26436 .section "Using cram_md5 as a client" "SECID177"
26437 .cindex "options" "&(cram_md5)& authenticator (client)"
26438 When used as a client, the &(cram_md5)& authenticator has two options:
26439
26440
26441
26442 .option client_name cram_md5 string&!! "the primary host name"
26443 This string is expanded, and the result used as the user name data when
26444 computing the response to the server's challenge.
26445
26446
26447 .option client_secret cram_md5 string&!! unset
26448 This option must be set for the authenticator to work as a client. Its value is
26449 expanded and the result used as the secret string when computing the response.
26450
26451
26452 .vindex "&$host$&"
26453 .vindex "&$host_address$&"
26454 Different user names and secrets can be used for different servers by referring
26455 to &$host$& or &$host_address$& in the options. Forced failure of either
26456 expansion string is treated as an indication that this authenticator is not
26457 prepared to handle this case. Exim moves on to the next configured client
26458 authenticator. Any other expansion failure causes Exim to give up trying to
26459 send the message to the current server.
26460
26461 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26462 strings, is:
26463 .code
26464 fixed_cram:
26465   driver = cram_md5
26466   public_name = CRAM-MD5
26467   client_name = ph10
26468   client_secret = secret
26469 .endd
26470 .ecindex IIDcramauth1
26471 .ecindex IIDcramauth2
26472
26473
26474
26475 . ////////////////////////////////////////////////////////////////////////////
26476 . ////////////////////////////////////////////////////////////////////////////
26477
26478 .chapter "The cyrus_sasl authenticator" "CHID10"
26479 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26480 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26481 .cindex "Cyrus" "SASL library"
26482 .cindex "Kerberos"
26483 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26484 Digital Ltd (&url(http://www.aldigital.co.uk)).
26485
26486 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26487 library implementation of the RFC 2222 (&"Simple Authentication and Security
26488 Layer"&). This library supports a number of authentication mechanisms,
26489 including PLAIN and LOGIN, but also several others that Exim does not support
26490 directly. In particular, there is support for Kerberos authentication.
26491
26492 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26493 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26494 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26495 name of the driver to determine which mechanism to support.
26496
26497 Where access to some kind of secret file is required, for example in GSSAPI
26498 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26499 user, and that the Cyrus SASL library has no way of escalating privileges
26500 by default. You may also find you need to set environment variables,
26501 depending on the driver you are using.
26502
26503 The application name provided by Exim is &"exim"&, so various SASL options may
26504 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26505 Kerberos, note that because of limitations in the GSSAPI interface,
26506 changing the server keytab might need to be communicated down to the Kerberos
26507 layer independently. The mechanism for doing so is dependent upon the Kerberos
26508 implementation.
26509
26510 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26511 may be set to point to an alternative keytab file. Exim will pass this
26512 variable through from its own inherited environment when started as root or the
26513 Exim user. The keytab file needs to be readable by the Exim user.
26514 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26515 environment variable.  In practice, for those releases, the Cyrus authenticator
26516 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26517 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26518
26519
26520 .section "Using cyrus_sasl as a server" "SECID178"
26521 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26522 (on a successful authentication) into &$auth1$&. For compatibility with
26523 previous releases of Exim, the username is also placed in &$1$&. However, the
26524 use of this variable for this purpose is now deprecated, as it can lead to
26525 confusion in string expansions that also use numeric variables for other
26526 things.
26527
26528
26529 .option server_hostname cyrus_sasl string&!! "see below"
26530 This option selects the hostname that is used when communicating with the
26531 library. The default value is &`$primary_hostname`&. It is up to the underlying
26532 SASL plug-in what it does with this data.
26533
26534
26535 .option server_mech cyrus_sasl string "see below"
26536 This option selects the authentication mechanism this driver should use. The
26537 default is the value of the generic &%public_name%& option. This option allows
26538 you to use a different underlying mechanism from the advertised name. For
26539 example:
26540 .code
26541 sasl:
26542   driver = cyrus_sasl
26543   public_name = X-ANYTHING
26544   server_mech = CRAM-MD5
26545   server_set_id = $auth1
26546 .endd
26547
26548 .option server_realm cyrus_sasl string&!! unset
26549 This specifies the SASL realm that the server claims to be in.
26550
26551
26552 .option server_service cyrus_sasl string &`smtp`&
26553 This is the SASL service that the server claims to implement.
26554
26555
26556 For straightforward cases, you do not need to set any of the authenticator's
26557 private options. All you need to do is to specify an appropriate mechanism as
26558 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26559 PLAIN, you could have two authenticators as follows:
26560 .code
26561 sasl_cram_md5:
26562   driver = cyrus_sasl
26563   public_name = CRAM-MD5
26564   server_set_id = $auth1
26565
26566 sasl_plain:
26567   driver = cyrus_sasl
26568   public_name = PLAIN
26569   server_set_id = $auth2
26570 .endd
26571 Cyrus SASL does implement the LOGIN authentication method, even though it is
26572 not a standard method. It is disabled by default in the source distribution,
26573 but it is present in many binary distributions.
26574 .ecindex IIDcyrauth1
26575 .ecindex IIDcyrauth2
26576
26577
26578
26579
26580 . ////////////////////////////////////////////////////////////////////////////
26581 . ////////////////////////////////////////////////////////////////////////////
26582 .chapter "The dovecot authenticator" "CHAPdovecot"
26583 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26584 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26585 This authenticator is an interface to the authentication facility of the
26586 Dovecot POP/IMAP server, which can support a number of authentication methods.
26587 Note that Dovecot must be configured to use auth-client not auth-userdb.
26588 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26589 to use the same mechanisms for SMTP authentication. This is a server
26590 authenticator only. There is only one option:
26591
26592 .option server_socket dovecot string unset
26593
26594 This option must specify the socket that is the interface to Dovecot
26595 authentication. The &%public_name%& option must specify an authentication
26596 mechanism that Dovecot is configured to support. You can have several
26597 authenticators for different mechanisms. For example:
26598 .code
26599 dovecot_plain:
26600   driver = dovecot
26601   public_name = PLAIN
26602   server_socket = /var/run/dovecot/auth-client
26603   server_set_id = $auth1
26604
26605 dovecot_ntlm:
26606   driver = dovecot
26607   public_name = NTLM
26608   server_socket = /var/run/dovecot/auth-client
26609   server_set_id = $auth1
26610 .endd
26611 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26612 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26613 option is passed in the Dovecot authentication command. If, for a TLS
26614 connection, a client certificate has been verified, the &"valid-client-cert"&
26615 option is passed. When authentication succeeds, the identity of the user
26616 who authenticated is placed in &$auth1$&.
26617 .ecindex IIDdcotauth1
26618 .ecindex IIDdcotauth2
26619
26620
26621 . ////////////////////////////////////////////////////////////////////////////
26622 . ////////////////////////////////////////////////////////////////////////////
26623 .chapter "The gsasl authenticator" "CHAPgsasl"
26624 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26625 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26626 .cindex "authentication" "GNU SASL"
26627 .cindex "authentication" "SASL"
26628 .cindex "authentication" "EXTERNAL"
26629 .cindex "authentication" "ANONYMOUS"
26630 .cindex "authentication" "PLAIN"
26631 .cindex "authentication" "LOGIN"
26632 .cindex "authentication" "DIGEST-MD5"
26633 .cindex "authentication" "CRAM-MD5"
26634 .cindex "authentication" "SCRAM-SHA-1"
26635 The &(gsasl)& authenticator provides server integration for the GNU SASL
26636 library and the mechanisms it provides.  This is new as of the 4.80 release
26637 and there are a few areas where the library does not let Exim smoothly
26638 scale to handle future authentication mechanisms, so no guarantee can be
26639 made that any particular new authentication mechanism will be supported
26640 without code changes in Exim.
26641
26642
26643 .option server_channelbinding gsasl boolean false
26644 Some authentication mechanisms are able to use external context at both ends
26645 of the session to bind the authentication to that context, and fail the
26646 authentication process if that context differs.  Specifically, some TLS
26647 ciphersuites can provide identifying information about the cryptographic
26648 context.
26649
26650 This means that certificate identity and verification becomes a non-issue,
26651 as a man-in-the-middle attack will cause the correct client and server to
26652 see different identifiers and authentication will fail.
26653
26654 This is currently only supported when using the GnuTLS library.  This is
26655 only usable by mechanisms which support "channel binding"; at time of
26656 writing, that's the SCRAM family.
26657
26658 This defaults off to ensure smooth upgrade across Exim releases, in case
26659 this option causes some clients to start failing.  Some future release
26660 of Exim may switch the default to be true.
26661
26662
26663 .option server_hostname gsasl string&!! "see below"
26664 This option selects the hostname that is used when communicating with the
26665 library. The default value is &`$primary_hostname`&.
26666 Some mechanisms will use this data.
26667
26668
26669 .option server_mech gsasl string "see below"
26670 This option selects the authentication mechanism this driver should use. The
26671 default is the value of the generic &%public_name%& option. This option allows
26672 you to use a different underlying mechanism from the advertised name. For
26673 example:
26674 .code
26675 sasl:
26676   driver = gsasl
26677   public_name = X-ANYTHING
26678   server_mech = CRAM-MD5
26679   server_set_id = $auth1
26680 .endd
26681
26682
26683 .option server_password gsasl string&!! unset
26684 Various mechanisms need access to the cleartext password on the server, so
26685 that proof-of-possession can be demonstrated on the wire, without sending
26686 the password itself.
26687
26688 The data available for lookup varies per mechanism.
26689 In all cases, &$auth1$& is set to the &'authentication id'&.
26690 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26691 if available, else the empty string.
26692 The &$auth3$& variable will always be the &'realm'& if available,
26693 else the empty string.
26694
26695 A forced failure will cause authentication to defer.
26696
26697 If using this option, it may make sense to set the &%server_condition%&
26698 option to be simply "true".
26699
26700
26701 .option server_realm gsasl string&!! unset
26702 This specifies the SASL realm that the server claims to be in.
26703 Some mechanisms will use this data.
26704
26705
26706 .option server_scram_iter gsasl string&!! unset
26707 This option provides data for the SCRAM family of mechanisms.
26708 &$auth1$& is not available at evaluation time.
26709 (This may change, as we receive feedback on use)
26710
26711
26712 .option server_scram_salt gsasl string&!! unset
26713 This option provides data for the SCRAM family of mechanisms.
26714 &$auth1$& is not available at evaluation time.
26715 (This may change, as we receive feedback on use)
26716
26717
26718 .option server_service gsasl string &`smtp`&
26719 This is the SASL service that the server claims to implement.
26720 Some mechanisms will use this data.
26721
26722
26723 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26724 .vindex "&$auth1$&, &$auth2$&, etc"
26725 These may be set when evaluating specific options, as detailed above.
26726 They will also be set when evaluating &%server_condition%&.
26727
26728 Unless otherwise stated below, the &(gsasl)& integration will use the following
26729 meanings for these variables:
26730
26731 .ilist
26732 .vindex "&$auth1$&"
26733 &$auth1$&: the &'authentication id'&
26734 .next
26735 .vindex "&$auth2$&"
26736 &$auth2$&: the &'authorization id'&
26737 .next
26738 .vindex "&$auth3$&"
26739 &$auth3$&: the &'realm'&
26740 .endlist
26741
26742 On a per-mechanism basis:
26743
26744 .ilist
26745 .cindex "authentication" "EXTERNAL"
26746 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26747 the &%server_condition%& option must be present.
26748 .next
26749 .cindex "authentication" "ANONYMOUS"
26750 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26751 the &%server_condition%& option must be present.
26752 .next
26753 .cindex "authentication" "GSSAPI"
26754 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26755 &$auth2$& will be set to the &'authorization id'&,
26756 the &%server_condition%& option must be present.
26757 .endlist
26758
26759 An &'anonymous token'& is something passed along as an unauthenticated
26760 identifier; this is analogous to FTP anonymous authentication passing an
26761 email address, or software-identifier@, as the "password".
26762
26763
26764 An example showing the password having the realm specified in the callback
26765 and demonstrating a Cyrus SASL to GSASL migration approach is:
26766 .code
26767 gsasl_cyrusless_crammd5:
26768   driver = gsasl
26769   public_name = CRAM-MD5
26770   server_realm = imap.example.org
26771   server_password = ${lookup{$auth1:$auth3:userPassword}\
26772                     dbmjz{/etc/sasldb2}{$value}fail}
26773   server_set_id = ${quote:$auth1}
26774   server_condition = yes
26775 .endd
26776
26777
26778 . ////////////////////////////////////////////////////////////////////////////
26779 . ////////////////////////////////////////////////////////////////////////////
26780
26781 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26782 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26783 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26784 .cindex "authentication" "GSSAPI"
26785 .cindex "authentication" "Kerberos"
26786 The &(heimdal_gssapi)& authenticator provides server integration for the
26787 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26788 reliably.
26789
26790 .option server_hostname heimdal_gssapi string&!! "see below"
26791 This option selects the hostname that is used, with &%server_service%&,
26792 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26793 identifier.  The default value is &`$primary_hostname`&.
26794
26795 .option server_keytab heimdal_gssapi string&!! unset
26796 If set, then Heimdal will not use the system default keytab (typically
26797 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26798 The value should be a pathname, with no &"file:"& prefix.
26799
26800 .option server_service heimdal_gssapi string&!! "smtp"
26801 This option specifies the service identifier used, in conjunction with
26802 &%server_hostname%&, for building the identifier for finding credentials
26803 from the keytab.
26804
26805
26806 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26807 Beware that these variables will typically include a realm, thus will appear
26808 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26809 not verified, so a malicious client can set it to anything.
26810
26811 The &$auth1$& field should be safely trustable as a value from the Key
26812 Distribution Center.  Note that these are not quite email addresses.
26813 Each identifier is for a role, and so the left-hand-side may include a
26814 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26815
26816 .vindex "&$auth1$&, &$auth2$&, etc"
26817 .ilist
26818 .vindex "&$auth1$&"
26819 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26820 .next
26821 .vindex "&$auth2$&"
26822 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26823 authentication.  If that was empty, this will also be set to the
26824 GSS Display Name.
26825 .endlist
26826
26827
26828 . ////////////////////////////////////////////////////////////////////////////
26829 . ////////////////////////////////////////////////////////////////////////////
26830
26831 .chapter "The spa authenticator" "CHAPspa"
26832 .scindex IIDspaauth1 "&(spa)& authenticator"
26833 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26834 .cindex "authentication" "Microsoft Secure Password"
26835 .cindex "authentication" "NTLM"
26836 .cindex "Microsoft Secure Password Authentication"
26837 .cindex "NTLM authentication"
26838 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26839 Password Authentication'& mechanism,
26840 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26841 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26842 taken from the Samba project (&url(http://www.samba.org)). The code for the
26843 server side was subsequently contributed by Tom Kistner. The mechanism works as
26844 follows:
26845
26846 .ilist
26847 After the AUTH command has been accepted, the client sends an SPA
26848 authentication request based on the user name and optional domain.
26849 .next
26850 The server sends back a challenge.
26851 .next
26852 The client builds a challenge response which makes use of the user's password
26853 and sends it to the server, which then accepts or rejects it.
26854 .endlist
26855
26856 Encryption is used to protect the password in transit.
26857
26858
26859
26860 .section "Using spa as a server" "SECID179"
26861 .cindex "options" "&(spa)& authenticator (server)"
26862 The &(spa)& authenticator has just one server option:
26863
26864 .option server_password spa string&!! unset
26865 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26866 This option is expanded, and the result must be the cleartext password for the
26867 authenticating user, whose name is at this point in &$auth1$&. For
26868 compatibility with previous releases of Exim, the user name is also placed in
26869 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26870 it can lead to confusion in string expansions that also use numeric variables
26871 for other things. For example:
26872 .code
26873 spa:
26874   driver = spa
26875   public_name = NTLM
26876   server_password = \
26877     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26878 .endd
26879 If the expansion is forced to fail, authentication fails. Any other expansion
26880 failure causes a temporary error code to be returned.
26881
26882
26883
26884
26885
26886 .section "Using spa as a client" "SECID180"
26887 .cindex "options" "&(spa)& authenticator (client)"
26888 The &(spa)& authenticator has the following client options:
26889
26890
26891
26892 .option client_domain spa string&!! unset
26893 This option specifies an optional domain for the authentication.
26894
26895
26896 .option client_password spa string&!! unset
26897 This option specifies the user's password, and must be set.
26898
26899
26900 .option client_username spa string&!! unset
26901 This option specifies the user name, and must be set. Here is an example of a
26902 configuration of this authenticator for use with the mail servers at
26903 &'msn.com'&:
26904 .code
26905 msn:
26906   driver = spa
26907   public_name = MSN
26908   client_username = msn/msn_username
26909   client_password = msn_plaintext_password
26910   client_domain = DOMAIN_OR_UNSET
26911 .endd
26912 .ecindex IIDspaauth1
26913 .ecindex IIDspaauth2
26914
26915
26916
26917
26918
26919 . ////////////////////////////////////////////////////////////////////////////
26920 . ////////////////////////////////////////////////////////////////////////////
26921
26922 .chapter "The tls authenticator" "CHAPtlsauth"
26923 .scindex IIDtlsauth1 "&(tls)& authenticator"
26924 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26925 .cindex "authentication" "Client Certificate"
26926 .cindex "authentication" "X509"
26927 .cindex "Certificate-based authentication"
26928 The &(tls)& authenticator provides server support for
26929 authentication based on client certificates.
26930
26931 It is not an SMTP authentication mechanism and is not
26932 advertised by the server as part of the SMTP EHLO response.
26933 It is an Exim authenticator in the sense that it affects
26934 the protocol element of the log line, can be tested for
26935 by the &%authenticated%& ACL condition, and can set
26936 the &$authenticated_id$& variable.
26937
26938 The client must present a verifiable certificate,
26939 for which it must have been requested via the
26940 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26941 (see &<<CHAPTLS>>&).
26942
26943 If an authenticator of this type is configured it is
26944 run before any SMTP-level communication is done,
26945 and can authenticate the connection.
26946 If it does, SMTP authentication is not offered.
26947
26948 A maximum of one authenticator of this type may be present.
26949
26950
26951 .cindex "options" "&(tls)& authenticator (server)"
26952 The &(tls)& authenticator has three server options:
26953
26954 .option server_param1 tls string&!! unset
26955 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26956 This option is expanded after the TLS negotiation and
26957 the result is placed in &$auth1$&.
26958 If the expansion is forced to fail, authentication fails. Any other expansion
26959 failure causes a temporary error code to be returned.
26960
26961 .option server_param2 tls string&!! unset
26962 .option server_param3 tls string&!! unset
26963 As above, for &$auth2$& and &$auth3$&.
26964
26965 &%server_param1%& may also be spelled &%server_param%&.
26966
26967
26968 Example:
26969 .code
26970 tls:
26971   driver = tls
26972   server_param1 =     ${certextract {subj_altname,mail,>:} \
26973                                     {$tls_in_peercert}}
26974   server_condition =  ${if forany {$auth1} \
26975                             {!= {0} \
26976                                 {${lookup ldap{ldap:///\
26977                          mailname=${quote_ldap_dn:${lc:$item}},\
26978                          ou=users,LDAP_DC?mailid} {$value}{0} \
26979                        }    }   } }
26980   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26981 .endd
26982 This accepts a client certificate that is verifiable against any
26983 of your configured trust-anchors
26984 (which usually means the full set of public CAs)
26985 and which has a SAN with a good account name.
26986 Note that the client cert is on the wire in-clear, including the SAN,
26987 whereas a plaintext SMTP AUTH done inside TLS is not.
26988
26989 . An alternative might use
26990 . .code
26991 .   server_param1 = ${sha256:$tls_in_peercert}
26992 . .endd
26993 . to require one of a set of specific certs that define a given account
26994 . (the verification is still required, but mostly irrelevant).
26995 . This would help for per-device use.
26996 .
26997 . However, for the future we really need support for checking a
26998 . user cert in LDAP - which probably wants a base-64 DER.
26999
27000 .ecindex IIDtlsauth1
27001 .ecindex IIDtlsauth2
27002
27003
27004 Note that because authentication is traditionally an SMTP operation,
27005 the &%authenticated%& ACL condition cannot be used in
27006 a connect- or helo-ACL.
27007
27008
27009
27010 . ////////////////////////////////////////////////////////////////////////////
27011 . ////////////////////////////////////////////////////////////////////////////
27012
27013 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27014          "Encrypted SMTP connections"
27015 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27016 .scindex IIDencsmtp2 "SMTP" "encryption"
27017 .cindex "TLS" "on SMTP connection"
27018 .cindex "OpenSSL"
27019 .cindex "GnuTLS"
27020 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27021 Sockets Layer), is implemented by making use of the OpenSSL library or the
27022 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27023 cryptographic code in the Exim distribution itself for implementing TLS. In
27024 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27025 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27026 You also need to understand the basic concepts of encryption at a managerial
27027 level, and in particular, the way that public keys, private keys, and
27028 certificates are used.
27029
27030 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27031 connection is established, the client issues a STARTTLS command. If the
27032 server accepts this, the client and the server negotiate an encryption
27033 mechanism. If the negotiation succeeds, the data that subsequently passes
27034 between them is encrypted.
27035
27036 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27037 and if so, what cipher suite is in use, whether the client supplied a
27038 certificate, and whether or not that certificate was verified. This makes it
27039 possible for an Exim server to deny or accept certain commands based on the
27040 encryption state.
27041
27042 &*Warning*&: Certain types of firewall and certain anti-virus products can
27043 disrupt TLS connections. You need to turn off SMTP scanning for these products
27044 in order to get TLS to work.
27045
27046
27047
27048 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
27049          "SECID284"
27050 .cindex "ssmtp protocol"
27051 .cindex "smtps protocol"
27052 .cindex "SMTP" "ssmtp protocol"
27053 .cindex "SMTP" "smtps protocol"
27054 Early implementations of encrypted SMTP used a different TCP port from normal
27055 SMTP, and expected an encryption negotiation to start immediately, instead of
27056 waiting for a STARTTLS command from the client using the standard SMTP
27057 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
27058 allocated for this purpose.
27059
27060 This approach was abandoned when encrypted SMTP was standardized, but there are
27061 still some legacy clients that use it. Exim supports these clients by means of
27062 the &%tls_on_connect_ports%& global option. Its value must be a list of port
27063 numbers; the most common use is expected to be:
27064 .code
27065 tls_on_connect_ports = 465
27066 .endd
27067 The port numbers specified by this option apply to all SMTP connections, both
27068 via the daemon and via &'inetd'&. You still need to specify all the ports that
27069 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
27070 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
27071 an extra port &-- rather, it specifies different behaviour on a port that is
27072 defined elsewhere.
27073
27074 There is also a &%-tls-on-connect%& command line option. This overrides
27075 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
27076
27077
27078
27079
27080
27081
27082 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
27083 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
27084 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
27085 followed later, when the first versions of GnuTLS were released. To build Exim
27086 to use GnuTLS, you need to set
27087 .code
27088 USE_GNUTLS=yes
27089 .endd
27090 in Local/Makefile, in addition to
27091 .code
27092 SUPPORT_TLS=yes
27093 .endd
27094 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
27095 include files and libraries for GnuTLS can be found.
27096
27097 There are some differences in usage when using GnuTLS instead of OpenSSL:
27098
27099 .ilist
27100 The &%tls_verify_certificates%& option
27101 cannot be the path of a directory
27102 for GnuTLS versions before 3.3.6
27103 (for later versions, or OpenSSL, it can be either).
27104 .next
27105 The default value for &%tls_dhparam%& differs for historical reasons.
27106 .next
27107 .vindex "&$tls_in_peerdn$&"
27108 .vindex "&$tls_out_peerdn$&"
27109 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
27110 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
27111 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
27112 .next
27113 OpenSSL identifies cipher suites using hyphens as separators, for example:
27114 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
27115 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
27116 in a cipher list. To make life simpler, Exim changes underscores to hyphens
27117 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
27118 to handle its own older variants) when processing lists of cipher suites in the
27119 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
27120 option).
27121 .next
27122 The &%tls_require_ciphers%& options operate differently, as described in the
27123 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
27124 .next
27125 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
27126 When using OpenSSL, this option is ignored.
27127 (If an API is found to let OpenSSL be configured in this way,
27128 let the Exim Maintainers know and we'll likely use it).
27129 .next
27130 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
27131 main option, it must be ordered to match the &%tls_certificate%& list.
27132 .next
27133 Some other recently added features may only be available in one or the other.
27134 This should be documented with the feature.  If the documentation does not
27135 explicitly state that the feature is infeasible in the other TLS
27136 implementation, then patches are welcome.
27137 .endlist
27138
27139
27140 .section "GnuTLS parameter computation" "SECTgnutlsparam"
27141 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
27142 an explicit path; if the latter, then the text about generation still applies,
27143 but not the chosen filename.
27144 By default, as of Exim 4.80 a hard-coded D-H prime is used.
27145 See the documentation of &%tls_dhparam%& for more information.
27146
27147 GnuTLS uses D-H parameters that may take a substantial amount of time
27148 to compute. It is unreasonable to re-compute them for every TLS session.
27149 Therefore, Exim keeps this data in a file in its spool directory, called
27150 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
27151 of bits requested.
27152 The file is owned by the Exim user and is readable only by
27153 its owner. Every Exim process that start up GnuTLS reads the D-H
27154 parameters from this file. If the file does not exist, the first Exim process
27155 that needs it computes the data and writes it to a temporary file which is
27156 renamed once it is complete. It does not matter if several Exim processes do
27157 this simultaneously (apart from wasting a few resources). Once a file is in
27158 place, new Exim processes immediately start using it.
27159
27160 For maximum security, the parameters that are stored in this file should be
27161 recalculated periodically, the frequency depending on your paranoia level.
27162 If you are avoiding using the fixed D-H primes published in RFCs, then you
27163 are concerned about some advanced attacks and will wish to do this; if you do
27164 not regenerate then you might as well stick to the standard primes.
27165
27166 Arranging this is easy in principle; just delete the file when you want new
27167 values to be computed. However, there may be a problem. The calculation of new
27168 parameters needs random numbers, and these are obtained from &_/dev/random_&.
27169 If the system is not very active, &_/dev/random_& may delay returning data
27170 until enough randomness (entropy) is available. This may cause Exim to hang for
27171 a substantial amount of time, causing timeouts on incoming connections.
27172
27173 The solution is to generate the parameters externally to Exim. They are stored
27174 in &_gnutls-params-N_& in PEM format, which means that they can be
27175 generated externally using the &(certtool)& command that is part of GnuTLS.
27176
27177 To replace the parameters with new ones, instead of deleting the file
27178 and letting Exim re-create it, you can generate new parameters using
27179 &(certtool)& and, when this has been done, replace Exim's cache file by
27180 renaming. The relevant commands are something like this:
27181 .code
27182 # ls
27183 [ look for file; assume gnutls-params-2236 is the most recent ]
27184 # rm -f new-params
27185 # touch new-params
27186 # chown exim:exim new-params
27187 # chmod 0600 new-params
27188 # certtool --generate-dh-params --bits 2236 >>new-params
27189 # openssl dhparam -noout -text -in new-params | head
27190 [ check the first line, make sure it's not more than 2236;
27191   if it is, then go back to the start ("rm") and repeat
27192   until the size generated is at most the size requested ]
27193 # chmod 0400 new-params
27194 # mv new-params gnutls-params-2236
27195 .endd
27196 If Exim never has to generate the parameters itself, the possibility of
27197 stalling is removed.
27198
27199 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27200 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27201 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27202 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27203 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27204 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27205 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27206 which applies to all D-H usage, client or server.  If the value returned by
27207 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27208 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27209 limit, which is still much higher than Exim historically used.
27210
27211 The filename and bits used will change as the GnuTLS maintainers change the
27212 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27213 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27214 2432 bits, while NSS is limited to 2236 bits.
27215
27216 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27217 increase the chance of the generated prime actually being within acceptable
27218 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27219 procedure above.  There is no sane procedure available to Exim to double-check
27220 the size of the generated prime, so it might still be too large.
27221
27222
27223 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27224 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
27225 .oindex "&%tls_require_ciphers%&" "OpenSSL"
27226 There is a function in the OpenSSL library that can be passed a list of cipher
27227 suites before the cipher negotiation takes place. This specifies which ciphers
27228 are acceptable. The list is colon separated and may contain names like
27229 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
27230 directly to this function call.
27231 Many systems will install the OpenSSL manual-pages, so you may have
27232 &'ciphers(1)'& available to you.
27233 The following quotation from the OpenSSL
27234 documentation specifies what forms of item are allowed in the cipher string:
27235
27236 .ilist
27237 It can consist of a single cipher suite such as RC4-SHA.
27238 .next
27239 It can represent a list of cipher suites containing a certain algorithm,
27240 or cipher suites of a certain type. For example SHA1 represents all
27241 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
27242 SSL v3 algorithms.
27243 .next
27244 Lists of cipher suites can be combined in a single cipher string using
27245 the + character. This is used as a logical and operation. For example
27246 SHA1+DES represents all cipher suites containing the SHA1 and the DES
27247 algorithms.
27248 .endlist
27249
27250 Each cipher string can be optionally preceded by one of the characters &`!`&,
27251 &`-`& or &`+`&.
27252 .ilist
27253 If &`!`& is used, the ciphers are permanently deleted from the list. The
27254 ciphers deleted can never reappear in the list even if they are explicitly
27255 stated.
27256 .next
27257 If &`-`& is used, the ciphers are deleted from the list, but some or all
27258 of the ciphers can be added again by later options.
27259 .next
27260 If &`+`& is used, the ciphers are moved to the end of the list. This
27261 option does not add any new ciphers; it just moves matching existing ones.
27262 .endlist
27263
27264 If none of these characters is present, the string is interpreted as
27265 a list of ciphers to be appended to the current preference list. If the list
27266 includes any ciphers already present they will be ignored: that is, they will
27267 not be moved to the end of the list.
27268 .endlist
27269
27270 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27271 string:
27272 .code
27273 # note single-quotes to get ! past any shell history expansion
27274 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27275 .endd
27276
27277 This example will let the library defaults be permitted on the MX port, where
27278 there's probably no identity verification anyway, but ups the ante on the
27279 submission ports where the administrator might have some influence on the
27280 choice of clients used:
27281 .code
27282 # OpenSSL variant; see man ciphers(1)
27283 tls_require_ciphers = ${if =={$received_port}{25}\
27284                            {DEFAULT}\
27285                            {HIGH:!MD5:!SHA1}}
27286 .endd
27287
27288 This example will prefer ECDSA-authenticated ciphers over RSA ones:
27289 .code
27290 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
27291 .endd
27292
27293
27294 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27295          "SECTreqciphgnu"
27296 .cindex "GnuTLS" "specifying parameters for"
27297 .cindex "TLS" "specifying ciphers (GnuTLS)"
27298 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27299 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27300 .cindex "TLS" "specifying protocols (GnuTLS)"
27301 .cindex "TLS" "specifying priority string (GnuTLS)"
27302 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27303 The GnuTLS library allows the caller to provide a "priority string", documented
27304 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27305 ciphersuite specification in OpenSSL.
27306
27307 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27308 and controls both protocols and ciphers.
27309
27310 The &%tls_require_ciphers%& option is available both as an global option,
27311 controlling how Exim behaves as a server, and also as an option of the
27312 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27313 the value is string expanded.  The resulting string is not an Exim list and
27314 the string is given to the GnuTLS library, so that Exim does not need to be
27315 aware of future feature enhancements of GnuTLS.
27316
27317 Documentation of the strings accepted may be found in the GnuTLS manual, under
27318 "Priority strings".  This is online as
27319 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
27320 but beware that this relates to GnuTLS 3, which may be newer than the version
27321 installed on your system.  If you are using GnuTLS 3,
27322 then the example code
27323 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27324 on that site can be used to test a given string.
27325
27326 For example:
27327 .code
27328 # Disable older versions of protocols
27329 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27330 .endd
27331
27332 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27333 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27334 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27335
27336 This example will let the library defaults be permitted on the MX port, where
27337 there's probably no identity verification anyway, and lowers security further
27338 by increasing compatibility; but this ups the ante on the submission ports
27339 where the administrator might have some influence on the choice of clients
27340 used:
27341 .code
27342 # GnuTLS variant
27343 tls_require_ciphers = ${if =={$received_port}{25}\
27344                            {NORMAL:%COMPAT}\
27345                            {SECURE128}}
27346 .endd
27347
27348
27349 .section "Configuring an Exim server to use TLS" "SECID182"
27350 .cindex "TLS" "configuring an Exim server"
27351 When Exim has been built with TLS support, it advertises the availability of
27352 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27353 but not to any others. The default value of this option is *, which means
27354 that STARTTLS is alway advertised.  Set it to blank to never advertise;
27355 this is reasonble for systems that want to use TLS only as a client.
27356
27357 If STARTTLS is to be used you
27358 need to set some other options in order to make TLS available.
27359
27360 If a client issues a STARTTLS command and there is some configuration
27361 problem in the server, the command is rejected with a 454 error. If the client
27362 persists in trying to issue SMTP commands, all except QUIT are rejected
27363 with the error
27364 .code
27365 554 Security failure
27366 .endd
27367 If a STARTTLS command is issued within an existing TLS session, it is
27368 rejected with a 554 error code.
27369
27370 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27371 must be set to match some hosts. The default is * which matches all hosts.
27372
27373 If this is all you do, TLS encryption will be enabled but not authentication -
27374 meaning that the peer has no assurance it is actually you he is talking to.
27375 You gain protection from a passive sniffer listening on the wire but not
27376 from someone able to intercept the communication.
27377
27378 Further protection requires some further configuration at the server end.
27379
27380 To make TLS work you need to set, in the server,
27381 .code
27382 tls_certificate = /some/file/name
27383 tls_privatekey = /some/file/name
27384 .endd
27385 These options are, in fact, expanded strings, so you can make them depend on
27386 the identity of the client that is connected if you wish. The first file
27387 contains the server's X509 certificate, and the second contains the private key
27388 that goes with it. These files need to be
27389 PEM format and readable by the Exim user, and must
27390 always be given as full path names.
27391 The key must not be password-protected.
27392 They can be the same file if both the
27393 certificate and the key are contained within it. If &%tls_privatekey%& is not
27394 set, or if its expansion is forced to fail or results in an empty string, this
27395 is assumed to be the case. The certificate file may also contain intermediate
27396 certificates that need to be sent to the client to enable it to authenticate
27397 the server's certificate.
27398
27399 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
27400 colon-separated lists of file paths.  Ciphers using given authentication
27401 algorithms require the presence of a suitable certificate to supply the
27402 public-key.  The server selects among the certificates to present to the
27403 client depending on the selected cipher, hence the priority ordering for
27404 ciphers will affect which certificate is used.
27405
27406 If you do not understand about certificates and keys, please try to find a
27407 source of this background information, which is not Exim-specific. (There are a
27408 few comments below in section &<<SECTcerandall>>&.)
27409
27410 &*Note*&: These options do not apply when Exim is operating as a client &--
27411 they apply only in the case of a server. If you need to use a certificate in an
27412 Exim client, you must set the options of the same names in an &(smtp)&
27413 transport.
27414
27415 With just these options, an Exim server will be able to use TLS. It does not
27416 require the client to have a certificate (but see below for how to insist on
27417 this). There is one other option that may be needed in other situations. If
27418 .code
27419 tls_dhparam = /some/file/name
27420 .endd
27421 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27422 with the parameters contained in the file.
27423 Set this to &`none`& to disable use of DH entirely, by making no prime
27424 available:
27425 .code
27426 tls_dhparam = none
27427 .endd
27428 This may also be set to a string identifying a standard prime to be used for
27429 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27430 used is &`ike23`&.  There are a few standard primes available, see the
27431 documentation for &%tls_dhparam%& for the complete list.
27432
27433 See the command
27434 .code
27435 openssl dhparam
27436 .endd
27437 for a way of generating file data.
27438
27439 The strings supplied for these three options are expanded every time a client
27440 host connects. It is therefore possible to use different certificates and keys
27441 for different hosts, if you so wish, by making use of the client's IP address
27442 in &$sender_host_address$& to control the expansion. If a string expansion is
27443 forced to fail, Exim behaves as if the option is not set.
27444
27445 .cindex "cipher" "logging"
27446 .cindex "log" "TLS cipher"
27447 .vindex "&$tls_in_cipher$&"
27448 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27449 an incoming TLS connection. It is included in the &'Received:'& header of an
27450 incoming message (by default &-- you can, of course, change this), and it is
27451 also included in the log line that records a message's arrival, keyed by
27452 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27453 condition can be used to test for specific cipher suites in ACLs.
27454
27455 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27456 can check the name of the cipher suite and vary their actions accordingly. The
27457 cipher suite names vary, depending on which TLS library is being used. For
27458 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27459 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27460 documentation for more details.
27461
27462 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27463 (again depending on the &%tls_cipher%& log selector).
27464
27465
27466 .section "Requesting and verifying client certificates" "SECID183"
27467 .cindex "certificate" "verification of client"
27468 .cindex "TLS" "client certificate verification"
27469 If you want an Exim server to request a certificate when negotiating a TLS
27470 session with a client, you must set either &%tls_verify_hosts%& or
27471 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27472 apply to all TLS connections. For any host that matches one of these options,
27473 Exim requests a certificate as part of the setup of the TLS session. The
27474 contents of the certificate are verified by comparing it with a list of
27475 expected certificates.
27476 These may be the system default set (depending on library version),
27477 an explicit file or,
27478 depending on library version, a directory, identified by
27479 &%tls_verify_certificates%&.
27480
27481 A file can contain multiple certificates, concatenated end to end. If a
27482 directory is used
27483 (OpenSSL only),
27484 each certificate must be in a separate file, with a name (or a symbolic link)
27485 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27486 certificate. You can compute the relevant hash by running the command
27487 .code
27488 openssl x509 -hash -noout -in /cert/file
27489 .endd
27490 where &_/cert/file_& contains a single certificate.
27491
27492 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27493 what happens if the client does not supply a certificate, or if the certificate
27494 does not match any of the certificates in the collection named by
27495 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27496 attempt to set up a TLS session is aborted, and the incoming connection is
27497 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27498 session continues. ACLs that run for subsequent SMTP commands can detect the
27499 fact that no certificate was verified, and vary their actions accordingly. For
27500 example, you can insist on a certificate before accepting a message for
27501 relaying, but not when the message is destined for local delivery.
27502
27503 .vindex "&$tls_in_peerdn$&"
27504 When a client supplies a certificate (whether it verifies or not), the value of
27505 the Distinguished Name of the certificate is made available in the variable
27506 &$tls_in_peerdn$& during subsequent processing of the message.
27507
27508 .cindex "log" "distinguished name"
27509 Because it is often a long text string, it is not included in the log line or
27510 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27511 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27512 &%received_header_text%& to change the &'Received:'& header. When no
27513 certificate is supplied, &$tls_in_peerdn$& is empty.
27514
27515
27516 .section "Revoked certificates" "SECID184"
27517 .cindex "TLS" "revoked certificates"
27518 .cindex "revocation list"
27519 .cindex "certificate" "revocation list"
27520 .cindex "OCSP" "stapling"
27521 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27522 certificates are revoked. If you have such a list, you can pass it to an Exim
27523 server using the global option called &%tls_crl%& and to an Exim client using
27524 an identically named option for the &(smtp)& transport. In each case, the value
27525 of the option is expanded and must then be the name of a file that contains a
27526 CRL in PEM format.
27527 The downside is that clients have to periodically re-download a potentially huge
27528 file from every certificate authority they know of.
27529
27530 The way with most moving parts at query time is Online Certificate
27531 Status Protocol (OCSP), where the client verifies the certificate
27532 against an OCSP server run by the CA.  This lets the CA track all
27533 usage of the certs.  It requires running software with access to the
27534 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27535 is based on HTTP and can be proxied accordingly.
27536
27537 The only widespread OCSP server implementation (known to this writer)
27538 comes as part of OpenSSL and aborts on an invalid request, such as
27539 connecting to the port and then disconnecting.  This requires
27540 re-entering the passphrase each time some random client does this.
27541
27542 The third way is OCSP Stapling; in this, the server using a certificate
27543 issued by the CA periodically requests an OCSP proof of validity from
27544 the OCSP server, then serves it up inline as part of the TLS
27545 negotiation.   This approach adds no extra round trips, does not let the
27546 CA track users, scales well with number of certs issued by the CA and is
27547 resilient to temporary OCSP server failures, as long as the server
27548 starts retrying to fetch an OCSP proof some time before its current
27549 proof expires.  The downside is that it requires server support.
27550
27551 Unless Exim is built with the support disabled,
27552 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27553 support for OCSP stapling is included.
27554
27555 There is a global option called &%tls_ocsp_file%&.
27556 The file specified therein is expected to be in DER format, and contain
27557 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27558 option will be re-expanded for SNI, if the &%tls_certificate%& option
27559 contains &`tls_in_sni`&, as per other TLS options.
27560
27561 Exim does not at this time implement any support for fetching a new OCSP
27562 proof.  The burden is on the administrator to handle this, outside of
27563 Exim.  The file specified should be replaced atomically, so that the
27564 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27565 on each connection, so a new file will be handled transparently on the
27566 next connection.
27567
27568 When built with OpenSSL Exim will check for a valid next update timestamp
27569 in the OCSP proof; if not present, or if the proof has expired, it will be
27570 ignored.
27571
27572 For the client to be able to verify the stapled OCSP the server must
27573 also supply, in its stapled information, any intermediate
27574 certificates for the chain leading to the OCSP proof from the signer
27575 of the server certificate.  There may be zero or one such. These
27576 intermediate certificates should be added to the server OCSP stapling
27577 file named by &%tls_ocsp_file%&.
27578
27579 Note that the proof only covers the terminal server certificate,
27580 not any of the chain from CA to it.
27581
27582 There is no current way to staple a proof for a client certificate.
27583
27584 .code
27585   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27586   OCSP server is supplied.  The server URL may be included in the
27587   server certificate, if the CA is helpful.
27588
27589   One failure mode seen was the OCSP Signer cert expiring before the end
27590   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27591   noted this as invalid overall, but the re-fetch script did not.
27592 .endd
27593
27594
27595
27596
27597 .section "Configuring an Exim client to use TLS" "SECID185"
27598 .cindex "cipher" "logging"
27599 .cindex "log" "TLS cipher"
27600 .cindex "log" "distinguished name"
27601 .cindex "TLS" "configuring an Exim client"
27602 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27603 deliveries as well as to incoming, the latter one causing logging of the
27604 server certificate's DN. The remaining client configuration for TLS is all
27605 within the &(smtp)& transport.
27606
27607 It is not necessary to set any options to have TLS work in the &(smtp)&
27608 transport. If Exim is built with TLS support, and TLS is advertised by a
27609 server, the &(smtp)& transport always tries to start a TLS session. However,
27610 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27611 transport) to a list of server hosts for which TLS should not be used.
27612
27613 If you do not want Exim to attempt to send messages unencrypted when an attempt
27614 to set up an encrypted connection fails in any way, you can set
27615 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27616 those hosts, delivery is always deferred if an encrypted connection cannot be
27617 set up. If there are any other hosts for the address, they are tried in the
27618 usual way.
27619
27620 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27621 the message unencrypted. It always does this if the response to STARTTLS is
27622 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27623 session after a success response code, what happens is controlled by the
27624 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27625 delivery to this host is deferred, and other hosts (if available) are tried. If
27626 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27627 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27628 negotiation fails, Exim closes the current connection (because it is in an
27629 unknown state), opens a new one to the same host, and then tries the delivery
27630 unencrypted.
27631
27632 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27633 transport provide the client with a certificate, which is passed to the server
27634 if it requests it. If the server is Exim, it will request a certificate only if
27635 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27636
27637 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27638 specifies a collection of expected server certificates.
27639 These may be
27640 the system default set (depending on library version),
27641 a file,
27642 or (depending on library version) a directory.
27643 The client verifies the server's certificate
27644 against this collection, taking into account any revoked certificates that are
27645 in the list defined by &%tls_crl%&.
27646 Failure to verify fails the TLS connection unless either of the
27647 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27648
27649 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27650 certificate verification to the listed servers.  Verification either must
27651 or need not succeed respectively.
27652
27653 The &(smtp)& transport has two OCSP-related options:
27654 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27655 is requested and required for the connection to proceed.  The default
27656 value is empty.
27657 &%hosts_request_ocsp%&; a host-list for which (additionally)
27658 a Certificate Status is requested (but not necessarily verified).  The default
27659 value is "*" meaning that requests are made unless configured
27660 otherwise.
27661
27662 The host(s) should also be in &%hosts_require_tls%&, and
27663 &%tls_verify_certificates%& configured for the transport,
27664 for OCSP to be relevant.
27665
27666 If
27667 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27668 list of permitted cipher suites. If either of these checks fails, delivery to
27669 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27670 alternative hosts, if any.
27671
27672  &*Note*&:
27673 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27674 is operating as a client. Exim does not assume that a server certificate (set
27675 by the global options of the same name) should also be used when operating as a
27676 client.
27677
27678 .vindex "&$host$&"
27679 .vindex "&$host_address$&"
27680 All the TLS options in the &(smtp)& transport are expanded before use, with
27681 &$host$& and &$host_address$& containing the name and address of the server to
27682 which the client is connected. Forced failure of an expansion causes Exim to
27683 behave as if the relevant option were unset.
27684
27685 .vindex &$tls_out_bits$&
27686 .vindex &$tls_out_cipher$&
27687 .vindex &$tls_out_peerdn$&
27688 .vindex &$tls_out_sni$&
27689 Before an SMTP connection is established, the
27690 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27691 variables are emptied. (Until the first connection, they contain the values
27692 that were set when the message was received.) If STARTTLS is subsequently
27693 successfully obeyed, these variables are set to the relevant values for the
27694 outgoing connection.
27695
27696
27697
27698 .section "Use of TLS Server Name Indication" "SECTtlssni"
27699 .cindex "TLS" "Server Name Indication"
27700 .vindex "&$tls_in_sni$&"
27701 .oindex "&%tls_in_sni%&"
27702 With TLS1.0 or above, there is an extension mechanism by which extra
27703 information can be included at various points in the protocol.  One of these
27704 extensions, documented in RFC 6066 (and before that RFC 4366) is
27705 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27706 client in the initial handshake, so that the server can examine the servername
27707 within and possibly choose to use different certificates and keys (and more)
27708 for this session.
27709
27710 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27711 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27712 address.
27713
27714 With SMTP to MX, there are the same problems here as in choosing the identity
27715 against which to validate a certificate: you can't rely on insecure DNS to
27716 provide the identity which you then cryptographically verify.  So this will
27717 be of limited use in that environment.
27718
27719 With SMTP to Submission, there is a well-defined hostname which clients are
27720 connecting to and can validate certificates against.  Thus clients &*can*&
27721 choose to include this information in the TLS negotiation.  If this becomes
27722 wide-spread, then hosters can choose to present different certificates to
27723 different clients.  Or even negotiate different cipher suites.
27724
27725 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27726 if not empty, will be sent on a TLS session as part of the handshake.  There's
27727 nothing more to it.  Choosing a sensible value not derived insecurely is the
27728 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27729 for the lifetime of the client connection (including during authentication).
27730
27731 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27732 received from a client.
27733 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27734
27735 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27736 option (prior to expansion) then the following options will be re-expanded
27737 during TLS session handshake, to permit alternative values to be chosen:
27738
27739 .ilist
27740 .vindex "&%tls_certificate%&"
27741 &%tls_certificate%&
27742 .next
27743 .vindex "&%tls_crl%&"
27744 &%tls_crl%&
27745 .next
27746 .vindex "&%tls_privatekey%&"
27747 &%tls_privatekey%&
27748 .next
27749 .vindex "&%tls_verify_certificates%&"
27750 &%tls_verify_certificates%&
27751 .next
27752 .vindex "&%tls_ocsp_file%&"
27753 &%tls_ocsp_file%&
27754 .endlist
27755
27756 Great care should be taken to deal with matters of case, various injection
27757 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27758 can always be referenced; it is important to remember that &$tls_in_sni$& is
27759 arbitrary unverified data provided prior to authentication.
27760 Further, the initial certificate is loaded before SNI is arrived, so
27761 an expansion for &%tls_certificate%& must have a default which is used
27762 when &$tls_in_sni$& is empty.
27763
27764 The Exim developers are proceeding cautiously and so far no other TLS options
27765 are re-expanded.
27766
27767 When Exim is built against OpenSSL, OpenSSL must have been built with support
27768 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27769 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27770 see &`-servername`& in the output, then OpenSSL has support.
27771
27772 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27773 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27774 built, then you have SNI support).
27775
27776
27777
27778 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27779          "SECTmulmessam"
27780 .cindex "multiple SMTP deliveries with TLS"
27781 .cindex "TLS" "multiple message deliveries"
27782 Exim sends multiple messages down the same TCP/IP connection by starting up
27783 an entirely new delivery process for each message, passing the socket from
27784 one process to the next. This implementation does not fit well with the use
27785 of TLS, because there is quite a lot of state information associated with a TLS
27786 connection, not just a socket identification. Passing all the state information
27787 to a new process is not feasible. Consequently, for sending using TLS Exim
27788 starts an additional proxy process for handling the encryption, piping the
27789 unencrypted data stream from and to the delivery processes.
27790
27791 An older mode of operation can be enabled on a per-host basis by the
27792 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
27793 this list the proxy process descibed above is not used; instead Exim
27794 shuts down an existing TLS session being run by the delivery process
27795 before passing the socket to a new process. The new process may then
27796 try to start a new TLS session, and if successful, may try to re-authenticate
27797 if AUTH is in use, before sending the next message.
27798
27799 The RFC is not clear as to whether or not an SMTP session continues in clear
27800 after TLS has been shut down, or whether TLS may be restarted again later, as
27801 just described. However, if the server is Exim, this shutdown and
27802 reinitialization works. It is not known which (if any) other servers operate
27803 successfully if the client closes a TLS session and continues with unencrypted
27804 SMTP, but there are certainly some that do not work. For such servers, Exim
27805 should not pass the socket to another process, because the failure of the
27806 subsequent attempt to use it would cause Exim to record a temporary host error,
27807 and delay other deliveries to that host.
27808
27809 To test for this case, Exim sends an EHLO command to the server after
27810 closing down the TLS session. If this fails in any way, the connection is
27811 closed instead of being passed to a new delivery process, but no retry
27812 information is recorded.
27813
27814 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27815 &(smtp)& transport to match those hosts for which Exim should not pass
27816 connections to new processes if TLS has been used.
27817
27818
27819
27820
27821 .section "Certificates and all that" "SECTcerandall"
27822 .cindex "certificate" "references to discussion"
27823 In order to understand fully how TLS works, you need to know about
27824 certificates, certificate signing, and certificate authorities. This is not the
27825 place to give a tutorial, especially as I do not know very much about it
27826 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27827 to Apache, currently at
27828 .display
27829 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27830 .endd
27831 Other parts of the &'modssl'& documentation are also helpful, and have
27832 links to further files.
27833 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27834 0-201-61598-3), contains both introductory and more in-depth descriptions.
27835 Some sample programs taken from the book are available from
27836 .display
27837 &url(http://www.rtfm.com/openssl-examples/)
27838 .endd
27839
27840
27841 .section "Certificate chains" "SECID186"
27842 The file named by &%tls_certificate%& may contain more than one
27843 certificate. This is useful in the case where the certificate that is being
27844 sent is validated by an intermediate certificate which the other end does
27845 not have. Multiple certificates must be in the correct order in the file.
27846 First the host's certificate itself, then the first intermediate
27847 certificate to validate the issuer of the host certificate, then the next
27848 intermediate certificate to validate the issuer of the first intermediate
27849 certificate, and so on, until finally (optionally) the root certificate.
27850 The root certificate must already be trusted by the recipient for
27851 validation to succeed, of course, but if it's not preinstalled, sending the
27852 root certificate along with the rest makes it available for the user to
27853 install if the receiving end is a client MUA that can interact with a user.
27854
27855 Note that certificates using MD5 are unlikely to work on today's Internet;
27856 even if your libraries allow loading them for use in Exim when acting as a
27857 server, increasingly clients will not accept such certificates.  The error
27858 diagnostics in such a case can be frustratingly vague.
27859
27860
27861
27862 .section "Self-signed certificates" "SECID187"
27863 .cindex "certificate" "self-signed"
27864 You can create a self-signed certificate using the &'req'& command provided
27865 with OpenSSL, like this:
27866 . ==== Do not shorten the duration here without reading and considering
27867 . ==== the text below.  Please leave it at 9999 days.
27868 .code
27869 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27870             -days 9999 -nodes
27871 .endd
27872 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27873 delimited and so can be identified independently. The &%-days%& option
27874 specifies a period for which the certificate is valid. The &%-nodes%& option is
27875 important: if you do not set it, the key is encrypted with a passphrase
27876 that you are prompted for, and any use that is made of the key causes more
27877 prompting for the passphrase. This is not helpful if you are going to use
27878 this certificate and key in an MTA, where prompting is not possible.
27879
27880 . ==== I expect to still be working 26 years from now.  The less technical
27881 . ==== debt I create, in terms of storing up trouble for my later years, the
27882 . ==== happier I will be then.  We really have reached the point where we
27883 . ==== should start, at the very least, provoking thought and making folks
27884 . ==== pause before proceeding, instead of leaving all the fixes until two
27885 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27886 . ==== -pdp, 2012
27887 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27888 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27889 the above command might produce a date in the past.  Think carefully about
27890 the lifetime of the systems you're deploying, and either reduce the duration
27891 of the certificate or reconsider your platform deployment.  (At time of
27892 writing, reducing the duration is the most likely choice, but the inexorable
27893 progression of time takes us steadily towards an era where this will not
27894 be a sensible resolution).
27895
27896 A self-signed certificate made in this way is sufficient for testing, and
27897 may be adequate for all your requirements if you are mainly interested in
27898 encrypting transfers, and not in secure identification.
27899
27900 However, many clients require that the certificate presented by the server be a
27901 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27902 certificate. In this situation, the self-signed certificate described above
27903 must be installed on the client host as a trusted root &'certification
27904 authority'& (CA), and the certificate used by Exim must be a user certificate
27905 signed with that self-signed certificate.
27906
27907 For information on creating self-signed CA certificates and using them to sign
27908 user certificates, see the &'General implementation overview'& chapter of the
27909 Open-source PKI book, available online at
27910 &url(http://ospkibook.sourceforge.net/).
27911 .ecindex IIDencsmtp1
27912 .ecindex IIDencsmtp2
27913
27914
27915
27916 . ////////////////////////////////////////////////////////////////////////////
27917 . ////////////////////////////////////////////////////////////////////////////
27918
27919 .chapter "Access control lists" "CHAPACL"
27920 .scindex IIDacl "&ACL;" "description"
27921 .cindex "control of incoming mail"
27922 .cindex "message" "controlling incoming"
27923 .cindex "policy control" "access control lists"
27924 Access Control Lists (ACLs) are defined in a separate section of the run time
27925 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27926 name, terminated by a colon. Here is a complete ACL section that contains just
27927 one very small ACL:
27928 .code
27929 begin acl
27930 small_acl:
27931   accept   hosts = one.host.only
27932 .endd
27933 You can have as many lists as you like in the ACL section, and the order in
27934 which they appear does not matter. The lists are self-terminating.
27935
27936 The majority of ACLs are used to control Exim's behaviour when it receives
27937 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27938 when a local process submits a message using SMTP by specifying the &%-bs%&
27939 option. The most common use is for controlling which recipients are accepted
27940 in incoming messages. In addition, you can define an ACL that is used to check
27941 local non-SMTP messages. The default configuration file contains an example of
27942 a realistic ACL for checking RCPT commands. This is discussed in chapter
27943 &<<CHAPdefconfil>>&.
27944
27945
27946 .section "Testing ACLs" "SECID188"
27947 The &%-bh%& command line option provides a way of testing your ACL
27948 configuration locally by running a fake SMTP session with which you interact.
27949
27950
27951 .section "Specifying when ACLs are used" "SECID189"
27952 .cindex "&ACL;" "options for specifying"
27953 In order to cause an ACL to be used, you have to name it in one of the relevant
27954 options in the main part of the configuration. These options are:
27955 .cindex "AUTH" "ACL for"
27956 .cindex "DATA" "ACLs for"
27957 .cindex "ETRN" "ACL for"
27958 .cindex "EXPN" "ACL for"
27959 .cindex "HELO" "ACL for"
27960 .cindex "EHLO" "ACL for"
27961 .cindex "DKIM" "ACL for"
27962 .cindex "MAIL" "ACL for"
27963 .cindex "QUIT, ACL for"
27964 .cindex "RCPT" "ACL for"
27965 .cindex "STARTTLS, ACL for"
27966 .cindex "VRFY" "ACL for"
27967 .cindex "SMTP" "connection, ACL for"
27968 .cindex "non-SMTP messages" "ACLs for"
27969 .cindex "MIME content scanning" "ACL for"
27970 .cindex "PRDR" "ACL for"
27971
27972 .table2 140pt
27973 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27974 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27975 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27976 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27977 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27978 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27979 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27980 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27981 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27982 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27983 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27984 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27985 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27986 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27987 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27988 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27989 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27990 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27991 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27992 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27993 .endtable
27994
27995 For example, if you set
27996 .code
27997 acl_smtp_rcpt = small_acl
27998 .endd
27999 the little ACL defined above is used whenever Exim receives a RCPT command
28000 in an SMTP dialogue. The majority of policy tests on incoming messages can be
28001 done when RCPT commands arrive. A rejection of RCPT should cause the
28002 sending MTA to give up on the recipient address contained in the RCPT
28003 command, whereas rejection at other times may cause the client MTA to keep on
28004 trying to deliver the message. It is therefore recommended that you do as much
28005 testing as possible at RCPT time.
28006
28007
28008 .section "The non-SMTP ACLs" "SECID190"
28009 .cindex "non-SMTP messages" "ACLs for"
28010 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
28011 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
28012 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
28013 the state of the SMTP connection such as encryption and authentication) are not
28014 relevant and are forbidden in these ACLs. However, the sender and recipients
28015 are known, so the &%senders%& and &%sender_domains%& conditions and the
28016 &$sender_address$& and &$recipients$& variables can be used. Variables such as
28017 &$authenticated_sender$& are also available. You can specify added header lines
28018 in any of these ACLs.
28019
28020 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
28021 non-SMTP message, before any of the message has been read. (This is the
28022 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
28023 batched SMTP input, it runs after the DATA command has been reached. The
28024 result of this ACL is ignored; it cannot be used to reject a message. If you
28025 really need to, you could set a value in an ACL variable here and reject based
28026 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
28027 controls, and in particular, it can be used to set
28028 .code
28029 control = suppress_local_fixups
28030 .endd
28031 This cannot be used in the other non-SMTP ACLs because by the time they are
28032 run, it is too late.
28033
28034 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
28035 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28036
28037 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
28038 kind of rejection is treated as permanent, because there is no way of sending a
28039 temporary error for these kinds of message.
28040
28041
28042 .section "The SMTP connect ACL" "SECID191"
28043 .cindex "SMTP" "connection, ACL for"
28044 .oindex &%smtp_banner%&
28045 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
28046 session, after the test specified by &%host_reject_connection%& (which is now
28047 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
28048 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
28049 the message override the banner message that is otherwise specified by the
28050 &%smtp_banner%& option.
28051
28052
28053 .section "The EHLO/HELO ACL" "SECID192"
28054 .cindex "EHLO" "ACL for"
28055 .cindex "HELO" "ACL for"
28056 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
28057 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
28058 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
28059 Note that a client may issue more than one EHLO or HELO command in an SMTP
28060 session, and indeed is required to issue a new EHLO or HELO after successfully
28061 setting up encryption following a STARTTLS command.
28062
28063 Note also that a deny neither forces the client to go away nor means that
28064 mail will be refused on the connection.  Consider checking for
28065 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
28066
28067 If the command is accepted by an &%accept%& verb that has a &%message%&
28068 modifier, the message may not contain more than one line (it will be truncated
28069 at the first newline and a panic logged if it does). Such a message cannot
28070 affect the EHLO options that are listed on the second and subsequent lines of
28071 an EHLO response.
28072
28073
28074 .section "The DATA ACLs" "SECID193"
28075 .cindex "DATA" "ACLs for"
28076 Two ACLs are associated with the DATA command, because it is two-stage
28077 command, with two responses being sent to the client.
28078 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
28079 is obeyed. This gives you control after all the RCPT commands, but before
28080 the message itself is received. It offers the opportunity to give a negative
28081 response to the DATA command before the data is transmitted. Header lines
28082 added by MAIL or RCPT ACLs are not visible at this time, but any that
28083 are defined here are visible when the &%acl_smtp_data%& ACL is run.
28084
28085 You cannot test the contents of the message, for example, to verify addresses
28086 in the headers, at RCPT time or when the DATA command is received. Such
28087 tests have to appear in the ACL that is run after the message itself has been
28088 received, before the final response to the DATA command is sent. This is
28089 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
28090 associated with the DATA command.
28091
28092 .cindex CHUNKING "BDAT command"
28093 .cindex BDAT "SMTP command"
28094 .cindex "RFC 3030" CHUNKING
28095 If CHUNKING was advertised and a BDAT command sequence is received,
28096 the &%acl_smtp_predata%& ACL is not run.
28097 . XXX why not?  It should be possible, for the first BDAT.
28098 The &%acl_smtp_data%& is run after the last BDAT command and all of
28099 the data specified is received.
28100
28101 For both of these ACLs, it is not possible to reject individual recipients. An
28102 error response rejects the entire message. Unfortunately, it is known that some
28103 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
28104 before or after the data) correctly &-- they keep the message on their queues
28105 and try again later, but that is their problem, though it does waste some of
28106 your resources.
28107
28108 The &%acl_smtp_data%& ACL is run after
28109 the &%acl_smtp_data_prdr%&,
28110 the &%acl_smtp_dkim%&
28111 and the &%acl_smtp_mime%& ACLs.
28112
28113 .section "The SMTP DKIM ACL" "SECTDKIMACL"
28114 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
28115 enabled (which is the default).
28116
28117 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
28118 received, and is executed for each DKIM signature found in a message.  If not
28119 otherwise specified, the default action is to accept.
28120
28121 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
28122
28123 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
28124
28125
28126 .section "The SMTP MIME ACL" "SECID194"
28127 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
28128 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28129
28130 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28131
28132
28133 .section "The SMTP PRDR ACL" "SECTPRDRACL"
28134 .cindex "PRDR" "ACL for"
28135 .oindex "&%prdr_enable%&"
28136 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
28137 with PRDR support enabled (which is the default).
28138 It becomes active only when the PRDR feature is negotiated between
28139 client and server for a message, and more than one recipient
28140 has been accepted.
28141
28142 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
28143 has been received, and is executed once for each recipient of the message
28144 with &$local_part$& and &$domain$& valid.
28145 The test may accept, defer or deny for individual recipients.
28146 The &%acl_smtp_data%& will still be called after this ACL and
28147 can reject the message overall, even if this ACL has accepted it
28148 for some or all recipients.
28149
28150 PRDR may be used to support per-user content filtering.  Without it
28151 one must defer any recipient after the first that has a different
28152 content-filter configuration.  With PRDR, the RCPT-time check
28153 .cindex "PRDR" "variable for"
28154 for this can be disabled when the variable &$prdr_requested$&
28155 is &"yes"&.
28156 Any required difference in behaviour of the main DATA-time
28157 ACL should however depend on the PRDR-time ACL having run, as Exim
28158 will avoid doing so in some situations (e.g.  single-recipient mails).
28159
28160 See also the &%prdr_enable%& global option
28161 and the &%hosts_try_prdr%& smtp transport option.
28162
28163 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28164 If the ACL is not defined, processing completes as if
28165 the feature was not requested by the client.
28166
28167 .section "The QUIT ACL" "SECTQUITACL"
28168 .cindex "QUIT, ACL for"
28169 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
28170 does not affect the response code to QUIT, which is always 221. Thus, the ACL
28171 does not in fact control any access.
28172 For this reason, it may only accept
28173 or warn as its final result.
28174
28175 This ACL can be used for tasks such as custom logging at the end of an SMTP
28176 session. For example, you can use ACL variables in other ACLs to count
28177 messages, recipients, etc., and log the totals at QUIT time using one or
28178 more &%logwrite%& modifiers on a &%warn%& verb.
28179
28180 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
28181 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
28182
28183 You do not need to have a final &%accept%&, but if you do, you can use a
28184 &%message%& modifier to specify custom text that is sent as part of the 221
28185 response to QUIT.
28186
28187 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
28188 failure (for example, failure to open a log file, or when Exim is bombing out
28189 because it has detected an unrecoverable error), all SMTP commands from the
28190 client are given temporary error responses until QUIT is received or the
28191 connection is closed. In these special cases, the QUIT ACL does not run.
28192
28193
28194 .section "The not-QUIT ACL" "SECTNOTQUITACL"
28195 .vindex &$acl_smtp_notquit$&
28196 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
28197 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
28198 trouble, such as being unable to write to its log files, this ACL is not run,
28199 because it might try to do things (such as write to log files) that make the
28200 situation even worse.
28201
28202 Like the QUIT ACL, this ACL is provided to make it possible to do customized
28203 logging or to gather statistics, and its outcome is ignored. The &%delay%&
28204 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
28205 and &%warn%&.
28206
28207 .vindex &$smtp_notquit_reason$&
28208 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
28209 to a string that indicates the reason for the termination of the SMTP
28210 connection. The possible values are:
28211 .table2
28212 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
28213 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
28214 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
28215 .irow &`connection-lost`&          "The SMTP connection has been lost"
28216 .irow &`data-timeout`&             "Timeout while reading message data"
28217 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
28218 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
28219 .irow &`signal-exit`&              "SIGTERM or SIGINT"
28220 .irow &`synchronization-error`&    "SMTP synchronization error"
28221 .irow &`tls-failed`&               "TLS failed to start"
28222 .endtable
28223 In most cases when an SMTP connection is closed without having received QUIT,
28224 Exim sends an SMTP response message before actually closing the connection.
28225 With the exception of the &`acl-drop`& case, the default message can be
28226 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
28227 &%drop%& verb in another ACL, it is the message from the other ACL that is
28228 used.
28229
28230
28231 .section "Finding an ACL to use" "SECID195"
28232 .cindex "&ACL;" "finding which to use"
28233 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
28234 you can use different ACLs in different circumstances. For example,
28235 .code
28236 acl_smtp_rcpt = ${if ={25}{$interface_port} \
28237                      {acl_check_rcpt} {acl_check_rcpt_submit} }
28238 .endd
28239 In the default configuration file there are some example settings for
28240 providing an RFC 4409 message submission service on port 587 and a
28241 non-standard &"smtps"& service on port 465. You can use a string
28242 expansion like this to choose an ACL for MUAs on these ports which is
28243 more appropriate for this purpose than the default ACL on port 25.
28244
28245 The expanded string does not have to be the name of an ACL in the
28246 configuration file; there are other possibilities. Having expanded the
28247 string, Exim searches for an ACL as follows:
28248
28249 .ilist
28250 If the string begins with a slash, Exim uses it as a file name, and reads its
28251 contents as an ACL. The lines are processed in the same way as lines in the
28252 Exim configuration file. In particular, continuation lines are supported, blank
28253 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
28254 If the file does not exist or cannot be read, an error occurs (typically
28255 causing a temporary failure of whatever caused the ACL to be run). For example:
28256 .code
28257 acl_smtp_data = /etc/acls/\
28258   ${lookup{$sender_host_address}lsearch\
28259   {/etc/acllist}{$value}{default}}
28260 .endd
28261 This looks up an ACL file to use on the basis of the host's IP address, falling
28262 back to a default if the lookup fails. If an ACL is successfully read from a
28263 file, it is retained in memory for the duration of the Exim process, so that it
28264 can be re-used without having to re-read the file.
28265 .next
28266 If the string does not start with a slash, and does not contain any spaces,
28267 Exim searches the ACL section of the configuration for an ACL whose name
28268 matches the string.
28269 .next
28270 If no named ACL is found, or if the string contains spaces, Exim parses
28271 the string as an inline ACL. This can save typing in cases where you just
28272 want to have something like
28273 .code
28274 acl_smtp_vrfy = accept
28275 .endd
28276 in order to allow free use of the VRFY command. Such a string may contain
28277 newlines; it is processed in the same way as an ACL that is read from a file.
28278 .endlist
28279
28280
28281
28282
28283 .section "ACL return codes" "SECID196"
28284 .cindex "&ACL;" "return codes"
28285 Except for the QUIT ACL, which does not affect the SMTP return code (see
28286 section &<<SECTQUITACL>>& above), the result of running an ACL is either
28287 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
28288 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
28289 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
28290 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28291 This also causes a 4&'xx'& return code.
28292
28293 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28294 &"deny"&, because there is no mechanism for passing temporary errors to the
28295 submitters of non-SMTP messages.
28296
28297
28298 ACLs that are relevant to message reception may also return &"discard"&. This
28299 has the effect of &"accept"&, but causes either the entire message or an
28300 individual recipient address to be discarded. In other words, it is a
28301 blackholing facility. Use it with care.
28302
28303 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
28304 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
28305 RCPT ACL is to discard just the one recipient address. If there are no
28306 recipients left when the message's data is received, the DATA ACL is not
28307 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
28308 remaining recipients. The &"discard"& return is not permitted for the
28309 &%acl_smtp_predata%& ACL.
28310
28311 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
28312 is done on the address and the result determines the SMTP response.
28313
28314
28315 .cindex "&[local_scan()]& function" "when all recipients discarded"
28316 The &[local_scan()]& function is always run, even if there are no remaining
28317 recipients; it may create new recipients.
28318
28319
28320
28321 .section "Unset ACL options" "SECID197"
28322 .cindex "&ACL;" "unset options"
28323 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
28324 all the same. &*Note*&: These defaults apply only when the relevant ACL is
28325 not defined at all. For any defined ACL, the default action when control
28326 reaches the end of the ACL statements is &"deny"&.
28327
28328 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
28329 these two are ACLs that are used only for their side effects. They cannot be
28330 used to accept or reject anything.
28331
28332 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
28333 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
28334 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
28335 when the ACL is not defined is &"accept"&.
28336
28337 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
28338 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
28339 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28340 messages over an SMTP connection. For an example, see the ACL in the default
28341 configuration file.
28342
28343
28344
28345
28346 .section "Data for message ACLs" "SECID198"
28347 .cindex "&ACL;" "data for message ACL"
28348 .vindex &$domain$&
28349 .vindex &$local_part$&
28350 .vindex &$sender_address$&
28351 .vindex &$sender_host_address$&
28352 .vindex &$smtp_command$&
28353 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28354 that contain information about the host and the message's sender (for example,
28355 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28356 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28357 &$local_part$& are set from the argument address. The entire SMTP command
28358 is available in &$smtp_command$&.
28359
28360 When an ACL for the AUTH parameter of MAIL is running, the variables that
28361 contain information about the host are set, but &$sender_address$& is not yet
28362 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28363 how it is used.
28364
28365 .vindex "&$message_size$&"
28366 The &$message_size$& variable is set to the value of the SIZE parameter on
28367 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28368 that parameter is not given. The value is updated to the true message size by
28369 the time the final DATA ACL is run (after the message data has been
28370 received).
28371
28372 .vindex "&$rcpt_count$&"
28373 .vindex "&$recipients_count$&"
28374 The &$rcpt_count$& variable increases by one for each RCPT command received.
28375 The &$recipients_count$& variable increases by one each time a RCPT command is
28376 accepted, so while an ACL for RCPT is being processed, it contains the number
28377 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28378 &$rcpt_count$& contains the total number of RCPT commands, and
28379 &$recipients_count$& contains the total number of accepted recipients.
28380
28381
28382
28383
28384
28385 .section "Data for non-message ACLs" "SECTdatfornon"
28386 .cindex "&ACL;" "data for non-message ACL"
28387 .vindex &$smtp_command_argument$&
28388 .vindex &$smtp_command$&
28389 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28390 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28391 and the entire SMTP command is available in &$smtp_command$&.
28392 These variables can be tested using a &%condition%& condition. For example,
28393 here is an ACL for use with AUTH, which insists that either the session is
28394 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28395 does not permit authentication methods that use cleartext passwords on
28396 unencrypted connections.
28397 .code
28398 acl_check_auth:
28399   accept encrypted = *
28400   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28401                      {CRAM-MD5}}
28402   deny   message   = TLS encryption or CRAM-MD5 required
28403 .endd
28404 (Another way of applying this restriction is to arrange for the authenticators
28405 that use cleartext passwords not to be advertised when the connection is not
28406 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28407 option to do this.)
28408
28409
28410
28411 .section "Format of an ACL" "SECID199"
28412 .cindex "&ACL;" "format of"
28413 .cindex "&ACL;" "verbs, definition of"
28414 An individual ACL consists of a number of statements. Each statement starts
28415 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28416 Modifiers can change the way the verb operates, define error and log messages,
28417 set variables, insert delays, and vary the processing of accepted messages.
28418
28419 If all the conditions are met, the verb is obeyed. The same condition may be
28420 used (with different arguments) more than once in the same statement. This
28421 provides a means of specifying an &"and"& conjunction between conditions. For
28422 example:
28423 .code
28424 deny  dnslists = list1.example
28425       dnslists = list2.example
28426 .endd
28427 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28428 the conditions and modifiers when it reaches a condition that fails. What
28429 happens then depends on the verb (and in one case, on a special modifier). Not
28430 all the conditions make sense at every testing point. For example, you cannot
28431 test a sender address in the ACL that is run for a VRFY command.
28432
28433
28434 .section "ACL verbs" "SECID200"
28435 The ACL verbs are as follows:
28436
28437 .ilist
28438 .cindex "&%accept%& ACL verb"
28439 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28440 of the conditions are not met, what happens depends on whether &%endpass%&
28441 appears among the conditions (for syntax see below). If the failing condition
28442 is before &%endpass%&, control is passed to the next ACL statement; if it is
28443 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28444 check a RCPT command:
28445 .code
28446 accept domains = +local_domains
28447        endpass
28448        verify = recipient
28449 .endd
28450 If the recipient domain does not match the &%domains%& condition, control
28451 passes to the next statement. If it does match, the recipient is verified, and
28452 the command is accepted if verification succeeds. However, if verification
28453 fails, the ACL yields &"deny"&, because the failing condition is after
28454 &%endpass%&.
28455
28456 The &%endpass%& feature has turned out to be confusing to many people, so its
28457 use is not recommended nowadays. It is always possible to rewrite an ACL so
28458 that &%endpass%& is not needed, and it is no longer used in the default
28459 configuration.
28460
28461 .cindex "&%message%& ACL modifier" "with &%accept%&"
28462 If a &%message%& modifier appears on an &%accept%& statement, its action
28463 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28464 (when an &%accept%& verb either accepts or passes control to the next
28465 statement), &%message%& can be used to vary the message that is sent when an
28466 SMTP command is accepted. For example, in a RCPT ACL you could have:
28467 .display
28468 &`accept  `&<&'some conditions'&>
28469 &`        message = OK, I will allow you through today`&
28470 .endd
28471 You can specify an SMTP response code, optionally followed by an &"extended
28472 response code"& at the start of the message, but the first digit must be the
28473 same as would be sent by default, which is 2 for an &%accept%& verb.
28474
28475 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28476 an error message that is used when access is denied. This behaviour is retained
28477 for backward compatibility, but current &"best practice"& is to avoid the use
28478 of &%endpass%&.
28479
28480
28481 .next
28482 .cindex "&%defer%& ACL verb"
28483 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28484 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28485 &%defer%& is the same as &%deny%&, because there is no way of sending a
28486 temporary error. For a RCPT command, &%defer%& is much the same as using a
28487 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28488 be used in any ACL, and even for a recipient it might be a simpler approach.
28489
28490
28491 .next
28492 .cindex "&%deny%& ACL verb"
28493 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28494 the conditions are not met, control is passed to the next ACL statement. For
28495 example,
28496 .code
28497 deny dnslists = blackholes.mail-abuse.org
28498 .endd
28499 rejects commands from hosts that are on a DNS black list.
28500
28501
28502 .next
28503 .cindex "&%discard%& ACL verb"
28504 &%discard%&: This verb behaves like &%accept%&, except that it returns
28505 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28506 that are concerned with receiving messages. When all the conditions are true,
28507 the sending entity receives a &"success"& response. However, &%discard%& causes
28508 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28509 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28510 message's recipients are discarded. Recipients that are discarded before DATA
28511 do not appear in the log line when the &%received_recipients%& log selector is set.
28512
28513 If the &%log_message%& modifier is set when &%discard%& operates,
28514 its contents are added to the line that is automatically written to the log.
28515 The &%message%& modifier operates exactly as it does for &%accept%&.
28516
28517
28518 .next
28519 .cindex "&%drop%& ACL verb"
28520 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28521 forcibly closed after the 5&'xx'& error message has been sent. For example:
28522 .code
28523 drop   message   = I don't take more than 20 RCPTs
28524        condition = ${if > {$rcpt_count}{20}}
28525 .endd
28526 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28527 The connection is always dropped after sending a 550 response.
28528
28529 .next
28530 .cindex "&%require%& ACL verb"
28531 &%require%&: If all the conditions are met, control is passed to the next ACL
28532 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28533 example, when checking a RCPT command,
28534 .code
28535 require message = Sender did not verify
28536         verify  = sender
28537 .endd
28538 passes control to subsequent statements only if the message's sender can be
28539 verified. Otherwise, it rejects the command. Note the positioning of the
28540 &%message%& modifier, before the &%verify%& condition. The reason for this is
28541 discussed in section &<<SECTcondmodproc>>&.
28542
28543 .next
28544 .cindex "&%warn%& ACL verb"
28545 &%warn%&: If all the conditions are true, a line specified by the
28546 &%log_message%& modifier is written to Exim's main log. Control always passes
28547 to the next ACL statement. If any condition is false, the log line is not
28548 written. If an identical log line is requested several times in the same
28549 message, only one copy is actually written to the log. If you want to force
28550 duplicates to be written, use the &%logwrite%& modifier instead.
28551
28552 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28553 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28554 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28555 first failing condition. There is more about adding header lines in section
28556 &<<SECTaddheadacl>>&.
28557
28558 If any condition on a &%warn%& statement cannot be completed (that is, there is
28559 some sort of defer), the log line specified by &%log_message%& is not written.
28560 This does not include the case of a forced failure from a lookup, which
28561 is considered to be a successful completion. After a defer, no further
28562 conditions or modifiers in the &%warn%& statement are processed. The incident
28563 is logged, and the ACL continues to be processed, from the next statement
28564 onwards.
28565
28566
28567 .vindex "&$acl_verify_message$&"
28568 When one of the &%warn%& conditions is an address verification that fails, the
28569 text of the verification failure message is in &$acl_verify_message$&. If you
28570 want this logged, you must set it up explicitly. For example:
28571 .code
28572 warn   !verify = sender
28573        log_message = sender verify failed: $acl_verify_message
28574 .endd
28575 .endlist
28576
28577 At the end of each ACL there is an implicit unconditional &%deny%&.
28578
28579 As you can see from the examples above, the conditions and modifiers are
28580 written one to a line, with the first one on the same line as the verb, and
28581 subsequent ones on following lines. If you have a very long condition, you can
28582 continue it onto several physical lines by the usual backslash continuation
28583 mechanism. It is conventional to align the conditions vertically.
28584
28585
28586
28587 .section "ACL variables" "SECTaclvariables"
28588 .cindex "&ACL;" "variables"
28589 There are some special variables that can be set during ACL processing. They
28590 can be used to pass information between different ACLs, different invocations
28591 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28592 transports, and filters that are used to deliver a message. The names of these
28593 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28594 an underscore, but the remainder of the name can be any sequence of
28595 alphanumeric characters and underscores that you choose. There is no limit on
28596 the number of ACL variables. The two sets act as follows:
28597 .ilist
28598 The values of those variables whose names begin with &$acl_c$& persist
28599 throughout an SMTP connection. They are never reset. Thus, a value that is set
28600 while receiving one message is still available when receiving the next message
28601 on the same SMTP connection.
28602 .next
28603 The values of those variables whose names begin with &$acl_m$& persist only
28604 while a message is being received. They are reset afterwards. They are also
28605 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28606 .endlist
28607
28608 When a message is accepted, the current values of all the ACL variables are
28609 preserved with the message and are subsequently made available at delivery
28610 time. The ACL variables are set by a modifier called &%set%&. For example:
28611 .code
28612 accept hosts = whatever
28613        set acl_m4 = some value
28614 accept authenticated = *
28615        set acl_c_auth = yes
28616 .endd
28617 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28618 be set. If you want to set a variable without taking any action, you can use a
28619 &%warn%& verb without any other modifiers or conditions.
28620
28621 .oindex &%strict_acl_vars%&
28622 What happens if a syntactically valid but undefined ACL variable is
28623 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28624 false (the default), an empty string is substituted; if it is true, an
28625 error is generated.
28626
28627 Versions of Exim before 4.64 have a limited set of numbered variables, but
28628 their names are compatible, so there is no problem with upgrading.
28629
28630
28631 .section "Condition and modifier processing" "SECTcondmodproc"
28632 .cindex "&ACL;" "conditions; processing"
28633 .cindex "&ACL;" "modifiers; processing"
28634 An exclamation mark preceding a condition negates its result. For example:
28635 .code
28636 deny   domains = *.dom.example
28637       !verify  = recipient
28638 .endd
28639 causes the ACL to return &"deny"& if the recipient domain ends in
28640 &'dom.example'& and the recipient address cannot be verified. Sometimes
28641 negation can be used on the right-hand side of a condition. For example, these
28642 two statements are equivalent:
28643 .code
28644 deny  hosts = !192.168.3.4
28645 deny !hosts =  192.168.3.4
28646 .endd
28647 However, for many conditions (&%verify%& being a good example), only left-hand
28648 side negation of the whole condition is possible.
28649
28650 The arguments of conditions and modifiers are expanded. A forced failure
28651 of an expansion causes a condition to be ignored, that is, it behaves as if the
28652 condition is true. Consider these two statements:
28653 .code
28654 accept  senders = ${lookup{$host_name}lsearch\
28655                   {/some/file}{$value}fail}
28656 accept  senders = ${lookup{$host_name}lsearch\
28657                   {/some/file}{$value}{}}
28658 .endd
28659 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28660 the returned list is searched, but if the lookup fails the behaviour is
28661 different in the two cases. The &%fail%& in the first statement causes the
28662 condition to be ignored, leaving no further conditions. The &%accept%& verb
28663 therefore succeeds. The second statement, however, generates an empty list when
28664 the lookup fails. No sender can match an empty list, so the condition fails,
28665 and therefore the &%accept%& also fails.
28666
28667 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28668 specify actions that are taken as the conditions for a statement are checked;
28669 others specify text for messages that are used when access is denied or a
28670 warning is generated. The &%control%& modifier affects the way an incoming
28671 message is handled.
28672
28673 The positioning of the modifiers in an ACL statement is important, because the
28674 processing of a verb ceases as soon as its outcome is known. Only those
28675 modifiers that have already been encountered will take effect. For example,
28676 consider this use of the &%message%& modifier:
28677 .code
28678 require message = Can't verify sender
28679         verify  = sender
28680         message = Can't verify recipient
28681         verify  = recipient
28682         message = This message cannot be used
28683 .endd
28684 If sender verification fails, Exim knows that the result of the statement is
28685 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28686 so its text is used as the error message. If sender verification succeeds, but
28687 recipient verification fails, the second message is used. If recipient
28688 verification succeeds, the third message becomes &"current"&, but is never used
28689 because there are no more conditions to cause failure.
28690
28691 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28692 modifier that is used, because all the conditions must be true for rejection to
28693 happen. Specifying more than one &%message%& modifier does not make sense, and
28694 the message can even be specified after all the conditions. For example:
28695 .code
28696 deny   hosts = ...
28697       !senders = *@my.domain.example
28698        message = Invalid sender from client host
28699 .endd
28700 The &"deny"& result does not happen until the end of the statement is reached,
28701 by which time Exim has set up the message.
28702
28703
28704
28705 .section "ACL modifiers" "SECTACLmodi"
28706 .cindex "&ACL;" "modifiers; list of"
28707 The ACL modifiers are as follows:
28708
28709 .vlist
28710 .vitem &*add_header*&&~=&~<&'text'&>
28711 This modifier specifies one or more header lines that are to be added to an
28712 incoming message, assuming, of course, that the message is ultimately
28713 accepted. For details, see section &<<SECTaddheadacl>>&.
28714
28715 .vitem &*continue*&&~=&~<&'text'&>
28716 .cindex "&%continue%& ACL modifier"
28717 .cindex "database" "updating in ACL"
28718 This modifier does nothing of itself, and processing of the ACL always
28719 continues with the next condition or modifier. The value of &%continue%& is in
28720 the side effects of expanding its argument. Typically this could be used to
28721 update a database. It is really just a syntactic tidiness, to avoid having to
28722 write rather ugly lines like this:
28723 .display
28724 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28725 .endd
28726 Instead, all you need is
28727 .display
28728 &`continue = `&<&'some expansion'&>
28729 .endd
28730
28731 .vitem &*control*&&~=&~<&'text'&>
28732 .cindex "&%control%& ACL modifier"
28733 This modifier affects the subsequent processing of the SMTP connection or of an
28734 incoming message that is accepted. The effect of the first type of control
28735 lasts for the duration of the connection, whereas the effect of the second type
28736 lasts only until the current message has been received. The message-specific
28737 controls always apply to the whole message, not to individual recipients,
28738 even if the &%control%& modifier appears in a RCPT ACL.
28739
28740 As there are now quite a few controls that can be applied, they are described
28741 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28742 in several different ways. For example:
28743
28744 . ==== As this is a nested list, any displays it contains must be indented
28745 . ==== as otherwise they are too far to the left. That comment applies only
28746 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28747 . ==== way.
28748
28749 .ilist
28750 It can be at the end of an &%accept%& statement:
28751 .code
28752     accept  ...some conditions
28753             control = queue_only
28754 .endd
28755 In this case, the control is applied when this statement yields &"accept"&, in
28756 other words, when the conditions are all true.
28757
28758 .next
28759 It can be in the middle of an &%accept%& statement:
28760 .code
28761     accept  ...some conditions...
28762             control = queue_only
28763             ...some more conditions...
28764 .endd
28765 If the first set of conditions are true, the control is applied, even if the
28766 statement does not accept because one of the second set of conditions is false.
28767 In this case, some subsequent statement must yield &"accept"& for the control
28768 to be relevant.
28769
28770 .next
28771 It can be used with &%warn%& to apply the control, leaving the
28772 decision about accepting or denying to a subsequent verb. For
28773 example:
28774 .code
28775     warn    ...some conditions...
28776             control = freeze
28777     accept  ...
28778 .endd
28779 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28780 &%logwrite%&, so it does not add anything to the message and does not write a
28781 log entry.
28782
28783 .next
28784 If you want to apply a control unconditionally, you can use it with a
28785 &%require%& verb. For example:
28786 .code
28787     require  control = no_multiline_responses
28788 .endd
28789 .endlist
28790
28791 .vitem &*delay*&&~=&~<&'time'&>
28792 .cindex "&%delay%& ACL modifier"
28793 .oindex "&%-bh%&"
28794 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28795 the time interval before proceeding. However, when testing Exim using the
28796 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28797 output instead). The time is given in the usual Exim notation, and the delay
28798 happens as soon as the modifier is processed. In an SMTP session, pending
28799 output is flushed before the delay is imposed.
28800
28801 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28802 example:
28803 .code
28804 deny    ...some conditions...
28805         delay = 30s
28806 .endd
28807 The delay happens if all the conditions are true, before the statement returns
28808 &"deny"&. Compare this with:
28809 .code
28810 deny    delay = 30s
28811         ...some conditions...
28812 .endd
28813 which waits for 30s before processing the conditions. The &%delay%& modifier
28814 can also be used with &%warn%& and together with &%control%&:
28815 .code
28816 warn    ...some conditions...
28817         delay = 2m
28818         control = freeze
28819 accept  ...
28820 .endd
28821
28822 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28823 responses to several commands are no longer buffered and sent in one packet (as
28824 they would normally be) because all output is flushed before imposing the
28825 delay. This optimization is disabled so that a number of small delays do not
28826 appear to the client as one large aggregated delay that might provoke an
28827 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28828 using a &%control%& modifier to set &%no_delay_flush%&.
28829
28830
28831 .vitem &*endpass*&
28832 .cindex "&%endpass%& ACL modifier"
28833 This modifier, which has no argument, is recognized only in &%accept%& and
28834 &%discard%& statements. It marks the boundary between the conditions whose
28835 failure causes control to pass to the next statement, and the conditions whose
28836 failure causes the ACL to return &"deny"&. This concept has proved to be
28837 confusing to some people, so the use of &%endpass%& is no longer recommended as
28838 &"best practice"&. See the description of &%accept%& above for more details.
28839
28840
28841 .vitem &*log_message*&&~=&~<&'text'&>
28842 .cindex "&%log_message%& ACL modifier"
28843 This modifier sets up a message that is used as part of the log message if the
28844 ACL denies access or a &%warn%& statement's conditions are true. For example:
28845 .code
28846 require log_message = wrong cipher suite $tls_in_cipher
28847         encrypted   = DES-CBC3-SHA
28848 .endd
28849 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28850 example:
28851 .display
28852 &`discard `&<&'some conditions'&>
28853 &`        log_message = Discarded $local_part@$domain because...`&
28854 .endd
28855 When access is denied, &%log_message%& adds to any underlying error message
28856 that may exist because of a condition failure. For example, while verifying a
28857 recipient address, a &':fail:'& redirection might have already set up a
28858 message.
28859
28860 The message may be defined before the conditions to which it applies, because
28861 the string expansion does not happen until Exim decides that access is to be
28862 denied. This means that any variables that are set by the condition are
28863 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28864 variables are set after a DNS black list lookup succeeds. If the expansion of
28865 &%log_message%& fails, or if the result is an empty string, the modifier is
28866 ignored.
28867
28868 .vindex "&$acl_verify_message$&"
28869 If you want to use a &%warn%& statement to log the result of an address
28870 verification, you can use &$acl_verify_message$& to include the verification
28871 error message.
28872
28873 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28874 the start of the logged message. If the same warning log message is requested
28875 more than once while receiving  a single email message, only one copy is
28876 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28877 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28878 is logged for a successful &%warn%& statement.
28879
28880 If &%log_message%& is not present and there is no underlying error message (for
28881 example, from the failure of address verification), but &%message%& is present,
28882 the &%message%& text is used for logging rejections. However, if any text for
28883 logging contains newlines, only the first line is logged. In the absence of
28884 both &%log_message%& and &%message%&, a default built-in message is used for
28885 logging rejections.
28886
28887
28888 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28889 .cindex "&%log_reject_target%& ACL modifier"
28890 .cindex "logging in ACL" "specifying which log"
28891 This modifier makes it possible to specify which logs are used for messages
28892 about ACL rejections. Its argument is a colon-separated list of words that can
28893 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28894 may be empty, in which case a rejection is not logged at all. For example, this
28895 ACL fragment writes no logging information when access is denied:
28896 .display
28897 &`deny `&<&'some conditions'&>
28898 &`     log_reject_target =`&
28899 .endd
28900 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28901 permanent and temporary rejections. Its effect lasts for the rest of the
28902 current ACL.
28903
28904
28905 .vitem &*logwrite*&&~=&~<&'text'&>
28906 .cindex "&%logwrite%& ACL modifier"
28907 .cindex "logging in ACL" "immediate"
28908 This modifier writes a message to a log file as soon as it is encountered when
28909 processing an ACL. (Compare &%log_message%&, which, except in the case of
28910 &%warn%& and &%discard%&, is used only if the ACL statement denies
28911 access.) The &%logwrite%& modifier can be used to log special incidents in
28912 ACLs. For example:
28913 .display
28914 &`accept `&<&'some special conditions'&>
28915 &`       control  = freeze`&
28916 &`       logwrite = froze message because ...`&
28917 .endd
28918 By default, the message is written to the main log. However, it may begin
28919 with a colon, followed by a comma-separated list of log names, and then
28920 another colon, to specify exactly which logs are to be written. For
28921 example:
28922 .code
28923 logwrite = :main,reject: text for main and reject logs
28924 logwrite = :panic: text for panic log only
28925 .endd
28926
28927
28928 .vitem &*message*&&~=&~<&'text'&>
28929 .cindex "&%message%& ACL modifier"
28930 This modifier sets up a text string that is expanded and used as a response
28931 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28932 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28933 there is some complication if &%endpass%& is involved; see the description of
28934 &%accept%& for details.)
28935
28936 The expansion of the message happens at the time Exim decides that the ACL is
28937 to end, not at the time it processes &%message%&. If the expansion fails, or
28938 generates an empty string, the modifier is ignored. Here is an example where
28939 &%message%& must be specified first, because the ACL ends with a rejection if
28940 the &%hosts%& condition fails:
28941 .code
28942 require  message = Host not recognized
28943          hosts = 10.0.0.0/8
28944 .endd
28945 (Once a condition has failed, no further conditions or modifiers are
28946 processed.)
28947
28948 .cindex "SMTP" "error codes"
28949 .oindex "&%smtp_banner%&
28950 For ACLs that are triggered by SMTP commands, the message is returned as part
28951 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28952 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28953 is accepted. In the case of the connect ACL, accepting with a message modifier
28954 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28955 accept message may not contain more than one line (otherwise it will be
28956 truncated at the first newline and a panic logged), and it cannot affect the
28957 EHLO options.
28958
28959 When SMTP is involved, the message may begin with an overriding response code,
28960 consisting of three digits optionally followed by an &"extended response code"&
28961 of the form &'n.n.n'&, each code being followed by a space. For example:
28962 .code
28963 deny  message = 599 1.2.3 Host not welcome
28964       hosts = 192.168.34.0/24
28965 .endd
28966 The first digit of the supplied response code must be the same as would be sent
28967 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28968 access, but for the predata ACL, note that the default success code is 354, not
28969 2&'xx'&.
28970
28971 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28972 the message modifier cannot override the 221 response code.
28973
28974 The text in a &%message%& modifier is literal; any quotes are taken as
28975 literals, but because the string is expanded, backslash escapes are processed
28976 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28977 response.
28978
28979 .vindex "&$acl_verify_message$&"
28980 For ACLs that are called by an &%acl =%& ACL condition, the message is
28981 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28982
28983 If &%message%& is used on a statement that verifies an address, the message
28984 specified overrides any message that is generated by the verification process.
28985 However, the original message is available in the variable
28986 &$acl_verify_message$&, so you can incorporate it into your message if you
28987 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28988 routers to be passed back as part of the SMTP response, you should either not
28989 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28990
28991 For compatibility with previous releases of Exim, a &%message%& modifier that
28992 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28993 modifier, but this usage is now deprecated. However, &%message%& acts only when
28994 all the conditions are true, wherever it appears in an ACL command, whereas
28995 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28996 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28997 effect.
28998
28999
29000 .vitem &*queue*&&~=&~<&'text'&>
29001 This modifier specifies the use of a named queue for spool files
29002 for the message.
29003 It can only be used before the message is received (i.e. not in
29004 the DATA ACL).
29005 This could be used, for example, for known high-volume burst sources
29006 of traffic, or for quarantine of messages.
29007 Separate queue-runner processes will be needed for named queues.
29008 If the text after expansion is empty, the default queue is used.
29009
29010
29011 .vitem &*remove_header*&&~=&~<&'text'&>
29012 This modifier specifies one or more header names in a colon-separated list
29013  that are to be removed from an incoming message, assuming, of course, that
29014 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
29015
29016
29017 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
29018 .cindex "&%set%& ACL modifier"
29019 This modifier puts a value into one of the ACL variables (see section
29020 &<<SECTaclvariables>>&).
29021
29022
29023 .vitem &*udpsend*&&~=&~<&'parameters'&>
29024 .cindex "UDP communications"
29025 This modifier sends a UDP packet, for purposes such as statistics
29026 collection or behaviour monitoring. The parameters are expanded, and
29027 the result of the expansion must be a colon-separated list consisting
29028 of a destination server, port number, and the packet contents. The
29029 server can be specified as a host name or IPv4 or IPv6 address. The
29030 separator can be changed with the usual angle bracket syntax. For
29031 example, you might want to collect information on which hosts connect
29032 when:
29033 .code
29034 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
29035              $tod_zulu $sender_host_address
29036 .endd
29037 .endlist
29038
29039
29040
29041
29042 .section "Use of the control modifier" "SECTcontrols"
29043 .cindex "&%control%& ACL modifier"
29044 The &%control%& modifier supports the following settings:
29045
29046 .vlist
29047 .vitem &*control&~=&~allow_auth_unadvertised*&
29048 This modifier allows a client host to use the SMTP AUTH command even when it
29049 has not been advertised in response to EHLO. Furthermore, because there are
29050 apparently some really broken clients that do this, Exim will accept AUTH after
29051 HELO (rather than EHLO) when this control is set. It should be used only if you
29052 really need it, and you should limit its use to those broken clients that do
29053 not work without it. For example:
29054 .code
29055 warn hosts   = 192.168.34.25
29056      control = allow_auth_unadvertised
29057 .endd
29058 Normally, when an Exim server receives an AUTH command, it checks the name of
29059 the authentication mechanism that is given in the command to ensure that it
29060 matches an advertised mechanism. When this control is set, the check that a
29061 mechanism has been advertised is bypassed. Any configured mechanism can be used
29062 by the client. This control is permitted only in the connection and HELO ACLs.
29063
29064
29065 .vitem &*control&~=&~caseful_local_part*& &&&
29066        &*control&~=&~caselower_local_part*&
29067 .cindex "&ACL;" "case of local part in"
29068 .cindex "case of local parts"
29069 .vindex "&$local_part$&"
29070 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
29071 (that is, during RCPT processing). By default, the contents of &$local_part$&
29072 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
29073 any uppercase letters in the original local part are restored in &$local_part$&
29074 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
29075 is encountered.
29076
29077 These controls affect only the current recipient. Moreover, they apply only to
29078 local part handling that takes place directly in the ACL (for example, as a key
29079 in lookups). If a test to verify the recipient is obeyed, the case-related
29080 handling of the local part during the verification is controlled by the router
29081 configuration (see the &%caseful_local_part%& generic router option).
29082
29083 This facility could be used, for example, to add a spam score to local parts
29084 containing upper case letters. For example, using &$acl_m4$& to accumulate the
29085 spam score:
29086 .code
29087 warn  control = caseful_local_part
29088       set acl_m4 = ${eval:\
29089                      $acl_m4 + \
29090                      ${if match{$local_part}{[A-Z]}{1}{0}}\
29091                     }
29092       control = caselower_local_part
29093 .endd
29094 Notice that we put back the lower cased version afterwards, assuming that
29095 is what is wanted for subsequent tests.
29096
29097
29098 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
29099 .cindex "&ACL;" "cutthrough routing"
29100 .cindex "cutthrough" "requesting"
29101 This option requests delivery be attempted while the item is being received.
29102
29103 The option is usable in the RCPT ACL.
29104 If enabled for a message received via smtp and routed to an smtp transport,
29105 and only one transport, interface, destination host and port combination
29106 is used for all recipients of the message,
29107 then the delivery connection is made while the receiving connection is open
29108 and data is copied from one to the other.
29109
29110 An attempt to set this option for any recipient but the first
29111 for a mail will be quietly ignored.
29112 If a recipient-verify callout
29113 (with use_sender)
29114 connection is subsequently
29115 requested in the same ACL it is held open and used for
29116 any subsequent recipients and the data,
29117 otherwise one is made after the initial RCPT ACL completes.
29118
29119 Note that routers are used in verify mode,
29120 and cannot depend on content of received headers.
29121 Note also that headers cannot be
29122 modified by any of the post-data ACLs (DATA, MIME and DKIM).
29123 Headers may be modified by routers (subject to the above) and transports.
29124 The Received-By: header is generated as soon as the body reception starts,
29125 rather than the traditional time after the full message is received;
29126 this will affect the timestamp.
29127
29128 All the usual ACLs are called; if one results in the message being
29129 rejected, all effort spent in delivery (including the costs on
29130 the ultimate destination) will be wasted.
29131 Note that in the case of data-time ACLs this includes the entire
29132 message body.
29133
29134 Cutthrough delivery is not supported via transport-filters or when DKIM signing
29135 of outgoing messages is done, because it sends data to the ultimate destination
29136 before the entire message has been received from the source.
29137 It is not supported for messages received with the SMTP PRDR
29138 or CHUNKING
29139 options in use.
29140
29141 Should the ultimate destination system positively accept or reject the mail,
29142 a corresponding indication is given to the source system and nothing is queued.
29143 If the item is successfully delivered in cutthrough mode
29144 the delivery log lines are tagged with ">>" rather than "=>" and appear
29145 before the acceptance "<=" line.
29146
29147 If there is a temporary error the item is queued for later delivery in the
29148 usual fashion.
29149 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
29150 to the control; the default value is &"spool"& and the alternate value
29151 &"pass"& copies an SMTP defer response from the target back to the initiator
29152 and does not queue the message.
29153 Note that this is independent of any recipient verify conditions in the ACL.
29154
29155 Delivery in this mode avoids the generation of a bounce mail to a
29156 (possibly faked)
29157 sender when the destination system is doing content-scan based rejection.
29158
29159
29160 .vitem &*control&~=&~debug/*&<&'options'&>
29161 .cindex "&ACL;" "enabling debug logging"
29162 .cindex "debugging" "enabling from an ACL"
29163 This control turns on debug logging, almost as though Exim had been invoked
29164 with &`-d`&, with the output going to a new logfile in the usual logs directory,
29165 by default called &'debuglog'&.
29166 The filename can be adjusted with the &'tag'& option, which
29167 may access any variables already defined.  The logging may be adjusted with
29168 the &'opts'& option, which takes the same values as the &`-d`& command-line
29169 option.
29170 Logging started this way may be stopped, and the file removed,
29171 with the &'kill'& option.
29172 Some examples (which depend on variables that don't exist in all
29173 contexts):
29174 .code
29175       control = debug
29176       control = debug/tag=.$sender_host_address
29177       control = debug/opts=+expand+acl
29178       control = debug/tag=.$message_exim_id/opts=+expand
29179       control = debug/kill
29180 .endd
29181
29182
29183 .vitem &*control&~=&~dkim_disable_verify*&
29184 .cindex "disable DKIM verify"
29185 .cindex "DKIM" "disable verify"
29186 This control turns off DKIM verification processing entirely.  For details on
29187 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
29188
29189
29190 .vitem &*control&~=&~dscp/*&<&'value'&>
29191 .cindex "&ACL;" "setting DSCP value"
29192 .cindex "DSCP" "inbound"
29193 This option causes the DSCP value associated with the socket for the inbound
29194 connection to be adjusted to a given value, given as one of a number of fixed
29195 strings or to numeric value.
29196 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
29197 Common values include &`throughput`&, &`mincost`&, and on newer systems
29198 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
29199
29200 The outbound packets from Exim will be marked with this value in the header
29201 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
29202 that these values will have any effect, not be stripped by networking
29203 equipment, or do much of anything without cooperation with your Network
29204 Engineer and those of all network operators between the source and destination.
29205
29206
29207 .vitem &*control&~=&~enforce_sync*& &&&
29208        &*control&~=&~no_enforce_sync*&
29209 .cindex "SMTP" "synchronization checking"
29210 .cindex "synchronization checking in SMTP"
29211 These controls make it possible to be selective about when SMTP synchronization
29212 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
29213 state of the switch (it is true by default). See the description of this option
29214 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
29215
29216 The effect of these two controls lasts for the remainder of the SMTP
29217 connection. They can appear in any ACL except the one for the non-SMTP
29218 messages. The most straightforward place to put them is in the ACL defined by
29219 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
29220 before the first synchronization check. The expected use is to turn off the
29221 synchronization checks for badly-behaved hosts that you nevertheless need to
29222 work with.
29223
29224
29225 .vitem &*control&~=&~fakedefer/*&<&'message'&>
29226 .cindex "fake defer"
29227 .cindex "defer, fake"
29228 This control works in exactly the same way as &%fakereject%& (described below)
29229 except that it causes an SMTP 450 response after the message data instead of a
29230 550 response. You must take care when using &%fakedefer%& because it causes the
29231 messages to be duplicated when the sender retries. Therefore, you should not
29232 use &%fakedefer%& if the message is to be delivered normally.
29233
29234 .vitem &*control&~=&~fakereject/*&<&'message'&>
29235 .cindex "fake rejection"
29236 .cindex "rejection, fake"
29237 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
29238 words, only when an SMTP message is being received. If Exim accepts the
29239 message, instead the final 250 response, a 550 rejection message is sent.
29240 However, Exim proceeds to deliver the message as normal. The control applies
29241 only to the current message, not to any subsequent ones that may be received in
29242 the same SMTP connection.
29243
29244 The text for the 550 response is taken from the &%control%& modifier. If no
29245 message is supplied, the following is used:
29246 .code
29247 550-Your message has been rejected but is being
29248 550-kept for evaluation.
29249 550-If it was a legitimate message, it may still be
29250 550 delivered to the target recipient(s).
29251 .endd
29252 This facility should be used with extreme caution.
29253
29254 .vitem &*control&~=&~freeze*&
29255 .cindex "frozen messages" "forcing in ACL"
29256 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29257 other words, only when a message is being received. If the message is accepted,
29258 it is placed on Exim's queue and frozen. The control applies only to the
29259 current message, not to any subsequent ones that may be received in the same
29260 SMTP connection.
29261
29262 This modifier can optionally be followed by &`/no_tell`&. If the global option
29263 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
29264 is told about the freezing), provided all the &*control=freeze*& modifiers that
29265 are obeyed for the current message have the &`/no_tell`& option.
29266
29267 .vitem &*control&~=&~no_delay_flush*&
29268 .cindex "SMTP" "output flushing, disabling for delay"
29269 Exim normally flushes SMTP output before implementing a delay in an ACL, to
29270 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29271 use. This control, as long as it is encountered before the &%delay%& modifier,
29272 disables such output flushing.
29273
29274 .vitem &*control&~=&~no_callout_flush*&
29275 .cindex "SMTP" "output flushing, disabling for callout"
29276 Exim normally flushes SMTP output before performing a callout in an ACL, to
29277 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29278 use. This control, as long as it is encountered before the &%verify%& condition
29279 that causes the callout, disables such output flushing.
29280
29281 .vitem &*control&~=&~no_mbox_unspool*&
29282 This control is available when Exim is compiled with the content scanning
29283 extension. Content scanning may require a copy of the current message, or parts
29284 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
29285 or spam scanner. Normally, such copies are deleted when they are no longer
29286 needed. If this control is set, the copies are not deleted. The control applies
29287 only to the current message, not to any subsequent ones that may be received in
29288 the same SMTP connection. It is provided for debugging purposes and is unlikely
29289 to be useful in production.
29290
29291 .vitem &*control&~=&~no_multiline_responses*&
29292 .cindex "multiline responses, suppressing"
29293 This control is permitted for any ACL except the one for non-SMTP messages.
29294 It seems that there are broken clients in use that cannot handle multiline
29295 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
29296
29297 If this control is set, multiline SMTP responses from ACL rejections are
29298 suppressed. One way of doing this would have been to put out these responses as
29299 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
29300 (&"use multiline responses for more"& it says &-- ha!), and some of the
29301 responses might get close to that. So this facility, which is after all only a
29302 sop to broken clients, is implemented by doing two very easy things:
29303
29304 .ilist
29305 Extra information that is normally output as part of a rejection caused by
29306 sender verification failure is omitted. Only the final line (typically &"sender
29307 verification failed"&) is sent.
29308 .next
29309 If a &%message%& modifier supplies a multiline response, only the first
29310 line is output.
29311 .endlist
29312
29313 The setting of the switch can, of course, be made conditional on the
29314 calling host. Its effect lasts until the end of the SMTP connection.
29315
29316 .vitem &*control&~=&~no_pipelining*&
29317 .cindex "PIPELINING" "suppressing advertising"
29318 This control turns off the advertising of the PIPELINING extension to SMTP in
29319 the current session. To be useful, it must be obeyed before Exim sends its
29320 response to an EHLO command. Therefore, it should normally appear in an ACL
29321 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
29322 &%pipelining_advertise_hosts%&.
29323
29324 .vitem &*control&~=&~queue_only*&
29325 .oindex "&%queue_only%&"
29326 .cindex "queueing incoming messages"
29327 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29328 other words, only when a message is being received. If the message is accepted,
29329 it is placed on Exim's queue and left there for delivery by a subsequent queue
29330 runner. No immediate delivery process is started. In other words, it has the
29331 effect as the &%queue_only%& global option. However, the control applies only
29332 to the current message, not to any subsequent ones that may be received in the
29333 same SMTP connection.
29334
29335 .vitem &*control&~=&~submission/*&<&'options'&>
29336 .cindex "message" "submission"
29337 .cindex "submission mode"
29338 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
29339 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
29340 the current message is a submission from a local MUA. In this case, Exim
29341 operates in &"submission mode"&, and applies certain fixups to the message if
29342 necessary. For example, it adds a &'Date:'& header line if one is not present.
29343 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
29344 late (the message has already been created).
29345
29346 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
29347 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
29348 submission mode; the available options for this control are described there.
29349 The control applies only to the current message, not to any subsequent ones
29350 that may be received in the same SMTP connection.
29351
29352 .vitem &*control&~=&~suppress_local_fixups*&
29353 .cindex "submission fixups, suppressing"
29354 This control applies to locally submitted (non TCP/IP) messages, and is the
29355 complement of &`control = submission`&. It disables the fixups that are
29356 normally applied to locally-submitted messages. Specifically:
29357
29358 .ilist
29359 Any &'Sender:'& header line is left alone (in this respect, it is a
29360 dynamic version of &%local_sender_retain%&).
29361 .next
29362 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29363 .next
29364 There is no check that &'From:'& corresponds to the actual sender.
29365 .endlist ilist
29366
29367 This control may be useful when a remotely-originated message is accepted,
29368 passed to some scanning program, and then re-submitted for delivery. It can be
29369 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29370 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29371 data is read.
29372
29373 &*Note:*& This control applies only to the current message, not to any others
29374 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29375
29376 .vitem &*control&~=&~utf8_downconvert*&
29377 This control enables conversion of UTF-8 in message addresses
29378 to a-label form.
29379 For details see section &<<SECTi18nMTA>>&.
29380 .endlist vlist
29381
29382
29383 .section "Summary of message fixup control" "SECTsummesfix"
29384 All four possibilities for message fixups can be specified:
29385
29386 .ilist
29387 Locally submitted, fixups applied: the default.
29388 .next
29389 Locally submitted, no fixups applied: use
29390 &`control = suppress_local_fixups`&.
29391 .next
29392 Remotely submitted, no fixups applied: the default.
29393 .next
29394 Remotely submitted, fixups applied: use &`control = submission`&.
29395 .endlist
29396
29397
29398
29399 .section "Adding header lines in ACLs" "SECTaddheadacl"
29400 .cindex "header lines" "adding in an ACL"
29401 .cindex "header lines" "position of added lines"
29402 .cindex "&%add_header%& ACL modifier"
29403 The &%add_header%& modifier can be used to add one or more extra header lines
29404 to an incoming message, as in this example:
29405 .code
29406 warn dnslists = sbl.spamhaus.org : \
29407                 dialup.mail-abuse.org
29408      add_header = X-blacklisted-at: $dnslist_domain
29409 .endd
29410 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29411 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29412 receiving a message). The message must ultimately be accepted for
29413 &%add_header%& to have any significant effect. You can use &%add_header%& with
29414 any ACL verb, including &%deny%& (though this is potentially useful only in a
29415 RCPT ACL).
29416
29417 Headers will not be added to the message if the modifier is used in
29418 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29419
29420 Leading and trailing newlines are removed from
29421 the data for the &%add_header%& modifier; if it then
29422 contains one or more newlines that
29423 are not followed by a space or a tab, it is assumed to contain multiple header
29424 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29425 front of any line that is not a valid header line.
29426
29427 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29428 They are added to the message before processing the DATA and MIME ACLs.
29429 However, if an identical header line is requested more than once, only one copy
29430 is actually added to the message. Further header lines may be accumulated
29431 during the DATA and MIME ACLs, after which they are added to the message, again
29432 with duplicates suppressed. Thus, it is possible to add two identical header
29433 lines to an SMTP message, but only if one is added before DATA and one after.
29434 In the case of non-SMTP messages, new headers are accumulated during the
29435 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29436 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29437 are included in the entry that is written to the reject log.
29438
29439 .cindex "header lines" "added; visibility of"
29440 Header lines are not visible in string expansions
29441 of message headers
29442 until they are added to the
29443 message. It follows that header lines defined in the MAIL, RCPT, and predata
29444 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29445 header lines that are added by the DATA or MIME ACLs are not visible in those
29446 ACLs. Because of this restriction, you cannot use header lines as a way of
29447 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29448 this, you can use ACL variables, as described in section
29449 &<<SECTaclvariables>>&.
29450
29451 The list of headers yet to be added is given by the &%$headers_added%& variable.
29452
29453 The &%add_header%& modifier acts immediately as it is encountered during the
29454 processing of an ACL. Notice the difference between these two cases:
29455 .display
29456 &`accept add_header = ADDED: some text`&
29457 &`       `&<&'some condition'&>
29458
29459 &`accept `&<&'some condition'&>
29460 &`       add_header = ADDED: some text`&
29461 .endd
29462 In the first case, the header line is always added, whether or not the
29463 condition is true. In the second case, the header line is added only if the
29464 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29465 ACL statement. All those that are encountered before a condition fails are
29466 honoured.
29467
29468 .cindex "&%warn%& ACL verb"
29469 For compatibility with previous versions of Exim, a &%message%& modifier for a
29470 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29471 effect only if all the conditions are true, even if it appears before some of
29472 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29473 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29474 are present on a &%warn%& verb, both are processed according to their
29475 specifications.
29476
29477 By default, new header lines are added to a message at the end of the existing
29478 header lines. However, you can specify that any particular header line should
29479 be added right at the start (before all the &'Received:'& lines), immediately
29480 after the first block of &'Received:'& lines, or immediately before any line
29481 that is not a &'Received:'& or &'Resent-something:'& header.
29482
29483 This is done by specifying &":at_start:"&, &":after_received:"&, or
29484 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29485 header line, respectively. (Header text cannot start with a colon, as there has
29486 to be a header name first.) For example:
29487 .code
29488 warn add_header = \
29489        :after_received:X-My-Header: something or other...
29490 .endd
29491 If more than one header line is supplied in a single &%add_header%& modifier,
29492 each one is treated independently and can therefore be placed differently. If
29493 you add more than one line at the start, or after the Received: block, they end
29494 up in reverse order.
29495
29496 &*Warning*&: This facility currently applies only to header lines that are
29497 added in an ACL. It does NOT work for header lines that are added in a
29498 system filter or in a router or transport.
29499
29500
29501
29502 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29503 .cindex "header lines" "removing in an ACL"
29504 .cindex "header lines" "position of removed lines"
29505 .cindex "&%remove_header%& ACL modifier"
29506 The &%remove_header%& modifier can be used to remove one or more header lines
29507 from an incoming message, as in this example:
29508 .code
29509 warn   message        = Remove internal headers
29510        remove_header  = x-route-mail1 : x-route-mail2
29511 .endd
29512 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29513 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29514 receiving a message). The message must ultimately be accepted for
29515 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29516 with any ACL verb, including &%deny%&, though this is really not useful for
29517 any verb that doesn't result in a delivered message.
29518
29519 Headers will not be removed from the message if the modifier is used in
29520 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29521
29522 More than one header can be removed at the same time by using a colon separated
29523 list of header names. The header matching is case insensitive. Wildcards are
29524 not permitted, nor is list expansion performed, so you cannot use hostlists to
29525 create a list of headers, however both connection and message variable expansion
29526 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29527 .code
29528 warn   hosts           = +internal_hosts
29529        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29530 warn   message         = Remove internal headers
29531        remove_header   = $acl_c_ihdrs
29532 .endd
29533 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29534 They are removed from the message before processing the DATA and MIME ACLs.
29535 There is no harm in attempting to remove the same header twice nor is removing
29536 a non-existent header. Further header lines to be removed may be accumulated
29537 during the DATA and MIME ACLs, after which they are removed from the message,
29538 if present. In the case of non-SMTP messages, headers to be removed are
29539 accumulated during the non-SMTP ACLs, and are removed from the message after
29540 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29541 ACL, there really is no effect because there is no logging of what headers
29542 would have been removed.
29543
29544 .cindex "header lines" "removed; visibility of"
29545 Header lines are not visible in string expansions until the DATA phase when it
29546 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29547 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29548 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29549 this restriction, you cannot use header lines as a way of controlling data
29550 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29551 you should instead use ACL variables, as described in section
29552 &<<SECTaclvariables>>&.
29553
29554 The &%remove_header%& modifier acts immediately as it is encountered during the
29555 processing of an ACL. Notice the difference between these two cases:
29556 .display
29557 &`accept remove_header = X-Internal`&
29558 &`       `&<&'some condition'&>
29559
29560 &`accept `&<&'some condition'&>
29561 &`       remove_header = X-Internal`&
29562 .endd
29563 In the first case, the header line is always removed, whether or not the
29564 condition is true. In the second case, the header line is removed only if the
29565 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29566 same ACL statement. All those that are encountered before a condition fails
29567 are honoured.
29568
29569 &*Warning*&: This facility currently applies only to header lines that are
29570 present during ACL processing. It does NOT remove header lines that are added
29571 in a system filter or in a router or transport.
29572
29573
29574
29575
29576 .section "ACL conditions" "SECTaclconditions"
29577 .cindex "&ACL;" "conditions; list of"
29578 Some of the conditions listed in this section are available only when Exim is
29579 compiled with the content-scanning extension. They are included here briefly
29580 for completeness. More detailed descriptions can be found in the discussion on
29581 content scanning in chapter &<<CHAPexiscan>>&.
29582
29583 Not all conditions are relevant in all circumstances. For example, testing
29584 senders and recipients does not make sense in an ACL that is being run as the
29585 result of the arrival of an ETRN command, and checks on message headers can be
29586 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29587 can use the same condition (with different parameters) more than once in the
29588 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29589 The conditions are as follows:
29590
29591
29592 .vlist
29593 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29594 .cindex "&ACL;" "nested"
29595 .cindex "&ACL;" "indirect"
29596 .cindex "&ACL;" "arguments"
29597 .cindex "&%acl%& ACL condition"
29598 The possible values of the argument are the same as for the
29599 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29600 &"accept"& the condition is true; if it returns &"deny"& the condition is
29601 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29602 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29603 condition false. This means that further processing of the &%warn%& verb
29604 ceases, but processing of the ACL continues.
29605
29606 If the argument is a named ACL, up to nine space-separated optional values
29607 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29608 and $acl_narg is set to the count of values.
29609 Previous values of these variables are restored after the call returns.
29610 The name and values are expanded separately.
29611 Note that spaces in complex expansions which are used as arguments
29612 will act as argument separators.
29613
29614 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29615 the connection is dropped. If it returns &"discard"&, the verb must be
29616 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29617 conditions are tested.
29618
29619 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29620 loops. This condition allows you to use different ACLs in different
29621 circumstances. For example, different ACLs can be used to handle RCPT commands
29622 for different local users or different local domains.
29623
29624 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29625 .cindex "&%authenticated%& ACL condition"
29626 .cindex "authentication" "ACL checking"
29627 .cindex "&ACL;" "testing for authentication"
29628 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29629 the name of the authenticator is tested against the list. To test for
29630 authentication by any authenticator, you can set
29631 .code
29632 authenticated = *
29633 .endd
29634
29635 .vitem &*condition&~=&~*&<&'string'&>
29636 .cindex "&%condition%& ACL condition"
29637 .cindex "customizing" "ACL condition"
29638 .cindex "&ACL;" "customized test"
29639 .cindex "&ACL;" "testing, customized"
29640 This feature allows you to make up custom conditions. If the result of
29641 expanding the string is an empty string, the number zero, or one of the strings
29642 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29643 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29644 any other value, some error is assumed to have occurred, and the ACL returns
29645 &"defer"&. However, if the expansion is forced to fail, the condition is
29646 ignored. The effect is to treat it as true, whether it is positive or
29647 negative.
29648
29649 .vitem &*decode&~=&~*&<&'location'&>
29650 .cindex "&%decode%& ACL condition"
29651 This condition is available only when Exim is compiled with the
29652 content-scanning extension, and it is allowed only in the ACL defined by
29653 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29654 If all goes well, the condition is true. It is false only if there are
29655 problems such as a syntax error or a memory shortage. For more details, see
29656 chapter &<<CHAPexiscan>>&.
29657
29658 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29659 .cindex "&%dnslists%& ACL condition"
29660 .cindex "DNS list" "in ACL"
29661 .cindex "black list (DNS)"
29662 .cindex "&ACL;" "testing a DNS list"
29663 This condition checks for entries in DNS black lists. These are also known as
29664 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29665 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29666 different variants of this condition to describe briefly here. See sections
29667 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29668
29669 .vitem &*domains&~=&~*&<&'domain&~list'&>
29670 .cindex "&%domains%& ACL condition"
29671 .cindex "domain" "ACL checking"
29672 .cindex "&ACL;" "testing a recipient domain"
29673 .vindex "&$domain_data$&"
29674 This condition is relevant only after a RCPT command. It checks that the domain
29675 of the recipient address is in the domain list. If percent-hack processing is
29676 enabled, it is done before this test is done. If the check succeeds with a
29677 lookup, the result of the lookup is placed in &$domain_data$& until the next
29678 &%domains%& test.
29679
29680 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29681 use &%domains%& in a DATA ACL.
29682
29683
29684 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29685 .cindex "&%encrypted%& ACL condition"
29686 .cindex "encryption" "checking in an ACL"
29687 .cindex "&ACL;" "testing for encryption"
29688 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29689 name of the cipher suite in use is tested against the list. To test for
29690 encryption without testing for any specific cipher suite(s), set
29691 .code
29692 encrypted = *
29693 .endd
29694
29695
29696 .vitem &*hosts&~=&~*&<&'host&~list'&>
29697 .cindex "&%hosts%& ACL condition"
29698 .cindex "host" "ACL checking"
29699 .cindex "&ACL;" "testing the client host"
29700 This condition tests that the calling host matches the host list. If you have
29701 name lookups or wildcarded host names and IP addresses in the same host list,
29702 you should normally put the IP addresses first. For example, you could have:
29703 .code
29704 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29705 .endd
29706 The lookup in this example uses the host name for its key. This is implied by
29707 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29708 and it wouldn't matter which way round you had these two items.)
29709
29710 The reason for the problem with host names lies in the left-to-right way that
29711 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29712 but when it reaches an item that requires a host name, it fails if it cannot
29713 find a host name to compare with the pattern. If the above list is given in the
29714 opposite order, the &%accept%& statement fails for a host whose name cannot be
29715 found, even if its IP address is 10.9.8.7.
29716
29717 If you really do want to do the name check first, and still recognize the IP
29718 address even if the name lookup fails, you can rewrite the ACL like this:
29719 .code
29720 accept hosts = dbm;/etc/friendly/hosts
29721 accept hosts = 10.9.8.7
29722 .endd
29723 The default action on failing to find the host name is to assume that the host
29724 is not in the list, so the first &%accept%& statement fails. The second
29725 statement can then check the IP address.
29726
29727 .vindex "&$host_data$&"
29728 If a &%hosts%& condition is satisfied by means of a lookup, the result
29729 of the lookup is made available in the &$host_data$& variable. This
29730 allows you, for example, to set up a statement like this:
29731 .code
29732 deny  hosts = net-lsearch;/some/file
29733 message = $host_data
29734 .endd
29735 which gives a custom error message for each denied host.
29736
29737 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29738 .cindex "&%local_parts%& ACL condition"
29739 .cindex "local part" "ACL checking"
29740 .cindex "&ACL;" "testing a local part"
29741 .vindex "&$local_part_data$&"
29742 This condition is relevant only after a RCPT command. It checks that the local
29743 part of the recipient address is in the list. If percent-hack processing is
29744 enabled, it is done before this test. If the check succeeds with a lookup, the
29745 result of the lookup is placed in &$local_part_data$&, which remains set until
29746 the next &%local_parts%& test.
29747
29748 .vitem &*malware&~=&~*&<&'option'&>
29749 .cindex "&%malware%& ACL condition"
29750 .cindex "&ACL;" "virus scanning"
29751 .cindex "&ACL;" "scanning for viruses"
29752 This condition is available only when Exim is compiled with the
29753 content-scanning extension. It causes the incoming message to be scanned for
29754 viruses. For details, see chapter &<<CHAPexiscan>>&.
29755
29756 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29757 .cindex "&%mime_regex%& ACL condition"
29758 .cindex "&ACL;" "testing by regex matching"
29759 This condition is available only when Exim is compiled with the
29760 content-scanning extension, and it is allowed only in the ACL defined by
29761 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29762 with any of the regular expressions. For details, see chapter
29763 &<<CHAPexiscan>>&.
29764
29765 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29766 .cindex "rate limiting"
29767 This condition can be used to limit the rate at which a user or host submits
29768 messages. Details are given in section &<<SECTratelimiting>>&.
29769
29770 .vitem &*recipients&~=&~*&<&'address&~list'&>
29771 .cindex "&%recipients%& ACL condition"
29772 .cindex "recipient" "ACL checking"
29773 .cindex "&ACL;" "testing a recipient"
29774 This condition is relevant only after a RCPT command. It checks the entire
29775 recipient address against a list of recipients.
29776
29777 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29778 .cindex "&%regex%& ACL condition"
29779 .cindex "&ACL;" "testing by regex matching"
29780 This condition is available only when Exim is compiled with the
29781 content-scanning extension, and is available only in the DATA, MIME, and
29782 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29783 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29784
29785 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29786 .cindex "&%sender_domains%& ACL condition"
29787 .cindex "sender" "ACL checking"
29788 .cindex "&ACL;" "testing a sender domain"
29789 .vindex "&$domain$&"
29790 .vindex "&$sender_address_domain$&"
29791 This condition tests the domain of the sender of the message against the given
29792 domain list. &*Note*&: The domain of the sender address is in
29793 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29794 of this condition. This is an exception to the general rule for testing domain
29795 lists. It is done this way so that, if this condition is used in an ACL for a
29796 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29797 influence the sender checking.
29798
29799 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29800 relaying, because sender addresses are easily, and commonly, forged.
29801
29802 .vitem &*senders&~=&~*&<&'address&~list'&>
29803 .cindex "&%senders%& ACL condition"
29804 .cindex "sender" "ACL checking"
29805 .cindex "&ACL;" "testing a sender"
29806 This condition tests the sender of the message against the given list. To test
29807 for a bounce message, which has an empty sender, set
29808 .code
29809 senders = :
29810 .endd
29811 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29812 relaying, because sender addresses are easily, and commonly, forged.
29813
29814 .vitem &*spam&~=&~*&<&'username'&>
29815 .cindex "&%spam%& ACL condition"
29816 .cindex "&ACL;" "scanning for spam"
29817 This condition is available only when Exim is compiled with the
29818 content-scanning extension. It causes the incoming message to be scanned by
29819 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29820
29821 .vitem &*verify&~=&~certificate*&
29822 .cindex "&%verify%& ACL condition"
29823 .cindex "TLS" "client certificate verification"
29824 .cindex "certificate" "verification of client"
29825 .cindex "&ACL;" "certificate verification"
29826 .cindex "&ACL;" "testing a TLS certificate"
29827 This condition is true in an SMTP session if the session is encrypted, and a
29828 certificate was received from the client, and the certificate was verified. The
29829 server requests a certificate only if the client matches &%tls_verify_hosts%&
29830 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29831
29832 .vitem &*verify&~=&~csa*&
29833 .cindex "CSA verification"
29834 This condition checks whether the sending host (the client) is authorized to
29835 send email. Details of how this works are given in section
29836 &<<SECTverifyCSA>>&.
29837
29838 .vitem &*verify&~=&~header_names_ascii*&
29839 .cindex "&%verify%& ACL condition"
29840 .cindex "&ACL;" "verifying header names only ASCII"
29841 .cindex "header lines" "verifying header names only ASCII"
29842 .cindex "verifying" "header names only ASCII"
29843 This condition is relevant only in an ACL that is run after a message has been
29844 received, that is, in an ACL specified by &%acl_smtp_data%& or
29845 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29846 there are no non-ASCII characters, also excluding control characters.  The
29847 allowable characters are decimal ASCII values 33 through 126.
29848
29849 Exim itself will handle headers with non-ASCII characters, but it can cause
29850 problems for downstream applications, so this option will allow their
29851 detection and rejection in the DATA ACL's.
29852
29853 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29854 .cindex "&%verify%& ACL condition"
29855 .cindex "&ACL;" "verifying sender in the header"
29856 .cindex "header lines" "verifying the sender in"
29857 .cindex "sender" "verifying in header"
29858 .cindex "verifying" "sender in header"
29859 This condition is relevant only in an ACL that is run after a message has been
29860 received, that is, in an ACL specified by &%acl_smtp_data%& or
29861 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29862 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29863 is loosely thought of as a &"sender"& address (hence the name of the test).
29864 However, an address that appears in one of these headers need not be an address
29865 that accepts bounce messages; only sender addresses in envelopes are required
29866 to accept bounces. Therefore, if you use the callout option on this check, you
29867 might want to arrange for a non-empty address in the MAIL command.
29868
29869 Details of address verification and the options are given later, starting at
29870 section &<<SECTaddressverification>>& (callouts are described in section
29871 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29872 condition to restrict it to bounce messages only:
29873 .code
29874 deny    senders = :
29875         message = A valid sender header is required for bounces
29876        !verify  = header_sender
29877 .endd
29878
29879 .vitem &*verify&~=&~header_syntax*&
29880 .cindex "&%verify%& ACL condition"
29881 .cindex "&ACL;" "verifying header syntax"
29882 .cindex "header lines" "verifying syntax"
29883 .cindex "verifying" "header syntax"
29884 This condition is relevant only in an ACL that is run after a message has been
29885 received, that is, in an ACL specified by &%acl_smtp_data%& or
29886 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29887 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29888 and &'Bcc:'&), returning true if there are no problems.
29889 Unqualified addresses (local parts without domains) are
29890 permitted only in locally generated messages and from hosts that match
29891 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29892 appropriate.
29893
29894 Note that this condition is a syntax check only. However, a common spamming
29895 ploy used to be to send syntactically invalid headers such as
29896 .code
29897 To: @
29898 .endd
29899 and this condition can be used to reject such messages, though they are not as
29900 common as they used to be.
29901
29902 .vitem &*verify&~=&~helo*&
29903 .cindex "&%verify%& ACL condition"
29904 .cindex "&ACL;" "verifying HELO/EHLO"
29905 .cindex "HELO" "verifying"
29906 .cindex "EHLO" "verifying"
29907 .cindex "verifying" "EHLO"
29908 .cindex "verifying" "HELO"
29909 This condition is true if a HELO or EHLO command has been received from the
29910 client host, and its contents have been verified. If there has been no previous
29911 attempt to verify the HELO/EHLO contents, it is carried out when this
29912 condition is encountered. See the description of the &%helo_verify_hosts%& and
29913 &%helo_try_verify_hosts%& options for details of how to request verification
29914 independently of this condition.
29915
29916 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29917 option), this condition is always true.
29918
29919
29920 .vitem &*verify&~=&~not_blind*&
29921 .cindex "verifying" "not blind"
29922 .cindex "bcc recipients, verifying none"
29923 This condition checks that there are no blind (bcc) recipients in the message.
29924 Every envelope recipient must appear either in a &'To:'& header line or in a
29925 &'Cc:'& header line for this condition to be true. Local parts are checked
29926 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29927 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29928 used only in a DATA or non-SMTP ACL.
29929
29930 There are, of course, many legitimate messages that make use of blind (bcc)
29931 recipients. This check should not be used on its own for blocking messages.
29932
29933
29934 .vitem &*verify&~=&~recipient/*&<&'options'&>
29935 .cindex "&%verify%& ACL condition"
29936 .cindex "&ACL;" "verifying recipient"
29937 .cindex "recipient" "verifying"
29938 .cindex "verifying" "recipient"
29939 .vindex "&$address_data$&"
29940 This condition is relevant only after a RCPT command. It verifies the current
29941 recipient. Details of address verification are given later, starting at section
29942 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29943 of &$address_data$& is the last value that was set while routing the address.
29944 This applies even if the verification fails. When an address that is being
29945 verified is redirected to a single address, verification continues with the new
29946 address, and in that case, the subsequent value of &$address_data$& is the
29947 value for the child address.
29948
29949 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29950 .cindex "&%verify%& ACL condition"
29951 .cindex "&ACL;" "verifying host reverse lookup"
29952 .cindex "host" "verifying reverse lookup"
29953 This condition ensures that a verified host name has been looked up from the IP
29954 address of the client host. (This may have happened already if the host name
29955 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29956 Verification ensures that the host name obtained from a reverse DNS lookup, or
29957 one of its aliases, does, when it is itself looked up in the DNS, yield the
29958 original IP address.
29959
29960 There is one possible option, &`defer_ok`&.  If this is present and a
29961 DNS operation returns a temporary error, the verify condition succeeds.
29962
29963 If this condition is used for a locally generated message (that is, when there
29964 is no client host involved), it always succeeds.
29965
29966 .vitem &*verify&~=&~sender/*&<&'options'&>
29967 .cindex "&%verify%& ACL condition"
29968 .cindex "&ACL;" "verifying sender"
29969 .cindex "sender" "verifying"
29970 .cindex "verifying" "sender"
29971 This condition is relevant only after a MAIL or RCPT command, or after a
29972 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29973 the message's sender is empty (that is, this is a bounce message), the
29974 condition is true. Otherwise, the sender address is verified.
29975
29976 .vindex "&$address_data$&"
29977 .vindex "&$sender_address_data$&"
29978 If there is data in the &$address_data$& variable at the end of routing, its
29979 value is placed in &$sender_address_data$& at the end of verification. This
29980 value can be used in subsequent conditions and modifiers in the same ACL
29981 statement. It does not persist after the end of the current statement. If you
29982 want to preserve the value for longer, you can save it in an ACL variable.
29983
29984 Details of verification are given later, starting at section
29985 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29986 to avoid doing it more than once per message.
29987
29988 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29989 .cindex "&%verify%& ACL condition"
29990 This is a variation of the previous option, in which a modified address is
29991 verified as a sender.
29992
29993 Note that '/' is legal in local-parts; if the address may have such
29994 (eg. is generated from the received message)
29995 they must be protected from the options parsing by doubling:
29996 .code
29997 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
29998 .endd
29999 .endlist
30000
30001
30002
30003 .section "Using DNS lists" "SECTmorednslists"
30004 .cindex "DNS list" "in ACL"
30005 .cindex "black list (DNS)"
30006 .cindex "&ACL;" "testing a DNS list"
30007 In its simplest form, the &%dnslists%& condition tests whether the calling host
30008 is on at least one of a number of DNS lists by looking up the inverted IP
30009 address in one or more DNS domains. (Note that DNS list domains are not mail
30010 domains, so the &`+`& syntax for named lists doesn't work - it is used for
30011 special options instead.) For example, if the calling host's IP
30012 address is 192.168.62.43, and the ACL statement is
30013 .code
30014 deny dnslists = blackholes.mail-abuse.org : \
30015                 dialups.mail-abuse.org
30016 .endd
30017 the following records are looked up:
30018 .code
30019 43.62.168.192.blackholes.mail-abuse.org
30020 43.62.168.192.dialups.mail-abuse.org
30021 .endd
30022 As soon as Exim finds an existing DNS record, processing of the list stops.
30023 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
30024 to test that a host is on more than one list (an &"and"& conjunction), you can
30025 use two separate conditions:
30026 .code
30027 deny dnslists = blackholes.mail-abuse.org
30028      dnslists = dialups.mail-abuse.org
30029 .endd
30030 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
30031 behaves as if the host does not match the list item, that is, as if the DNS
30032 record does not exist. If there are further items in the DNS list, they are
30033 processed.
30034
30035 This is usually the required action when &%dnslists%& is used with &%deny%&
30036 (which is the most common usage), because it prevents a DNS failure from
30037 blocking mail. However, you can change this behaviour by putting one of the
30038 following special items in the list:
30039 .display
30040 &`+include_unknown `&   behave as if the item is on the list
30041 &`+exclude_unknown `&   behave as if the item is not on the list (default)
30042 &`+defer_unknown   `&   give a temporary error
30043 .endd
30044 .cindex "&`+include_unknown`&"
30045 .cindex "&`+exclude_unknown`&"
30046 .cindex "&`+defer_unknown`&"
30047 Each of these applies to any subsequent items on the list. For example:
30048 .code
30049 deny dnslists = +defer_unknown : foo.bar.example
30050 .endd
30051 Testing the list of domains stops as soon as a match is found. If you want to
30052 warn for one list and block for another, you can use two different statements:
30053 .code
30054 deny  dnslists = blackholes.mail-abuse.org
30055 warn  message  = X-Warn: sending host is on dialups list
30056       dnslists = dialups.mail-abuse.org
30057 .endd
30058 .cindex caching "of dns lookup"
30059 .cindex DNS TTL
30060 DNS list lookups are cached by Exim for the duration of the SMTP session
30061 (but limited by the DNS return TTL value),
30062 so a lookup based on the IP address is done at most once for any incoming
30063 connection (assuming long-enough TTL).
30064 Exim does not share information between multiple incoming
30065 connections (but your local name server cache should be active).
30066
30067
30068
30069 .section "Specifying the IP address for a DNS list lookup" "SECID201"
30070 .cindex "DNS list" "keyed by explicit IP address"
30071 By default, the IP address that is used in a DNS list lookup is the IP address
30072 of the calling host. However, you can specify another IP address by listing it
30073 after the domain name, introduced by a slash. For example:
30074 .code
30075 deny dnslists = black.list.tld/192.168.1.2
30076 .endd
30077 This feature is not very helpful with explicit IP addresses; it is intended for
30078 use with IP addresses that are looked up, for example, the IP addresses of the
30079 MX hosts or nameservers of an email sender address. For an example, see section
30080 &<<SECTmulkeyfor>>& below.
30081
30082
30083
30084
30085 .section "DNS lists keyed on domain names" "SECID202"
30086 .cindex "DNS list" "keyed by domain name"
30087 There are some lists that are keyed on domain names rather than inverted IP
30088 addresses (see for example the &'domain based zones'& link at
30089 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
30090 with these lists. You can change the name that is looked up in a DNS list by
30091 listing it after the domain name, introduced by a slash. For example,
30092 .code
30093 deny  message  = Sender's domain is listed at $dnslist_domain
30094       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
30095 .endd
30096 This particular example is useful only in ACLs that are obeyed after the
30097 RCPT or DATA commands, when a sender address is available. If (for
30098 example) the message's sender is &'user@tld.example'& the name that is looked
30099 up by this example is
30100 .code
30101 tld.example.dsn.rfc-ignorant.org
30102 .endd
30103 A single &%dnslists%& condition can contain entries for both names and IP
30104 addresses. For example:
30105 .code
30106 deny dnslists = sbl.spamhaus.org : \
30107                 dsn.rfc-ignorant.org/$sender_address_domain
30108 .endd
30109 The first item checks the sending host's IP address; the second checks a domain
30110 name. The whole condition is true if either of the DNS lookups succeeds.
30111
30112
30113
30114
30115 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
30116 .cindex "DNS list" "multiple keys for"
30117 The syntax described above for looking up explicitly-defined values (either
30118 names or IP addresses) in a DNS blacklist is a simplification. After the domain
30119 name for the DNS list, what follows the slash can in fact be a list of items.
30120 As with all lists in Exim, the default separator is a colon. However, because
30121 this is a sublist within the list of DNS blacklist domains, it is necessary
30122 either to double the separators like this:
30123 .code
30124 dnslists = black.list.tld/name.1::name.2
30125 .endd
30126 or to change the separator character, like this:
30127 .code
30128 dnslists = black.list.tld/<;name.1;name.2
30129 .endd
30130 If an item in the list is an IP address, it is inverted before the DNS
30131 blacklist domain is appended. If it is not an IP address, no inversion
30132 occurs. Consider this condition:
30133 .code
30134 dnslists = black.list.tld/<;192.168.1.2;a.domain
30135 .endd
30136 The DNS lookups that occur are:
30137 .code
30138 2.1.168.192.black.list.tld
30139 a.domain.black.list.tld
30140 .endd
30141 Once a DNS record has been found (that matches a specific IP return
30142 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
30143 are done. If there is a temporary DNS error, the rest of the sublist of domains
30144 or IP addresses is tried. A temporary error for the whole dnslists item occurs
30145 only if no other DNS lookup in this sublist succeeds. In other words, a
30146 successful lookup for any of the items in the sublist overrides a temporary
30147 error for a previous item.
30148
30149 The ability to supply a list of items after the slash is in some sense just a
30150 syntactic convenience. These two examples have the same effect:
30151 .code
30152 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
30153 dnslists = black.list.tld/a.domain::b.domain
30154 .endd
30155 However, when the data for the list is obtained from a lookup, the second form
30156 is usually much more convenient. Consider this example:
30157 .code
30158 deny message  = The mail servers for the domain \
30159                 $sender_address_domain \
30160                 are listed at $dnslist_domain ($dnslist_value); \
30161                 see $dnslist_text.
30162      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
30163                                    ${lookup dnsdb {>|mxh=\
30164                                    $sender_address_domain} }} }
30165 .endd
30166 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
30167 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
30168 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
30169 of expanding the condition might be something like this:
30170 .code
30171 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
30172 .endd
30173 Thus, this example checks whether or not the IP addresses of the sender
30174 domain's mail servers are on the Spamhaus black list.
30175
30176 The key that was used for a successful DNS list lookup is put into the variable
30177 &$dnslist_matched$& (see section &<<SECID204>>&).
30178
30179
30180
30181
30182 .section "Data returned by DNS lists" "SECID203"
30183 .cindex "DNS list" "data returned from"
30184 DNS lists are constructed using address records in the DNS. The original RBL
30185 just used the address 127.0.0.1 on the right hand side of each record, but the
30186 RBL+ list and some other lists use a number of values with different meanings.
30187 The values used on the RBL+ list are:
30188 .display
30189 127.1.0.1  RBL
30190 127.1.0.2  DUL
30191 127.1.0.3  DUL and RBL
30192 127.1.0.4  RSS
30193 127.1.0.5  RSS and RBL
30194 127.1.0.6  RSS and DUL
30195 127.1.0.7  RSS and DUL and RBL
30196 .endd
30197 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
30198 different values. Some DNS lists may return more than one address record;
30199 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
30200
30201
30202 .section "Variables set from DNS lists" "SECID204"
30203 .cindex "expansion" "variables, set from DNS list"
30204 .cindex "DNS list" "variables set from"
30205 .vindex "&$dnslist_domain$&"
30206 .vindex "&$dnslist_matched$&"
30207 .vindex "&$dnslist_text$&"
30208 .vindex "&$dnslist_value$&"
30209 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
30210 the name of the overall domain that matched (for example,
30211 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
30212 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
30213 the DNS record. When the key is an IP address, it is not reversed in
30214 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
30215 cases, for example:
30216 .code
30217 deny dnslists = spamhaus.example
30218 .endd
30219 the key is also available in another variable (in this case,
30220 &$sender_host_address$&). In more complicated cases, however, this is not true.
30221 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
30222 might generate a dnslists lookup like this:
30223 .code
30224 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
30225 .endd
30226 If this condition succeeds, the value in &$dnslist_matched$& might be
30227 &`192.168.6.7`& (for example).
30228
30229 If more than one address record is returned by the DNS lookup, all the IP
30230 addresses are included in &$dnslist_value$&, separated by commas and spaces.
30231 The variable &$dnslist_text$& contains the contents of any associated TXT
30232 record. For lists such as RBL+ the TXT record for a merged entry is often not
30233 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
30234 information.
30235
30236 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
30237 &-- although these appear before the condition in the ACL, they are not
30238 expanded until after it has failed. For example:
30239 .code
30240 deny    hosts = !+local_networks
30241         message = $sender_host_address is listed \
30242                   at $dnslist_domain
30243         dnslists = rbl-plus.mail-abuse.example
30244 .endd
30245
30246
30247
30248 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
30249 .cindex "DNS list" "matching specific returned data"
30250 You can add an equals sign and an IP address after a &%dnslists%& domain name
30251 in order to restrict its action to DNS records with a matching right hand side.
30252 For example,
30253 .code
30254 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
30255 .endd
30256 rejects only those hosts that yield 127.0.0.2. Without this additional data,
30257 any address record is considered to be a match. For the moment, we assume
30258 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
30259 describes how multiple records are handled.
30260
30261 More than one IP address may be given for checking, using a comma as a
30262 separator. These are alternatives &-- if any one of them matches, the
30263 &%dnslists%& condition is true. For example:
30264 .code
30265 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30266 .endd
30267 If you want to specify a constraining address list and also specify names or IP
30268 addresses to be looked up, the constraining address list must be specified
30269 first. For example:
30270 .code
30271 deny dnslists = dsn.rfc-ignorant.org\
30272                 =127.0.0.2/$sender_address_domain
30273 .endd
30274
30275 If the character &`&&`& is used instead of &`=`&, the comparison for each
30276 listed IP address is done by a bitwise &"and"& instead of by an equality test.
30277 In other words, the listed addresses are used as bit masks. The comparison is
30278 true if all the bits in the mask are present in the address that is being
30279 tested. For example:
30280 .code
30281 dnslists = a.b.c&0.0.0.3
30282 .endd
30283 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
30284 want to test whether one bit or another bit is present (as opposed to both
30285 being present), you must use multiple values. For example:
30286 .code
30287 dnslists = a.b.c&0.0.0.1,0.0.0.2
30288 .endd
30289 matches if the final component of the address is an odd number or two times
30290 an odd number.
30291
30292
30293
30294 .section "Negated DNS matching conditions" "SECID205"
30295 You can supply a negative list of IP addresses as part of a &%dnslists%&
30296 condition. Whereas
30297 .code
30298 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30299 .endd
30300 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30301 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
30302 .code
30303 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
30304 .endd
30305 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30306 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
30307 words, the result of the test is inverted if an exclamation mark appears before
30308 the &`=`& (or the &`&&`&) sign.
30309
30310 &*Note*&: This kind of negation is not the same as negation in a domain,
30311 host, or address list (which is why the syntax is different).
30312
30313 If you are using just one list, the negation syntax does not gain you much. The
30314 previous example is precisely equivalent to
30315 .code
30316 deny  dnslists = a.b.c
30317      !dnslists = a.b.c=127.0.0.2,127.0.0.3
30318 .endd
30319 However, if you are using multiple lists, the negation syntax is clearer.
30320 Consider this example:
30321 .code
30322 deny  dnslists = sbl.spamhaus.org : \
30323                  list.dsbl.org : \
30324                  dnsbl.njabl.org!=127.0.0.3 : \
30325                  relays.ordb.org
30326 .endd
30327 Using only positive lists, this would have to be:
30328 .code
30329 deny  dnslists = sbl.spamhaus.org : \
30330                  list.dsbl.org
30331 deny  dnslists = dnsbl.njabl.org
30332      !dnslists = dnsbl.njabl.org=127.0.0.3
30333 deny  dnslists = relays.ordb.org
30334 .endd
30335 which is less clear, and harder to maintain.
30336
30337
30338
30339
30340 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
30341 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
30342 thereby providing more than one IP address. When an item in a &%dnslists%& list
30343 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
30344 the match to specific results from the DNS lookup, there are two ways in which
30345 the checking can be handled. For example, consider the condition:
30346 .code
30347 dnslists = a.b.c=127.0.0.1
30348 .endd
30349 What happens if the DNS lookup for the incoming IP address yields both
30350 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
30351 condition true because at least one given value was found, or is it false
30352 because at least one of the found values was not listed? And how does this
30353 affect negated conditions? Both possibilities are provided for with the help of
30354 additional separators &`==`& and &`=&&`&.
30355
30356 .ilist
30357 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30358 IP addresses matches one of the listed addresses. For the example above, the
30359 condition is true because 127.0.0.1 matches.
30360 .next
30361 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30362 looked up IP addresses matches one of the listed addresses. If the condition is
30363 changed to:
30364 .code
30365 dnslists = a.b.c==127.0.0.1
30366 .endd
30367 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30368 false because 127.0.0.2 is not listed. You would need to have:
30369 .code
30370 dnslists = a.b.c==127.0.0.1,127.0.0.2
30371 .endd
30372 for the condition to be true.
30373 .endlist
30374
30375 When &`!`& is used to negate IP address matching, it inverts the result, giving
30376 the precise opposite of the behaviour above. Thus:
30377 .ilist
30378 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30379 addresses matches one of the listed addresses. Consider:
30380 .code
30381 dnslists = a.b.c!&0.0.0.1
30382 .endd
30383 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30384 false because 127.0.0.1 matches.
30385 .next
30386 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30387 looked up IP address that does not match. Consider:
30388 .code
30389 dnslists = a.b.c!=&0.0.0.1
30390 .endd
30391 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30392 true, because 127.0.0.2 does not match. You would need to have:
30393 .code
30394 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30395 .endd
30396 for the condition to be false.
30397 .endlist
30398 When the DNS lookup yields only a single IP address, there is no difference
30399 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30400
30401
30402
30403
30404 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30405 .cindex "DNS list" "information from merged"
30406 When the facility for restricting the matching IP values in a DNS list is used,
30407 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30408 the true reason for rejection. This happens when lists are merged and the IP
30409 address in the A record is used to distinguish them; unfortunately there is
30410 only one TXT record. One way round this is not to use merged lists, but that
30411 can be inefficient because it requires multiple DNS lookups where one would do
30412 in the vast majority of cases when the host of interest is not on any of the
30413 lists.
30414
30415 A less inefficient way of solving this problem is available. If
30416 two domain names, comma-separated, are given, the second is used first to
30417 do an initial check, making use of any IP value restrictions that are set.
30418 If there is a match, the first domain is used, without any IP value
30419 restrictions, to get the TXT record. As a byproduct of this, there is also
30420 a check that the IP being tested is indeed on the first list. The first
30421 domain is the one that is put in &$dnslist_domain$&. For example:
30422 .code
30423 reject message  = \
30424          rejected because $sender_host_address is blacklisted \
30425          at $dnslist_domain\n$dnslist_text
30426        dnslists = \
30427          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30428          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30429 .endd
30430 For the first blacklist item, this starts by doing a lookup in
30431 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30432 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30433 value, and as long as something is found, it looks for the corresponding TXT
30434 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30435 The second blacklist item is processed similarly.
30436
30437 If you are interested in more than one merged list, the same list must be
30438 given several times, but because the results of the DNS lookups are cached,
30439 the DNS calls themselves are not repeated. For example:
30440 .code
30441 reject dnslists = \
30442          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30443          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30444          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30445          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30446 .endd
30447 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30448 values matches (or if no record is found), this is the only lookup that is
30449 done. Only if there is a match is one of the more specific lists consulted.
30450
30451
30452
30453 .section "DNS lists and IPv6" "SECTmorednslistslast"
30454 .cindex "IPv6" "DNS black lists"
30455 .cindex "DNS list" "IPv6 usage"
30456 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30457 nibble by nibble. For example, if the calling host's IP address is
30458 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30459 .code
30460 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30461   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30462 .endd
30463 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30464 lists contain wildcard records, intended for IPv4, that interact badly with
30465 IPv6. For example, the DNS entry
30466 .code
30467 *.3.some.list.example.    A    127.0.0.1
30468 .endd
30469 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30470 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30471
30472 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30473 &%condition%& condition, as in this example:
30474 .code
30475 deny   condition = ${if isip4{$sender_host_address}}
30476        dnslists  = some.list.example
30477 .endd
30478
30479 If an explicit key is being used for a DNS lookup and it may be an IPv6
30480 address you should specify alternate list separators for both the outer
30481 (DNS list name) list and inner (lookup keys) list:
30482 .code
30483        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30484 .endd
30485
30486 .section "Rate limiting incoming messages" "SECTratelimiting"
30487 .cindex "rate limiting" "client sending"
30488 .cindex "limiting client sending rates"
30489 .oindex "&%smtp_ratelimit_*%&"
30490 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30491 which clients can send email. This is more powerful than the
30492 &%smtp_ratelimit_*%& options, because those options control the rate of
30493 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30494 works across all connections (concurrent and sequential) from the same client
30495 host. The syntax of the &%ratelimit%& condition is:
30496 .display
30497 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30498 .endd
30499 If the average client sending rate is less than &'m'& messages per time
30500 period &'p'& then the condition is false; otherwise it is true.
30501
30502 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30503 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30504 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30505 of &'p'&.
30506
30507 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30508 time interval, for example, &`8h`& for eight hours. A larger time constant
30509 means that it takes Exim longer to forget a client's past behaviour. The
30510 parameter &'m'& is the maximum number of messages that a client is permitted to
30511 send in each time interval. It also specifies the number of messages permitted
30512 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30513 constant, you can allow a client to send more messages in a burst without
30514 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30515 both small, messages must be sent at an even rate.
30516
30517 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30518 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30519 when deploying the &%ratelimit%& ACL condition. The script prints usage
30520 instructions when it is run with no arguments.
30521
30522 The key is used to look up the data for calculating the client's average
30523 sending rate. This data is stored in Exim's spool directory, alongside the
30524 retry and other hints databases. The default key is &$sender_host_address$&,
30525 which means Exim computes the sending rate of each client host IP address.
30526 By changing the key you can change how Exim identifies clients for the purpose
30527 of ratelimiting. For example, to limit the sending rate of each authenticated
30528 user, independent of the computer they are sending from, set the key to
30529 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30530 example, &$authenticated_id$& is only meaningful if the client has
30531 authenticated (which you can check with the &%authenticated%& ACL condition).
30532
30533 The lookup key does not have to identify clients: If you want to limit the
30534 rate at which a recipient receives messages, you can use the key
30535 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30536 ACL.
30537
30538 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30539 specifies what Exim measures the rate of, for example messages or recipients
30540 or bytes. You can adjust the measurement using the &%unique=%& and/or
30541 &%count=%& options. You can also control when Exim updates the recorded rate
30542 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30543 separated by a slash, like the other parameters. They may appear in any order.
30544
30545 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30546 any options that alter the meaning of the stored data. The limit &'m'& is not
30547 stored, so you can alter the configured maximum rate and Exim will still
30548 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30549 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30550 behaviour. The lookup key is not affected by changes to the update mode and
30551 the &%count=%& option.
30552
30553
30554 .section "Ratelimit options for what is being measured" "ratoptmea"
30555 .cindex "rate limiting" "per_* options"
30556 The &%per_conn%& option limits the client's connection rate. It is not
30557 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30558 &%acl_not_smtp_start%& ACLs.
30559
30560 The &%per_mail%& option limits the client's rate of sending messages. This is
30561 the default if none of the &%per_*%& options is specified. It can be used in
30562 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30563 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30564
30565 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30566 the same ACLs as the &%per_mail%& option, though it is best to use this option
30567 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30568 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30569 in its MAIL command, which may be inaccurate or completely missing. You can
30570 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30571 in kilobytes, megabytes, or gigabytes, respectively.
30572
30573 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30574 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30575 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30576 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30577 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30578 in either case the rate limiting engine will see a message with many
30579 recipients as a large high-speed burst.
30580
30581 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30582 number of different recipients that the client has sent messages to in the
30583 last time period. That is, if the client repeatedly sends messages to the same
30584 recipient, its measured rate is not increased. This option can only be used in
30585 &%acl_smtp_rcpt%&.
30586
30587 The &%per_cmd%& option causes Exim to recompute the rate every time the
30588 condition is processed. This can be used to limit the rate of any SMTP
30589 command. If it is used in multiple ACLs it can limit the aggregate rate of
30590 multiple different commands.
30591
30592 The &%count=%& option can be used to alter how much Exim adds to the client's
30593 measured rate. For example, the &%per_byte%& option is equivalent to
30594 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30595 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30596 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30597
30598 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30599
30600
30601 .section "Ratelimit update modes" "ratoptupd"
30602 .cindex "rate limiting" "reading data without updating"
30603 You can specify one of three options with the &%ratelimit%& condition to
30604 control when its database is updated. This section describes the &%readonly%&
30605 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30606
30607 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30608 previously-computed rate to check against the limit.
30609
30610 For example, you can test the client's sending rate and deny it access (when
30611 it is too fast) in the connect ACL. If the client passes this check then it
30612 can go on to send a message, in which case its recorded rate will be updated
30613 in the MAIL ACL. Subsequent connections from the same client will check this
30614 new rate.
30615 .code
30616 acl_check_connect:
30617  deny ratelimit = 100 / 5m / readonly
30618     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30619                   (max $sender_rate_limit)
30620 # ...
30621 acl_check_mail:
30622  warn ratelimit = 100 / 5m / strict
30623     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30624                   (max $sender_rate_limit)
30625 .endd
30626
30627 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30628 processing a message then it may increase the client's measured rate more than
30629 it should. For example, this will happen if you check the &%per_rcpt%& option
30630 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30631 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30632 multiple update problems by using the &%readonly%& option on later ratelimit
30633 checks.
30634
30635 The &%per_*%& options described above do not make sense in some ACLs. If you
30636 use a &%per_*%& option in an ACL where it is not normally permitted then the
30637 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30638 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30639 next section) so you must specify the &%readonly%& option explicitly.
30640
30641
30642 .section "Ratelimit options for handling fast clients" "ratoptfast"
30643 .cindex "rate limiting" "strict and leaky modes"
30644 If a client's average rate is greater than the maximum, the rate limiting
30645 engine can react in two possible ways, depending on the presence of the
30646 &%strict%& or &%leaky%& update modes. This is independent of the other
30647 counter-measures (such as rejecting the message) that may be specified by the
30648 rest of the ACL.
30649
30650 The &%leaky%& (default) option means that the client's recorded rate is not
30651 updated if it is above the limit. The effect of this is that Exim measures the
30652 client's average rate of successfully sent email, which cannot be greater than
30653 the maximum allowed. If the client is over the limit it may suffer some
30654 counter-measures (as specified in the ACL), but it will still be able to send
30655 email at the configured maximum rate, whatever the rate of its attempts. This
30656 is generally the better choice if you have clients that retry automatically.
30657 For example, it does not prevent a sender with an over-aggressive retry rate
30658 from getting any email through.
30659
30660 The &%strict%& option means that the client's recorded rate is always
30661 updated. The effect of this is that Exim measures the client's average rate
30662 of attempts to send email, which can be much higher than the maximum it is
30663 actually allowed. If the client is over the limit it may be subjected to
30664 counter-measures by the ACL. It must slow down and allow sufficient time to
30665 pass that its computed rate falls below the maximum before it can send email
30666 again. The time (the number of smoothing periods) it must wait and not
30667 attempt to send mail can be calculated with this formula:
30668 .code
30669         ln(peakrate/maxrate)
30670 .endd
30671
30672
30673 .section "Limiting the rate of different events" "ratoptuniq"
30674 .cindex "rate limiting" "counting unique events"
30675 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30676 rate of different events. For example, the &%per_addr%& option uses this
30677 mechanism to count the number of different recipients that the client has
30678 sent messages to in the last time period; it is equivalent to
30679 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30680 measure the rate that a client uses different sender addresses with the
30681 options &`per_mail/unique=$sender_address`&.
30682
30683 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30684 has seen for that key. The whole set is thrown away when it is older than the
30685 rate smoothing period &'p'&, so each different event is counted at most once
30686 per period. In the &%leaky%& update mode, an event that causes the client to
30687 go over the limit is not added to the set, in the same way that the client's
30688 recorded rate is not updated in the same situation.
30689
30690 When you combine the &%unique=%& and &%readonly%& options, the specific
30691 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30692 rate.
30693
30694 The &%unique=%& mechanism needs more space in the ratelimit database than the
30695 other &%ratelimit%& options in order to store the event set. The number of
30696 unique values is potentially as large as the rate limit, so the extra space
30697 required increases with larger limits.
30698
30699 The uniqueification is not perfect: there is a small probability that Exim
30700 will think a new event has happened before. If the sender's rate is less than
30701 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30702 the measured rate can go above the limit, in which case Exim may under-count
30703 events by a significant margin. Fortunately, if the rate is high enough (2.7
30704 times the limit) that the false positive rate goes above 9%, then Exim will
30705 throw away the over-full event set before the measured rate falls below the
30706 limit. Therefore the only harm should be that exceptionally high sending rates
30707 are logged incorrectly; any countermeasures you configure will be as effective
30708 as intended.
30709
30710
30711 .section "Using rate limiting" "useratlim"
30712 Exim's other ACL facilities are used to define what counter-measures are taken
30713 when the rate limit is exceeded. This might be anything from logging a warning
30714 (for example, while measuring existing sending rates in order to define
30715 policy), through time delays to slow down fast senders, up to rejecting the
30716 message. For example:
30717 .code
30718 # Log all senders' rates
30719 warn ratelimit = 0 / 1h / strict
30720      log_message = Sender rate $sender_rate / $sender_rate_period
30721
30722 # Slow down fast senders; note the need to truncate $sender_rate
30723 # at the decimal point.
30724 warn ratelimit = 100 / 1h / per_rcpt / strict
30725      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30726                    $sender_rate_limit }s
30727
30728 # Keep authenticated users under control
30729 deny authenticated = *
30730      ratelimit = 100 / 1d / strict / $authenticated_id
30731
30732 # System-wide rate limit
30733 defer message = Sorry, too busy. Try again later.
30734      ratelimit = 10 / 1s / $primary_hostname
30735
30736 # Restrict incoming rate from each host, with a default
30737 # set using a macro and special cases looked up in a table.
30738 defer message = Sender rate exceeds $sender_rate_limit \
30739                messages per $sender_rate_period
30740      ratelimit = ${lookup {$sender_host_address} \
30741                    cdb {DB/ratelimits.cdb} \
30742                    {$value} {RATELIMIT} }
30743 .endd
30744 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30745 especially with the &%per_rcpt%& option, you may suffer from a performance
30746 bottleneck caused by locking on the ratelimit hints database. Apart from
30747 making your ACLs less complicated, you can reduce the problem by using a
30748 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30749 this means that Exim will lose its hints data after a reboot (including retry
30750 hints, the callout cache, and ratelimit data).
30751
30752
30753
30754 .section "Address verification" "SECTaddressverification"
30755 .cindex "verifying address" "options for"
30756 .cindex "policy control" "address verification"
30757 Several of the &%verify%& conditions described in section
30758 &<<SECTaclconditions>>& cause addresses to be verified. Section
30759 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30760 The verification conditions can be followed by options that modify the
30761 verification process. The options are separated from the keyword and from each
30762 other by slashes, and some of them contain parameters. For example:
30763 .code
30764 verify = sender/callout
30765 verify = recipient/defer_ok/callout=10s,defer_ok
30766 .endd
30767 The first stage of address verification, which always happens, is to run the
30768 address through the routers, in &"verify mode"&. Routers can detect the
30769 difference between verification and routing for delivery, and their actions can
30770 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30771 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30772 The available options are as follows:
30773
30774 .ilist
30775 If the &%callout%& option is specified, successful routing to one or more
30776 remote hosts is followed by a &"callout"& to those hosts as an additional
30777 check. Callouts and their sub-options are discussed in the next section.
30778 .next
30779 If there is a defer error while doing verification routing, the ACL
30780 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30781 options, the condition is forced to be true instead. Note that this is a main
30782 verification option as well as a suboption for callouts.
30783 .next
30784 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30785 discusses the reporting of sender address verification failures.
30786 .next
30787 The &%success_on_redirect%& option causes verification always to succeed
30788 immediately after a successful redirection. By default, if a redirection
30789 generates just one address, that address is also verified. See further
30790 discussion in section &<<SECTredirwhilveri>>&.
30791 .endlist
30792
30793 .cindex "verifying address" "differentiating failures"
30794 .vindex "&$recipient_verify_failure$&"
30795 .vindex "&$sender_verify_failure$&"
30796 .vindex "&$acl_verify_message$&"
30797 After an address verification failure, &$acl_verify_message$& contains the
30798 error message that is associated with the failure. It can be preserved by
30799 coding like this:
30800 .code
30801 warn  !verify = sender
30802        set acl_m0 = $acl_verify_message
30803 .endd
30804 If you are writing your own custom rejection message or log message when
30805 denying access, you can use this variable to include information about the
30806 verification failure.
30807
30808 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30809 appropriate) contains one of the following words:
30810
30811 .ilist
30812 &%qualify%&: The address was unqualified (no domain), and the message
30813 was neither local nor came from an exempted host.
30814 .next
30815 &%route%&: Routing failed.
30816 .next
30817 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30818 occurred at or before the MAIL command (that is, on initial
30819 connection, HELO, or MAIL).
30820 .next
30821 &%recipient%&: The RCPT command in a callout was rejected.
30822 .next
30823 &%postmaster%&: The postmaster check in a callout was rejected.
30824 .endlist
30825
30826 The main use of these variables is expected to be to distinguish between
30827 rejections of MAIL and rejections of RCPT in callouts.
30828
30829
30830
30831
30832 .section "Callout verification" "SECTcallver"
30833 .cindex "verifying address" "by callout"
30834 .cindex "callout" "verification"
30835 .cindex "SMTP" "callout verification"
30836 For non-local addresses, routing verifies the domain, but is unable to do any
30837 checking of the local part. There are situations where some means of verifying
30838 the local part is desirable. One way this can be done is to make an SMTP
30839 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30840 a subsequent host for a recipient address, to see if the host accepts the
30841 address. We use the term &'callout'& to cover both cases. Note that for a
30842 sender address, the callback is not to the client host that is trying to
30843 deliver the message, but to one of the hosts that accepts incoming mail for the
30844 sender's domain.
30845
30846 Exim does not do callouts by default. If you want them to happen, you must
30847 request them by setting appropriate options on the &%verify%& condition, as
30848 described below. This facility should be used with care, because it can add a
30849 lot of resource usage to the cost of verifying an address. However, Exim does
30850 cache the results of callouts, which helps to reduce the cost. Details of
30851 caching are in section &<<SECTcallvercache>>&.
30852
30853 Recipient callouts are usually used only between hosts that are controlled by
30854 the same administration. For example, a corporate gateway host could use
30855 callouts to check for valid recipients on an internal mailserver. A successful
30856 callout does not guarantee that a real delivery to the address would succeed;
30857 on the other hand, a failing callout does guarantee that a delivery would fail.
30858
30859 If the &%callout%& option is present on a condition that verifies an address, a
30860 second stage of verification occurs if the address is successfully routed to
30861 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30862 &(manualroute)& router, where the router specifies the hosts. However, if a
30863 router that does not set up hosts routes to an &(smtp)& transport with a
30864 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30865 &%hosts_override%& set, its hosts are always used, whether or not the router
30866 supplies a host list.
30867 Callouts are only supported on &(smtp)& transports.
30868
30869 The port that is used is taken from the transport, if it is specified and is a
30870 remote transport. (For routers that do verification only, no transport need be
30871 specified.) Otherwise, the default SMTP port is used. If a remote transport
30872 specifies an outgoing interface, this is used; otherwise the interface is not
30873 specified. Likewise, the text that is used for the HELO command is taken from
30874 the transport's &%helo_data%& option; if there is no transport, the value of
30875 &$smtp_active_hostname$& is used.
30876
30877 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30878 test whether a bounce message could be delivered to the sender address. The
30879 following SMTP commands are sent:
30880 .display
30881 &`HELO `&<&'local host name'&>
30882 &`MAIL FROM:<>`&
30883 &`RCPT TO:`&<&'the address to be tested'&>
30884 &`QUIT`&
30885 .endd
30886 LHLO is used instead of HELO if the transport's &%protocol%& option is
30887 set to &"lmtp"&.
30888
30889 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30890 settings.
30891
30892 A recipient callout check is similar. By default, it also uses an empty address
30893 for the sender. This default is chosen because most hosts do not make use of
30894 the sender address when verifying a recipient. Using the same address means
30895 that a single cache entry can be used for each recipient. Some sites, however,
30896 do make use of the sender address when verifying. These are catered for by the
30897 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30898
30899 If the response to the RCPT command is a 2&'xx'& code, the verification
30900 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30901 Exim tries the next host, if any. If there is a problem with all the remote
30902 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30903 &%callout%& option is given, in which case the condition is forced to succeed.
30904
30905 .cindex "SMTP" "output flushing, disabling for callout"
30906 A callout may take a little time. For this reason, Exim normally flushes SMTP
30907 output before performing a callout in an ACL, to avoid unexpected timeouts in
30908 clients when the SMTP PIPELINING extension is in use. The flushing can be
30909 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30910
30911
30912
30913
30914 .section "Additional parameters for callouts" "CALLaddparcall"
30915 .cindex "callout" "additional parameters for"
30916 The &%callout%& option can be followed by an equals sign and a number of
30917 optional parameters, separated by commas. For example:
30918 .code
30919 verify = recipient/callout=10s,defer_ok
30920 .endd
30921 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30922 separate verify options, is retained for backwards compatibility, but is now
30923 deprecated. The additional parameters for &%callout%& are as follows:
30924
30925
30926 .vlist
30927 .vitem <&'a&~time&~interval'&>
30928 .cindex "callout" "timeout, specifying"
30929 This specifies the timeout that applies for the callout attempt to each host.
30930 For example:
30931 .code
30932 verify = sender/callout=5s
30933 .endd
30934 The default is 30 seconds. The timeout is used for each response from the
30935 remote host. It is also used for the initial connection, unless overridden by
30936 the &%connect%& parameter.
30937
30938
30939 .vitem &*connect&~=&~*&<&'time&~interval'&>
30940 .cindex "callout" "connection timeout, specifying"
30941 This parameter makes it possible to set a different (usually smaller) timeout
30942 for making the SMTP connection. For example:
30943 .code
30944 verify = sender/callout=5s,connect=1s
30945 .endd
30946 If not specified, this timeout defaults to the general timeout value.
30947
30948 .vitem &*defer_ok*&
30949 .cindex "callout" "defer, action on"
30950 When this parameter is present, failure to contact any host, or any other kind
30951 of temporary error, is treated as success by the ACL. However, the cache is not
30952 updated in this circumstance.
30953
30954 .vitem &*fullpostmaster*&
30955 .cindex "callout" "full postmaster check"
30956 This operates like the &%postmaster%& option (see below), but if the check for
30957 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30958 accordance with the specification in RFC 2821. The RFC states that the
30959 unqualified address &'postmaster'& should be accepted.
30960
30961
30962 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30963 .cindex "callout" "sender when verifying header"
30964 When verifying addresses in header lines using the &%header_sender%&
30965 verification option, Exim behaves by default as if the addresses are envelope
30966 sender addresses from a message. Callout verification therefore tests to see
30967 whether a bounce message could be delivered, by using an empty address in the
30968 MAIL command. However, it is arguable that these addresses might never be used
30969 as envelope senders, and could therefore justifiably reject bounce messages
30970 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30971 address to use in the MAIL command. For example:
30972 .code
30973 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30974 .endd
30975 This parameter is available only for the &%header_sender%& verification option.
30976
30977
30978 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30979 .cindex "callout" "overall timeout, specifying"
30980 This parameter sets an overall timeout for performing a callout verification.
30981 For example:
30982 .code
30983 verify = sender/callout=5s,maxwait=30s
30984 .endd
30985 This timeout defaults to four times the callout timeout for individual SMTP
30986 commands. The overall timeout applies when there is more than one host that can
30987 be tried. The timeout is checked before trying the next host. This prevents
30988 very long delays if there are a large number of hosts and all are timing out
30989 (for example, when network connections are timing out).
30990
30991
30992 .vitem &*no_cache*&
30993 .cindex "callout" "cache, suppressing"
30994 .cindex "caching callout, suppressing"
30995 When this parameter is given, the callout cache is neither read nor updated.
30996
30997 .vitem &*postmaster*&
30998 .cindex "callout" "postmaster; checking"
30999 When this parameter is set, a successful callout check is followed by a similar
31000 check for the local part &'postmaster'& at the same domain. If this address is
31001 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
31002 the postmaster check is recorded in a cache record; if it is a failure, this is
31003 used to fail subsequent callouts for the domain without a connection being
31004 made, until the cache record expires.
31005
31006 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
31007 The postmaster check uses an empty sender in the MAIL command by default.
31008 You can use this parameter to do a postmaster check using a different address.
31009 For example:
31010 .code
31011 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
31012 .endd
31013 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
31014 one overrides. The &%postmaster%& parameter is equivalent to this example:
31015 .code
31016 require  verify = sender/callout=postmaster_mailfrom=
31017 .endd
31018 &*Warning*&: The caching arrangements for postmaster checking do not take
31019 account of the sender address. It is assumed that either the empty address or
31020 a fixed non-empty address will be used. All that Exim remembers is that the
31021 postmaster check for the domain succeeded or failed.
31022
31023
31024 .vitem &*random*&
31025 .cindex "callout" "&""random""& check"
31026 When this parameter is set, before doing the normal callout check, Exim does a
31027 check for a &"random"& local part at the same domain. The local part is not
31028 really random &-- it is defined by the expansion of the option
31029 &%callout_random_local_part%&, which defaults to
31030 .code
31031 $primary_hostname-$tod_epoch-testing
31032 .endd
31033 The idea here is to try to determine whether the remote host accepts all local
31034 parts without checking. If it does, there is no point in doing callouts for
31035 specific local parts. If the &"random"& check succeeds, the result is saved in
31036 a cache record, and used to force the current and subsequent callout checks to
31037 succeed without a connection being made, until the cache record expires.
31038
31039 .vitem &*use_postmaster*&
31040 .cindex "callout" "sender for recipient check"
31041 This parameter applies to recipient callouts only. For example:
31042 .code
31043 deny  !verify = recipient/callout=use_postmaster
31044 .endd
31045 .vindex "&$qualify_domain$&"
31046 It causes a non-empty postmaster address to be used in the MAIL command when
31047 performing the callout for the recipient, and also for a &"random"& check if
31048 that is configured. The local part of the address is &`postmaster`& and the
31049 domain is the contents of &$qualify_domain$&.
31050
31051 .vitem &*use_sender*&
31052 This option applies to recipient callouts only. For example:
31053 .code
31054 require  verify = recipient/callout=use_sender
31055 .endd
31056 It causes the message's actual sender address to be used in the MAIL
31057 command when performing the callout, instead of an empty address. There is no
31058 need to use this option unless you know that the called hosts make use of the
31059 sender when checking recipients. If used indiscriminately, it reduces the
31060 usefulness of callout caching.
31061
31062 .vitem &*hold*&
31063 This option applies to recipient callouts only. For example:
31064 .code
31065 require  verify = recipient/callout=use_sender,hold
31066 .endd
31067 It causes the connection to be helod open and used for any further recipients
31068 and for eventual delivery (should that be done quickly).
31069 Doing this saves on TCP and SMTP startup costs, and TLS costs also
31070 when that is used for the connections.
31071 The advantage is only gained if there are no callout cache hits
31072 (which could be enforced by the no_cache option),
31073 if the use_sender option is used,
31074 if neither the random nor the use_postmaster option is used,
31075 and if no other callouts intervene.
31076 .endlist
31077
31078 If you use any of the parameters that set a non-empty sender for the MAIL
31079 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
31080 &%use_sender%&), you should think about possible loops. Recipient checking is
31081 usually done between two hosts that are under the same management, and the host
31082 that receives the callouts is not normally configured to do callouts itself.
31083 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
31084 these circumstances.
31085
31086 However, if you use a non-empty sender address for a callout to an arbitrary
31087 host, there is the likelihood that the remote host will itself initiate a
31088 callout check back to your host. As it is checking what appears to be a message
31089 sender, it is likely to use an empty address in MAIL, thus avoiding a
31090 callout loop. However, to be on the safe side it would be best to set up your
31091 own ACLs so that they do not do sender verification checks when the recipient
31092 is the address you use for header sender or postmaster callout checking.
31093
31094 Another issue to think about when using non-empty senders for callouts is
31095 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
31096 by the sender/recipient combination; thus, for any given recipient, many more
31097 actual callouts are performed than when an empty sender or postmaster is used.
31098
31099
31100
31101
31102 .section "Callout caching" "SECTcallvercache"
31103 .cindex "hints database" "callout cache"
31104 .cindex "callout" "cache, description of"
31105 .cindex "caching" "callout"
31106 Exim caches the results of callouts in order to reduce the amount of resources
31107 used, unless you specify the &%no_cache%& parameter with the &%callout%&
31108 option. A hints database called &"callout"& is used for the cache. Two
31109 different record types are used: one records the result of a callout check for
31110 a specific address, and the other records information that applies to the
31111 entire domain (for example, that it accepts the local part &'postmaster'&).
31112
31113 When an original callout fails, a detailed SMTP error message is given about
31114 the failure. However, for subsequent failures use the cache data, this message
31115 is not available.
31116
31117 The expiry times for negative and positive address cache records are
31118 independent, and can be set by the global options &%callout_negative_expire%&
31119 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
31120
31121 If a host gives a negative response to an SMTP connection, or rejects any
31122 commands up to and including
31123 .code
31124 MAIL FROM:<>
31125 .endd
31126 (but not including the MAIL command with a non-empty address),
31127 any callout attempt is bound to fail. Exim remembers such failures in a
31128 domain cache record, which it uses to fail callouts for the domain without
31129 making new connections, until the domain record times out. There are two
31130 separate expiry times for domain cache records:
31131 &%callout_domain_negative_expire%& (default 3h) and
31132 &%callout_domain_positive_expire%& (default 7d).
31133
31134 Domain records expire when the negative expiry time is reached if callouts
31135 cannot be made for the domain, or if the postmaster check failed.
31136 Otherwise, they expire when the positive expiry time is reached. This
31137 ensures that, for example, a host that stops accepting &"random"& local parts
31138 will eventually be noticed.
31139
31140 The callout caching mechanism is based on the domain of the address that is
31141 being tested. If the domain routes to several hosts, it is assumed that their
31142 behaviour will be the same.
31143
31144
31145
31146 .section "Sender address verification reporting" "SECTsenaddver"
31147 .cindex "verifying" "suppressing error details"
31148 See section &<<SECTaddressverification>>& for a general discussion of
31149 verification. When sender verification fails in an ACL, the details of the
31150 failure are given as additional output lines before the 550 response to the
31151 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
31152 you might see:
31153 .code
31154 MAIL FROM:<xyz@abc.example>
31155 250 OK
31156 RCPT TO:<pqr@def.example>
31157 550-Verification failed for <xyz@abc.example>
31158 550-Called:   192.168.34.43
31159 550-Sent:     RCPT TO:<xyz@abc.example>
31160 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
31161 550 Sender verification failed
31162 .endd
31163 If more than one RCPT command fails in the same way, the details are given
31164 only for the first of them. However, some administrators do not want to send
31165 out this much information. You can suppress the details by adding
31166 &`/no_details`& to the ACL statement that requests sender verification. For
31167 example:
31168 .code
31169 verify = sender/no_details
31170 .endd
31171
31172 .section "Redirection while verifying" "SECTredirwhilveri"
31173 .cindex "verifying" "redirection while"
31174 .cindex "address redirection" "while verifying"
31175 A dilemma arises when a local address is redirected by aliasing or forwarding
31176 during verification: should the generated addresses themselves be verified,
31177 or should the successful expansion of the original address be enough to verify
31178 it? By default, Exim takes the following pragmatic approach:
31179
31180 .ilist
31181 When an incoming address is redirected to just one child address, verification
31182 continues with the child address, and if that fails to verify, the original
31183 verification also fails.
31184 .next
31185 When an incoming address is redirected to more than one child address,
31186 verification does not continue. A success result is returned.
31187 .endlist
31188
31189 This seems the most reasonable behaviour for the common use of aliasing as a
31190 way of redirecting different local parts to the same mailbox. It means, for
31191 example, that a pair of alias entries of the form
31192 .code
31193 A.Wol:   aw123
31194 aw123:   :fail: Gone away, no forwarding address
31195 .endd
31196 work as expected, with both local parts causing verification failure. When a
31197 redirection generates more than one address, the behaviour is more like a
31198 mailing list, where the existence of the alias itself is sufficient for
31199 verification to succeed.
31200
31201 It is possible, however, to change the default behaviour so that all successful
31202 redirections count as successful verifications, however many new addresses are
31203 generated. This is specified by the &%success_on_redirect%& verification
31204 option. For example:
31205 .code
31206 require verify = recipient/success_on_redirect/callout=10s
31207 .endd
31208 In this example, verification succeeds if a router generates a new address, and
31209 the callout does not occur, because no address was routed to a remote host.
31210
31211 When verification is being tested via the &%-bv%& option, the treatment of
31212 redirections is as just described, unless the &%-v%& or any debugging option is
31213 also specified. In that case, full verification is done for every generated
31214 address and a report is output for each of them.
31215
31216
31217
31218 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
31219 .cindex "CSA" "verifying"
31220 Client SMTP Authorization is a system that allows a site to advertise
31221 which machines are and are not permitted to send email. This is done by placing
31222 special SRV records in the DNS; these are looked up using the client's HELO
31223 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
31224 Authorization checks in Exim are performed by the ACL condition:
31225 .code
31226 verify = csa
31227 .endd
31228 This fails if the client is not authorized. If there is a DNS problem, or if no
31229 valid CSA SRV record is found, or if the client is authorized, the condition
31230 succeeds. These three cases can be distinguished using the expansion variable
31231 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
31232 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
31233 be likely to cause problems for legitimate email.
31234
31235 The error messages produced by the CSA code include slightly more
31236 detail. If &$csa_status$& is &"defer"&, this may be because of problems
31237 looking up the CSA SRV record, or problems looking up the CSA target
31238 address record. There are four reasons for &$csa_status$& being &"fail"&:
31239
31240 .ilist
31241 The client's host name is explicitly not authorized.
31242 .next
31243 The client's IP address does not match any of the CSA target IP addresses.
31244 .next
31245 The client's host name is authorized but it has no valid target IP addresses
31246 (for example, the target's addresses are IPv6 and the client is using IPv4).
31247 .next
31248 The client's host name has no CSA SRV record but a parent domain has asserted
31249 that all subdomains must be explicitly authorized.
31250 .endlist
31251
31252 The &%csa%& verification condition can take an argument which is the domain to
31253 use for the DNS query. The default is:
31254 .code
31255 verify = csa/$sender_helo_name
31256 .endd
31257 This implementation includes an extension to CSA. If the query domain
31258 is an address literal such as [192.0.2.95], or if it is a bare IP
31259 address, Exim searches for CSA SRV records in the reverse DNS as if
31260 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
31261 meaningful to say:
31262 .code
31263 verify = csa/$sender_host_address
31264 .endd
31265 In fact, this is the check that Exim performs if the client does not say HELO.
31266 This extension can be turned off by setting the main configuration option
31267 &%dns_csa_use_reverse%& to be false.
31268
31269 If a CSA SRV record is not found for the domain itself, a search
31270 is performed through its parent domains for a record which might be
31271 making assertions about subdomains. The maximum depth of this search is limited
31272 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
31273 default. Exim does not look for CSA SRV records in a top level domain, so the
31274 default settings handle HELO domains as long as seven
31275 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
31276 of legitimate HELO domains.
31277
31278 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
31279 direct SRV lookups, this is not sufficient because of the extra parent domain
31280 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
31281 addresses into lookups in the reverse DNS space. The result of a successful
31282 lookup such as:
31283 .code
31284 ${lookup dnsdb {csa=$sender_helo_name}}
31285 .endd
31286 has two space-separated fields: an authorization code and a target host name.
31287 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
31288 authorization required but absent, or &"?"& for unknown.
31289
31290
31291
31292
31293 .section "Bounce address tag validation" "SECTverifyPRVS"
31294 .cindex "BATV, verifying"
31295 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
31296 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
31297 Genuine incoming bounce messages should therefore always be addressed to
31298 recipients that have a valid tag. This scheme is a way of detecting unwanted
31299 bounce messages caused by sender address forgeries (often called &"collateral
31300 spam"&), because the recipients of such messages do not include valid tags.
31301
31302 There are two expansion items to help with the implementation of the BATV
31303 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
31304 the original envelope sender address by using a simple key to add a hash of the
31305 address and some time-based randomizing information. The &%prvs%& expansion
31306 item creates a signed address, and the &%prvscheck%& expansion item checks one.
31307 The syntax of these expansion items is described in section
31308 &<<SECTexpansionitems>>&.
31309 The validity period on signed addresses is seven days.
31310
31311 As an example, suppose the secret per-address keys are stored in an MySQL
31312 database. A query to look up the key for an address could be defined as a macro
31313 like this:
31314 .code
31315 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
31316                 WHERE sender='${quote_mysql:$prvscheck_address}'\
31317                 }{$value}}
31318 .endd
31319 Suppose also that the senders who make use of BATV are defined by an address
31320 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
31321 use this:
31322 .code
31323 # Bounces: drop unsigned addresses for BATV senders
31324 deny message = This address does not send an unsigned reverse path
31325      senders = :
31326      recipients = +batv_senders
31327
31328 # Bounces: In case of prvs-signed address, check signature.
31329 deny message = Invalid reverse path signature.
31330      senders = :
31331      condition  = ${prvscheck {$local_part@$domain}\
31332                   {PRVSCHECK_SQL}{1}}
31333      !condition = $prvscheck_result
31334 .endd
31335 The first statement rejects recipients for bounce messages that are addressed
31336 to plain BATV sender addresses, because it is known that BATV senders do not
31337 send out messages with plain sender addresses. The second statement rejects
31338 recipients that are prvs-signed, but with invalid signatures (either because
31339 the key is wrong, or the signature has timed out).
31340
31341 A non-prvs-signed address is not rejected by the second statement, because the
31342 &%prvscheck%& expansion yields an empty string if its first argument is not a
31343 prvs-signed address, thus causing the &%condition%& condition to be false. If
31344 the first argument is a syntactically valid prvs-signed address, the yield is
31345 the third string (in this case &"1"&), whether or not the cryptographic and
31346 timeout checks succeed. The &$prvscheck_result$& variable contains the result
31347 of the checks (empty for failure, &"1"& for success).
31348
31349 There is one more issue you must consider when implementing prvs-signing:
31350 you have to ensure that the routers accept prvs-signed addresses and
31351 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
31352 router to remove the signature with a configuration along these lines:
31353 .code
31354 batv_redirect:
31355   driver = redirect
31356   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
31357 .endd
31358 This works because, if the third argument of &%prvscheck%& is empty, the result
31359 of the expansion of a prvs-signed address is the decoded value of the original
31360 address. This router should probably be the first of your routers that handles
31361 local addresses.
31362
31363 To create BATV-signed addresses in the first place, a transport of this form
31364 can be used:
31365 .code
31366 external_smtp_batv:
31367   driver = smtp
31368   return_path = ${prvs {$return_path} \
31369                        {${lookup mysql{SELECT \
31370                        secret FROM batv_prvs WHERE \
31371                        sender='${quote_mysql:$sender_address}'} \
31372                        {$value}fail}}}
31373 .endd
31374 If no key can be found for the existing return path, no signing takes place.
31375
31376
31377
31378 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31379 .cindex "&ACL;" "relay control"
31380 .cindex "relaying" "control by ACL"
31381 .cindex "policy control" "relay control"
31382 An MTA is said to &'relay'& a message if it receives it from some host and
31383 delivers it directly to another host as a result of a remote address contained
31384 within it. Redirecting a local address via an alias or forward file and then
31385 passing the message on to another host is not relaying,
31386 .cindex "&""percent hack""&"
31387 but a redirection as a result of the &"percent hack"& is.
31388
31389 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31390 A host which is acting as a gateway or an MX backup is concerned with incoming
31391 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31392 a host which is acting as a smart host for a number of clients is concerned
31393 with outgoing relaying from those clients to the Internet at large. Often the
31394 same host is fulfilling both functions,
31395 . ///
31396 . as illustrated in the diagram below,
31397 . ///
31398 but in principle these two kinds of relaying are entirely independent. What is
31399 not wanted is the transmission of mail from arbitrary remote hosts through your
31400 system to arbitrary domains.
31401
31402
31403 You can implement relay control by means of suitable statements in the ACL that
31404 runs for each RCPT command. For convenience, it is often easiest to use
31405 Exim's named list facility to define the domains and hosts involved. For
31406 example, suppose you want to do the following:
31407
31408 .ilist
31409 Deliver a number of domains to mailboxes on the local host (or process them
31410 locally in some other way). Let's say these are &'my.dom1.example'& and
31411 &'my.dom2.example'&.
31412 .next
31413 Relay mail for a number of other domains for which you are the secondary MX.
31414 These might be &'friend1.example'& and &'friend2.example'&.
31415 .next
31416 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31417 Suppose your LAN is 192.168.45.0/24.
31418 .endlist
31419
31420
31421 In the main part of the configuration, you put the following definitions:
31422 .code
31423 domainlist local_domains    = my.dom1.example : my.dom2.example
31424 domainlist relay_to_domains = friend1.example : friend2.example
31425 hostlist   relay_from_hosts = 192.168.45.0/24
31426 .endd
31427 Now you can use these definitions in the ACL that is run for every RCPT
31428 command:
31429 .code
31430 acl_check_rcpt:
31431   accept domains = +local_domains : +relay_to_domains
31432   accept hosts   = +relay_from_hosts
31433 .endd
31434 The first statement accepts any RCPT command that contains an address in
31435 the local or relay domains. For any other domain, control passes to the second
31436 statement, which accepts the command only if it comes from one of the relay
31437 hosts. In practice, you will probably want to make your ACL more sophisticated
31438 than this, for example, by including sender and recipient verification. The
31439 default configuration includes a more comprehensive example, which is described
31440 in chapter &<<CHAPdefconfil>>&.
31441
31442
31443
31444 .section "Checking a relay configuration" "SECTcheralcon"
31445 .cindex "relaying" "checking control of"
31446 You can check the relay characteristics of your configuration in the same way
31447 that you can test any ACL behaviour for an incoming SMTP connection, by using
31448 the &%-bh%& option to run a fake SMTP session with which you interact.
31449 .ecindex IIDacl
31450
31451
31452
31453 . ////////////////////////////////////////////////////////////////////////////
31454 . ////////////////////////////////////////////////////////////////////////////
31455
31456 .chapter "Content scanning at ACL time" "CHAPexiscan"
31457 .scindex IIDcosca "content scanning" "at ACL time"
31458 The extension of Exim to include content scanning at ACL time, formerly known
31459 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31460 was integrated into the main source for Exim release 4.50, and Tom continues to
31461 maintain it. Most of the wording of this chapter is taken from Tom's
31462 specification.
31463
31464 It is also possible to scan the content of messages at other times. The
31465 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31466 scanning after all the ACLs have run. A transport filter can be used to scan
31467 messages at delivery time (see the &%transport_filter%& option, described in
31468 chapter &<<CHAPtransportgeneric>>&).
31469
31470 If you want to include the ACL-time content-scanning features when you compile
31471 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31472 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31473
31474 .ilist
31475 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31476 for all MIME parts for SMTP and non-SMTP messages, respectively.
31477 .next
31478 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31479 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31480 run at the end of message reception (the &%acl_smtp_data%& ACL).
31481 .next
31482 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31483 of messages, or parts of messages, for debugging purposes.
31484 .next
31485 Additional expansion variables that are set in the new ACL and by the new
31486 conditions.
31487 .next
31488 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31489 .endlist
31490
31491 Content-scanning is continually evolving, and new features are still being
31492 added. While such features are still unstable and liable to incompatible
31493 changes, they are made available in Exim by setting options whose names begin
31494 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31495 this manual. You can find out about them by reading the file called
31496 &_doc/experimental.txt_&.
31497
31498 All the content-scanning facilities work on a MBOX copy of the message that is
31499 temporarily created in a file called:
31500 .display
31501 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31502 .endd
31503 The &_.eml_& extension is a friendly hint to virus scanners that they can
31504 expect an MBOX-like structure inside that file. The file is created when the
31505 first content scanning facility is called. Subsequent calls to content
31506 scanning conditions open the same file again. The directory is recursively
31507 removed when the &%acl_smtp_data%& ACL has finished running, unless
31508 .code
31509 control = no_mbox_unspool
31510 .endd
31511 has been encountered. When the MIME ACL decodes files, they are put into the
31512 same directory by default.
31513
31514
31515
31516 .section "Scanning for viruses" "SECTscanvirus"
31517 .cindex "virus scanning"
31518 .cindex "content scanning" "for viruses"
31519 .cindex "content scanning" "the &%malware%& condition"
31520 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31521 It supports a &"generic"& interface to scanners called via the shell, and
31522 specialized interfaces for &"daemon"& type virus scanners, which are resident
31523 in memory and thus are much faster.
31524
31525 A timeout of 2 minutes is applied to a scanner call (by default);
31526 if it expires then a defer action is taken.
31527
31528 .oindex "&%av_scanner%&"
31529 You can set the &%av_scanner%& option in the main part of the configuration
31530 to specify which scanner to use, together with any additional options that
31531 are needed. The basic syntax is as follows:
31532 .display
31533 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31534 .endd
31535 If you do not set &%av_scanner%&, it defaults to
31536 .code
31537 av_scanner = sophie:/var/run/sophie
31538 .endd
31539 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31540 before use.
31541 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31542 The following scanner types are supported in this release:
31543
31544 .vlist
31545 .vitem &%avast%&
31546 .cindex "virus scanners" "avast"
31547 This is the scanner daemon of Avast. It has been tested with Avast Core
31548 Security (currently at version 1.1.7).
31549 You can get a trial version at &url(http://www.avast.com) or for Linux
31550 at &url(http://www.avast.com/linux-server-antivirus).
31551 This scanner type takes one option,
31552 which can be either a full path to a UNIX socket,
31553 or host and port specifiers separated by white space.
31554 The host may be a name or an IP address; the port is either a
31555 single number or a pair of numbers with a dash between.
31556 Any further options are given, on separate lines,
31557 to the daemon as options before the main scan command.
31558 For example:
31559 .code
31560 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31561 av_scanner = avast:192.168.2.22 5036
31562 .endd
31563 If you omit the argument, the default path
31564 &_/var/run/avast/scan.sock_&
31565 is used.
31566 If you use a remote host,
31567 you need to make Exim's spool directory available to it,
31568 as the scanner is passed a file path, not file contents.
31569 For information about available commands and their options you may use
31570 .code
31571 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31572     FLAGS
31573     SENSITIVITY
31574     PACK
31575 .endd
31576
31577
31578 .vitem &%aveserver%&
31579 .cindex "virus scanners" "Kaspersky"
31580 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31581 at &url(http://www.kaspersky.com). This scanner type takes one option,
31582 which is the path to the daemon's UNIX socket. The default is shown in this
31583 example:
31584 .code
31585 av_scanner = aveserver:/var/run/aveserver
31586 .endd
31587
31588
31589 .vitem &%clamd%&
31590 .cindex "virus scanners" "clamd"
31591 This daemon-type scanner is GPL and free. You can get it at
31592 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31593 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31594 in the MIME ACL. This is no longer believed to be necessary.
31595
31596 The options are a list of server specifiers, which may be
31597 a UNIX socket specification,
31598 a TCP socket specification,
31599 or a (global) option.
31600
31601 A socket specification consists of a space-separated list.
31602 For a Unix socket the first element is a full path for the socket,
31603 for a TCP socket the first element is the IP address
31604 and the second a port number,
31605 Any further elements are per-server (non-global) options.
31606 These per-server options are supported:
31607 .code
31608 retry=<timespec>        Retry on connect fail
31609 .endd
31610
31611 The &`retry`& option specifies a time after which a single retry for
31612 a failed connect is made.  The default is to not retry.
31613
31614 If a Unix socket file is specified, only one server is supported.
31615
31616 Examples:
31617 .code
31618 av_scanner = clamd:/opt/clamd/socket
31619 av_scanner = clamd:192.0.2.3 1234
31620 av_scanner = clamd:192.0.2.3 1234:local
31621 av_scanner = clamd:192.0.2.3 1234 retry=10s
31622 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31623 .endd
31624 If the value of av_scanner points to a UNIX socket file or contains the
31625 &`local`&
31626 option, then the ClamAV interface will pass a filename containing the data
31627 to be scanned, which will should normally result in less I/O happening and be
31628 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31629 Exim does not assume that there is a common filesystem with the remote host.
31630 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31631 you be running a version of ClamAV prior to 0.95.
31632
31633 The final example shows that multiple TCP targets can be specified.  Exim will
31634 randomly use one for each incoming email (i.e. it load balances them).  Note
31635 that only TCP targets may be used if specifying a list of scanners; a UNIX
31636 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31637 unavailable, Exim will try the remaining one(s) until it finds one that works.
31638 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31639 not keep track of scanner state between multiple messages, and the scanner
31640 selection is random, so the message will get logged in the mainlog for each
31641 email that the down scanner gets chosen first (message wrapped to be readable):
31642 .code
31643 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31644    clamd: connection to localhost, port 3310 failed
31645    (Connection refused)
31646 .endd
31647
31648 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31649 contributing the code for this scanner.
31650
31651 .vitem &%cmdline%&
31652 .cindex "virus scanners" "command line interface"
31653 This is the keyword for the generic command line scanner interface. It can be
31654 used to attach virus scanners that are invoked from the shell. This scanner
31655 type takes 3 mandatory options:
31656
31657 .olist
31658 The full path and name of the scanner binary, with all command line options,
31659 and a placeholder (&`%s`&) for the directory to scan.
31660
31661 .next
31662 A regular expression to match against the STDOUT and STDERR output of the
31663 virus scanner. If the expression matches, a virus was found. You must make
31664 absolutely sure that this expression matches on &"virus found"&. This is called
31665 the &"trigger"& expression.
31666
31667 .next
31668 Another regular expression, containing exactly one pair of parentheses, to
31669 match the name of the virus found in the scanners output. This is called the
31670 &"name"& expression.
31671 .endlist olist
31672
31673 For example, Sophos Sweep reports a virus on a line like this:
31674 .code
31675 Virus 'W32/Magistr-B' found in file ./those.bat
31676 .endd
31677 For the trigger expression, we can match the phrase &"found in file"&. For the
31678 name expression, we want to extract the W32/Magistr-B string, so we can match
31679 for the single quotes left and right of it. Altogether, this makes the
31680 configuration setting:
31681 .code
31682 av_scanner = cmdline:\
31683              /path/to/sweep -ss -all -rec -archive %s:\
31684              found in file:'(.+)'
31685 .endd
31686 .vitem &%drweb%&
31687 .cindex "virus scanners" "DrWeb"
31688 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31689 takes one option,
31690 either a full path to a UNIX socket,
31691 or host and port specifiers separated by white space.
31692 The host may be a name or an IP address; the port is either a
31693 single number or a pair of numbers with a dash between.
31694 For example:
31695 .code
31696 av_scanner = drweb:/var/run/drwebd.sock
31697 av_scanner = drweb:192.168.2.20 31337
31698 .endd
31699 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31700 is used. Thanks to Alex Miller for contributing the code for this scanner.
31701
31702 .vitem &%f-protd%&
31703 .cindex "virus scanners" "f-protd"
31704 The f-protd scanner is accessed via HTTP over TCP.
31705 One argument is taken, being a space-separated hostname and port number
31706 (or port-range).
31707 For example:
31708 .code
31709 av_scanner = f-protd:localhost 10200-10204
31710 .endd
31711 If you omit the argument, the default values show above are used.
31712
31713 .vitem &%f-prot6d%&
31714 .cindex "virus scanners" "f-prot6d"
31715 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
31716 One argument is taken, being a space-separated hostname and port number.
31717 For example:
31718 .code
31719 av_scanner = f-prot6d:localhost 10200
31720 .endd
31721 If you omit the argument, the default values show above are used.
31722
31723 .vitem &%fsecure%&
31724 .cindex "virus scanners" "F-Secure"
31725 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31726 argument which is the path to a UNIX socket. For example:
31727 .code
31728 av_scanner = fsecure:/path/to/.fsav
31729 .endd
31730 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31731 Thelmen for contributing the code for this scanner.
31732
31733 .vitem &%kavdaemon%&
31734 .cindex "virus scanners" "Kaspersky"
31735 This is the scanner daemon of Kaspersky Version 4. This version of the
31736 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31737 scanner type takes one option, which is the path to the daemon's UNIX socket.
31738 For example:
31739 .code
31740 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31741 .endd
31742 The default path is &_/var/run/AvpCtl_&.
31743
31744 .vitem &%mksd%&
31745 .cindex "virus scanners" "mksd"
31746 This is a daemon type scanner that is aimed mainly at Polish users, though some
31747 parts of documentation are now available in English. You can get it at
31748 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31749 the maximum number of processes used simultaneously to scan the attachments,
31750 provided that mksd has
31751 been run with at least the same number of child processes. For example:
31752 .code
31753 av_scanner = mksd:2
31754 .endd
31755 You can safely omit this option (the default value is 1).
31756
31757 .vitem &%sock%&
31758 .cindex "virus scanners" "simple socket-connected"
31759 This is a general-purpose way of talking to simple scanner daemons
31760 running on the local machine.
31761 There are four options:
31762 an address (which may be an IP address and port, or the path of a Unix socket),
31763 a commandline to send (may include a single %s which will be replaced with
31764 the path to the mail file to be scanned),
31765 an RE to trigger on from the returned data,
31766 and an RE to extract malware_name from the returned data.
31767 For example:
31768 .code
31769 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
31770 .endd
31771 Note that surrounding whitespace is stripped from each option, meaning
31772 there is no way to specify a trailing newline.
31773 The socket specifier and both regular-expressions are required.
31774 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
31775 specify an empty element to get this.
31776
31777 .vitem &%sophie%&
31778 .cindex "virus scanners" "Sophos and Sophie"
31779 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31780 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31781 for this scanner type is the path to the UNIX socket that Sophie uses for
31782 client communication. For example:
31783 .code
31784 av_scanner = sophie:/tmp/sophie
31785 .endd
31786 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31787 the option.
31788 .endlist
31789
31790 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31791 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31792 ACL.
31793
31794 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31795 makes it possible to use different scanners. See further below for an example.
31796 The &%malware%& condition caches its results, so when you use it multiple times
31797 for the same message, the actual scanning process is only carried out once.
31798 However, using expandable items in &%av_scanner%& disables this caching, in
31799 which case each use of the &%malware%& condition causes a new scan of the
31800 message.
31801
31802 The &%malware%& condition takes a right-hand argument that is expanded before
31803 use and taken as a list, slash-separated by default.
31804 The first element can then be one of
31805
31806 .ilist
31807 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31808 The condition succeeds if a virus was found, and fail otherwise. This is the
31809 recommended usage.
31810 .next
31811 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31812 the condition fails immediately.
31813 .next
31814 A regular expression, in which case the message is scanned for viruses. The
31815 condition succeeds if a virus is found and its name matches the regular
31816 expression. This allows you to take special actions on certain types of virus.
31817 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31818 unless the separator is changed (in the usual way).
31819 .endlist
31820
31821 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31822 messages even if there is a problem with the virus scanner.
31823 Otherwise, such a problem causes the ACL to defer.
31824
31825 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31826 specify a non-default timeout.  The default is two minutes.
31827 For example:
31828 .code
31829 malware = * / defer_ok / tmo=10s
31830 .endd
31831 A timeout causes the ACL to defer.
31832
31833 .vindex "&$callout_address$&"
31834 When a connection is made to the scanner the expansion variable &$callout_address$&
31835 is set to record the actual address used.
31836
31837 .vindex "&$malware_name$&"
31838 When a virus is found, the condition sets up an expansion variable called
31839 &$malware_name$& that contains the name of the virus. You can use it in a
31840 &%message%& modifier that specifies the error returned to the sender, and/or in
31841 logging data.
31842
31843 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31844 imposed by your anti-virus scanner.
31845
31846 Here is a very simple scanning example:
31847 .code
31848 deny message = This message contains malware ($malware_name)
31849      malware = *
31850 .endd
31851 The next example accepts messages when there is a problem with the scanner:
31852 .code
31853 deny message = This message contains malware ($malware_name)
31854      malware = */defer_ok
31855 .endd
31856 The next example shows how to use an ACL variable to scan with both sophie and
31857 aveserver. It assumes you have set:
31858 .code
31859 av_scanner = $acl_m0
31860 .endd
31861 in the main Exim configuration.
31862 .code
31863 deny message = This message contains malware ($malware_name)
31864      set acl_m0 = sophie
31865      malware = *
31866
31867 deny message = This message contains malware ($malware_name)
31868      set acl_m0 = aveserver
31869      malware = *
31870 .endd
31871
31872
31873 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31874 .cindex "content scanning" "for spam"
31875 .cindex "spam scanning"
31876 .cindex "SpamAssassin"
31877 .cindex "Rspamd"
31878 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31879 score and a report for the message.
31880 Support is also provided for Rspamd.
31881
31882 For more information about installation and configuration of SpamAssassin or
31883 Rspamd refer to their respective websites at
31884 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31885
31886 SpamAssassin can be installed with CPAN by running:
31887 .code
31888 perl -MCPAN -e 'install Mail::SpamAssassin'
31889 .endd
31890 SpamAssassin has its own set of configuration files. Please review its
31891 documentation to see how you can tweak it. The default installation should work
31892 nicely, however.
31893
31894 .oindex "&%spamd_address%&"
31895 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31896 intend to use an instance running on the local host you do not need to set
31897 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31898 you must set the &%spamd_address%& option in the global part of the Exim
31899 configuration as follows (example):
31900 .code
31901 spamd_address = 192.168.99.45 387
31902 .endd
31903 The SpamAssassin protocol relies on a TCP half-close from the client.
31904 If your SpamAssassin client side is running a Linux system with an
31905 iptables firewall, consider setting
31906 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
31907 timeout, Exim uses when waiting for a response from the SpamAssassin
31908 server (currently defaulting to 120s).  With a lower value the Linux
31909 connection tracking may consider your half-closed connection as dead too
31910 soon.
31911
31912
31913 To use Rspamd (which by default listens on all local addresses
31914 on TCP port 11333)
31915 you should add &%variant=rspamd%& after the address/port pair, for example:
31916 .code
31917 spamd_address = 127.0.0.1 11333 variant=rspamd
31918 .endd
31919
31920 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31921 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31922 file name instead of an address/port pair:
31923 .code
31924 spamd_address = /var/run/spamd_socket
31925 .endd
31926 You can have multiple &%spamd%& servers to improve scalability. These can
31927 reside on other hardware reachable over the network. To specify multiple
31928 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31929 option, separated with colons (the separator can be changed in the usual way):
31930 .code
31931 spamd_address = 192.168.2.10 783 : \
31932                 192.168.2.11 783 : \
31933                 192.168.2.12 783
31934 .endd
31935 Up to 32 &%spamd%& servers are supported.
31936 When a server fails to respond to the connection attempt, all other
31937 servers are tried until one succeeds. If no server responds, the &%spam%&
31938 condition defers.
31939
31940 Unix and TCP socket specifications may be mixed in any order.
31941 Each element of the list is a list itself, space-separated by default
31942 and changeable in the usual way; take care to not double the separator.
31943
31944 For TCP socket specifications a host name or IP (v4 or v6, but
31945 subject to list-separator quoting rules) address can be used,
31946 and the port can be one or a dash-separated pair.
31947 In the latter case, the range is tried in strict order.
31948
31949 Elements after the first for Unix sockets, or second for TCP socket,
31950 are options.
31951 The supported options are:
31952 .code
31953 pri=<priority>      Selection priority
31954 weight=<value>      Selection bias
31955 time=<start>-<end>  Use only between these times of day
31956 retry=<timespec>    Retry on connect fail
31957 tmo=<timespec>      Connection time limit
31958 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31959 .endd
31960
31961 The &`pri`& option specifies a priority for the server within the list,
31962 higher values being tried first.
31963 The default priority is 1.
31964
31965 The &`weight`& option specifies a selection bias.
31966 Within a priority set
31967 servers are queried in a random fashion, weighted by this value.
31968 The default value for selection bias is 1.
31969
31970 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31971 in the local time zone; each element being one or more digits.
31972 Either the seconds or both minutes and seconds, plus the leading &`.`&
31973 characters, may be omitted and will be taken as zero.
31974
31975 Timeout specifications for the &`retry`& and &`tmo`& options
31976 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31977
31978 The &`tmo`& option specifies an overall timeout for communication.
31979 The default value is two minutes.
31980
31981 The &`retry`& option specifies a time after which a single retry for
31982 a failed connect is made.
31983 The default is to not retry.
31984
31985 The &%spamd_address%& variable is expanded before use if it starts with
31986 a dollar sign. In this case, the expansion may return a string that is
31987 used as the list so that multiple spamd servers can be the result of an
31988 expansion.
31989
31990 .vindex "&$callout_address$&"
31991 When a connection is made to the server the expansion variable &$callout_address$&
31992 is set to record the actual address used.
31993
31994 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31995 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31996 .code
31997 deny message = This message was classified as SPAM
31998      spam = joe
31999 .endd
32000 The right-hand side of the &%spam%& condition specifies a name. This is
32001 relevant if you have set up multiple SpamAssassin profiles. If you do not want
32002 to scan using a specific profile, but rather use the SpamAssassin system-wide
32003 default profile, you can scan for an unknown name, or simply use &"nobody"&.
32004 Rspamd does not use this setting. However, you must put something on the
32005 right-hand side.
32006
32007 The name allows you to use per-domain or per-user antispam profiles in
32008 principle, but this is not straightforward in practice, because a message may
32009 have multiple recipients, not necessarily all in the same domain. Because the
32010 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
32011 read the contents of the message, the variables &$local_part$& and &$domain$&
32012 are not set.
32013 Careful enforcement of single-recipient messages
32014 (e.g. by responding with defer in the recipient ACL for all recipients
32015 after the first),
32016 or the use of PRDR,
32017 .cindex "PRDR" "use for per-user SpamAssassin profiles"
32018 are needed to use this feature.
32019
32020 The right-hand side of the &%spam%& condition is expanded before being used, so
32021 you can put lookups or conditions there. When the right-hand side evaluates to
32022 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
32023
32024
32025 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
32026 large ones may cause significant performance degradation. As most spam messages
32027 are quite small, it is recommended that you do not scan the big ones. For
32028 example:
32029 .code
32030 deny message = This message was classified as SPAM
32031      condition = ${if < {$message_size}{10K}}
32032      spam = nobody
32033 .endd
32034
32035 The &%spam%& condition returns true if the threshold specified in the user's
32036 SpamAssassin profile has been matched or exceeded. If you want to use the
32037 &%spam%& condition for its side effects (see the variables below), you can make
32038 it always return &"true"& by appending &`:true`& to the username.
32039
32040 .cindex "spam scanning" "returned variables"
32041 When the &%spam%& condition is run, it sets up a number of expansion
32042 variables.
32043 Except for &$spam_report$&,
32044 these variables are saved with the received message so are
32045 available for use at delivery time.
32046
32047 .vlist
32048 .vitem &$spam_score$&
32049 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
32050 for inclusion in log or reject messages.
32051
32052 .vitem &$spam_score_int$&
32053 The spam score of the message, multiplied by ten, as an integer value. For
32054 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
32055 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
32056 The integer value is useful for numeric comparisons in conditions.
32057
32058 .vitem &$spam_bar$&
32059 A string consisting of a number of &"+"& or &"-"& characters, representing the
32060 integer part of the spam score value. A spam score of 4.4 would have a
32061 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
32062 headers, since MUAs can match on such strings. The maximum length of the
32063 spam bar is 50 characters.
32064
32065 .vitem &$spam_report$&
32066 A multiline text table, containing the full SpamAssassin report for the
32067 message. Useful for inclusion in headers or reject messages.
32068 This variable is only usable in a DATA-time ACL.
32069 Beware that SpamAssassin may return non-ASCII characters, especially
32070 when running in country-specific locales, which are not legal
32071 unencoded in headers.
32072
32073 .vitem &$spam_action$&
32074 For SpamAssassin either 'reject' or 'no action' depending on the
32075 spam score versus threshold.
32076 For Rspamd, the recommended action.
32077
32078 .endlist
32079
32080 The &%spam%& condition caches its results unless expansion in
32081 spamd_address was used. If you call it again with the same user name, it
32082 does not scan again, but rather returns the same values as before.
32083
32084 The &%spam%& condition returns DEFER if there is any error while running
32085 the message through SpamAssassin or if the expansion of spamd_address
32086 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
32087 statement block), append &`/defer_ok`& to the right-hand side of the
32088 spam condition, like this:
32089 .code
32090 deny message = This message was classified as SPAM
32091      spam    = joe/defer_ok
32092 .endd
32093 This causes messages to be accepted even if there is a problem with &%spamd%&.
32094
32095 Here is a longer, commented example of the use of the &%spam%&
32096 condition:
32097 .code
32098 # put headers in all messages (no matter if spam or not)
32099 warn  spam = nobody:true
32100       add_header = X-Spam-Score: $spam_score ($spam_bar)
32101       add_header = X-Spam-Report: $spam_report
32102
32103 # add second subject line with *SPAM* marker when message
32104 # is over threshold
32105 warn  spam = nobody
32106       add_header = Subject: *SPAM* $h_Subject:
32107
32108 # reject spam at high scores (> 12)
32109 deny  message = This message scored $spam_score spam points.
32110       spam = nobody:true
32111       condition = ${if >{$spam_score_int}{120}{1}{0}}
32112 .endd
32113
32114
32115
32116 .section "Scanning MIME parts" "SECTscanmimepart"
32117 .cindex "content scanning" "MIME parts"
32118 .cindex "MIME content scanning"
32119 .oindex "&%acl_smtp_mime%&"
32120 .oindex "&%acl_not_smtp_mime%&"
32121 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
32122 each MIME part of an SMTP message, including multipart types, in the sequence
32123 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
32124 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
32125 options may both refer to the same ACL if you want the same processing in both
32126 cases.
32127
32128 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
32129 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
32130 the case of a non-SMTP message. However, a MIME ACL is called only if the
32131 message contains a &'Content-Type:'& header line. When a call to a MIME
32132 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
32133 result code is sent to the client. In the case of an SMTP message, the
32134 &%acl_smtp_data%& ACL is not called when this happens.
32135
32136 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
32137 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
32138 condition to match against the raw MIME part. You can also use the
32139 &%mime_regex%& condition to match against the decoded MIME part (see section
32140 &<<SECTscanregex>>&).
32141
32142 At the start of a MIME ACL, a number of variables are set from the header
32143 information for the relevant MIME part. These are described below. The contents
32144 of the MIME part are not by default decoded into a disk file except for MIME
32145 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
32146 part into a disk file, you can use the &%decode%& condition. The general
32147 syntax is:
32148 .display
32149 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
32150 .endd
32151 The right hand side is expanded before use. After expansion,
32152 the value can be:
32153
32154 .olist
32155 &"0"& or &"false"&, in which case no decoding is done.
32156 .next
32157 The string &"default"&. In that case, the file is put in the temporary
32158 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
32159 a sequential file name consisting of the message id and a sequence number. The
32160 full path and name is available in &$mime_decoded_filename$& after decoding.
32161 .next
32162 A full path name starting with a slash. If the full name is an existing
32163 directory, it is used as a replacement for the default directory. The filename
32164 is then sequentially assigned. If the path does not exist, it is used as
32165 the full path and file name.
32166 .next
32167 If the string does not start with a slash, it is used as the
32168 filename, and the default path is then used.
32169 .endlist
32170 The &%decode%& condition normally succeeds. It is only false for syntax
32171 errors or unusual circumstances such as memory shortages. You can easily decode
32172 a file with its original, proposed filename using
32173 .code
32174 decode = $mime_filename
32175 .endd
32176 However, you should keep in mind that &$mime_filename$& might contain
32177 anything. If you place files outside of the default path, they are not
32178 automatically unlinked.
32179
32180 For RFC822 attachments (these are messages attached to messages, with a
32181 content-type of &"message/rfc822"&), the ACL is called again in the same manner
32182 as for the primary message, only that the &$mime_is_rfc822$& expansion
32183 variable is set (see below). Attached messages are always decoded to disk
32184 before being checked, and the files are unlinked once the check is done.
32185
32186 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
32187 used to match regular expressions against raw and decoded MIME parts,
32188 respectively. They are described in section &<<SECTscanregex>>&.
32189
32190 .cindex "MIME content scanning" "returned variables"
32191 The following list describes all expansion variables that are
32192 available in the MIME ACL:
32193
32194 .vlist
32195 .vitem &$mime_boundary$&
32196 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
32197 have a boundary string, which is stored in this variable. If the current part
32198 has no boundary parameter in the &'Content-Type:'& header, this variable
32199 contains the empty string.
32200
32201 .vitem &$mime_charset$&
32202 This variable contains the character set identifier, if one was found in the
32203 &'Content-Type:'& header. Examples for charset identifiers are:
32204 .code
32205 us-ascii
32206 gb2312 (Chinese)
32207 iso-8859-1
32208 .endd
32209 Please note that this value is not normalized, so you should do matches
32210 case-insensitively.
32211
32212 .vitem &$mime_content_description$&
32213 This variable contains the normalized content of the &'Content-Description:'&
32214 header. It can contain a human-readable description of the parts content. Some
32215 implementations repeat the filename for attachments here, but they are usually
32216 only used for display purposes.
32217
32218 .vitem &$mime_content_disposition$&
32219 This variable contains the normalized content of the &'Content-Disposition:'&
32220 header. You can expect strings like &"attachment"& or &"inline"& here.
32221
32222 .vitem &$mime_content_id$&
32223 This variable contains the normalized content of the &'Content-ID:'& header.
32224 This is a unique ID that can be used to reference a part from another part.
32225
32226 .vitem &$mime_content_size$&
32227 This variable is set only after the &%decode%& modifier (see above) has been
32228 successfully run. It contains the size of the decoded part in kilobytes. The
32229 size is always rounded up to full kilobytes, so only a completely empty part
32230 has a &$mime_content_size$& of zero.
32231
32232 .vitem &$mime_content_transfer_encoding$&
32233 This variable contains the normalized content of the
32234 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
32235 type. Typical values are &"base64"& and &"quoted-printable"&.
32236
32237 .vitem &$mime_content_type$&
32238 If the MIME part has a &'Content-Type:'& header, this variable contains its
32239 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
32240 are some examples of popular MIME types, as they may appear in this variable:
32241 .code
32242 text/plain
32243 text/html
32244 application/octet-stream
32245 image/jpeg
32246 audio/midi
32247 .endd
32248 If the MIME part has no &'Content-Type:'& header, this variable contains the
32249 empty string.
32250
32251 .vitem &$mime_decoded_filename$&
32252 This variable is set only after the &%decode%& modifier (see above) has been
32253 successfully run. It contains the full path and file name of the file
32254 containing the decoded data.
32255 .endlist
32256
32257 .cindex "RFC 2047"
32258 .vlist
32259 .vitem &$mime_filename$&
32260 This is perhaps the most important of the MIME variables. It contains a
32261 proposed filename for an attachment, if one was found in either the
32262 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
32263 RFC2047
32264 or RFC2231
32265 decoded, but no additional sanity checks are done.
32266  If no filename was
32267 found, this variable contains the empty string.
32268
32269 .vitem &$mime_is_coverletter$&
32270 This variable attempts to differentiate the &"cover letter"& of an e-mail from
32271 attached data. It can be used to clamp down on flashy or unnecessarily encoded
32272 content in the cover letter, while not restricting attachments at all.
32273
32274 The variable contains 1 (true) for a MIME part believed to be part of the
32275 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
32276 follows:
32277
32278 .olist
32279 The outermost MIME part of a message is always a cover letter.
32280
32281 .next
32282 If a multipart/alternative or multipart/related MIME part is a cover letter,
32283 so are all MIME subparts within that multipart.
32284
32285 .next
32286 If any other multipart is a cover letter, the first subpart is a cover letter,
32287 and the rest are attachments.
32288
32289 .next
32290 All parts contained within an attachment multipart are attachments.
32291 .endlist olist
32292
32293 As an example, the following will ban &"HTML mail"& (including that sent with
32294 alternative plain text), while allowing HTML files to be attached. HTML
32295 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
32296 .code
32297 deny message = HTML mail is not accepted here
32298 !condition = $mime_is_rfc822
32299 condition = $mime_is_coverletter
32300 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
32301 .endd
32302 .vitem &$mime_is_multipart$&
32303 This variable has the value 1 (true) when the current part has the main type
32304 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
32305 Since multipart entities only serve as containers for other parts, you may not
32306 want to carry out specific actions on them.
32307
32308 .vitem &$mime_is_rfc822$&
32309 This variable has the value 1 (true) if the current part is not a part of the
32310 checked message itself, but part of an attached message. Attached message
32311 decoding is fully recursive.
32312
32313 .vitem &$mime_part_count$&
32314 This variable is a counter that is raised for each processed MIME part. It
32315 starts at zero for the very first part (which is usually a multipart). The
32316 counter is per-message, so it is reset when processing RFC822 attachments (see
32317 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
32318 complete, so you can use it in the DATA ACL to determine the number of MIME
32319 parts of a message. For non-MIME messages, this variable contains the value -1.
32320 .endlist
32321
32322
32323
32324 .section "Scanning with regular expressions" "SECTscanregex"
32325 .cindex "content scanning" "with regular expressions"
32326 .cindex "regular expressions" "content scanning with"
32327 You can specify your own custom regular expression matches on the full body of
32328 the message, or on individual MIME parts.
32329
32330 The &%regex%& condition takes one or more regular expressions as arguments and
32331 matches them against the full message (when called in the DATA ACL) or a raw
32332 MIME part (when called in the MIME ACL). The &%regex%& condition matches
32333 linewise, with a maximum line length of 32K characters. That means you cannot
32334 have multiline matches with the &%regex%& condition.
32335
32336 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
32337 to 32K of decoded content (the whole content at once, not linewise). If the
32338 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
32339 is decoded automatically when &%mime_regex%& is executed (using default path
32340 and filename values). If the decoded data is larger than  32K, only the first
32341 32K characters are checked.
32342
32343 The regular expressions are passed as a colon-separated list. To include a
32344 literal colon, you must double it. Since the whole right-hand side string is
32345 expanded before being used, you must also escape dollar signs and backslashes
32346 with more backslashes, or use the &`\N`& facility to disable expansion.
32347 Here is a simple example that contains two regular expressions:
32348 .code
32349 deny message = contains blacklisted regex ($regex_match_string)
32350      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
32351 .endd
32352 The conditions returns true if any one of the regular expressions matches. The
32353 &$regex_match_string$& expansion variable is then set up and contains the
32354 matching regular expression.
32355 The expansion variables &$regex1$& &$regex2$& etc
32356 are set to any substrings captured by the regular expression.
32357
32358 &*Warning*&: With large messages, these conditions can be fairly
32359 CPU-intensive.
32360
32361 .ecindex IIDcosca
32362
32363
32364
32365
32366 . ////////////////////////////////////////////////////////////////////////////
32367 . ////////////////////////////////////////////////////////////////////////////
32368
32369 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32370          "Local scan function"
32371 .scindex IIDlosca "&[local_scan()]& function" "description of"
32372 .cindex "customizing" "input scan using C function"
32373 .cindex "policy control" "by local scan function"
32374 In these days of email worms, viruses, and ever-increasing spam, some sites
32375 want to apply a lot of checking to messages before accepting them.
32376
32377 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32378 passing messages to external virus and spam scanning software. You can also do
32379 a certain amount in Exim itself through string expansions and the &%condition%&
32380 condition in the ACL that runs after the SMTP DATA command or the ACL for
32381 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32382
32383 To allow for further customization to a site's own requirements, there is the
32384 possibility of linking Exim with a private message scanning function, written
32385 in C. If you want to run code that is written in something other than C, you
32386 can of course use a little C stub to call it.
32387
32388 The local scan function is run once for every incoming message, at the point
32389 when Exim is just about to accept the message.
32390 It can therefore be used to control non-SMTP messages from local processes as
32391 well as messages arriving via SMTP.
32392
32393 Exim applies a timeout to calls of the local scan function, and there is an
32394 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32395 Zero means &"no timeout"&.
32396 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32397 before calling the local scan function, so that the most common types of crash
32398 are caught. If the timeout is exceeded or one of those signals is caught, the
32399 incoming message is rejected with a temporary error if it is an SMTP message.
32400 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32401 code. The incident is logged on the main and reject logs.
32402
32403
32404
32405 .section "Building Exim to use a local scan function" "SECID207"
32406 .cindex "&[local_scan()]& function" "building Exim to use"
32407 To make use of the local scan function feature, you must tell Exim where your
32408 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32409 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32410 directory, so you might set
32411 .code
32412 LOCAL_SCAN_SOURCE=Local/local_scan.c
32413 .endd
32414 for example. The function must be called &[local_scan()]&. It is called by
32415 Exim after it has received a message, when the success return code is about to
32416 be sent. This is after all the ACLs have been run. The return code from your
32417 function controls whether the message is actually accepted or not. There is a
32418 commented template function (that just accepts the message) in the file
32419 _src/local_scan.c_.
32420
32421 If you want to make use of Exim's run time configuration file to set options
32422 for your &[local_scan()]& function, you must also set
32423 .code
32424 LOCAL_SCAN_HAS_OPTIONS=yes
32425 .endd
32426 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32427
32428
32429
32430
32431 .section "API for local_scan()" "SECTapiforloc"
32432 .cindex "&[local_scan()]& function" "API description"
32433 You must include this line near the start of your code:
32434 .code
32435 #include "local_scan.h"
32436 .endd
32437 This header file defines a number of variables and other values, and the
32438 prototype for the function itself. Exim is coded to use unsigned char values
32439 almost exclusively, and one of the things this header defines is a shorthand
32440 for &`unsigned char`& called &`uschar`&.
32441 It also contains the following macro definitions, to simplify casting character
32442 strings and pointers to character strings:
32443 .code
32444 #define CS   (char *)
32445 #define CCS  (const char *)
32446 #define CSS  (char **)
32447 #define US   (unsigned char *)
32448 #define CUS  (const unsigned char *)
32449 #define USS  (unsigned char **)
32450 .endd
32451 The function prototype for &[local_scan()]& is:
32452 .code
32453 extern int local_scan(int fd, uschar **return_text);
32454 .endd
32455 The arguments are as follows:
32456
32457 .ilist
32458 &%fd%& is a file descriptor for the file that contains the body of the message
32459 (the -D file). The file is open for reading and writing, but updating it is not
32460 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32461
32462 The descriptor is positioned at character 19 of the file, which is the first
32463 character of the body itself, because the first 19 characters are the message
32464 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32465 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32466 case this changes in some future version.
32467 .next
32468 &%return_text%& is an address which you can use to return a pointer to a text
32469 string at the end of the function. The value it points to on entry is NULL.
32470 .endlist
32471
32472 The function must return an &%int%& value which is one of the following macros:
32473
32474 .vlist
32475 .vitem &`LOCAL_SCAN_ACCEPT`&
32476 .vindex "&$local_scan_data$&"
32477 The message is accepted. If you pass back a string of text, it is saved with
32478 the message, and made available in the variable &$local_scan_data$&. No
32479 newlines are permitted (if there are any, they are turned into spaces) and the
32480 maximum length of text is 1000 characters.
32481
32482 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32483 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32484 queued without immediate delivery, and is frozen.
32485
32486 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32487 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32488 queued without immediate delivery.
32489
32490 .vitem &`LOCAL_SCAN_REJECT`&
32491 The message is rejected; the returned text is used as an error message which is
32492 passed back to the sender and which is also logged. Newlines are permitted &--
32493 they cause a multiline response for SMTP rejections, but are converted to
32494 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32495 used.
32496
32497 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32498 The message is temporarily rejected; the returned text is used as an error
32499 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32500 problem"& is used.
32501
32502 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32503 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32504 message is not written to the reject log. It has the effect of unsetting the
32505 &%rejected_header%& log selector for just this rejection. If
32506 &%rejected_header%& is already unset (see the discussion of the
32507 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32508 same as LOCAL_SCAN_REJECT.
32509
32510 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32511 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32512 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32513 .endlist
32514
32515 If the message is not being received by interactive SMTP, rejections are
32516 reported by writing to &%stderr%& or by sending an email, as configured by the
32517 &%-oe%& command line options.
32518
32519
32520
32521 .section "Configuration options for local_scan()" "SECTconoptloc"
32522 .cindex "&[local_scan()]& function" "configuration options"
32523 It is possible to have option settings in the main configuration file
32524 that set values in static variables in the &[local_scan()]& module. If you
32525 want to do this, you must have the line
32526 .code
32527 LOCAL_SCAN_HAS_OPTIONS=yes
32528 .endd
32529 in your &_Local/Makefile_& when you build Exim. (This line is in
32530 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32531 file, you must define static variables to hold the option values, and a table
32532 to define them.
32533
32534 The table must be a vector called &%local_scan_options%&, of type
32535 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32536 and a pointer to the variable that holds the value. The entries must appear in
32537 alphabetical order. Following &%local_scan_options%& you must also define a
32538 variable called &%local_scan_options_count%& that contains the number of
32539 entries in the table. Here is a short example, showing two kinds of option:
32540 .code
32541 static int my_integer_option = 42;
32542 static uschar *my_string_option = US"a default string";
32543
32544 optionlist local_scan_options[] = {
32545   { "my_integer", opt_int,       &my_integer_option },
32546   { "my_string",  opt_stringptr, &my_string_option }
32547 };
32548
32549 int local_scan_options_count =
32550   sizeof(local_scan_options)/sizeof(optionlist);
32551 .endd
32552 The values of the variables can now be changed from Exim's runtime
32553 configuration file by including a local scan section as in this example:
32554 .code
32555 begin local_scan
32556 my_integer = 99
32557 my_string = some string of text...
32558 .endd
32559 The available types of option data are as follows:
32560
32561 .vlist
32562 .vitem &*opt_bool*&
32563 This specifies a boolean (true/false) option. The address should point to a
32564 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32565 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32566 whether such a variable has been set at all, you can initialize it to
32567 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32568 values.)
32569
32570 .vitem &*opt_fixed*&
32571 This specifies a fixed point number, such as is used for load averages.
32572 The address should point to a variable of type &`int`&. The value is stored
32573 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32574
32575 .vitem &*opt_int*&
32576 This specifies an integer; the address should point to a variable of type
32577 &`int`&. The value may be specified in any of the integer formats accepted by
32578 Exim.
32579
32580 .vitem &*opt_mkint*&
32581 This is the same as &%opt_int%&, except that when such a value is output in a
32582 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32583 printed with the suffix K or M.
32584
32585 .vitem &*opt_octint*&
32586 This also specifies an integer, but the value is always interpreted as an
32587 octal integer, whether or not it starts with the digit zero, and it is
32588 always output in octal.
32589
32590 .vitem &*opt_stringptr*&
32591 This specifies a string value; the address must be a pointer to a
32592 variable that points to a string (for example, of type &`uschar *`&).
32593
32594 .vitem &*opt_time*&
32595 This specifies a time interval value. The address must point to a variable of
32596 type &`int`&. The value that is placed there is a number of seconds.
32597 .endlist
32598
32599 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32600 out the values of all the &[local_scan()]& options.
32601
32602
32603
32604 .section "Available Exim variables" "SECID208"
32605 .cindex "&[local_scan()]& function" "available Exim variables"
32606 The header &_local_scan.h_& gives you access to a number of C variables. These
32607 are the only ones that are guaranteed to be maintained from release to release.
32608 Note, however, that you can obtain the value of any Exim expansion variable,
32609 including &$recipients$&, by calling &'expand_string()'&. The exported
32610 C variables are as follows:
32611
32612 .vlist
32613 .vitem &*int&~body_linecount*&
32614 This variable contains the number of lines in the message's body.
32615 It is not valid if the &%spool_files_wireformat%& option is used.
32616
32617 .vitem &*int&~body_zerocount*&
32618 This variable contains the number of binary zero bytes in the message's body.
32619 It is not valid if the &%spool_files_wireformat%& option is used.
32620
32621 .vitem &*unsigned&~int&~debug_selector*&
32622 This variable is set to zero when no debugging is taking place. Otherwise, it
32623 is a bitmap of debugging selectors. Two bits are identified for use in
32624 &[local_scan()]&; they are defined as macros:
32625
32626 .ilist
32627 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32628 testing option that is not privileged &-- any caller may set it. All the
32629 other selector bits can be set only by admin users.
32630
32631 .next
32632 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32633 by the &`+local_scan`& debug selector. It is not included in the default set
32634 of debugging bits.
32635 .endlist ilist
32636
32637 Thus, to write to the debugging output only when &`+local_scan`& has been
32638 selected, you should use code like this:
32639 .code
32640 if ((debug_selector & D_local_scan) != 0)
32641   debug_printf("xxx", ...);
32642 .endd
32643 .vitem &*uschar&~*expand_string_message*&
32644 After a failing call to &'expand_string()'& (returned value NULL), the
32645 variable &%expand_string_message%& contains the error message, zero-terminated.
32646
32647 .vitem &*header_line&~*header_list*&
32648 A pointer to a chain of header lines. The &%header_line%& structure is
32649 discussed below.
32650
32651 .vitem &*header_line&~*header_last*&
32652 A pointer to the last of the header lines.
32653
32654 .vitem &*uschar&~*headers_charset*&
32655 The value of the &%headers_charset%& configuration option.
32656
32657 .vitem &*BOOL&~host_checking*&
32658 This variable is TRUE during a host checking session that is initiated by the
32659 &%-bh%& command line option.
32660
32661 .vitem &*uschar&~*interface_address*&
32662 The IP address of the interface that received the message, as a string. This
32663 is NULL for locally submitted messages.
32664
32665 .vitem &*int&~interface_port*&
32666 The port on which this message was received. When testing with the &%-bh%&
32667 command line option, the value of this variable is -1 unless a port has been
32668 specified via the &%-oMi%& option.
32669
32670 .vitem &*uschar&~*message_id*&
32671 This variable contains Exim's message id for the incoming message (the value of
32672 &$message_exim_id$&) as a zero-terminated string.
32673
32674 .vitem &*uschar&~*received_protocol*&
32675 The name of the protocol by which the message was received.
32676
32677 .vitem &*int&~recipients_count*&
32678 The number of accepted recipients.
32679
32680 .vitem &*recipient_item&~*recipients_list*&
32681 .cindex "recipient" "adding in local scan"
32682 .cindex "recipient" "removing in local scan"
32683 The list of accepted recipients, held in a vector of length
32684 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32685 can add additional recipients by calling &'receive_add_recipient()'& (see
32686 below). You can delete recipients by removing them from the vector and
32687 adjusting the value in &%recipients_count%&. In particular, by setting
32688 &%recipients_count%& to zero you remove all recipients. If you then return the
32689 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32690 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32691 and then call &'receive_add_recipient()'& as often as needed.
32692
32693 .vitem &*uschar&~*sender_address*&
32694 The envelope sender address. For bounce messages this is the empty string.
32695
32696 .vitem &*uschar&~*sender_host_address*&
32697 The IP address of the sending host, as a string. This is NULL for
32698 locally-submitted messages.
32699
32700 .vitem &*uschar&~*sender_host_authenticated*&
32701 The name of the authentication mechanism that was used, or NULL if the message
32702 was not received over an authenticated SMTP connection.
32703
32704 .vitem &*uschar&~*sender_host_name*&
32705 The name of the sending host, if known.
32706
32707 .vitem &*int&~sender_host_port*&
32708 The port on the sending host.
32709
32710 .vitem &*BOOL&~smtp_input*&
32711 This variable is TRUE for all SMTP input, including BSMTP.
32712
32713 .vitem &*BOOL&~smtp_batched_input*&
32714 This variable is TRUE for BSMTP input.
32715
32716 .vitem &*int&~store_pool*&
32717 The contents of this variable control which pool of memory is used for new
32718 requests. See section &<<SECTmemhanloc>>& for details.
32719 .endlist
32720
32721
32722 .section "Structure of header lines" "SECID209"
32723 The &%header_line%& structure contains the members listed below.
32724 You can add additional header lines by calling the &'header_add()'& function
32725 (see below). You can cause header lines to be ignored (deleted) by setting
32726 their type to *.
32727
32728
32729 .vlist
32730 .vitem &*struct&~header_line&~*next*&
32731 A pointer to the next header line, or NULL for the last line.
32732
32733 .vitem &*int&~type*&
32734 A code identifying certain headers that Exim recognizes. The codes are printing
32735 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32736 Notice in particular that any header line whose type is * is not transmitted
32737 with the message. This flagging is used for header lines that have been
32738 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32739 lines.) Effectively, * means &"deleted"&.
32740
32741 .vitem &*int&~slen*&
32742 The number of characters in the header line, including the terminating and any
32743 internal newlines.
32744
32745 .vitem &*uschar&~*text*&
32746 A pointer to the text of the header. It always ends with a newline, followed by
32747 a zero byte. Internal newlines are preserved.
32748 .endlist
32749
32750
32751
32752 .section "Structure of recipient items" "SECID210"
32753 The &%recipient_item%& structure contains these members:
32754
32755 .vlist
32756 .vitem &*uschar&~*address*&
32757 This is a pointer to the recipient address as it was received.
32758
32759 .vitem &*int&~pno*&
32760 This is used in later Exim processing when top level addresses are created by
32761 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32762 and must always contain -1 at this stage.
32763
32764 .vitem &*uschar&~*errors_to*&
32765 If this value is not NULL, bounce messages caused by failing to deliver to the
32766 recipient are sent to the address it contains. In other words, it overrides the
32767 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32768 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32769 an unqualified address, Exim qualifies it using the domain from
32770 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32771 is NULL for all recipients.
32772 .endlist
32773
32774
32775
32776 .section "Available Exim functions" "SECID211"
32777 .cindex "&[local_scan()]& function" "available Exim functions"
32778 The header &_local_scan.h_& gives you access to a number of Exim functions.
32779 These are the only ones that are guaranteed to be maintained from release to
32780 release:
32781
32782 .vlist
32783 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32784        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32785
32786 This function creates a child process that runs the command specified by
32787 &%argv%&. The environment for the process is specified by &%envp%&, which can
32788 be NULL if no environment variables are to be passed. A new umask is supplied
32789 for the process in &%newumask%&.
32790
32791 Pipes to the standard input and output of the new process are set up
32792 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32793 standard error is cloned to the standard output. If there are any file
32794 descriptors &"in the way"& in the new process, they are closed. If the final
32795 argument is TRUE, the new process is made into a process group leader.
32796
32797 The function returns the pid of the new process, or -1 if things go wrong.
32798
32799 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32800 This function waits for a child process to terminate, or for a timeout (in
32801 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32802 return value is as follows:
32803
32804 .ilist
32805 >= 0
32806
32807 The process terminated by a normal exit and the value is the process
32808 ending status.
32809
32810 .next
32811 < 0 and > &--256
32812
32813 The process was terminated by a signal and the value is the negation of the
32814 signal number.
32815
32816 .next
32817 &--256
32818
32819 The process timed out.
32820 .next
32821 &--257
32822
32823 The was some other error in wait(); &%errno%& is still set.
32824 .endlist
32825
32826 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32827 This function provide you with a means of submitting a new message to
32828 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32829 want, but this packages it all up for you.) The function creates a pipe,
32830 forks a subprocess that is running
32831 .code
32832 exim -t -oem -oi -f <>
32833 .endd
32834 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32835 that is connected to the standard input. The yield of the function is the PID
32836 of the subprocess. You can then write a message to the file descriptor, with
32837 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32838
32839 When you have finished, call &'child_close()'& to wait for the process to
32840 finish and to collect its ending status. A timeout value of zero is usually
32841 fine in this circumstance. Unless you have made a mistake with the recipient
32842 addresses, you should get a return code of zero.
32843
32844
32845 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32846        *sender_authentication)*&
32847 This function is a more sophisticated version of &'child_open()'&. The command
32848 that it runs is:
32849 .display
32850 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32851 .endd
32852 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32853
32854
32855 .vitem &*void&~debug_printf(char&~*,&~...)*&
32856 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32857 output is written to the standard error stream. If no debugging is selected,
32858 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32859 conditional on the &`local_scan`& debug selector by coding like this:
32860 .code
32861 if ((debug_selector & D_local_scan) != 0)
32862   debug_printf("xxx", ...);
32863 .endd
32864
32865 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32866 This is an interface to Exim's string expansion code. The return value is the
32867 expanded string, or NULL if there was an expansion failure.
32868 The C variable &%expand_string_message%& contains an error message after an
32869 expansion failure. If expansion does not change the string, the return value is
32870 the pointer to the input string. Otherwise, the return value points to a new
32871 block of memory that was obtained by a call to &'store_get()'&. See section
32872 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32873
32874 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32875 This function allows you to an add additional header line at the end of the
32876 existing ones. The first argument is the type, and should normally be a space
32877 character. The second argument is a format string and any number of
32878 substitution arguments as for &[sprintf()]&. You may include internal newlines
32879 if you want, and you must ensure that the string ends with a newline.
32880
32881 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32882         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32883 This function adds a new header line at a specified point in the header
32884 chain. The header itself is specified as for &'header_add()'&.
32885
32886 If &%name%& is NULL, the new header is added at the end of the chain if
32887 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32888 NULL, the header lines are searched for the first non-deleted header that
32889 matches the name. If one is found, the new header is added before it if
32890 &%after%& is false. If &%after%& is true, the new header is added after the
32891 found header and any adjacent subsequent ones with the same name (even if
32892 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32893 option controls where the header is added. If it is true, addition is at the
32894 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32895 headers, or at the top if there are no &'Received:'& headers, you could use
32896 .code
32897 header_add_at_position(TRUE, US"Received", TRUE,
32898   ' ', "X-xxx: ...");
32899 .endd
32900 Normally, there is always at least one non-deleted &'Received:'& header, but
32901 there may not be if &%received_header_text%& expands to an empty string.
32902
32903
32904 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32905 This function removes header lines. If &%occurrence%& is zero or negative, all
32906 occurrences of the header are removed. If occurrence is greater than zero, that
32907 particular instance of the header is removed. If no header(s) can be found that
32908 match the specification, the function does nothing.
32909
32910
32911 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32912         int&~length,&~BOOL&~notdel)*&"
32913 This function tests whether the given header has the given name. It is not just
32914 a string comparison, because white space is permitted between the name and the
32915 colon. If the &%notdel%& argument is true, a false return is forced for all
32916 &"deleted"& headers; otherwise they are not treated specially. For example:
32917 .code
32918 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32919 .endd
32920 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32921 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32922 This function base64-encodes a string, which is passed by address and length.
32923 The text may contain bytes of any value, including zero. The result is passed
32924 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32925 zero-terminated.
32926
32927 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32928 This function decodes a base64-encoded string. Its arguments are a
32929 zero-terminated base64-encoded string and the address of a variable that is set
32930 to point to the result, which is in dynamic memory. The length of the decoded
32931 string is the yield of the function. If the input is invalid base64 data, the
32932 yield is -1. A zero byte is added to the end of the output string to make it
32933 easy to interpret as a C string (assuming it contains no zeros of its own). The
32934 added zero byte is not included in the returned count.
32935
32936 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32937 This function checks for a match in a domain list. Domains are always
32938 matched caselessly. The return value is one of the following:
32939 .display
32940 &`OK     `& match succeeded
32941 &`FAIL   `& match failed
32942 &`DEFER  `& match deferred
32943 .endd
32944 DEFER is usually caused by some kind of lookup defer, such as the
32945 inability to contact a database.
32946
32947 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32948         BOOL&~caseless)*&"
32949 This function checks for a match in a local part list. The third argument
32950 controls case-sensitivity. The return values are as for
32951 &'lss_match_domain()'&.
32952
32953 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32954         BOOL&~caseless)*&"
32955 This function checks for a match in an address list. The third argument
32956 controls the case-sensitivity of the local part match. The domain is always
32957 matched caselessly. The return values are as for &'lss_match_domain()'&.
32958
32959 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32960         uschar&~*list)*&"
32961 This function checks for a match in a host list. The most common usage is
32962 expected to be
32963 .code
32964 lss_match_host(sender_host_name, sender_host_address, ...)
32965 .endd
32966 .vindex "&$sender_host_address$&"
32967 An empty address field matches an empty item in the host list. If the host name
32968 is NULL, the name corresponding to &$sender_host_address$& is automatically
32969 looked up if a host name is required to match an item in the list. The return
32970 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32971 returns ERROR in the case when it had to look up a host name, but the lookup
32972 failed.
32973
32974 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32975         *format,&~...)*&"
32976 This function writes to Exim's log files. The first argument should be zero (it
32977 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32978 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32979 them. It specifies to which log or logs the message is written. The remaining
32980 arguments are a format and relevant insertion arguments. The string should not
32981 contain any newlines, not even at the end.
32982
32983
32984 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32985 This function adds an additional recipient to the message. The first argument
32986 is the recipient address. If it is unqualified (has no domain), it is qualified
32987 with the &%qualify_recipient%& domain. The second argument must always be -1.
32988
32989 This function does not allow you to specify a private &%errors_to%& address (as
32990 described with the structure of &%recipient_item%& above), because it pre-dates
32991 the addition of that field to the structure. However, it is easy to add such a
32992 value afterwards. For example:
32993 .code
32994  receive_add_recipient(US"monitor@mydom.example", -1);
32995  recipients_list[recipients_count-1].errors_to =
32996    US"postmaster@mydom.example";
32997 .endd
32998
32999 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
33000 This is a convenience function to remove a named recipient from the list of
33001 recipients. It returns true if a recipient was removed, and false if no
33002 matching recipient could be found. The argument must be a complete email
33003 address.
33004 .endlist
33005
33006
33007 .cindex "RFC 2047"
33008 .vlist
33009 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
33010   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
33011 This function decodes strings that are encoded according to RFC 2047. Typically
33012 these are the contents of header lines. First, each &"encoded word"& is decoded
33013 from the Q or B encoding into a byte-string. Then, if provided with the name of
33014 a charset encoding, and if the &[iconv()]& function is available, an attempt is
33015 made  to translate the result to the named character set. If this fails, the
33016 binary string is returned with an error message.
33017
33018 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
33019 maximum MIME word length is enforced. The third argument is the target
33020 encoding, or NULL if no translation is wanted.
33021
33022 .cindex "binary zero" "in RFC 2047 decoding"
33023 .cindex "RFC 2047" "binary zero in"
33024 If a binary zero is encountered in the decoded string, it is replaced by the
33025 contents of the &%zeroval%& argument. For use with Exim headers, the value must
33026 not be 0 because header lines are handled as zero-terminated strings.
33027
33028 The function returns the result of processing the string, zero-terminated; if
33029 &%lenptr%& is not NULL, the length of the result is set in the variable to
33030 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
33031
33032 If an error is encountered, the function returns NULL and uses the &%error%&
33033 argument to return an error message. The variable pointed to by &%error%& is
33034 set to NULL if there is no error; it may be set non-NULL even when the function
33035 returns a non-NULL value if decoding was successful, but there was a problem
33036 with translation.
33037
33038
33039 .vitem &*int&~smtp_fflush(void)*&
33040 This function is used in conjunction with &'smtp_printf()'&, as described
33041 below.
33042
33043 .vitem &*void&~smtp_printf(char&~*,&~...)*&
33044 The arguments of this function are like &[printf()]&; it writes to the SMTP
33045 output stream. You should use this function only when there is an SMTP output
33046 stream, that is, when the incoming message is being received via interactive
33047 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
33048 is FALSE. If you want to test for an incoming message from another host (as
33049 opposed to a local process that used the &%-bs%& command line option), you can
33050 test the value of &%sender_host_address%&, which is non-NULL when a remote host
33051 is involved.
33052
33053 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
33054 output function, so it can be used for all forms of SMTP connection.
33055
33056 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
33057 must start with an appropriate response code: 550 if you are going to return
33058 LOCAL_SCAN_REJECT, 451 if you are going to return
33059 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
33060 initial lines of a multi-line response, the code must be followed by a hyphen
33061 to indicate that the line is not the final response line. You must also ensure
33062 that the lines you write terminate with CRLF. For example:
33063 .code
33064 smtp_printf("550-this is some extra info\r\n");
33065 return LOCAL_SCAN_REJECT;
33066 .endd
33067 Note that you can also create multi-line responses by including newlines in
33068 the data returned via the &%return_text%& argument. The added value of using
33069 &'smtp_printf()'& is that, for instance, you could introduce delays between
33070 multiple output lines.
33071
33072 The &'smtp_printf()'& function does not return any error indication, because it
33073 does not automatically flush pending output, and therefore does not test
33074 the state of the stream. (In the main code of Exim, flushing and error
33075 detection is done when Exim is ready for the next SMTP input command.) If
33076 you want to flush the output and check for an error (for example, the
33077 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
33078 arguments. It flushes the output stream, and returns a non-zero value if there
33079 is an error.
33080
33081 .vitem &*void&~*store_get(int)*&
33082 This function accesses Exim's internal store (memory) manager. It gets a new
33083 chunk of memory whose size is given by the argument. Exim bombs out if it ever
33084 runs out of memory. See the next section for a discussion of memory handling.
33085
33086 .vitem &*void&~*store_get_perm(int)*&
33087 This function is like &'store_get()'&, but it always gets memory from the
33088 permanent pool. See the next section for a discussion of memory handling.
33089
33090 .vitem &*uschar&~*string_copy(uschar&~*string)*&
33091 See below.
33092
33093 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
33094 See below.
33095
33096 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
33097 These three functions create strings using Exim's dynamic memory facilities.
33098 The first makes a copy of an entire string. The second copies up to a maximum
33099 number of characters, indicated by the second argument. The third uses a format
33100 and insertion arguments to create a new string. In each case, the result is a
33101 pointer to a new string in the current memory pool. See the next section for
33102 more discussion.
33103 .endlist
33104
33105
33106
33107 .section "More about Exim's memory handling" "SECTmemhanloc"
33108 .cindex "&[local_scan()]& function" "memory handling"
33109 No function is provided for freeing memory, because that is never needed.
33110 The dynamic memory that Exim uses when receiving a message is automatically
33111 recycled if another message is received by the same process (this applies only
33112 to incoming SMTP connections &-- other input methods can supply only one
33113 message at a time). After receiving the last message, a reception process
33114 terminates.
33115
33116 Because it is recycled, the normal dynamic memory cannot be used for holding
33117 data that must be preserved over a number of incoming messages on the same SMTP
33118 connection. However, Exim in fact uses two pools of dynamic memory; the second
33119 one is not recycled, and can be used for this purpose.
33120
33121 If you want to allocate memory that remains available for subsequent messages
33122 in the same SMTP connection, you should set
33123 .code
33124 store_pool = POOL_PERM
33125 .endd
33126 before calling the function that does the allocation. There is no need to
33127 restore the value if you do not need to; however, if you do want to revert to
33128 the normal pool, you can either restore the previous value of &%store_pool%& or
33129 set it explicitly to POOL_MAIN.
33130
33131 The pool setting applies to all functions that get dynamic memory, including
33132 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
33133 There is also a convenience function called &'store_get_perm()'& that gets a
33134 block of memory from the permanent pool while preserving the value of
33135 &%store_pool%&.
33136 .ecindex IIDlosca
33137
33138
33139
33140
33141 . ////////////////////////////////////////////////////////////////////////////
33142 . ////////////////////////////////////////////////////////////////////////////
33143
33144 .chapter "System-wide message filtering" "CHAPsystemfilter"
33145 .scindex IIDsysfil1 "filter" "system filter"
33146 .scindex IIDsysfil2 "filtering all mail"
33147 .scindex IIDsysfil3 "system filter"
33148 The previous chapters (on ACLs and the local scan function) describe checks
33149 that can be applied to messages before they are accepted by a host. There is
33150 also a mechanism for checking messages once they have been received, but before
33151 they are delivered. This is called the &'system filter'&.
33152
33153 The system filter operates in a similar manner to users' filter files, but it
33154 is run just once per message (however many recipients the message has).
33155 It should not normally be used as a substitute for routing, because &%deliver%&
33156 commands in a system router provide new envelope recipient addresses.
33157 The system filter must be an Exim filter. It cannot be a Sieve filter.
33158
33159 The system filter is run at the start of a delivery attempt, before any routing
33160 is done. If a message fails to be completely delivered at the first attempt,
33161 the system filter is run again at the start of every retry.
33162 If you want your filter to do something only once per message, you can make use
33163 of the &%first_delivery%& condition in an &%if%& command in the filter to
33164 prevent it happening on retries.
33165
33166 .vindex "&$domain$&"
33167 .vindex "&$local_part$&"
33168 &*Warning*&: Because the system filter runs just once, variables that are
33169 specific to individual recipient addresses, such as &$local_part$& and
33170 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
33171 you want to run a centrally-specified filter for each recipient address
33172 independently, you can do so by setting up a suitable &(redirect)& router, as
33173 described in section &<<SECTperaddfil>>& below.
33174
33175
33176 .section "Specifying a system filter" "SECID212"
33177 .cindex "uid (user id)" "system filter"
33178 .cindex "gid (group id)" "system filter"
33179 The name of the file that contains the system filter must be specified by
33180 setting &%system_filter%&. If you want the filter to run under a uid and gid
33181 other than root, you must also set &%system_filter_user%& and
33182 &%system_filter_group%& as appropriate. For example:
33183 .code
33184 system_filter = /etc/mail/exim.filter
33185 system_filter_user = exim
33186 .endd
33187 If a system filter generates any deliveries directly to files or pipes (via the
33188 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
33189 specified by setting &%system_filter_file_transport%& and
33190 &%system_filter_pipe_transport%&, respectively. Similarly,
33191 &%system_filter_reply_transport%& must be set to handle any messages generated
33192 by the &%reply%& command.
33193
33194
33195 .section "Testing a system filter" "SECID213"
33196 You can run simple tests of a system filter in the same way as for a user
33197 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
33198 are permitted only in system filters are recognized.
33199
33200 If you want to test the combined effect of a system filter and a user filter,
33201 you can use both &%-bF%& and &%-bf%& on the same command line.
33202
33203
33204
33205 .section "Contents of a system filter" "SECID214"
33206 The language used to specify system filters is the same as for users' filter
33207 files. It is described in the separate end-user document &'Exim's interface to
33208 mail filtering'&. However, there are some additional features that are
33209 available only in system filters; these are described in subsequent sections.
33210 If they are encountered in a user's filter file or when testing with &%-bf%&,
33211 they cause errors.
33212
33213 .cindex "frozen messages" "manual thaw; testing in filter"
33214 There are two special conditions which, though available in users' filter
33215 files, are designed for use in system filters. The condition &%first_delivery%&
33216 is true only for the first attempt at delivering a message, and
33217 &%manually_thawed%& is true only if the message has been frozen, and
33218 subsequently thawed by an admin user. An explicit forced delivery counts as a
33219 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
33220
33221 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
33222 specify an &"unseen"& (non-significant) delivery, and that delivery does not
33223 succeed, it will not be tried again.
33224 If you want Exim to retry an unseen delivery until it succeeds, you should
33225 arrange to set it up every time the filter runs.
33226
33227 When a system filter finishes running, the values of the variables &$n0$& &--
33228 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
33229 users' filter files. Thus a system filter can, for example, set up &"scores"&
33230 to which users' filter files can refer.
33231
33232
33233
33234 .section "Additional variable for system filters" "SECID215"
33235 .vindex "&$recipients$&"
33236 The expansion variable &$recipients$&, containing a list of all the recipients
33237 of the message (separated by commas and white space), is available in system
33238 filters. It is not available in users' filters for privacy reasons.
33239
33240
33241
33242 .section "Defer, freeze, and fail commands for system filters" "SECID216"
33243 .cindex "freezing messages"
33244 .cindex "message" "freezing"
33245 .cindex "message" "forced failure"
33246 .cindex "&%fail%&" "in system filter"
33247 .cindex "&%freeze%& in system filter"
33248 .cindex "&%defer%& in system filter"
33249 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
33250 always available in system filters, but are not normally enabled in users'
33251 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
33252 for the &(redirect)& router.) These commands can optionally be followed by the
33253 word &%text%& and a string containing an error message, for example:
33254 .code
33255 fail text "this message looks like spam to me"
33256 .endd
33257 The keyword &%text%& is optional if the next character is a double quote.
33258
33259 The &%defer%& command defers delivery of the original recipients of the
33260 message. The &%fail%& command causes all the original recipients to be failed,
33261 and a bounce message to be created. The &%freeze%& command suspends all
33262 delivery attempts for the original recipients. In all cases, any new deliveries
33263 that are specified by the filter are attempted as normal after the filter has
33264 run.
33265
33266 The &%freeze%& command is ignored if the message has been manually unfrozen and
33267 not manually frozen since. This means that automatic freezing by a system
33268 filter can be used as a way of checking out suspicious messages. If a message
33269 is found to be all right, manually unfreezing it allows it to be delivered.
33270
33271 .cindex "log" "&%fail%& command log line"
33272 .cindex "&%fail%&" "log line; reducing"
33273 The text given with a fail command is used as part of the bounce message as
33274 well as being written to the log. If the message is quite long, this can fill
33275 up a lot of log space when such failures are common. To reduce the size of the
33276 log message, Exim interprets the text in a special way if it starts with the
33277 two characters &`<<`& and contains &`>>`& later. The text between these two
33278 strings is written to the log, and the rest of the text is used in the bounce
33279 message. For example:
33280 .code
33281 fail "<<filter test 1>>Your message is rejected \
33282      because it contains attachments that we are \
33283      not prepared to receive."
33284 .endd
33285
33286 .cindex "loop" "caused by &%fail%&"
33287 Take great care with the &%fail%& command when basing the decision to fail on
33288 the contents of the message, because the bounce message will of course include
33289 the contents of the original message and will therefore trigger the &%fail%&
33290 command again (causing a mail loop) unless steps are taken to prevent this.
33291 Testing the &%error_message%& condition is one way to prevent this. You could
33292 use, for example
33293 .code
33294 if $message_body contains "this is spam" and not error_message
33295 then fail text "spam is not wanted here" endif
33296 .endd
33297 though of course that might let through unwanted bounce messages. The
33298 alternative is clever checking of the body and/or headers to detect bounces
33299 generated by the filter.
33300
33301 The interpretation of a system filter file ceases after a
33302 &%defer%&,
33303 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
33304 set up earlier in the filter file are honoured, so you can use a sequence such
33305 as
33306 .code
33307 mail ...
33308 freeze
33309 .endd
33310 to send a specified message when the system filter is freezing (or deferring or
33311 failing) a message. The normal deliveries for the message do not, of course,
33312 take place.
33313
33314
33315
33316 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
33317 .cindex "header lines" "adding; in system filter"
33318 .cindex "header lines" "removing; in system filter"
33319 .cindex "filter" "header lines; adding/removing"
33320 Two filter commands that are available only in system filters are:
33321 .code
33322 headers add <string>
33323 headers remove <string>
33324 .endd
33325 The argument for the &%headers add%& is a string that is expanded and then
33326 added to the end of the message's headers. It is the responsibility of the
33327 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
33328 space is ignored, and if the string is otherwise empty, or if the expansion is
33329 forced to fail, the command has no effect.
33330
33331 You can use &"\n"& within the string, followed by white space, to specify
33332 continued header lines. More than one header may be added in one command by
33333 including &"\n"& within the string without any following white space. For
33334 example:
33335 .code
33336 headers add "X-header-1: ....\n  \
33337              continuation of X-header-1 ...\n\
33338              X-header-2: ...."
33339 .endd
33340 Note that the header line continuation white space after the first newline must
33341 be placed before the backslash that continues the input string, because white
33342 space after input continuations is ignored.
33343
33344 The argument for &%headers remove%& is a colon-separated list of header names.
33345 This command applies only to those headers that are stored with the message;
33346 those that are added at delivery time (such as &'Envelope-To:'& and
33347 &'Return-Path:'&) cannot be removed by this means. If there is more than one
33348 header with the same name, they are all removed.
33349
33350 The &%headers%& command in a system filter makes an immediate change to the set
33351 of header lines that was received with the message (with possible additions
33352 from ACL processing). Subsequent commands in the system filter operate on the
33353 modified set, which also forms the basis for subsequent message delivery.
33354 Unless further modified during routing or transporting, this set of headers is
33355 used for all recipients of the message.
33356
33357 During routing and transporting, the variables that refer to the contents of
33358 header lines refer only to those lines that are in this set. Thus, header lines
33359 that are added by a system filter are visible to users' filter files and to all
33360 routers and transports. This contrasts with the manipulation of header lines by
33361 routers and transports, which is not immediate, but which instead is saved up
33362 until the message is actually being written (see section
33363 &<<SECTheadersaddrem>>&).
33364
33365 If the message is not delivered at the first attempt, header lines that were
33366 added by the system filter are stored with the message, and so are still
33367 present at the next delivery attempt. Header lines that were removed are still
33368 present, but marked &"deleted"& so that they are not transported with the
33369 message. For this reason, it is usual to make the &%headers%& command
33370 conditional on &%first_delivery%& so that the set of header lines is not
33371 modified more than once.
33372
33373 Because header modification in a system filter acts immediately, you have to
33374 use an indirect approach if you want to modify the contents of a header line.
33375 For example:
33376 .code
33377 headers add "Old-Subject: $h_subject:"
33378 headers remove "Subject"
33379 headers add "Subject: new subject (was: $h_old-subject:)"
33380 headers remove "Old-Subject"
33381 .endd
33382
33383
33384
33385 .section "Setting an errors address in a system filter" "SECID217"
33386 .cindex "envelope sender"
33387 In a system filter, if a &%deliver%& command is followed by
33388 .code
33389 errors_to <some address>
33390 .endd
33391 in order to change the envelope sender (and hence the error reporting) for that
33392 delivery, any address may be specified. (In a user filter, only the current
33393 user's address can be set.) For example, if some mail is being monitored, you
33394 might use
33395 .code
33396 unseen deliver monitor@spying.example errors_to root@local.example
33397 .endd
33398 to take a copy which would not be sent back to the normal error reporting
33399 address if its delivery failed.
33400
33401
33402
33403 .section "Per-address filtering" "SECTperaddfil"
33404 .vindex "&$domain$&"
33405 .vindex "&$local_part$&"
33406 In contrast to the system filter, which is run just once per message for each
33407 delivery attempt, it is also possible to set up a system-wide filtering
33408 operation that runs once for each recipient address. In this case, variables
33409 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33410 filter file could be made dependent on them. This is an example of a router
33411 which implements such a filter:
33412 .code
33413 central_filter:
33414   check_local_user
33415   driver = redirect
33416   domains = +local_domains
33417   file = /central/filters/$local_part
33418   no_verify
33419   allow_filter
33420   allow_freeze
33421 .endd
33422 The filter is run in a separate process under its own uid. Therefore, either
33423 &%check_local_user%& must be set (as above), in which case the filter is run as
33424 the local user, or the &%user%& option must be used to specify which user to
33425 use. If both are set, &%user%& overrides.
33426
33427 Care should be taken to ensure that none of the commands in the filter file
33428 specify a significant delivery if the message is to go on to be delivered to
33429 its intended recipient. The router will not then claim to have dealt with the
33430 address, so it will be passed on to subsequent routers to be delivered in the
33431 normal way.
33432 .ecindex IIDsysfil1
33433 .ecindex IIDsysfil2
33434 .ecindex IIDsysfil3
33435
33436
33437
33438
33439
33440
33441 . ////////////////////////////////////////////////////////////////////////////
33442 . ////////////////////////////////////////////////////////////////////////////
33443
33444 .chapter "Message processing" "CHAPmsgproc"
33445 .scindex IIDmesproc "message" "general processing"
33446 Exim performs various transformations on the sender and recipient addresses of
33447 all messages that it handles, and also on the messages' header lines. Some of
33448 these are optional and configurable, while others always take place. All of
33449 this processing, except rewriting as a result of routing, and the addition or
33450 removal of header lines while delivering, happens when a message is received,
33451 before it is placed on Exim's queue.
33452
33453 Some of the automatic processing takes place by default only for
33454 &"locally-originated"& messages. This adjective is used to describe messages
33455 that are not received over TCP/IP, but instead are passed to an Exim process on
33456 its standard input. This includes the interactive &"local SMTP"& case that is
33457 set up by the &%-bs%& command line option.
33458
33459 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33460 or ::1) are not considered to be locally-originated. Exim does not treat the
33461 loopback interface specially in any way.
33462
33463 If you want the loopback interface to be treated specially, you must ensure
33464 that there are appropriate entries in your ACLs.
33465
33466
33467
33468
33469 .section "Submission mode for non-local messages" "SECTsubmodnon"
33470 .cindex "message" "submission"
33471 .cindex "submission mode"
33472 Processing that happens automatically for locally-originated messages (unless
33473 &%suppress_local_fixups%& is set) can also be requested for messages that are
33474 received over TCP/IP. The term &"submission mode"& is used to describe this
33475 state. Submission mode is set by the modifier
33476 .code
33477 control = submission
33478 .endd
33479 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33480 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33481 a local submission, and is normally used when the source of the message is
33482 known to be an MUA running on a client host (as opposed to an MTA). For
33483 example, to set submission mode for messages originating on the IPv4 loopback
33484 interface, you could include the following in the MAIL ACL:
33485 .code
33486 warn  hosts = 127.0.0.1
33487       control = submission
33488 .endd
33489 .cindex "&%sender_retain%& submission option"
33490 There are some options that can be used when setting submission mode. A slash
33491 is used to separate options. For example:
33492 .code
33493 control = submission/sender_retain
33494 .endd
33495 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33496 true and &%local_from_check%& false for the current incoming message. The first
33497 of these allows an existing &'Sender:'& header in the message to remain, and
33498 the second suppresses the check to ensure that &'From:'& matches the
33499 authenticated sender. With this setting, Exim still fixes up messages by adding
33500 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33501 attempt to check sender authenticity in header lines.
33502
33503 When &%sender_retain%& is not set, a submission mode setting may specify a
33504 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33505 example:
33506 .code
33507 control = submission/domain=some.domain
33508 .endd
33509 The domain may be empty. How this value is used is described in sections
33510 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33511 that allows you to specify the user's full name for inclusion in a created
33512 &'Sender:'& or &'From:'& header line. For example:
33513 .code
33514 accept authenticated = *
33515        control = submission/domain=wonderland.example/\
33516                             name=${lookup {$authenticated_id} \
33517                                    lsearch {/etc/exim/namelist}}
33518 .endd
33519 Because the name may contain any characters, including slashes, the &%name%&
33520 option must be given last. The remainder of the string is used as the name. For
33521 the example above, if &_/etc/exim/namelist_& contains:
33522 .code
33523 bigegg:  Humpty Dumpty
33524 .endd
33525 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33526 line would be:
33527 .code
33528 Sender: Humpty Dumpty <bigegg@wonderland.example>
33529 .endd
33530 .cindex "return path" "in submission mode"
33531 By default, submission mode forces the return path to the same address as is
33532 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33533 specified, the return path is also left unchanged.
33534
33535 &*Note*&: The changes caused by submission mode take effect after the predata
33536 ACL. This means that any sender checks performed before the fix-ups use the
33537 untrusted sender address specified by the user, not the trusted sender address
33538 specified by submission mode. Although this might be slightly unexpected, it
33539 does mean that you can configure ACL checks to spot that a user is trying to
33540 spoof another's address.
33541
33542 .section "Line endings" "SECTlineendings"
33543 .cindex "line endings"
33544 .cindex "carriage return"
33545 .cindex "linefeed"
33546 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33547 linefeed) is the line ending for messages transmitted over the Internet using
33548 SMTP over TCP/IP. However, within individual operating systems, different
33549 conventions are used. For example, Unix-like systems use just LF, but others
33550 use CRLF or just CR.
33551
33552 Exim was designed for Unix-like systems, and internally, it stores messages
33553 using the system's convention of a single LF as a line terminator. When
33554 receiving a message, all line endings are translated to this standard format.
33555 Originally, it was thought that programs that passed messages directly to an
33556 MTA within an operating system would use that system's convention. Experience
33557 has shown that this is not the case; for example, there are Unix applications
33558 that use CRLF in this circumstance. For this reason, and for compatibility with
33559 other MTAs, the way Exim handles line endings for all messages is now as
33560 follows:
33561
33562 .ilist
33563 LF not preceded by CR is treated as a line ending.
33564 .next
33565 CR is treated as a line ending; if it is immediately followed by LF, the LF
33566 is ignored.
33567 .next
33568 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33569 nor a local message in the state where a line containing only a dot is a
33570 terminator.
33571 .next
33572 If a bare CR is encountered within a header line, an extra space is added after
33573 the line terminator so as not to end the header line. The reasoning behind this
33574 is that bare CRs in header lines are most likely either to be mistakes, or
33575 people trying to play silly games.
33576 .next
33577 If the first header line received in a message ends with CRLF, a subsequent
33578 bare LF in a header line is treated in the same way as a bare CR in a header
33579 line.
33580 .endlist
33581
33582
33583
33584
33585
33586 .section "Unqualified addresses" "SECID218"
33587 .cindex "unqualified addresses"
33588 .cindex "address" "qualification"
33589 By default, Exim expects every envelope address it receives from an external
33590 host to be fully qualified. Unqualified addresses cause negative responses to
33591 SMTP commands. However, because SMTP is used as a means of transporting
33592 messages from MUAs running on personal workstations, there is sometimes a
33593 requirement to accept unqualified addresses from specific hosts or IP networks.
33594
33595 Exim has two options that separately control which hosts may send unqualified
33596 sender or recipient addresses in SMTP commands, namely
33597 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33598 cases, if an unqualified address is accepted, it is qualified by adding the
33599 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33600
33601 .oindex "&%qualify_domain%&"
33602 .oindex "&%qualify_recipient%&"
33603 Unqualified addresses in header lines are automatically qualified for messages
33604 that are locally originated, unless the &%-bnq%& option is given on the command
33605 line. For messages received over SMTP, unqualified addresses in header lines
33606 are qualified only if unqualified addresses are permitted in SMTP commands. In
33607 other words, such qualification is also controlled by
33608 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33609
33610
33611
33612
33613 .section "The UUCP From line" "SECID219"
33614 .cindex "&""From""& line"
33615 .cindex "UUCP" "&""From""& line"
33616 .cindex "sender" "address"
33617 .oindex "&%uucp_from_pattern%&"
33618 .oindex "&%uucp_from_sender%&"
33619 .cindex "envelope sender"
33620 .cindex "Sendmail compatibility" "&""From""& line"
33621 Messages that have come from UUCP (and some other applications) often begin
33622 with a line containing the envelope sender and a timestamp, following the word
33623 &"From"&. Examples of two common formats are:
33624 .code
33625 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33626 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33627 .endd
33628 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33629 Exim recognizes such lines at the start of messages that are submitted to it
33630 via the command line (that is, on the standard input). It does not recognize
33631 such lines in incoming SMTP messages, unless the sending host matches
33632 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33633 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33634 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33635 default value matches the two common cases shown above and puts the address
33636 that follows &"From"& into &$1$&.
33637
33638 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33639 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33640 a trusted user, the message's sender address is constructed by expanding the
33641 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33642 then parsed as an RFC 2822 address. If there is no domain, the local part is
33643 qualified with &%qualify_domain%& unless it is the empty string. However, if
33644 the command line &%-f%& option is used, it overrides the &"From"& line.
33645
33646 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33647 sender address is not changed. This is also the case for incoming SMTP messages
33648 that are permitted to contain &"From"& lines.
33649
33650 Only one &"From"& line is recognized. If there is more than one, the second is
33651 treated as a data line that starts the body of the message, as it is not valid
33652 as a header line. This also happens if a &"From"& line is present in an
33653 incoming SMTP message from a source that is not permitted to send them.
33654
33655
33656
33657 .section "Resent- header lines" "SECID220"
33658 .cindex "&%Resent-%& header lines"
33659 .cindex "header lines" "Resent-"
33660 RFC 2822 makes provision for sets of header lines starting with the string
33661 &`Resent-`& to be added to a message when it is resent by the original
33662 recipient to somebody else. These headers are &'Resent-Date:'&,
33663 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33664 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33665
33666 .blockquote
33667 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33668 processing of replies or other such automatic actions on messages.'&
33669 .endblockquote
33670
33671 This leaves things a bit vague as far as other processing actions such as
33672 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33673 follows:
33674
33675 .ilist
33676 A &'Resent-From:'& line that just contains the login id of the submitting user
33677 is automatically rewritten in the same way as &'From:'& (see below).
33678 .next
33679 If there's a rewriting rule for a particular header line, it is also applied to
33680 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33681 &'From:'& also rewrites &'Resent-From:'&.
33682 .next
33683 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33684 also removed.
33685 .next
33686 For a locally-submitted message,
33687 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33688 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33689 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33690 included in log lines in this case.
33691 .next
33692 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33693 &%Resent-%& header lines are present.
33694 .endlist
33695
33696
33697
33698
33699 .section "The Auto-Submitted: header line" "SECID221"
33700 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33701 includes the header line:
33702 .code
33703 Auto-Submitted: auto-replied
33704 .endd
33705
33706 .section "The Bcc: header line" "SECID222"
33707 .cindex "&'Bcc:'& header line"
33708 If Exim is called with the &%-t%& option, to take recipient addresses from a
33709 message's header, it removes any &'Bcc:'& header line that may exist (after
33710 extracting its addresses). If &%-t%& is not present on the command line, any
33711 existing &'Bcc:'& is not removed.
33712
33713
33714 .section "The Date: header line" "SECID223"
33715 .cindex "&'Date:'& header line"
33716 .cindex "header lines" "Date:"
33717 If a locally-generated or submission-mode message has no &'Date:'& header line,
33718 Exim adds one, using the current date and time, unless the
33719 &%suppress_local_fixups%& control has been specified.
33720
33721 .section "The Delivery-date: header line" "SECID224"
33722 .cindex "&'Delivery-date:'& header line"
33723 .oindex "&%delivery_date_remove%&"
33724 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33725 set. Exim can be configured to add them to the final delivery of messages. (See
33726 the generic &%delivery_date_add%& transport option.) They should not be present
33727 in messages in transit. If the &%delivery_date_remove%& configuration option is
33728 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33729 messages.
33730
33731
33732 .section "The Envelope-to: header line" "SECID225"
33733 .cindex "&'Envelope-to:'& header line"
33734 .cindex "header lines" "Envelope-to:"
33735 .oindex "&%envelope_to_remove%&"
33736 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33737 Exim can be configured to add them to the final delivery of messages. (See the
33738 generic &%envelope_to_add%& transport option.) They should not be present in
33739 messages in transit. If the &%envelope_to_remove%& configuration option is set
33740 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33741 messages.
33742
33743
33744 .section "The From: header line" "SECTthefrohea"
33745 .cindex "&'From:'& header line"
33746 .cindex "header lines" "From:"
33747 .cindex "Sendmail compatibility" "&""From""& line"
33748 .cindex "message" "submission"
33749 .cindex "submission mode"
33750 If a submission-mode message does not contain a &'From:'& header line, Exim
33751 adds one if either of the following conditions is true:
33752
33753 .ilist
33754 The envelope sender address is not empty (that is, this is not a bounce
33755 message). The added header line copies the envelope sender address.
33756 .next
33757 .vindex "&$authenticated_id$&"
33758 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33759 .olist
33760 .vindex "&$qualify_domain$&"
33761 If no domain is specified by the submission control, the local part is
33762 &$authenticated_id$& and the domain is &$qualify_domain$&.
33763 .next
33764 If a non-empty domain is specified by the submission control, the local
33765 part is &$authenticated_id$&, and the domain is the specified domain.
33766 .next
33767 If an empty domain is specified by the submission control,
33768 &$authenticated_id$& is assumed to be the complete address.
33769 .endlist
33770 .endlist
33771
33772 A non-empty envelope sender takes precedence.
33773
33774 If a locally-generated incoming message does not contain a &'From:'& header
33775 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33776 containing the sender's address. The calling user's login name and full name
33777 are used to construct the address, as described in section &<<SECTconstr>>&.
33778 They are obtained from the password data by calling &[getpwuid()]& (but see the
33779 &%unknown_login%& configuration option). The address is qualified with
33780 &%qualify_domain%&.
33781
33782 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33783 &'From:'& header line containing just the unqualified login name of the calling
33784 user, this is replaced by an address containing the user's login name and full
33785 name as described in section &<<SECTconstr>>&.
33786
33787
33788 .section "The Message-ID: header line" "SECID226"
33789 .cindex "&'Message-ID:'& header line"
33790 .cindex "header lines" "Message-ID:"
33791 .cindex "message" "submission"
33792 .oindex "&%message_id_header_text%&"
33793 If a locally-generated or submission-mode incoming message does not contain a
33794 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33795 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33796 to the message. If there are any &'Resent-:'& headers in the message, it
33797 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33798 message id, preceded by the letter E to ensure it starts with a letter, and
33799 followed by @ and the primary host name. Additional information can be included
33800 in this header line by setting the &%message_id_header_text%& and/or
33801 &%message_id_header_domain%& options.
33802
33803
33804 .section "The Received: header line" "SECID227"
33805 .cindex "&'Received:'& header line"
33806 .cindex "header lines" "Received:"
33807 A &'Received:'& header line is added at the start of every message. The
33808 contents are defined by the &%received_header_text%& configuration option, and
33809 Exim automatically adds a semicolon and a timestamp to the configured string.
33810
33811 The &'Received:'& header is generated as soon as the message's header lines
33812 have been received. At this stage, the timestamp in the &'Received:'& header
33813 line is the time that the message started to be received. This is the value
33814 that is seen by the DATA ACL and by the &[local_scan()]& function.
33815
33816 Once a message is accepted, the timestamp in the &'Received:'& header line is
33817 changed to the time of acceptance, which is (apart from a small delay while the
33818 -H spool file is written) the earliest time at which delivery could start.
33819
33820
33821 .section "The References: header line" "SECID228"
33822 .cindex "&'References:'& header line"
33823 .cindex "header lines" "References:"
33824 Messages created by the &(autoreply)& transport include a &'References:'&
33825 header line. This is constructed according to the rules that are described in
33826 section 3.64 of RFC 2822 (which states that replies should contain such a
33827 header line), and section 3.14 of RFC 3834 (which states that automatic
33828 responses are not different in this respect). However, because some mail
33829 processing software does not cope well with very long header lines, no more
33830 than 12 message IDs are copied from the &'References:'& header line in the
33831 incoming message. If there are more than 12, the first one and then the final
33832 11 are copied, before adding the message ID of the incoming message.
33833
33834
33835
33836 .section "The Return-path: header line" "SECID229"
33837 .cindex "&'Return-path:'& header line"
33838 .cindex "header lines" "Return-path:"
33839 .oindex "&%return_path_remove%&"
33840 &'Return-path:'& header lines are defined as something an MTA may insert when
33841 it does the final delivery of messages. (See the generic &%return_path_add%&
33842 transport option.) Therefore, they should not be present in messages in
33843 transit. If the &%return_path_remove%& configuration option is set (the
33844 default), Exim removes &'Return-path:'& header lines from incoming messages.
33845
33846
33847
33848 .section "The Sender: header line" "SECTthesenhea"
33849 .cindex "&'Sender:'& header line"
33850 .cindex "message" "submission"
33851 .cindex "header lines" "Sender:"
33852 For a locally-originated message from an untrusted user, Exim may remove an
33853 existing &'Sender:'& header line, and it may add a new one. You can modify
33854 these actions by setting the &%local_sender_retain%& option true, the
33855 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33856 control setting.
33857
33858 When a local message is received from an untrusted user and
33859 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33860 control has not been set, a check is made to see if the address given in the
33861 &'From:'& header line is the correct (local) sender of the message. The address
33862 that is expected has the login name as the local part and the value of
33863 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33864 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33865 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33866 line is added to the message.
33867
33868 If you set &%local_from_check%& false, this checking does not occur. However,
33869 the removal of an existing &'Sender:'& line still happens, unless you also set
33870 &%local_sender_retain%& to be true. It is not possible to set both of these
33871 options true at the same time.
33872
33873 .cindex "submission mode"
33874 By default, no processing of &'Sender:'& header lines is done for messages
33875 received over TCP/IP or for messages submitted by trusted users. However, when
33876 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33877 not specified on the submission control, the following processing takes place:
33878
33879 .vindex "&$authenticated_id$&"
33880 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33881 authenticated, and &$authenticated_id$& is not empty, a sender address is
33882 created as follows:
33883
33884 .ilist
33885 .vindex "&$qualify_domain$&"
33886 If no domain is specified by the submission control, the local part is
33887 &$authenticated_id$& and the domain is &$qualify_domain$&.
33888 .next
33889 If a non-empty domain is specified by the submission control, the local part
33890 is &$authenticated_id$&, and the domain is the specified domain.
33891 .next
33892 If an empty domain is specified by the submission control,
33893 &$authenticated_id$& is assumed to be the complete address.
33894 .endlist
33895
33896 This address is compared with the address in the &'From:'& header line. If they
33897 are different, a &'Sender:'& header line containing the created address is
33898 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33899 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33900
33901 .cindex "return path" "created from &'Sender:'&"
33902 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33903 the message (the envelope sender address) is changed to be the same address,
33904 except in the case of submission mode when &%sender_retain%& is specified.
33905
33906
33907
33908 .section "Adding and removing header lines in routers and transports" &&&
33909          "SECTheadersaddrem"
33910 .cindex "header lines" "adding; in router or transport"
33911 .cindex "header lines" "removing; in router or transport"
33912 When a message is delivered, the addition and removal of header lines can be
33913 specified in a system filter, or on any of the routers and transports that
33914 process the message. Section &<<SECTaddremheasys>>& contains details about
33915 modifying headers in a system filter. Header lines can also be added in an ACL
33916 as a message is received (see section &<<SECTaddheadacl>>&).
33917
33918 In contrast to what happens in a system filter, header modifications that are
33919 specified on routers and transports apply only to the particular recipient
33920 addresses that are being processed by those routers and transports. These
33921 changes do not actually take place until a copy of the message is being
33922 transported. Therefore, they do not affect the basic set of header lines, and
33923 they do not affect the values of the variables that refer to header lines.
33924
33925 &*Note*&: In particular, this means that any expansions in the configuration of
33926 the transport cannot refer to the modified header lines, because such
33927 expansions all occur before the message is actually transported.
33928
33929 For both routers and transports, the argument of a &%headers_add%&
33930 option must be in the form of one or more RFC 2822 header lines, separated by
33931 newlines (coded as &"\n"&). For example:
33932 .code
33933 headers_add = X-added-header: added by $primary_hostname\n\
33934               X-added-second: another added header line
33935 .endd
33936 Exim does not check the syntax of these added header lines.
33937
33938 Multiple &%headers_add%& options for a single router or transport can be
33939 specified; the values will append to a single list of header lines.
33940 Each header-line is separately expanded.
33941
33942 The argument of a &%headers_remove%& option must consist of a colon-separated
33943 list of header names. This is confusing, because header names themselves are
33944 often terminated by colons. In this case, the colons are the list separators,
33945 not part of the names. For example:
33946 .code
33947 headers_remove = return-receipt-to:acknowledge-to
33948 .endd
33949
33950 Multiple &%headers_remove%& options for a single router or transport can be
33951 specified; the arguments will append to a single header-names list.
33952 Each item is separately expanded.
33953 Note that colons in complex expansions which are used to
33954 form all or part of a &%headers_remove%& list
33955 will act as list separators.
33956
33957 When &%headers_add%& or &%headers_remove%& is specified on a router,
33958 items are expanded at routing time,
33959 and then associated with all addresses that are
33960 accepted by that router, and also with any new addresses that it generates. If
33961 an address passes through several routers as a result of aliasing or
33962 forwarding, the changes are cumulative.
33963
33964 .oindex "&%unseen%&"
33965 However, this does not apply to multiple routers that result from the use of
33966 the &%unseen%& option. Any header modifications that were specified by the
33967 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33968
33969 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33970 settings cannot be delivered together in a batch, so a transport is always
33971 dealing with a set of addresses that have the same header-processing
33972 requirements.
33973
33974 The transport starts by writing the original set of header lines that arrived
33975 with the message, possibly modified by the system filter. As it writes out
33976 these lines, it consults the list of header names that were attached to the
33977 recipient address(es) by &%headers_remove%& options in routers, and it also
33978 consults the transport's own &%headers_remove%& option. Header lines whose
33979 names are on either of these lists are not written out. If there are multiple
33980 instances of any listed header, they are all skipped.
33981
33982 After the remaining original header lines have been written, new header
33983 lines that were specified by routers' &%headers_add%& options are written, in
33984 the order in which they were attached to the address. These are followed by any
33985 header lines specified by the transport's &%headers_add%& option.
33986
33987 This way of handling header line modifications in routers and transports has
33988 the following consequences:
33989
33990 .ilist
33991 The original set of header lines, possibly modified by the system filter,
33992 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33993 to it, at all times.
33994 .next
33995 Header lines that are added by a router's
33996 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33997 expansion syntax in subsequent routers or the transport.
33998 .next
33999 Conversely, header lines that are specified for removal by &%headers_remove%&
34000 in a router remain visible to subsequent routers and the transport.
34001 .next
34002 Headers added to an address by &%headers_add%& in a router cannot be removed by
34003 a later router or by a transport.
34004 .next
34005 An added header can refer to the contents of an original header that is to be
34006 removed, even it has the same name as the added header. For example:
34007 .code
34008 headers_remove = subject
34009 headers_add = Subject: new subject (was: $h_subject:)
34010 .endd
34011 .endlist
34012
34013 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
34014 for a &(redirect)& router that has the &%one_time%& option set.
34015
34016
34017
34018
34019
34020 .section "Constructed addresses" "SECTconstr"
34021 .cindex "address" "constructed"
34022 .cindex "constructed address"
34023 When Exim constructs a sender address for a locally-generated message, it uses
34024 the form
34025 .display
34026 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
34027 .endd
34028 For example:
34029 .code
34030 Zaphod Beeblebrox <zaphod@end.univ.example>
34031 .endd
34032 The user name is obtained from the &%-F%& command line option if set, or
34033 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
34034 &"gecos"& field from the password entry. If the &"gecos"& field contains an
34035 ampersand character, this is replaced by the login name with the first letter
34036 upper cased, as is conventional in a number of operating systems. See the
34037 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
34038 The &%unknown_username%& option can be used to specify user names in cases when
34039 there is no password file entry.
34040
34041 .cindex "RFC 2047"
34042 In all cases, the user name is made to conform to RFC 2822 by quoting all or
34043 parts of it if necessary. In addition, if it contains any non-printing
34044 characters, it is encoded as described in RFC 2047, which defines a way of
34045 including non-ASCII characters in header lines. The value of the
34046 &%headers_charset%& option specifies the name of the encoding that is used (the
34047 characters are assumed to be in this encoding). The setting of
34048 &%print_topbitchars%& controls whether characters with the top bit set (that
34049 is, with codes greater than 127) count as printing characters or not.
34050
34051
34052
34053 .section "Case of local parts" "SECID230"
34054 .cindex "case of local parts"
34055 .cindex "local part" "case of"
34056 RFC 2822 states that the case of letters in the local parts of addresses cannot
34057 be assumed to be non-significant. Exim preserves the case of local parts of
34058 addresses, but by default it uses a lower-cased form when it is routing,
34059 because on most Unix systems, usernames are in lower case and case-insensitive
34060 routing is required. However, any particular router can be made to use the
34061 original case for local parts by setting the &%caseful_local_part%& generic
34062 router option.
34063
34064 .cindex "mixed-case login names"
34065 If you must have mixed-case user names on your system, the best way to proceed,
34066 assuming you want case-independent handling of incoming email, is to set up
34067 your first router to convert incoming local parts in your domains to the
34068 correct case by means of a file lookup. For example:
34069 .code
34070 correct_case:
34071   driver = redirect
34072   domains = +local_domains
34073   data = ${lookup{$local_part}cdb\
34074               {/etc/usercased.cdb}{$value}fail}\
34075               @$domain
34076 .endd
34077 For this router, the local part is forced to lower case by the default action
34078 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
34079 up a new local part in the correct case. If you then set &%caseful_local_part%&
34080 on any subsequent routers which process your domains, they will operate on
34081 local parts with the correct case in a case-sensitive manner.
34082
34083
34084
34085 .section "Dots in local parts" "SECID231"
34086 .cindex "dot" "in local part"
34087 .cindex "local part" "dots in"
34088 RFC 2822 forbids empty components in local parts. That is, an unquoted local
34089 part may not begin or end with a dot, nor have two consecutive dots in the
34090 middle. However, it seems that many MTAs do not enforce this, so Exim permits
34091 empty components for compatibility.
34092
34093
34094
34095 .section "Rewriting addresses" "SECID232"
34096 .cindex "rewriting" "addresses"
34097 Rewriting of sender and recipient addresses, and addresses in headers, can
34098 happen automatically, or as the result of configuration options, as described
34099 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
34100 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
34101
34102 Automatic rewriting includes qualification, as mentioned above. The other case
34103 in which it can happen is when an incomplete non-local domain is given. The
34104 routing process may cause this to be expanded into the full domain name. For
34105 example, a header such as
34106 .code
34107 To: hare@teaparty
34108 .endd
34109 might get rewritten as
34110 .code
34111 To: hare@teaparty.wonderland.fict.example
34112 .endd
34113 Rewriting as a result of routing is the one kind of message processing that
34114 does not happen at input time, as it cannot be done until the address has
34115 been routed.
34116
34117 Strictly, one should not do &'any'& deliveries of a message until all its
34118 addresses have been routed, in case any of the headers get changed as a
34119 result of routing. However, doing this in practice would hold up many
34120 deliveries for unreasonable amounts of time, just because one address could not
34121 immediately be routed. Exim therefore does not delay other deliveries when
34122 routing of one or more addresses is deferred.
34123 .ecindex IIDmesproc
34124
34125
34126
34127 . ////////////////////////////////////////////////////////////////////////////
34128 . ////////////////////////////////////////////////////////////////////////////
34129
34130 .chapter "SMTP processing" "CHAPSMTP"
34131 .scindex IIDsmtpproc1 "SMTP" "processing details"
34132 .scindex IIDsmtpproc2 "LMTP" "processing details"
34133 Exim supports a number of different ways of using the SMTP protocol, and its
34134 LMTP variant, which is an interactive protocol for transferring messages into a
34135 closed mail store application. This chapter contains details of how SMTP is
34136 processed. For incoming mail, the following are available:
34137
34138 .ilist
34139 SMTP over TCP/IP (Exim daemon or &'inetd'&);
34140 .next
34141 SMTP over the standard input and output (the &%-bs%& option);
34142 .next
34143 Batched SMTP on the standard input (the &%-bS%& option).
34144 .endlist
34145
34146 For mail delivery, the following are available:
34147
34148 .ilist
34149 SMTP over TCP/IP (the &(smtp)& transport);
34150 .next
34151 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
34152 &"lmtp"&);
34153 .next
34154 LMTP over a pipe to a process running in the local host (the &(lmtp)&
34155 transport);
34156 .next
34157 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
34158 the &%use_bsmtp%& option set).
34159 .endlist
34160
34161 &'Batched SMTP'& is the name for a process in which batches of messages are
34162 stored in or read from files (or pipes), in a format in which SMTP commands are
34163 used to contain the envelope information.
34164
34165
34166
34167 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
34168 .cindex "SMTP" "outgoing over TCP/IP"
34169 .cindex "outgoing SMTP over TCP/IP"
34170 .cindex "LMTP" "over TCP/IP"
34171 .cindex "outgoing LMTP over TCP/IP"
34172 .cindex "EHLO"
34173 .cindex "HELO"
34174 .cindex "SIZE option on MAIL command"
34175 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
34176 The &%protocol%& option selects which protocol is to be used, but the actual
34177 processing is the same in both cases.
34178
34179 If, in response to its EHLO command, Exim is told that the SIZE
34180 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
34181 command. The value of <&'n'&> is the message size plus the value of the
34182 &%size_addition%& option (default 1024) to allow for additions to the message
34183 such as per-transport header lines, or changes made in a
34184 .cindex "transport" "filter"
34185 .cindex "filter" "transport filter"
34186 transport filter. If &%size_addition%& is set negative, the use of SIZE is
34187 suppressed.
34188
34189 If the remote server advertises support for PIPELINING, Exim uses the
34190 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
34191 required for the transaction.
34192
34193 If the remote server advertises support for the STARTTLS command, and Exim
34194 was built to support TLS encryption, it tries to start a TLS session unless the
34195 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
34196 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
34197 is called for verification.
34198
34199 If the remote server advertises support for the AUTH command, Exim scans
34200 the authenticators configuration for any suitable client settings, as described
34201 in chapter &<<CHAPSMTPAUTH>>&.
34202
34203 .cindex "carriage return"
34204 .cindex "linefeed"
34205 Responses from the remote host are supposed to be terminated by CR followed by
34206 LF. However, there are known to be hosts that do not send CR characters, so in
34207 order to be able to interwork with such hosts, Exim treats LF on its own as a
34208 line terminator.
34209
34210 If a message contains a number of different addresses, all those with the same
34211 characteristics (for example, the same envelope sender) that resolve to the
34212 same set of hosts, in the same order, are sent in a single SMTP transaction,
34213 even if they are for different domains, unless there are more than the setting
34214 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
34215 they are split into groups containing no more than &%max_rcpt%&s addresses
34216 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
34217 in parallel sessions. The order of hosts with identical MX values is not
34218 significant when checking whether addresses can be batched in this way.
34219
34220 When the &(smtp)& transport suffers a temporary failure that is not
34221 message-related, Exim updates its transport-specific database, which contains
34222 records indexed by host name that remember which messages are waiting for each
34223 particular host. It also updates the retry database with new retry times.
34224
34225 .cindex "hints database" "retry keys"
34226 Exim's retry hints are based on host name plus IP address, so if one address of
34227 a multi-homed host is broken, it will soon be skipped most of the time.
34228 See the next section for more detail about error handling.
34229
34230 .cindex "SMTP" "passed connection"
34231 .cindex "SMTP" "batching over TCP/IP"
34232 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
34233 looks in the hints database for the transport to see if there are any queued
34234 messages waiting for the host to which it is connected. If it finds one, it
34235 creates a new Exim process using the &%-MC%& option (which can only be used by
34236 a process running as root or the Exim user) and passes the TCP/IP socket to it
34237 so that it can deliver another message using the same socket. The new process
34238 does only those deliveries that are routed to the connected host, and may in
34239 turn pass the socket on to a third process, and so on.
34240
34241 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
34242 limit the number of messages sent down a single TCP/IP connection.
34243
34244 .cindex "asterisk" "after IP address"
34245 The second and subsequent messages delivered down an existing connection are
34246 identified in the main log by the addition of an asterisk after the closing
34247 square bracket of the IP address.
34248
34249
34250
34251
34252 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
34253 .cindex "error" "in outgoing SMTP"
34254 .cindex "SMTP" "errors in outgoing"
34255 .cindex "host" "error"
34256 Three different kinds of error are recognized for outgoing SMTP: host errors,
34257 message errors, and recipient errors.
34258
34259 .vlist
34260 .vitem "&*Host errors*&"
34261 A host error is not associated with a particular message or with a
34262 particular recipient of a message. The host errors are:
34263
34264 .ilist
34265 Connection refused or timed out,
34266 .next
34267 Any error response code on connection,
34268 .next
34269 Any error response code to EHLO or HELO,
34270 .next
34271 Loss of connection at any time, except after &"."&,
34272 .next
34273 I/O errors at any time,
34274 .next
34275 Timeouts during the session, other than in response to MAIL, RCPT or
34276 the &"."& at the end of the data.
34277 .endlist ilist
34278
34279 For a host error, a permanent error response on connection, or in response to
34280 EHLO, causes all addresses routed to the host to be failed. Any other host
34281 error causes all addresses to be deferred, and retry data to be created for the
34282 host. It is not tried again, for any message, until its retry time arrives. If
34283 the current set of addresses are not all delivered in this run (to some
34284 alternative host), the message is added to the list of those waiting for this
34285 host, so if it is still undelivered when a subsequent successful delivery is
34286 made to the host, it will be sent down the same SMTP connection.
34287
34288 .vitem "&*Message errors*&"
34289 .cindex "message" "error"
34290 A message error is associated with a particular message when sent to a
34291 particular host, but not with a particular recipient of the message. The
34292 message errors are:
34293
34294 .ilist
34295 Any error response code to MAIL, DATA, or the &"."& that terminates
34296 the data,
34297 .next
34298 Timeout after MAIL,
34299 .next
34300 Timeout or loss of connection after the &"."& that terminates the data. A
34301 timeout after the DATA command itself is treated as a host error, as is loss of
34302 connection at any other time.
34303 .endlist ilist
34304
34305 For a message error, a permanent error response (5&'xx'&) causes all addresses
34306 to be failed, and a delivery error report to be returned to the sender. A
34307 temporary error response (4&'xx'&), or one of the timeouts, causes all
34308 addresses to be deferred. Retry data is not created for the host, but instead,
34309 a retry record for the combination of host plus message id is created. The
34310 message is not added to the list of those waiting for this host. This ensures
34311 that the failing message will not be sent to this host again until the retry
34312 time arrives. However, other messages that are routed to the host are not
34313 affected, so if it is some property of the message that is causing the error,
34314 it will not stop the delivery of other mail.
34315
34316 If the remote host specified support for the SIZE parameter in its response
34317 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
34318 over-large message will cause a message error because the error arrives as a
34319 response to MAIL.
34320
34321 .vitem "&*Recipient errors*&"
34322 .cindex "recipient" "error"
34323 A recipient error is associated with a particular recipient of a message. The
34324 recipient errors are:
34325
34326 .ilist
34327 Any error response to RCPT,
34328 .next
34329 Timeout after RCPT.
34330 .endlist
34331
34332 For a recipient error, a permanent error response (5&'xx'&) causes the
34333 recipient address to be failed, and a bounce message to be returned to the
34334 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
34335 address to be deferred, and routing retry data to be created for it. This is
34336 used to delay processing of the address in subsequent queue runs, until its
34337 routing retry time arrives. This applies to all messages, but because it
34338 operates only in queue runs, one attempt will be made to deliver a new message
34339 to the failing address before the delay starts to operate. This ensures that,
34340 if the failure is really related to the message rather than the recipient
34341 (&"message too big for this recipient"& is a possible example), other messages
34342 have a chance of getting delivered. If a delivery to the address does succeed,
34343 the retry information gets cleared, so all stuck messages get tried again, and
34344 the retry clock is reset.
34345
34346 The message is not added to the list of those waiting for this host. Use of the
34347 host for other messages is unaffected, and except in the case of a timeout,
34348 other recipients are processed independently, and may be successfully delivered
34349 in the current SMTP session. After a timeout it is of course impossible to
34350 proceed with the session, so all addresses get deferred. However, those other
34351 than the one that failed do not suffer any subsequent retry delays. Therefore,
34352 if one recipient is causing trouble, the others have a chance of getting
34353 through when a subsequent delivery attempt occurs before the failing
34354 recipient's retry time.
34355 .endlist
34356
34357 In all cases, if there are other hosts (or IP addresses) available for the
34358 current set of addresses (for example, from multiple MX records), they are
34359 tried in this run for any undelivered addresses, subject of course to their
34360 own retry data. In other words, recipient error retry data does not take effect
34361 until the next delivery attempt.
34362
34363 Some hosts have been observed to give temporary error responses to every
34364 MAIL command at certain times (&"insufficient space"& has been seen). It
34365 would be nice if such circumstances could be recognized, and defer data for the
34366 host itself created, but this is not possible within the current Exim design.
34367 What actually happens is that retry data for every (host, message) combination
34368 is created.
34369
34370 The reason that timeouts after MAIL and RCPT are treated specially is that
34371 these can sometimes arise as a result of the remote host's verification
34372 procedures. Exim makes this assumption, and treats them as if a temporary error
34373 response had been received. A timeout after &"."& is treated specially because
34374 it is known that some broken implementations fail to recognize the end of the
34375 message if the last character of the last line is a binary zero. Thus, it is
34376 helpful to treat this case as a message error.
34377
34378 Timeouts at other times are treated as host errors, assuming a problem with the
34379 host, or the connection to it. If a timeout after MAIL, RCPT,
34380 or &"."& is really a connection problem, the assumption is that at the next try
34381 the timeout is likely to occur at some other point in the dialogue, causing it
34382 then to be treated as a host error.
34383
34384 There is experimental evidence that some MTAs drop the connection after the
34385 terminating &"."& if they do not like the contents of the message for some
34386 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34387 should be given. That is why Exim treats this case as a message rather than a
34388 host error, in order not to delay other messages to the same host.
34389
34390
34391
34392
34393 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34394 .cindex "SMTP" "incoming over TCP/IP"
34395 .cindex "incoming SMTP over TCP/IP"
34396 .cindex "inetd"
34397 .cindex "daemon"
34398 Incoming SMTP messages can be accepted in one of two ways: by running a
34399 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34400 &_/etc/inetd.conf_& should be like this:
34401 .code
34402 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34403 .endd
34404 Exim distinguishes between this case and the case of a locally running user
34405 agent using the &%-bs%& option by checking whether or not the standard input is
34406 a socket. When it is, either the port must be privileged (less than 1024), or
34407 the caller must be root or the Exim user. If any other user passes a socket
34408 with an unprivileged port number, Exim prints a message on the standard error
34409 stream and exits with an error code.
34410
34411 By default, Exim does not make a log entry when a remote host connects or
34412 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34413 unexpected. It can be made to write such log entries by setting the
34414 &%smtp_connection%& log selector.
34415
34416 .cindex "carriage return"
34417 .cindex "linefeed"
34418 Commands from the remote host are supposed to be terminated by CR followed by
34419 LF. However, there are known to be hosts that do not send CR characters. In
34420 order to be able to interwork with such hosts, Exim treats LF on its own as a
34421 line terminator.
34422 Furthermore, because common code is used for receiving messages from all
34423 sources, a CR on its own is also interpreted as a line terminator. However, the
34424 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34425
34426 .cindex "EHLO" "invalid data"
34427 .cindex "HELO" "invalid data"
34428 One area that sometimes gives rise to problems concerns the EHLO or
34429 HELO commands. Some clients send syntactically invalid versions of these
34430 commands, which Exim rejects by default. (This is nothing to do with verifying
34431 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34432 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34433 match the broken hosts that send invalid commands.
34434
34435 .cindex "SIZE option on MAIL command"
34436 .cindex "MAIL" "SIZE option"
34437 The amount of disk space available is checked whenever SIZE is received on
34438 a MAIL command, independently of whether &%message_size_limit%& or
34439 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34440 false. A temporary error is given if there is not enough space. If
34441 &%check_spool_space%& is set, the check is for that amount of space plus the
34442 value given with SIZE, that is, it checks that the addition of the incoming
34443 message will not reduce the space below the threshold.
34444
34445 When a message is successfully received, Exim includes the local message id in
34446 its response to the final &"."& that terminates the data. If the remote host
34447 logs this text it can help with tracing what has happened to a message.
34448
34449 The Exim daemon can limit the number of simultaneous incoming connections it is
34450 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34451 number of simultaneous incoming connections from a single remote host (see the
34452 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34453 rejected using the SMTP temporary error code 421.
34454
34455 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34456 subprocess has finished, as this can get lost at busy times. Instead, it looks
34457 for completed subprocesses every time it wakes up. Provided there are other
34458 things happening (new incoming calls, starts of queue runs), completed
34459 processes will be noticed and tidied away. On very quiet systems you may
34460 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34461 it will be noticed when the daemon next wakes up.
34462
34463 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34464 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34465 high system load &-- for details see the &%smtp_accept_reserve%&,
34466 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34467 applies in both the daemon and &'inetd'& cases.
34468
34469 Exim normally starts a delivery process for each message received, though this
34470 can be varied by means of the &%-odq%& command line option and the
34471 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34472 number of simultaneously running delivery processes started in this way from
34473 SMTP input can be limited by the &%smtp_accept_queue%& and
34474 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34475 subsequently received messages are just put on the input queue without starting
34476 a delivery process.
34477
34478 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34479 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34480 started up from the &'inetd'& daemon, because in that case each connection is
34481 handled by an entirely independent Exim process. Control by load average is,
34482 however, available with &'inetd'&.
34483
34484 Exim can be configured to verify addresses in incoming SMTP commands as they
34485 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34486 to rewrite addresses at this time &-- before any syntax checking is done. See
34487 section &<<SECTrewriteS>>&.
34488
34489 Exim can also be configured to limit the rate at which a client host submits
34490 MAIL and RCPT commands in a single SMTP session. See the
34491 &%smtp_ratelimit_hosts%& option.
34492
34493
34494
34495 .section "Unrecognized SMTP commands" "SECID234"
34496 .cindex "SMTP" "unrecognized commands"
34497 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34498 commands during a single SMTP connection, it drops the connection after sending
34499 the error response to the last command. The default value for
34500 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34501 abuse that subvert web servers into making connections to SMTP ports; in these
34502 circumstances, a number of non-SMTP lines are sent first.
34503
34504
34505 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34506 .cindex "SMTP" "syntax errors"
34507 .cindex "SMTP" "protocol errors"
34508 A syntax error is detected if an SMTP command is recognized, but there is
34509 something syntactically wrong with its data, for example, a malformed email
34510 address in a RCPT command. Protocol errors include invalid command
34511 sequencing such as RCPT before MAIL. If Exim receives more than
34512 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34513 drops the connection after sending the error response to the last command. The
34514 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34515 broken clients that loop sending bad commands (yes, it has been seen).
34516
34517
34518
34519 .section "Use of non-mail SMTP commands" "SECID236"
34520 .cindex "SMTP" "non-mail commands"
34521 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34522 DATA. Exim counts such commands, and drops the connection if there are too
34523 many of them in a single SMTP session. This action catches some
34524 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34525 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34526 defines what &"too many"& means. Its default value is 10.
34527
34528 When a new message is expected, one occurrence of RSET is not counted. This
34529 allows a client to send one RSET between messages (this is not necessary,
34530 but some clients do it). Exim also allows one uncounted occurrence of HELO
34531 or EHLO, and one occurrence of STARTTLS between messages. After
34532 starting up a TLS session, another EHLO is expected, and so it too is not
34533 counted.
34534
34535 The first occurrence of AUTH in a connection, or immediately following
34536 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34537 RCPT, DATA, and QUIT are counted.
34538
34539 You can control which hosts are subject to the limit set by
34540 &%smtp_accept_max_nonmail%& by setting
34541 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34542 the limit apply to all hosts. This option means that you can exclude any
34543 specific badly-behaved hosts that you have to live with.
34544
34545
34546
34547
34548 .section "The VRFY and EXPN commands" "SECID237"
34549 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34550 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34551 appropriate) in order to decide whether the command should be accepted or not.
34552
34553 .cindex "VRFY" "processing"
34554 When no ACL is defined for VRFY, or if it rejects without
34555 setting an explicit response code, the command is accepted
34556 (with a 252 SMTP response code)
34557 in order to support awkward clients that do a VRFY before every RCPT.
34558 When VRFY is accepted, it runs exactly the same code as when Exim is
34559 called with the &%-bv%& option, and returns 250/451/550
34560 SMTP response codes.
34561
34562 .cindex "EXPN" "processing"
34563 If no ACL for EXPN is defined, the command is rejected.
34564 When EXPN is accepted, a single-level expansion of the address is done.
34565 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34566 than a verification (the &%-bv%& option). If an unqualified local part is given
34567 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34568 of VRFY and EXPN commands are logged on the main and reject logs, and
34569 VRFY verification failures are logged on the main log for consistency with
34570 RCPT failures.
34571
34572
34573
34574 .section "The ETRN command" "SECTETRN"
34575 .cindex "ETRN" "processing"
34576 RFC 1985 describes an SMTP command called ETRN that is designed to
34577 overcome the security problems of the TURN command (which has fallen into
34578 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34579 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34580 should be accepted or not. If no ACL is defined, the command is rejected.
34581
34582 The ETRN command is concerned with &"releasing"& messages that are awaiting
34583 delivery to certain hosts. As Exim does not organize its message queue by host,
34584 the only form of ETRN that is supported by default is the one where the
34585 text starts with the &"#"& prefix, in which case the remainder of the text is
34586 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34587 the &%-R%& option to happen, with the remainder of the ETRN text as its
34588 argument. For example,
34589 .code
34590 ETRN #brigadoon
34591 .endd
34592 runs the command
34593 .code
34594 exim -R brigadoon
34595 .endd
34596 which causes a delivery attempt on all messages with undelivered addresses
34597 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34598 default), Exim prevents the simultaneous execution of more than one queue run
34599 for the same argument string as a result of an ETRN command. This stops
34600 a misbehaving client from starting more than one queue runner at once.
34601
34602 .cindex "hints database" "ETRN serialization"
34603 Exim implements the serialization by means of a hints database in which a
34604 record is written whenever a process is started by ETRN, and deleted when
34605 the process completes. However, Exim does not keep the SMTP session waiting for
34606 the ETRN process to complete. Once ETRN is accepted, the client is sent
34607 a &"success"& return code. Obviously there is scope for hints records to get
34608 left lying around if there is a system or program crash. To guard against this,
34609 Exim ignores any records that are more than six hours old.
34610
34611 .oindex "&%smtp_etrn_command%&"
34612 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34613 used. This specifies a command that is run whenever ETRN is received,
34614 whatever the form of its argument. For
34615 example:
34616 .code
34617 smtp_etrn_command = /etc/etrn_command $domain \
34618                     $sender_host_address
34619 .endd
34620 .vindex "&$domain$&"
34621 The string is split up into arguments which are independently expanded. The
34622 expansion variable &$domain$& is set to the argument of the ETRN command,
34623 and no syntax checking is done on the contents of this argument. Exim does not
34624 wait for the command to complete, so its status code is not checked. Exim runs
34625 under its own uid and gid when receiving incoming SMTP, so it is not possible
34626 for it to change them before running the command.
34627
34628
34629
34630 .section "Incoming local SMTP" "SECID238"
34631 .cindex "SMTP" "local incoming"
34632 Some user agents use SMTP to pass messages to their local MTA using the
34633 standard input and output, as opposed to passing the envelope on the command
34634 line and writing the message to the standard input. This is supported by the
34635 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34636 messages over TCP/IP (including the use of ACLs), except that the envelope
34637 sender given in a MAIL command is ignored unless the caller is trusted. In
34638 an ACL you can detect this form of SMTP input by testing for an empty host
34639 identification. It is common to have this as the first line in the ACL that
34640 runs for RCPT commands:
34641 .code
34642 accept hosts = :
34643 .endd
34644 This accepts SMTP messages from local processes without doing any other tests.
34645
34646
34647
34648 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34649 .cindex "SMTP" "batched outgoing"
34650 .cindex "batched SMTP output"
34651 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34652 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34653 be output in BSMTP format. No SMTP responses are possible for this form of
34654 delivery. All it is doing is using SMTP commands as a way of transmitting the
34655 envelope along with the message.
34656
34657 The message is written to the file or pipe preceded by the SMTP commands
34658 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34659 the message that start with a dot have an extra dot added. The SMTP command
34660 HELO is not normally used. If it is required, the &%message_prefix%& option
34661 can be used to specify it.
34662
34663 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34664 one recipient address at a time by default. However, you can arrange for them
34665 to handle several addresses at once by setting the &%batch_max%& option. When
34666 this is done for BSMTP, messages may contain multiple RCPT commands. See
34667 chapter &<<CHAPbatching>>& for more details.
34668
34669 .vindex "&$host$&"
34670 When one or more addresses are routed to a BSMTP transport by a router that
34671 sets up a host list, the name of the first host on the list is available to the
34672 transport in the variable &$host$&. Here is an example of such a transport and
34673 router:
34674 .code
34675 begin routers
34676 route_append:
34677   driver = manualroute
34678   transport = smtp_appendfile
34679   route_list = domain.example  batch.host.example
34680
34681 begin transports
34682 smtp_appendfile:
34683   driver = appendfile
34684   directory = /var/bsmtp/$host
34685   batch_max = 1000
34686   use_bsmtp
34687   user = exim
34688 .endd
34689 This causes messages addressed to &'domain.example'& to be written in BSMTP
34690 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34691 message (unless there are more than 1000 recipients).
34692
34693
34694
34695 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34696 .cindex "SMTP" "batched incoming"
34697 .cindex "batched SMTP input"
34698 The &%-bS%& command line option causes Exim to accept one or more messages by
34699 reading SMTP on the standard input, but to generate no responses. If the caller
34700 is trusted, the senders in the MAIL commands are believed; otherwise the
34701 sender is always the caller of Exim. Unqualified senders and receivers are not
34702 rejected (there seems little point) but instead just get qualified. HELO
34703 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34704 as NOOP; QUIT quits.
34705
34706 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34707 ACL is run in the same way as for non-SMTP local input.
34708
34709 If an error is detected while reading a message, including a missing &"."& at
34710 the end, Exim gives up immediately. It writes details of the error to the
34711 standard output in a stylized way that the calling program should be able to
34712 make some use of automatically, for example:
34713 .code
34714 554 Unexpected end of file
34715 Transaction started in line 10
34716 Error detected in line 14
34717 .endd
34718 It writes a more verbose version, for human consumption, to the standard error
34719 file, for example:
34720 .code
34721 An error was detected while processing a file of BSMTP input.
34722 The error message was:
34723
34724 501 '>' missing at end of address
34725
34726 The SMTP transaction started in line 10.
34727 The error was detected in line 12.
34728 The SMTP command at fault was:
34729
34730 rcpt to:<malformed@in.com.plete
34731
34732 1 previous message was successfully processed.
34733 The rest of the batch was abandoned.
34734 .endd
34735 The return code from Exim is zero only if there were no errors. It is 1 if some
34736 messages were accepted before an error was detected, and 2 if no messages were
34737 accepted.
34738 .ecindex IIDsmtpproc1
34739 .ecindex IIDsmtpproc2
34740
34741
34742
34743 . ////////////////////////////////////////////////////////////////////////////
34744 . ////////////////////////////////////////////////////////////////////////////
34745
34746 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34747          "Customizing messages"
34748 When a message fails to be delivered, or remains on the queue for more than a
34749 configured amount of time, Exim sends a message to the original sender, or
34750 to an alternative configured address. The text of these messages is built into
34751 the code of Exim, but it is possible to change it, either by adding a single
34752 string, or by replacing each of the paragraphs by text supplied in a file.
34753
34754 The &'From:'& and &'To:'& header lines are automatically generated; you can
34755 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34756 option. Exim also adds the line
34757 .code
34758 Auto-Submitted: auto-generated
34759 .endd
34760 to all warning and bounce messages,
34761
34762
34763 .section "Customizing bounce messages" "SECID239"
34764 .cindex "customizing" "bounce message"
34765 .cindex "bounce message" "customizing"
34766 If &%bounce_message_text%& is set, its contents are included in the default
34767 message immediately after &"This message was created automatically by mail
34768 delivery software."& The string is not expanded. It is not used if
34769 &%bounce_message_file%& is set.
34770
34771 When &%bounce_message_file%& is set, it must point to a template file for
34772 constructing error messages. The file consists of a series of text items,
34773 separated by lines consisting of exactly four asterisks. If the file cannot be
34774 opened, default text is used and a message is written to the main and panic
34775 logs. If any text item in the file is empty, default text is used for that
34776 item.
34777
34778 .vindex "&$bounce_recipient$&"
34779 .vindex "&$bounce_return_size_limit$&"
34780 Each item of text that is read from the file is expanded, and there are two
34781 expansion variables which can be of use here: &$bounce_recipient$& is set to
34782 the recipient of an error message while it is being created, and
34783 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34784 option, rounded to a whole number.
34785
34786 The items must appear in the file in the following order:
34787
34788 .ilist
34789 The first item is included in the headers, and should include at least a
34790 &'Subject:'& header. Exim does not check the syntax of these headers.
34791 .next
34792 The second item forms the start of the error message. After it, Exim lists the
34793 failing addresses with their error messages.
34794 .next
34795 The third item is used to introduce any text from pipe transports that is to be
34796 returned to the sender. It is omitted if there is no such text.
34797 .next
34798 The fourth, fifth and sixth items will be ignored and may be empty.
34799 The fields exist for back-compatibility
34800 .endlist
34801
34802 The default state (&%bounce_message_file%& unset) is equivalent to the
34803 following file, in which the sixth item is empty. The &'Subject:'& and some
34804 other lines have been split in order to fit them on the page:
34805 .code
34806 Subject: Mail delivery failed
34807   ${if eq{$sender_address}{$bounce_recipient}
34808   {: returning message to sender}}
34809 ****
34810 This message was created automatically by mail delivery software.
34811
34812 A message ${if eq{$sender_address}{$bounce_recipient}
34813   {that you sent }{sent by
34814
34815 <$sender_address>
34816
34817 }}could not be delivered to all of its recipients.
34818 This is a permanent error. The following address(es) failed:
34819 ****
34820 The following text was generated during the delivery attempt(s):
34821 ****
34822 ------ This is a copy of the message, including all the headers.
34823   ------
34824 ****
34825 ------ The body of the message is $message_size characters long;
34826   only the first
34827 ------ $bounce_return_size_limit or so are included here.
34828 ****
34829 .endd
34830 .section "Customizing warning messages" "SECTcustwarn"
34831 .cindex "customizing" "warning message"
34832 .cindex "warning of delay" "customizing the message"
34833 The option &%warn_message_file%& can be pointed at a template file for use when
34834 warnings about message delays are created. In this case there are only three
34835 text sections:
34836
34837 .ilist
34838 The first item is included in the headers, and should include at least a
34839 &'Subject:'& header. Exim does not check the syntax of these headers.
34840 .next
34841 The second item forms the start of the warning message. After it, Exim lists
34842 the delayed addresses.
34843 .next
34844 The third item then ends the message.
34845 .endlist
34846
34847 The default state is equivalent to the following file, except that some lines
34848 have been split here, in order to fit them on the page:
34849 .code
34850 Subject: Warning: message $message_exim_id delayed
34851   $warn_message_delay
34852 ****
34853 This message was created automatically by mail delivery software.
34854
34855 A message ${if eq{$sender_address}{$warn_message_recipients}
34856 {that you sent }{sent by
34857
34858 <$sender_address>
34859
34860 }}has not been delivered to all of its recipients after
34861 more than $warn_message_delay on the queue on $primary_hostname.
34862
34863 The message identifier is:     $message_exim_id
34864 The subject of the message is: $h_subject
34865 The date of the message is:    $h_date
34866
34867 The following address(es) have not yet been delivered:
34868 ****
34869 No action is required on your part. Delivery attempts will
34870 continue for some time, and this warning may be repeated at
34871 intervals if the message remains undelivered. Eventually the
34872 mail delivery software will give up, and when that happens,
34873 the message will be returned to you.
34874 .endd
34875 .vindex "&$warn_message_delay$&"
34876 .vindex "&$warn_message_recipients$&"
34877 However, in the default state the subject and date lines are omitted if no
34878 appropriate headers exist. During the expansion of this file,
34879 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34880 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34881 of recipients for the warning message. There may be more than one if there are
34882 multiple addresses with different &%errors_to%& settings on the routers that
34883 handled them.
34884
34885
34886
34887
34888 . ////////////////////////////////////////////////////////////////////////////
34889 . ////////////////////////////////////////////////////////////////////////////
34890
34891 .chapter "Some common configuration settings" "CHAPcomconreq"
34892 This chapter discusses some configuration settings that seem to be fairly
34893 common. More examples and discussion can be found in the Exim book.
34894
34895
34896
34897 .section "Sending mail to a smart host" "SECID240"
34898 .cindex "smart host" "example router"
34899 If you want to send all mail for non-local domains to a &"smart host"&, you
34900 should replace the default &(dnslookup)& router with a router which does the
34901 routing explicitly:
34902 .code
34903 send_to_smart_host:
34904   driver = manualroute
34905   route_list = !+local_domains smart.host.name
34906   transport = remote_smtp
34907 .endd
34908 You can use the smart host's IP address instead of the name if you wish.
34909 If you are using Exim only to submit messages to a smart host, and not for
34910 receiving incoming messages, you can arrange for it to do the submission
34911 synchronously by setting the &%mua_wrapper%& option (see chapter
34912 &<<CHAPnonqueueing>>&).
34913
34914
34915
34916
34917 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34918 .cindex "mailing lists"
34919 Exim can be used to run simple mailing lists, but for large and/or complicated
34920 requirements, the use of additional specialized mailing list software such as
34921 Majordomo or Mailman is recommended.
34922
34923 The &(redirect)& router can be used to handle mailing lists where each list
34924 is maintained in a separate file, which can therefore be managed by an
34925 independent manager. The &%domains%& router option can be used to run these
34926 lists in a separate domain from normal mail. For example:
34927 .code
34928 lists:
34929   driver = redirect
34930   domains = lists.example
34931   file = /usr/lists/$local_part
34932   forbid_pipe
34933   forbid_file
34934   errors_to = $local_part-request@lists.example
34935   no_more
34936 .endd
34937 This router is skipped for domains other than &'lists.example'&. For addresses
34938 in that domain, it looks for a file that matches the local part. If there is no
34939 such file, the router declines, but because &%no_more%& is set, no subsequent
34940 routers are tried, and so the whole delivery fails.
34941
34942 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34943 expanded into a file name or a pipe delivery, which is usually inappropriate in
34944 a mailing list.
34945
34946 .oindex "&%errors_to%&"
34947 The &%errors_to%& option specifies that any delivery errors caused by addresses
34948 taken from a mailing list are to be sent to the given address rather than the
34949 original sender of the message. However, before acting on this, Exim verifies
34950 the error address, and ignores it if verification fails.
34951
34952 For example, using the configuration above, mail sent to
34953 &'dicts@lists.example'& is passed on to those addresses contained in
34954 &_/usr/lists/dicts_&, with error reports directed to
34955 &'dicts-request@lists.example'&, provided that this address can be verified.
34956 There could be a file called &_/usr/lists/dicts-request_& containing
34957 the address(es) of this particular list's manager(s), but other approaches,
34958 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34959 or &%local_part_suffix%& options) to handle addresses of the form
34960 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34961
34962
34963
34964 .section "Syntax errors in mailing lists" "SECID241"
34965 .cindex "mailing lists" "syntax errors in"
34966 If an entry in redirection data contains a syntax error, Exim normally defers
34967 delivery of the original address. That means that a syntax error in a mailing
34968 list holds up all deliveries to the list. This may not be appropriate when a
34969 list is being maintained automatically from data supplied by users, and the
34970 addresses are not rigorously checked.
34971
34972 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34973 entries that fail to parse, noting the incident in the log. If in addition
34974 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34975 whenever a broken address is skipped. It is usually appropriate to set
34976 &%syntax_errors_to%& to the same address as &%errors_to%&.
34977
34978
34979
34980 .section "Re-expansion of mailing lists" "SECID242"
34981 .cindex "mailing lists" "re-expansion of"
34982 Exim remembers every individual address to which a message has been delivered,
34983 in order to avoid duplication, but it normally stores only the original
34984 recipient addresses with a message. If all the deliveries to a mailing list
34985 cannot be done at the first attempt, the mailing list is re-expanded when the
34986 delivery is next tried. This means that alterations to the list are taken into
34987 account at each delivery attempt, so addresses that have been added to
34988 the list since the message arrived will therefore receive a copy of the
34989 message, even though it pre-dates their subscription.
34990
34991 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34992 on the &(redirect)& router. If this is done, any addresses generated by the
34993 router that fail to deliver at the first attempt are added to the message as
34994 &"top level"& addresses, and the parent address that generated them is marked
34995 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34996 subsequent delivery attempts. The disadvantage of this is that if any of the
34997 failing addresses are incorrect, correcting them in the file has no effect on
34998 pre-existing messages.
34999
35000 The original top-level address is remembered with each of the generated
35001 addresses, and is output in any log messages. However, any intermediate parent
35002 addresses are not recorded. This makes a difference to the log only if the
35003 &%all_parents%& selector is set, but for mailing lists there is normally only
35004 one level of expansion anyway.
35005
35006
35007
35008 .section "Closed mailing lists" "SECID243"
35009 .cindex "mailing lists" "closed"
35010 The examples so far have assumed open mailing lists, to which anybody may
35011 send mail. It is also possible to set up closed lists, where mail is accepted
35012 from specified senders only. This is done by making use of the generic
35013 &%senders%& option to restrict the router that handles the list.
35014
35015 The following example uses the same file as a list of recipients and as a list
35016 of permitted senders. It requires three routers:
35017 .code
35018 lists_request:
35019   driver = redirect
35020   domains = lists.example
35021   local_part_suffix = -request
35022   file = /usr/lists/$local_part$local_part_suffix
35023   no_more
35024
35025 lists_post:
35026   driver = redirect
35027   domains = lists.example
35028   senders = ${if exists {/usr/lists/$local_part}\
35029              {lsearch;/usr/lists/$local_part}{*}}
35030   file = /usr/lists/$local_part
35031   forbid_pipe
35032   forbid_file
35033   errors_to = $local_part-request@lists.example
35034   no_more
35035
35036 lists_closed:
35037   driver = redirect
35038   domains = lists.example
35039   allow_fail
35040   data = :fail: $local_part@lists.example is a closed mailing list
35041 .endd
35042 All three routers have the same &%domains%& setting, so for any other domains,
35043 they are all skipped. The first router runs only if the local part ends in
35044 &%-request%&. It handles messages to the list manager(s) by means of an open
35045 mailing list.
35046
35047 The second router runs only if the &%senders%& precondition is satisfied. It
35048 checks for the existence of a list that corresponds to the local part, and then
35049 checks that the sender is on the list by means of a linear search. It is
35050 necessary to check for the existence of the file before trying to search it,
35051 because otherwise Exim thinks there is a configuration error. If the file does
35052 not exist, the expansion of &%senders%& is *, which matches all senders. This
35053 means that the router runs, but because there is no list, declines, and
35054 &%no_more%& ensures that no further routers are run. The address fails with an
35055 &"unrouteable address"& error.
35056
35057 The third router runs only if the second router is skipped, which happens when
35058 a mailing list exists, but the sender is not on it. This router forcibly fails
35059 the address, giving a suitable error message.
35060
35061
35062
35063
35064 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
35065 .cindex "VERP"
35066 .cindex "Variable Envelope Return Paths"
35067 .cindex "envelope sender"
35068 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
35069 are a way of helping mailing list administrators discover which subscription
35070 address is the cause of a particular delivery failure. The idea is to encode
35071 the original recipient address in the outgoing envelope sender address, so that
35072 if the message is forwarded by another host and then subsequently bounces, the
35073 original recipient can be extracted from the recipient address of the bounce.
35074
35075 .oindex &%errors_to%&
35076 .oindex &%return_path%&
35077 Envelope sender addresses can be modified by Exim using two different
35078 facilities: the &%errors_to%& option on a router (as shown in previous mailing
35079 list examples), or the &%return_path%& option on a transport. The second of
35080 these is effective only if the message is successfully delivered to another
35081 host; it is not used for errors detected on the local host (see the description
35082 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
35083 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
35084 .code
35085 verp_smtp:
35086   driver = smtp
35087   max_rcpt = 1
35088   return_path = \
35089     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35090       {$1-request+$local_part=$domain@your.dom.example}fail}
35091 .endd
35092 This has the effect of rewriting the return path (envelope sender) on outgoing
35093 SMTP messages, if the local part of the original return path ends in
35094 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
35095 local part and domain of the recipient into the return path. Suppose, for
35096 example, that a message whose return path has been set to
35097 &'somelist-request@your.dom.example'& is sent to
35098 &'subscriber@other.dom.example'&. In the transport, the return path is
35099 rewritten as
35100 .code
35101 somelist-request+subscriber=other.dom.example@your.dom.example
35102 .endd
35103 .vindex "&$local_part$&"
35104 For this to work, you must tell Exim to send multiple copies of messages that
35105 have more than one recipient, so that each copy has just one recipient. This is
35106 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
35107 might be sent to several different recipients in the same domain, in which case
35108 &$local_part$& is not available in the transport, because it is not unique.
35109
35110 Unless your host is doing nothing but mailing list deliveries, you should
35111 probably use a separate transport for the VERP deliveries, so as not to use
35112 extra resources in making one-per-recipient copies for other deliveries. This
35113 can easily be done by expanding the &%transport%& option in the router:
35114 .code
35115 dnslookup:
35116   driver = dnslookup
35117   domains = ! +local_domains
35118   transport = \
35119     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35120       {verp_smtp}{remote_smtp}}
35121   no_more
35122 .endd
35123 If you want to change the return path using &%errors_to%& in a router instead
35124 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
35125 routers that handle mailing list addresses. This will ensure that all delivery
35126 errors, including those detected on the local host, are sent to the VERP
35127 address.
35128
35129 On a host that does no local deliveries and has no manual routing, only the
35130 &(dnslookup)& router needs to be changed. A special transport is not needed for
35131 SMTP deliveries. Every mailing list recipient has its own return path value,
35132 and so Exim must hand them to the transport one at a time. Here is an example
35133 of a &(dnslookup)& router that implements VERP:
35134 .code
35135 verp_dnslookup:
35136   driver = dnslookup
35137   domains = ! +local_domains
35138   transport = remote_smtp
35139   errors_to = \
35140     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
35141      {$1-request+$local_part=$domain@your.dom.example}fail}
35142   no_more
35143 .endd
35144 Before you start sending out messages with VERPed return paths, you must also
35145 configure Exim to accept the bounce messages that come back to those paths.
35146 Typically this is done by setting a &%local_part_suffix%& option for a
35147 router, and using this to route the messages to wherever you want to handle
35148 them.
35149
35150 The overhead incurred in using VERP depends very much on the size of the
35151 message, the number of recipient addresses that resolve to the same remote
35152 host, and the speed of the connection over which the message is being sent. If
35153 a lot of addresses resolve to the same host and the connection is slow, sending
35154 a separate copy of the message for each address may take substantially longer
35155 than sending a single copy with many recipients (for which VERP cannot be
35156 used).
35157
35158
35159
35160
35161
35162
35163 .section "Virtual domains" "SECTvirtualdomains"
35164 .cindex "virtual domains"
35165 .cindex "domain" "virtual"
35166 The phrase &'virtual domain'& is unfortunately used with two rather different
35167 meanings:
35168
35169 .ilist
35170 A domain for which there are no real mailboxes; all valid local parts are
35171 aliases for other email addresses. Common examples are organizational
35172 top-level domains and &"vanity"& domains.
35173 .next
35174 One of a number of independent domains that are all handled by the same host,
35175 with mailboxes on that host, but where the mailbox owners do not necessarily
35176 have login accounts on that host.
35177 .endlist
35178
35179 The first usage is probably more common, and does seem more &"virtual"& than
35180 the second. This kind of domain can be handled in Exim with a straightforward
35181 aliasing router. One approach is to create a separate alias file for each
35182 virtual domain. Exim can test for the existence of the alias file to determine
35183 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
35184 to a router of this form:
35185 .code
35186 virtual:
35187   driver = redirect
35188   domains = dsearch;/etc/mail/virtual
35189   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
35190   no_more
35191 .endd
35192 The &%domains%& option specifies that the router is to be skipped, unless there
35193 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
35194 domain that is being processed. When the router runs, it looks up the local
35195 part in the file to find a new address (or list of addresses). The &%no_more%&
35196 setting ensures that if the lookup fails (leading to &%data%& being an empty
35197 string), Exim gives up on the address without trying any subsequent routers.
35198
35199 This one router can handle all the virtual domains because the alias file names
35200 follow a fixed pattern. Permissions can be arranged so that appropriate people
35201 can edit the different alias files. A successful aliasing operation results in
35202 a new envelope recipient address, which is then routed from scratch.
35203
35204 The other kind of &"virtual"& domain can also be handled in a straightforward
35205 way. One approach is to create a file for each domain containing a list of
35206 valid local parts, and use it in a router like this:
35207 .code
35208 my_domains:
35209   driver = accept
35210   domains = dsearch;/etc/mail/domains
35211   local_parts = lsearch;/etc/mail/domains/$domain
35212   transport = my_mailboxes
35213 .endd
35214 The address is accepted if there is a file for the domain, and the local part
35215 can be found in the file. The &%domains%& option is used to check for the
35216 file's existence because &%domains%& is tested before the &%local_parts%&
35217 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
35218 because that option is tested after &%local_parts%&. The transport is as
35219 follows:
35220 .code
35221 my_mailboxes:
35222   driver = appendfile
35223   file = /var/mail/$domain/$local_part
35224   user = mail
35225 .endd
35226 This uses a directory of mailboxes for each domain. The &%user%& setting is
35227 required, to specify which uid is to be used for writing to the mailboxes.
35228
35229 The configuration shown here is just one example of how you might support this
35230 requirement. There are many other ways this kind of configuration can be set
35231 up, for example, by using a database instead of separate files to hold all the
35232 information about the domains.
35233
35234
35235
35236 .section "Multiple user mailboxes" "SECTmulbox"
35237 .cindex "multiple mailboxes"
35238 .cindex "mailbox" "multiple"
35239 .cindex "local part" "prefix"
35240 .cindex "local part" "suffix"
35241 Heavy email users often want to operate with multiple mailboxes, into which
35242 incoming mail is automatically sorted. A popular way of handling this is to
35243 allow users to use multiple sender addresses, so that replies can easily be
35244 identified. Users are permitted to add prefixes or suffixes to their local
35245 parts for this purpose. The wildcard facility of the generic router options
35246 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
35247 example, consider this router:
35248 .code
35249 userforward:
35250   driver = redirect
35251   check_local_user
35252   file = $home/.forward
35253   local_part_suffix = -*
35254   local_part_suffix_optional
35255   allow_filter
35256 .endd
35257 .vindex "&$local_part_suffix$&"
35258 It runs a user's &_.forward_& file for all local parts of the form
35259 &'username-*'&. Within the filter file the user can distinguish different
35260 cases by testing the variable &$local_part_suffix$&. For example:
35261 .code
35262 if $local_part_suffix contains -special then
35263 save /home/$local_part/Mail/special
35264 endif
35265 .endd
35266 If the filter file does not exist, or does not deal with such addresses, they
35267 fall through to subsequent routers, and, assuming no subsequent use of the
35268 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
35269 control over which suffixes are valid.
35270
35271 Alternatively, a suffix can be used to trigger the use of a different
35272 &_.forward_& file &-- which is the way a similar facility is implemented in
35273 another MTA:
35274 .code
35275 userforward:
35276   driver = redirect
35277   check_local_user
35278   file = $home/.forward$local_part_suffix
35279   local_part_suffix = -*
35280   local_part_suffix_optional
35281   allow_filter
35282 .endd
35283 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
35284 example, &_.forward-special_& is used. Once again, if the appropriate file
35285 does not exist, or does not deal with the address, it is passed on to
35286 subsequent routers, which could, if required, look for an unqualified
35287 &_.forward_& file to use as a default.
35288
35289
35290
35291 .section "Simplified vacation processing" "SECID244"
35292 .cindex "vacation processing"
35293 The traditional way of running the &'vacation'& program is for a user to set up
35294 a pipe command in a &_.forward_& file
35295 (see section &<<SECTspecitredli>>& for syntax details).
35296 This is prone to error by inexperienced users. There are two features of Exim
35297 that can be used to make this process simpler for users:
35298
35299 .ilist
35300 A local part prefix such as &"vacation-"& can be specified on a router which
35301 can cause the message to be delivered directly to the &'vacation'& program, or
35302 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
35303 &_.forward_& file are then much simpler. For example:
35304 .code
35305 spqr, vacation-spqr
35306 .endd
35307 .next
35308 The &%require_files%& generic router option can be used to trigger a
35309 vacation delivery by checking for the existence of a certain file in the
35310 user's home directory. The &%unseen%& generic option should also be used, to
35311 ensure that the original delivery also proceeds. In this case, all the user has
35312 to do is to create a file called, say, &_.vacation_&, containing a vacation
35313 message.
35314 .endlist
35315
35316 Another advantage of both these methods is that they both work even when the
35317 use of arbitrary pipes by users is locked out.
35318
35319
35320
35321 .section "Taking copies of mail" "SECID245"
35322 .cindex "message" "copying every"
35323 Some installations have policies that require archive copies of all messages to
35324 be made. A single copy of each message can easily be taken by an appropriate
35325 command in a system filter, which could, for example, use a different file for
35326 each day's messages.
35327
35328 There is also a shadow transport mechanism that can be used to take copies of
35329 messages that are successfully delivered by local transports, one copy per
35330 delivery. This could be used, &'inter alia'&, to implement automatic
35331 notification of delivery by sites that insist on doing such things.
35332
35333
35334
35335 .section "Intermittently connected hosts" "SECID246"
35336 .cindex "intermittently connected hosts"
35337 It has become quite common (because it is cheaper) for hosts to connect to the
35338 Internet periodically rather than remain connected all the time. The normal
35339 arrangement is that mail for such hosts accumulates on a system that is
35340 permanently connected.
35341
35342 Exim was designed for use on permanently connected hosts, and so it is not
35343 particularly well-suited to use in an intermittently connected environment.
35344 Nevertheless there are some features that can be used.
35345
35346
35347 .section "Exim on the upstream server host" "SECID247"
35348 It is tempting to arrange for incoming mail for the intermittently connected
35349 host to remain on Exim's queue until the client connects. However, this
35350 approach does not scale very well. Two different kinds of waiting message are
35351 being mixed up in the same queue &-- those that cannot be delivered because of
35352 some temporary problem, and those that are waiting for their destination host
35353 to connect. This makes it hard to manage the queue, as well as wasting
35354 resources, because each queue runner scans the entire queue.
35355
35356 A better approach is to separate off those messages that are waiting for an
35357 intermittently connected host. This can be done by delivering these messages
35358 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
35359 format, from where they are transmitted by other software when their
35360 destination connects. This makes it easy to collect all the mail for one host
35361 in a single directory, and to apply local timeout rules on a per-message basis
35362 if required.
35363
35364 On a very small scale, leaving the mail on Exim's queue can be made to work. If
35365 you are doing this, you should configure Exim with a long retry period for the
35366 intermittent host. For example:
35367 .code
35368 cheshire.wonderland.fict.example    *   F,5d,24h
35369 .endd
35370 This stops a lot of failed delivery attempts from occurring, but Exim remembers
35371 which messages it has queued up for that host. Once the intermittent host comes
35372 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
35373 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
35374 causes all the queued up messages to be delivered, often down a single SMTP
35375 connection. While the host remains connected, any new messages get delivered
35376 immediately.
35377
35378 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35379 issued with a different IP address each time it connects, Exim's retry
35380 mechanisms on the holding host get confused, because the IP address is normally
35381 used as part of the key string for holding retry information. This can be
35382 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35383 Since this has disadvantages for permanently connected hosts, it is best to
35384 arrange a separate transport for the intermittently connected ones.
35385
35386
35387
35388 .section "Exim on the intermittently connected client host" "SECID248"
35389 The value of &%smtp_accept_queue_per_connection%& should probably be
35390 increased, or even set to zero (that is, disabled) on the intermittently
35391 connected host, so that all incoming messages down a single connection get
35392 delivered immediately.
35393
35394 .cindex "SMTP" "passed connection"
35395 .cindex "SMTP" "multiple deliveries"
35396 .cindex "multiple SMTP deliveries"
35397 Mail waiting to be sent from an intermittently connected host will probably
35398 not have been routed, because without a connection DNS lookups are not
35399 possible. This means that if a normal queue run is done at connection time,
35400 each message is likely to be sent in a separate SMTP session. This can be
35401 avoided by starting the queue run with a command line option beginning with
35402 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35403 first pass, routing is done but no deliveries take place. The second pass is a
35404 normal queue run; since all the messages have been previously routed, those
35405 destined for the same host are likely to get sent as multiple deliveries in a
35406 single SMTP connection.
35407
35408
35409
35410 . ////////////////////////////////////////////////////////////////////////////
35411 . ////////////////////////////////////////////////////////////////////////////
35412
35413 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35414          "Exim as a non-queueing client"
35415 .cindex "client, non-queueing"
35416 .cindex "smart host" "suppressing queueing"
35417 On a personal computer, it is a common requirement for all
35418 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35419 configured to operate that way, for all the popular operating systems.
35420 However, there are some MUAs for Unix-like systems that cannot be so
35421 configured: they submit messages using the command line interface of
35422 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35423 messages this way.
35424
35425 If the personal computer runs continuously, there is no problem, because it can
35426 run a conventional MTA that handles delivery to the smart host, and deal with
35427 any delays via its queueing mechanism. However, if the computer does not run
35428 continuously or runs different operating systems at different times, queueing
35429 email is not desirable.
35430
35431 There is therefore a requirement for something that can provide the
35432 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35433 any queueing or retrying facilities. Furthermore, the delivery to the smart
35434 host should be synchronous, so that if it fails, the sending MUA is immediately
35435 informed. In other words, we want something that extends an MUA that submits
35436 to a local MTA via the command line so that it behaves like one that submits
35437 to a remote smart host using TCP/SMTP.
35438
35439 There are a number of applications (for example, there is one called &'ssmtp'&)
35440 that do this job. However, people have found them to be lacking in various
35441 ways. For instance, you might want to allow aliasing and forwarding to be done
35442 before sending a message to the smart host.
35443
35444 Exim already had the necessary infrastructure for doing this job. Just a few
35445 tweaks were needed to make it behave as required, though it is somewhat of an
35446 overkill to use a fully-featured MTA for this purpose.
35447
35448 .oindex "&%mua_wrapper%&"
35449 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35450 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35451 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35452 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35453 compatible router and transport configuration. Typically there will be just one
35454 router and one transport, sending everything to a smart host.
35455
35456 When run in MUA wrapping mode, the behaviour of Exim changes in the
35457 following ways:
35458
35459 .ilist
35460 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35461 In other words, the only way to submit messages is via the command line.
35462 .next
35463 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35464 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35465 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35466 does not finish until the delivery attempt is complete. If the delivery is
35467 successful, a zero return code is given.
35468 .next
35469 Address redirection is permitted, but the final routing for all addresses must
35470 be to the same remote transport, and to the same list of hosts. Furthermore,
35471 the return address (envelope sender) must be the same for all recipients, as
35472 must any added or deleted header lines. In other words, it must be possible to
35473 deliver the message in a single SMTP transaction, however many recipients there
35474 are.
35475 .next
35476 If these conditions are not met, or if routing any address results in a
35477 failure or defer status, or if Exim is unable to deliver all the recipients
35478 successfully to one of the smart hosts, delivery of the entire message fails.
35479 .next
35480 Because no queueing is allowed, all failures are treated as permanent; there
35481 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35482 smart host. Furthermore, because only a single yes/no response can be given to
35483 the caller, it is not possible to deliver to some recipients and not others. If
35484 there is an error (temporary or permanent) for any recipient, all are failed.
35485 .next
35486 If more than one smart host is listed, Exim will try another host after a
35487 connection failure or a timeout, in the normal way. However, if this kind of
35488 failure happens for all the hosts, the delivery fails.
35489 .next
35490 When delivery fails, an error message is written to the standard error stream
35491 (as well as to Exim's log), and Exim exits to the caller with a return code
35492 value 1. The message is expunged from Exim's spool files. No bounce messages
35493 are ever generated.
35494 .next
35495 No retry data is maintained, and any retry rules are ignored.
35496 .next
35497 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35498 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35499 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35500 .endlist
35501
35502 The overall effect is that Exim makes a single synchronous attempt to deliver
35503 the message, failing if there is any kind of problem. Because no local
35504 deliveries are done and no daemon can be run, Exim does not need root
35505 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35506 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35507 the advantages and disadvantages of running without root privilege.
35508
35509
35510
35511
35512 . ////////////////////////////////////////////////////////////////////////////
35513 . ////////////////////////////////////////////////////////////////////////////
35514
35515 .chapter "Log files" "CHAPlog"
35516 .scindex IIDloggen "log" "general description"
35517 .cindex "log" "types of"
35518 Exim writes three different logs, referred to as the main log, the reject log,
35519 and the panic log:
35520
35521 .ilist
35522 .cindex "main log"
35523 The main log records the arrival of each message and each delivery in a single
35524 line in each case. The format is as compact as possible, in an attempt to keep
35525 down the size of log files. Two-character flag sequences make it easy to pick
35526 out these lines. A number of other events are recorded in the main log. Some of
35527 them are optional, in which case the &%log_selector%& option controls whether
35528 they are included or not. A Perl script called &'eximstats'&, which does simple
35529 analysis of main log files, is provided in the Exim distribution (see section
35530 &<<SECTmailstat>>&).
35531 .next
35532 .cindex "reject log"
35533 The reject log records information from messages that are rejected as a result
35534 of a configuration option (that is, for policy reasons).
35535 The first line of each rejection is a copy of the line that is also written to
35536 the main log. Then, if the message's header has been read at the time the log
35537 is written, its contents are written to this log. Only the original header
35538 lines are available; header lines added by ACLs are not logged. You can use the
35539 reject log to check that your policy controls are working correctly; on a busy
35540 host this may be easier than scanning the main log for rejection messages. You
35541 can suppress the writing of the reject log by setting &%write_rejectlog%&
35542 false.
35543 .next
35544 .cindex "panic log"
35545 .cindex "system log"
35546 When certain serious errors occur, Exim writes entries to its panic log. If the
35547 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35548 are usually written to the main log as well, but can get lost amid the mass of
35549 other entries. The panic log should be empty under normal circumstances. It is
35550 therefore a good idea to check it (or to have a &'cron'& script check it)
35551 regularly, in order to become aware of any problems. When Exim cannot open its
35552 panic log, it tries as a last resort to write to the system log (syslog). This
35553 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35554 message itself is written at priority LOG_CRIT.
35555 .endlist
35556
35557 Every log line starts with a timestamp, in the format shown in the following
35558 example. Note that many of the examples shown in this chapter are line-wrapped.
35559 In the log file, this would be all on one line:
35560 .code
35561 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35562   by QUIT
35563 .endd
35564 By default, the timestamps are in the local timezone. There are two
35565 ways of changing this:
35566
35567 .ilist
35568 You can set the &%timezone%& option to a different time zone; in particular, if
35569 you set
35570 .code
35571 timezone = UTC
35572 .endd
35573 the timestamps will be in UTC (aka GMT).
35574 .next
35575 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35576 example:
35577 .code
35578 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35579 .endd
35580 .endlist
35581
35582 .cindex "log" "process ids in"
35583 .cindex "pid (process id)" "in log lines"
35584 Exim does not include its process id in log lines by default, but you can
35585 request that it does so by specifying the &`pid`& log selector (see section
35586 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35587 brackets, immediately after the time and date.
35588
35589
35590
35591
35592 .section "Where the logs are written" "SECTwhelogwri"
35593 .cindex "log" "destination"
35594 .cindex "log" "to file"
35595 .cindex "log" "to syslog"
35596 .cindex "syslog"
35597 The logs may be written to local files, or to syslog, or both. However, it
35598 should be noted that many syslog implementations use UDP as a transport, and
35599 are therefore unreliable in the sense that messages are not guaranteed to
35600 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35601 It has also been reported that on large log files (tens of megabytes) you may
35602 need to tweak syslog to prevent it syncing the file with each write &-- on
35603 Linux this has been seen to make syslog take 90% plus of CPU time.
35604
35605 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35606 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35607 configuration. This latter string is expanded, so it can contain, for example,
35608 references to the host name:
35609 .code
35610 log_file_path = /var/log/$primary_hostname/exim_%slog
35611 .endd
35612 It is generally advisable, however, to set the string in &_Local/Makefile_&
35613 rather than at run time, because then the setting is available right from the
35614 start of Exim's execution. Otherwise, if there's something it wants to log
35615 before it has read the configuration file (for example, an error in the
35616 configuration file) it will not use the path you want, and may not be able to
35617 log at all.
35618
35619 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35620 list, currently limited to at most two items. This is one option where the
35621 facility for changing a list separator may not be used. The list must always be
35622 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35623 otherwise the item must either be an absolute path, containing &`%s`& at the
35624 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35625 implying the use of a default path.
35626
35627 When Exim encounters an empty item in the list, it searches the list defined by
35628 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35629 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35630 mean &"use the path specified at build time"&. It no such item exists, log
35631 files are written in the &_log_& subdirectory of the spool directory. This is
35632 equivalent to the setting:
35633 .code
35634 log_file_path = $spool_directory/log/%slog
35635 .endd
35636 If you do not specify anything at build time or run time,
35637 or if you unset the option at run time (i.e. &`log_file_path = `&),
35638 that is where the logs are written.
35639
35640 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35641 are in use &-- see section &<<SECTdatlogfil>>& below.
35642
35643 Here are some examples of possible settings:
35644 .display
35645 &`LOG_FILE_PATH=syslog                    `& syslog only
35646 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35647 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35648 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35649 .endd
35650 If there are more than two paths in the list, the first is used and a panic
35651 error is logged.
35652
35653
35654
35655 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35656 .cindex "log" "cycling local files"
35657 .cindex "cycling logs"
35658 .cindex "&'exicyclog'&"
35659 .cindex "log" "local files; writing to"
35660 Some operating systems provide centralized and standardized methods for cycling
35661 log files. For those that do not, a utility script called &'exicyclog'& is
35662 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35663 main and reject logs each time it is called. The maximum number of old logs to
35664 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35665
35666 An Exim delivery process opens the main log when it first needs to write to it,
35667 and it keeps the file open in case subsequent entries are required &-- for
35668 example, if a number of different deliveries are being done for the same
35669 message. However, remote SMTP deliveries can take a long time, and this means
35670 that the file may be kept open long after it is renamed if &'exicyclog'& or
35671 something similar is being used to rename log files on a regular basis. To
35672 ensure that a switch of log files is noticed as soon as possible, Exim calls
35673 &[stat()]& on the main log's name before reusing an open file, and if the file
35674 does not exist, or its inode has changed, the old file is closed and Exim
35675 tries to open the main log from scratch. Thus, an old log file may remain open
35676 for quite some time, but no Exim processes should write to it once it has been
35677 renamed.
35678
35679
35680
35681 .section "Datestamped log files" "SECTdatlogfil"
35682 .cindex "log" "datestamped files"
35683 Instead of cycling the main and reject log files by renaming them
35684 periodically, some sites like to use files whose names contain a datestamp,
35685 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35686 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35687 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35688 point where the datestamp is required. For example:
35689 .code
35690 log_file_path = /var/spool/exim/log/%slog-%D
35691 log_file_path = /var/log/exim-%s-%D.log
35692 log_file_path = /var/spool/exim/log/%D-%slog
35693 log_file_path = /var/log/exim/%s.%M
35694 .endd
35695 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35696 examples of names generated by the above examples:
35697 .code
35698 /var/spool/exim/log/mainlog-20021225
35699 /var/log/exim-reject-20021225.log
35700 /var/spool/exim/log/20021225-mainlog
35701 /var/log/exim/main.200212
35702 .endd
35703 When this form of log file is specified, Exim automatically switches to new
35704 files at midnight. It does not make any attempt to compress old logs; you
35705 will need to write your own script if you require this. You should not
35706 run &'exicyclog'& with this form of logging.
35707
35708 The location of the panic log is also determined by &%log_file_path%&, but it
35709 is not datestamped, because rotation of the panic log does not make sense.
35710 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35711 the string. In addition, if it immediately follows a slash, a following
35712 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35713 character is removed. Thus, the four examples above would give these panic
35714 log names:
35715 .code
35716 /var/spool/exim/log/paniclog
35717 /var/log/exim-panic.log
35718 /var/spool/exim/log/paniclog
35719 /var/log/exim/panic
35720 .endd
35721
35722
35723 .section "Logging to syslog" "SECID249"
35724 .cindex "log" "syslog; writing to"
35725 The use of syslog does not change what Exim logs or the format of its messages,
35726 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35727 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35728 that, the same strings are written to syslog as to log files. The syslog
35729 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35730 by default, but you can change these by setting the &%syslog_facility%& and
35731 &%syslog_processname%& options, respectively. If Exim was compiled with
35732 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35733 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35734 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35735 the time and host name to each line.
35736 The three log streams are mapped onto syslog priorities as follows:
35737
35738 .ilist
35739 &'mainlog'& is mapped to LOG_INFO
35740 .next
35741 &'rejectlog'& is mapped to LOG_NOTICE
35742 .next
35743 &'paniclog'& is mapped to LOG_ALERT
35744 .endlist
35745
35746 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35747 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35748 these are routed by syslog to the same place. You can suppress this duplication
35749 by setting &%syslog_duplication%& false.
35750
35751 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35752 entries contain multiple lines when headers are included. To cope with both
35753 these cases, entries written to syslog are split into separate &[syslog()]&
35754 calls at each internal newline, and also after a maximum of
35755 870 data characters. (This allows for a total syslog line length of 1024, when
35756 additions such as timestamps are added.) If you are running a syslog
35757 replacement that can handle lines longer than the 1024 characters allowed by
35758 RFC 3164, you should set
35759 .code
35760 SYSLOG_LONG_LINES=yes
35761 .endd
35762 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35763 lines, but it still splits at internal newlines in &'reject'& log entries.
35764
35765 To make it easy to re-assemble split lines later, each component of a split
35766 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35767 where <&'n'&> is the component number and <&'m'&> is the total number of
35768 components in the entry. The / delimiter is used when the line was split
35769 because it was too long; if it was split because of an internal newline, the \
35770 delimiter is used. For example, supposing the length limit to be 50 instead of
35771 870, the following would be the result of a typical rejection message to
35772 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35773 name, and pid as added by syslog:
35774 .code
35775 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35776 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35777 [3/5]  when scanning for sender: missing or malformed lo
35778 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35779 [5/5] mple>)
35780 .endd
35781 The same error might cause the following lines to be written to &"rejectlog"&
35782 (LOG_NOTICE):
35783 .code
35784 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35785 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35786 [3/18] er when scanning for sender: missing or malformed
35787 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35788 [5\18] .example>)
35789 [6\18] Recipients: ph10@some.domain.cam.example
35790 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35791 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35792 [9\18]        id 16RdAL-0006pc-00
35793 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35794 [11\18] 09:43 +0100
35795 [12\18] F From: <>
35796 [13\18]   Subject: this is a test header
35797 [18\18]   X-something: this is another header
35798 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35799 [16\18] le>
35800 [17\18] B Bcc:
35801 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35802 .endd
35803 Log lines that are neither too long nor contain newlines are written to syslog
35804 without modification.
35805
35806 If only syslog is being used, the Exim monitor is unable to provide a log tail
35807 display, unless syslog is routing &'mainlog'& to a file on the local host and
35808 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35809 where it is.
35810
35811
35812
35813 .section "Log line flags" "SECID250"
35814 One line is written to the main log for each message received, and for each
35815 successful, unsuccessful, and delayed delivery. These lines can readily be
35816 picked out by the distinctive two-character flags that immediately follow the
35817 timestamp. The flags are:
35818 .display
35819 &`<=`&     message arrival
35820 &`(=`&     message fakereject
35821 &`=>`&     normal message delivery
35822 &`->`&     additional address in same delivery
35823 &`>>`&     cutthrough message delivery
35824 &`*>`&     delivery suppressed by &%-N%&
35825 &`**`&     delivery failed; address bounced
35826 &`==`&     delivery deferred; temporary problem
35827 .endd
35828
35829
35830 .section "Logging message reception" "SECID251"
35831 .cindex "log" "reception line"
35832 The format of the single-line entry in the main log that is written for every
35833 message received is shown in the basic example below, which is split over
35834 several lines in order to fit it on the page:
35835 .code
35836 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35837   H=mailer.fict.example [192.168.123.123] U=exim
35838   P=smtp S=5678 id=<incoming message id>
35839 .endd
35840 The address immediately following &"<="& is the envelope sender address. A
35841 bounce message is shown with the sender address &"<>"&, and if it is locally
35842 generated, this is followed by an item of the form
35843 .code
35844 R=<message id>
35845 .endd
35846 which is a reference to the message that caused the bounce to be sent.
35847
35848 .cindex "HELO"
35849 .cindex "EHLO"
35850 For messages from other hosts, the H and U fields identify the remote host and
35851 record the RFC 1413 identity of the user that sent the message, if one was
35852 received. The number given in square brackets is the IP address of the sending
35853 host. If there is a single, unparenthesized  host name in the H field, as
35854 above, it has been verified to correspond to the IP address (see the
35855 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35856 by the remote host in the SMTP HELO or EHLO command, and has not been
35857 verified. If verification yields a different name to that given for HELO or
35858 EHLO, the verified name appears first, followed by the HELO or EHLO
35859 name in parentheses.
35860
35861 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35862 without brackets, in the HELO or EHLO command, leading to entries in
35863 the log containing text like these examples:
35864 .code
35865 H=(10.21.32.43) [192.168.8.34]
35866 H=([10.21.32.43]) [192.168.8.34]
35867 .endd
35868 This can be confusing. Only the final address in square brackets can be relied
35869 on.
35870
35871 For locally generated messages (that is, messages not received over TCP/IP),
35872 the H field is omitted, and the U field contains the login name of the caller
35873 of Exim.
35874
35875 .cindex "authentication" "logging"
35876 .cindex "AUTH" "logging"
35877 For all messages, the P field specifies the protocol used to receive the
35878 message. This is the value that is stored in &$received_protocol$&. In the case
35879 of incoming SMTP messages, the value indicates whether or not any SMTP
35880 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35881 session was encrypted, there is an additional X field that records the cipher
35882 suite that was used.
35883
35884 .cindex log protocol
35885 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35886 hosts that have authenticated themselves using the SMTP AUTH command. The first
35887 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35888 there is an additional item A= followed by the name of the authenticator that
35889 was used. If an authenticated identification was set up by the authenticator's
35890 &%server_set_id%& option, this is logged too, separated by a colon from the
35891 authenticator name.
35892
35893 .cindex "size" "of message"
35894 The id field records the existing message id, if present. The size of the
35895 received message is given by the S field. When the message is delivered,
35896 headers may be removed or added, so that the size of delivered copies of the
35897 message may not correspond with this value (and indeed may be different to each
35898 other).
35899
35900 The &%log_selector%& option can be used to request the logging of additional
35901 data when a message is received. See section &<<SECTlogselector>>& below.
35902
35903
35904
35905 .section "Logging deliveries" "SECID252"
35906 .cindex "log" "delivery line"
35907 The format of the single-line entry in the main log that is written for every
35908 delivery is shown in one of the examples below, for local and remote
35909 deliveries, respectively. Each example has been split into multiple lines in order
35910 to fit it on the page:
35911 .code
35912 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35913   <marv@hitch.fict.example> R=localuser T=local_delivery
35914 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35915   monk@holistic.fict.example R=dnslookup T=remote_smtp
35916   H=holistic.fict.example [192.168.234.234]
35917 .endd
35918 For ordinary local deliveries, the original address is given in angle brackets
35919 after the final delivery address, which might be a pipe or a file. If
35920 intermediate address(es) exist between the original and the final address, the
35921 last of these is given in parentheses after the final address. The R and T
35922 fields record the router and transport that were used to process the address.
35923
35924 If SMTP AUTH was used for the delivery there is an additional item A=
35925 followed by the name of the authenticator that was used.
35926 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35927 option, this is logged too, separated by a colon from the authenticator name.
35928
35929 If a shadow transport was run after a successful local delivery, the log line
35930 for the successful delivery has an item added on the end, of the form
35931 .display
35932 &`ST=<`&&'shadow transport name'&&`>`&
35933 .endd
35934 If the shadow transport did not succeed, the error message is put in
35935 parentheses afterwards.
35936
35937 .cindex "asterisk" "after IP address"
35938 When more than one address is included in a single delivery (for example, two
35939 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35940 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35941 down a single SMTP connection, an asterisk follows the IP address in the log
35942 lines for the second and subsequent messages.
35943 When two or more messages are delivered down a single TLS connection, the
35944 DNS and some TLS-related information logged for the first message delivered
35945 will not be present in the log lines for the second and subsequent messages.
35946 TLS cipher information is still available.
35947
35948 .cindex "delivery" "cutthrough; logging"
35949 .cindex "cutthrough" "logging"
35950 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35951 line precedes the reception line, since cutthrough waits for a possible
35952 rejection from the destination in case it can reject the sourced item.
35953
35954 The generation of a reply message by a filter file gets logged as a
35955 &"delivery"& to the addressee, preceded by &">"&.
35956
35957 The &%log_selector%& option can be used to request the logging of additional
35958 data when a message is delivered. See section &<<SECTlogselector>>& below.
35959
35960
35961 .section "Discarded deliveries" "SECID253"
35962 .cindex "discarded messages"
35963 .cindex "message" "discarded"
35964 .cindex "delivery" "discarded; logging"
35965 When a message is discarded as a result of the command &"seen finish"& being
35966 obeyed in a filter file which generates no deliveries, a log entry of the form
35967 .code
35968 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35969   <low.club@bridge.example> R=userforward
35970 .endd
35971 is written, to record why no deliveries are logged. When a message is discarded
35972 because it is aliased to &":blackhole:"& the log line is like this:
35973 .code
35974 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35975   <hole@nowhere.example> R=blackhole_router
35976 .endd
35977
35978
35979 .section "Deferred deliveries" "SECID254"
35980 When a delivery is deferred, a line of the following form is logged:
35981 .code
35982 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35983   R=dnslookup T=smtp defer (146): Connection refused
35984 .endd
35985 In the case of remote deliveries, the error is the one that was given for the
35986 last IP address that was tried. Details of individual SMTP failures are also
35987 written to the log, so the above line would be preceded by something like
35988 .code
35989 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35990   mail1.endrest.example [192.168.239.239]: Connection refused
35991 .endd
35992 When a deferred address is skipped because its retry time has not been reached,
35993 a message is written to the log, but this can be suppressed by setting an
35994 appropriate value in &%log_selector%&.
35995
35996
35997
35998 .section "Delivery failures" "SECID255"
35999 .cindex "delivery" "failure; logging"
36000 If a delivery fails because an address cannot be routed, a line of the
36001 following form is logged:
36002 .code
36003 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
36004   <jim@trek99.example>: unknown mail domain
36005 .endd
36006 If a delivery fails at transport time, the router and transport are shown, and
36007 the response from the remote host is included, as in this example:
36008 .code
36009 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
36010   R=dnslookup T=remote_smtp: SMTP error from remote mailer
36011   after pipelined RCPT TO:<ace400@pb.example>: host
36012   pbmail3.py.example [192.168.63.111]: 553 5.3.0
36013   <ace400@pb.example>...Addressee unknown
36014 .endd
36015 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
36016 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
36017 disabling PIPELINING. The log lines for all forms of delivery failure are
36018 flagged with &`**`&.
36019
36020
36021
36022 .section "Fake deliveries" "SECID256"
36023 .cindex "delivery" "fake; logging"
36024 If a delivery does not actually take place because the &%-N%& option has been
36025 used to suppress it, a normal delivery line is written to the log, except that
36026 &"=>"& is replaced by &"*>"&.
36027
36028
36029
36030 .section "Completion" "SECID257"
36031 A line of the form
36032 .code
36033 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
36034 .endd
36035 is written to the main log when a message is about to be removed from the spool
36036 at the end of its processing.
36037
36038
36039
36040
36041 .section "Summary of Fields in Log Lines" "SECID258"
36042 .cindex "log" "summary of fields"
36043 A summary of the field identifiers that are used in log lines is shown in
36044 the following table:
36045 .display
36046 &`A   `&        authenticator name (and optional id and sender)
36047 &`C   `&        SMTP confirmation on delivery
36048 &`    `&        command list for &"no mail in SMTP session"&
36049 &`CV  `&        certificate verification status
36050 &`D   `&        duration of &"no mail in SMTP session"&
36051 &`DN  `&        distinguished name from peer certificate
36052 &`DS  `&        DNSSEC secured lookups
36053 &`DT  `&        on &`=>`& lines: time taken for a delivery
36054 &`F   `&        sender address (on delivery lines)
36055 &`H   `&        host name and IP address
36056 &`I   `&        local interface used
36057 &`K   `&        CHUNKING extension used
36058 &`id  `&        message id for incoming message
36059 &`M8S `&        8BITMIME status for incoming message
36060 &`P   `&        on &`<=`& lines: protocol used
36061 &`    `&        on &`=>`& and &`**`& lines: return path
36062 &`PRDR`&        PRDR extension used
36063 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
36064 &`Q   `&        alternate queue name
36065 &`QT  `&        on &`=>`& lines: time spent on queue so far
36066 &`    `&        on &"Completed"& lines: time spent on queue
36067 &`R   `&        on &`<=`& lines: reference for local bounce
36068 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
36069 &`S   `&        size of message in bytes
36070 &`SNI `&        server name indication from TLS client hello
36071 &`ST  `&        shadow transport name
36072 &`T   `&        on &`<=`& lines: message subject (topic)
36073 &`TFO `&        connection took advantage of TCP Fast Open
36074 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
36075 &`U   `&        local user or RFC 1413 identity
36076 &`X   `&        TLS cipher suite
36077 .endd
36078
36079
36080 .section "Other log entries" "SECID259"
36081 Various other types of log entry are written from time to time. Most should be
36082 self-explanatory. Among the more common are:
36083
36084 .ilist
36085 .cindex "retry" "time not reached"
36086 &'retry time not reached'&&~&~An address previously suffered a temporary error
36087 during routing or local delivery, and the time to retry has not yet arrived.
36088 This message is not written to an individual message log file unless it happens
36089 during the first delivery attempt.
36090 .next
36091 &'retry time not reached for any host'&&~&~An address previously suffered
36092 temporary errors during remote delivery, and the retry time has not yet arrived
36093 for any of the hosts to which it is routed.
36094 .next
36095 .cindex "spool directory" "file locked"
36096 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
36097 some other Exim process is already working on the message. This can be quite
36098 common if queue running processes are started at frequent intervals. The
36099 &'exiwhat'& utility script can be used to find out what Exim processes are
36100 doing.
36101 .next
36102 .cindex "error" "ignored"
36103 &'error ignored'&&~&~There are several circumstances that give rise to this
36104 message:
36105 .olist
36106 Exim failed to deliver a bounce message whose age was greater than
36107 &%ignore_bounce_errors_after%&. The bounce was discarded.
36108 .next
36109 A filter file set up a delivery using the &"noerror"& option, and the delivery
36110 failed. The delivery was discarded.
36111 .next
36112 A delivery set up by a router configured with
36113 . ==== As this is a nested list, any displays it contains must be indented
36114 . ==== as otherwise they are too far to the left.
36115 .code
36116     errors_to = <>
36117 .endd
36118 failed. The delivery was discarded.
36119 .endlist olist
36120 .endlist ilist
36121
36122
36123
36124
36125
36126 .section "Reducing or increasing what is logged" "SECTlogselector"
36127 .cindex "log" "selectors"
36128 By setting the &%log_selector%& global option, you can disable some of Exim's
36129 default logging, or you can request additional logging. The value of
36130 &%log_selector%& is made up of names preceded by plus or minus characters. For
36131 example:
36132 .code
36133 log_selector = +arguments -retry_defer
36134 .endd
36135 The list of optional log items is in the following table, with the default
36136 selection marked by asterisks:
36137 .display
36138 &` 8bitmime                   `&  received 8BITMIME status
36139 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
36140 &` address_rewrite            `&  address rewriting
36141 &` all_parents                `&  all parents in => lines
36142 &` arguments                  `&  command line arguments
36143 &`*connection_reject          `&  connection rejections
36144 &`*delay_delivery             `&  immediate delivery delayed
36145 &` deliver_time               `&  time taken to perform delivery
36146 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
36147 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
36148 &` dnssec                     `&  DNSSEC secured lookups
36149 &`*etrn                       `&  ETRN commands
36150 &`*host_lookup_failed         `&  as it says
36151 &` ident_timeout              `&  timeout for ident connection
36152 &` incoming_interface         `&  local interface on <= and => lines
36153 &` incoming_port              `&  remote port on <= lines
36154 &`*lost_incoming_connection   `&  as it says (includes timeouts)
36155 &` millisec                   `&  millisecond timestamps and QT,DT,D times
36156 &` outgoing_interface         `&  local interface on => lines
36157 &` outgoing_port              `&  add remote port to => lines
36158 &`*queue_run                  `&  start and end queue runs
36159 &` queue_time                 `&  time on queue for one recipient
36160 &` queue_time_overall         `&  time on queue for whole message
36161 &` pid                        `&  Exim process id
36162 &` proxy                      `&  proxy address on <= and => lines
36163 &` received_recipients        `&  recipients on <= lines
36164 &` received_sender            `&  sender on <= lines
36165 &`*rejected_header            `&  header contents on reject log
36166 &`*retry_defer                `&  &"retry time not reached"&
36167 &` return_path_on_delivery    `&  put return path on => and ** lines
36168 &` sender_on_delivery         `&  add sender to => lines
36169 &`*sender_verify_fail         `&  sender verification failures
36170 &`*size_reject                `&  rejection because too big
36171 &`*skip_delivery              `&  delivery skipped in a queue run
36172 &`*smtp_confirmation          `&  SMTP confirmation on => lines
36173 &` smtp_connection            `&  incoming SMTP connections
36174 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
36175 &` smtp_mailauth              `&  AUTH argument to MAIL commands
36176 &` smtp_no_mail               `&  session with no MAIL commands
36177 &` smtp_protocol_error        `&  SMTP protocol errors
36178 &` smtp_syntax_error          `&  SMTP syntax errors
36179 &` subject                    `&  contents of &'Subject:'& on <= lines
36180 &`*tls_certificate_verified   `&  certificate verification status
36181 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
36182 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
36183 &` tls_sni                    `&  TLS SNI on <= lines
36184 &` unknown_in_list            `&  DNS lookup failed in list match
36185
36186 &` all                        `&  all of the above
36187 .endd
36188 See also the &%slow_lookup_log%& main configuration option,
36189 section &<<SECID99>>&
36190
36191 More details on each of these items follows:
36192
36193 .ilist
36194 .cindex "8BITMIME"
36195 .cindex "log" "8BITMIME"
36196 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
36197 which may help in tracking down interoperability issues with ancient MTAs
36198 that are not 8bit clean.  This is added to the &"<="& line, tagged with
36199 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
36200 &`7BIT`& and &`8BITMIME`& respectively.
36201 .next
36202 .cindex "&%warn%& ACL verb" "log when skipping"
36203 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
36204 its conditions cannot be evaluated, a log line to this effect is written if
36205 this log selector is set.
36206 .next
36207 .cindex "log" "rewriting"
36208 .cindex "rewriting" "logging"
36209 &%address_rewrite%&: This applies both to global rewrites and per-transport
36210 rewrites, but not to rewrites in filters run as an unprivileged user (because
36211 such users cannot access the log).
36212 .next
36213 .cindex "log" "full parentage"
36214 &%all_parents%&: Normally only the original and final addresses are logged on
36215 delivery lines; with this selector, intermediate parents are given in
36216 parentheses between them.
36217 .next
36218 .cindex "log" "Exim arguments"
36219 .cindex "Exim arguments, logging"
36220 &%arguments%&: This causes Exim to write the arguments with which it was called
36221 to the main log, preceded by the current working directory. This is a debugging
36222 feature, added to make it easier to find out how certain MUAs call
36223 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
36224 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
36225 that are empty or that contain white space are quoted. Non-printing characters
36226 are shown as escape sequences. This facility cannot log unrecognized arguments,
36227 because the arguments are checked before the configuration file is read. The
36228 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
36229 between the caller and Exim.
36230 .next
36231 .cindex "log" "connection rejections"
36232 &%connection_reject%&: A log entry is written whenever an incoming SMTP
36233 connection is rejected, for whatever reason.
36234 .next
36235 .cindex "log" "delayed delivery"
36236 .cindex "delayed delivery, logging"
36237 &%delay_delivery%&: A log entry is written whenever a delivery process is not
36238 started for an incoming message because the load is too high or too many
36239 messages were received on one connection. Logging does not occur if no delivery
36240 process is started because &%queue_only%& is set or &%-odq%& was used.
36241 .next
36242 .cindex "log" "delivery duration"
36243 &%deliver_time%&: For each delivery, the amount of real time it has taken to
36244 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
36245 If millisecond logging is enabled, short times will be shown with greater
36246 precision, eg. &`DT=0.304`&.
36247 .next
36248 .cindex "log" "message size on delivery"
36249 .cindex "size" "of message"
36250 &%delivery_size%&: For each delivery, the size of message delivered is added to
36251 the &"=>"& line, tagged with S=.
36252 .next
36253 .cindex "log" "dnslist defer"
36254 .cindex "DNS list" "logging defer"
36255 .cindex "black list (DNS)"
36256 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
36257 DNS black list suffers a temporary error.
36258 .next
36259 .cindex log dnssec
36260 .cindex dnssec logging
36261 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
36262 dns lookups gave secure results a tag of DS is added.
36263 For acceptance this covers the reverse and forward lookups for host name verification.
36264 It does not cover helo-name verification.
36265 For delivery this covers the SRV, MX, A and/or AAAA lookups.
36266 .next
36267 .cindex "log" "ETRN commands"
36268 .cindex "ETRN" "logging"
36269 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
36270 is run to determine whether or not it is actually accepted. An invalid ETRN
36271 command, or one received within a message transaction is not logged by this
36272 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
36273 .next
36274 .cindex "log" "host lookup failure"
36275 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
36276 any addresses, or when a lookup of an IP address fails to find a host name, a
36277 log line is written. This logging does not apply to direct DNS lookups when
36278 routing email addresses, but it does apply to &"byname"& lookups.
36279 .next
36280 .cindex "log" "ident timeout"
36281 .cindex "RFC 1413" "logging timeout"
36282 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
36283 client's ident port times out.
36284 .next
36285 .cindex "log" "incoming interface"
36286 .cindex "log" "local interface"
36287 .cindex "log" "local address and port"
36288 .cindex "TCP/IP" "logging local address and port"
36289 .cindex "interface" "logging"
36290 &%incoming_interface%&: The interface on which a message was received is added
36291 to the &"<="& line as an IP address in square brackets, tagged by I= and
36292 followed by a colon and the port number. The local interface and port are also
36293 added to other SMTP log lines, for example &"SMTP connection from"&, to
36294 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
36295 The latter can be disabled by turning off the &%outgoing_interface%& option.
36296 .next
36297 .cindex log "incoming proxy address"
36298 .cindex proxy "logging proxy address"
36299 .cindex "TCP/IP" "logging proxy address"
36300 &%proxy%&: The internal (closest to the system running Exim) IP address
36301 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
36302 on a proxied connection
36303 or the &"=>"& line for a message delivered on a proxied connection.
36304 See &<<SECTproxyInbound>>& for more information.
36305 .next
36306 .cindex "log" "incoming remote port"
36307 .cindex "port" "logging remote"
36308 .cindex "TCP/IP" "logging incoming remote port"
36309 .vindex "&$sender_fullhost$&"
36310 .vindex "&$sender_rcvhost$&"
36311 &%incoming_port%&: The remote port number from which a message was received is
36312 added to log entries and &'Received:'& header lines, following the IP address
36313 in square brackets, and separated from it by a colon. This is implemented by
36314 changing the value that is put in the &$sender_fullhost$& and
36315 &$sender_rcvhost$& variables. Recording the remote port number has become more
36316 important with the widening use of NAT (see RFC 2505).
36317 .next
36318 .cindex "log" "dropped connection"
36319 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
36320 connection is unexpectedly dropped.
36321 .next
36322 .cindex "log" "millisecond timestamps"
36323 .cindex millisecond logging
36324 .cindex timstamps "millisecond, in logs"
36325 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
36326 appended to the seconds value.
36327 .next
36328 .cindex "log" "outgoing interface"
36329 .cindex "log" "local interface"
36330 .cindex "log" "local address and port"
36331 .cindex "TCP/IP" "logging local address and port"
36332 .cindex "interface" "logging"
36333 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
36334 interface on which a message was sent is added to delivery lines as an I= tag
36335 followed by IP address in square brackets. You can disable this by turning
36336 off the &%outgoing_interface%& option.
36337 .next
36338 .cindex "log" "outgoing remote port"
36339 .cindex "port" "logging outgoint remote"
36340 .cindex "TCP/IP" "logging outgoing remote port"
36341 &%outgoing_port%&: The remote port number is added to delivery log lines (those
36342 containing => tags) following the IP address.
36343 The local port is also added if &%incoming_interface%& and
36344 &%outgoing_interface%& are both enabled.
36345 This option is not included in the default setting, because for most ordinary
36346 configurations, the remote port number is always 25 (the SMTP port), and the
36347 local port is a random ephemeral port.
36348 .next
36349 .cindex "log" "process ids in"
36350 .cindex "pid (process id)" "in log lines"
36351 &%pid%&: The current process id is added to every log line, in square brackets,
36352 immediately after the time and date.
36353 .next
36354 .cindex "log" "queue run"
36355 .cindex "queue runner" "logging"
36356 &%queue_run%&: The start and end of every queue run are logged.
36357 .next
36358 .cindex "log" "queue time"
36359 &%queue_time%&: The amount of time the message has been in the queue on the
36360 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
36361 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
36362 includes reception time as well as the delivery time for the current address.
36363 This means that it may be longer than the difference between the arrival and
36364 delivery log line times, because the arrival log line is not written until the
36365 message has been successfully received.
36366 If millisecond logging is enabled, short times will be shown with greater
36367 precision, eg. &`QT=1.578s`&.
36368 .next
36369 &%queue_time_overall%&: The amount of time the message has been in the queue on
36370 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
36371 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
36372 message, so it includes reception time as well as the total delivery time.
36373 .next
36374 .cindex "log" "recipients"
36375 &%received_recipients%&: The recipients of a message are listed in the main log
36376 as soon as the message is received. The list appears at the end of the log line
36377 that is written when a message is received, preceded by the word &"for"&. The
36378 addresses are listed after they have been qualified, but before any rewriting
36379 has taken place.
36380 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
36381 in the list.
36382 .next
36383 .cindex "log" "sender reception"
36384 &%received_sender%&: The unrewritten original sender of a message is added to
36385 the end of the log line that records the message's arrival, after the word
36386 &"from"& (before the recipients if &%received_recipients%& is also set).
36387 .next
36388 .cindex "log" "header lines for rejection"
36389 &%rejected_header%&: If a message's header has been received at the time a
36390 rejection is written to the reject log, the complete header is added to the
36391 log. Header logging can be turned off individually for messages that are
36392 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
36393 .next
36394 .cindex "log" "retry defer"
36395 &%retry_defer%&: A log line is written if a delivery is deferred because a
36396 retry time has not yet been reached. However, this &"retry time not reached"&
36397 message is always omitted from individual message logs after the first delivery
36398 attempt.
36399 .next
36400 .cindex "log" "return path"
36401 &%return_path_on_delivery%&: The return path that is being transmitted with
36402 the message is included in delivery and bounce lines, using the tag P=.
36403 This is omitted if no delivery actually happens, for example, if routing fails,
36404 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36405 .next
36406 .cindex "log" "sender on delivery"
36407 &%sender_on_delivery%&: The message's sender address is added to every delivery
36408 and bounce line, tagged by F= (for &"from"&).
36409 This is the original sender that was received with the message; it is not
36410 necessarily the same as the outgoing return path.
36411 .next
36412 .cindex "log" "sender verify failure"
36413 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36414 gives details of a sender verification failure is not written. Log lines for
36415 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36416 detail is lost.
36417 .next
36418 .cindex "log" "size rejection"
36419 &%size_reject%&: A log line is written whenever a message is rejected because
36420 it is too big.
36421 .next
36422 .cindex "log" "frozen messages; skipped"
36423 .cindex "frozen messages" "logging skipping"
36424 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36425 queue run because it is frozen or because another process is already delivering
36426 it.
36427 .cindex "&""spool file is locked""&"
36428 The message that is written is &"spool file is locked"&.
36429 .next
36430 .cindex "log" "smtp confirmation"
36431 .cindex "SMTP" "logging confirmation"
36432 .cindex "LMTP" "logging confirmation"
36433 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36434 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36435 A number of MTAs (including Exim) return an identifying string in this
36436 response.
36437 .next
36438 .cindex "log" "SMTP connections"
36439 .cindex "SMTP" "logging connections"
36440 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36441 established or closed, unless the connection is from a host that matches
36442 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36443 only when the closure is unexpected.) This applies to connections from local
36444 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36445 dropped in the middle of a message, a log line is always written, whether or
36446 not this selector is set, but otherwise nothing is written at the start and end
36447 of connections unless this selector is enabled.
36448
36449 For TCP/IP connections to an Exim daemon, the current number of connections is
36450 included in the log message for each new connection, but note that the count is
36451 reset if the daemon is restarted.
36452 Also, because connections are closed (and the closure is logged) in
36453 subprocesses, the count may not include connections that have been closed but
36454 whose termination the daemon has not yet noticed. Thus, while it is possible to
36455 match up the opening and closing of connections in the log, the value of the
36456 logged counts may not be entirely accurate.
36457 .next
36458 .cindex "log" "SMTP transaction; incomplete"
36459 .cindex "SMTP" "logging incomplete transactions"
36460 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36461 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36462 and the message sender plus any accepted recipients are included in the log
36463 line. This can provide evidence of dictionary attacks.
36464 .next
36465 .cindex "log" "non-MAIL SMTP sessions"
36466 .cindex "MAIL" "logging session without"
36467 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36468 connection terminates without having issued a MAIL command. This includes both
36469 the case when the connection is dropped, and the case when QUIT is used. It
36470 does not include cases where the connection is rejected right at the start (by
36471 an ACL, or because there are too many connections, or whatever). These cases
36472 already have their own log lines.
36473
36474 The log line that is written contains the identity of the client in the usual
36475 way, followed by D= and a time, which records the duration of the connection.
36476 If the connection was authenticated, this fact is logged exactly as it is for
36477 an incoming message, with an A= item. If the connection was encrypted, CV=,
36478 DN=, and X= items may appear as they do for an incoming message, controlled by
36479 the same logging options.
36480
36481 Finally, if any SMTP commands were issued during the connection, a C= item
36482 is added to the line, listing the commands that were used. For example,
36483 .code
36484 C=EHLO,QUIT
36485 .endd
36486 shows that the client issued QUIT straight after EHLO. If there were fewer
36487 than 20 commands, they are all listed. If there were more than 20 commands,
36488 the last 20 are listed, preceded by &"..."&. However, with the default
36489 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36490 have been aborted before 20 non-mail commands are processed.
36491 .next
36492 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36493 colon-separated, is appended to the A= item for a message arrival or delivery
36494 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36495 was accepted or used.
36496 .next
36497 .cindex "log" "SMTP protocol error"
36498 .cindex "SMTP" "logging protocol error"
36499 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36500 encountered. Exim does not have perfect detection of all protocol errors
36501 because of transmission delays and the use of pipelining. If PIPELINING has
36502 been advertised to a client, an Exim server assumes that the client will use
36503 it, and therefore it does not count &"expected"& errors (for example, RCPT
36504 received after rejecting MAIL) as protocol errors.
36505 .next
36506 .cindex "SMTP" "logging syntax errors"
36507 .cindex "SMTP" "syntax errors; logging"
36508 .cindex "SMTP" "unknown command; logging"
36509 .cindex "log" "unknown SMTP command"
36510 .cindex "log" "SMTP syntax error"
36511 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36512 encountered. An unrecognized command is treated as a syntax error. For an
36513 external connection, the host identity is given; for an internal connection
36514 using &%-bs%& the sender identification (normally the calling user) is given.
36515 .next
36516 .cindex "log" "subject"
36517 .cindex "subject, logging"
36518 &%subject%&: The subject of the message is added to the arrival log line,
36519 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36520 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36521 specifies whether characters with values greater than 127 should be logged
36522 unchanged, or whether they should be rendered as escape sequences.
36523 .next
36524 .cindex "log" "certificate verification"
36525 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36526 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36527 verified, and &`CV=no`& if not.
36528 .next
36529 .cindex "log" "TLS cipher"
36530 .cindex "TLS" "logging cipher"
36531 &%tls_cipher%&: When a message is sent or received over an encrypted
36532 connection, the cipher suite used is added to the log line, preceded by X=.
36533 .next
36534 .cindex "log" "TLS peer DN"
36535 .cindex "TLS" "logging peer DN"
36536 &%tls_peerdn%&: When a message is sent or received over an encrypted
36537 connection, and a certificate is supplied by the remote host, the peer DN is
36538 added to the log line, preceded by DN=.
36539 .next
36540 .cindex "log" "TLS SNI"
36541 .cindex "TLS" "logging SNI"
36542 &%tls_sni%&: When a message is received over an encrypted connection, and
36543 the remote host provided the Server Name Indication extension, the SNI is
36544 added to the log line, preceded by SNI=.
36545 .next
36546 .cindex "log" "DNS failure in list"
36547 &%unknown_in_list%&: This setting causes a log entry to be written when the
36548 result of a list match is failure because a DNS lookup failed.
36549 .endlist
36550
36551
36552 .section "Message log" "SECID260"
36553 .cindex "message" "log file for"
36554 .cindex "log" "message log; description of"
36555 .cindex "&_msglog_& directory"
36556 .oindex "&%preserve_message_logs%&"
36557 In addition to the general log files, Exim writes a log file for each message
36558 that it handles. The names of these per-message logs are the message ids, and
36559 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36560 message log contains copies of the log lines that apply to the message. This
36561 makes it easier to inspect the status of an individual message without having
36562 to search the main log. A message log is deleted when processing of the message
36563 is complete, unless &%preserve_message_logs%& is set, but this should be used
36564 only with great care because they can fill up your disk very quickly.
36565
36566 On a heavily loaded system, it may be desirable to disable the use of
36567 per-message logs, in order to reduce disk I/O. This can be done by setting the
36568 &%message_logs%& option false.
36569 .ecindex IIDloggen
36570
36571
36572
36573
36574 . ////////////////////////////////////////////////////////////////////////////
36575 . ////////////////////////////////////////////////////////////////////////////
36576
36577 .chapter "Exim utilities" "CHAPutils"
36578 .scindex IIDutils "utilities"
36579 A number of utility scripts and programs are supplied with Exim and are
36580 described in this chapter. There is also the Exim Monitor, which is covered in
36581 the next chapter. The utilities described here are:
36582
36583 .itable none 0 0 3  7* left  15* left  40* left
36584 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36585   "list what Exim processes are doing"
36586 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36587 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36588 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36589 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36590                                                 various criteria"
36591 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36592 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36593   "extract statistics from the log"
36594 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36595   "check address acceptance from given IP"
36596 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36597 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36598 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36599 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36600 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36601 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36602 .endtable
36603
36604 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36605 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36606 &url(http://duncanthrax.net/exilog/) for details.
36607
36608
36609
36610
36611 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36612 .cindex "&'exiwhat'&"
36613 .cindex "process, querying"
36614 .cindex "SIGUSR1"
36615 On operating systems that can restart a system call after receiving a signal
36616 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36617 a line describing what it is doing to the file &_exim-process.info_& in the
36618 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36619 processes it can find, having first emptied the file. It then waits for one
36620 second to allow the Exim processes to react before displaying the results. In
36621 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36622 send the signal to the Exim processes, so it is normally run as root.
36623
36624 &*Warning*&: This is not an efficient process. It is intended for occasional
36625 use by system administrators. It is not sensible, for example, to set up a
36626 script that sends SIGUSR1 signals to Exim processes at short intervals.
36627
36628
36629 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36630 varies in different operating systems. Not only are different options used,
36631 but the format of the output is different. For this reason, there are some
36632 system configuration options that configure exactly how &'exiwhat'& works. If
36633 it doesn't seem to be working for you, check the following compile-time
36634 options:
36635 .display
36636 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36637 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36638 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36639 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36640 .endd
36641 An example of typical output from &'exiwhat'& is
36642 .code
36643 164 daemon: -q1h, listening on port 25
36644 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36645 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36646   [10.19.42.42] (editor@ref.example)
36647 10592 handling incoming call from [192.168.243.242]
36648 10628 accepting a local non-SMTP message
36649 .endd
36650 The first number in the output line is the process number. The third line has
36651 been split here, in order to fit it on the page.
36652
36653
36654
36655 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36656 .cindex "&'exiqgrep'&"
36657 .cindex "queue" "grepping"
36658 This utility is a Perl script contributed by Matt Hubbard. It runs
36659 .code
36660 exim -bpu
36661 .endd
36662 or (in case &*-a*& switch is specified)
36663 .code
36664 exim -bp
36665 .endd
36666 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36667 contain alternate exim configuration the queue management might be using.
36668
36669 to obtain a queue listing, and then greps the output to select messages
36670 that match given criteria. The following selection options are available:
36671
36672 .vlist
36673 .vitem &*-f*&&~<&'regex'&>
36674 Match the sender address using a case-insensitive search. The field that is
36675 tested is enclosed in angle brackets, so you can test for bounce messages with
36676 .code
36677 exiqgrep -f '^<>$'
36678 .endd
36679 .vitem &*-r*&&~<&'regex'&>
36680 Match a recipient address using a case-insensitive search. The field that is
36681 tested is not enclosed in angle brackets.
36682
36683 .vitem &*-s*&&~<&'regex'&>
36684 Match against the size field.
36685
36686 .vitem &*-y*&&~<&'seconds'&>
36687 Match messages that are younger than the given time.
36688
36689 .vitem &*-o*&&~<&'seconds'&>
36690 Match messages that are older than the given time.
36691
36692 .vitem &*-z*&
36693 Match only frozen messages.
36694
36695 .vitem &*-x*&
36696 Match only non-frozen messages.
36697 .endlist
36698
36699 The following options control the format of the output:
36700
36701 .vlist
36702 .vitem &*-c*&
36703 Display only the count of matching messages.
36704
36705 .vitem &*-l*&
36706 Long format &-- display the full message information as output by Exim. This is
36707 the default.
36708
36709 .vitem &*-i*&
36710 Display message ids only.
36711
36712 .vitem &*-b*&
36713 Brief format &-- one line per message.
36714
36715 .vitem &*-R*&
36716 Display messages in reverse order.
36717
36718 .vitem &*-a*&
36719 Include delivered recipients in queue listing.
36720 .endlist
36721
36722 There is one more option, &%-h%&, which outputs a list of options.
36723
36724
36725
36726 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36727 .cindex "&'exiqsumm'&"
36728 .cindex "queue" "summary"
36729 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36730 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36731 running a command such as
36732 .code
36733 exim -bp | exiqsumm
36734 .endd
36735 The output consists of one line for each domain that has messages waiting for
36736 it, as in the following example:
36737 .code
36738 3   2322   74m   66m  msn.com.example
36739 .endd
36740 Each line lists the number of pending deliveries for a domain, their total
36741 volume, and the length of time that the oldest and the newest messages have
36742 been waiting. Note that the number of pending deliveries is greater than the
36743 number of messages when messages have more than one recipient.
36744
36745 A summary line is output at the end. By default the output is sorted on the
36746 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36747 the output to be sorted by oldest message and by count of messages,
36748 respectively. There are also three options that split the messages for each
36749 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36750 separates frozen messages, and &%-s%& separates messages according to their
36751 sender.
36752
36753 The output of &'exim -bp'& contains the original addresses in the message, so
36754 this also applies to the output from &'exiqsumm'&. No domains from addresses
36755 generated by aliasing or forwarding are included (unless the &%one_time%&
36756 option of the &(redirect)& router has been used to convert them into &"top
36757 level"& addresses).
36758
36759
36760
36761
36762 .section "Extracting specific information from the log (exigrep)" &&&
36763          "SECTextspeinf"
36764 .cindex "&'exigrep'&"
36765 .cindex "log" "extracts; grepping for"
36766 The &'exigrep'& utility is a Perl script that searches one or more main log
36767 files for entries that match a given pattern. When it finds a match, it
36768 extracts all the log entries for the relevant message, not just those that
36769 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36770 given message, or all mail for a given user, or for a given host, for example.
36771 The input files can be in Exim log format or syslog format.
36772 If a matching log line is not associated with a specific message, it is
36773 included in &'exigrep'&'s output without any additional lines. The usage is:
36774 .display
36775 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36776 .endd
36777 If no log file names are given on the command line, the standard input is read.
36778
36779 The &%-t%& argument specifies a number of seconds. It adds an additional
36780 condition for message selection. Messages that are complete are shown only if
36781 they spent more than <&'n'&> seconds on the queue.
36782
36783 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36784 makes it case-sensitive. This may give a performance improvement when searching
36785 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36786 option; with &%-I%& they do not. In both cases it is possible to change the
36787 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36788
36789 The &%-l%& option means &"literal"&, that is, treat all characters in the
36790 pattern as standing for themselves. Otherwise the pattern must be a Perl
36791 regular expression.
36792
36793 The &%-v%& option inverts the matching condition. That is, a line is selected
36794 if it does &'not'& match the pattern.
36795
36796 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36797 that are generated as a result/response to a message that &'exigrep'& matched
36798 normally.
36799
36800 Example of &%-M%&:
36801 user_a sends a message to user_b, which generates a bounce back to user_b. If
36802 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36803 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36804 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36805 when searching for &"user_a"& will show both messages since the bounce is
36806 &"related"& to or a &"result"& of the first message that was found by the
36807 search term.
36808
36809 If the location of a &'zcat'& command is known from the definition of
36810 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36811 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36812 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36813 autodetection of some well known compression extensions.
36814
36815
36816 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36817 .cindex "&'exipick'&"
36818 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36819 lists messages from the queue according to a variety of criteria. For details
36820 of &'exipick'&'s facilities, run &'exipick'& with
36821 the &%--help%& option.
36822
36823
36824 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36825 .cindex "log" "cycling local files"
36826 .cindex "cycling logs"
36827 .cindex "&'exicyclog'&"
36828 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36829 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36830 you are using log files with datestamps in their names (see section
36831 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36832 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36833 There are two command line options for &'exicyclog'&:
36834 .ilist
36835 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36836 default that is set when Exim is built. The default default is 10.
36837 .next
36838 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36839 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36840 overriding the script's default, which is to find the setting from Exim's
36841 configuration.
36842 .endlist
36843
36844 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36845 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36846 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36847 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36848 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36849 logs are handled similarly.
36850
36851 If the limit is greater than 99, the script uses 3-digit numbers such as
36852 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36853 to one that is greater, or &'vice versa'&, you will have to fix the names of
36854 any existing log files.
36855
36856 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36857 the end are deleted. All files with numbers greater than 01 are compressed,
36858 using a compression command which is configured by the COMPRESS_COMMAND
36859 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36860 root &%crontab%& entry of the form
36861 .code
36862 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36863 .endd
36864 assuming you have used the name &"exim"& for the Exim user. You can run
36865 &'exicyclog'& as root if you wish, but there is no need.
36866
36867
36868
36869 .section "Mail statistics (eximstats)" "SECTmailstat"
36870 .cindex "statistics"
36871 .cindex "&'eximstats'&"
36872 A Perl script called &'eximstats'& is provided for extracting statistical
36873 information from log files. The output is either plain text, or HTML.
36874 Exim log files are also supported by the &'Lire'& system produced by the
36875 LogReport Foundation &url(http://www.logreport.org).
36876
36877 The &'eximstats'& script has been hacked about quite a bit over time. The
36878 latest version is the result of some extensive revision by Steve Campbell. A
36879 lot of information is given by default, but there are options for suppressing
36880 various parts of it. Following any options, the arguments to the script are a
36881 list of files, which should be main log files. For example:
36882 .code
36883 eximstats -nr /var/spool/exim/log/mainlog.01
36884 .endd
36885 By default, &'eximstats'& extracts information about the number and volume of
36886 messages received from or delivered to various hosts. The information is sorted
36887 both by message count and by volume, and the top fifty hosts in each category
36888 are listed on the standard output. Similar information, based on email
36889 addresses or domains instead of hosts can be requested by means of various
36890 options. For messages delivered and received locally, similar statistics are
36891 also produced per user.
36892
36893 The output also includes total counts and statistics about delivery errors, and
36894 histograms showing the number of messages received and deliveries made in each
36895 hour of the day. A delivery with more than one address in its envelope (for
36896 example, an SMTP transaction with more than one RCPT command) is counted
36897 as a single delivery by &'eximstats'&.
36898
36899 Though normally more deliveries than receipts are reported (as messages may
36900 have multiple recipients), it is possible for &'eximstats'& to report more
36901 messages received than delivered, even though the queue is empty at the start
36902 and end of the period in question. If an incoming message contains no valid
36903 recipients, no deliveries are recorded for it. A bounce message is handled as
36904 an entirely separate message.
36905
36906 &'eximstats'& always outputs a grand total summary giving the volume and number
36907 of messages received and deliveries made, and the number of hosts involved in
36908 each case. It also outputs the number of messages that were delayed (that is,
36909 not completely delivered at the first attempt), and the number that had at
36910 least one address that failed.
36911
36912 The remainder of the output is in sections that can be independently disabled
36913 or modified by various options. It consists of a summary of deliveries by
36914 transport, histograms of messages received and delivered per time interval
36915 (default per hour), information about the time messages spent on the queue,
36916 a list of relayed messages, lists of the top fifty sending hosts, local
36917 senders, destination hosts, and destination local users by count and by volume,
36918 and a list of delivery errors that occurred.
36919
36920 The relay information lists messages that were actually relayed, that is, they
36921 came from a remote host and were directly delivered to some other remote host,
36922 without being processed (for example, for aliasing or forwarding) locally.
36923
36924 There are quite a few options for &'eximstats'& to control exactly what it
36925 outputs. These are documented in the Perl script itself, and can be extracted
36926 by running the command &(perldoc)& on the script. For example:
36927 .code
36928 perldoc /usr/exim/bin/eximstats
36929 .endd
36930
36931 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36932 .cindex "&'exim_checkaccess'&"
36933 .cindex "policy control" "checking access"
36934 .cindex "checking access"
36935 The &%-bh%& command line argument allows you to run a fake SMTP session with
36936 debugging output, in order to check what Exim is doing when it is applying
36937 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36938 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36939 sometimes you just want to answer the question &"Does this address have
36940 access?"& without bothering with any further details.
36941
36942 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36943 two arguments, an IP address and an email address:
36944 .code
36945 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36946 .endd
36947 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36948 given email address would be accepted in a RCPT command in a TCP/IP
36949 connection from the host with the given IP address. The output of the utility
36950 is either the word &"accepted"&, or the SMTP error response, for example:
36951 .code
36952 Rejected:
36953 550 Relay not permitted
36954 .endd
36955 When running this test, the utility uses &`<>`& as the envelope sender address
36956 for the MAIL command, but you can change this by providing additional
36957 options. These are passed directly to the Exim command. For example, to specify
36958 that the test is to be run with the sender address &'himself@there.example'&
36959 you can use:
36960 .code
36961 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36962                  -f himself@there.example
36963 .endd
36964 Note that these additional Exim command line items must be given after the two
36965 mandatory arguments.
36966
36967 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36968 while running its checks. You can run checks that include callouts by using
36969 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36970
36971
36972
36973 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36974 .cindex "DBM" "building dbm files"
36975 .cindex "building DBM files"
36976 .cindex "&'exim_dbmbuild'&"
36977 .cindex "lower casing"
36978 .cindex "binary zero" "in lookup key"
36979 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36980 the format used by the &(lsearch)& lookup (see section
36981 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36982 names as keys and the remainder of the information as data. The lower-casing
36983 can be prevented by calling the program with the &%-nolc%& option.
36984
36985 A terminating zero is included as part of the key string. This is expected by
36986 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36987 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36988 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36989 files.
36990
36991 The program requires two arguments: the name of the input file (which can be a
36992 single hyphen to indicate the standard input), and the name of the output file.
36993 It creates the output under a temporary name, and then renames it if all went
36994 well.
36995
36996 .cindex "USE_DB"
36997 If the native DB interface is in use (USE_DB is set in a compile-time
36998 configuration file &-- this is common in free versions of Unix) the two file
36999 names must be different, because in this mode the Berkeley DB functions create
37000 a single output file using exactly the name given. For example,
37001 .code
37002 exim_dbmbuild /etc/aliases /etc/aliases.db
37003 .endd
37004 reads the system alias file and creates a DBM version of it in
37005 &_/etc/aliases.db_&.
37006
37007 In systems that use the &'ndbm'& routines (mostly proprietary versions of
37008 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
37009 environment, the suffixes are added to the second argument of
37010 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
37011 when the Berkeley functions are used in compatibility mode (though this is not
37012 recommended), because in that case it adds a &_.db_& suffix to the file name.
37013
37014 If a duplicate key is encountered, the program outputs a warning, and when it
37015 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
37016 option is used. By default, only the first of a set of duplicates is used &--
37017 this makes it compatible with &(lsearch)& lookups. There is an option
37018 &%-lastdup%& which causes it to use the data for the last duplicate instead.
37019 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
37020 &%stderr%&. For other errors, where it doesn't actually make a new file, the
37021 return code is 2.
37022
37023
37024
37025
37026 .section "Finding individual retry times (exinext)" "SECTfinindret"
37027 .cindex "retry" "times"
37028 .cindex "&'exinext'&"
37029 A utility called &'exinext'& (mostly a Perl script) provides the ability to
37030 fish specific information out of the retry database. Given a mail domain (or a
37031 complete address), it looks up the hosts for that domain, and outputs any retry
37032 information for the hosts or for the domain. At present, the retry information
37033 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
37034 output. For example:
37035 .code
37036 $ exinext piglet@milne.fict.example
37037 kanga.milne.example:192.168.8.1 error 146: Connection refused
37038   first failed: 21-Feb-1996 14:57:34
37039   last tried:   21-Feb-1996 14:57:34
37040   next try at:  21-Feb-1996 15:02:34
37041 roo.milne.example:192.168.8.3 error 146: Connection refused
37042   first failed: 20-Jan-1996 13:12:08
37043   last tried:   21-Feb-1996 11:42:03
37044   next try at:  21-Feb-1996 19:42:03
37045   past final cutoff time
37046 .endd
37047 You can also give &'exinext'& a local part, without a domain, and it
37048 will give any retry information for that local part in your default domain.
37049 A message id can be used to obtain retry information pertaining to a specific
37050 message. This exists only when an attempt to deliver a message to a remote host
37051 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
37052 &'exinext'& is not particularly efficient, but then it is not expected to be
37053 run very often.
37054
37055 The &'exinext'& utility calls Exim to find out information such as the location
37056 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
37057 passed on to the &'exim'& commands. The first specifies an alternate Exim
37058 configuration file, and the second sets macros for use within the configuration
37059 file. These features are mainly to help in testing, but might also be useful in
37060 environments where more than one configuration file is in use.
37061
37062
37063
37064 .section "Hints database maintenance" "SECThindatmai"
37065 .cindex "hints database" "maintenance"
37066 .cindex "maintaining Exim's hints database"
37067 Three utility programs are provided for maintaining the DBM files that Exim
37068 uses to contain its delivery hint information. Each program requires two
37069 arguments. The first specifies the name of Exim's spool directory, and the
37070 second is the name of the database it is to operate on. These are as follows:
37071
37072 .ilist
37073 &'retry'&: the database of retry information
37074 .next
37075 &'wait-'&<&'transport name'&>: databases of information about messages waiting
37076 for remote hosts
37077 .next
37078 &'callout'&: the callout cache
37079 .next
37080 &'ratelimit'&: the data for implementing the ratelimit ACL condition
37081 .next
37082 &'misc'&: other hints data
37083 .endlist
37084
37085 The &'misc'& database is used for
37086
37087 .ilist
37088 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
37089 .next
37090 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
37091 &(smtp)& transport)
37092 .next
37093 Limiting the concurrency of specific transports (when &%max_parallel%& is set
37094 in a transport)
37095 .endlist
37096
37097
37098
37099 .section "exim_dumpdb" "SECID261"
37100 .cindex "&'exim_dumpdb'&"
37101 The entire contents of a database are written to the standard output by the
37102 &'exim_dumpdb'& program, which has no options or arguments other than the
37103 spool and database names. For example, to dump the retry database:
37104 .code
37105 exim_dumpdb /var/spool/exim retry
37106 .endd
37107 Two lines of output are produced for each entry:
37108 .code
37109 T:mail.ref.example:192.168.242.242 146 77 Connection refused
37110 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
37111 .endd
37112 The first item on the first line is the key of the record. It starts with one
37113 of the letters R, or T, depending on whether it refers to a routing or
37114 transport retry. For a local delivery, the next part is the local address; for
37115 a remote delivery it is the name of the remote host, followed by its failing IP
37116 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
37117 transport). If the remote port is not the standard one (port 25), it is added
37118 to the IP address. Then there follows an error code, an additional error code,
37119 and a textual description of the error.
37120
37121 The three times on the second line are the time of first failure, the time of
37122 the last delivery attempt, and the computed time for the next attempt. The line
37123 ends with an asterisk if the cutoff time for the last retry rule has been
37124 exceeded.
37125
37126 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
37127 consists of a host name followed by a list of ids for messages that are or were
37128 waiting to be delivered to that host. If there are a very large number for any
37129 one host, continuation records, with a sequence number added to the host name,
37130 may be seen. The data in these records is often out of date, because a message
37131 may be routed to several alternative hosts, and Exim makes no effort to keep
37132 cross-references.
37133
37134
37135
37136 .section "exim_tidydb" "SECID262"
37137 .cindex "&'exim_tidydb'&"
37138 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
37139 database. If run with no options, it removes all records that are more than 30
37140 days old. The age is calculated from the date and time that the record was last
37141 updated. Note that, in the case of the retry database, it is &'not'& the time
37142 since the first delivery failure. Information about a host that has been down
37143 for more than 30 days will remain in the database, provided that the record is
37144 updated sufficiently often.
37145
37146 The cutoff date can be altered by means of the &%-t%& option, which must be
37147 followed by a time. For example, to remove all records older than a week from
37148 the retry database:
37149 .code
37150 exim_tidydb -t 7d /var/spool/exim retry
37151 .endd
37152 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
37153 message ids. In the former these appear as data in records keyed by host &--
37154 they were messages that were waiting for that host &-- and in the latter they
37155 are the keys for retry information for messages that have suffered certain
37156 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
37157 message ids in database records are those of messages that are still on the
37158 queue. Message ids for messages that no longer exist are removed from
37159 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
37160 For the &'retry'& database, records whose keys are non-existent message ids are
37161 removed. The &'exim_tidydb'& utility outputs comments on the standard output
37162 whenever it removes information from the database.
37163
37164 Certain records are automatically removed by Exim when they are no longer
37165 needed, but others are not. For example, if all the MX hosts for a domain are
37166 down, a retry record is created for each one. If the primary MX host comes back
37167 first, its record is removed when Exim successfully delivers to it, but the
37168 records for the others remain because Exim has not tried to use those hosts.
37169
37170 It is important, therefore, to run &'exim_tidydb'& periodically on all the
37171 hints databases. You should do this at a quiet time of day, because it requires
37172 a database to be locked (and therefore inaccessible to Exim) while it does its
37173 work. Removing records from a DBM file does not normally make the file smaller,
37174 but all the common DBM libraries are able to re-use the space that is released.
37175 After an initial phase of increasing in size, the databases normally reach a
37176 point at which they no longer get any bigger, as long as they are regularly
37177 tidied.
37178
37179 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
37180 databases is likely to keep on increasing.
37181
37182
37183
37184
37185 .section "exim_fixdb" "SECID263"
37186 .cindex "&'exim_fixdb'&"
37187 The &'exim_fixdb'& program is a utility for interactively modifying databases.
37188 Its main use is for testing Exim, but it might also be occasionally useful for
37189 getting round problems in a live system. It has no options, and its interface
37190 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
37191 key of a database record can then be entered, and the data for that record is
37192 displayed.
37193
37194 If &"d"& is typed at the next prompt, the entire record is deleted. For all
37195 except the &'retry'& database, that is the only operation that can be carried
37196 out. For the &'retry'& database, each field is output preceded by a number, and
37197 data for individual fields can be changed by typing the field number followed
37198 by new data, for example:
37199 .code
37200 > 4 951102:1000
37201 .endd
37202 resets the time of the next delivery attempt. Time values are given as a
37203 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
37204 used as optional separators.
37205
37206
37207
37208
37209 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
37210 .cindex "mailbox" "maintenance"
37211 .cindex "&'exim_lock'&"
37212 .cindex "locking mailboxes"
37213 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
37214 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
37215 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
37216 a user agent while investigating a problem. The utility requires the name of
37217 the file as its first argument. If the locking is successful, the second
37218 argument is run as a command (using C's &[system()]& function); if there is no
37219 second argument, the value of the SHELL environment variable is used; if this
37220 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
37221 is unlocked and the utility ends. The following options are available:
37222
37223 .vlist
37224 .vitem &%-fcntl%&
37225 Use &[fcntl()]& locking on the open mailbox.
37226
37227 .vitem &%-flock%&
37228 Use &[flock()]& locking on the open mailbox, provided the operating system
37229 supports it.
37230
37231 .vitem &%-interval%&
37232 This must be followed by a number, which is a number of seconds; it sets the
37233 interval to sleep between retries (default 3).
37234
37235 .vitem &%-lockfile%&
37236 Create a lock file before opening the mailbox.
37237
37238 .vitem &%-mbx%&
37239 Lock the mailbox using MBX rules.
37240
37241 .vitem &%-q%&
37242 Suppress verification output.
37243
37244 .vitem &%-retries%&
37245 This must be followed by a number; it sets the number of times to try to get
37246 the lock (default 10).
37247
37248 .vitem &%-restore_time%&
37249 This option causes &%exim_lock%& to restore the modified and read times to the
37250 locked file before exiting. This allows you to access a locked mailbox (for
37251 example, to take a backup copy) without disturbing the times that the user
37252 subsequently sees.
37253
37254 .vitem &%-timeout%&
37255 This must be followed by a number, which is a number of seconds; it sets a
37256 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
37257 default), a non-blocking call is used.
37258
37259 .vitem &%-v%&
37260 Generate verbose output.
37261 .endlist
37262
37263 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
37264 default is to create a lock file and also to use &[fcntl()]& locking on the
37265 mailbox, which is the same as Exim's default. The use of &%-flock%& or
37266 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
37267 requires that the directory containing the file be writeable. Locking by lock
37268 file does not last for ever; Exim assumes that a lock file is expired if it is
37269 more than 30 minutes old.
37270
37271 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
37272 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
37273 to be taken out on the open mailbox, and an exclusive lock on the file
37274 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
37275 number of the mailbox file. When the locking is released, if an exclusive lock
37276 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
37277
37278 The default output contains verification of the locking that takes place. The
37279 &%-v%& option causes some additional information to be given. The &%-q%& option
37280 suppresses all output except error messages.
37281
37282 A command such as
37283 .code
37284 exim_lock /var/spool/mail/spqr
37285 .endd
37286 runs an interactive shell while the file is locked, whereas
37287 .display
37288 &`exim_lock -q /var/spool/mail/spqr <<End`&
37289 <&'some commands'&>
37290 &`End`&
37291 .endd
37292 runs a specific non-interactive sequence of commands while the file is locked,
37293 suppressing all verification output. A single command can be run by a command
37294 such as
37295 .code
37296 exim_lock -q /var/spool/mail/spqr \
37297   "cp /var/spool/mail/spqr /some/where"
37298 .endd
37299 Note that if a command is supplied, it must be entirely contained within the
37300 second argument &-- hence the quotes.
37301 .ecindex IIDutils
37302
37303
37304 . ////////////////////////////////////////////////////////////////////////////
37305 . ////////////////////////////////////////////////////////////////////////////
37306
37307 .chapter "The Exim monitor" "CHAPeximon"
37308 .scindex IIDeximon "Exim monitor" "description"
37309 .cindex "X-windows"
37310 .cindex "&'eximon'&"
37311 .cindex "Local/eximon.conf"
37312 .cindex "&_exim_monitor/EDITME_&"
37313 The Exim monitor is an application which displays in an X window information
37314 about the state of Exim's queue and what Exim is doing. An admin user can
37315 perform certain operations on messages from this GUI interface; however all
37316 such facilities are also available from the command line, and indeed, the
37317 monitor itself makes use of the command line to perform any actions requested.
37318
37319
37320
37321 .section "Running the monitor" "SECID264"
37322 The monitor is started by running the script called &'eximon'&. This is a shell
37323 script that sets up a number of environment variables, and then runs the
37324 binary called &_eximon.bin_&. The default appearance of the monitor window can
37325 be changed by editing the &_Local/eximon.conf_& file created by editing
37326 &_exim_monitor/EDITME_&. Comments in that file describe what the various
37327 parameters are for.
37328
37329 The parameters that get built into the &'eximon'& script can be overridden for
37330 a particular invocation by setting up environment variables of the same names,
37331 preceded by &`EXIMON_`&. For example, a shell command such as
37332 .code
37333 EXIMON_LOG_DEPTH=400 eximon
37334 .endd
37335 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
37336 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
37337 overrides the Exim log file configuration. This makes it possible to have
37338 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
37339 syslog messages are routed to a file on the local host.
37340
37341 X resources can be used to change the appearance of the window in the normal
37342 way. For example, a resource setting of the form
37343 .code
37344 Eximon*background: gray94
37345 .endd
37346 changes the colour of the background to light grey rather than white. The
37347 stripcharts are drawn with both the data lines and the reference lines in
37348 black. This means that the reference lines are not visible when on top of the
37349 data. However, their colour can be changed by setting a resource called
37350 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
37351 For example, if your X server is running Unix, you could set up lighter
37352 reference lines in the stripcharts by obeying
37353 .code
37354 xrdb -merge <<End
37355 Eximon*highlight: gray
37356 End
37357 .endd
37358 .cindex "admin user"
37359 In order to see the contents of messages on the queue, and to operate on them,
37360 &'eximon'& must either be run as root or by an admin user.
37361
37362 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
37363 contain X11 resource parameters interpreted by the X11 library.  In addition,
37364 if the first parameter starts with the string "gdb" then it is removed and the
37365 binary is invoked under gdb (the parameter is used as the gdb command-name, so
37366 versioned variants of gdb can be invoked).
37367
37368 The monitor's window is divided into three parts. The first contains one or
37369 more stripcharts and two action buttons, the second contains a &"tail"& of the
37370 main log file, and the third is a display of the queue of messages awaiting
37371 delivery, with two more action buttons. The following sections describe these
37372 different parts of the display.
37373
37374
37375
37376
37377 .section "The stripcharts" "SECID265"
37378 .cindex "stripchart"
37379 The first stripchart is always a count of messages on the queue. Its name can
37380 be configured by setting QUEUE_STRIPCHART_NAME in the
37381 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
37382 configuration script by regular expression matches on log file entries, making
37383 it possible to display, for example, counts of messages delivered to certain
37384 hosts or using certain transports. The supplied defaults display counts of
37385 received and delivered messages, and of local and SMTP deliveries. The default
37386 period between stripchart updates is one minute; this can be adjusted by a
37387 parameter in the &_Local/eximon.conf_& file.
37388
37389 The stripchart displays rescale themselves automatically as the value they are
37390 displaying changes. There are always 10 horizontal lines in each chart; the
37391 title string indicates the value of each division when it is greater than one.
37392 For example, &"x2"& means that each division represents a value of 2.
37393
37394 It is also possible to have a stripchart which shows the percentage fullness of
37395 a particular disk partition, which is useful when local deliveries are confined
37396 to a single partition.
37397
37398 .cindex "&%statvfs%& function"
37399 This relies on the availability of the &[statvfs()]& function or equivalent in
37400 the operating system. Most, but not all versions of Unix that support Exim have
37401 this. For this particular stripchart, the top of the chart always represents
37402 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37403 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37404 &_Local/eximon.conf_& file.
37405
37406
37407
37408
37409 .section "Main action buttons" "SECID266"
37410 .cindex "size" "of monitor window"
37411 .cindex "Exim monitor" "window size"
37412 .cindex "window size"
37413 Below the stripcharts there is an action button for quitting the monitor. Next
37414 to this is another button marked &"Size"&. They are placed here so that
37415 shrinking the window to its default minimum size leaves just the queue count
37416 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37417 the window to expand to its maximum size, unless it is already at the maximum,
37418 in which case it is reduced to its minimum.
37419
37420 When expanding to the maximum, if the window cannot be fully seen where it
37421 currently is, it is moved back to where it was the last time it was at full
37422 size. When it is expanding from its minimum size, the old position is
37423 remembered, and next time it is reduced to the minimum it is moved back there.
37424
37425 The idea is that you can keep a reduced window just showing one or two
37426 stripcharts at a convenient place on your screen, easily expand it to show
37427 the full window when required, and just as easily put it back to what it was.
37428 The idea is copied from what the &'twm'& window manager does for its
37429 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37430 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37431
37432 Normally, the monitor starts up with the window at its full size, but it can be
37433 built so that it starts up with the window at its smallest size, by setting
37434 START_SMALL=yes in &_Local/eximon.conf_&.
37435
37436
37437
37438 .section "The log display" "SECID267"
37439 .cindex "log" "tail of; in monitor"
37440 The second section of the window is an area in which a display of the tail of
37441 the main log is maintained.
37442 To save space on the screen, the timestamp on each log line is shortened by
37443 removing the date and, if &%log_timezone%& is set, the timezone.
37444 The log tail is not available when the only destination for logging data is
37445 syslog, unless the syslog lines are routed to a local file whose name is passed
37446 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37447
37448 The log sub-window has a scroll bar at its lefthand side which can be used to
37449 move back to look at earlier text, and the up and down arrow keys also have a
37450 scrolling effect. The amount of log that is kept depends on the setting of
37451 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37452 to use. When this is full, the earlier 50% of data is discarded &-- this is
37453 much more efficient than throwing it away line by line. The sub-window also has
37454 a horizontal scroll bar for accessing the ends of long log lines. This is the
37455 only means of horizontal scrolling; the right and left arrow keys are not
37456 available. Text can be cut from this part of the window using the mouse in the
37457 normal way. The size of this subwindow is controlled by parameters in the
37458 configuration file &_Local/eximon.conf_&.
37459
37460 Searches of the text in the log window can be carried out by means of the ^R
37461 and ^S keystrokes, which default to a reverse and a forward search,
37462 respectively. The search covers only the text that is displayed in the window.
37463 It cannot go further back up the log.
37464
37465 The point from which the search starts is indicated by a caret marker. This is
37466 normally at the end of the text in the window, but can be positioned explicitly
37467 by pointing and clicking with the left mouse button, and is moved automatically
37468 by a successful search. If new text arrives in the window when it is scrolled
37469 back, the caret remains where it is, but if the window is not scrolled back,
37470 the caret is moved to the end of the new text.
37471
37472 Pressing ^R or ^S pops up a window into which the search text can be typed.
37473 There are buttons for selecting forward or reverse searching, for carrying out
37474 the search, and for cancelling. If the &"Search"& button is pressed, the search
37475 happens and the window remains so that further searches can be done. If the
37476 &"Return"& key is pressed, a single search is done and the window is closed. If
37477 ^C is typed the search is cancelled.
37478
37479 The searching facility is implemented using the facilities of the Athena text
37480 widget. By default this pops up a window containing both &"search"& and
37481 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37482 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37483 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37484 provided version of &%TextPop%& when the remaining parts of the text widget
37485 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37486 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37487 on these systems, at the expense of having unwanted items in the search popup
37488 window.
37489
37490
37491
37492 .section "The queue display" "SECID268"
37493 .cindex "queue" "display in monitor"
37494 The bottom section of the monitor window contains a list of all messages that
37495 are on the queue, which includes those currently being received or delivered,
37496 as well as those awaiting delivery. The size of this subwindow is controlled by
37497 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37498 at which it is updated is controlled by another parameter in the same file &--
37499 the default is 5 minutes, since queue scans can be quite expensive. However,
37500 there is an &"Update"& action button just above the display which can be used
37501 to force an update of the queue display at any time.
37502
37503 When a host is down for some time, a lot of pending mail can build up for it,
37504 and this can make it hard to deal with other messages on the queue. To help
37505 with this situation there is a button next to &"Update"& called &"Hide"&. If
37506 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37507 type anything in here and press &"Return"&, the text is added to a chain of
37508 such texts, and if every undelivered address in a message matches at least one
37509 of the texts, the message is not displayed.
37510
37511 If there is an address that does not match any of the texts, all the addresses
37512 are displayed as normal. The matching happens on the ends of addresses so, for
37513 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37514 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37515 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37516 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37517 a hide request is automatically cancelled after one hour.
37518
37519 While the dialogue box is displayed, you can't press any buttons or do anything
37520 else to the monitor window. For this reason, if you want to cut text from the
37521 queue display to use in the dialogue box, you have to do the cutting before
37522 pressing the &"Hide"& button.
37523
37524 The queue display contains, for each unhidden queued message, the length of
37525 time it has been on the queue, the size of the message, the message id, the
37526 message sender, and the first undelivered recipient, all on one line. If it is
37527 a bounce message, the sender is shown as &"<>"&. If there is more than one
37528 recipient to which the message has not yet been delivered, subsequent ones are
37529 listed on additional lines, up to a maximum configured number, following which
37530 an ellipsis is displayed. Recipients that have already received the message are
37531 not shown.
37532
37533 .cindex "frozen messages" "display"
37534 If a message is frozen, an asterisk is displayed at the left-hand side.
37535
37536 The queue display has a vertical scroll bar, and can also be scrolled by means
37537 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37538 The text searching facilities, as described above for the log window, are also
37539 available, but the caret is always moved to the end of the text when the queue
37540 display is updated.
37541
37542
37543
37544 .section "The queue menu" "SECID269"
37545 .cindex "queue" "menu in monitor"
37546 If the &%shift%& key is held down and the left button is clicked when the mouse
37547 pointer is over the text for any message, an action menu pops up, and the first
37548 line of the queue display for the message is highlighted. This does not affect
37549 any selected text.
37550
37551 If you want to use some other event for popping up the menu, you can set the
37552 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37553 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37554 value set in this parameter is a standard X event description. For example, to
37555 run eximon using &%ctrl%& rather than &%shift%& you could use
37556 .code
37557 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37558 .endd
37559 The title of the menu is the message id, and it contains entries which act as
37560 follows:
37561
37562 .ilist
37563 &'message log'&: The contents of the message log for the message are displayed
37564 in a new text window.
37565 .next
37566 &'headers'&: Information from the spool file that contains the envelope
37567 information and headers is displayed in a new text window. See chapter
37568 &<<CHAPspool>>& for a description of the format of spool files.
37569 .next
37570 &'body'&: The contents of the spool file containing the body of the message are
37571 displayed in a new text window. There is a default limit of 20,000 bytes to the
37572 amount of data displayed. This can be changed by setting the BODY_MAX
37573 option at compile time, or the EXIMON_BODY_MAX option at run time.
37574 .next
37575 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37576 delivery of the message. This causes an automatic thaw if the message is
37577 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37578 a new text window. The delivery is run in a separate process, to avoid holding
37579 up the monitor while the delivery proceeds.
37580 .next
37581 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37582 that the message be frozen.
37583 .next
37584 .cindex "thawing messages"
37585 .cindex "unfreezing messages"
37586 .cindex "frozen messages" "thawing"
37587 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37588 that the message be thawed.
37589 .next
37590 .cindex "delivery" "forcing failure"
37591 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37592 that Exim gives up trying to deliver the message. A bounce message is generated
37593 for any remaining undelivered addresses.
37594 .next
37595 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37596 that the message be deleted from the system without generating a bounce
37597 message.
37598 .next
37599 &'add recipient'&: A dialog box is displayed into which a recipient address can
37600 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37601 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37602 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37603 causes a call to Exim to be made using the &%-Mar%& option to request that an
37604 additional recipient be added to the message, unless the entry box is empty, in
37605 which case no action is taken.
37606 .next
37607 &'mark delivered'&: A dialog box is displayed into which a recipient address
37608 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37609 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37610 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37611 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37612 recipient address as already delivered, unless the entry box is empty, in which
37613 case no action is taken.
37614 .next
37615 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37616 mark all recipient addresses as already delivered.
37617 .next
37618 &'edit sender'&: A dialog box is displayed initialized with the current
37619 sender's address. Pressing RETURN causes a call to Exim to be made using the
37620 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37621 in which case no action is taken. If you want to set an empty sender (as in
37622 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37623 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37624 the address is qualified with that domain.
37625 .endlist
37626
37627 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37628 other cases when a call to Exim is made, if there is any output from Exim (in
37629 particular, if the command fails) a window containing the command and the
37630 output is displayed. Otherwise, the results of the action are normally apparent
37631 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37632 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37633 if no output is generated.
37634
37635 The queue display is automatically updated for actions such as freezing and
37636 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37637 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37638 force an update of the display after one of these actions.
37639
37640 In any text window that is displayed as result of a menu action, the normal
37641 cut-and-paste facility is available, and searching can be carried out using ^R
37642 and ^S, as described above for the log tail window.
37643 .ecindex IIDeximon
37644
37645
37646
37647
37648
37649 . ////////////////////////////////////////////////////////////////////////////
37650 . ////////////////////////////////////////////////////////////////////////////
37651
37652 .chapter "Security considerations" "CHAPsecurity"
37653 .scindex IIDsecurcon "security" "discussion of"
37654 This chapter discusses a number of issues concerned with security, some of
37655 which are also covered in other parts of this manual.
37656
37657 For reasons that this author does not understand, some people have promoted
37658 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37659 existence of this chapter in the documentation. However, the intent of the
37660 chapter is simply to describe the way Exim works in relation to certain
37661 security concerns, not to make any specific claims about the effectiveness of
37662 its security as compared with other MTAs.
37663
37664 What follows is a description of the way Exim is supposed to be. Best efforts
37665 have been made to try to ensure that the code agrees with the theory, but an
37666 absence of bugs can never be guaranteed. Any that are reported will get fixed
37667 as soon as possible.
37668
37669
37670 .section "Building a more &""hardened""& Exim" "SECID286"
37671 .cindex "security" "build-time features"
37672 There are a number of build-time options that can be set in &_Local/Makefile_&
37673 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37674 Exim administrator who does not have the root password, or by someone who has
37675 penetrated the Exim (but not the root) account. These options are as follows:
37676
37677 .ilist
37678 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37679 start of any file names used with the &%-C%& option. When it is set, these file
37680 names are also not allowed to contain the sequence &"/../"&. (However, if the
37681 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37682 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37683 default setting for &%ALT_CONFIG_PREFIX%&.
37684
37685 If the permitted configuration files are confined to a directory to
37686 which only root has access, this guards against someone who has broken
37687 into the Exim account from running a privileged Exim with an arbitrary
37688 configuration file, and using it to break into other accounts.
37689 .next
37690
37691 If a non-trusted configuration file (i.e. not the default configuration file
37692 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37693 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37694 the next item), then root privilege is retained only if the caller of Exim is
37695 root. This locks out the possibility of testing a configuration using &%-C%&
37696 right through message reception and delivery, even if the caller is root. The
37697 reception works, but by that time, Exim is running as the Exim user, so when
37698 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37699 privilege to be lost. However, root can test reception and delivery using two
37700 separate commands.
37701
37702 .next
37703 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37704 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37705 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37706 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37707 the restrictive side.  Requiring build-time selection of safe macros is onerous
37708 but this option is intended solely as a transition mechanism to permit
37709 previously-working configurations to continue to work after release 4.73.
37710 .next
37711 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37712 is disabled.
37713 .next
37714 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37715 never to be used for any deliveries. This is like the &%never_users%& runtime
37716 option, but it cannot be overridden; the runtime option adds additional users
37717 to the list. The default setting is &"root"&; this prevents a non-root user who
37718 is permitted to modify the runtime file from using Exim as a way to get root.
37719 .endlist
37720
37721
37722
37723 .section "Root privilege" "SECID270"
37724 .cindex "setuid"
37725 .cindex "root privilege"
37726 The Exim binary is normally setuid to root, which means that it gains root
37727 privilege (runs as root) when it starts execution. In some special cases (for
37728 example, when the daemon is not in use and there are no local deliveries), it
37729 may be possible to run Exim setuid to some user other than root. This is
37730 discussed in the next section. However, in most installations, root privilege
37731 is required for two things:
37732
37733 .ilist
37734 To set up a socket connected to the standard SMTP port (25) when initialising
37735 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37736 not required.
37737 .next
37738 To be able to change uid and gid in order to read users' &_.forward_& files and
37739 perform local deliveries as the receiving user or as specified in the
37740 configuration.
37741 .endlist
37742
37743 It is not necessary to be root to do any of the other things Exim does, such as
37744 receiving messages and delivering them externally over SMTP, and it is
37745 obviously more secure if Exim does not run as root except when necessary.
37746 For this reason, a user and group for Exim to use must be defined in
37747 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37748 group"&. Their values can be changed by the run time configuration, though this
37749 is not recommended. Often a user called &'exim'& is used, but some sites use
37750 &'mail'& or another user name altogether.
37751
37752 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37753 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37754 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37755
37756 After a new Exim process has interpreted its command line options, it changes
37757 uid and gid in the following cases:
37758
37759 .ilist
37760 .oindex "&%-C%&"
37761 .oindex "&%-D%&"
37762 If the &%-C%& option is used to specify an alternate configuration file, or if
37763 the &%-D%& option is used to define macro values for the configuration, and the
37764 calling process is not running as root, the uid and gid are changed to those of
37765 the calling process.
37766 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37767 option may not be used at all.
37768 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37769 can be supplied if the calling process is running as root, the Exim run-time
37770 user or CONFIGURE_OWNER, if defined.
37771 .next
37772 .oindex "&%-be%&"
37773 .oindex "&%-bf%&"
37774 .oindex "&%-bF%&"
37775 If the expansion test option (&%-be%&) or one of the filter testing options
37776 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37777 calling process.
37778 .next
37779 If the process is not a daemon process or a queue runner process or a delivery
37780 process or a process for testing address routing (started with &%-bt%&), the
37781 uid and gid are changed to the Exim user and group. This means that Exim always
37782 runs under its own uid and gid when receiving messages. This also applies when
37783 testing address verification
37784 .oindex "&%-bv%&"
37785 .oindex "&%-bh%&"
37786 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37787 option).
37788 .next
37789 For a daemon, queue runner, delivery, or address testing process, the uid
37790 remains as root at this stage, but the gid is changed to the Exim group.
37791 .endlist
37792
37793 The processes that initially retain root privilege behave as follows:
37794
37795 .ilist
37796 A daemon process changes the gid to the Exim group and the uid to the Exim
37797 user after setting up one or more listening sockets. The &[initgroups()]&
37798 function is called, so that if the Exim user is in any additional groups, they
37799 will be used during message reception.
37800 .next
37801 A queue runner process retains root privilege throughout its execution. Its
37802 job is to fork a controlled sequence of delivery processes.
37803 .next
37804 A delivery process retains root privilege throughout most of its execution,
37805 but any actual deliveries (that is, the transports themselves) are run in
37806 subprocesses which always change to a non-root uid and gid. For local
37807 deliveries this is typically the uid and gid of the owner of the mailbox; for
37808 remote deliveries, the Exim uid and gid are used. Once all the delivery
37809 subprocesses have been run, a delivery process changes to the Exim uid and gid
37810 while doing post-delivery tidying up such as updating the retry database and
37811 generating bounce and warning messages.
37812
37813 While the recipient addresses in a message are being routed, the delivery
37814 process runs as root. However, if a user's filter file has to be processed,
37815 this is done in a subprocess that runs under the individual user's uid and
37816 gid. A system filter is run as root unless &%system_filter_user%& is set.
37817 .next
37818 A process that is testing addresses (the &%-bt%& option) runs as root so that
37819 the routing is done in the same environment as a message delivery.
37820 .endlist
37821
37822
37823
37824
37825 .section "Running Exim without privilege" "SECTrunexiwitpri"
37826 .cindex "privilege, running without"
37827 .cindex "unprivileged running"
37828 .cindex "root privilege" "running without"
37829 Some installations like to run Exim in an unprivileged state for more of its
37830 operation, for added security. Support for this mode of operation is provided
37831 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37832 gid are changed to the Exim user and group at the start of a delivery process
37833 (and also queue runner and address testing processes). This means that address
37834 routing is no longer run as root, and the deliveries themselves cannot change
37835 to any other uid.
37836
37837 .cindex SIGHUP
37838 .cindex "daemon" "restarting"
37839 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37840 that the daemon can still be started in the usual way, and it can respond
37841 correctly to SIGHUP because the re-invocation regains root privilege.
37842
37843 An alternative approach is to make Exim setuid to the Exim user and also setgid
37844 to the Exim group. If you do this, the daemon must be started from a root
37845 process. (Calling Exim from a root process makes it behave in the way it does
37846 when it is setuid root.) However, the daemon cannot restart itself after a
37847 SIGHUP signal because it cannot regain privilege.
37848
37849 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37850 stops Exim from trying to re-invoke itself to do a delivery after a message has
37851 been received. Such a re-invocation is a waste of resources because it has no
37852 effect.
37853
37854 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37855 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37856 to the Exim user seems a clean approach, but there is one complication:
37857
37858 In this style of operation, Exim is running with the real uid and gid set to
37859 those of the calling process, and the effective uid/gid set to Exim's values.
37860 Ideally, any association with the calling process' uid/gid should be dropped,
37861 that is, the real uid/gid should be reset to the effective values so as to
37862 discard any privileges that the caller may have. While some operating systems
37863 have a function that permits this action for a non-root effective uid, quite a
37864 number of them do not. Because of this lack of standardization, Exim does not
37865 address this problem at this time.
37866
37867 For this reason, the recommended approach for &"mostly unprivileged"& running
37868 is to keep the Exim binary setuid to root, and to set
37869 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37870 be used in the most straightforward way.
37871
37872 If you configure Exim not to run delivery processes as root, there are a
37873 number of restrictions on what you can do:
37874
37875 .ilist
37876 You can deliver only as the Exim user/group. You should  explicitly use the
37877 &%user%& and &%group%& options to override routers or local transports that
37878 normally deliver as the recipient. This makes sure that configurations that
37879 work in this mode function the same way in normal mode. Any implicit or
37880 explicit specification of another user causes an error.
37881 .next
37882 Use of &_.forward_& files is severely restricted, such that it is usually
37883 not worthwhile to include them in the configuration.
37884 .next
37885 Users who wish to use &_.forward_& would have to make their home directory and
37886 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37887 and their equivalents in Exim filters, cannot be used. While they could be
37888 enabled in the Exim user's name, that would be insecure and not very useful.
37889 .next
37890 Unless the local user mailboxes are all owned by the Exim user (possible in
37891 some POP3 or IMAP-only environments):
37892
37893 .olist
37894 They must be owned by the Exim group and be writeable by that group. This
37895 implies you must set &%mode%& in the appendfile configuration, as well as the
37896 mode of the mailbox files themselves.
37897 .next
37898 You must set &%no_check_owner%&, since most or all of the files will not be
37899 owned by the Exim user.
37900 .next
37901 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37902 on a newly created mailbox when unprivileged. This also implies that new
37903 mailboxes need to be created manually.
37904 .endlist olist
37905 .endlist ilist
37906
37907
37908 These restrictions severely restrict what can be done in local deliveries.
37909 However, there are no restrictions on remote deliveries. If you are running a
37910 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37911 gives more security at essentially no cost.
37912
37913 If you are using the &%mua_wrapper%& facility (see chapter
37914 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37915
37916
37917
37918
37919 .section "Delivering to local files" "SECID271"
37920 Full details of the checks applied by &(appendfile)& before it writes to a file
37921 are given in chapter &<<CHAPappendfile>>&.
37922
37923
37924
37925 .section "Running local commands" "SECTsecconslocalcmds"
37926 .cindex "security" "local commands"
37927 .cindex "security" "command injection attacks"
37928 There are a number of ways in which an administrator can configure Exim to run
37929 commands based upon received, untrustworthy, data. Further, in some
37930 configurations a user who can control a &_.forward_& file can also arrange to
37931 run commands. Configuration to check includes, but is not limited to:
37932
37933 .ilist
37934 Use of &%use_shell%& in the pipe transport: various forms of shell command
37935 injection may be possible with this option present. It is dangerous and should
37936 be used only with considerable caution. Consider constraints which whitelist
37937 allowed characters in a variable which is to be used in a pipe transport that
37938 has &%use_shell%& enabled.
37939 .next
37940 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37941 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37942 &_.forward_& files in a redirect router. If Exim is running on a central mail
37943 hub to which ordinary users do not have shell access, but home directories are
37944 NFS mounted (for instance) then administrators should review the list of these
37945 forbid options available, and should bear in mind that the options that may
37946 need forbidding can change as new features are added between releases.
37947 .next
37948 The &%${run...}%& expansion item does not use a shell by default, but
37949 administrators can configure use of &_/bin/sh_& as part of the command.
37950 Such invocations should be viewed with prejudicial suspicion.
37951 .next
37952 Administrators who use embedded Perl are advised to explore how Perl's
37953 taint checking might apply to their usage.
37954 .next
37955 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37956 administrators are well advised to view its use with suspicion, in case (for
37957 instance) it allows a local-part to contain embedded Exim directives.
37958 .next
37959 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37960 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37961 each can reference arbitrary lists and files, rather than just being a list
37962 of opaque strings.
37963 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37964 real-world security vulnerabilities caused by its use with untrustworthy data
37965 injected in, for SQL injection attacks.
37966 Consider the use of the &%inlisti%& expansion condition instead.
37967 .endlist
37968
37969
37970
37971
37972 .section "Trust in configuration data" "SECTsecconfdata"
37973 .cindex "security" "data sources"
37974 .cindex "security" "regular expressions"
37975 .cindex "regular expressions" "security"
37976 .cindex "PCRE" "security"
37977 If configuration data for Exim can come from untrustworthy sources, there
37978 are some issues to be aware of:
37979
37980 .ilist
37981 Use of &%${expand...}%& may provide a path for shell injection attacks.
37982 .next
37983 Letting untrusted data provide a regular expression is unwise.
37984 .next
37985 Using &%${match...}%& to apply a fixed regular expression against untrusted
37986 data may result in pathological behaviour within PCRE.  Be aware of what
37987 "backtracking" means and consider options for being more strict with a regular
37988 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37989 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37990 possessive quantifiers or just not using regular expressions against untrusted
37991 data.
37992 .next
37993 It can be important to correctly use &%${quote:...}%&,
37994 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37995 items to ensure that data is correctly constructed.
37996 .next
37997 Some lookups might return multiple results, even though normal usage is only
37998 expected to yield one result.
37999 .endlist
38000
38001
38002
38003
38004 .section "IPv4 source routing" "SECID272"
38005 .cindex "source routing" "in IP packets"
38006 .cindex "IP source routing"
38007 Many operating systems suppress IP source-routed packets in the kernel, but
38008 some cannot be made to do this, so Exim does its own check. It logs incoming
38009 IPv4 source-routed TCP calls, and then drops them. Things are all different in
38010 IPv6. No special checking is currently done.
38011
38012
38013
38014 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
38015 Support for these SMTP commands is disabled by default. If required, they can
38016 be enabled by defining suitable ACLs.
38017
38018
38019
38020
38021 .section "Privileged users" "SECID274"
38022 .cindex "trusted users"
38023 .cindex "admin user"
38024 .cindex "privileged user"
38025 .cindex "user" "trusted"
38026 .cindex "user" "admin"
38027 Exim recognizes two sets of users with special privileges. Trusted users are
38028 able to submit new messages to Exim locally, but supply their own sender
38029 addresses and information about a sending host. For other users submitting
38030 local messages, Exim sets up the sender address from the uid, and doesn't
38031 permit a remote host to be specified.
38032
38033 .oindex "&%-f%&"
38034 However, an untrusted user is permitted to use the &%-f%& command line option
38035 in the special form &%-f <>%& to indicate that a delivery failure for the
38036 message should not cause an error report. This affects the message's envelope,
38037 but it does not affect the &'Sender:'& header. Untrusted users may also be
38038 permitted to use specific forms of address with the &%-f%& option by setting
38039 the &%untrusted_set_sender%& option.
38040
38041 Trusted users are used to run processes that receive mail messages from some
38042 other mail domain and pass them on to Exim for delivery either locally, or over
38043 the Internet. Exim trusts a caller that is running as root, as the Exim user,
38044 as any user listed in the &%trusted_users%& configuration option, or under any
38045 group listed in the &%trusted_groups%& option.
38046
38047 Admin users are permitted to do things to the messages on Exim's queue. They
38048 can freeze or thaw messages, cause them to be returned to their senders, remove
38049 them entirely, or modify them in various ways. In addition, admin users can run
38050 the Exim monitor and see all the information it is capable of providing, which
38051 includes the contents of files on the spool.
38052
38053 .oindex "&%-M%&"
38054 .oindex "&%-q%&"
38055 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
38056 delivery of messages on its queue is restricted to admin users. This
38057 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
38058 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
38059 queue is also restricted to admin users. This restriction can be relaxed by
38060 setting &%no_queue_list_requires_admin%&.
38061
38062 Exim recognizes an admin user if the calling process is running as root or as
38063 the Exim user or if any of the groups associated with the calling process is
38064 the Exim group. It is not necessary actually to be running under the Exim
38065 group. However, if admin users who are not root or the Exim user are to access
38066 the contents of files on the spool via the Exim monitor (which runs
38067 unprivileged), Exim must be built to allow group read access to its spool
38068 files.
38069
38070 By default, regular users are trusted to perform basic testing and
38071 introspection commands, as themselves.  This setting can be tightened by
38072 setting the &%commandline_checks_require_admin%& option.
38073 This affects most of the checking options,
38074 such as &%-be%& and anything else &%-b*%&.
38075
38076
38077 .section "Spool files" "SECID275"
38078 .cindex "spool directory" "files"
38079 Exim's spool directory and everything it contains is owned by the Exim user and
38080 set to the Exim group. The mode for spool files is defined in the
38081 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
38082 any user who is a member of the Exim group can access these files.
38083
38084
38085
38086 .section "Use of argv[0]" "SECID276"
38087 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
38088 of specific strings, Exim assumes certain options. For example, calling Exim
38089 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
38090 to calling it with the option &%-bS%&. There are no security implications in
38091 this.
38092
38093
38094
38095 .section "Use of %f formatting" "SECID277"
38096 The only use made of &"%f"& by Exim is in formatting load average values. These
38097 are actually stored in integer variables as 1000 times the load average.
38098 Consequently, their range is limited and so therefore is the length of the
38099 converted output.
38100
38101
38102
38103 .section "Embedded Exim path" "SECID278"
38104 Exim uses its own path name, which is embedded in the code, only when it needs
38105 to re-exec in order to regain root privilege. Therefore, it is not root when it
38106 does so. If some bug allowed the path to get overwritten, it would lead to an
38107 arbitrary program's being run as exim, not as root.
38108
38109
38110
38111 .section "Dynamic module directory" "SECTdynmoddir"
38112 Any dynamically loadable modules must be installed into the directory
38113 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
38114 loading it.
38115
38116
38117 .section "Use of sprintf()" "SECID279"
38118 .cindex "&[sprintf()]&"
38119 A large number of occurrences of &"sprintf"& in the code are actually calls to
38120 &'string_sprintf()'&, a function that returns the result in malloc'd store.
38121 The intermediate formatting is done into a large fixed buffer by a function
38122 that runs through the format string itself, and checks the length of each
38123 conversion before performing it, thus preventing buffer overruns.
38124
38125 The remaining uses of &[sprintf()]& happen in controlled circumstances where
38126 the output buffer is known to be sufficiently long to contain the converted
38127 string.
38128
38129
38130
38131 .section "Use of debug_printf() and log_write()" "SECID280"
38132 Arbitrary strings are passed to both these functions, but they do their
38133 formatting by calling the function &'string_vformat()'&, which runs through
38134 the format string itself, and checks the length of each conversion.
38135
38136
38137
38138 .section "Use of strcat() and strcpy()" "SECID281"
38139 These are used only in cases where the output buffer is known to be large
38140 enough to hold the result.
38141 .ecindex IIDsecurcon
38142
38143
38144
38145
38146 . ////////////////////////////////////////////////////////////////////////////
38147 . ////////////////////////////////////////////////////////////////////////////
38148
38149 .chapter "Format of spool files" "CHAPspool"
38150 .scindex IIDforspo1 "format" "spool files"
38151 .scindex IIDforspo2 "spool directory" "format of files"
38152 .scindex IIDforspo3 "spool files" "format of"
38153 .cindex "spool files" "editing"
38154 A message on Exim's queue consists of two files, whose names are the message id
38155 followed by -D and -H, respectively. The data portion of the message is kept in
38156 the -D file on its own. The message's envelope, status, and headers are all
38157 kept in the -H file, whose format is described in this chapter. Each of these
38158 two files contains the final component of its own name as its first line. This
38159 is insurance against disk crashes where the directory is lost but the files
38160 themselves are recoverable.
38161
38162 Some people are tempted into editing -D files in order to modify messages. You
38163 need to be extremely careful if you do this; it is not recommended and you are
38164 on your own if you do it. Here are some of the pitfalls:
38165
38166 .ilist
38167 You must ensure that Exim does not try to deliver the message while you are
38168 fiddling with it. The safest way is to take out a write lock on the -D file,
38169 which is what Exim itself does, using &[fcntl()]&. If you update the file in
38170 place, the lock will be retained. If you write a new file and rename it, the
38171 lock will be lost at the instant of rename.
38172 .next
38173 .vindex "&$body_linecount$&"
38174 If you change the number of lines in the file, the value of
38175 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
38176 cause incomplete transmission of messages or undeliverable messages.
38177 .next
38178 If the message is in MIME format, you must take care not to break it.
38179 .next
38180 If the message is cryptographically signed, any change will invalidate the
38181 signature.
38182 .endlist
38183 All in all, modifying -D files is fraught with danger.
38184
38185 Files whose names end with -J may also be seen in the &_input_& directory (or
38186 its subdirectories when &%split_spool_directory%& is set). These are journal
38187 files, used to record addresses to which the message has been delivered during
38188 the course of a delivery attempt. If there are still undelivered recipients at
38189 the end, the -H file is updated, and the -J file is deleted. If, however, there
38190 is some kind of crash (for example, a power outage) before this happens, the -J
38191 file remains in existence. When Exim next processes the message, it notices the
38192 -J file and uses it to update the -H file before starting the next delivery
38193 attempt.
38194
38195 Files whose names end with -K or .eml may also be seen in the spool.
38196 These are temporaries used for DKIM or malware processing, when that is used.
38197 They should be tidied up by normal operations; any old ones are probably
38198 relics of crashes and can be removed.
38199
38200 .section "Format of the -H file" "SECID282"
38201 .cindex "uid (user id)" "in spool file"
38202 .cindex "gid (group id)" "in spool file"
38203 The second line of the -H file contains the login name for the uid of the
38204 process that called Exim to read the message, followed by the numerical uid and
38205 gid. For a locally generated message, this is normally the user who sent the
38206 message. For a message received over TCP/IP via the daemon, it is
38207 normally the Exim user.
38208
38209 The third line of the file contains the address of the message's sender as
38210 transmitted in the envelope, contained in angle brackets. The sender address is
38211 empty for bounce messages. For incoming SMTP mail, the sender address is given
38212 in the MAIL command. For locally generated mail, the sender address is
38213 created by Exim from the login name of the current user and the configured
38214 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
38215 leading &"From&~"& line if the caller is trusted, or if the supplied address is
38216 &"<>"& or an address that matches &%untrusted_set_senders%&.
38217
38218 The fourth line contains two numbers. The first is the time that the message
38219 was received, in the conventional Unix form &-- the number of seconds since the
38220 start of the epoch. The second number is a count of the number of messages
38221 warning of delayed delivery that have been sent to the sender.
38222
38223 There follow a number of lines starting with a hyphen. These can appear in any
38224 order, and are omitted when not relevant:
38225
38226 .vlist
38227 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
38228 This item is obsolete, and is not generated from Exim release 4.61 onwards;
38229 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
38230 recognized, to provide backward compatibility. In the old format, a line of
38231 this form is present for every ACL variable that is not empty. The number
38232 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
38233 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
38234 the data string for the variable. The string itself starts at the beginning of
38235 the next line, and is followed by a newline character. It may contain internal
38236 newlines.
38237
38238 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
38239 A line of this form is present for every ACL connection variable that is
38240 defined. Note that there is a space between &%-aclc%& and the rest of the name.
38241 The length is the length of the data string for the variable. The string itself
38242 starts at the beginning of the next line, and is followed by a newline
38243 character. It may contain internal newlines.
38244
38245 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
38246 A line of this form is present for every ACL message variable that is defined.
38247 Note that there is a space between &%-aclm%& and the rest of the name. The
38248 length is the length of the data string for the variable. The string itself
38249 starts at the beginning of the next line, and is followed by a newline
38250 character. It may contain internal newlines.
38251
38252 .vitem "&%-active_hostname%&&~<&'hostname'&>"
38253 This is present if, when the message was received over SMTP, the value of
38254 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
38255
38256 .vitem &%-allow_unqualified_recipient%&
38257 This is present if unqualified recipient addresses are permitted in header
38258 lines (to stop such addresses from being qualified if rewriting occurs at
38259 transport time). Local messages that were input using &%-bnq%& and remote
38260 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
38261
38262 .vitem &%-allow_unqualified_sender%&
38263 This is present if unqualified sender addresses are permitted in header lines
38264 (to stop such addresses from being qualified if rewriting occurs at transport
38265 time). Local messages that were input using &%-bnq%& and remote messages from
38266 hosts that match &%sender_unqualified_hosts%& set this flag.
38267
38268 .vitem "&%-auth_id%&&~<&'text'&>"
38269 The id information for a message received on an authenticated SMTP connection
38270 &-- the value of the &$authenticated_id$& variable.
38271
38272 .vitem "&%-auth_sender%&&~<&'address'&>"
38273 The address of an authenticated sender &-- the value of the
38274 &$authenticated_sender$& variable.
38275
38276 .vitem "&%-body_linecount%&&~<&'number'&>"
38277 This records the number of lines in the body of the message, and is
38278 present unless &%-spool_file_wireformat%& is.
38279
38280 .vitem "&%-body_zerocount%&&~<&'number'&>"
38281 This records the number of binary zero bytes in the body of the message, and is
38282 present if the number is greater than zero.
38283
38284 .vitem &%-deliver_firsttime%&
38285 This is written when a new message is first added to the spool. When the spool
38286 file is updated after a deferral, it is omitted.
38287
38288 .vitem "&%-frozen%&&~<&'time'&>"
38289 .cindex "frozen messages" "spool data"
38290 The message is frozen, and the freezing happened at <&'time'&>.
38291
38292 .vitem "&%-helo_name%&&~<&'text'&>"
38293 This records the host name as specified by a remote host in a HELO or EHLO
38294 command.
38295
38296 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
38297 This records the IP address of the host from which the message was received and
38298 the remote port number that was used. It is omitted for locally generated
38299 messages.
38300
38301 .vitem "&%-host_auth%&&~<&'text'&>"
38302 If the message was received on an authenticated SMTP connection, this records
38303 the name of the authenticator &-- the value of the
38304 &$sender_host_authenticated$& variable.
38305
38306 .vitem &%-host_lookup_failed%&
38307 This is present if an attempt to look up the sending host's name from its IP
38308 address failed. It corresponds to the &$host_lookup_failed$& variable.
38309
38310 .vitem "&%-host_name%&&~<&'text'&>"
38311 .cindex "reverse DNS lookup"
38312 .cindex "DNS" "reverse lookup"
38313 This records the name of the remote host from which the message was received,
38314 if the host name was looked up from the IP address when the message was being
38315 received. It is not present if no reverse lookup was done.
38316
38317 .vitem "&%-ident%&&~<&'text'&>"
38318 For locally submitted messages, this records the login of the originating user,
38319 unless it was a trusted user and the &%-oMt%& option was used to specify an
38320 ident value. For messages received over TCP/IP, this records the ident string
38321 supplied by the remote host, if any.
38322
38323 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
38324 This records the IP address of the local interface and the port number through
38325 which a message was received from a remote host. It is omitted for locally
38326 generated messages.
38327
38328 .vitem &%-local%&
38329 The message is from a local sender.
38330
38331 .vitem &%-localerror%&
38332 The message is a locally-generated bounce message.
38333
38334 .vitem "&%-local_scan%&&~<&'string'&>"
38335 This records the data string that was returned by the &[local_scan()]& function
38336 when the message was received &-- the value of the &$local_scan_data$&
38337 variable. It is omitted if no data was returned.
38338
38339 .vitem &%-manual_thaw%&
38340 The message was frozen but has been thawed manually, that is, by an explicit
38341 Exim command rather than via the auto-thaw process.
38342
38343 .vitem &%-N%&
38344 A testing delivery process was started using the &%-N%& option to suppress any
38345 actual deliveries, but delivery was deferred. At any further delivery attempts,
38346 &%-N%& is assumed.
38347
38348 .vitem &%-received_protocol%&
38349 This records the value of the &$received_protocol$& variable, which contains
38350 the name of the protocol by which the message was received.
38351
38352 .vitem &%-sender_set_untrusted%&
38353 The envelope sender of this message was set by an untrusted local caller (used
38354 to ensure that the caller is displayed in queue listings).
38355
38356 .vitem "&%-spam_score_int%&&~<&'number'&>"
38357 If a message was scanned by SpamAssassin, this is present. It records the value
38358 of &$spam_score_int$&.
38359
38360 .vitem &%-spool_file_wireformat%&
38361 The -D file for this message is in wire-format (for ESMTP CHUNKING)
38362 rather than Unix-format.
38363 The line-ending is CRLF rather than newline.
38364 There is still, however, no leading-dot-stuffing.
38365
38366 .vitem &%-tls_certificate_verified%&
38367 A TLS certificate was received from the client that sent this message, and the
38368 certificate was verified by the server.
38369
38370 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
38371 When the message was received over an encrypted connection, this records the
38372 name of the cipher suite that was used.
38373
38374 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
38375 When the message was received over an encrypted connection, and a certificate
38376 was received from the client, this records the Distinguished Name from that
38377 certificate.
38378 .endlist
38379
38380 Following the options there is a list of those addresses to which the message
38381 is not to be delivered. This set of addresses is initialized from the command
38382 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
38383 is set; otherwise it starts out empty. Whenever a successful delivery is made,
38384 the address is added to this set. The addresses are kept internally as a
38385 balanced binary tree, and it is a representation of that tree which is written
38386 to the spool file. If an address is expanded via an alias or forward file, the
38387 original address is added to the tree when deliveries to all its child
38388 addresses are complete.
38389
38390 If the tree is empty, there is a single line in the spool file containing just
38391 the text &"XX"&. Otherwise, each line consists of two letters, which are either
38392 Y or N, followed by an address. The address is the value for the node of the
38393 tree, and the letters indicate whether the node has a left branch and/or a
38394 right branch attached to it, respectively. If branches exist, they immediately
38395 follow. Here is an example of a three-node tree:
38396 .code
38397 YY darcy@austen.fict.example
38398 NN alice@wonderland.fict.example
38399 NN editor@thesaurus.ref.example
38400 .endd
38401 After the non-recipients tree, there is a list of the message's recipients.
38402 This is a simple list, preceded by a count. It includes all the original
38403 recipients of the message, including those to whom the message has already been
38404 delivered. In the simplest case, the list contains one address per line. For
38405 example:
38406 .code
38407 4
38408 editor@thesaurus.ref.example
38409 darcy@austen.fict.example
38410 rdo@foundation
38411 alice@wonderland.fict.example
38412 .endd
38413 However, when a child address has been added to the top-level addresses as a
38414 result of the use of the &%one_time%& option on a &(redirect)& router, each
38415 line is of the following form:
38416 .display
38417 <&'top-level address'&> <&'errors_to address'&> &&&
38418   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38419 .endd
38420 The 01 flag bit indicates the presence of the three other fields that follow
38421 the top-level address. Other bits may be used in future to support additional
38422 fields. The <&'parent number'&> is the offset in the recipients list of the
38423 original parent of the &"one time"& address. The first two fields are the
38424 envelope sender that is associated with this address and its length. If the
38425 length is zero, there is no special envelope sender (there are then two space
38426 characters in the line). A non-empty field can arise from a &(redirect)& router
38427 that has an &%errors_to%& setting.
38428
38429
38430 A blank line separates the envelope and status information from the headers
38431 which follow. A header may occupy several lines of the file, and to save effort
38432 when reading it in, each header is preceded by a number and an identifying
38433 character. The number is the number of characters in the header, including any
38434 embedded newlines and the terminating newline. The character is one of the
38435 following:
38436
38437 .table2 50pt
38438 .row <&'blank'&>         "header in which Exim has no special interest"
38439 .row &`B`&               "&'Bcc:'& header"
38440 .row &`C`&               "&'Cc:'& header"
38441 .row &`F`&               "&'From:'& header"
38442 .row &`I`&               "&'Message-id:'& header"
38443 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38444 .row &`R`&               "&'Reply-To:'& header"
38445 .row &`S`&               "&'Sender:'& header"
38446 .row &`T`&               "&'To:'& header"
38447 .row &`*`&               "replaced or deleted header"
38448 .endtable
38449
38450 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38451 purposes. They are not transmitted when the message is delivered. Here is a
38452 typical set of headers:
38453 .code
38454 111P Received: by hobbit.fict.example with local (Exim 4.00)
38455 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38456 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38457 038* X-rewrote-sender: bb@hobbit.fict.example
38458 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38459 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38460 099* To: alice@wonderland.fict.example, rdo@foundation,
38461 darcy@austen.fict.example, editor@thesaurus.ref.example
38462 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38463 darcy@austen.fict.example, editor@thesaurus.ref.example
38464 038  Date: Fri, 11 May 2001 10:28:59 +0100
38465 .endd
38466 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38467 &'To:'& header have been rewritten, the last one because routing expanded the
38468 unqualified domain &'foundation'&.
38469 .ecindex IIDforspo1
38470 .ecindex IIDforspo2
38471 .ecindex IIDforspo3
38472
38473 .section "Format of the -D file" "SECID282a"
38474 The data file is traditionally in Unix-standard format: lines are ended with
38475 an ASCII newline character.
38476 However, when the &%spool_wireformat%& main option is used some -D files
38477 can have an alternate format.
38478 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
38479 The -D file lines (not including the first name-component line) are
38480 suitable for direct copying to the wire when transmitting using the
38481 ESMTP CHUNKING option, meaning lower processing overhead.
38482 Lines are terminated with an ASCII CRLF pair.
38483 There is no dot-stuffing (and no dot-termination).
38484
38485 . ////////////////////////////////////////////////////////////////////////////
38486 . ////////////////////////////////////////////////////////////////////////////
38487
38488 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38489          "DKIM Support"
38490 .cindex "DKIM"
38491
38492 DKIM is a mechanism by which messages sent by some entity can be provably
38493 linked to a domain which that entity controls.  It permits reputation to
38494 be tracked on a per-domain basis, rather than merely upon source IP address.
38495 DKIM is documented in RFC 4871.
38496
38497 DKIM support is compiled into Exim by default if TLS support is present.
38498 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38499
38500 Exim's DKIM implementation allows for
38501 .olist
38502 Signing outgoing messages: This function is implemented in the SMTP transport.
38503 It can co-exist with all other Exim features
38504 (including transport filters)
38505 except cutthrough delivery.
38506 .next
38507 Verifying signatures in incoming messages: This is implemented by an additional
38508 ACL (acl_smtp_dkim), which can be called several times per message, with
38509 different signature contexts.
38510 .endlist
38511
38512 In typical Exim style, the verification implementation does not include any
38513 default "policy". Instead it enables you to build your own policy using
38514 Exim's standard controls.
38515
38516 Please note that verification of DKIM signatures in incoming mail is turned
38517 on by default for logging purposes. For each signature in incoming email,
38518 exim will log a line displaying the most important signature details, and the
38519 signature status. Here is an example (with line-breaks added for clarity):
38520 .code
38521 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38522     d=facebookmail.com s=q1-2009b
38523     c=relaxed/relaxed a=rsa-sha1
38524     i=@facebookmail.com t=1252484542 [verification succeeded]
38525 .endd
38526 You might want to turn off DKIM verification processing entirely for internal
38527 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38528 control modifier. This should typically be done in the RCPT ACL, at points
38529 where you accept mail from relay sources (internal hosts or authenticated
38530 senders).
38531
38532
38533 .section "Signing outgoing messages" "SECDKIMSIGN"
38534 .cindex "DKIM" "signing"
38535
38536 Signing is enabled by setting private options on the SMTP transport.
38537 These options take (expandable) strings as arguments.
38538
38539 .option dkim_domain smtp string list&!! unset
38540 The domain(s) you want to sign with.
38541 After expansion, this can be a list.
38542 Each element in turn is put into the &%$dkim_domain%& expansion variable
38543 while expanding the remaining signing options.
38544 If it is empty after expansion, DKIM signing is not done.
38545
38546 .option dkim_selector smtp string list&!! unset
38547 This sets the key selector string.
38548 After expansion, which can use &$dkim_domain$&, this can be a list.
38549 Each element in turn is put in the expansion
38550 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38551 option along with &%$dkim_domain%&.
38552 If the option is empty after expansion, DKIM signing is not done for this domain.
38553
38554 .option dkim_private_key smtp string&!! unset
38555 This sets the private key to use.
38556 You can use the &%$dkim_domain%& and
38557 &%$dkim_selector%& expansion variables to determine the private key to use.
38558 The result can either
38559 .ilist
38560 be a valid RSA private key in ASCII armor, including line breaks.
38561 .next
38562 start with a slash, in which case it is treated as a file that contains
38563 the private key.
38564 .next
38565 be "0", "false" or the empty string, in which case the message will not
38566 be signed. This case will not result in an error, even if &%dkim_strict%&
38567 is set.
38568 .endlist
38569 If the option is empty after expansion, DKIM signing is not done.
38570
38571 .option dkim_hash smtp string&!! sha256
38572 Can be set alternatively to &"sha1"& to use an alternate hash
38573 method.  Note that sha1 is now condidered insecure, and deprecated.
38574
38575 .option dkim_identity smtp string&!! unset
38576 If set after expansion, the value is used to set an "i=" tag in
38577 the signing header.  The DKIM standards restrict the permissible
38578 syntax of this optional tag to a mail address, with possibly-empty
38579 local part, an @, and a domain identical to or subdomain of the "d="
38580 tag value.  Note that Exim does not check the value.
38581
38582 .option dkim_canon smtp string&!! unset
38583 This option sets the canonicalization method used when signing a message.
38584 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38585 The option defaults to "relaxed" when unset. Note: the current implementation
38586 only supports using the same canonicalization method for both headers and body.
38587
38588 .option dkim_strict smtp string&!! unset
38589 This  option  defines  how  Exim  behaves  when  signing a message that
38590 should be signed fails for some reason.  When the expansion evaluates to
38591 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38592 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38593 variables here.
38594
38595 .option dkim_sign_headers smtp string&!! "see below"
38596 If set, this option must expand to a colon-separated
38597 list of header names.
38598 Headers with these names, or the absence or such a header, will be included
38599 in the message signature.
38600 When unspecified, the header names listed in RFC4871 will be used,
38601 whether or not each header is present in the message.
38602 The default list is available for the expansion in the macro
38603 "_DKIM_SIGN_HEADERS".
38604
38605 If a name is repeated, multiple headers by that name (or the absence therof)
38606 will be signed.  The textually later headers in the headers part of the
38607 message are signed first, if there are multiples.
38608
38609 A name can be prefixed with either an '=' or a '+' character.
38610 If an '=' prefix is used, all headers that are present with this name
38611 will be signed.
38612 If a '+' prefix if used, all headers that are present with this name
38613 will be signed, and one signtature added for a missing header with the
38614 name will be appended.
38615
38616
38617 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38618 .cindex "DKIM" "verification"
38619
38620 Verification of DKIM signatures in SMTP incoming email is implemented via the
38621 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38622 syntactically(!) correct signature in the incoming message.
38623 A missing ACL definition defaults to accept.
38624 If any ACL call does not accept, the message is not accepted.
38625 If a cutthrough delivery was in progress for the message, that is
38626 summarily dropped (having wasted the transmission effort).
38627
38628 To evaluate the signature in the ACL a large number of expansion variables
38629 containing the signature status and its details are set up during the
38630 runtime of the ACL.
38631
38632 Calling the ACL only for existing signatures is not sufficient to build
38633 more advanced policies. For that reason, the global option
38634 &%dkim_verify_signers%&, and a global expansion variable
38635 &%$dkim_signers%& exist.
38636
38637 The global option &%dkim_verify_signers%& can be set to a colon-separated
38638 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38639 called. It is expanded when the message has been received. At this point,
38640 the expansion variable &%$dkim_signers%& already contains a colon-separated
38641 list of signer domains and identities for the message. When
38642 &%dkim_verify_signers%& is not specified in the main configuration,
38643 it defaults as:
38644 .code
38645 dkim_verify_signers = $dkim_signers
38646 .endd
38647 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38648 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38649 call the ACL for known domains or identities. This would be achieved as follows:
38650 .code
38651 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38652 .endd
38653 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38654 and "ebay.com", plus all domains and identities that have signatures in the message.
38655 You can also be more creative in constructing your policy. For example:
38656 .code
38657 dkim_verify_signers = $sender_address_domain:$dkim_signers
38658 .endd
38659
38660 If a domain or identity is listed several times in the (expanded) value of
38661 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38662
38663 If multiple signatures match a domain (or identity), the ACL is called once
38664 for each matching signature.
38665
38666
38667 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38668 available (from most to least important):
38669
38670
38671 .vlist
38672 .vitem &%$dkim_cur_signer%&
38673 The signer that is being evaluated in this ACL run. This can be a domain or
38674 an identity. This is one of the list items from the expanded main option
38675 &%dkim_verify_signers%& (see above).
38676
38677 .vitem &%$dkim_verify_status%&
38678 Within the DKIM ACL,
38679 a string describing the general status of the signature. One of
38680 .ilist
38681 &%none%&: There is no signature in the message for the current domain or
38682 identity (as reflected by &%$dkim_cur_signer%&).
38683 .next
38684 &%invalid%&: The signature could not be verified due to a processing error.
38685 More detail is available in &%$dkim_verify_reason%&.
38686 .next
38687 &%fail%&: Verification of the signature failed.  More detail is
38688 available in &%$dkim_verify_reason%&.
38689 .next
38690 &%pass%&: The signature passed verification. It is valid.
38691 .endlist
38692
38693 This variable can be overwritten using an ACL 'set' modifier.
38694 This might, for instance, be done to enforce a policy restriction on
38695 hash-method or key-size:
38696 .code
38697   warn  condition =     ${if eq {$dkim_algo}{rsa-sha1}}
38698         condition =     ${if eq {$dkim_verify_status}{pass}}
38699         logwrite =      NOTE: forcing dkim verify fail (was pass)
38700         set dkim_verify_status = fail
38701         set dkim_verify_reason = hash too weak
38702 .endd
38703
38704 After all the DKIM ACL runs have completed, the value becomes a
38705 colon-separated list of the values after each run.
38706
38707 .vitem &%$dkim_verify_reason%&
38708 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38709 "fail" or "invalid". One of
38710 .ilist
38711 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38712 key for the domain could not be retrieved. This may be a temporary problem.
38713 .next
38714 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38715 record for the domain is syntactically invalid.
38716 .next
38717 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38718 body hash does not match the one specified in the signature header. This
38719 means that the message body was modified in transit.
38720 .next
38721 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38722 could not be verified. This may mean that headers were modified,
38723 re-written or otherwise changed in a way which is incompatible with
38724 DKIM verification. It may of course also mean that the signature is forged.
38725 .endlist
38726
38727 This variable can be overwritten using an ACL 'set' modifier.
38728
38729 .vitem &%$dkim_domain%&
38730 The signing domain. IMPORTANT: This variable is only populated if there is
38731 an actual signature in the message for the current domain or identity (as
38732 reflected by &%$dkim_cur_signer%&).
38733
38734 .vitem &%$dkim_identity%&
38735 The signing identity, if present. IMPORTANT: This variable is only populated
38736 if there is an actual signature in the message for the current domain or
38737 identity (as reflected by &%$dkim_cur_signer%&).
38738
38739 .vitem &%$dkim_selector%&
38740 The key record selector string.
38741
38742 .vitem &%$dkim_algo%&
38743 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38744
38745 .vitem &%$dkim_canon_body%&
38746 The body canonicalization method. One of 'relaxed' or 'simple'.
38747
38748 .vitem &%$dkim_canon_headers%&
38749 The header canonicalization method. One of 'relaxed' or 'simple'.
38750
38751 .vitem &%$dkim_copiedheaders%&
38752 A transcript of headers and their values which are included in the signature
38753 (copied from the 'z=' tag of the signature).
38754 Note that RFC6376 requires that verification fail if the From: header is
38755 not included in the signature.  Exim does not enforce this; sites wishing
38756 strict enforcement should code the check explicitly.
38757
38758 .vitem &%$dkim_bodylength%&
38759 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38760 limit was set by the signer, "9999999999999" is returned. This makes sure
38761 that this variable always expands to an integer value.
38762
38763 .vitem &%$dkim_created%&
38764 UNIX timestamp reflecting the date and time when the signature was created.
38765 When this was not specified by the signer, "0" is returned.
38766
38767 .vitem &%$dkim_expires%&
38768 UNIX timestamp reflecting the date and time when the signer wants the
38769 signature to be treated as "expired". When this was not specified by the
38770 signer, "9999999999999" is returned. This makes it possible to do useful
38771 integer size comparisons against this value.
38772
38773 .vitem &%$dkim_headernames%&
38774 A colon-separated list of names of headers included in the signature.
38775
38776 .vitem &%$dkim_key_testing%&
38777 "1" if the key record has the "testing" flag set, "0" if not.
38778
38779 .vitem &%$dkim_key_nosubdomains%&
38780 "1" if the key record forbids subdomaining, "0" otherwise.
38781
38782 .vitem &%$dkim_key_srvtype%&
38783 Service type (tag s=) from the key record. Defaults to "*" if not specified
38784 in the key record.
38785
38786 .vitem &%$dkim_key_granularity%&
38787 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38788 in the key record.
38789
38790 .vitem &%$dkim_key_notes%&
38791 Notes from the key record (tag n=).
38792
38793 .vitem &%$dkim_key_length%&
38794 Number of bits in the key.
38795 .endlist
38796
38797 In addition, two ACL conditions are provided:
38798
38799 .vlist
38800 .vitem &%dkim_signers%&
38801 ACL condition that checks a colon-separated list of domains or identities
38802 for a match against the domain or identity that the ACL is currently verifying
38803 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38804 verb to a group of domains or identities. For example:
38805
38806 .code
38807 # Warn when Mail purportedly from GMail has no gmail signature
38808 warn log_message = GMail sender without gmail.com DKIM signature
38809      sender_domains = gmail.com
38810      dkim_signers = gmail.com
38811      dkim_status = none
38812 .endd
38813
38814 Note that the above does not check for a total lack of DKIM signing;
38815 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
38816
38817 .vitem &%dkim_status%&
38818 ACL condition that checks a colon-separated list of possible DKIM verification
38819 results against the actual result of verification. This is typically used
38820 to restrict an ACL verb to a list of verification outcomes, for example:
38821
38822 .code
38823 deny message = Mail from Paypal with invalid/missing signature
38824      sender_domains = paypal.com:paypal.de
38825      dkim_signers = paypal.com:paypal.de
38826      dkim_status = none:invalid:fail
38827 .endd
38828
38829 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38830 see the documentation of the &%$dkim_verify_status%& expansion variable above
38831 for more information of what they mean.
38832 .endlist
38833
38834 . ////////////////////////////////////////////////////////////////////////////
38835 . ////////////////////////////////////////////////////////////////////////////
38836
38837 .chapter "Proxies" "CHAPproxies" &&&
38838          "Proxy support"
38839 .cindex "proxy support"
38840 .cindex "proxy" "access via"
38841
38842 A proxy is an intermediate system through which communication is passed.
38843 Proxies may provide a security, availability or load-distribution function.
38844
38845
38846 .section "Inbound proxies" SECTproxyInbound
38847 .cindex proxy inbound
38848 .cindex proxy "server side"
38849 .cindex proxy "Proxy protocol"
38850 .cindex "Proxy protocol" proxy
38851
38852 Exim has support for receiving inbound SMTP connections via a proxy
38853 that uses &"Proxy Protocol"& to speak to it.
38854 To include this support, include &"SUPPORT_PROXY=yes"&
38855 in Local/Makefile.
38856
38857 It was built on specifications from:
38858 (&url(http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt)).
38859 That URL was revised in May 2014 to version 2 spec:
38860 (&url(http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e)).
38861
38862 The purpose of this facility is so that an application load balancer,
38863 such as HAProxy, can sit in front of several Exim servers
38864 to distribute load.
38865 Exim uses the local protocol communication with the proxy to obtain
38866 the remote SMTP system IP address and port information.
38867 There is no logging if a host passes or
38868 fails Proxy Protocol negotiation, but it can easily be determined and
38869 recorded in an ACL (example is below).
38870
38871 Use of a proxy is enabled by setting the &%hosts_proxy%&
38872 main configuration option to a hostlist; connections from these
38873 hosts will use Proxy Protocol.
38874 Exim supports both version 1 and version 2 of the Proxy Protocol and
38875 automatically determines which version is in use.
38876
38877 The Proxy Protocol header is the first data received on a TCP connection
38878 and is inserted before any TLS-on-connect handshake from the client; Exim
38879 negotiates TLS between Exim-as-server and the remote client, not between
38880 Exim and the proxy server.
38881
38882 The following expansion variables are usable
38883 (&"internal"& and &"external"& here refer to the interfaces
38884 of the proxy):
38885 .display
38886 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38887 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38888 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
38889 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
38890 &'proxy_session            '& boolean: SMTP connection via proxy
38891 .endd
38892 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38893 there was a protocol error.
38894
38895 Since the real connections are all coming from the proxy, and the
38896 per host connection tracking is done before Proxy Protocol is
38897 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38898 handle all of the parallel volume you expect per inbound proxy.
38899 With the option set so high, you lose the ability
38900 to protect your server from many connections from one IP.
38901 In order to prevent your server from overload, you
38902 need to add a per connection ratelimit to your connect ACL.
38903 A possible solution is:
38904 .display
38905   # Set max number of connections per host
38906   LIMIT   = 5
38907   # Or do some kind of IP lookup in a flat file or database
38908   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38909
38910   defer   message        = Too many connections from this IP right now
38911           ratelimit      = LIMIT / 5s / per_conn / strict
38912 .endd
38913
38914
38915
38916 .section "Outbound proxies" SECTproxySOCKS
38917 .cindex proxy outbound
38918 .cindex proxy "client side"
38919 .cindex proxy SOCKS
38920 .cindex SOCKS proxy
38921 Exim has support for sending outbound SMTP via a proxy
38922 using a protocol called SOCKS5 (defined by RFC1928).
38923 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38924 Local/Makefile.
38925
38926 Use of a proxy is enabled by setting the &%socks_proxy%& option
38927 on an smtp transport.
38928 The option value is expanded and should then be a list
38929 (colon-separated by default) of proxy specifiers.
38930 Each proxy specifier is a list
38931 (space-separated by default) where the initial element
38932 is an IP address and any subsequent elements are options.
38933
38934 Options are a string <name>=<value>.
38935 The list of options is in the following table:
38936 .display
38937 &'auth   '& authentication method
38938 &'name   '& authentication username
38939 &'pass   '& authentication password
38940 &'port   '& tcp port
38941 &'tmo    '& connection timeout
38942 &'pri    '& priority
38943 &'weight '& selection bias
38944 .endd
38945
38946 More details on each of these options follows:
38947
38948 .ilist
38949 .cindex authentication "to proxy"
38950 .cindex proxy authentication
38951 &%auth%&: Either &"none"& (default) or &"name"&.
38952 Using &"name"& selects username/password authentication per RFC 1929
38953 for access to the proxy.
38954 Default is &"none"&.
38955 .next
38956 &%name%&: sets the username for the &"name"& authentication method.
38957 Default is empty.
38958 .next
38959 &%pass%&: sets the password for the &"name"& authentication method.
38960 Default is empty.
38961 .next
38962 &%port%&: the TCP port number to use for the connection to the proxy.
38963 Default is 1080.
38964 .next
38965 &%tmo%&: sets a connection timeout in seconds for this proxy.
38966 Default is 5.
38967 .next
38968 &%pri%&: specifies a priority for the proxy within the list,
38969 higher values being tried first.
38970 The default priority is 1.
38971 .next
38972 &%weight%&: specifies a selection bias.
38973 Within a priority set servers are queried in a random fashion,
38974 weighted by this value.
38975 The default value for selection bias is 1.
38976 .endlist
38977
38978 Proxies from the list are tried according to their priority
38979 and weight settings until one responds.  The timeout for the
38980 overall connection applies to the set of proxied attempts.
38981
38982 .section Logging SECTproxyLog
38983 To log the (local) IP of a proxy in the incoming or delivery logline,
38984 add &"+proxy"& to the &%log_selector%& option.
38985 This will add a component tagged with &"PRX="& to the line.
38986
38987 . ////////////////////////////////////////////////////////////////////////////
38988 . ////////////////////////////////////////////////////////////////////////////
38989
38990 .chapter "Internationalisation" "CHAPi18n" &&&
38991          "Internationalisation""
38992 .cindex internationalisation "email address"
38993 .cindex EAI
38994 .cindex i18n
38995 .cindex UTF-8 "mail name handling"
38996
38997 Exim has support for Internationalised mail names.
38998 To include this it must be built with SUPPORT_I18N and the libidn library.
38999 Standards supported are RFCs 2060, 5890, 6530 and 6533.
39000
39001 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
39002 instead of it) then IDNA2008 is supported; this adds an extra library
39003 requirement, upon libidn2.
39004
39005 .section "MTA operations" SECTi18nMTA
39006 .cindex SMTPUTF8 "ESMTP option"
39007 The main configuration option &%smtputf8_advertise_hosts%& specifies
39008 a host list.  If this matches the sending host and
39009 accept_8bitmime is true (the default) then the ESMTP option
39010 SMTPUTF8 will be advertised.
39011
39012 If the sender specifies the SMTPUTF8 option on a MAIL command
39013 international handling for the message is enabled and
39014 the expansion variable &$message_smtputf8$& will have value TRUE.
39015
39016 The option &%allow_utf8_domains%& is set to true for this
39017 message. All DNS lookups are converted to a-label form
39018 whatever the setting of &%allow_utf8_domains%&
39019 when Exim is built with SUPPORT_I18N.
39020
39021 Both localparts and domain are maintained as the original
39022 UTF-8 form internally; any comparison or regular-expression use will
39023 require appropriate care.  Filenames created, eg. by
39024 the appendfile transport, will have UTF-8 names.
39025
39026 HELO names sent by the smtp transport will have any UTF-8
39027 components expanded to a-label form,
39028 and any certificate name checks will be done using the a-label
39029 form of the name.
39030
39031 .cindex log protocol
39032 .cindex SMTPUTF8 logging
39033 Log lines and Received-by: header lines will acquire a "utf8"
39034 prefix on the protocol element, eg. utf8esmtp.
39035
39036 The following expansion operators can be used:
39037 .code
39038 ${utf8_domain_to_alabel:str}
39039 ${utf8_domain_from_alabel:str}
39040 ${utf8_localpart_to_alabel:str}
39041 ${utf8_localpart_from_alabel:str}
39042 .endd
39043
39044 ACLs may use the following modifier:
39045 .display
39046 control = utf8_downconvert
39047 control = utf8_downconvert/<value>
39048 .endd
39049 This sets a flag requiring that addresses are converted to
39050 a-label form before smtp delivery, for use in a
39051 Message Submission Agent context.
39052 If a value is appended it may be:
39053 .display
39054 &`1  `& (default) mandatory downconversion
39055 &`0  `& no downconversion
39056 &`-1 `& if SMTPUTF8 not supported by destination host
39057 .endd
39058
39059 If mua_wrapper is set, the utf8_downconvert control
39060 is initially set to -1.
39061
39062
39063 There is no explicit support for VRFY and EXPN.
39064 Configurations supporting these should inspect
39065 &$smtp_command_argument$& for an SMTPUTF8 argument.
39066
39067 There is no support for LMTP on Unix sockets.
39068 Using the "lmtp" protocol option on an smtp transport,
39069 for LMTP over TCP, should work as expected.
39070
39071 There is no support for DSN unitext handling,
39072 and no provision for converting logging from or to UTF-8.
39073
39074
39075
39076 .section "MDA operations" SECTi18nMDA
39077 To aid in constructing names suitable for IMAP folders
39078 the following expansion operator can be used:
39079 .code
39080 ${imapfolder {<string>} {<sep>} {<specials>}}
39081 .endd
39082
39083 The string is converted from the charset specified by
39084 the "headers charset" command (in a filter file)
39085 or &%headers_charset%& main configuration option (otherwise),
39086 to the
39087 modified UTF-7 encoding specified by RFC 2060,
39088 with the following exception: All occurences of <sep>
39089 (which has to be a single character)
39090 are replaced with periods ("."), and all periods and slashes that are not
39091 <sep> and are not in the <specials> string are BASE64 encoded.
39092
39093 The third argument can be omitted, defaulting to an empty string.
39094 The second argument can be omitted, defaulting to "/".
39095
39096 This is the encoding used by Courier for Maildir names on disk, and followed
39097 by many other IMAP servers.
39098
39099 Examples:
39100 .display
39101 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
39102 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
39103 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
39104 .endd
39105
39106 Note that the source charset setting is vital, and also that characters
39107 must be representable in UTF-16.
39108
39109
39110 . ////////////////////////////////////////////////////////////////////////////
39111 . ////////////////////////////////////////////////////////////////////////////
39112
39113 .chapter "Events" "CHAPevents" &&&
39114          "Events"
39115 .cindex events
39116
39117 The events mechanism in Exim can be used to intercept processing at a number
39118 of points.  It was originally invented to give a way to do customised logging
39119 actions (for example, to a database) but can also be used to modify some
39120 processing actions.
39121
39122 Most installations will never need to use Events.
39123 The support can be left out of a build by defining DISABLE_EVENT=yes
39124 in &_Local/Makefile_&.
39125
39126 There are two major classes of events: main and transport.
39127 The main configuration option &%event_action%& controls reception events;
39128 a transport option &%event_action%& controls delivery events.
39129
39130 Both options are a string which is expanded when the event fires.
39131 An example might look like:
39132 .cindex logging custom
39133 .code
39134 event_action = ${if eq {msg:delivery}{$event_name} \
39135 {${lookup pgsql {SELECT * FROM record_Delivery( \
39136     '${quote_pgsql:$sender_address_domain}',\
39137     '${quote_pgsql:${lc:$sender_address_local_part}}', \
39138     '${quote_pgsql:$domain}', \
39139     '${quote_pgsql:${lc:$local_part}}', \
39140     '${quote_pgsql:$host_address}', \
39141     '${quote_pgsql:${lc:$host}}', \
39142     '${quote_pgsql:$message_exim_id}')}} \
39143 } {}}
39144 .endd
39145
39146 Events have names which correspond to the point in process at which they fire.
39147 The name is placed in the variable &$event_name$& and the event action
39148 expansion must check this, as it will be called for every possible event type.
39149
39150 The current list of events is:
39151 .display
39152 &`msg:complete           after    main       `& per message
39153 &`msg:delivery           after    transport  `& per recipient
39154 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
39155 &`msg:rcpt:defer         after    transport  `& per recipient
39156 &`msg:host:defer         after    transport  `& per attempt
39157 &`msg:fail:delivery      after    transport  `& per recipient
39158 &`msg:fail:internal      after    main       `& per recipient
39159 &`tcp:connect            before   transport  `& per connection
39160 &`tcp:close              after    transport  `& per connection
39161 &`tls:cert               before   both       `& per certificate in verification chain
39162 &`smtp:connect           after    transport  `& per connection
39163 .endd
39164 New event types may be added in future.
39165
39166 The event name is a colon-separated list, defining the type of
39167 event in a tree of possibilities.  It may be used as a list
39168 or just matched on as a whole.  There will be no spaces in the name.
39169
39170 The second column in the table above describes whether the event fires
39171 before or after the action is associates with.  Those which fire before
39172 can be used to affect that action (more on this below).
39173
39174 The third column in the table above says what section of the configumration
39175 should define the event action.
39176
39177 An additional variable, &$event_data$&, is filled with information varying
39178 with the event type:
39179 .display
39180 &`msg:delivery         `& smtp confirmation message
39181 &`msg:rcpt:host:defer  `& error string
39182 &`msg:rcpt:defer       `& error string
39183 &`msg:host:defer       `& error string
39184 &`tls:cert             `& verification chain depth
39185 &`smtp:connect         `& smtp banner
39186 .endd
39187
39188 The :defer events populate one extra variable: &$event_defer_errno$&.
39189
39190 For complex operations an ACL expansion can be used in &%event_action%&
39191 however due to the multiple contexts that Exim operates in during
39192 the course of its processing:
39193 .ilist
39194 variables set in transport events will not be visible outside that
39195 transport call
39196 .next
39197 acl_m variables in a server context are lost on a new connection,
39198 and after smtp helo/ehlo/mail/starttls/rset commands
39199 .endlist
39200 Using an ACL expansion with the logwrite modifier can be
39201 a useful way of writing to the main log.
39202
39203 The expansion of the event_action option should normally
39204 return an empty string.  Should it return anything else the
39205 following will be forced:
39206 .display
39207 &`msg:delivery     `&  (ignored)
39208 &`msg:host:defer   `&  (ignored)
39209 &`msg:fail:delivery`&  (ignored)
39210 &`tcp:connect      `&  do not connect
39211 &`tcp:close        `&  (ignored)
39212 &`tls:cert         `&  refuse verification
39213 &`smtp:connect     `&  close connection
39214 .endd
39215 No other use is made of the result string.
39216
39217 For a tcp:connect event, if the connection is being made to a proxy
39218 then the address and port variables will be that of the proxy and not
39219 the target system.
39220
39221 For tls:cert events, if GnuTLS is in use this will trigger only per
39222 chain element received on the connection.
39223 For OpenSSL it will trigger for every chain element including those
39224 loaded locally.
39225
39226 . ////////////////////////////////////////////////////////////////////////////
39227 . ////////////////////////////////////////////////////////////////////////////
39228
39229 .chapter "Adding new drivers or lookup types" "CHID13" &&&
39230          "Adding drivers or lookups"
39231 .cindex "adding drivers"
39232 .cindex "new drivers, adding"
39233 .cindex "drivers" "adding new"
39234 The following actions have to be taken in order to add a new router, transport,
39235 authenticator, or lookup type to Exim:
39236
39237 .olist
39238 Choose a name for the driver or lookup type that does not conflict with any
39239 existing name; I will use &"newdriver"& in what follows.
39240 .next
39241 Add to &_src/EDITME_& the line:
39242 .display
39243 <&'type'&>&`_NEWDRIVER=yes`&
39244 .endd
39245 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
39246 code is not to be included in the binary by default, comment this line out. You
39247 should also add any relevant comments about the driver or lookup type.
39248 .next
39249 Add to &_src/config.h.defaults_& the line:
39250 .code
39251 #define <type>_NEWDRIVER
39252 .endd
39253 .next
39254 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
39255 and create a table entry as is done for all the other drivers and lookup types.
39256 .next
39257 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
39258 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
39259 Add your &`NEWDRIVER`& to that list.
39260 As long as the dynamic module would be named &_newdriver.so_&, you can use the
39261 simple form that most lookups have.
39262 .next
39263 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
39264 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
39265 driver or lookup type and add it to the definition of OBJ.
39266 .next
39267 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
39268 &_src_&.
39269 .next
39270 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
39271 as for other drivers and lookups.
39272 .endlist
39273
39274 Then all you need to do is write the code! A good way to start is to make a
39275 proforma by copying an existing module of the same type, globally changing all
39276 occurrences of the name, and cutting out most of the code. Note that any
39277 options you create must be listed in alphabetical order, because the tables are
39278 searched using a binary chop procedure.
39279
39280 There is a &_README_& file in each of the sub-directories of &_src_& describing
39281 the interface that is expected.
39282
39283
39284
39285
39286 . ////////////////////////////////////////////////////////////////////////////
39287 . ////////////////////////////////////////////////////////////////////////////
39288
39289 . /////////////////////////////////////////////////////////////////////////////
39290 . These lines are processing instructions for the Simple DocBook Processor that
39291 . Philip Hazel has developed as a less cumbersome way of making PostScript and
39292 . PDFs than using xmlto and fop. They will be ignored by all other XML
39293 . processors.
39294 . /////////////////////////////////////////////////////////////////////////////
39295
39296 .literal xml
39297 <?sdop
39298   format="newpage"
39299   foot_right_recto="&chaptertitle;"
39300   foot_right_verso="&chaptertitle;"
39301 ?>
39302 .literal off
39303
39304 .makeindex "Options index"   "option"
39305 .makeindex "Variables index" "variable"
39306 .makeindex "Concept index"   "concept"
39307
39308
39309 . /////////////////////////////////////////////////////////////////////////////
39310 . /////////////////////////////////////////////////////////////////////////////