Logging: TCP Fast Open
[exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.89"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2017
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- the small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of the program,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of the document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, the manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(http://www.uit.co.uk/exim-book/)).
396
397 This book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As the program develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to the program (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP and web sites" "SECID2"
449 .cindex "web site"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is currently the University of
452 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
453 distribution'& below. In addition, there is a web site and an FTP site at
454 &%exim.org%&. These are now also hosted at the University of Cambridge. The
455 &%exim.org%& site was previously hosted for a number of years by Energis
456 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
457
458 .cindex "wiki"
459 .cindex "FAQ"
460 As well as Exim distribution tar files, the Exim web site contains a number of
461 differently formatted versions of the documentation. A recent addition to the
462 online information is the Exim wiki (&url(http://wiki.exim.org)),
463 which contains what used to be a separate FAQ, as well as various other
464 examples, tips, and know-how that have been contributed by Exim users.
465
466 .cindex Bugzilla
467 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
468 this to report bugs, and also to add items to the wish list. Please search
469 first to check that you are not duplicating a previous entry.
470
471
472
473 .section "Mailing lists" "SECID3"
474 .cindex "mailing lists" "for Exim users"
475 The following Exim mailing lists exist:
476
477 .table2 140pt
478 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
479 .row &'exim-users@exim.org'&      "General discussion list"
480 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
481 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
482 .endtable
483
484 You can subscribe to these lists, change your existing subscriptions, and view
485 or search the archives via the mailing lists link on the Exim home page.
486 .cindex "Debian" "mailing list for"
487 If you are using a Debian distribution of Exim, you may wish to subscribe to
488 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
489 via this web page:
490 .display
491 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
492 .endd
493 Please ask Debian-specific questions on this list and not on the general Exim
494 lists.
495
496 .section "Bug reports" "SECID5"
497 .cindex "bug reports"
498 .cindex "reporting bugs"
499 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
500 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
501 whether some behaviour is a bug or not, the best thing to do is to post a
502 message to the &'exim-dev'& mailing list and have it discussed.
503
504
505
506 .section "Where to find the Exim distribution" "SECTavail"
507 .cindex "FTP site"
508 .cindex "distribution" "ftp site"
509 The master ftp site for the Exim distribution is
510 .display
511 &*ftp://ftp.exim.org/pub/exim*&
512 .endd
513 The file references that follow are relative to the &_exim_& directories at
514 these sites. There are now quite a number of independent mirror sites around
515 the world. Those that I know about are listed in the file called &_Mirrors_&.
516
517 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
518 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
519 distributions), and &_Testing_& for testing versions. In the &_exim4_&
520 subdirectory, the current release can always be found in files called
521 .display
522 &_exim-n.nn.tar.gz_&
523 &_exim-n.nn.tar.bz2_&
524 .endd
525 where &'n.nn'& is the highest such version number in the directory. The two
526 files contain identical data; the only difference is the type of compression.
527 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
528
529 .cindex "distribution" "signing details"
530 .cindex "distribution" "public key"
531 .cindex "public key for signed distribution"
532 The distributions will be PGP signed by an individual key of the Release
533 Coordinator.  This key will have a uid containing an email address in the
534 &'exim.org'& domain and will have signatures from other people, including
535 other Exim maintainers.  We expect that the key will be in the "strong set" of
536 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
537 PGP key, a version of which can be found in the release directory in the file
538 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
539 such as &'pool.sks-keyservers.net'&.
540
541 At time of last update, releases were being made by Phil Pennock and signed with
542 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
543 A trust path from Nigel's key to Phil's can be observed at
544 &url(https://www.security.spodhuis.org/exim-trustpath).
545
546 Releases have also been authorized to be performed by Todd Lyons who signs with
547 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
548 Pennock and Todd Lyons through a common associate.
549
550 The signatures for the tar bundles are in:
551 .display
552 &_exim-n.nn.tar.gz.asc_&
553 &_exim-n.nn.tar.bz2.asc_&
554 .endd
555 For each released version, the log of changes is made separately available in a
556 separate file in the directory &_ChangeLogs_& so that it is possible to
557 find out what has changed without having to download the entire distribution.
558
559 .cindex "documentation" "available formats"
560 The main distribution contains ASCII versions of this specification and other
561 documentation; other formats of the documents are available in separate files
562 inside the &_exim4_& directory of the FTP site:
563 .display
564 &_exim-html-n.nn.tar.gz_&
565 &_exim-pdf-n.nn.tar.gz_&
566 &_exim-postscript-n.nn.tar.gz_&
567 &_exim-texinfo-n.nn.tar.gz_&
568 .endd
569 These tar files contain only the &_doc_& directory, not the complete
570 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
571
572
573 .section "Limitations" "SECID6"
574 .ilist
575 .cindex "limitations of Exim"
576 .cindex "bang paths" "not handled by Exim"
577 Exim is designed for use as an Internet MTA, and therefore handles addresses in
578 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
579 simple two-component bang paths can be converted by a straightforward rewriting
580 configuration. This restriction does not prevent Exim from being interfaced to
581 UUCP as a transport mechanism, provided that domain addresses are used.
582 .next
583 .cindex "domainless addresses"
584 .cindex "address" "without domain"
585 Exim insists that every address it handles has a domain attached. For incoming
586 local messages, domainless addresses are automatically qualified with a
587 configured domain value. Configuration options specify from which remote
588 systems unqualified addresses are acceptable. These are then qualified on
589 arrival.
590 .next
591 .cindex "transport" "external"
592 .cindex "external transports"
593 The only external transport mechanisms that are currently implemented are SMTP
594 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
595 transport is available, and there are facilities for writing messages to files
596 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
597 to send messages to other transport mechanisms such as UUCP, provided they can
598 handle domain-style addresses. Batched SMTP input is also catered for.
599 .next
600 Exim is not designed for storing mail for dial-in hosts. When the volumes of
601 such mail are large, it is better to get the messages &"delivered"& into files
602 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
603 other means.
604 .next
605 Although Exim does have basic facilities for scanning incoming messages, these
606 are not comprehensive enough to do full virus or spam scanning. Such operations
607 are best carried out using additional specialized software packages. If you
608 compile Exim with the content-scanning extension, straightforward interfaces to
609 a number of common scanners are provided.
610 .endlist
611
612
613 .section "Run time configuration" "SECID7"
614 Exim's run time configuration is held in a single text file that is divided
615 into a number of sections. The entries in this file consist of keywords and
616 values, in the style of Smail 3 configuration files. A default configuration
617 file which is suitable for simple online installations is provided in the
618 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
619
620
621 .section "Calling interface" "SECID8"
622 .cindex "Sendmail compatibility" "command line interface"
623 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
624 can be a straight replacement for &_/usr/lib/sendmail_& or
625 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
626 about Sendmail in order to run Exim. For actions other than sending messages,
627 Sendmail-compatible options also exist, but those that produce output (for
628 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
629 format. There are also some additional options that are compatible with Smail
630 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
631 documents all Exim's command line options. This information is automatically
632 made into the man page that forms part of the Exim distribution.
633
634 Control of messages on the queue can be done via certain privileged command
635 line options. There is also an optional monitor program called &'eximon'&,
636 which displays current information in an X window, and which contains a menu
637 interface to Exim's command line administration options.
638
639
640
641 .section "Terminology" "SECID9"
642 .cindex "terminology definitions"
643 .cindex "body of message" "definition of"
644 The &'body'& of a message is the actual data that the sender wants to transmit.
645 It is the last part of a message, and is separated from the &'header'& (see
646 below) by a blank line.
647
648 .cindex "bounce message" "definition of"
649 When a message cannot be delivered, it is normally returned to the sender in a
650 delivery failure message or a &"non-delivery report"& (NDR). The term
651 &'bounce'& is commonly used for this action, and the error reports are often
652 called &'bounce messages'&. This is a convenient shorthand for &"delivery
653 failure error report"&. Such messages have an empty sender address in the
654 message's &'envelope'& (see below) to ensure that they cannot themselves give
655 rise to further bounce messages.
656
657 The term &'default'& appears frequently in this manual. It is used to qualify a
658 value which is used in the absence of any setting in the configuration. It may
659 also qualify an action which is taken unless a configuration setting specifies
660 otherwise.
661
662 The term &'defer'& is used when the delivery of a message to a specific
663 destination cannot immediately take place for some reason (a remote host may be
664 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
665 until a later time.
666
667 The word &'domain'& is sometimes used to mean all but the first component of a
668 host's name. It is &'not'& used in that sense here, where it normally refers to
669 the part of an email address following the @ sign.
670
671 .cindex "envelope, definition of"
672 .cindex "sender" "definition of"
673 A message in transit has an associated &'envelope'&, as well as a header and a
674 body. The envelope contains a sender address (to which bounce messages should
675 be delivered), and any number of recipient addresses. References to the
676 sender or the recipients of a message usually mean the addresses in the
677 envelope. An MTA uses these addresses for delivery, and for returning bounce
678 messages, not the addresses that appear in the header lines.
679
680 .cindex "message" "header, definition of"
681 .cindex "header section" "definition of"
682 The &'header'& of a message is the first part of a message's text, consisting
683 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
684 &'Subject:'&, etc. Long header lines can be split over several text lines by
685 indenting the continuations. The header is separated from the body by a blank
686 line.
687
688 .cindex "local part" "definition of"
689 .cindex "domain" "definition of"
690 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
691 part of an email address that precedes the @ sign. The part that follows the
692 @ sign is called the &'domain'& or &'mail domain'&.
693
694 .cindex "local delivery" "definition of"
695 .cindex "remote delivery, definition of"
696 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
697 delivery to a file or a pipe on the local host from delivery by SMTP over
698 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
699 host it is running on are &'remote'&.
700
701 .cindex "return path" "definition of"
702 &'Return path'& is another name that is used for the sender address in a
703 message's envelope.
704
705 .cindex "queue" "definition of"
706 The term &'queue'& is used to refer to the set of messages awaiting delivery,
707 because this term is in widespread use in the context of MTAs. However, in
708 Exim's case the reality is more like a pool than a queue, because there is
709 normally no ordering of waiting messages.
710
711 .cindex "queue runner" "definition of"
712 The term &'queue runner'& is used to describe a process that scans the queue
713 and attempts to deliver those messages whose retry times have come. This term
714 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
715 the waiting messages are normally processed in an unpredictable order.
716
717 .cindex "spool directory" "definition of"
718 The term &'spool directory'& is used for a directory in which Exim keeps the
719 messages on its queue &-- that is, those that it is in the process of
720 delivering. This should not be confused with the directory in which local
721 mailboxes are stored, which is called a &"spool directory"& by some people. In
722 the Exim documentation, &"spool"& is always used in the first sense.
723
724
725
726
727
728
729 . ////////////////////////////////////////////////////////////////////////////
730 . ////////////////////////////////////////////////////////////////////////////
731
732 .chapter "Incorporated code" "CHID2"
733 .cindex "incorporated code"
734 .cindex "regular expressions" "library"
735 .cindex "PCRE"
736 .cindex "OpenDMARC"
737 A number of pieces of external code are included in the Exim distribution.
738
739 .ilist
740 Regular expressions are supported in the main Exim program and in the
741 Exim monitor using the freely-distributable PCRE library, copyright
742 &copy; University of Cambridge. The source to PCRE is no longer shipped with
743 Exim, so you will need to use the version of PCRE shipped with your system,
744 or obtain and install the full version of the library from
745 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
746 .next
747 .cindex "cdb" "acknowledgment"
748 Support for the cdb (Constant DataBase) lookup method is provided by code
749 contributed by Nigel Metheringham of (at the time he contributed it) Planet
750 Online Ltd. The implementation is completely contained within the code of Exim.
751 It does not link against an external cdb library. The code contains the
752 following statements:
753
754 .blockquote
755 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
756
757 This program is free software; you can redistribute it and/or modify it under
758 the terms of the GNU General Public License as published by the Free Software
759 Foundation; either version 2 of the License, or (at your option) any later
760 version.
761 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
762 the spec and sample code for cdb can be obtained from
763 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
764 some code from Dan Bernstein's implementation (which has no license
765 restrictions applied to it).
766 .endblockquote
767 .next
768 .cindex "SPA authentication"
769 .cindex "Samba project"
770 .cindex "Microsoft Secure Password Authentication"
771 Client support for Microsoft's &'Secure Password Authentication'& is provided
772 by code contributed by Marc Prud'hommeaux. Server support was contributed by
773 Tom Kistner. This includes code taken from the Samba project, which is released
774 under the Gnu GPL.
775 .next
776 .cindex "Cyrus"
777 .cindex "&'pwcheck'& daemon"
778 .cindex "&'pwauthd'& daemon"
779 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
780 by code taken from the Cyrus-SASL library and adapted by Alexander S.
781 Sabourenkov. The permission notice appears below, in accordance with the
782 conditions expressed therein.
783
784 .blockquote
785 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
786
787 Redistribution and use in source and binary forms, with or without
788 modification, are permitted provided that the following conditions
789 are met:
790
791 .olist
792 Redistributions of source code must retain the above copyright
793 notice, this list of conditions and the following disclaimer.
794 .next
795 Redistributions in binary form must reproduce the above copyright
796 notice, this list of conditions and the following disclaimer in
797 the documentation and/or other materials provided with the
798 distribution.
799 .next
800 The name &"Carnegie Mellon University"& must not be used to
801 endorse or promote products derived from this software without
802 prior written permission. For permission or any other legal
803 details, please contact
804 .display
805               Office of Technology Transfer
806               Carnegie Mellon University
807               5000 Forbes Avenue
808               Pittsburgh, PA  15213-3890
809               (412) 268-4387, fax: (412) 268-7395
810               tech-transfer@andrew.cmu.edu
811 .endd
812 .next
813 Redistributions of any form whatsoever must retain the following
814 acknowledgment:
815
816 &"This product includes software developed by Computing Services
817 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
818
819 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
820 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
821 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
822 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
823 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
824 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
825 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
826 .endlist
827 .endblockquote
828
829 .next
830 .cindex "Exim monitor" "acknowledgment"
831 .cindex "X-windows"
832 .cindex "Athena"
833 The Exim Monitor program, which is an X-Window application, includes
834 modified versions of the Athena StripChart and TextPop widgets.
835 This code is copyright by DEC and MIT, and their permission notice appears
836 below, in accordance with the conditions expressed therein.
837
838 .blockquote
839 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
840 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
841
842 All Rights Reserved
843
844 Permission to use, copy, modify, and distribute this software and its
845 documentation for any purpose and without fee is hereby granted,
846 provided that the above copyright notice appear in all copies and that
847 both that copyright notice and this permission notice appear in
848 supporting documentation, and that the names of Digital or MIT not be
849 used in advertising or publicity pertaining to distribution of the
850 software without specific, written prior permission.
851
852 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
853 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
854 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
855 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
856 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
857 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
858 SOFTWARE.
859 .endblockquote
860
861 .next
862 .cindex "opendmarc" "acknowledgment"
863 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
864 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
865 derived code are indicated in the respective source files. The full OpenDMARC
866 license is provided in the LICENSE.opendmarc file contained in the distributed
867 source code.
868
869 .next
870 Many people have contributed code fragments, some large, some small, that were
871 not covered by any specific licence requirements. It is assumed that the
872 contributors are happy to see their code incorporated into Exim under the GPL.
873 .endlist
874
875
876
877
878
879 . ////////////////////////////////////////////////////////////////////////////
880 . ////////////////////////////////////////////////////////////////////////////
881
882 .chapter "How Exim receives and delivers mail" "CHID11" &&&
883          "Receiving and delivering mail"
884
885
886 .section "Overall philosophy" "SECID10"
887 .cindex "design philosophy"
888 Exim is designed to work efficiently on systems that are permanently connected
889 to the Internet and are handling a general mix of mail. In such circumstances,
890 most messages can be delivered immediately. Consequently, Exim does not
891 maintain independent queues of messages for specific domains or hosts, though
892 it does try to send several messages in a single SMTP connection after a host
893 has been down, and it also maintains per-host retry information.
894
895
896 .section "Policy control" "SECID11"
897 .cindex "policy control" "overview"
898 Policy controls are now an important feature of MTAs that are connected to the
899 Internet. Perhaps their most important job is to stop MTAs being abused as
900 &"open relays"& by misguided individuals who send out vast amounts of
901 unsolicited junk, and want to disguise its source. Exim provides flexible
902 facilities for specifying policy controls on incoming mail:
903
904 .ilist
905 .cindex "&ACL;" "introduction"
906 Exim 4 (unlike previous versions of Exim) implements policy controls on
907 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
908 series of statements that may either grant or deny access. ACLs can be used at
909 several places in the SMTP dialogue while receiving a message from a remote
910 host. However, the most common places are after each RCPT command, and at the
911 very end of the message. The sysadmin can specify conditions for accepting or
912 rejecting individual recipients or the entire message, respectively, at these
913 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
914 error code.
915 .next
916 An ACL is also available for locally generated, non-SMTP messages. In this
917 case, the only available actions are to accept or deny the entire message.
918 .next
919 When Exim is compiled with the content-scanning extension, facilities are
920 provided in the ACL mechanism for passing the message to external virus and/or
921 spam scanning software. The result of such a scan is passed back to the ACL,
922 which can then use it to decide what to do with the message.
923 .next
924 When a message has been received, either from a remote host or from the local
925 host, but before the final acknowledgment has been sent, a locally supplied C
926 function called &[local_scan()]& can be run to inspect the message and decide
927 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
928 is accepted, the list of recipients can be modified by the function.
929 .next
930 Using the &[local_scan()]& mechanism is another way of calling external scanner
931 software. The &%SA-Exim%& add-on package works this way. It does not require
932 Exim to be compiled with the content-scanning extension.
933 .next
934 After a message has been accepted, a further checking mechanism is available in
935 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
936 runs at the start of every delivery process.
937 .endlist
938
939
940
941 .section "User filters" "SECID12"
942 .cindex "filter" "introduction"
943 .cindex "Sieve filter"
944 In a conventional Exim configuration, users are able to run private filters by
945 setting up appropriate &_.forward_& files in their home directories. See
946 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
947 configuration needed to support this, and the separate document entitled
948 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
949 of filtering are available:
950
951 .ilist
952 Sieve filters are written in the standard filtering language that is defined
953 by RFC 3028.
954 .next
955 Exim filters are written in a syntax that is unique to Exim, but which is more
956 powerful than Sieve, which it pre-dates.
957 .endlist
958
959 User filters are run as part of the routing process, described below.
960
961
962
963 .section "Message identification" "SECTmessiden"
964 .cindex "message ids" "details of format"
965 .cindex "format" "of message id"
966 .cindex "id of message"
967 .cindex "base62"
968 .cindex "base36"
969 .cindex "Darwin"
970 .cindex "Cygwin"
971 Every message handled by Exim is given a &'message id'& which is sixteen
972 characters long. It is divided into three parts, separated by hyphens, for
973 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
974 normally encoding numbers in base 62. However, in the Darwin operating
975 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
976 (avoiding the use of lower case letters) is used instead, because the message
977 id is used to construct file names, and the names of files in those systems are
978 not always case-sensitive.
979
980 .cindex "pid (process id)" "re-use of"
981 The detail of the contents of the message id have changed as Exim has evolved.
982 Earlier versions relied on the operating system not re-using a process id (pid)
983 within one second. On modern operating systems, this assumption can no longer
984 be made, so the algorithm had to be changed. To retain backward compatibility,
985 the format of the message id was retained, which is why the following rules are
986 somewhat eccentric:
987
988 .ilist
989 The first six characters of the message id are the time at which the message
990 started to be received, to a granularity of one second. That is, this field
991 contains the number of seconds since the start of the epoch (the normal Unix
992 way of representing the date and time of day).
993 .next
994 After the first hyphen, the next six characters are the id of the process that
995 received the message.
996 .next
997 There are two different possibilities for the final two characters:
998 .olist
999 .oindex "&%localhost_number%&"
1000 If &%localhost_number%& is not set, this value is the fractional part of the
1001 time of reception, normally in units of 1/2000 of a second, but for systems
1002 that must use base 36 instead of base 62 (because of case-insensitive file
1003 systems), the units are 1/1000 of a second.
1004 .next
1005 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1006 the fractional part of the time, which in this case is in units of 1/200
1007 (1/100) of a second.
1008 .endlist
1009 .endlist
1010
1011 After a message has been received, Exim waits for the clock to tick at the
1012 appropriate resolution before proceeding, so that if another message is
1013 received by the same process, or by another process with the same (re-used)
1014 pid, it is guaranteed that the time will be different. In most cases, the clock
1015 will already have ticked while the message was being received.
1016
1017
1018 .section "Receiving mail" "SECID13"
1019 .cindex "receiving mail"
1020 .cindex "message" "reception"
1021 The only way Exim can receive mail from another host is using SMTP over
1022 TCP/IP, in which case the sender and recipient addresses are transferred using
1023 SMTP commands. However, from a locally running process (such as a user's MUA),
1024 there are several possibilities:
1025
1026 .ilist
1027 If the process runs Exim with the &%-bm%& option, the message is read
1028 non-interactively (usually via a pipe), with the recipients taken from the
1029 command line, or from the body of the message if &%-t%& is also used.
1030 .next
1031 If the process runs Exim with the &%-bS%& option, the message is also read
1032 non-interactively, but in this case the recipients are listed at the start of
1033 the message in a series of SMTP RCPT commands, terminated by a DATA
1034 command. This is so-called &"batch SMTP"& format,
1035 but it isn't really SMTP. The SMTP commands are just another way of passing
1036 envelope addresses in a non-interactive submission.
1037 .next
1038 If the process runs Exim with the &%-bs%& option, the message is read
1039 interactively, using the SMTP protocol. A two-way pipe is normally used for
1040 passing data between the local process and the Exim process.
1041 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1042 example, the ACLs for SMTP commands are used for this form of submission.
1043 .next
1044 A local process may also make a TCP/IP call to the host's loopback address
1045 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1046 does not treat the loopback address specially. It treats all such connections
1047 in the same way as connections from other hosts.
1048 .endlist
1049
1050
1051 .cindex "message sender, constructed by Exim"
1052 .cindex "sender" "constructed by Exim"
1053 In the three cases that do not involve TCP/IP, the sender address is
1054 constructed from the login name of the user that called Exim and a default
1055 qualification domain (which can be set by the &%qualify_domain%& configuration
1056 option). For local or batch SMTP, a sender address that is passed using the
1057 SMTP MAIL command is ignored. However, the system administrator may allow
1058 certain users (&"trusted users"&) to specify a different sender address
1059 unconditionally, or all users to specify certain forms of different sender
1060 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1061 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1062 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1063 users to change sender addresses.
1064
1065 Messages received by either of the non-interactive mechanisms are subject to
1066 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1067 (either over TCP/IP, or interacting with a local process) can be checked by a
1068 number of ACLs that operate at different times during the SMTP session. Either
1069 individual recipients, or the entire message, can be rejected if local policy
1070 requirements are not met. The &[local_scan()]& function (see chapter
1071 &<<CHAPlocalscan>>&) is run for all incoming messages.
1072
1073 Exim can be configured not to start a delivery process when a message is
1074 received; this can be unconditional, or depend on the number of incoming SMTP
1075 connections or the system load. In these situations, new messages wait on the
1076 queue until a queue runner process picks them up. However, in standard
1077 configurations under normal conditions, delivery is started as soon as a
1078 message is received.
1079
1080
1081
1082
1083
1084 .section "Handling an incoming message" "SECID14"
1085 .cindex "spool directory" "files that hold a message"
1086 .cindex "file" "how a message is held"
1087 When Exim accepts a message, it writes two files in its spool directory. The
1088 first contains the envelope information, the current status of the message, and
1089 the header lines, and the second contains the body of the message. The names of
1090 the two spool files consist of the message id, followed by &`-H`& for the
1091 file containing the envelope and header, and &`-D`& for the data file.
1092
1093 .cindex "spool directory" "&_input_& sub-directory"
1094 By default all these message files are held in a single directory called
1095 &_input_& inside the general Exim spool directory. Some operating systems do
1096 not perform very well if the number of files in a directory gets large; to
1097 improve performance in such cases, the &%split_spool_directory%& option can be
1098 used. This causes Exim to split up the input files into 62 sub-directories
1099 whose names are single letters or digits. When this is done, the queue is
1100 processed one sub-directory at a time instead of all at once, which can improve
1101 overall performance even when there are not enough files in each directory to
1102 affect file system performance.
1103
1104 The envelope information consists of the address of the message's sender and
1105 the addresses of the recipients. This information is entirely separate from
1106 any addresses contained in the header lines. The status of the message includes
1107 a list of recipients who have already received the message. The format of the
1108 first spool file is described in chapter &<<CHAPspool>>&.
1109
1110 .cindex "rewriting" "addresses"
1111 Address rewriting that is specified in the rewrite section of the configuration
1112 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1113 both in the header lines and the envelope, at the time the message is accepted.
1114 If during the course of delivery additional addresses are generated (for
1115 example, via aliasing), these new addresses are rewritten as soon as they are
1116 generated. At the time a message is actually delivered (transported) further
1117 rewriting can take place; because this is a transport option, it can be
1118 different for different forms of delivery. It is also possible to specify the
1119 addition or removal of certain header lines at the time the message is
1120 delivered (see chapters &<<CHAProutergeneric>>& and
1121 &<<CHAPtransportgeneric>>&).
1122
1123
1124
1125 .section "Life of a message" "SECID15"
1126 .cindex "message" "life of"
1127 .cindex "message" "frozen"
1128 A message remains in the spool directory until it is completely delivered to
1129 its recipients or to an error address, or until it is deleted by an
1130 administrator or by the user who originally created it. In cases when delivery
1131 cannot proceed &-- for example, when a message can neither be delivered to its
1132 recipients nor returned to its sender, the message is marked &"frozen"& on the
1133 spool, and no more deliveries are attempted.
1134
1135 .cindex "frozen messages" "thawing"
1136 .cindex "message" "thawing frozen"
1137 An administrator can &"thaw"& such messages when the problem has been
1138 corrected, and can also freeze individual messages by hand if necessary. In
1139 addition, an administrator can force a delivery error, causing a bounce message
1140 to be sent.
1141
1142 .oindex "&%timeout_frozen_after%&"
1143 .oindex "&%ignore_bounce_errors_after%&"
1144 There are options called &%ignore_bounce_errors_after%& and
1145 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1146 The first applies only to frozen bounces, the second to any frozen messages.
1147
1148 .cindex "message" "log file for"
1149 .cindex "log" "file for each message"
1150 While Exim is working on a message, it writes information about each delivery
1151 attempt to its main log file. This includes successful, unsuccessful, and
1152 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1153 lines are also written to a separate &'message log'& file for each message.
1154 These logs are solely for the benefit of the administrator, and are normally
1155 deleted along with the spool files when processing of a message is complete.
1156 The use of individual message logs can be disabled by setting
1157 &%no_message_logs%&; this might give an improvement in performance on very busy
1158 systems.
1159
1160 .cindex "journal file"
1161 .cindex "file" "journal"
1162 All the information Exim itself needs to set up a delivery is kept in the first
1163 spool file, along with the header lines. When a successful delivery occurs, the
1164 address is immediately written at the end of a journal file, whose name is the
1165 message id followed by &`-J`&. At the end of a delivery run, if there are some
1166 addresses left to be tried again later, the first spool file (the &`-H`& file)
1167 is updated to indicate which these are, and the journal file is then deleted.
1168 Updating the spool file is done by writing a new file and renaming it, to
1169 minimize the possibility of data loss.
1170
1171 Should the system or the program crash after a successful delivery but before
1172 the spool file has been updated, the journal is left lying around. The next
1173 time Exim attempts to deliver the message, it reads the journal file and
1174 updates the spool file before proceeding. This minimizes the chances of double
1175 deliveries caused by crashes.
1176
1177
1178
1179 .section "Processing an address for delivery" "SECTprocaddress"
1180 .cindex "drivers" "definition of"
1181 .cindex "router" "definition of"
1182 .cindex "transport" "definition of"
1183 The main delivery processing elements of Exim are called &'routers'& and
1184 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1185 number of them is provided in the source distribution, and compile-time options
1186 specify which ones are included in the binary. Run time options specify which
1187 ones are actually used for delivering messages.
1188
1189 .cindex "drivers" "instance definition"
1190 Each driver that is specified in the run time configuration is an &'instance'&
1191 of that particular driver type. Multiple instances are allowed; for example,
1192 you can set up several different &(smtp)& transports, each with different
1193 option values that might specify different ports or different timeouts. Each
1194 instance has its own identifying name. In what follows we will normally use the
1195 instance name when discussing one particular instance (that is, one specific
1196 configuration of the driver), and the generic driver name when discussing
1197 the driver's features in general.
1198
1199 A &'router'& is a driver that operates on an address, either determining how
1200 its delivery should happen, by assigning it to a specific transport, or
1201 converting the address into one or more new addresses (for example, via an
1202 alias file). A router may also explicitly choose to fail an address, causing it
1203 to be bounced.
1204
1205 A &'transport'& is a driver that transmits a copy of the message from Exim's
1206 spool to some destination. There are two kinds of transport: for a &'local'&
1207 transport, the destination is a file or a pipe on the local host, whereas for a
1208 &'remote'& transport the destination is some other host. A message is passed
1209 to a specific transport as a result of successful routing. If a message has
1210 several recipients, it may be passed to a number of different transports.
1211
1212 .cindex "preconditions" "definition of"
1213 An address is processed by passing it to each configured router instance in
1214 turn, subject to certain preconditions, until a router accepts the address or
1215 specifies that it should be bounced. We will describe this process in more
1216 detail shortly. First, as a simple example, we consider how each recipient
1217 address in a message is processed in a small configuration of three routers.
1218
1219 To make this a more concrete example, it is described in terms of some actual
1220 routers, but remember, this is only an example. You can configure Exim's
1221 routers in many different ways, and there may be any number of routers in a
1222 configuration.
1223
1224 The first router that is specified in a configuration is often one that handles
1225 addresses in domains that are not recognized specially by the local host. These
1226 are typically addresses for arbitrary domains on the Internet. A precondition
1227 is set up which looks for the special domains known to the host (for example,
1228 its own domain name), and the router is run for addresses that do &'not'&
1229 match. Typically, this is a router that looks up domains in the DNS in order to
1230 find the hosts to which this address routes. If it succeeds, the address is
1231 assigned to a suitable SMTP transport; if it does not succeed, the router is
1232 configured to fail the address.
1233
1234 The second router is reached only when the domain is recognized as one that
1235 &"belongs"& to the local host. This router does redirection &-- also known as
1236 aliasing and forwarding. When it generates one or more new addresses from the
1237 original, each of them is routed independently from the start. Otherwise, the
1238 router may cause an address to fail, or it may simply decline to handle the
1239 address, in which case the address is passed to the next router.
1240
1241 The final router in many configurations is one that checks to see if the
1242 address belongs to a local mailbox. The precondition may involve a check to
1243 see if the local part is the name of a login account, or it may look up the
1244 local part in a file or a database. If its preconditions are not met, or if
1245 the router declines, we have reached the end of the routers. When this happens,
1246 the address is bounced.
1247
1248
1249
1250 .section "Processing an address for verification" "SECID16"
1251 .cindex "router" "for verification"
1252 .cindex "verifying address" "overview"
1253 As well as being used to decide how to deliver to an address, Exim's routers
1254 are also used for &'address verification'&. Verification can be requested as
1255 one of the checks to be performed in an ACL for incoming messages, on both
1256 sender and recipient addresses, and it can be tested using the &%-bv%& and
1257 &%-bvs%& command line options.
1258
1259 When an address is being verified, the routers are run in &"verify mode"&. This
1260 does not affect the way the routers work, but it is a state that can be
1261 detected. By this means, a router can be skipped or made to behave differently
1262 when verifying. A common example is a configuration in which the first router
1263 sends all messages to a message-scanning program, unless they have been
1264 previously scanned. Thus, the first router accepts all addresses without any
1265 checking, making it useless for verifying. Normally, the &%no_verify%& option
1266 would be set for such a router, causing it to be skipped in verify mode.
1267
1268
1269
1270
1271 .section "Running an individual router" "SECTrunindrou"
1272 .cindex "router" "running details"
1273 .cindex "preconditions" "checking"
1274 .cindex "router" "result of running"
1275 As explained in the example above, a number of preconditions are checked before
1276 running a router. If any are not met, the router is skipped, and the address is
1277 passed to the next router. When all the preconditions on a router &'are'& met,
1278 the router is run. What happens next depends on the outcome, which is one of
1279 the following:
1280
1281 .ilist
1282 &'accept'&: The router accepts the address, and either assigns it to a
1283 transport, or generates one or more &"child"& addresses. Processing the
1284 original address ceases,
1285 .oindex "&%unseen%&"
1286 unless the &%unseen%& option is set on the router. This option
1287 can be used to set up multiple deliveries with different routing (for example,
1288 for keeping archive copies of messages). When &%unseen%& is set, the address is
1289 passed to the next router. Normally, however, an &'accept'& return marks the
1290 end of routing.
1291
1292 Any child addresses generated by the router are processed independently,
1293 starting with the first router by default. It is possible to change this by
1294 setting the &%redirect_router%& option to specify which router to start at for
1295 child addresses. Unlike &%pass_router%& (see below) the router specified by
1296 &%redirect_router%& may be anywhere in the router configuration.
1297 .next
1298 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1299 requests that the address be passed to another router. By default the address
1300 is passed to the next router, but this can be changed by setting the
1301 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1302 must be below the current router (to avoid loops).
1303 .next
1304 &'decline'&: The router declines to accept the address because it does not
1305 recognize it at all. By default, the address is passed to the next router, but
1306 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1307 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1308 &'decline'& into &'fail'&.
1309 .next
1310 &'fail'&: The router determines that the address should fail, and queues it for
1311 the generation of a bounce message. There is no further processing of the
1312 original address unless &%unseen%& is set on the router.
1313 .next
1314 &'defer'&: The router cannot handle the address at the present time. (A
1315 database may be offline, or a DNS lookup may have timed out.) No further
1316 processing of the address happens in this delivery attempt. It is tried again
1317 next time the message is considered for delivery.
1318 .next
1319 &'error'&: There is some error in the router (for example, a syntax error in
1320 its configuration). The action is as for defer.
1321 .endlist
1322
1323 If an address reaches the end of the routers without having been accepted by
1324 any of them, it is bounced as unrouteable. The default error message in this
1325 situation is &"unrouteable address"&, but you can set your own message by
1326 making use of the &%cannot_route_message%& option. This can be set for any
1327 router; the value from the last router that &"saw"& the address is used.
1328
1329 Sometimes while routing you want to fail a delivery when some conditions are
1330 met but others are not, instead of passing the address on for further routing.
1331 You can do this by having a second router that explicitly fails the delivery
1332 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1333 facility for this purpose.
1334
1335
1336 .section "Duplicate addresses" "SECID17"
1337 .cindex "case of local parts"
1338 .cindex "address duplicate, discarding"
1339 .cindex "duplicate addresses"
1340 Once routing is complete, Exim scans the addresses that are assigned to local
1341 and remote transports, and discards any duplicates that it finds. During this
1342 check, local parts are treated as case-sensitive. This happens only when
1343 actually delivering a message; when testing routers with &%-bt%&, all the
1344 routed addresses are shown.
1345
1346
1347
1348 .section "Router preconditions" "SECTrouprecon"
1349 .cindex "router" "preconditions, order of processing"
1350 .cindex "preconditions" "order of processing"
1351 The preconditions that are tested for each router are listed below, in the
1352 order in which they are tested. The individual configuration options are
1353 described in more detail in chapter &<<CHAProutergeneric>>&.
1354
1355 .ilist
1356 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1357 the local parts handled by the router may or must have certain prefixes and/or
1358 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1359 skipped. These conditions are tested first. When an affix is present, it is
1360 removed from the local part before further processing, including the evaluation
1361 of any other conditions.
1362 .next
1363 Routers can be designated for use only when not verifying an address, that is,
1364 only when routing it for delivery (or testing its delivery routing). If the
1365 &%verify%& option is set false, the router is skipped when Exim is verifying an
1366 address.
1367 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1368 &%verify_recipient%&, which independently control the use of the router for
1369 sender and recipient verification. You can set these options directly if
1370 you want a router to be used for only one type of verification.
1371 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1372 .next
1373 If the &%address_test%& option is set false, the router is skipped when Exim is
1374 run with the &%-bt%& option to test an address routing. This can be helpful
1375 when the first router sends all new messages to a scanner of some sort; it
1376 makes it possible to use &%-bt%& to test subsequent delivery routing without
1377 having to simulate the effect of the scanner.
1378 .next
1379 Routers can be designated for use only when verifying an address, as
1380 opposed to routing it for delivery. The &%verify_only%& option controls this.
1381 Again, cutthrough delivery counts as a verification.
1382 .next
1383 Individual routers can be explicitly skipped when running the routers to
1384 check an address given in the SMTP EXPN command (see the &%expn%& option).
1385 .next
1386 If the &%domains%& option is set, the domain of the address must be in the set
1387 of domains that it defines.
1388 .next
1389 .vindex "&$local_part_prefix$&"
1390 .vindex "&$local_part$&"
1391 .vindex "&$local_part_suffix$&"
1392 If the &%local_parts%& option is set, the local part of the address must be in
1393 the set of local parts that it defines. If &%local_part_prefix%& or
1394 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1395 part before this check. If you want to do precondition tests on local parts
1396 that include affixes, you can do so by using a &%condition%& option (see below)
1397 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1398 &$local_part_suffix$& as necessary.
1399 .next
1400 .vindex "&$local_user_uid$&"
1401 .vindex "&$local_user_gid$&"
1402 .vindex "&$home$&"
1403 If the &%check_local_user%& option is set, the local part must be the name of
1404 an account on the local host. If this check succeeds, the uid and gid of the
1405 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1406 user's home directory is placed in &$home$&; these values can be used in the
1407 remaining preconditions.
1408 .next
1409 If the &%router_home_directory%& option is set, it is expanded at this point,
1410 because it overrides the value of &$home$&. If this expansion were left till
1411 later, the value of &$home$& as set by &%check_local_user%& would be used in
1412 subsequent tests. Having two different values of &$home$& in the same router
1413 could lead to confusion.
1414 .next
1415 If the &%senders%& option is set, the envelope sender address must be in the
1416 set of addresses that it defines.
1417 .next
1418 If the &%require_files%& option is set, the existence or non-existence of
1419 specified files is tested.
1420 .next
1421 .cindex "customizing" "precondition"
1422 If the &%condition%& option is set, it is evaluated and tested. This option
1423 uses an expanded string to allow you to set up your own custom preconditions.
1424 Expanded strings are described in chapter &<<CHAPexpand>>&.
1425 .endlist
1426
1427
1428 Note that &%require_files%& comes near the end of the list, so you cannot use
1429 it to check for the existence of a file in which to lookup up a domain, local
1430 part, or sender. However, as these options are all expanded, you can use the
1431 &%exists%& expansion condition to make such tests within each condition. The
1432 &%require_files%& option is intended for checking files that the router may be
1433 going to use internally, or which are needed by a specific transport (for
1434 example, &_.procmailrc_&).
1435
1436
1437
1438 .section "Delivery in detail" "SECID18"
1439 .cindex "delivery" "in detail"
1440 When a message is to be delivered, the sequence of events is as follows:
1441
1442 .ilist
1443 If a system-wide filter file is specified, the message is passed to it. The
1444 filter may add recipients to the message, replace the recipients, discard the
1445 message, cause a new message to be generated, or cause the message delivery to
1446 fail. The format of the system filter file is the same as for Exim user filter
1447 files, described in the separate document entitled &'Exim's interfaces to mail
1448 filtering'&.
1449 .cindex "Sieve filter" "not available for system filter"
1450 (&*Note*&: Sieve cannot be used for system filter files.)
1451
1452 Some additional features are available in system filters &-- see chapter
1453 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1454 filter only once per delivery attempt, however many recipients it has. However,
1455 if there are several delivery attempts because one or more addresses could not
1456 be immediately delivered, the system filter is run each time. The filter
1457 condition &%first_delivery%& can be used to detect the first run of the system
1458 filter.
1459 .next
1460 Each recipient address is offered to each configured router in turn, subject to
1461 its preconditions, until one is able to handle it. If no router can handle the
1462 address, that is, if they all decline, the address is failed. Because routers
1463 can be targeted at particular domains, several locally handled domains can be
1464 processed entirely independently of each other.
1465 .next
1466 .cindex "routing" "loops in"
1467 .cindex "loop" "while routing"
1468 A router that accepts an address may assign it to a local or a remote
1469 transport. However, the transport is not run at this time. Instead, the address
1470 is placed on a list for the particular transport, which will be run later.
1471 Alternatively, the router may generate one or more new addresses (typically
1472 from alias, forward, or filter files). New addresses are fed back into this
1473 process from the top, but in order to avoid loops, a router ignores any address
1474 which has an identically-named ancestor that was processed by itself.
1475 .next
1476 When all the routing has been done, addresses that have been successfully
1477 handled are passed to their assigned transports. When local transports are
1478 doing real local deliveries, they handle only one address at a time, but if a
1479 local transport is being used as a pseudo-remote transport (for example, to
1480 collect batched SMTP messages for transmission by some other means) multiple
1481 addresses can be handled. Remote transports can always handle more than one
1482 address at a time, but can be configured not to do so, or to restrict multiple
1483 addresses to the same domain.
1484 .next
1485 Each local delivery to a file or a pipe runs in a separate process under a
1486 non-privileged uid, and these deliveries are run one at a time. Remote
1487 deliveries also run in separate processes, normally under a uid that is private
1488 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1489 run in parallel. The maximum number of simultaneous remote deliveries for any
1490 one message is set by the &%remote_max_parallel%& option.
1491 The order in which deliveries are done is not defined, except that all local
1492 deliveries happen before any remote deliveries.
1493 .next
1494 .cindex "queue runner"
1495 When it encounters a local delivery during a queue run, Exim checks its retry
1496 database to see if there has been a previous temporary delivery failure for the
1497 address before running the local transport. If there was a previous failure,
1498 Exim does not attempt a new delivery until the retry time for the address is
1499 reached. However, this happens only for delivery attempts that are part of a
1500 queue run. Local deliveries are always attempted when delivery immediately
1501 follows message reception, even if retry times are set for them. This makes for
1502 better behaviour if one particular message is causing problems (for example,
1503 causing quota overflow, or provoking an error in a filter file).
1504 .next
1505 .cindex "delivery" "retry in remote transports"
1506 Remote transports do their own retry handling, since an address may be
1507 deliverable to one of a number of hosts, each of which may have a different
1508 retry time. If there have been previous temporary failures and no host has
1509 reached its retry time, no delivery is attempted, whether in a queue run or
1510 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1511 .next
1512 If there were any permanent errors, a bounce message is returned to an
1513 appropriate address (the sender in the common case), with details of the error
1514 for each failing address. Exim can be configured to send copies of bounce
1515 messages to other addresses.
1516 .next
1517 .cindex "delivery" "deferral"
1518 If one or more addresses suffered a temporary failure, the message is left on
1519 the queue, to be tried again later. Delivery of these addresses is said to be
1520 &'deferred'&.
1521 .next
1522 When all the recipient addresses have either been delivered or bounced,
1523 handling of the message is complete. The spool files and message log are
1524 deleted, though the message log can optionally be preserved if required.
1525 .endlist
1526
1527
1528
1529
1530 .section "Retry mechanism" "SECID19"
1531 .cindex "delivery" "retry mechanism"
1532 .cindex "retry" "description of mechanism"
1533 .cindex "queue runner"
1534 Exim's mechanism for retrying messages that fail to get delivered at the first
1535 attempt is the queue runner process. You must either run an Exim daemon that
1536 uses the &%-q%& option with a time interval to start queue runners at regular
1537 intervals, or use some other means (such as &'cron'&) to start them. If you do
1538 not arrange for queue runners to be run, messages that fail temporarily at the
1539 first attempt will remain on your queue for ever. A queue runner process works
1540 its way through the queue, one message at a time, trying each delivery that has
1541 passed its retry time.
1542 You can run several queue runners at once.
1543
1544 Exim uses a set of configured rules to determine when next to retry the failing
1545 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1546 should give up trying to deliver to the address, at which point it generates a
1547 bounce message. If no retry rules are set for a particular host, address, and
1548 error combination, no retries are attempted, and temporary errors are treated
1549 as permanent.
1550
1551
1552
1553 .section "Temporary delivery failure" "SECID20"
1554 .cindex "delivery" "temporary failure"
1555 There are many reasons why a message may not be immediately deliverable to a
1556 particular address. Failure to connect to a remote machine (because it, or the
1557 connection to it, is down) is one of the most common. Temporary failures may be
1558 detected during routing as well as during the transport stage of delivery.
1559 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1560 is on a file system where the user is over quota. Exim can be configured to
1561 impose its own quotas on local mailboxes; where system quotas are set they will
1562 also apply.
1563
1564 If a host is unreachable for a period of time, a number of messages may be
1565 waiting for it by the time it recovers, and sending them in a single SMTP
1566 connection is clearly beneficial. Whenever a delivery to a remote host is
1567 deferred,
1568 .cindex "hints database" "deferred deliveries"
1569 Exim makes a note in its hints database, and whenever a successful
1570 SMTP delivery has happened, it looks to see if any other messages are waiting
1571 for the same host. If any are found, they are sent over the same SMTP
1572 connection, subject to a configuration limit as to the maximum number in any
1573 one connection.
1574
1575
1576
1577 .section "Permanent delivery failure" "SECID21"
1578 .cindex "delivery" "permanent failure"
1579 .cindex "bounce message" "when generated"
1580 When a message cannot be delivered to some or all of its intended recipients, a
1581 bounce message is generated. Temporary delivery failures turn into permanent
1582 errors when their timeout expires. All the addresses that fail in a given
1583 delivery attempt are listed in a single message. If the original message has
1584 many recipients, it is possible for some addresses to fail in one delivery
1585 attempt and others to fail subsequently, giving rise to more than one bounce
1586 message. The wording of bounce messages can be customized by the administrator.
1587 See chapter &<<CHAPemsgcust>>& for details.
1588
1589 .cindex "&'X-Failed-Recipients:'& header line"
1590 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1591 failed addresses, for the benefit of programs that try to analyse such messages
1592 automatically.
1593
1594 .cindex "bounce message" "recipient of"
1595 A bounce message is normally sent to the sender of the original message, as
1596 obtained from the message's envelope. For incoming SMTP messages, this is the
1597 address given in the MAIL command. However, when an address is expanded via a
1598 forward or alias file, an alternative address can be specified for delivery
1599 failures of the generated addresses. For a mailing list expansion (see section
1600 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1601 of the list.
1602
1603
1604
1605 .section "Failures to deliver bounce messages" "SECID22"
1606 .cindex "bounce message" "failure to deliver"
1607 If a bounce message (either locally generated or received from a remote host)
1608 itself suffers a permanent delivery failure, the message is left on the queue,
1609 but it is frozen, awaiting the attention of an administrator. There are options
1610 that can be used to make Exim discard such failed messages, or to keep them
1611 for only a short time (see &%timeout_frozen_after%& and
1612 &%ignore_bounce_errors_after%&).
1613
1614
1615
1616
1617
1618 . ////////////////////////////////////////////////////////////////////////////
1619 . ////////////////////////////////////////////////////////////////////////////
1620
1621 .chapter "Building and installing Exim" "CHID3"
1622 .scindex IIDbuex "building Exim"
1623
1624 .section "Unpacking" "SECID23"
1625 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1626 creates a directory with the name of the current release (for example,
1627 &_exim-&version()_&) into which the following files are placed:
1628
1629 .table2 140pt
1630 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1631 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1632   documented"
1633 .irow &_LICENCE_&         "the GNU General Public Licence"
1634 .irow &_Makefile_&        "top-level make file"
1635 .irow &_NOTICE_&          "conditions for the use of Exim"
1636 .irow &_README_&          "list of files, directories and simple build &&&
1637   instructions"
1638 .endtable
1639
1640 Other files whose names begin with &_README_& may also be present. The
1641 following subdirectories are created:
1642
1643 .table2 140pt
1644 .irow &_Local_&           "an empty directory for local configuration files"
1645 .irow &_OS_&              "OS-specific files"
1646 .irow &_doc_&             "documentation files"
1647 .irow &_exim_monitor_&    "source files for the Exim monitor"
1648 .irow &_scripts_&         "scripts used in the build process"
1649 .irow &_src_&             "remaining source files"
1650 .irow &_util_&            "independent utilities"
1651 .endtable
1652
1653 The main utility programs are contained in the &_src_& directory, and are built
1654 with the Exim binary. The &_util_& directory contains a few optional scripts
1655 that may be useful to some sites.
1656
1657
1658 .section "Multiple machine architectures and operating systems" "SECID24"
1659 .cindex "building Exim" "multiple OS/architectures"
1660 The building process for Exim is arranged to make it easy to build binaries for
1661 a number of different architectures and operating systems from the same set of
1662 source files. Compilation does not take place in the &_src_& directory.
1663 Instead, a &'build directory'& is created for each architecture and operating
1664 system.
1665 .cindex "symbolic link" "to build directory"
1666 Symbolic links to the sources are installed in this directory, which is where
1667 the actual building takes place. In most cases, Exim can discover the machine
1668 architecture and operating system for itself, but the defaults can be
1669 overridden if necessary.
1670 .cindex compiler requirements
1671 .cindex compiler version
1672 A C99-capable compiler will be required for the build.
1673
1674
1675 .section "PCRE library" "SECTpcre"
1676 .cindex "PCRE library"
1677 Exim no longer has an embedded PCRE library as the vast majority of
1678 modern systems include PCRE as a system library, although you may need
1679 to install the PCRE or PCRE development package for your operating
1680 system. If your system has a normal PCRE installation the Exim build
1681 process will need no further configuration. If the library or the
1682 headers are in an unusual location you will need to either set the PCRE_LIBS
1683 and INCLUDE directives appropriately,
1684 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1685 If your operating system has no
1686 PCRE support then you will need to obtain and build the current PCRE
1687 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1688 More information on PCRE is available at &url(http://www.pcre.org/).
1689
1690 .section "DBM libraries" "SECTdb"
1691 .cindex "DBM libraries" "discussion of"
1692 .cindex "hints database" "DBM files used for"
1693 Even if you do not use any DBM files in your configuration, Exim still needs a
1694 DBM library in order to operate, because it uses indexed files for its hints
1695 databases. Unfortunately, there are a number of DBM libraries in existence, and
1696 different operating systems often have different ones installed.
1697
1698 .cindex "Solaris" "DBM library for"
1699 .cindex "IRIX, DBM library for"
1700 .cindex "BSD, DBM library for"
1701 .cindex "Linux, DBM library for"
1702 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1703 Linux distribution, the DBM configuration should happen automatically, and you
1704 may be able to ignore this section. Otherwise, you may have to learn more than
1705 you would like about DBM libraries from what follows.
1706
1707 .cindex "&'ndbm'& DBM library"
1708 Licensed versions of Unix normally contain a library of DBM functions operating
1709 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1710 versions of Unix seem to vary in what they contain as standard. In particular,
1711 some early versions of Linux have no default DBM library, and different
1712 distributors have chosen to bundle different libraries with their packaged
1713 versions. However, the more recent releases seem to have standardized on the
1714 Berkeley DB library.
1715
1716 Different DBM libraries have different conventions for naming the files they
1717 use. When a program opens a file called &_dbmfile_&, there are several
1718 possibilities:
1719
1720 .olist
1721 A traditional &'ndbm'& implementation, such as that supplied as part of
1722 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1723 .next
1724 .cindex "&'gdbm'& DBM library"
1725 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1726 compatibility interface it makes two different hard links to it with names
1727 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1728 file name is used unmodified.
1729 .next
1730 .cindex "Berkeley DB library"
1731 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1732 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1733 programmer exactly the same as the traditional &'ndbm'& implementation.
1734 .next
1735 If the Berkeley package is used in its native mode, it operates on a single
1736 file called &_dbmfile_&; the programmer's interface is somewhat different to
1737 the traditional &'ndbm'& interface.
1738 .next
1739 To complicate things further, there are several very different versions of the
1740 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1741 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1742 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1743 versions of Berkeley DB can be obtained from
1744 &url(http://www.sleepycat.com/).
1745 .next
1746 .cindex "&'tdb'& DBM library"
1747 Yet another DBM library, called &'tdb'&, is available from
1748 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1749 operates on a single file.
1750 .endlist
1751
1752 .cindex "USE_DB"
1753 .cindex "DBM libraries" "configuration for building"
1754 Exim and its utilities can be compiled to use any of these interfaces. In order
1755 to use any version of the Berkeley DB package in native mode, you must set
1756 USE_DB in an appropriate configuration file (typically
1757 &_Local/Makefile_&). For example:
1758 .code
1759 USE_DB=yes
1760 .endd
1761 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1762 error is diagnosed if you set more than one of these.
1763
1764 At the lowest level, the build-time configuration sets none of these options,
1765 thereby assuming an interface of type (1). However, some operating system
1766 configuration files (for example, those for the BSD operating systems and
1767 Linux) assume type (4) by setting USE_DB as their default, and the
1768 configuration files for Cygwin set USE_GDBM. Anything you set in
1769 &_Local/Makefile_&, however, overrides these system defaults.
1770
1771 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1772 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1773 in one of these lines:
1774 .code
1775 DBMLIB = -ldb
1776 DBMLIB = -ltdb
1777 .endd
1778 Settings like that will work if the DBM library is installed in the standard
1779 place. Sometimes it is not, and the library's header file may also not be in
1780 the default path. You may need to set INCLUDE to specify where the header
1781 file is, and to specify the path to the library more fully in DBMLIB, as in
1782 this example:
1783 .code
1784 INCLUDE=-I/usr/local/include/db-4.1
1785 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1786 .endd
1787 There is further detailed discussion about the various DBM libraries in the
1788 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1789
1790
1791
1792 .section "Pre-building configuration" "SECID25"
1793 .cindex "building Exim" "pre-building configuration"
1794 .cindex "configuration for building Exim"
1795 .cindex "&_Local/Makefile_&"
1796 .cindex "&_src/EDITME_&"
1797 Before building Exim, a local configuration file that specifies options
1798 independent of any operating system has to be created with the name
1799 &_Local/Makefile_&. A template for this file is supplied as the file
1800 &_src/EDITME_&, and it contains full descriptions of all the option settings
1801 therein. These descriptions are therefore not repeated here. If you are
1802 building Exim for the first time, the simplest thing to do is to copy
1803 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1804
1805 There are three settings that you must supply, because Exim will not build
1806 without them. They are the location of the run time configuration file
1807 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1808 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1809 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1810 a colon-separated list of file names; Exim uses the first of them that exists.
1811
1812 There are a few other parameters that can be specified either at build time or
1813 at run time, to enable the same binary to be used on a number of different
1814 machines. However, if the locations of Exim's spool directory and log file
1815 directory (if not within the spool directory) are fixed, it is recommended that
1816 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1817 detected early in Exim's execution (such as a malformed configuration file) can
1818 be logged.
1819
1820 .cindex "content scanning" "specifying at build time"
1821 Exim's interfaces for calling virus and spam scanning software directly from
1822 access control lists are not compiled by default. If you want to include these
1823 facilities, you need to set
1824 .code
1825 WITH_CONTENT_SCAN=yes
1826 .endd
1827 in your &_Local/Makefile_&. For details of the facilities themselves, see
1828 chapter &<<CHAPexiscan>>&.
1829
1830
1831 .cindex "&_Local/eximon.conf_&"
1832 .cindex "&_exim_monitor/EDITME_&"
1833 If you are going to build the Exim monitor, a similar configuration process is
1834 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1835 your installation and saved under the name &_Local/eximon.conf_&. If you are
1836 happy with the default settings described in &_exim_monitor/EDITME_&,
1837 &_Local/eximon.conf_& can be empty, but it must exist.
1838
1839 This is all the configuration that is needed in straightforward cases for known
1840 operating systems. However, the building process is set up so that it is easy
1841 to override options that are set by default or by operating-system-specific
1842 configuration files, for example to change the name of the C compiler, which
1843 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1844 do this.
1845
1846
1847
1848 .section "Support for iconv()" "SECID26"
1849 .cindex "&[iconv()]& support"
1850 .cindex "RFC 2047"
1851 The contents of header lines in messages may be encoded according to the rules
1852 described RFC 2047. This makes it possible to transmit characters that are not
1853 in the ASCII character set, and to label them as being in a particular
1854 character set. When Exim is inspecting header lines by means of the &%$h_%&
1855 mechanism, it decodes them, and translates them into a specified character set
1856 (default is set at build time). The translation is possible only if the operating system
1857 supports the &[iconv()]& function.
1858
1859 However, some of the operating systems that supply &[iconv()]& do not support
1860 very many conversions. The GNU &%libiconv%& library (available from
1861 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1862 systems to remedy this deficiency, as well as on systems that do not supply
1863 &[iconv()]& at all. After installing &%libiconv%&, you should add
1864 .code
1865 HAVE_ICONV=yes
1866 .endd
1867 to your &_Local/Makefile_& and rebuild Exim.
1868
1869
1870
1871 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1872 .cindex "TLS" "including support for TLS"
1873 .cindex "encryption" "including support for"
1874 .cindex "SUPPORT_TLS"
1875 .cindex "OpenSSL" "building Exim with"
1876 .cindex "GnuTLS" "building Exim with"
1877 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1878 command as per RFC 2487. It can also support legacy clients that expect to
1879 start a TLS session immediately on connection to a non-standard port (see the
1880 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1881 line option).
1882
1883 If you want to build Exim with TLS support, you must first install either the
1884 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1885 implementing SSL.
1886
1887 If OpenSSL is installed, you should set
1888 .code
1889 SUPPORT_TLS=yes
1890 TLS_LIBS=-lssl -lcrypto
1891 .endd
1892 in &_Local/Makefile_&. You may also need to specify the locations of the
1893 OpenSSL library and include files. For example:
1894 .code
1895 SUPPORT_TLS=yes
1896 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1897 TLS_INCLUDE=-I/usr/local/openssl/include/
1898 .endd
1899 .cindex "pkg-config" "OpenSSL"
1900 If you have &'pkg-config'& available, then instead you can just use:
1901 .code
1902 SUPPORT_TLS=yes
1903 USE_OPENSSL_PC=openssl
1904 .endd
1905 .cindex "USE_GNUTLS"
1906 If GnuTLS is installed, you should set
1907 .code
1908 SUPPORT_TLS=yes
1909 USE_GNUTLS=yes
1910 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1911 .endd
1912 in &_Local/Makefile_&, and again you may need to specify the locations of the
1913 library and include files. For example:
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1918 TLS_INCLUDE=-I/usr/gnu/include
1919 .endd
1920 .cindex "pkg-config" "GnuTLS"
1921 If you have &'pkg-config'& available, then instead you can just use:
1922 .code
1923 SUPPORT_TLS=yes
1924 USE_GNUTLS=yes
1925 USE_GNUTLS_PC=gnutls
1926 .endd
1927
1928 You do not need to set TLS_INCLUDE if the relevant directory is already
1929 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1930 given in chapter &<<CHAPTLS>>&.
1931
1932
1933
1934
1935 .section "Use of tcpwrappers" "SECID27"
1936
1937 .cindex "tcpwrappers, building Exim to support"
1938 .cindex "USE_TCP_WRAPPERS"
1939 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1940 .cindex "tcp_wrappers_daemon_name"
1941 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1942 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1943 alternative to Exim's own checking facilities for installations that are
1944 already making use of &'tcpwrappers'& for other purposes. To do this, you
1945 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1946 &_tcpd.h_& to be available at compile time, and also ensure that the library
1947 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1948 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1949 you might have
1950 .code
1951 USE_TCP_WRAPPERS=yes
1952 CFLAGS=-O -I/usr/local/include
1953 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1954 .endd
1955 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1956 files is &"exim"&. For example, the line
1957 .code
1958 exim : LOCAL  192.168.1.  .friendly.domain.example
1959 .endd
1960 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1961 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1962 All other connections are denied. The daemon name used by &'tcpwrappers'&
1963 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1964 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1965 configure file. Consult the &'tcpwrappers'& documentation for
1966 further details.
1967
1968
1969 .section "Including support for IPv6" "SECID28"
1970 .cindex "IPv6" "including support for"
1971 Exim contains code for use on systems that have IPv6 support. Setting
1972 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1973 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1974 where the IPv6 support is not fully integrated into the normal include and
1975 library files.
1976
1977 Two different types of DNS record for handling IPv6 addresses have been
1978 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1979 currently seen as the mainstream. Another record type called A6 was proposed
1980 as better than AAAA because it had more flexibility. However, it was felt to be
1981 over-complex, and its status was reduced to &"experimental"&.
1982 Exim used to
1983 have a compile option for including A6 record support but this has now been
1984 withdrawn.
1985
1986
1987
1988 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1989 .cindex "lookup modules"
1990 .cindex "dynamic modules"
1991 .cindex ".so building"
1992 On some platforms, Exim supports not compiling all lookup types directly into
1993 the main binary, instead putting some into external modules which can be loaded
1994 on demand.
1995 This permits packagers to build Exim with support for lookups with extensive
1996 library dependencies without requiring all users to install all of those
1997 dependencies.
1998 Most, but not all, lookup types can be built this way.
1999
2000 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2001 installed; Exim will only load modules from that directory, as a security
2002 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2003 for your OS; see &_OS/Makefile-Linux_& for an example.
2004 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2005 see &_src/EDITME_& for details.
2006
2007 Then, for each module to be loaded dynamically, define the relevant
2008 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2009 For example, this will build in lsearch but load sqlite and mysql support
2010 on demand:
2011 .code
2012 LOOKUP_LSEARCH=yes
2013 LOOKUP_SQLITE=2
2014 LOOKUP_MYSQL=2
2015 .endd
2016
2017
2018 .section "The building process" "SECID29"
2019 .cindex "build directory"
2020 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2021 created, run &'make'& at the top level. It determines the architecture and
2022 operating system types, and creates a build directory if one does not exist.
2023 For example, on a Sun system running Solaris 8, the directory
2024 &_build-SunOS5-5.8-sparc_& is created.
2025 .cindex "symbolic link" "to source files"
2026 Symbolic links to relevant source files are installed in the build directory.
2027
2028 If this is the first time &'make'& has been run, it calls a script that builds
2029 a make file inside the build directory, using the configuration files from the
2030 &_Local_& directory. The new make file is then passed to another instance of
2031 &'make'&. This does the real work, building a number of utility scripts, and
2032 then compiling and linking the binaries for the Exim monitor (if configured), a
2033 number of utility programs, and finally Exim itself. The command &`make
2034 makefile`& can be used to force a rebuild of the make file in the build
2035 directory, should this ever be necessary.
2036
2037 If you have problems building Exim, check for any comments there may be in the
2038 &_README_& file concerning your operating system, and also take a look at the
2039 FAQ, where some common problems are covered.
2040
2041
2042
2043 .section 'Output from &"make"&' "SECID283"
2044 The output produced by the &'make'& process for compile lines is often very
2045 unreadable, because these lines can be very long. For this reason, the normal
2046 output is suppressed by default, and instead output similar to that which
2047 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2048 each module that is being compiled or linked. However, it is still possible to
2049 get the full output, by calling &'make'& like this:
2050 .code
2051 FULLECHO='' make -e
2052 .endd
2053 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2054 command reflection in &'make'&. When you ask for the full output, it is
2055 given in addition to the short output.
2056
2057
2058
2059 .section "Overriding build-time options for Exim" "SECToverride"
2060 .cindex "build-time options, overriding"
2061 The main make file that is created at the beginning of the building process
2062 consists of the concatenation of a number of files which set configuration
2063 values, followed by a fixed set of &'make'& instructions. If a value is set
2064 more than once, the last setting overrides any previous ones. This provides a
2065 convenient way of overriding defaults. The files that are concatenated are, in
2066 order:
2067 .display
2068 &_OS/Makefile-Default_&
2069 &_OS/Makefile-_&<&'ostype'&>
2070 &_Local/Makefile_&
2071 &_Local/Makefile-_&<&'ostype'&>
2072 &_Local/Makefile-_&<&'archtype'&>
2073 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2074 &_OS/Makefile-Base_&
2075 .endd
2076 .cindex "&_Local/Makefile_&"
2077 .cindex "building Exim" "operating system type"
2078 .cindex "building Exim" "architecture type"
2079 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2080 architecture type. &_Local/Makefile_& is required to exist, and the building
2081 process fails if it is absent. The other three &_Local_& files are optional,
2082 and are often not needed.
2083
2084 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2085 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2086 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2087 values are used, thereby providing a means of forcing particular settings.
2088 Otherwise, the scripts try to get values from the &%uname%& command. If this
2089 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2090 of &'ad hoc'& transformations are then applied, to produce the standard names
2091 that Exim expects. You can run these scripts directly from the shell in order
2092 to find out what values are being used on your system.
2093
2094
2095 &_OS/Makefile-Default_& contains comments about the variables that are set
2096 therein. Some (but not all) are mentioned below. If there is something that
2097 needs changing, review the contents of this file and the contents of the make
2098 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2099 default values are.
2100
2101
2102 .cindex "building Exim" "overriding default settings"
2103 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2104 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2105 need to change the original files. Instead, you should make the changes by
2106 putting the new values in an appropriate &_Local_& file. For example,
2107 .cindex "Tru64-Unix build-time settings"
2108 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2109 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2110 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2111 called with the option &%-std1%&, to make it recognize some of the features of
2112 Standard C that Exim uses. (Most other compilers recognize Standard C by
2113 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2114 containing the lines
2115 .code
2116 CC=cc
2117 CFLAGS=-std1
2118 .endd
2119 If you are compiling for just one operating system, it may be easier to put
2120 these lines directly into &_Local/Makefile_&.
2121
2122 Keeping all your local configuration settings separate from the distributed
2123 files makes it easy to transfer them to new versions of Exim simply by copying
2124 the contents of the &_Local_& directory.
2125
2126
2127 .cindex "NIS lookup type" "including support for"
2128 .cindex "NIS+ lookup type" "including support for"
2129 .cindex "LDAP" "including support for"
2130 .cindex "lookup" "inclusion in binary"
2131 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2132 lookup, but not all systems have these components installed, so the default is
2133 not to include the relevant code in the binary. All the different kinds of file
2134 and database lookup that Exim supports are implemented as separate code modules
2135 which are included only if the relevant compile-time options are set. In the
2136 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2137 .code
2138 LOOKUP_LDAP=yes
2139 LOOKUP_NIS=yes
2140 LOOKUP_NISPLUS=yes
2141 .endd
2142 and similar settings apply to the other lookup types. They are all listed in
2143 &_src/EDITME_&. In many cases the relevant include files and interface
2144 libraries need to be installed before compiling Exim.
2145 .cindex "cdb" "including support for"
2146 However, there are some optional lookup types (such as cdb) for which
2147 the code is entirely contained within Exim, and no external include
2148 files or libraries are required. When a lookup type is not included in the
2149 binary, attempts to configure Exim to use it cause run time configuration
2150 errors.
2151
2152 .cindex "pkg-config" "lookups"
2153 .cindex "pkg-config" "authenticators"
2154 Many systems now use a tool called &'pkg-config'& to encapsulate information
2155 about how to compile against a library; Exim has some initial support for
2156 being able to use pkg-config for lookups and authenticators.  For any given
2157 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2158 variable with the &`_PC`& suffix in the name and assign as the value the
2159 name of the package to be queried.  The results of querying via the
2160 &'pkg-config'& command will be added to the appropriate Makefile variables
2161 with &`+=`& directives, so your version of &'make'& will need to support that
2162 syntax.  For instance:
2163 .code
2164 LOOKUP_SQLITE=yes
2165 LOOKUP_SQLITE_PC=sqlite3
2166 AUTH_GSASL=yes
2167 AUTH_GSASL_PC=libgsasl
2168 AUTH_HEIMDAL_GSSAPI=yes
2169 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2170 .endd
2171
2172 .cindex "Perl" "including support for"
2173 Exim can be linked with an embedded Perl interpreter, allowing Perl
2174 subroutines to be called during string expansion. To enable this facility,
2175 .code
2176 EXIM_PERL=perl.o
2177 .endd
2178 must be defined in &_Local/Makefile_&. Details of this facility are given in
2179 chapter &<<CHAPperl>>&.
2180
2181 .cindex "X11 libraries, location of"
2182 The location of the X11 libraries is something that varies a lot between
2183 operating systems, and there may be different versions of X11 to cope
2184 with. Exim itself makes no use of X11, but if you are compiling the Exim
2185 monitor, the X11 libraries must be available.
2186 The following three variables are set in &_OS/Makefile-Default_&:
2187 .code
2188 X11=/usr/X11R6
2189 XINCLUDE=-I$(X11)/include
2190 XLFLAGS=-L$(X11)/lib
2191 .endd
2192 These are overridden in some of the operating-system configuration files. For
2193 example, in &_OS/Makefile-SunOS5_& there is
2194 .code
2195 X11=/usr/openwin
2196 XINCLUDE=-I$(X11)/include
2197 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2198 .endd
2199 If you need to override the default setting for your operating system, place a
2200 definition of all three of these variables into your
2201 &_Local/Makefile-<ostype>_& file.
2202
2203 .cindex "EXTRALIBS"
2204 If you need to add any extra libraries to the link steps, these can be put in a
2205 variable called EXTRALIBS, which appears in all the link commands, but by
2206 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2207 command for linking the main Exim binary, and not for any associated utilities.
2208
2209 .cindex "DBM libraries" "configuration for building"
2210 There is also DBMLIB, which appears in the link commands for binaries that
2211 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2212 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2213 binary, and which can be used, for example, to include additional X11
2214 libraries.
2215
2216 .cindex "configuration file" "editing"
2217 The make file copes with rebuilding Exim correctly if any of the configuration
2218 files are edited. However, if an optional configuration file is deleted, it is
2219 necessary to touch the associated non-optional file (that is,
2220 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2221
2222
2223 .section "OS-specific header files" "SECID30"
2224 .cindex "&_os.h_&"
2225 .cindex "building Exim" "OS-specific C header files"
2226 The &_OS_& directory contains a number of files with names of the form
2227 &_os.h-<ostype>_&. These are system-specific C header files that should not
2228 normally need to be changed. There is a list of macro settings that are
2229 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2230 are porting Exim to a new operating system.
2231
2232
2233
2234 .section "Overriding build-time options for the monitor" "SECID31"
2235 .cindex "building Eximon"
2236 A similar process is used for overriding things when building the Exim monitor,
2237 where the files that are involved are
2238 .display
2239 &_OS/eximon.conf-Default_&
2240 &_OS/eximon.conf-_&<&'ostype'&>
2241 &_Local/eximon.conf_&
2242 &_Local/eximon.conf-_&<&'ostype'&>
2243 &_Local/eximon.conf-_&<&'archtype'&>
2244 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2245 .endd
2246 .cindex "&_Local/eximon.conf_&"
2247 As with Exim itself, the final three files need not exist, and in this case the
2248 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2249 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2250 variables of the same name, preceded by EXIMON_. For example, setting
2251 EXIMON_LOG_DEPTH in the environment overrides the value of
2252 LOG_DEPTH at run time.
2253 .ecindex IIDbuex
2254
2255
2256 .section "Installing Exim binaries and scripts" "SECID32"
2257 .cindex "installing Exim"
2258 .cindex "BIN_DIRECTORY"
2259 The command &`make install`& runs the &(exim_install)& script with no
2260 arguments. The script copies binaries and utility scripts into the directory
2261 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2262 .cindex "setuid" "installing Exim with"
2263 The install script copies files only if they are newer than the files they are
2264 going to replace. The Exim binary is required to be owned by root and have the
2265 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2266 install`& as root so that it can set up the Exim binary in this way. However, in
2267 some special situations (for example, if a host is doing no local deliveries)
2268 it may be possible to run Exim without making the binary setuid root (see
2269 chapter &<<CHAPsecurity>>& for details).
2270
2271 .cindex "CONFIGURE_FILE"
2272 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2273 in &_Local/Makefile_&. If this names a single file, and the file does not
2274 exist, the default configuration file &_src/configure.default_& is copied there
2275 by the installation script. If a run time configuration file already exists, it
2276 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2277 alternative files, no default is installed.
2278
2279 .cindex "system aliases file"
2280 .cindex "&_/etc/aliases_&"
2281 One change is made to the default configuration file when it is installed: the
2282 default configuration contains a router that references a system aliases file.
2283 The path to this file is set to the value specified by
2284 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2285 If the system aliases file does not exist, the installation script creates it,
2286 and outputs a comment to the user.
2287
2288 The created file contains no aliases, but it does contain comments about the
2289 aliases a site should normally have. Mail aliases have traditionally been
2290 kept in &_/etc/aliases_&. However, some operating systems are now using
2291 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2292 Exim's configuration if necessary.
2293
2294 The default configuration uses the local host's name as the only local domain,
2295 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2296 running as the local user. System aliases and &_.forward_& files in users' home
2297 directories are supported, but no NIS or NIS+ support is configured. Domains
2298 other than the name of the local host are routed using the DNS, with delivery
2299 over SMTP.
2300
2301 It is possible to install Exim for special purposes (such as building a binary
2302 distribution) in a private part of the file system. You can do this by a
2303 command such as
2304 .code
2305 make DESTDIR=/some/directory/ install
2306 .endd
2307 This has the effect of pre-pending the specified directory to all the file
2308 paths, except the name of the system aliases file that appears in the default
2309 configuration. (If a default alias file is created, its name &'is'& modified.)
2310 For backwards compatibility, ROOT is used if DESTDIR is not set,
2311 but this usage is deprecated.
2312
2313 .cindex "installing Exim" "what is not installed"
2314 Running &'make install'& does not copy the Exim 4 conversion script
2315 &'convert4r4'&. You will probably run this only once if you are
2316 upgrading from Exim 3. None of the documentation files in the &_doc_&
2317 directory are copied, except for the info files when you have set
2318 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2319
2320 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2321 to their names. The Exim binary itself, however, is handled differently. It is
2322 installed under a name that includes the version number and the compile number,
2323 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2324 called &_exim_& to point to the binary. If you are updating a previous version
2325 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2326 from the directory (as seen by other processes).
2327
2328 .cindex "installing Exim" "testing the script"
2329 If you want to see what the &'make install'& will do before running it for
2330 real, you can pass the &%-n%& option to the installation script by this
2331 command:
2332 .code
2333 make INSTALL_ARG=-n install
2334 .endd
2335 The contents of the variable INSTALL_ARG are passed to the installation
2336 script. You do not need to be root to run this test. Alternatively, you can run
2337 the installation script directly, but this must be from within the build
2338 directory. For example, from the top-level Exim directory you could use this
2339 command:
2340 .code
2341 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2342 .endd
2343 .cindex "installing Exim" "install script options"
2344 There are two other options that can be supplied to the installation script.
2345
2346 .ilist
2347 &%-no_chown%& bypasses the call to change the owner of the installed binary
2348 to root, and the call to make it a setuid binary.
2349 .next
2350 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2351 installed binary.
2352 .endlist
2353
2354 INSTALL_ARG can be used to pass these options to the script. For example:
2355 .code
2356 make INSTALL_ARG=-no_symlink install
2357 .endd
2358 The installation script can also be given arguments specifying which files are
2359 to be copied. For example, to install just the Exim binary, and nothing else,
2360 without creating the symbolic link, you could use:
2361 .code
2362 make INSTALL_ARG='-no_symlink exim' install
2363 .endd
2364
2365
2366
2367 .section "Installing info documentation" "SECTinsinfdoc"
2368 .cindex "installing Exim" "&'info'& documentation"
2369 Not all systems use the GNU &'info'& system for documentation, and for this
2370 reason, the Texinfo source of Exim's documentation is not included in the main
2371 distribution. Instead it is available separately from the ftp site (see section
2372 &<<SECTavail>>&).
2373
2374 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2375 source of the documentation is found in the source tree, running &`make
2376 install`& automatically builds the info files and installs them.
2377
2378
2379
2380 .section "Setting up the spool directory" "SECID33"
2381 .cindex "spool directory" "creating"
2382 When it starts up, Exim tries to create its spool directory if it does not
2383 exist. The Exim uid and gid are used for the owner and group of the spool
2384 directory. Sub-directories are automatically created in the spool directory as
2385 necessary.
2386
2387
2388
2389
2390 .section "Testing" "SECID34"
2391 .cindex "testing" "installation"
2392 Having installed Exim, you can check that the run time configuration file is
2393 syntactically valid by running the following command, which assumes that the
2394 Exim binary directory is within your PATH environment variable:
2395 .code
2396 exim -bV
2397 .endd
2398 If there are any errors in the configuration file, Exim outputs error messages.
2399 Otherwise it outputs the version number and build date,
2400 the DBM library that is being used, and information about which drivers and
2401 other optional code modules are included in the binary.
2402 Some simple routing tests can be done by using the address testing option. For
2403 example,
2404 .display
2405 &`exim -bt`& <&'local username'&>
2406 .endd
2407 should verify that it recognizes a local mailbox, and
2408 .display
2409 &`exim -bt`& <&'remote address'&>
2410 .endd
2411 a remote one. Then try getting it to deliver mail, both locally and remotely.
2412 This can be done by passing messages directly to Exim, without going through a
2413 user agent. For example:
2414 .code
2415 exim -v postmaster@your.domain.example
2416 From: user@your.domain.example
2417 To: postmaster@your.domain.example
2418 Subject: Testing Exim
2419
2420 This is a test message.
2421 ^D
2422 .endd
2423 The &%-v%& option causes Exim to output some verification of what it is doing.
2424 In this case you should see copies of three log lines, one for the message's
2425 arrival, one for its delivery, and one containing &"Completed"&.
2426
2427 .cindex "delivery" "problems with"
2428 If you encounter problems, look at Exim's log files (&'mainlog'& and
2429 &'paniclog'&) to see if there is any relevant information there. Another source
2430 of information is running Exim with debugging turned on, by specifying the
2431 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2432 with debugging turned on by a command of the form
2433 .display
2434 &`exim -d -M`& <&'exim-message-id'&>
2435 .endd
2436 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2437 produces rather a lot of output, but you can cut this down to specific areas.
2438 For example, if you use &%-d-all+route%& only the debugging information
2439 relevant to routing is included. (See the &%-d%& option in chapter
2440 &<<CHAPcommandline>>& for more details.)
2441
2442 .cindex '&"sticky"& bit'
2443 .cindex "lock files"
2444 One specific problem that has shown up on some sites is the inability to do
2445 local deliveries into a shared mailbox directory, because it does not have the
2446 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2447 writing to a mailbox file, and if it cannot create the lock file, the delivery
2448 is deferred. You can get round this either by setting the &"sticky bit"& on the
2449 directory, or by setting a specific group for local deliveries and allowing
2450 that group to create files in the directory (see the comments above the
2451 &(local_delivery)& transport in the default configuration file). Another
2452 approach is to configure Exim not to use lock files, but just to rely on
2453 &[fcntl()]& locking instead. However, you should do this only if all user
2454 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2455 see chapter &<<CHAPappendfile>>&.
2456
2457 One thing that cannot be tested on a system that is already running an MTA is
2458 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2459 &%-oX%& option can be used to run an Exim daemon that listens on some other
2460 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2461 &'exim_checkaccess'& utility can be used to check out policy controls on
2462 incoming SMTP mail.
2463
2464 Testing a new version on a system that is already running Exim can most easily
2465 be done by building a binary with a different CONFIGURE_FILE setting. From
2466 within the run time configuration, all other file and directory names
2467 that Exim uses can be altered, in order to keep it entirely clear of the
2468 production version.
2469
2470
2471 .section "Replacing another MTA with Exim" "SECID35"
2472 .cindex "replacing another MTA"
2473 Building and installing Exim for the first time does not of itself put it in
2474 general use. The name by which the system's MTA is called by mail user agents
2475 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2476 operating system), and it is necessary to make this name point to the &'exim'&
2477 binary in order to get the user agents to pass messages to Exim. This is
2478 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2479 or &_/usr/lib/sendmail_&
2480 .cindex "symbolic link" "to &'exim'& binary"
2481 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2482 privilege and executable status from the old MTA. It is then necessary to stop
2483 and restart the mailer daemon, if one is running.
2484
2485 .cindex "FreeBSD, MTA indirection"
2486 .cindex "&_/etc/mail/mailer.conf_&"
2487 Some operating systems have introduced alternative ways of switching MTAs. For
2488 example, if you are running FreeBSD, you need to edit the file
2489 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2490 described. A typical example of the contents of this file for running Exim is
2491 as follows:
2492 .code
2493 sendmail            /usr/exim/bin/exim
2494 send-mail           /usr/exim/bin/exim
2495 mailq               /usr/exim/bin/exim -bp
2496 newaliases          /usr/bin/true
2497 .endd
2498 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2499 your Exim installation is &"live"&. Check it by sending a message from your
2500 favourite user agent.
2501
2502 You should consider what to tell your users about the change of MTA. Exim may
2503 have different capabilities to what was previously running, and there are
2504 various operational differences such as the text of messages produced by
2505 command line options and in bounce messages. If you allow your users to make
2506 use of Exim's filtering capabilities, you should make the document entitled
2507 &'Exim's interface to mail filtering'& available to them.
2508
2509
2510
2511 .section "Upgrading Exim" "SECID36"
2512 .cindex "upgrading Exim"
2513 If you are already running Exim on your host, building and installing a new
2514 version automatically makes it available to MUAs, or any other programs that
2515 call the MTA directly. However, if you are running an Exim daemon, you do need
2516 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2517 new binary. You do not need to stop processing mail in order to install a new
2518 version of Exim. The install script does not modify an existing runtime
2519 configuration file.
2520
2521
2522
2523
2524 .section "Stopping the Exim daemon on Solaris" "SECID37"
2525 .cindex "Solaris" "stopping Exim on"
2526 The standard command for stopping the mailer daemon on Solaris is
2527 .code
2528 /etc/init.d/sendmail stop
2529 .endd
2530 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2531 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2532 for the text &"sendmail"&; this is not present because the actual program name
2533 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2534 solution is to replace the line that finds the process id with something like
2535 .code
2536 pid=`cat /var/spool/exim/exim-daemon.pid`
2537 .endd
2538 to obtain the daemon's pid directly from the file that Exim saves it in.
2539
2540 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2541 still be received from local processes, and if automatic delivery is configured
2542 (the normal case), deliveries will still occur.
2543
2544
2545
2546
2547 . ////////////////////////////////////////////////////////////////////////////
2548 . ////////////////////////////////////////////////////////////////////////////
2549
2550 .chapter "The Exim command line" "CHAPcommandline"
2551 .scindex IIDclo1 "command line" "options"
2552 .scindex IIDclo2 "options" "command line"
2553 Exim's command line takes the standard Unix form of a sequence of options,
2554 each starting with a hyphen character, followed by a number of arguments. The
2555 options are compatible with the main options of Sendmail, and there are also
2556 some additional options, some of which are compatible with Smail 3. Certain
2557 combinations of options do not make sense, and provoke an error if used.
2558 The form of the arguments depends on which options are set.
2559
2560
2561 .section "Setting options by program name" "SECID38"
2562 .cindex "&'mailq'&"
2563 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2564 were present before any other options.
2565 The &%-bp%& option requests a listing of the contents of the mail queue on the
2566 standard output.
2567 This feature is for compatibility with some systems that contain a command of
2568 that name in one of the standard libraries, symbolically linked to
2569 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2570
2571 .cindex "&'rsmtp'&"
2572 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2573 were present before any other options, for compatibility with Smail. The
2574 &%-bS%& option is used for reading in a number of messages in batched SMTP
2575 format.
2576
2577 .cindex "&'rmail'&"
2578 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2579 &%-oee%& options were present before any other options, for compatibility with
2580 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2581
2582 .cindex "&'runq'&"
2583 .cindex "queue runner"
2584 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2585 were present before any other options, for compatibility with Smail. The &%-q%&
2586 option causes a single queue runner process to be started.
2587
2588 .cindex "&'newaliases'&"
2589 .cindex "alias file" "building"
2590 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2591 If Exim is called under the name &'newaliases'& it behaves as if the option
2592 &%-bi%& were present before any other options, for compatibility with Sendmail.
2593 This option is used for rebuilding Sendmail's alias file. Exim does not have
2594 the concept of a single alias file, but can be configured to run a given
2595 command if called with the &%-bi%& option.
2596
2597
2598 .section "Trusted and admin users" "SECTtrustedadmin"
2599 Some Exim options are available only to &'trusted users'& and others are
2600 available only to &'admin users'&. In the description below, the phrases &"Exim
2601 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2602 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2603 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2604
2605 .ilist
2606 .cindex "trusted users" "definition of"
2607 .cindex "user" "trusted definition of"
2608 The trusted users are root, the Exim user, any user listed in the
2609 &%trusted_users%& configuration option, and any user whose current group or any
2610 supplementary group is one of those listed in the &%trusted_groups%&
2611 configuration option. Note that the Exim group is not automatically trusted.
2612
2613 .cindex '&"From"& line'
2614 .cindex "envelope sender"
2615 Trusted users are always permitted to use the &%-f%& option or a leading
2616 &"From&~"& line to specify the envelope sender of a message that is passed to
2617 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2618 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2619 users to set envelope senders.
2620
2621 .cindex "&'From:'& header line"
2622 .cindex "&'Sender:'& header line"
2623 .cindex "header lines" "From:"
2624 .cindex "header lines" "Sender:"
2625 For a trusted user, there is never any check on the contents of the &'From:'&
2626 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2627 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2628
2629 Trusted users may also specify a host name, host address, interface address,
2630 protocol name, ident value, and authentication data when submitting a message
2631 locally. Thus, they are able to insert messages into Exim's queue locally that
2632 have the characteristics of messages received from a remote host. Untrusted
2633 users may in some circumstances use &%-f%&, but can never set the other values
2634 that are available to trusted users.
2635 .next
2636 .cindex "user" "admin definition of"
2637 .cindex "admin user" "definition of"
2638 The admin users are root, the Exim user, and any user that is a member of the
2639 Exim group or of any group listed in the &%admin_groups%& configuration option.
2640 The current group does not have to be one of these groups.
2641
2642 Admin users are permitted to list the queue, and to carry out certain
2643 operations on messages, for example, to force delivery failures. It is also
2644 necessary to be an admin user in order to see the full information provided by
2645 the Exim monitor, and full debugging output.
2646
2647 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2648 Exim to attempt delivery of messages on its queue is restricted to admin users.
2649 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2650 option false (that is, specifying &%no_prod_requires_admin%&).
2651
2652 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2653 is restricted to admin users unless &%queue_list_requires_admin%& is set
2654 false.
2655 .endlist
2656
2657
2658 &*Warning*&: If you configure your system so that admin users are able to
2659 edit Exim's configuration file, you are giving those users an easy way of
2660 getting root. There is further discussion of this issue at the start of chapter
2661 &<<CHAPconf>>&.
2662
2663
2664
2665
2666 .section "Command line options" "SECID39"
2667 Exim's command line options are described in alphabetical order below. If none
2668 of the options that specifies a specific action (such as starting the daemon or
2669 a queue runner, or testing an address, or receiving a message in a specific
2670 format, or listing the queue) are present, and there is at least one argument
2671 on the command line, &%-bm%& (accept a local message on the standard input,
2672 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2673 outputs a brief message about itself and exits.
2674
2675 . ////////////////////////////////////////////////////////////////////////////
2676 . Insert a stylized XML comment here, to identify the start of the command line
2677 . options. This is for the benefit of the Perl script that automatically
2678 . creates a man page for the options.
2679 . ////////////////////////////////////////////////////////////////////////////
2680
2681 .literal xml
2682 <!-- === Start of command line options === -->
2683 .literal off
2684
2685
2686 .vlist
2687 .vitem &%--%&
2688 .oindex "--"
2689 .cindex "options" "command line; terminating"
2690 This is a pseudo-option whose only purpose is to terminate the options and
2691 therefore to cause subsequent command line items to be treated as arguments
2692 rather than options, even if they begin with hyphens.
2693
2694 .vitem &%--help%&
2695 .oindex "&%--help%&"
2696 This option causes Exim to output a few sentences stating what it is.
2697 The same output is generated if the Exim binary is called with no options and
2698 no arguments.
2699
2700 .vitem &%--version%&
2701 .oindex "&%--version%&"
2702 This option is an alias for &%-bV%& and causes version information to be
2703 displayed.
2704
2705 .vitem &%-Ac%& &&&
2706        &%-Am%&
2707 .oindex "&%-Ac%&"
2708 .oindex "&%-Am%&"
2709 These options are used by Sendmail for selecting configuration files and are
2710 ignored by Exim.
2711
2712 .vitem &%-B%&<&'type'&>
2713 .oindex "&%-B%&"
2714 .cindex "8-bit characters"
2715 .cindex "Sendmail compatibility" "8-bit characters"
2716 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2717 clean; it ignores this option.
2718
2719 .vitem &%-bd%&
2720 .oindex "&%-bd%&"
2721 .cindex "daemon"
2722 .cindex "SMTP" "listener"
2723 .cindex "queue runner"
2724 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2725 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2726 that the daemon should also initiate periodic queue runs.
2727
2728 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2729 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2730 disconnect from the controlling terminal. When running this way, it can be
2731 stopped by pressing ctrl-C.
2732
2733 By default, Exim listens for incoming connections to the standard SMTP port on
2734 all the host's running interfaces. However, it is possible to listen on other
2735 ports, on multiple ports, and only on specific interfaces. Chapter
2736 &<<CHAPinterfaces>>& contains a description of the options that control this.
2737
2738 When a listening daemon
2739 .cindex "daemon" "process id (pid)"
2740 .cindex "pid (process id)" "of daemon"
2741 is started without the use of &%-oX%& (that is, without overriding the normal
2742 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2743 in Exim's spool directory. This location can be overridden by setting
2744 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2745 running as root.
2746
2747 When &%-oX%& is used on the command line to start a listening daemon, the
2748 process id is not written to the normal pid file path. However, &%-oP%& can be
2749 used to specify a path on the command line if a pid file is required.
2750
2751 The SIGHUP signal
2752 .cindex "SIGHUP"
2753 .cindex "daemon" "restarting"
2754 can be used to cause the daemon to re-execute itself. This should be done
2755 whenever Exim's configuration file, or any file that is incorporated into it by
2756 means of the &%.include%& facility, is changed, and also whenever a new version
2757 of Exim is installed. It is not necessary to do this when other files that are
2758 referenced from the configuration (for example, alias files) are changed,
2759 because these are reread each time they are used.
2760
2761 .vitem &%-bdf%&
2762 .oindex "&%-bdf%&"
2763 This option has the same effect as &%-bd%& except that it never disconnects
2764 from the controlling terminal, even when no debugging is specified.
2765
2766 .vitem &%-be%&
2767 .oindex "&%-be%&"
2768 .cindex "testing" "string expansion"
2769 .cindex "expansion" "testing"
2770 Run Exim in expansion testing mode. Exim discards its root privilege, to
2771 prevent ordinary users from using this mode to read otherwise inaccessible
2772 files. If no arguments are given, Exim runs interactively, prompting for lines
2773 of data. Otherwise, it processes each argument in turn.
2774
2775 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2776 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2777 used without command line arguments. If successful, it uses the &[readline()]&
2778 function, which provides extensive line-editing facilities, for reading the
2779 test data. A line history is supported.
2780
2781 Long expansion expressions can be split over several lines by using backslash
2782 continuations. As in Exim's run time configuration, white space at the start of
2783 continuation lines is ignored. Each argument or data line is passed through the
2784 string expansion mechanism, and the result is output. Variable values from the
2785 configuration file (for example, &$qualify_domain$&) are available, but no
2786 message-specific values (such as &$message_exim_id$&) are set, because no message
2787 is being processed (but see &%-bem%& and &%-Mset%&).
2788
2789 &*Note*&: If you use this mechanism to test lookups, and you change the data
2790 files or databases you are using, you must exit and restart Exim before trying
2791 the same lookup again. Otherwise, because each Exim process caches the results
2792 of lookups, you will just get the same result as before.
2793
2794 .vitem &%-bem%&&~<&'filename'&>
2795 .oindex "&%-bem%&"
2796 .cindex "testing" "string expansion"
2797 .cindex "expansion" "testing"
2798 This option operates like &%-be%& except that it must be followed by the name
2799 of a file. For example:
2800 .code
2801 exim -bem /tmp/testmessage
2802 .endd
2803 The file is read as a message (as if receiving a locally-submitted non-SMTP
2804 message) before any of the test expansions are done. Thus, message-specific
2805 variables such as &$message_size$& and &$header_from:$& are available. However,
2806 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2807 recipients are read from the headers in the normal way, and are shown in the
2808 &$recipients$& variable. Note that recipients cannot be given on the command
2809 line, because further arguments are taken as strings to expand (just like
2810 &%-be%&).
2811
2812 .vitem &%-bF%&&~<&'filename'&>
2813 .oindex "&%-bF%&"
2814 .cindex "system filter" "testing"
2815 .cindex "testing" "system filter"
2816 This option is the same as &%-bf%& except that it assumes that the filter being
2817 tested is a system filter. The additional commands that are available only in
2818 system filters are recognized.
2819
2820 .vitem &%-bf%&&~<&'filename'&>
2821 .oindex "&%-bf%&"
2822 .cindex "filter" "testing"
2823 .cindex "testing" "filter file"
2824 .cindex "forward file" "testing"
2825 .cindex "testing" "forward file"
2826 .cindex "Sieve filter" "testing"
2827 This option runs Exim in user filter testing mode; the file is the filter file
2828 to be tested, and a test message must be supplied on the standard input. If
2829 there are no message-dependent tests in the filter, an empty file can be
2830 supplied.
2831
2832 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2833 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2834 filter and a user filter in the same run. For example:
2835 .code
2836 exim -bF /system/filter -bf /user/filter </test/message
2837 .endd
2838 This is helpful when the system filter adds header lines or sets filter
2839 variables that are used by the user filter.
2840
2841 If the test filter file does not begin with one of the special lines
2842 .code
2843 # Exim filter
2844 # Sieve filter
2845 .endd
2846 it is taken to be a normal &_.forward_& file, and is tested for validity under
2847 that interpretation. See sections &<<SECTitenonfilred>>& to
2848 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2849 redirection lists.
2850
2851 The result of an Exim command that uses &%-bf%&, provided no errors are
2852 detected, is a list of the actions that Exim would try to take if presented
2853 with the message for real. More details of filter testing are given in the
2854 separate document entitled &'Exim's interfaces to mail filtering'&.
2855
2856 When testing a filter file,
2857 .cindex "&""From""& line"
2858 .cindex "envelope sender"
2859 .oindex "&%-f%&" "for filter testing"
2860 the envelope sender can be set by the &%-f%& option,
2861 or by a &"From&~"& line at the start of the test message. Various parameters
2862 that would normally be taken from the envelope recipient address of the message
2863 can be set by means of additional command line options (see the next four
2864 options).
2865
2866 .vitem &%-bfd%&&~<&'domain'&>
2867 .oindex "&%-bfd%&"
2868 .vindex "&$qualify_domain$&"
2869 This sets the domain of the recipient address when a filter file is being
2870 tested by means of the &%-bf%& option. The default is the value of
2871 &$qualify_domain$&.
2872
2873 .vitem &%-bfl%&&~<&'local&~part'&>
2874 .oindex "&%-bfl%&"
2875 This sets the local part of the recipient address when a filter file is being
2876 tested by means of the &%-bf%& option. The default is the username of the
2877 process that calls Exim. A local part should be specified with any prefix or
2878 suffix stripped, because that is how it appears to the filter when a message is
2879 actually being delivered.
2880
2881 .vitem &%-bfp%&&~<&'prefix'&>
2882 .oindex "&%-bfp%&"
2883 This sets the prefix of the local part of the recipient address when a filter
2884 file is being tested by means of the &%-bf%& option. The default is an empty
2885 prefix.
2886
2887 .vitem &%-bfs%&&~<&'suffix'&>
2888 .oindex "&%-bfs%&"
2889 This sets the suffix of the local part of the recipient address when a filter
2890 file is being tested by means of the &%-bf%& option. The default is an empty
2891 suffix.
2892
2893 .vitem &%-bh%&&~<&'IP&~address'&>
2894 .oindex "&%-bh%&"
2895 .cindex "testing" "incoming SMTP"
2896 .cindex "SMTP" "testing incoming"
2897 .cindex "testing" "relay control"
2898 .cindex "relaying" "testing configuration"
2899 .cindex "policy control" "testing"
2900 .cindex "debugging" "&%-bh%& option"
2901 This option runs a fake SMTP session as if from the given IP address, using the
2902 standard input and output. The IP address may include a port number at the end,
2903 after a full stop. For example:
2904 .code
2905 exim -bh 10.9.8.7.1234
2906 exim -bh fe80::a00:20ff:fe86:a061.5678
2907 .endd
2908 When an IPv6 address is given, it is converted into canonical form. In the case
2909 of the second example above, the value of &$sender_host_address$& after
2910 conversion to the canonical form is
2911 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2912
2913 Comments as to what is going on are written to the standard error file. These
2914 include lines beginning with &"LOG"& for anything that would have been logged.
2915 This facility is provided for testing configuration options for incoming
2916 messages, to make sure they implement the required policy. For example, you can
2917 test your relay controls using &%-bh%&.
2918
2919 &*Warning 1*&:
2920 .cindex "RFC 1413"
2921 You can test features of the configuration that rely on ident (RFC 1413)
2922 information by using the &%-oMt%& option. However, Exim cannot actually perform
2923 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2924 connection.
2925
2926 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2927 are also skipped when testing using &%-bh%&. If you want these callouts to
2928 occur, use &%-bhc%& instead.
2929
2930 Messages supplied during the testing session are discarded, and nothing is
2931 written to any of the real log files. There may be pauses when DNS (and other)
2932 lookups are taking place, and of course these may time out. The &%-oMi%& option
2933 can be used to specify a specific IP interface and port if this is important,
2934 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2935 session were authenticated.
2936
2937 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2938 output just states whether a given recipient address from a given host is
2939 acceptable or not. See section &<<SECTcheckaccess>>&.
2940
2941 Features such as authentication and encryption, where the client input is not
2942 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2943 specialized SMTP test program such as
2944 &url(http://jetmore.org/john/code/#swaks,swaks).
2945
2946 .vitem &%-bhc%&&~<&'IP&~address'&>
2947 .oindex "&%-bhc%&"
2948 This option operates in the same way as &%-bh%&, except that address
2949 verification callouts are performed if required. This includes consulting and
2950 updating the callout cache database.
2951
2952 .vitem &%-bi%&
2953 .oindex "&%-bi%&"
2954 .cindex "alias file" "building"
2955 .cindex "building alias file"
2956 .cindex "Sendmail compatibility" "&%-bi%& option"
2957 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2958 Exim does not have the concept of a single alias file, and so it cannot mimic
2959 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2960 tend to appear in various scripts such as NIS make files, so the option must be
2961 recognized.
2962
2963 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2964 configuration option is run, under the uid and gid of the caller of Exim. If
2965 the &%-oA%& option is used, its value is passed to the command as an argument.
2966 The command set by &%bi_command%& may not contain arguments. The command can
2967 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2968 if this is required. If the &%bi_command%& option is not set, calling Exim with
2969 &%-bi%& is a no-op.
2970
2971 . // Keep :help first, then the rest in alphabetical order
2972 .vitem &%-bI:help%&
2973 .oindex "&%-bI:help%&"
2974 .cindex "querying exim information"
2975 We shall provide various options starting &`-bI:`& for querying Exim for
2976 information.  The output of many of these will be intended for machine
2977 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2978 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2979 options shall cause Exim to exit after producing the requested output.
2980
2981 .vitem &%-bI:dscp%&
2982 .oindex "&%-bI:dscp%&"
2983 .cindex "DSCP" "values"
2984 This option causes Exim to emit an alphabetically sorted list of all
2985 recognised DSCP names.
2986
2987 .vitem &%-bI:sieve%&
2988 .oindex "&%-bI:sieve%&"
2989 .cindex "Sieve filter" "capabilities"
2990 This option causes Exim to emit an alphabetically sorted list of all supported
2991 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2992 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2993 &`SIEVE`& capability response line.  As the precise list may depend upon
2994 compile-time build options, which this option will adapt to, this is the only
2995 way to guarantee a correct response.
2996
2997 .vitem &%-bm%&
2998 .oindex "&%-bm%&"
2999 .cindex "local message reception"
3000 This option runs an Exim receiving process that accepts an incoming,
3001 locally-generated message on the standard input. The recipients are given as the
3002 command arguments (except when &%-t%& is also present &-- see below). Each
3003 argument can be a comma-separated list of RFC 2822 addresses. This is the
3004 default option for selecting the overall action of an Exim call; it is assumed
3005 if no other conflicting option is present.
3006
3007 If any addresses in the message are unqualified (have no domain), they are
3008 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3009 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3010 suppressing this for special cases.
3011
3012 Policy checks on the contents of local messages can be enforced by means of
3013 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3014
3015 .cindex "return code" "for &%-bm%&"
3016 The return code is zero if the message is successfully accepted. Otherwise, the
3017 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3018
3019 The format
3020 .cindex "message" "format"
3021 .cindex "format" "message"
3022 .cindex "&""From""& line"
3023 .cindex "UUCP" "&""From""& line"
3024 .cindex "Sendmail compatibility" "&""From""& line"
3025 of the message must be as defined in RFC 2822, except that, for
3026 compatibility with Sendmail and Smail, a line in one of the forms
3027 .code
3028 From sender Fri Jan  5 12:55 GMT 1997
3029 From sender Fri, 5 Jan 97 12:55:01
3030 .endd
3031 (with the weekday optional, and possibly with additional text after the date)
3032 is permitted to appear at the start of the message. There appears to be no
3033 authoritative specification of the format of this line. Exim recognizes it by
3034 matching against the regular expression defined by the &%uucp_from_pattern%&
3035 option, which can be changed if necessary.
3036
3037 .oindex "&%-f%&" "overriding &""From""& line"
3038 The specified sender is treated as if it were given as the argument to the
3039 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3040 preference to the address taken from the message. The caller of Exim must be a
3041 trusted user for the sender of a message to be set in this way.
3042
3043 .vitem &%-bmalware%&&~<&'filename'&>
3044 .oindex "&%-bmalware%&"
3045 .cindex "testing", "malware"
3046 .cindex "malware scan test"
3047 This debugging option causes Exim to scan the given file or directory
3048 (depending on the used scanner interface),
3049 using the malware scanning framework.  The option of &%av_scanner%& influences
3050 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3051 the expansion should have defaults which apply to this invocation.  ACLs are
3052 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3053 will never be populated and &%-bmalware%& will fail.
3054
3055 Exim will have changed working directory before resolving the filename, so
3056 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3057 user when it tries to open the file, rather than as the invoking user.
3058 This option requires admin privileges.
3059
3060 The &%-bmalware%& option will not be extended to be more generally useful,
3061 there are better tools for file-scanning.  This option exists to help
3062 administrators verify their Exim and AV scanner configuration.
3063
3064 .vitem &%-bnq%&
3065 .oindex "&%-bnq%&"
3066 .cindex "address qualification, suppressing"
3067 By default, Exim automatically qualifies unqualified addresses (those
3068 without domains) that appear in messages that are submitted locally (that
3069 is, not over TCP/IP). This qualification applies both to addresses in
3070 envelopes, and addresses in header lines. Sender addresses are qualified using
3071 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3072 defaults to the value of &%qualify_domain%&).
3073
3074 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3075 being used to re-submit messages that originally came from remote hosts after
3076 content scanning, you probably do not want to qualify unqualified addresses in
3077 header lines. (Such lines will be present only if you have not enabled a header
3078 syntax check in the appropriate ACL.)
3079
3080 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3081 messages that originate on the local host. When this is used, unqualified
3082 addresses in the envelope provoke errors (causing message rejection) and
3083 unqualified addresses in header lines are left alone.
3084
3085
3086 .vitem &%-bP%&
3087 .oindex "&%-bP%&"
3088 .cindex "configuration options" "extracting"
3089 .cindex "options" "configuration &-- extracting"
3090 If this option is given with no arguments, it causes the values of all Exim's
3091 main configuration options to be written to the standard output. The values
3092 of one or more specific options can be requested by giving their names as
3093 arguments, for example:
3094 .code
3095 exim -bP qualify_domain hold_domains
3096 .endd
3097 .cindex "hiding configuration option values"
3098 .cindex "configuration options" "hiding value of"
3099 .cindex "options" "hiding value of"
3100 However, any option setting that is preceded by the word &"hide"& in the
3101 configuration file is not shown in full, except to an admin user. For other
3102 users, the output is as in this example:
3103 .code
3104 mysql_servers = <value not displayable>
3105 .endd
3106 If &%config%& is given as an argument, the config is
3107 output, as it was parsed, any include file resolved, any comment removed.
3108
3109 If &%config_file%& is given as an argument, the name of the run time
3110 configuration file is output. (&%configure_file%& works too, for
3111 backward compatibility.)
3112 If a list of configuration files was supplied, the value that is output here
3113 is the name of the file that was actually used.
3114
3115 .cindex "options" "hiding name of"
3116 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3117 name will not be output.
3118
3119 .cindex "daemon" "process id (pid)"
3120 .cindex "pid (process id)" "of daemon"
3121 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3122 directories where log files and daemon pid files are written are output,
3123 respectively. If these values are unset, log files are written in a
3124 sub-directory of the spool directory called &%log%&, and the pid file is
3125 written directly into the spool directory.
3126
3127 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3128 .code
3129 exim -bP +local_domains
3130 .endd
3131 it searches for a matching named list of any type (domain, host, address, or
3132 local part) and outputs what it finds.
3133
3134 .cindex "options" "router &-- extracting"
3135 .cindex "options" "transport &-- extracting"
3136 .cindex "options" "authenticator &-- extracting"
3137 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3138 followed by the name of an appropriate driver instance, the option settings for
3139 that driver are output. For example:
3140 .code
3141 exim -bP transport local_delivery
3142 .endd
3143 The generic driver options are output first, followed by the driver's private
3144 options. A list of the names of drivers of a particular type can be obtained by
3145 using one of the words &%router_list%&, &%transport_list%&, or
3146 &%authenticator_list%&, and a complete list of all drivers with their option
3147 settings can be obtained by using &%routers%&, &%transports%&, or
3148 &%authenticators%&.
3149
3150 .cindex "environment"
3151 If &%environment%& is given as an argument, the set of environment
3152 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3153 variables.
3154
3155 .cindex "options" "macro &-- extracting"
3156 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3157 are available, similarly to the drivers.  Because macros are sometimes used
3158 for storing passwords, this option is restricted.
3159 The output format is one item per line.
3160
3161 .vitem &%-bp%&
3162 .oindex "&%-bp%&"
3163 .cindex "queue" "listing messages on"
3164 .cindex "listing" "messages on the queue"
3165 This option requests a listing of the contents of the mail queue on the
3166 standard output. If the &%-bp%& option is followed by a list of message ids,
3167 just those messages are listed. By default, this option can be used only by an
3168 admin user. However, the &%queue_list_requires_admin%& option can be set false
3169 to allow any user to see the queue.
3170
3171 Each message on the queue is displayed as in the following example:
3172 .code
3173 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3174           red.king@looking-glass.fict.example
3175           <other addresses>
3176 .endd
3177 .cindex "message" "size in queue listing"
3178 .cindex "size" "of message"
3179 The first line contains the length of time the message has been on the queue
3180 (in this case 25 minutes), the size of the message (2.9K), the unique local
3181 identifier for the message, and the message sender, as contained in the
3182 envelope. For bounce messages, the sender address is empty, and appears as
3183 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3184 the default sender address, the user's login name is shown in parentheses
3185 before the sender address.
3186
3187 .cindex "frozen messages" "in queue listing"
3188 If the message is frozen (attempts to deliver it are suspended) then the text
3189 &"*** frozen ***"& is displayed at the end of this line.
3190
3191 The recipients of the message (taken from the envelope, not the headers) are
3192 displayed on subsequent lines. Those addresses to which the message has already
3193 been delivered are marked with the letter D. If an original address gets
3194 expanded into several addresses via an alias or forward file, the original is
3195 displayed with a D only when deliveries for all of its child addresses are
3196 complete.
3197
3198
3199 .vitem &%-bpa%&
3200 .oindex "&%-bpa%&"
3201 This option operates like &%-bp%&, but in addition it shows delivered addresses
3202 that were generated from the original top level address(es) in each message by
3203 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3204 of just &"D"&.
3205
3206
3207 .vitem &%-bpc%&
3208 .oindex "&%-bpc%&"
3209 .cindex "queue" "count of messages on"
3210 This option counts the number of messages on the queue, and writes the total
3211 to the standard output. It is restricted to admin users, unless
3212 &%queue_list_requires_admin%& is set false.
3213
3214
3215 .vitem &%-bpr%&
3216 .oindex "&%-bpr%&"
3217 This option operates like &%-bp%&, but the output is not sorted into
3218 chronological order of message arrival. This can speed it up when there are
3219 lots of messages on the queue, and is particularly useful if the output is
3220 going to be post-processed in a way that doesn't need the sorting.
3221
3222 .vitem &%-bpra%&
3223 .oindex "&%-bpra%&"
3224 This option is a combination of &%-bpr%& and &%-bpa%&.
3225
3226 .vitem &%-bpru%&
3227 .oindex "&%-bpru%&"
3228 This option is a combination of &%-bpr%& and &%-bpu%&.
3229
3230
3231 .vitem &%-bpu%&
3232 .oindex "&%-bpu%&"
3233 This option operates like &%-bp%& but shows only undelivered top-level
3234 addresses for each message displayed. Addresses generated by aliasing or
3235 forwarding are not shown, unless the message was deferred after processing by a
3236 router with the &%one_time%& option set.
3237
3238
3239 .vitem &%-brt%&
3240 .oindex "&%-brt%&"
3241 .cindex "testing" "retry configuration"
3242 .cindex "retry" "configuration testing"
3243 This option is for testing retry rules, and it must be followed by up to three
3244 arguments. It causes Exim to look for a retry rule that matches the values
3245 and to write it to the standard output. For example:
3246 .code
3247 exim -brt bach.comp.mus.example
3248 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3249 .endd
3250 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3251 argument, which is required, can be a complete address in the form
3252 &'local_part@domain'&, or it can be just a domain name. If the second argument
3253 contains a dot, it is interpreted as an optional second domain name; if no
3254 retry rule is found for the first argument, the second is tried. This ties in
3255 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3256 rule is found that matches the host, one that matches the mail domain is
3257 sought. Finally, an argument that is the name of a specific delivery error, as
3258 used in setting up retry rules, can be given. For example:
3259 .code
3260 exim -brt haydn.comp.mus.example quota_3d
3261 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3262 .endd
3263
3264 .vitem &%-brw%&
3265 .oindex "&%-brw%&"
3266 .cindex "testing" "rewriting"
3267 .cindex "rewriting" "testing"
3268 This option is for testing address rewriting rules, and it must be followed by
3269 a single argument, consisting of either a local part without a domain, or a
3270 complete address with a fully qualified domain. Exim outputs how this address
3271 would be rewritten for each possible place it might appear. See chapter
3272 &<<CHAPrewrite>>& for further details.
3273
3274 .vitem &%-bS%&
3275 .oindex "&%-bS%&"
3276 .cindex "SMTP" "batched incoming"
3277 .cindex "batched SMTP input"
3278 This option is used for batched SMTP input, which is an alternative interface
3279 for non-interactive local message submission. A number of messages can be
3280 submitted in a single run. However, despite its name, this is not really SMTP
3281 input. Exim reads each message's envelope from SMTP commands on the standard
3282 input, but generates no responses. If the caller is trusted, or
3283 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3284 believed; otherwise the sender is always the caller of Exim.
3285
3286 The message itself is read from the standard input, in SMTP format (leading
3287 dots doubled), terminated by a line containing just a single dot. An error is
3288 provoked if the terminating dot is missing. A further message may then follow.
3289
3290 As for other local message submissions, the contents of incoming batch SMTP
3291 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3292 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3293 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3294
3295 Some other SMTP commands are recognized in the input. HELO and EHLO act
3296 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3297 QUIT quits, ignoring the rest of the standard input.
3298
3299 .cindex "return code" "for &%-bS%&"
3300 If any error is encountered, reports are written to the standard output and
3301 error streams, and Exim gives up immediately. The return code is 0 if no error
3302 was detected; it is 1 if one or more messages were accepted before the error
3303 was detected; otherwise it is 2.
3304
3305 More details of input using batched SMTP are given in section
3306 &<<SECTincomingbatchedSMTP>>&.
3307
3308 .vitem &%-bs%&
3309 .oindex "&%-bs%&"
3310 .cindex "SMTP" "local input"
3311 .cindex "local SMTP input"
3312 This option causes Exim to accept one or more messages by reading SMTP commands
3313 on the standard input, and producing SMTP replies on the standard output. SMTP
3314 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3315 Some user agents use this interface as a way of passing locally-generated
3316 messages to the MTA.
3317
3318 In
3319 .cindex "sender" "source of"
3320 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3321 set, the senders of messages are taken from the SMTP MAIL commands.
3322 Otherwise the content of these commands is ignored and the sender is set up as
3323 the calling user. Unqualified addresses are automatically qualified using
3324 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3325 &%-bnq%& option is used.
3326
3327 .cindex "inetd"
3328 The
3329 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3330 using a listening daemon. Exim can distinguish the two cases by checking
3331 whether the standard input is a TCP/IP socket. When Exim is called from
3332 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3333 above concerning senders and qualification do not apply. In this situation,
3334 Exim behaves in exactly the same way as it does when receiving a message via
3335 the listening daemon.
3336
3337 .vitem &%-bt%&
3338 .oindex "&%-bt%&"
3339 .cindex "testing" "addresses"
3340 .cindex "address" "testing"
3341 This option runs Exim in address testing mode, in which each argument is taken
3342 as a recipient address to be tested for deliverability. The results are
3343 written to the standard output. If a test fails, and the caller is not an admin
3344 user, no details of the failure are output, because these might contain
3345 sensitive information such as usernames and passwords for database lookups.
3346
3347 If no arguments are given, Exim runs in an interactive manner, prompting with a
3348 right angle bracket for addresses to be tested.
3349
3350 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3351 &[readline()]& function, because it is running as &'root'& and there are
3352 security issues.
3353
3354 Each address is handled as if it were the recipient address of a message
3355 (compare the &%-bv%& option). It is passed to the routers and the result is
3356 written to the standard output. However, any router that has
3357 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3358 genuine routing tests if your first router passes everything to a scanner
3359 program.
3360
3361 .cindex "return code" "for &%-bt%&"
3362 The return code is 2 if any address failed outright; it is 1 if no address
3363 failed outright but at least one could not be resolved for some reason. Return
3364 code 0 is given only when all addresses succeed.
3365
3366 .cindex "duplicate addresses"
3367 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3368 addresses after routing is complete, so that only one delivery takes place.
3369 This does not happen when testing with &%-bt%&; the full results of routing are
3370 always shown.
3371
3372 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3373 routers in the configuration makes any tests on the sender address of a
3374 message,
3375 .oindex "&%-f%&" "for address testing"
3376 you can use the &%-f%& option to set an appropriate sender when running
3377 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3378 default qualifying domain. However, if you have set up (for example) routers
3379 whose behaviour depends on the contents of an incoming message, you cannot test
3380 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3381 doing such tests.
3382
3383 .vitem &%-bV%&
3384 .oindex "&%-bV%&"
3385 .cindex "version number of Exim"
3386 This option causes Exim to write the current version number, compilation
3387 number, and compilation date of the &'exim'& binary to the standard output.
3388 It also lists the DBM library that is being used, the optional modules (such as
3389 specific lookup types), the drivers that are included in the binary, and the
3390 name of the run time configuration file that is in use.
3391
3392 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3393 configuration file. However, this is a static check only. It cannot check
3394 values that are to be expanded. For example, although a misspelt ACL verb is
3395 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3396 alone to discover (for example) all the typos in the configuration; some
3397 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3398 dynamic testing facilities.
3399
3400 .vitem &%-bv%&
3401 .oindex "&%-bv%&"
3402 .cindex "verifying address" "using &%-bv%&"
3403 .cindex "address" "verification"
3404 This option runs Exim in address verification mode, in which each argument is
3405 taken as a recipient address to be verified by the routers. (This does
3406 not involve any verification callouts). During normal operation, verification
3407 happens mostly as a consequence processing a &%verify%& condition in an ACL
3408 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3409 including callouts, see the &%-bh%& and &%-bhc%& options.
3410
3411 If verification fails, and the caller is not an admin user, no details of the
3412 failure are output, because these might contain sensitive information such as
3413 usernames and passwords for database lookups.
3414
3415 If no arguments are given, Exim runs in an interactive manner, prompting with a
3416 right angle bracket for addresses to be verified.
3417
3418 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3419 &[readline()]& function, because it is running as &'exim'& and there are
3420 security issues.
3421
3422 Verification differs from address testing (the &%-bt%& option) in that routers
3423 that have &%no_verify%& set are skipped, and if the address is accepted by a
3424 router that has &%fail_verify%& set, verification fails. The address is
3425 verified as a recipient if &%-bv%& is used; to test verification for a sender
3426 address, &%-bvs%& should be used.
3427
3428 If the &%-v%& option is not set, the output consists of a single line for each
3429 address, stating whether it was verified or not, and giving a reason in the
3430 latter case. Without &%-v%&, generating more than one address by redirection
3431 causes verification to end successfully, without considering the generated
3432 addresses. However, if just one address is generated, processing continues,
3433 and the generated address must verify successfully for the overall verification
3434 to succeed.
3435
3436 When &%-v%& is set, more details are given of how the address has been handled,
3437 and in the case of address redirection, all the generated addresses are also
3438 considered. Verification may succeed for some and fail for others.
3439
3440 The
3441 .cindex "return code" "for &%-bv%&"
3442 return code is 2 if any address failed outright; it is 1 if no address
3443 failed outright but at least one could not be resolved for some reason. Return
3444 code 0 is given only when all addresses succeed.
3445
3446 If any of the routers in the configuration makes any tests on the sender
3447 address of a message, you should use the &%-f%& option to set an appropriate
3448 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3449 calling user at the default qualifying domain.
3450
3451 .vitem &%-bvs%&
3452 .oindex "&%-bvs%&"
3453 This option acts like &%-bv%&, but verifies the address as a sender rather
3454 than a recipient address. This affects any rewriting and qualification that
3455 might happen.
3456
3457 .vitem &%-bw%&
3458 .oindex "&%-bw%&"
3459 .cindex "daemon"
3460 .cindex "inetd"
3461 .cindex "inetd" "wait mode"
3462 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3463 similarly to the &%-bd%& option.  All port specifications on the command-line
3464 and in the configuration file are ignored.  Queue-running may not be specified.
3465
3466 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3467 listening for connections.  This permits the system to start up and have
3468 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3469 each port only when the first connection is received.
3470
3471 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3472 which the daemon will exit, which should cause inetd to listen once more.
3473
3474 .vitem &%-C%&&~<&'filelist'&>
3475 .oindex "&%-C%&"
3476 .cindex "configuration file" "alternate"
3477 .cindex "CONFIGURE_FILE"
3478 .cindex "alternate configuration file"
3479 This option causes Exim to find the run time configuration file from the given
3480 list instead of from the list specified by the CONFIGURE_FILE
3481 compile-time setting. Usually, the list will consist of just a single file
3482 name, but it can be a colon-separated list of names. In this case, the first
3483 file that exists is used. Failure to open an existing file stops Exim from
3484 proceeding any further along the list, and an error is generated.
3485
3486 When this option is used by a caller other than root, and the list is different
3487 from the compiled-in list, Exim gives up its root privilege immediately, and
3488 runs with the real and effective uid and gid set to those of the caller.
3489 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3490 file contains a list of full pathnames, one per line, for configuration files
3491 which are trusted. Root privilege is retained for any configuration file so
3492 listed, as long as the caller is the Exim user (or the user specified in the
3493 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3494 not writeable by inappropriate users or groups.
3495
3496 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3497 configuration using &%-C%& right through message reception and delivery,
3498 even if the caller is root. The reception works, but by that time, Exim is
3499 running as the Exim user, so when it re-executes to regain privilege for the
3500 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3501 test reception and delivery using two separate commands (one to put a message
3502 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3503
3504 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3505 prefix string with which any file named in a &%-C%& command line option
3506 must start. In addition, the file name must not contain the sequence &`/../`&.
3507 However, if the value of the &%-C%& option is identical to the value of
3508 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3509 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3510 unset, any file name can be used with &%-C%&.
3511
3512 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3513 to a directory to which only root has access. This prevents someone who has
3514 broken into the Exim account from running a privileged Exim with an arbitrary
3515 configuration file.
3516
3517 The &%-C%& facility is useful for ensuring that configuration files are
3518 syntactically correct, but cannot be used for test deliveries, unless the
3519 caller is privileged, or unless it is an exotic configuration that does not
3520 require privilege. No check is made on the owner or group of the files
3521 specified by this option.
3522
3523
3524 .vitem &%-D%&<&'macro'&>=<&'value'&>
3525 .oindex "&%-D%&"
3526 .cindex "macro" "setting on command line"
3527 This option can be used to override macro definitions in the configuration file
3528 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3529 unprivileged caller, it causes Exim to give up its root privilege.
3530 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3531 completely disabled, and its use causes an immediate error exit.
3532
3533 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3534 colon-separated list of macros which are considered safe and, if &%-D%& only
3535 supplies macros from this list, and the values are acceptable, then Exim will
3536 not give up root privilege if the caller is root, the Exim run-time user, or
3537 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3538 to be removed in the future.  Acceptable values for the macros satisfy the
3539 regexp: &`^[A-Za-z0-9_/.-]*$`&
3540
3541 The entire option (including equals sign if present) must all be within one
3542 command line item. &%-D%& can be used to set the value of a macro to the empty
3543 string, in which case the equals sign is optional. These two commands are
3544 synonymous:
3545 .code
3546 exim -DABC  ...
3547 exim -DABC= ...
3548 .endd
3549 To include spaces in a macro definition item, quotes must be used. If you use
3550 quotes, spaces are permitted around the macro name and the equals sign. For
3551 example:
3552 .code
3553 exim '-D ABC = something' ...
3554 .endd
3555 &%-D%& may be repeated up to 10 times on a command line.
3556 Only macro names up to 22 letters long can be set.
3557
3558
3559 .vitem &%-d%&<&'debug&~options'&>
3560 .oindex "&%-d%&"
3561 .cindex "debugging" "list of selectors"
3562 .cindex "debugging" "&%-d%& option"
3563 This option causes debugging information to be written to the standard
3564 error stream. It is restricted to admin users because debugging output may show
3565 database queries that contain password information. Also, the details of users'
3566 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3567 writes an error message to the standard error stream and exits with a non-zero
3568 return code.
3569
3570 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3571 standard debugging data is output. This can be reduced, or increased to include
3572 some more rarely needed information, by directly following &%-d%& with a string
3573 made up of names preceded by plus or minus characters. These add or remove sets
3574 of debugging data, respectively. For example, &%-d+filter%& adds filter
3575 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3576 no spaces are allowed in the debug setting. The available debugging categories
3577 are:
3578 .display
3579 &`acl            `& ACL interpretation
3580 &`auth           `& authenticators
3581 &`deliver        `& general delivery logic
3582 &`dns            `& DNS lookups (see also resolver)
3583 &`dnsbl          `& DNS black list (aka RBL) code
3584 &`exec           `& arguments for &[execv()]& calls
3585 &`expand         `& detailed debugging for string expansions
3586 &`filter         `& filter handling
3587 &`hints_lookup   `& hints data lookups
3588 &`host_lookup    `& all types of name-to-IP address handling
3589 &`ident          `& ident lookup
3590 &`interface      `& lists of local interfaces
3591 &`lists          `& matching things in lists
3592 &`load           `& system load checks
3593 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3594                     &<<CHAPlocalscan>>&)
3595 &`lookup         `& general lookup code and all lookups
3596 &`memory         `& memory handling
3597 &`pid            `& add pid to debug output lines
3598 &`process_info   `& setting info for the process log
3599 &`queue_run      `& queue runs
3600 &`receive        `& general message reception logic
3601 &`resolver       `& turn on the DNS resolver's debugging output
3602 &`retry          `& retry handling
3603 &`rewrite        `& address rewriting
3604 &`route          `& address routing
3605 &`timestamp      `& add timestamp to debug output lines
3606 &`tls            `& TLS logic
3607 &`transport      `& transports
3608 &`uid            `& changes of uid/gid and looking up uid/gid
3609 &`verify         `& address verification logic
3610 &`all            `& almost all of the above (see below), and also &%-v%&
3611 .endd
3612 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3613 for &`-all`&. The reason for this is that &`+all`& is something that people
3614 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3615 is included, an awful lot of output that is very rarely of interest is
3616 generated, so it now has to be explicitly requested. However, &`-all`& does
3617 turn everything off.
3618
3619 .cindex "resolver, debugging output"
3620 .cindex "DNS resolver, debugging output"
3621 The &`resolver`& option produces output only if the DNS resolver was compiled
3622 with DEBUG enabled. This is not the case in some operating systems. Also,
3623 unfortunately, debugging output from the DNS resolver is written to stdout
3624 rather than stderr.
3625
3626 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3627 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3628 However, the &`pid`& selector is forced when debugging is turned on for a
3629 daemon, which then passes it on to any re-executed Exims. Exim also
3630 automatically adds the pid to debug lines when several remote deliveries are
3631 run in parallel.
3632
3633 The &`timestamp`& selector causes the current time to be inserted at the start
3634 of all debug output lines. This can be useful when trying to track down delays
3635 in processing.
3636
3637 If the &%debug_print%& option is set in any driver, it produces output whenever
3638 any debugging is selected, or if &%-v%& is used.
3639
3640 .vitem &%-dd%&<&'debug&~options'&>
3641 .oindex "&%-dd%&"
3642 This option behaves exactly like &%-d%& except when used on a command that
3643 starts a daemon process. In that case, debugging is turned off for the
3644 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3645 behaviour of the daemon without creating as much output as full debugging does.
3646
3647 .vitem &%-dropcr%&
3648 .oindex "&%-dropcr%&"
3649 This is an obsolete option that is now a no-op. It used to affect the way Exim
3650 handled CR and LF characters in incoming messages. What happens now is
3651 described in section &<<SECTlineendings>>&.
3652
3653 .vitem &%-E%&
3654 .oindex "&%-E%&"
3655 .cindex "bounce message" "generating"
3656 This option specifies that an incoming message is a locally-generated delivery
3657 failure report. It is used internally by Exim when handling delivery failures
3658 and is not intended for external use. Its only effect is to stop Exim
3659 generating certain messages to the postmaster, as otherwise message cascades
3660 could occur in some situations. As part of the same option, a message id may
3661 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3662 new message contains the id, following &"R="&, as a cross-reference.
3663
3664 .vitem &%-e%&&'x'&
3665 .oindex "&%-e%&&'x'&"
3666 There are a number of Sendmail options starting with &%-oe%& which seem to be
3667 called by various programs without the leading &%o%& in the option. For
3668 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3669 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3670
3671 .vitem &%-F%&&~<&'string'&>
3672 .oindex "&%-F%&"
3673 .cindex "sender" "name"
3674 .cindex "name" "of sender"
3675 This option sets the sender's full name for use when a locally-generated
3676 message is being accepted. In the absence of this option, the user's &'gecos'&
3677 entry from the password data is used. As users are generally permitted to alter
3678 their &'gecos'& entries, no security considerations are involved. White space
3679 between &%-F%& and the <&'string'&> is optional.
3680
3681 .vitem &%-f%&&~<&'address'&>
3682 .oindex "&%-f%&"
3683 .cindex "sender" "address"
3684 .cindex "address" "sender"
3685 .cindex "trusted users"
3686 .cindex "envelope sender"
3687 .cindex "user" "trusted"
3688 This option sets the address of the envelope sender of a locally-generated
3689 message (also known as the return path). The option can normally be used only
3690 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3691 users to use it.
3692
3693 Processes running as root or the Exim user are always trusted. Other
3694 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3695 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3696 of a local message is set to the caller's login name at the default qualify
3697 domain.
3698
3699 There is one exception to the restriction on the use of &%-f%&: an empty sender
3700 can be specified by any user, trusted or not, to create a message that can
3701 never provoke a bounce. An empty sender can be specified either as an empty
3702 string, or as a pair of angle brackets with nothing between them, as in these
3703 examples of shell commands:
3704 .code
3705 exim -f '<>' user@domain
3706 exim -f "" user@domain
3707 .endd
3708 In addition, the use of &%-f%& is not restricted when testing a filter file
3709 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3710 &%-bv%& options.
3711
3712 Allowing untrusted users to change the sender address does not of itself make
3713 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3714 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3715 though this can be overridden by setting &%no_local_from_check%&.
3716
3717 White
3718 .cindex "&""From""& line"
3719 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3720 given as two arguments or one combined argument). The sender of a
3721 locally-generated message can also be set (when permitted) by an initial
3722 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3723 if &%-f%& is also present, it overrides &"From&~"&.
3724
3725 .vitem &%-G%&
3726 .oindex "&%-G%&"
3727 .cindex "submission fixups, suppressing (command-line)"
3728 This option is equivalent to an ACL applying:
3729 .code
3730 control = suppress_local_fixups
3731 .endd
3732 for every message received.  Note that Sendmail will complain about such
3733 bad formatting, where Exim silently just does not fix it up.  This may change
3734 in future.
3735
3736 As this affects audit information, the caller must be a trusted user to use
3737 this option.
3738
3739 .vitem &%-h%&&~<&'number'&>
3740 .oindex "&%-h%&"
3741 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3742 This option is accepted for compatibility with Sendmail, but has no effect. (In
3743 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3744 headers.)
3745
3746 .vitem &%-i%&
3747 .oindex "&%-i%&"
3748 .cindex "Solaris" "&'mail'& command"
3749 .cindex "dot" "in incoming non-SMTP message"
3750 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3751 line by itself should not terminate an incoming, non-SMTP message. I can find
3752 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3753 command in Solaris 2.4 uses it. See also &%-ti%&.
3754
3755 .vitem &%-L%&&~<&'tag'&>
3756 .oindex "&%-L%&"
3757 .cindex "syslog" "process name; set with flag"
3758 This option is equivalent to setting &%syslog_processname%& in the config
3759 file and setting &%log_file_path%& to &`syslog`&.
3760 Its use is restricted to administrators.  The configuration file has to be
3761 read and parsed, to determine access rights, before this is set and takes
3762 effect, so early configuration file errors will not honour this flag.
3763
3764 The tag should not be longer than 32 characters.
3765
3766 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3767 .oindex "&%-M%&"
3768 .cindex "forcing delivery"
3769 .cindex "delivery" "forcing attempt"
3770 .cindex "frozen messages" "forcing delivery"
3771 This option requests Exim to run a delivery attempt on each message in turn. If
3772 any of the messages are frozen, they are automatically thawed before the
3773 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3774 and &%hold_domains%& are ignored.
3775
3776 Retry
3777 .cindex "hints database" "overriding retry hints"
3778 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3779 the normal retry time has not yet been reached. This option requires the caller
3780 to be an admin user. However, there is an option called &%prod_requires_admin%&
3781 which can be set false to relax this restriction (and also the same requirement
3782 for the &%-q%&, &%-R%&, and &%-S%& options).
3783
3784 The deliveries happen synchronously, that is, the original Exim process does
3785 not terminate until all the delivery attempts have finished. No output is
3786 produced unless there is a serious error. If you want to see what is happening,
3787 use the &%-v%& option as well, or inspect Exim's main log.
3788
3789 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3790 .oindex "&%-Mar%&"
3791 .cindex "message" "adding recipients"
3792 .cindex "recipient" "adding"
3793 This option requests Exim to add the addresses to the list of recipients of the
3794 message (&"ar"& for &"add recipients"&). The first argument must be a message
3795 id, and the remaining ones must be email addresses. However, if the message is
3796 active (in the middle of a delivery attempt), it is not altered. This option
3797 can be used only by an admin user.
3798
3799 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3800         &~<&'message&~id'&>"
3801 .oindex "&%-MC%&"
3802 .cindex "SMTP" "passed connection"
3803 .cindex "SMTP" "multiple deliveries"
3804 .cindex "multiple SMTP deliveries"
3805 This option is not intended for use by external callers. It is used internally
3806 by Exim to invoke another instance of itself to deliver a waiting message using
3807 an existing SMTP connection, which is passed as the standard input. Details are
3808 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3809 must be root or the Exim user in order to use it.
3810
3811 .vitem &%-MCA%&
3812 .oindex "&%-MCA%&"
3813 This option is not intended for use by external callers. It is used internally
3814 by Exim in conjunction with the &%-MC%& option. It signifies that the
3815 connection to the remote host has been authenticated.
3816
3817 .vitem &%-MCD%&
3818 .oindex "&%-MCD%&"
3819 This option is not intended for use by external callers. It is used internally
3820 by Exim in conjunction with the &%-MC%& option. It signifies that the
3821 remote host supports the ESMTP &_DSN_& extension.
3822
3823 .vitem &%-MCG%&&~<&'queue&~name'&>
3824 .oindex "&%-MCG%&"
3825 This option is not intended for use by external callers. It is used internally
3826 by Exim in conjunction with the &%-MC%& option. It signifies that an
3827 alternate queue is used, named by the following argument.
3828
3829 .vitem &%-MCK%&
3830 .oindex "&%-MCK%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option. It signifies that an
3833 remote host supports the ESMTP &_CHUNKING_& extension.
3834
3835 .vitem &%-MCP%&
3836 .oindex "&%-MCP%&"
3837 This option is not intended for use by external callers. It is used internally
3838 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3839 which Exim is connected supports pipelining.
3840
3841 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3842 .oindex "&%-MCQ%&"
3843 This option is not intended for use by external callers. It is used internally
3844 by Exim in conjunction with the &%-MC%& option when the original delivery was
3845 started by a queue runner. It passes on the process id of the queue runner,
3846 together with the file descriptor number of an open pipe. Closure of the pipe
3847 signals the final completion of the sequence of processes that are passing
3848 messages through the same SMTP connection.
3849
3850 .vitem &%-MCS%&
3851 .oindex "&%-MCS%&"
3852 This option is not intended for use by external callers. It is used internally
3853 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3854 SMTP SIZE option should be used on messages delivered down the existing
3855 connection.
3856
3857 .vitem &%-MCT%&
3858 .oindex "&%-MCT%&"
3859 This option is not intended for use by external callers. It is used internally
3860 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3861 host to which Exim is connected supports TLS encryption.
3862
3863 .new
3864 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3865 .oindex "&%-MCt%&"
3866 This option is not intended for use by external callers. It is used internally
3867 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3868 connection is being proxied by a parent process for handling TLS encryption.
3869 The arguments give the local address and port being proxied, and the TLS cipher.
3870 .wen
3871
3872 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3873 .oindex "&%-Mc%&"
3874 .cindex "hints database" "not overridden by &%-Mc%&"
3875 .cindex "delivery" "manually started &-- not forced"
3876 This option requests Exim to run a delivery attempt on each message in turn,
3877 but unlike the &%-M%& option, it does check for retry hints, and respects any
3878 that are found. This option is not very useful to external callers. It is
3879 provided mainly for internal use by Exim when it needs to re-invoke itself in
3880 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3881 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3882 respects retry times and other options such as &%hold_domains%& that are
3883 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3884 If you want to run a specific delivery as if in a queue run, you should use
3885 &%-q%& with a message id argument. A distinction between queue run deliveries
3886 and other deliveries is made in one or two places.
3887
3888 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3889 .oindex "&%-Mes%&"
3890 .cindex "message" "changing sender"
3891 .cindex "sender" "changing"
3892 This option requests Exim to change the sender address in the message to the
3893 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3894 &"edit sender"&). There must be exactly two arguments. The first argument must
3895 be a message id, and the second one an email address. However, if the message
3896 is active (in the middle of a delivery attempt), its status is not altered.
3897 This option can be used only by an admin user.
3898
3899 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3900 .oindex "&%-Mf%&"
3901 .cindex "freezing messages"
3902 .cindex "message" "manually freezing"
3903 This option requests Exim to mark each listed message as &"frozen"&. This
3904 prevents any delivery attempts taking place until the message is &"thawed"&,
3905 either manually or as a result of the &%auto_thaw%& configuration option.
3906 However, if any of the messages are active (in the middle of a delivery
3907 attempt), their status is not altered. This option can be used only by an admin
3908 user.
3909
3910 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3911 .oindex "&%-Mg%&"
3912 .cindex "giving up on messages"
3913 .cindex "message" "abandoning delivery attempts"
3914 .cindex "delivery" "abandoning further attempts"
3915 This option requests Exim to give up trying to deliver the listed messages,
3916 including any that are frozen. However, if any of the messages are active,
3917 their status is not altered. For non-bounce messages, a delivery error message
3918 is sent to the sender, containing the text &"cancelled by administrator"&.
3919 Bounce messages are just discarded. This option can be used only by an admin
3920 user.
3921
3922 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3923 .oindex "&%-Mmad%&"
3924 .cindex "delivery" "cancelling all"
3925 This option requests Exim to mark all the recipient addresses in the messages
3926 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3927 message is active (in the middle of a delivery attempt), its status is not
3928 altered. This option can be used only by an admin user.
3929
3930 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3931 .oindex "&%-Mmd%&"
3932 .cindex "delivery" "cancelling by address"
3933 .cindex "recipient" "removing"
3934 .cindex "removing recipients"
3935 This option requests Exim to mark the given addresses as already delivered
3936 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3937 the remaining ones must be email addresses. These are matched to recipient
3938 addresses in the message in a case-sensitive manner. If the message is active
3939 (in the middle of a delivery attempt), its status is not altered. This option
3940 can be used only by an admin user.
3941
3942 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3943 .oindex "&%-Mrm%&"
3944 .cindex "removing messages"
3945 .cindex "abandoning mail"
3946 .cindex "message" "manually discarding"
3947 This option requests Exim to remove the given messages from the queue. No
3948 bounce messages are sent; each message is simply forgotten. However, if any of
3949 the messages are active, their status is not altered. This option can be used
3950 only by an admin user or by the user who originally caused the message to be
3951 placed on the queue.
3952
3953 .vitem &%-Mset%&&~<&'message&~id'&>
3954 .oindex "&%-Mset%&
3955 .cindex "testing" "string expansion"
3956 .cindex "expansion" "testing"
3957 This option is useful only in conjunction with &%-be%& (that is, when testing
3958 string expansions). Exim loads the given message from its spool before doing
3959 the test expansions, thus setting message-specific variables such as
3960 &$message_size$& and the header variables. The &$recipients$& variable is made
3961 available. This feature is provided to make it easier to test expansions that
3962 make use of these variables. However, this option can be used only by an admin
3963 user. See also &%-bem%&.
3964
3965 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3966 .oindex "&%-Mt%&"
3967 .cindex "thawing messages"
3968 .cindex "unfreezing messages"
3969 .cindex "frozen messages" "thawing"
3970 .cindex "message" "thawing frozen"
3971 This option requests Exim to &"thaw"& any of the listed messages that are
3972 &"frozen"&, so that delivery attempts can resume. However, if any of the
3973 messages are active, their status is not altered. This option can be used only
3974 by an admin user.
3975
3976 .vitem &%-Mvb%&&~<&'message&~id'&>
3977 .oindex "&%-Mvb%&"
3978 .cindex "listing" "message body"
3979 .cindex "message" "listing body of"
3980 This option causes the contents of the message body (-D) spool file to be
3981 written to the standard output. This option can be used only by an admin user.
3982
3983 .vitem &%-Mvc%&&~<&'message&~id'&>
3984 .oindex "&%-Mvc%&"
3985 .cindex "message" "listing in RFC 2822 format"
3986 .cindex "listing" "message in RFC 2822 format"
3987 This option causes a copy of the complete message (header lines plus body) to
3988 be written to the standard output in RFC 2822 format. This option can be used
3989 only by an admin user.
3990
3991 .vitem &%-Mvh%&&~<&'message&~id'&>
3992 .oindex "&%-Mvh%&"
3993 .cindex "listing" "message headers"
3994 .cindex "header lines" "listing"
3995 .cindex "message" "listing header lines"
3996 This option causes the contents of the message headers (-H) spool file to be
3997 written to the standard output. This option can be used only by an admin user.
3998
3999 .vitem &%-Mvl%&&~<&'message&~id'&>
4000 .oindex "&%-Mvl%&"
4001 .cindex "listing" "message log"
4002 .cindex "message" "listing message log"
4003 This option causes the contents of the message log spool file to be written to
4004 the standard output. This option can be used only by an admin user.
4005
4006 .vitem &%-m%&
4007 .oindex "&%-m%&"
4008 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4009 treats it that way too.
4010
4011 .vitem &%-N%&
4012 .oindex "&%-N%&"
4013 .cindex "debugging" "&%-N%& option"
4014 .cindex "debugging" "suppressing delivery"
4015 This is a debugging option that inhibits delivery of a message at the transport
4016 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4017 it just doesn't actually transport the message, but instead behaves as if it
4018 had successfully done so. However, it does not make any updates to the retry
4019 database, and the log entries for deliveries are flagged with &"*>"& rather
4020 than &"=>"&.
4021
4022 Because &%-N%& discards any message to which it applies, only root or the Exim
4023 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4024 words, an ordinary user can use it only when supplying an incoming message to
4025 which it will apply. Although transportation never fails when &%-N%& is set, an
4026 address may be deferred because of a configuration problem on a transport, or a
4027 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4028 the message, and applies to any subsequent delivery attempts that may happen
4029 for that message.
4030
4031 .vitem &%-n%&
4032 .oindex "&%-n%&"
4033 This option is interpreted by Sendmail to mean &"no aliasing"&.
4034 For normal modes of operation, it is ignored by Exim.
4035 When combined with &%-bP%& it makes the output more terse (suppresses
4036 option names, environment values and config pretty printing).
4037
4038 .vitem &%-O%&&~<&'data'&>
4039 .oindex "&%-O%&"
4040 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4041 Exim.
4042
4043 .vitem &%-oA%&&~<&'file&~name'&>
4044 .oindex "&%-oA%&"
4045 .cindex "Sendmail compatibility" "&%-oA%& option"
4046 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4047 alternative alias file name. Exim handles &%-bi%& differently; see the
4048 description above.
4049
4050 .vitem &%-oB%&&~<&'n'&>
4051 .oindex "&%-oB%&"
4052 .cindex "SMTP" "passed connection"
4053 .cindex "SMTP" "multiple deliveries"
4054 .cindex "multiple SMTP deliveries"
4055 This is a debugging option which limits the maximum number of messages that can
4056 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4057 transport. If <&'n'&> is omitted, the limit is set to 1.
4058
4059 .vitem &%-odb%&
4060 .oindex "&%-odb%&"
4061 .cindex "background delivery"
4062 .cindex "delivery" "in the background"
4063 This option applies to all modes in which Exim accepts incoming messages,
4064 including the listening daemon. It requests &"background"& delivery of such
4065 messages, which means that the accepting process automatically starts a
4066 delivery process for each message received, but does not wait for the delivery
4067 processes to finish.
4068
4069 When all the messages have been received, the reception process exits,
4070 leaving the delivery processes to finish in their own time. The standard output
4071 and error streams are closed at the start of each delivery process.
4072 This is the default action if none of the &%-od%& options are present.
4073
4074 If one of the queueing options in the configuration file
4075 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4076 overrides it if &%queue_only_override%& is set true, which is the default
4077 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4078
4079 .vitem &%-odf%&
4080 .oindex "&%-odf%&"
4081 .cindex "foreground delivery"
4082 .cindex "delivery" "in the foreground"
4083 This option requests &"foreground"& (synchronous) delivery when Exim has
4084 accepted a locally-generated message. (For the daemon it is exactly the same as
4085 &%-odb%&.) A delivery process is automatically started to deliver the message,
4086 and Exim waits for it to complete before proceeding.
4087
4088 The original Exim reception process does not finish until the delivery
4089 process for the final message has ended. The standard error stream is left open
4090 during deliveries.
4091
4092 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4093 false and one of the queueing options in the configuration file is in effect.
4094
4095 If there is a temporary delivery error during foreground delivery, the
4096 message is left on the queue for later delivery, and the original reception
4097 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4098 restricted configuration that never queues messages.
4099
4100
4101 .vitem &%-odi%&
4102 .oindex "&%-odi%&"
4103 This option is synonymous with &%-odf%&. It is provided for compatibility with
4104 Sendmail.
4105
4106 .vitem &%-odq%&
4107 .oindex "&%-odq%&"
4108 .cindex "non-immediate delivery"
4109 .cindex "delivery" "suppressing immediate"
4110 .cindex "queueing incoming messages"
4111 This option applies to all modes in which Exim accepts incoming messages,
4112 including the listening daemon. It specifies that the accepting process should
4113 not automatically start a delivery process for each message received. Messages
4114 are placed on the queue, and remain there until a subsequent queue runner
4115 process encounters them. There are several configuration options (such as
4116 &%queue_only%&) that can be used to queue incoming messages under certain
4117 conditions. This option overrides all of them and also &%-odqs%&. It always
4118 forces queueing.
4119
4120 .vitem &%-odqs%&
4121 .oindex "&%-odqs%&"
4122 .cindex "SMTP" "delaying delivery"
4123 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4124 However, like &%-odb%& and &%-odi%&, this option has no effect if
4125 &%queue_only_override%& is false and one of the queueing options in the
4126 configuration file is in effect.
4127
4128 When &%-odqs%& does operate, a delivery process is started for each incoming
4129 message, in the background by default, but in the foreground if &%-odi%& is
4130 also present. The recipient addresses are routed, and local deliveries are done
4131 in the normal way. However, if any SMTP deliveries are required, they are not
4132 done at this time, so the message remains on the queue until a subsequent queue
4133 runner process encounters it. Because routing was done, Exim knows which
4134 messages are waiting for which hosts, and so a number of messages for the same
4135 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4136 configuration option has the same effect for specific domains. See also the
4137 &%-qq%& option.
4138
4139 .vitem &%-oee%&
4140 .oindex "&%-oee%&"
4141 .cindex "error" "reporting"
4142 If an error is detected while a non-SMTP message is being received (for
4143 example, a malformed address), the error is reported to the sender in a mail
4144 message.
4145
4146 .cindex "return code" "for &%-oee%&"
4147 Provided
4148 this error message is successfully sent, the Exim receiving process
4149 exits with a return code of zero. If not, the return code is 2 if the problem
4150 is that the original message has no recipients, or 1 for any other error.
4151 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4152
4153 .vitem &%-oem%&
4154 .oindex "&%-oem%&"
4155 .cindex "error" "reporting"
4156 .cindex "return code" "for &%-oem%&"
4157 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4158 return code, whether or not the error message was successfully sent.
4159 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4160
4161 .vitem &%-oep%&
4162 .oindex "&%-oep%&"
4163 .cindex "error" "reporting"
4164 If an error is detected while a non-SMTP message is being received, the
4165 error is reported by writing a message to the standard error file (stderr).
4166 .cindex "return code" "for &%-oep%&"
4167 The return code is 1 for all errors.
4168
4169 .vitem &%-oeq%&
4170 .oindex "&%-oeq%&"
4171 .cindex "error" "reporting"
4172 This option is supported for compatibility with Sendmail, but has the same
4173 effect as &%-oep%&.
4174
4175 .vitem &%-oew%&
4176 .oindex "&%-oew%&"
4177 .cindex "error" "reporting"
4178 This option is supported for compatibility with Sendmail, but has the same
4179 effect as &%-oem%&.
4180
4181 .vitem &%-oi%&
4182 .oindex "&%-oi%&"
4183 .cindex "dot" "in incoming non-SMTP message"
4184 This option, which has the same effect as &%-i%&, specifies that a dot on a
4185 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4186 single dot does terminate, though Exim does no special processing for other
4187 lines that start with a dot. This option is set by default if Exim is called as
4188 &'rmail'&. See also &%-ti%&.
4189
4190 .vitem &%-oitrue%&
4191 .oindex "&%-oitrue%&"
4192 This option is treated as synonymous with &%-oi%&.
4193
4194 .vitem &%-oMa%&&~<&'host&~address'&>
4195 .oindex "&%-oMa%&"
4196 .cindex "sender" "host address, specifying for local message"
4197 A number of options starting with &%-oM%& can be used to set values associated
4198 with remote hosts on locally-submitted messages (that is, messages not received
4199 over TCP/IP). These options can be used by any caller in conjunction with the
4200 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4201 other circumstances, they are ignored unless the caller is trusted.
4202
4203 The &%-oMa%& option sets the sender host address. This may include a port
4204 number at the end, after a full stop (period). For example:
4205 .code
4206 exim -bs -oMa 10.9.8.7.1234
4207 .endd
4208 An alternative syntax is to enclose the IP address in square brackets,
4209 followed by a colon and the port number:
4210 .code
4211 exim -bs -oMa [10.9.8.7]:1234
4212 .endd
4213 The IP address is placed in the &$sender_host_address$& variable, and the
4214 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4215 are present on the command line, the sender host IP address is taken from
4216 whichever one is last.
4217
4218 .vitem &%-oMaa%&&~<&'name'&>
4219 .oindex "&%-oMaa%&"
4220 .cindex "authentication" "name, specifying for local message"
4221 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4222 option sets the value of &$sender_host_authenticated$& (the authenticator
4223 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4224 This option can be used with &%-bh%& and &%-bs%& to set up an
4225 authenticated SMTP session without actually using the SMTP AUTH command.
4226
4227 .vitem &%-oMai%&&~<&'string'&>
4228 .oindex "&%-oMai%&"
4229 .cindex "authentication" "id, specifying for local message"
4230 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4231 option sets the value of &$authenticated_id$& (the id that was authenticated).
4232 This overrides the default value (the caller's login id, except with &%-bh%&,
4233 where there is no default) for messages from local sources. See chapter
4234 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4235
4236 .vitem &%-oMas%&&~<&'address'&>
4237 .oindex "&%-oMas%&"
4238 .cindex "authentication" "sender, specifying for local message"
4239 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4240 option sets the authenticated sender value in &$authenticated_sender$&. It
4241 overrides the sender address that is created from the caller's login id for
4242 messages from local sources, except when &%-bh%& is used, when there is no
4243 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4244 specified on a MAIL command overrides this value. See chapter
4245 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4246
4247 .vitem &%-oMi%&&~<&'interface&~address'&>
4248 .oindex "&%-oMi%&"
4249 .cindex "interface" "address, specifying for local message"
4250 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4251 option sets the IP interface address value. A port number may be included,
4252 using the same syntax as for &%-oMa%&. The interface address is placed in
4253 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4254
4255 .vitem &%-oMm%&&~<&'message&~reference'&>
4256 .oindex "&%-oMm%&"
4257 .cindex "message reference" "message reference, specifying for local message"
4258 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4259 option sets the message reference, e.g. message-id, and is logged during
4260 delivery. This is useful when some kind of audit trail is required to tie
4261 messages together. The format of the message reference is checked and will
4262 abort if the format is invalid. The option will only be accepted if exim is
4263 running in trusted mode, not as any regular user.
4264
4265 The best example of a message reference is when Exim sends a bounce message.
4266 The message reference is the message-id of the original message for which Exim
4267 is sending the bounce.
4268
4269 .vitem &%-oMr%&&~<&'protocol&~name'&>
4270 .oindex "&%-oMr%&"
4271 .cindex "protocol, specifying for local message"
4272 .vindex "&$received_protocol$&"
4273 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4274 option sets the received protocol value that is stored in
4275 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4276 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4277 SMTP protocol names (see the description of &$received_protocol$& in section
4278 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4279 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4280 be set by &%-oMr%&. Repeated use of this option is not supported.
4281
4282 .vitem &%-oMs%&&~<&'host&~name'&>
4283 .oindex "&%-oMs%&"
4284 .cindex "sender" "host name, specifying for local message"
4285 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4286 option sets the sender host name in &$sender_host_name$&. When this option is
4287 present, Exim does not attempt to look up a host name from an IP address; it
4288 uses the name it is given.
4289
4290 .vitem &%-oMt%&&~<&'ident&~string'&>
4291 .oindex "&%-oMt%&"
4292 .cindex "sender" "ident string, specifying for local message"
4293 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4294 option sets the sender ident value in &$sender_ident$&. The default setting for
4295 local callers is the login id of the calling process, except when &%-bh%& is
4296 used, when there is no default.
4297
4298 .vitem &%-om%&
4299 .oindex "&%-om%&"
4300 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4301 In Sendmail, this option means &"me too"&, indicating that the sender of a
4302 message should receive a copy of the message if the sender appears in an alias
4303 expansion. Exim always does this, so the option does nothing.
4304
4305 .vitem &%-oo%&
4306 .oindex "&%-oo%&"
4307 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4308 This option is ignored. In Sendmail it specifies &"old style headers"&,
4309 whatever that means.
4310
4311 .vitem &%-oP%&&~<&'path'&>
4312 .oindex "&%-oP%&"
4313 .cindex "pid (process id)" "of daemon"
4314 .cindex "daemon" "process id (pid)"
4315 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4316 value. The option specifies the file to which the process id of the daemon is
4317 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4318 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4319 because in those cases, the normal pid file is not used.
4320
4321 .vitem &%-or%&&~<&'time'&>
4322 .oindex "&%-or%&"
4323 .cindex "timeout" "for non-SMTP input"
4324 This option sets a timeout value for incoming non-SMTP messages. If it is not
4325 set, Exim will wait forever for the standard input. The value can also be set
4326 by the &%receive_timeout%& option. The format used for specifying times is
4327 described in section &<<SECTtimeformat>>&.
4328
4329 .vitem &%-os%&&~<&'time'&>
4330 .oindex "&%-os%&"
4331 .cindex "timeout" "for SMTP input"
4332 .cindex "SMTP" "input timeout"
4333 This option sets a timeout value for incoming SMTP messages. The timeout
4334 applies to each SMTP command and block of data. The value can also be set by
4335 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4336 for specifying times is described in section &<<SECTtimeformat>>&.
4337
4338 .vitem &%-ov%&
4339 .oindex "&%-ov%&"
4340 This option has exactly the same effect as &%-v%&.
4341
4342 .vitem &%-oX%&&~<&'number&~or&~string'&>
4343 .oindex "&%-oX%&"
4344 .cindex "TCP/IP" "setting listening ports"
4345 .cindex "TCP/IP" "setting listening interfaces"
4346 .cindex "port" "receiving TCP/IP"
4347 This option is relevant only when the &%-bd%& (start listening daemon) option
4348 is also given. It controls which ports and interfaces the daemon uses. Details
4349 of the syntax, and how it interacts with configuration file options, are given
4350 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4351 file is written unless &%-oP%& is also present to specify a pid file name.
4352
4353 .vitem &%-pd%&
4354 .oindex "&%-pd%&"
4355 .cindex "Perl" "starting the interpreter"
4356 This option applies when an embedded Perl interpreter is linked with Exim (see
4357 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4358 option, forcing the starting of the interpreter to be delayed until it is
4359 needed.
4360
4361 .vitem &%-ps%&
4362 .oindex "&%-ps%&"
4363 .cindex "Perl" "starting the interpreter"
4364 This option applies when an embedded Perl interpreter is linked with Exim (see
4365 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4366 option, forcing the starting of the interpreter to occur as soon as Exim is
4367 started.
4368
4369 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4370 .oindex "&%-p%&"
4371 For compatibility with Sendmail, this option is equivalent to
4372 .display
4373 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4374 .endd
4375 It sets the incoming protocol and host name (for trusted callers). The
4376 host name and its colon can be omitted when only the protocol is to be set.
4377 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4378 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4379 or &`s`& using this option (but that does not seem a real limitation).
4380 Repeated use of this option is not supported.
4381
4382 .vitem &%-q%&
4383 .oindex "&%-q%&"
4384 .cindex "queue runner" "starting manually"
4385 This option is normally restricted to admin users. However, there is a
4386 configuration option called &%prod_requires_admin%& which can be set false to
4387 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4388 and &%-S%& options).
4389
4390 .cindex "queue runner" "description of operation"
4391 If other commandline options do not specify an action,
4392 the &%-q%& option starts one queue runner process. This scans the queue of
4393 waiting messages, and runs a delivery process for each one in turn. It waits
4394 for each delivery process to finish before starting the next one. A delivery
4395 process may not actually do any deliveries if the retry times for the addresses
4396 have not been reached. Use &%-qf%& (see below) if you want to override this.
4397
4398 If
4399 .cindex "SMTP" "passed connection"
4400 .cindex "SMTP" "multiple deliveries"
4401 .cindex "multiple SMTP deliveries"
4402 the delivery process spawns other processes to deliver other messages down
4403 passed SMTP connections, the queue runner waits for these to finish before
4404 proceeding.
4405
4406 When all the queued messages have been considered, the original queue runner
4407 process terminates. In other words, a single pass is made over the waiting
4408 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4409 this to be repeated periodically.
4410
4411 Exim processes the waiting messages in an unpredictable order. It isn't very
4412 random, but it is likely to be different each time, which is all that matters.
4413 If one particular message screws up a remote MTA, other messages to the same
4414 MTA have a chance of getting through if they get tried first.
4415
4416 It is possible to cause the messages to be processed in lexical message id
4417 order, which is essentially the order in which they arrived, by setting the
4418 &%queue_run_in_order%& option, but this is not recommended for normal use.
4419
4420 .vitem &%-q%&<&'qflags'&>
4421 The &%-q%& option may be followed by one or more flag letters that change its
4422 behaviour. They are all optional, but if more than one is present, they must
4423 appear in the correct order. Each flag is described in a separate item below.
4424
4425 .vitem &%-qq...%&
4426 .oindex "&%-qq%&"
4427 .cindex "queue" "double scanning"
4428 .cindex "queue" "routing"
4429 .cindex "routing" "whole queue before delivery"
4430 An option starting with &%-qq%& requests a two-stage queue run. In the first
4431 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4432 every domain. Addresses are routed, local deliveries happen, but no remote
4433 transports are run.
4434
4435 .cindex "hints database" "remembering routing"
4436 The hints database that remembers which messages are waiting for specific hosts
4437 is updated, as if delivery to those hosts had been deferred. After this is
4438 complete, a second, normal queue scan happens, with routing and delivery taking
4439 place as normal. Messages that are routed to the same host should mostly be
4440 delivered down a single SMTP
4441 .cindex "SMTP" "passed connection"
4442 .cindex "SMTP" "multiple deliveries"
4443 .cindex "multiple SMTP deliveries"
4444 connection because of the hints that were set up during the first queue scan.
4445 This option may be useful for hosts that are connected to the Internet
4446 intermittently.
4447
4448 .vitem &%-q[q]i...%&
4449 .oindex "&%-qi%&"
4450 .cindex "queue" "initial delivery"
4451 If the &'i'& flag is present, the queue runner runs delivery processes only for
4452 those messages that haven't previously been tried. (&'i'& stands for &"initial
4453 delivery"&.) This can be helpful if you are putting messages on the queue using
4454 &%-odq%& and want a queue runner just to process the new messages.
4455
4456 .vitem &%-q[q][i]f...%&
4457 .oindex "&%-qf%&"
4458 .cindex "queue" "forcing delivery"
4459 .cindex "delivery" "forcing in queue run"
4460 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4461 message, whereas without &'f'& only those non-frozen addresses that have passed
4462 their retry times are tried.
4463
4464 .vitem &%-q[q][i]ff...%&
4465 .oindex "&%-qff%&"
4466 .cindex "frozen messages" "forcing delivery"
4467 If &'ff'& is present, a delivery attempt is forced for every message, whether
4468 frozen or not.
4469
4470 .vitem &%-q[q][i][f[f]]l%&
4471 .oindex "&%-ql%&"
4472 .cindex "queue" "local deliveries only"
4473 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4474 be done. If a message requires any remote deliveries, it remains on the queue
4475 for later delivery.
4476
4477 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4478 .oindex "&%-qG%&"
4479 .cindex queue named
4480 .cindex "named queues"
4481 .cindex "queue" "delivering specific messages"
4482 If the &'G'& flag and a name is present, the queue runner operates on the
4483 queue with the given name rather than the default queue.
4484 The name should not contain a &'/'& character.
4485 For a periodic queue run (see below)
4486 append to the name a slash and a time value.
4487
4488 If other commandline options specify an action, a &'-qG<name>'& option
4489 will specify a queue to operate on.
4490 For example:
4491 .code
4492 exim -bp -qGquarantine
4493 mailq -qGquarantine
4494 exim -qGoffpeak -Rf @special.domain.example
4495 .endd
4496
4497 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4498 When scanning the queue, Exim can be made to skip over messages whose ids are
4499 lexically less than a given value by following the &%-q%& option with a
4500 starting message id. For example:
4501 .code
4502 exim -q 0t5C6f-0000c8-00
4503 .endd
4504 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4505 second message id is given, messages whose ids are lexically greater than it
4506 are also skipped. If the same id is given twice, for example,
4507 .code
4508 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4509 .endd
4510 just one delivery process is started, for that message. This differs from
4511 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4512 that it counts as a delivery from a queue run. Note that the selection
4513 mechanism does not affect the order in which the messages are scanned. There
4514 are also other ways of selecting specific sets of messages for delivery in a
4515 queue run &-- see &%-R%& and &%-S%&.
4516
4517 .vitem &%-q%&<&'qflags'&><&'time'&>
4518 .cindex "queue runner" "starting periodically"
4519 .cindex "periodic queue running"
4520 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4521 starting a queue runner process at intervals specified by the given time value
4522 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4523 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4524 single daemon process handles both functions. A common way of starting up a
4525 combined daemon at system boot time is to use a command such as
4526 .code
4527 /usr/exim/bin/exim -bd -q30m
4528 .endd
4529 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4530 process every 30 minutes.
4531
4532 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4533 pid file is written unless one is explicitly requested by the &%-oP%& option.
4534
4535 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4536 .oindex "&%-qR%&"
4537 This option is synonymous with &%-R%&. It is provided for Sendmail
4538 compatibility.
4539
4540 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4541 .oindex "&%-qS%&"
4542 This option is synonymous with &%-S%&.
4543
4544 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4545 .oindex "&%-R%&"
4546 .cindex "queue runner" "for specific recipients"
4547 .cindex "delivery" "to given domain"
4548 .cindex "domain" "delivery to"
4549 The <&'rsflags'&> may be empty, in which case the white space before the string
4550 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4551 which are the possible values for <&'rsflags'&>. White space is required if
4552 <&'rsflags'&> is not empty.
4553
4554 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4555 perform a single queue run, except that, when scanning the messages on the
4556 queue, Exim processes only those that have at least one undelivered recipient
4557 address containing the given string, which is checked in a case-independent
4558 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4559 regular expression; otherwise it is a literal string.
4560
4561 If you want to do periodic queue runs for messages with specific recipients,
4562 you can combine &%-R%& with &%-q%& and a time value. For example:
4563 .code
4564 exim -q25m -R @special.domain.example
4565 .endd
4566 This example does a queue run for messages with recipients in the given domain
4567 every 25 minutes. Any additional flags that are specified with &%-q%& are
4568 applied to each queue run.
4569
4570 Once a message is selected for delivery by this mechanism, all its addresses
4571 are processed. For the first selected message, Exim overrides any retry
4572 information and forces a delivery attempt for each undelivered address. This
4573 means that if delivery of any address in the first message is successful, any
4574 existing retry information is deleted, and so delivery attempts for that
4575 address in subsequently selected messages (which are processed without forcing)
4576 will run. However, if delivery of any address does not succeed, the retry
4577 information is updated, and in subsequently selected messages, the failing
4578 address will be skipped.
4579
4580 .cindex "frozen messages" "forcing delivery"
4581 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4582 all selected messages, not just the first; frozen messages are included when
4583 &'ff'& is present.
4584
4585 The &%-R%& option makes it straightforward to initiate delivery of all messages
4586 to a given domain after a host has been down for some time. When the SMTP
4587 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4588 effect is to run Exim with the &%-R%& option, but it can be configured to run
4589 an arbitrary command instead.
4590
4591 .vitem &%-r%&
4592 .oindex "&%-r%&"
4593 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4594
4595 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4596 .oindex "&%-S%&"
4597 .cindex "delivery" "from given sender"
4598 .cindex "queue runner" "for specific senders"
4599 This option acts like &%-R%& except that it checks the string against each
4600 message's sender instead of against the recipients. If &%-R%& is also set, both
4601 conditions must be met for a message to be selected. If either of the options
4602 has &'f'& or &'ff'& in its flags, the associated action is taken.
4603
4604 .vitem &%-Tqt%&&~<&'times'&>
4605 .oindex "&%-Tqt%&"
4606 This is an option that is exclusively for use by the Exim testing suite. It is not
4607 recognized when Exim is run normally. It allows for the setting up of explicit
4608 &"queue times"& so that various warning/retry features can be tested.
4609
4610 .vitem &%-t%&
4611 .oindex "&%-t%&"
4612 .cindex "recipient" "extracting from header lines"
4613 .cindex "&'Bcc:'& header line"
4614 .cindex "&'Cc:'& header line"
4615 .cindex "&'To:'& header line"
4616 When Exim is receiving a locally-generated, non-SMTP message on its standard
4617 input, the &%-t%& option causes the recipients of the message to be obtained
4618 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4619 from the command arguments. The addresses are extracted before any rewriting
4620 takes place and the &'Bcc:'& header line, if present, is then removed.
4621
4622 .cindex "Sendmail compatibility" "&%-t%& option"
4623 If the command has any arguments, they specify addresses to which the message
4624 is &'not'& to be delivered. That is, the argument addresses are removed from
4625 the recipients list obtained from the headers. This is compatible with Smail 3
4626 and in accordance with the documented behaviour of several versions of
4627 Sendmail, as described in man pages on a number of operating systems (e.g.
4628 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4629 argument addresses to those obtained from the headers, and the O'Reilly
4630 Sendmail book documents it that way. Exim can be made to add argument addresses
4631 instead of subtracting them by setting the option
4632 &%extract_addresses_remove_arguments%& false.
4633
4634 .cindex "&%Resent-%& header lines" "with &%-t%&"
4635 If there are any &%Resent-%& header lines in the message, Exim extracts
4636 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4637 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4638 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4639 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4640
4641 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4642 message is resent several times). The RFC also specifies that they should be
4643 added at the front of the message, and separated by &'Received:'& lines. It is
4644 not at all clear how &%-t%& should operate in the present of multiple sets,
4645 nor indeed exactly what constitutes a &"set"&.
4646 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4647 are often added at the end of the header, and if a message is resent more than
4648 once, it is common for the original set of &%Resent-%& headers to be renamed as
4649 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4650
4651 .vitem &%-ti%&
4652 .oindex "&%-ti%&"
4653 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4654 compatibility with Sendmail.
4655
4656 .vitem &%-tls-on-connect%&
4657 .oindex "&%-tls-on-connect%&"
4658 .cindex "TLS" "use without STARTTLS"
4659 .cindex "TLS" "automatic start"
4660 This option is available when Exim is compiled with TLS support. It forces all
4661 incoming SMTP connections to behave as if the incoming port is listed in the
4662 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4663 &<<CHAPTLS>>& for further details.
4664
4665
4666 .vitem &%-U%&
4667 .oindex "&%-U%&"
4668 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4669 Sendmail uses this option for &"initial message submission"&, and its
4670 documentation states that in future releases, it may complain about
4671 syntactically invalid messages rather than fixing them when this flag is not
4672 set. Exim ignores this option.
4673
4674 .vitem &%-v%&
4675 .oindex "&%-v%&"
4676 This option causes Exim to write information to the standard error stream,
4677 describing what it is doing. In particular, it shows the log lines for
4678 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4679 dialogue is shown. Some of the log lines shown may not actually be written to
4680 the log if the setting of &%log_selector%& discards them. Any relevant
4681 selectors are shown with each log line. If none are shown, the logging is
4682 unconditional.
4683
4684 .vitem &%-x%&
4685 .oindex "&%-x%&"
4686 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4687 National Language Support extended characters in the body of the mail item"&).
4688 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4689 this option.
4690
4691 .vitem &%-X%&&~<&'logfile'&>
4692 .oindex "&%-X%&"
4693 This option is interpreted by Sendmail to cause debug information to be sent
4694 to the named file.  It is ignored by Exim.
4695
4696 .vitem &%-z%&&~<&'log-line'&>
4697 .oindex "&%-z%&"
4698 This option writes its argument to Exim's logfile.
4699 Use is restricted to administrators; the intent is for operational notes.
4700 Quotes should be used to maintain a multi-word item as a single argument,
4701 under most shells.
4702 .endlist
4703
4704 .ecindex IIDclo1
4705 .ecindex IIDclo2
4706
4707
4708 . ////////////////////////////////////////////////////////////////////////////
4709 . Insert a stylized DocBook comment here, to identify the end of the command
4710 . line options. This is for the benefit of the Perl script that automatically
4711 . creates a man page for the options.
4712 . ////////////////////////////////////////////////////////////////////////////
4713
4714 .literal xml
4715 <!-- === End of command line options === -->
4716 .literal off
4717
4718
4719
4720
4721
4722 . ////////////////////////////////////////////////////////////////////////////
4723 . ////////////////////////////////////////////////////////////////////////////
4724
4725
4726 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4727          "The runtime configuration file"
4728
4729 .cindex "run time configuration"
4730 .cindex "configuration file" "general description"
4731 .cindex "CONFIGURE_FILE"
4732 .cindex "configuration file" "errors in"
4733 .cindex "error" "in configuration file"
4734 .cindex "return code" "for bad configuration"
4735 Exim uses a single run time configuration file that is read whenever an Exim
4736 binary is executed. Note that in normal operation, this happens frequently,
4737 because Exim is designed to operate in a distributed manner, without central
4738 control.
4739
4740 If a syntax error is detected while reading the configuration file, Exim
4741 writes a message on the standard error, and exits with a non-zero return code.
4742 The message is also written to the panic log. &*Note*&: Only simple syntax
4743 errors can be detected at this time. The values of any expanded options are
4744 not checked until the expansion happens, even when the expansion does not
4745 actually alter the string.
4746
4747 The name of the configuration file is compiled into the binary for security
4748 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4749 most configurations, this specifies a single file. However, it is permitted to
4750 give a colon-separated list of file names, in which case Exim uses the first
4751 existing file in the list.
4752
4753 .cindex "EXIM_USER"
4754 .cindex "EXIM_GROUP"
4755 .cindex "CONFIGURE_OWNER"
4756 .cindex "CONFIGURE_GROUP"
4757 .cindex "configuration file" "ownership"
4758 .cindex "ownership" "configuration file"
4759 The run time configuration file must be owned by root or by the user that is
4760 specified at compile time by the CONFIGURE_OWNER option (if set). The
4761 configuration file must not be world-writeable, or group-writeable unless its
4762 group is the root group or the one specified at compile time by the
4763 CONFIGURE_GROUP option.
4764
4765 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4766 to root, anybody who is able to edit the run time configuration file has an
4767 easy way to run commands as root. If you specify a user or group in the
4768 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4769 who are members of that group will trivially be able to obtain root privileges.
4770
4771 Up to Exim version 4.72, the run time configuration file was also permitted to
4772 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4773 since it offered a simple privilege escalation for any attacker who managed to
4774 compromise the Exim user account.
4775
4776 A default configuration file, which will work correctly in simple situations,
4777 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4778 defines just one file name, the installation process copies the default
4779 configuration to a new file of that name if it did not previously exist. If
4780 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4781 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4782 configuration.
4783
4784
4785
4786 .section "Using a different configuration file" "SECID40"
4787 .cindex "configuration file" "alternate"
4788 A one-off alternate configuration can be specified by the &%-C%& command line
4789 option, which may specify a single file or a list of files. However, when
4790 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4791 unless the argument for &%-C%& is identical to the built-in value from
4792 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4793 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4794 is useful mainly for checking the syntax of configuration files before
4795 installing them. No owner or group checks are done on a configuration file
4796 specified by &%-C%&, if root privilege has been dropped.
4797
4798 Even the Exim user is not trusted to specify an arbitrary configuration file
4799 with the &%-C%& option to be used with root privileges, unless that file is
4800 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4801 testing a configuration using &%-C%& right through message reception and
4802 delivery, even if the caller is root. The reception works, but by that time,
4803 Exim is running as the Exim user, so when it re-execs to regain privilege for
4804 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4805 can test reception and delivery using two separate commands (one to put a
4806 message on the queue, using &%-odq%&, and another to do the delivery, using
4807 &%-M%&).
4808
4809 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4810 prefix string with which any file named in a &%-C%& command line option must
4811 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4812 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4813 name can be used with &%-C%&.
4814
4815 One-off changes to a configuration can be specified by the &%-D%& command line
4816 option, which defines and overrides values for macros used inside the
4817 configuration file. However, like &%-C%&, the use of this option by a
4818 non-privileged user causes Exim to discard its root privilege.
4819 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4820 completely disabled, and its use causes an immediate error exit.
4821
4822 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4823 to declare certain macro names trusted, such that root privilege will not
4824 necessarily be discarded.
4825 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4826 considered safe and, if &%-D%& only supplies macros from this list, and the
4827 values are acceptable, then Exim will not give up root privilege if the caller
4828 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4829 transition mechanism and is expected to be removed in the future.  Acceptable
4830 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4831
4832 Some sites may wish to use the same Exim binary on different machines that
4833 share a file system, but to use different configuration files on each machine.
4834 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4835 looks for a file whose name is the configuration file name followed by a dot
4836 and the machine's node name, as obtained from the &[uname()]& function. If this
4837 file does not exist, the standard name is tried. This processing occurs for
4838 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4839
4840 In some esoteric situations different versions of Exim may be run under
4841 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4842 help with this. See the comments in &_src/EDITME_& for details.
4843
4844
4845
4846 .section "Configuration file format" "SECTconffilfor"
4847 .cindex "configuration file" "format of"
4848 .cindex "format" "configuration file"
4849 Exim's configuration file is divided into a number of different parts. General
4850 option settings must always appear at the start of the file. The other parts
4851 are all optional, and may appear in any order. Each part other than the first
4852 is introduced by the word &"begin"& followed by at least one literal
4853 space, and the name of the part. The optional parts are:
4854
4855 .ilist
4856 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4857 &<<CHAPACL>>&).
4858 .next
4859 .cindex "AUTH" "configuration"
4860 &'authenticators'&: Configuration settings for the authenticator drivers. These
4861 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4862 .next
4863 &'routers'&: Configuration settings for the router drivers. Routers process
4864 addresses and determine how the message is to be delivered (see chapters
4865 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4866 .next
4867 &'transports'&: Configuration settings for the transport drivers. Transports
4868 define mechanisms for copying messages to destinations (see chapters
4869 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4870 .next
4871 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4872 If there is no retry section, or if it is empty (that is, no retry rules are
4873 defined), Exim will not retry deliveries. In this situation, temporary errors
4874 are treated the same as permanent errors. Retry rules are discussed in chapter
4875 &<<CHAPretry>>&.
4876 .next
4877 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4878 when new addresses are generated during delivery. Rewriting is discussed in
4879 chapter &<<CHAPrewrite>>&.
4880 .next
4881 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4882 want to use this feature, you must set
4883 .code
4884 LOCAL_SCAN_HAS_OPTIONS=yes
4885 .endd
4886 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4887 facility are given in chapter &<<CHAPlocalscan>>&.
4888 .endlist
4889
4890 .cindex "configuration file" "leading white space in"
4891 .cindex "configuration file" "trailing white space in"
4892 .cindex "white space" "in configuration file"
4893 Leading and trailing white space in configuration lines is always ignored.
4894
4895 Blank lines in the file, and lines starting with a # character (ignoring
4896 leading white space) are treated as comments and are ignored. &*Note*&: A
4897 # character other than at the beginning of a line is not treated specially,
4898 and does not introduce a comment.
4899
4900 Any non-comment line can be continued by ending it with a backslash. Note that
4901 the general rule for white space means that trailing white space after the
4902 backslash and leading white space at the start of continuation
4903 lines is ignored. Comment lines beginning with # (but not empty lines) may
4904 appear in the middle of a sequence of continuation lines.
4905
4906 A convenient way to create a configuration file is to start from the
4907 default, which is supplied in &_src/configure.default_&, and add, delete, or
4908 change settings as required.
4909
4910 The ACLs, retry rules, and rewriting rules have their own syntax which is
4911 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4912 respectively. The other parts of the configuration file have some syntactic
4913 items in common, and these are described below, from section &<<SECTcos>>&
4914 onwards. Before that, the inclusion, macro, and conditional facilities are
4915 described.
4916
4917
4918
4919 .section "File inclusions in the configuration file" "SECID41"
4920 .cindex "inclusions in configuration file"
4921 .cindex "configuration file" "including other files"
4922 .cindex "&`.include`& in configuration file"
4923 .cindex "&`.include_if_exists`& in configuration file"
4924 You can include other files inside Exim's run time configuration file by
4925 using this syntax:
4926 .display
4927 &`.include`& <&'file name'&>
4928 &`.include_if_exists`& <&'file name'&>
4929 .endd
4930 on a line by itself. Double quotes round the file name are optional. If you use
4931 the first form, a configuration error occurs if the file does not exist; the
4932 second form does nothing for non-existent files.
4933 The first form allows a relative name. It is resolved relative to
4934 the directory of the including file. For the second form an absolute file
4935 name is required.
4936
4937 Includes may be nested to any depth, but remember that Exim reads its
4938 configuration file often, so it is a good idea to keep them to a minimum.
4939 If you change the contents of an included file, you must HUP the daemon,
4940 because an included file is read only when the configuration itself is read.
4941
4942 The processing of inclusions happens early, at a physical line level, so, like
4943 comment lines, an inclusion can be used in the middle of an option setting,
4944 for example:
4945 .code
4946 hosts_lookup = a.b.c \
4947                .include /some/file
4948 .endd
4949 Include processing happens after macro processing (see below). Its effect is to
4950 process the lines of the included file as if they occurred inline where the
4951 inclusion appears.
4952
4953
4954
4955 .section "Macros in the configuration file" "SECTmacrodefs"
4956 .cindex "macro" "description of"
4957 .cindex "configuration file" "macros"
4958 If a line in the main part of the configuration (that is, before the first
4959 &"begin"& line) begins with an upper case letter, it is taken as a macro
4960 definition, and must be of the form
4961 .display
4962 <&'name'&> = <&'rest of line'&>
4963 .endd
4964 The name must consist of letters, digits, and underscores, and need not all be
4965 in upper case, though that is recommended. The rest of the line, including any
4966 continuations, is the replacement text, and has leading and trailing white
4967 space removed. Quotes are not removed. The replacement text can never end with
4968 a backslash character, but this doesn't seem to be a serious limitation.
4969
4970 Macros may also be defined between router, transport, authenticator, or ACL
4971 definitions. They may not, however, be defined within an individual driver or
4972 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4973
4974 .section "Macro substitution" "SECID42"
4975 Once a macro is defined, all subsequent lines in the file (and any included
4976 files) are scanned for the macro name; if there are several macros, the line is
4977 scanned for each in turn, in the order in which the macros are defined. The
4978 replacement text is not re-scanned for the current macro, though it is scanned
4979 for subsequently defined macros. For this reason, a macro name may not contain
4980 the name of a previously defined macro as a substring. You could, for example,
4981 define
4982 .display
4983 &`ABCD_XYZ = `&<&'something'&>
4984 &`ABCD = `&<&'something else'&>
4985 .endd
4986 but putting the definitions in the opposite order would provoke a configuration
4987 error. Macro expansion is applied to individual physical lines from the file,
4988 before checking for line continuation or file inclusion (see above). If a line
4989 consists solely of a macro name, and the expansion of the macro is empty, the
4990 line is ignored. A macro at the start of a line may turn the line into a
4991 comment line or a &`.include`& line.
4992
4993
4994 .section "Redefining macros" "SECID43"
4995 Once defined, the value of a macro can be redefined later in the configuration
4996 (or in an included file). Redefinition is specified by using &'=='& instead of
4997 &'='&. For example:
4998 .code
4999 MAC =  initial value
5000 ...
5001 MAC == updated value
5002 .endd
5003 Redefinition does not alter the order in which the macros are applied to the
5004 subsequent lines of the configuration file. It is still the same order in which
5005 the macros were originally defined. All that changes is the macro's value.
5006 Redefinition makes it possible to accumulate values. For example:
5007 .code
5008 MAC =  initial value
5009 ...
5010 MAC == MAC and something added
5011 .endd
5012 This can be helpful in situations where the configuration file is built
5013 from a number of other files.
5014
5015 .section "Overriding macro values" "SECID44"
5016 The values set for macros in the configuration file can be overridden by the
5017 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5018 used, unless called by root or the Exim user. A definition on the command line
5019 using the &%-D%& option causes all definitions and redefinitions within the
5020 file to be ignored.
5021
5022
5023
5024 .section "Example of macro usage" "SECID45"
5025 As an example of macro usage, consider a configuration where aliases are looked
5026 up in a MySQL database. It helps to keep the file less cluttered if long
5027 strings such as SQL statements are defined separately as macros, for example:
5028 .code
5029 ALIAS_QUERY = select mailbox from user where \
5030               login='${quote_mysql:$local_part}';
5031 .endd
5032 This can then be used in a &(redirect)& router setting like this:
5033 .code
5034 data = ${lookup mysql{ALIAS_QUERY}}
5035 .endd
5036 In earlier versions of Exim macros were sometimes used for domain, host, or
5037 address lists. In Exim 4 these are handled better by named lists &-- see
5038 section &<<SECTnamedlists>>&.
5039
5040
5041 .section "Builtin macros" "SECTbuiltinmacros"
5042 Exim defines some macros depending on facilities available, which may
5043 differ due to build-time definitions and from one release to another.
5044 All of these macros start with an underscore.
5045 They can be used to conditionally include parts of a configuration
5046 (see below).
5047
5048 The following classes of macros are defined:
5049 .display
5050 &` _HAVE_*                    `&  build-time defines
5051 &` _DRIVER_ROUTER_*           `&  router drivers
5052 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5053 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5054 &` _OPT_MAIN_*                `&  main config options
5055 &` _OPT_ROUTERS_*             `&  generic router options
5056 &` _OPT_TRANSPORTS_*          `&  generic transport options
5057 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5058 &` _OPT_ROUTER_*_*            `&  private router options
5059 &` _OPT_TRANSPORT_*_*         `&  private transport options
5060 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5061 .endd
5062
5063 Use an &"exim -bP macros"& command to get the list of macros.
5064
5065
5066 .section "Conditional skips in the configuration file" "SECID46"
5067 .cindex "configuration file" "conditional skips"
5068 .cindex "&`.ifdef`&"
5069 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5070 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5071 portions of the configuration file. The processing happens whenever the file is
5072 read (that is, when an Exim binary starts to run).
5073
5074 The implementation is very simple. Instances of the first four directives must
5075 be followed by text that includes the names of one or macros. The condition
5076 that is tested is whether or not any macro substitution has taken place in the
5077 line. Thus:
5078 .code
5079 .ifdef AAA
5080 message_size_limit = 50M
5081 .else
5082 message_size_limit = 100M
5083 .endif
5084 .endd
5085 sets a message size limit of 50M if the macro &`AAA`& is defined
5086 (or &`A`& or &`AA`&), and 100M
5087 otherwise. If there is more than one macro named on the line, the condition
5088 is true if any of them are defined. That is, it is an &"or"& condition. To
5089 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5090
5091 Although you can use a macro expansion to generate one of these directives,
5092 it is not very useful, because the condition &"there was a macro substitution
5093 in this line"& will always be true.
5094
5095 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5096 to clarify complicated nestings.
5097
5098
5099
5100 .section "Common option syntax" "SECTcos"
5101 .cindex "common option syntax"
5102 .cindex "syntax of common options"
5103 .cindex "configuration file" "common option syntax"
5104 For the main set of options, driver options, and &[local_scan()]& options,
5105 each setting is on a line by itself, and starts with a name consisting of
5106 lower-case letters and underscores. Many options require a data value, and in
5107 these cases the name must be followed by an equals sign (with optional white
5108 space) and then the value. For example:
5109 .code
5110 qualify_domain = mydomain.example.com
5111 .endd
5112 .cindex "hiding configuration option values"
5113 .cindex "configuration options" "hiding value of"
5114 .cindex "options" "hiding value of"
5115 Some option settings may contain sensitive data, for example, passwords for
5116 accessing databases. To stop non-admin users from using the &%-bP%& command
5117 line option to read these values, you can precede the option settings with the
5118 word &"hide"&. For example:
5119 .code
5120 hide mysql_servers = localhost/users/admin/secret-password
5121 .endd
5122 For non-admin users, such options are displayed like this:
5123 .code
5124 mysql_servers = <value not displayable>
5125 .endd
5126 If &"hide"& is used on a driver option, it hides the value of that option on
5127 all instances of the same driver.
5128
5129 The following sections describe the syntax used for the different data types
5130 that are found in option settings.
5131
5132
5133 .section "Boolean options" "SECID47"
5134 .cindex "format" "boolean"
5135 .cindex "boolean configuration values"
5136 .oindex "&%no_%&&'xxx'&"
5137 .oindex "&%not_%&&'xxx'&"
5138 Options whose type is given as boolean are on/off switches. There are two
5139 different ways of specifying such options: with and without a data value. If
5140 the option name is specified on its own without data, the switch is turned on;
5141 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5142 boolean options may be followed by an equals sign and one of the words
5143 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5144 the following two settings have exactly the same effect:
5145 .code
5146 queue_only
5147 queue_only = true
5148 .endd
5149 The following two lines also have the same (opposite) effect:
5150 .code
5151 no_queue_only
5152 queue_only = false
5153 .endd
5154 You can use whichever syntax you prefer.
5155
5156
5157
5158
5159 .section "Integer values" "SECID48"
5160 .cindex "integer configuration values"
5161 .cindex "format" "integer"
5162 If an option's type is given as &"integer"&, the value can be given in decimal,
5163 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5164 number is assumed. Otherwise, it is treated as an octal number unless it starts
5165 with the characters &"0x"&, in which case the remainder is interpreted as a
5166 hexadecimal number.
5167
5168 If an integer value is followed by the letter K, it is multiplied by 1024; if
5169 it is followed by the letter M, it is multiplied by 1024x1024;
5170 if by the letter G, 1024x1024x1024.
5171 When the values
5172 of integer option settings are output, values which are an exact multiple of
5173 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5174 and M. The printing style is independent of the actual input format that was
5175 used.
5176
5177
5178 .section "Octal integer values" "SECID49"
5179 .cindex "integer format"
5180 .cindex "format" "octal integer"
5181 If an option's type is given as &"octal integer"&, its value is always
5182 interpreted as an octal number, whether or not it starts with the digit zero.
5183 Such options are always output in octal.
5184
5185
5186 .section "Fixed point numbers" "SECID50"
5187 .cindex "fixed point configuration values"
5188 .cindex "format" "fixed point"
5189 If an option's type is given as &"fixed-point"&, its value must be a decimal
5190 integer, optionally followed by a decimal point and up to three further digits.
5191
5192
5193
5194 .section "Time intervals" "SECTtimeformat"
5195 .cindex "time interval" "specifying in configuration"
5196 .cindex "format" "time interval"
5197 A time interval is specified as a sequence of numbers, each followed by one of
5198 the following letters, with no intervening white space:
5199
5200 .table2 30pt
5201 .irow &%s%& seconds
5202 .irow &%m%& minutes
5203 .irow &%h%& hours
5204 .irow &%d%& days
5205 .irow &%w%& weeks
5206 .endtable
5207
5208 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5209 intervals are output in the same format. Exim does not restrict the values; it
5210 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5211
5212
5213
5214 .section "String values" "SECTstrings"
5215 .cindex "string" "format of configuration values"
5216 .cindex "format" "string"
5217 If an option's type is specified as &"string"&, the value can be specified with
5218 or without double-quotes. If it does not start with a double-quote, the value
5219 consists of the remainder of the line plus any continuation lines, starting at
5220 the first character after any leading white space, with trailing white space
5221 removed, and with no interpretation of the characters in the string. Because
5222 Exim removes comment lines (those beginning with #) at an early stage, they can
5223 appear in the middle of a multi-line string. The following two settings are
5224 therefore equivalent:
5225 .code
5226 trusted_users = uucp:mail
5227 trusted_users = uucp:\
5228                 # This comment line is ignored
5229                 mail
5230 .endd
5231 .cindex "string" "quoted"
5232 .cindex "escape characters in quoted strings"
5233 If a string does start with a double-quote, it must end with a closing
5234 double-quote, and any backslash characters other than those used for line
5235 continuation are interpreted as escape characters, as follows:
5236
5237 .table2 100pt
5238 .irow &`\\`&                     "single backslash"
5239 .irow &`\n`&                     "newline"
5240 .irow &`\r`&                     "carriage return"
5241 .irow &`\t`&                     "tab"
5242 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5243 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5244                                    character"
5245 .endtable
5246
5247 If a backslash is followed by some other character, including a double-quote
5248 character, that character replaces the pair.
5249
5250 Quoting is necessary only if you want to make use of the backslash escapes to
5251 insert special characters, or if you need to specify a value with leading or
5252 trailing spaces. These cases are rare, so quoting is almost never needed in
5253 current versions of Exim. In versions of Exim before 3.14, quoting was required
5254 in order to continue lines, so you may come across older configuration files
5255 and examples that apparently quote unnecessarily.
5256
5257
5258 .section "Expanded strings" "SECID51"
5259 .cindex "expansion" "definition of"
5260 Some strings in the configuration file are subjected to &'string expansion'&,
5261 by which means various parts of the string may be changed according to the
5262 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5263 is as just described; in particular, the handling of backslashes in quoted
5264 strings is done as part of the input process, before expansion takes place.
5265 However, backslash is also an escape character for the expander, so any
5266 backslashes that are required for that reason must be doubled if they are
5267 within a quoted configuration string.
5268
5269
5270 .section "User and group names" "SECID52"
5271 .cindex "user name" "format of"
5272 .cindex "format" "user name"
5273 .cindex "groups" "name format"
5274 .cindex "format" "group name"
5275 User and group names are specified as strings, using the syntax described
5276 above, but the strings are interpreted specially. A user or group name must
5277 either consist entirely of digits, or be a name that can be looked up using the
5278 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5279
5280
5281 .section "List construction" "SECTlistconstruct"
5282 .cindex "list" "syntax of in configuration"
5283 .cindex "format" "list item in configuration"
5284 .cindex "string" "list, definition of"
5285 The data for some configuration options is a list of items, with colon as the
5286 default separator. Many of these options are shown with type &"string list"& in
5287 the descriptions later in this document. Others are listed as &"domain list"&,
5288 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5289 are all the same; however, those other than &"string list"& are subject to
5290 particular kinds of interpretation, as described in chapter
5291 &<<CHAPdomhosaddlists>>&.
5292
5293 In all these cases, the entire list is treated as a single string as far as the
5294 input syntax is concerned. The &%trusted_users%& setting in section
5295 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5296 in a list, it must be entered as two colons. Leading and trailing white space
5297 on each item in a list is ignored. This makes it possible to include items that
5298 start with a colon, and in particular, certain forms of IPv6 address. For
5299 example, the list
5300 .code
5301 local_interfaces = 127.0.0.1 : ::::1
5302 .endd
5303 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5304
5305 &*Note*&: Although leading and trailing white space is ignored in individual
5306 list items, it is not ignored when parsing the list. The space after the first
5307 colon in the example above is necessary. If it were not there, the list would
5308 be interpreted as the two items 127.0.0.1:: and 1.
5309
5310 .section "Changing list separators" "SECTlistsepchange"
5311 .cindex "list separator" "changing"
5312 .cindex "IPv6" "addresses in lists"
5313 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5314 introduced to allow the separator character to be changed. If a list begins
5315 with a left angle bracket, followed by any punctuation character, that
5316 character is used instead of colon as the list separator. For example, the list
5317 above can be rewritten to use a semicolon separator like this:
5318 .code
5319 local_interfaces = <; 127.0.0.1 ; ::1
5320 .endd
5321 This facility applies to all lists, with the exception of the list in
5322 &%log_file_path%&. It is recommended that the use of non-colon separators be
5323 confined to circumstances where they really are needed.
5324
5325 .cindex "list separator" "newline as"
5326 .cindex "newline" "as list separator"
5327 It is also possible to use newline and other control characters (those with
5328 code values less than 32, plus DEL) as separators in lists. Such separators
5329 must be provided literally at the time the list is processed. For options that
5330 are string-expanded, you can write the separator using a normal escape
5331 sequence. This will be processed by the expander before the string is
5332 interpreted as a list. For example, if a newline-separated list of domains is
5333 generated by a lookup, you can process it directly by a line such as this:
5334 .code
5335 domains = <\n ${lookup mysql{.....}}
5336 .endd
5337 This avoids having to change the list separator in such data. You are unlikely
5338 to want to use a control character as a separator in an option that is not
5339 expanded, because the value is literal text. However, it can be done by giving
5340 the value in quotes. For example:
5341 .code
5342 local_interfaces = "<\n 127.0.0.1 \n ::1"
5343 .endd
5344 Unlike printing character separators, which can be included in list items by
5345 doubling, it is not possible to include a control character as data when it is
5346 set as the separator. Two such characters in succession are interpreted as
5347 enclosing an empty list item.
5348
5349
5350
5351 .section "Empty items in lists" "SECTempitelis"
5352 .cindex "list" "empty item in"
5353 An empty item at the end of a list is always ignored. In other words, trailing
5354 separator characters are ignored. Thus, the list in
5355 .code
5356 senders = user@domain :
5357 .endd
5358 contains only a single item. If you want to include an empty string as one item
5359 in a list, it must not be the last item. For example, this list contains three
5360 items, the second of which is empty:
5361 .code
5362 senders = user1@domain : : user2@domain
5363 .endd
5364 &*Note*&: There must be white space between the two colons, as otherwise they
5365 are interpreted as representing a single colon data character (and the list
5366 would then contain just one item). If you want to specify a list that contains
5367 just one, empty item, you can do it as in this example:
5368 .code
5369 senders = :
5370 .endd
5371 In this case, the first item is empty, and the second is discarded because it
5372 is at the end of the list.
5373
5374
5375
5376
5377 .section "Format of driver configurations" "SECTfordricon"
5378 .cindex "drivers" "configuration format"
5379 There are separate parts in the configuration for defining routers, transports,
5380 and authenticators. In each part, you are defining a number of driver
5381 instances, each with its own set of options. Each driver instance is defined by
5382 a sequence of lines like this:
5383 .display
5384 <&'instance name'&>:
5385   <&'option'&>
5386   ...
5387   <&'option'&>
5388 .endd
5389 In the following example, the instance name is &(localuser)&, and it is
5390 followed by three options settings:
5391 .code
5392 localuser:
5393   driver = accept
5394   check_local_user
5395   transport = local_delivery
5396 .endd
5397 For each driver instance, you specify which Exim code module it uses &-- by the
5398 setting of the &%driver%& option &-- and (optionally) some configuration
5399 settings. For example, in the case of transports, if you want a transport to
5400 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5401 a local file you would use the &(appendfile)& driver. Each of the drivers is
5402 described in detail in its own separate chapter later in this manual.
5403
5404 You can have several routers, transports, or authenticators that are based on
5405 the same underlying driver (each must have a different instance name).
5406
5407 The order in which routers are defined is important, because addresses are
5408 passed to individual routers one by one, in order. The order in which
5409 transports are defined does not matter at all. The order in which
5410 authenticators are defined is used only when Exim, as a client, is searching
5411 them to find one that matches an authentication mechanism offered by the
5412 server.
5413
5414 .cindex "generic options"
5415 .cindex "options" "generic &-- definition of"
5416 Within a driver instance definition, there are two kinds of option: &'generic'&
5417 and &'private'&. The generic options are those that apply to all drivers of the
5418 same type (that is, all routers, all transports or all authenticators). The
5419 &%driver%& option is a generic option that must appear in every definition.
5420 .cindex "private options"
5421 The private options are special for each driver, and none need appear, because
5422 they all have default values.
5423
5424 The options may appear in any order, except that the &%driver%& option must
5425 precede any private options, since these depend on the particular driver. For
5426 this reason, it is recommended that &%driver%& always be the first option.
5427
5428 Driver instance names, which are used for reference in log entries and
5429 elsewhere, can be any sequence of letters, digits, and underscores (starting
5430 with a letter) and must be unique among drivers of the same type. A router and
5431 a transport (for example) can each have the same name, but no two router
5432 instances can have the same name. The name of a driver instance should not be
5433 confused with the name of the underlying driver module. For example, the
5434 configuration lines:
5435 .code
5436 remote_smtp:
5437   driver = smtp
5438 .endd
5439 create an instance of the &(smtp)& transport driver whose name is
5440 &(remote_smtp)&. The same driver code can be used more than once, with
5441 different instance names and different option settings each time. A second
5442 instance of the &(smtp)& transport, with different options, might be defined
5443 thus:
5444 .code
5445 special_smtp:
5446   driver = smtp
5447   port = 1234
5448   command_timeout = 10s
5449 .endd
5450 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5451 these transport instances from routers, and these names would appear in log
5452 lines.
5453
5454 Comment lines may be present in the middle of driver specifications. The full
5455 list of option settings for any particular driver instance, including all the
5456 defaulted values, can be extracted by making use of the &%-bP%& command line
5457 option.
5458
5459
5460
5461
5462
5463
5464 . ////////////////////////////////////////////////////////////////////////////
5465 . ////////////////////////////////////////////////////////////////////////////
5466
5467 .chapter "The default configuration file" "CHAPdefconfil"
5468 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5469 .cindex "default" "configuration file &""walk through""&"
5470 The default configuration file supplied with Exim as &_src/configure.default_&
5471 is sufficient for a host with simple mail requirements. As an introduction to
5472 the way Exim is configured, this chapter &"walks through"& the default
5473 configuration, giving brief explanations of the settings. Detailed descriptions
5474 of the options are given in subsequent chapters. The default configuration file
5475 itself contains extensive comments about ways you might want to modify the
5476 initial settings. However, note that there are many options that are not
5477 mentioned at all in the default configuration.
5478
5479
5480
5481 .section "Main configuration settings" "SECTdefconfmain"
5482 The main (global) configuration option settings must always come first in the
5483 file. The first thing you'll see in the file, after some initial comments, is
5484 the line
5485 .code
5486 # primary_hostname =
5487 .endd
5488 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5489 to know the official, fully qualified name of your host, and this is where you
5490 can specify it. However, in most cases you do not need to set this option. When
5491 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5492
5493 The first three non-comment configuration lines are as follows:
5494 .code
5495 domainlist local_domains    = @
5496 domainlist relay_to_domains =
5497 hostlist   relay_from_hosts = 127.0.0.1
5498 .endd
5499 These are not, in fact, option settings. They are definitions of two named
5500 domain lists and one named host list. Exim allows you to give names to lists of
5501 domains, hosts, and email addresses, in order to make it easier to manage the
5502 configuration file (see section &<<SECTnamedlists>>&).
5503
5504 The first line defines a domain list called &'local_domains'&; this is used
5505 later in the configuration to identify domains that are to be delivered
5506 on the local host.
5507
5508 .cindex "@ in a domain list"
5509 There is just one item in this list, the string &"@"&. This is a special form
5510 of entry which means &"the name of the local host"&. Thus, if the local host is
5511 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5512 be delivered locally. Because the local host's name is referenced indirectly,
5513 the same configuration file can be used on different hosts.
5514
5515 The second line defines a domain list called &'relay_to_domains'&, but the
5516 list itself is empty. Later in the configuration we will come to the part that
5517 controls mail relaying through the local host; it allows relaying to any
5518 domains in this list. By default, therefore, no relaying on the basis of a mail
5519 domain is permitted.
5520
5521 The third line defines a host list called &'relay_from_hosts'&. This list is
5522 used later in the configuration to permit relaying from any host or IP address
5523 that matches the list. The default contains just the IP address of the IPv4
5524 loopback interface, which means that processes on the local host are able to
5525 submit mail for relaying by sending it over TCP/IP to that interface. No other
5526 hosts are permitted to submit messages for relaying.
5527
5528 Just to be sure there's no misunderstanding: at this point in the configuration
5529 we aren't actually setting up any controls. We are just defining some domains
5530 and hosts that will be used in the controls that are specified later.
5531
5532 The next two configuration lines are genuine option settings:
5533 .code
5534 acl_smtp_rcpt = acl_check_rcpt
5535 acl_smtp_data = acl_check_data
5536 .endd
5537 These options specify &'Access Control Lists'& (ACLs) that are to be used
5538 during an incoming SMTP session for every recipient of a message (every RCPT
5539 command), and after the contents of the message have been received,
5540 respectively. The names of the lists are &'acl_check_rcpt'& and
5541 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5542 section of the configuration. The RCPT ACL controls which recipients are
5543 accepted for an incoming message &-- if a configuration does not provide an ACL
5544 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5545 contents of a message to be checked.
5546
5547 Two commented-out option settings are next:
5548 .code
5549 # av_scanner = clamd:/tmp/clamd
5550 # spamd_address = 127.0.0.1 783
5551 .endd
5552 These are example settings that can be used when Exim is compiled with the
5553 content-scanning extension. The first specifies the interface to the virus
5554 scanner, and the second specifies the interface to SpamAssassin. Further
5555 details are given in chapter &<<CHAPexiscan>>&.
5556
5557 Three more commented-out option settings follow:
5558 .code
5559 # tls_advertise_hosts = *
5560 # tls_certificate = /etc/ssl/exim.crt
5561 # tls_privatekey = /etc/ssl/exim.pem
5562 .endd
5563 These are example settings that can be used when Exim is compiled with
5564 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5565 first one specifies the list of clients that are allowed to use TLS when
5566 connecting to this server; in this case the wildcard means all clients. The
5567 other options specify where Exim should find its TLS certificate and private
5568 key, which together prove the server's identity to any clients that connect.
5569 More details are given in chapter &<<CHAPTLS>>&.
5570
5571 Another two commented-out option settings follow:
5572 .code
5573 # daemon_smtp_ports = 25 : 465 : 587
5574 # tls_on_connect_ports = 465
5575 .endd
5576 .cindex "port" "465 and 587"
5577 .cindex "port" "for message submission"
5578 .cindex "message" "submission, ports for"
5579 .cindex "ssmtp protocol"
5580 .cindex "smtps protocol"
5581 .cindex "SMTP" "ssmtp protocol"
5582 .cindex "SMTP" "smtps protocol"
5583 These options provide better support for roaming users who wish to use this
5584 server for message submission. They are not much use unless you have turned on
5585 TLS (as described in the previous paragraph) and authentication (about which
5586 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5587 on end-user networks, so RFC 4409 specifies that message submission should use
5588 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5589 configured to use port 587 correctly, so these settings also enable the
5590 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5591 &<<SECTsupobssmt>>&).
5592
5593 Two more commented-out options settings follow:
5594 .code
5595 # qualify_domain =
5596 # qualify_recipient =
5597 .endd
5598 The first of these specifies a domain that Exim uses when it constructs a
5599 complete email address from a local login name. This is often needed when Exim
5600 receives a message from a local process. If you do not set &%qualify_domain%&,
5601 the value of &%primary_hostname%& is used. If you set both of these options,
5602 you can have different qualification domains for sender and recipient
5603 addresses. If you set only the first one, its value is used in both cases.
5604
5605 .cindex "domain literal" "recognizing format"
5606 The following line must be uncommented if you want Exim to recognize
5607 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5608 (an IP address within square brackets) instead of a named domain.
5609 .code
5610 # allow_domain_literals
5611 .endd
5612 The RFCs still require this form, but many people think that in the modern
5613 Internet it makes little sense to permit mail to be sent to specific hosts by
5614 quoting their IP addresses. This ancient format has been used by people who
5615 try to abuse hosts by using them for unwanted relaying. However, some
5616 people believe there are circumstances (for example, messages addressed to
5617 &'postmaster'&) where domain literals are still useful.
5618
5619 The next configuration line is a kind of trigger guard:
5620 .code
5621 never_users = root
5622 .endd
5623 It specifies that no delivery must ever be run as the root user. The normal
5624 convention is to set up &'root'& as an alias for the system administrator. This
5625 setting is a guard against slips in the configuration.
5626 The list of users specified by &%never_users%& is not, however, the complete
5627 list; the build-time configuration in &_Local/Makefile_& has an option called
5628 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5629 contents of &%never_users%& are added to this list. By default
5630 FIXED_NEVER_USERS also specifies root.
5631
5632 When a remote host connects to Exim in order to send mail, the only information
5633 Exim has about the host's identity is its IP address. The next configuration
5634 line,
5635 .code
5636 host_lookup = *
5637 .endd
5638 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5639 in order to get a host name. This improves the quality of the logging
5640 information, but if you feel it is too expensive, you can remove it entirely,
5641 or restrict the lookup to hosts on &"nearby"& networks.
5642 Note that it is not always possible to find a host name from an IP address,
5643 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5644 unreachable.
5645
5646 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5647 1413 (hence their names):
5648 .code
5649 rfc1413_hosts = *
5650 rfc1413_query_timeout = 0s
5651 .endd
5652 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5653 Few hosts offer RFC1413 service these days; calls have to be
5654 terminated by a timeout and this needlessly delays the startup
5655 of an incoming SMTP connection.
5656 If you have hosts for which you trust RFC1413 and need this
5657 information, you can change this.
5658
5659 This line enables an efficiency SMTP option.  It is negotiated by clients
5660 and not expected to cause problems but can be disabled if needed.
5661 .code
5662 prdr_enable = true
5663 .endd
5664
5665 When Exim receives messages over SMTP connections, it expects all addresses to
5666 be fully qualified with a domain, as required by the SMTP definition. However,
5667 if you are running a server to which simple clients submit messages, you may
5668 find that they send unqualified addresses. The two commented-out options:
5669 .code
5670 # sender_unqualified_hosts =
5671 # recipient_unqualified_hosts =
5672 .endd
5673 show how you can specify hosts that are permitted to send unqualified sender
5674 and recipient addresses, respectively.
5675
5676 The &%log_selector%& option is used to increase the detail of logging
5677 over the default:
5678 .code
5679 log_selector = +smtp_protocol_error +smtp_syntax_error \
5680                +tls_certificate_verified
5681 .endd
5682
5683 The &%percent_hack_domains%& option is also commented out:
5684 .code
5685 # percent_hack_domains =
5686 .endd
5687 It provides a list of domains for which the &"percent hack"& is to operate.
5688 This is an almost obsolete form of explicit email routing. If you do not know
5689 anything about it, you can safely ignore this topic.
5690
5691 The next two settings in the main part of the default configuration are
5692 concerned with messages that have been &"frozen"& on Exim's queue. When a
5693 message is frozen, Exim no longer continues to try to deliver it. Freezing
5694 occurs when a bounce message encounters a permanent failure because the sender
5695 address of the original message that caused the bounce is invalid, so the
5696 bounce cannot be delivered. This is probably the most common case, but there
5697 are also other conditions that cause freezing, and frozen messages are not
5698 always bounce messages.
5699 .code
5700 ignore_bounce_errors_after = 2d
5701 timeout_frozen_after = 7d
5702 .endd
5703 The first of these options specifies that failing bounce messages are to be
5704 discarded after 2 days on the queue. The second specifies that any frozen
5705 message (whether a bounce message or not) is to be timed out (and discarded)
5706 after a week. In this configuration, the first setting ensures that no failing
5707 bounce message ever lasts a week.
5708
5709 Exim queues it's messages in a spool directory. If you expect to have
5710 large queues, you may consider using this option. It splits the spool
5711 directory into subdirectories to avoid file system degradation from
5712 many files in a single directory, resulting in better performance.
5713 Manual manipulation of queued messages becomes more complex (though fortunately
5714 not often needed).
5715 .code
5716 # split_spool_directory = true
5717 .endd
5718
5719 In an ideal world everybody follows the standards. For non-ASCII
5720 messages RFC 2047 is a standard, allowing a maximum line length of 76
5721 characters. Exim adheres that standard and won't process messages which
5722 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5723 In particular, the Exim maintainers have had multiple reports of
5724 problems from Russian administrators of issues until they disable this
5725 check, because of some popular, yet buggy, mail composition software.
5726 .code
5727 # check_rfc2047_length = false
5728 .endd
5729
5730 If you need to be strictly RFC compliant you may wish to disable the
5731 8BITMIME advertisement. Use this, if you exchange mails with systems
5732 that are not 8-bit clean.
5733 .code
5734 # accept_8bitmime = false
5735 .endd
5736
5737 Libraries you use may depend on specific environment settings.  This
5738 imposes a security risk (e.g. PATH). There are two lists:
5739 &%keep_environment%& for the variables to import as they are, and
5740 &%add_environment%& for variables we want to set to a fixed value.
5741 Note that TZ is handled separately, by the $%timezone%$ runtime
5742 option and by the TIMEZONE_DEFAULT buildtime option.
5743 .code
5744 # keep_environment = ^LDAP
5745 # add_environment = PATH=/usr/bin::/bin
5746 .endd
5747
5748
5749 .section "ACL configuration" "SECID54"
5750 .cindex "default" "ACLs"
5751 .cindex "&ACL;" "default configuration"
5752 In the default configuration, the ACL section follows the main configuration.
5753 It starts with the line
5754 .code
5755 begin acl
5756 .endd
5757 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5758 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5759 and &%acl_smtp_data%& above.
5760
5761 .cindex "RCPT" "ACL for"
5762 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5763 RCPT command specifies one of the message's recipients. The ACL statements
5764 are considered in order, until the recipient address is either accepted or
5765 rejected. The RCPT command is then accepted or rejected, according to the
5766 result of the ACL processing.
5767 .code
5768 acl_check_rcpt:
5769 .endd
5770 This line, consisting of a name terminated by a colon, marks the start of the
5771 ACL, and names it.
5772 .code
5773 accept  hosts = :
5774 .endd
5775 This ACL statement accepts the recipient if the sending host matches the list.
5776 But what does that strange list mean? It doesn't actually contain any host
5777 names or IP addresses. The presence of the colon puts an empty item in the
5778 list; Exim matches this only if the incoming message did not come from a remote
5779 host, because in that case, the remote hostname is empty. The colon is
5780 important. Without it, the list itself is empty, and can never match anything.
5781
5782 What this statement is doing is to accept unconditionally all recipients in
5783 messages that are submitted by SMTP from local processes using the standard
5784 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5785 manner.
5786 .code
5787 deny    message       = Restricted characters in address
5788         domains       = +local_domains
5789         local_parts   = ^[.] : ^.*[@%!/|]
5790
5791 deny    message       = Restricted characters in address
5792         domains       = !+local_domains
5793         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5794 .endd
5795 These statements are concerned with local parts that contain any of the
5796 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5797 Although these characters are entirely legal in local parts (in the case of
5798 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5799 in Internet mail addresses.
5800
5801 The first three have in the past been associated with explicitly routed
5802 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5803 option). Addresses containing these characters are regularly tried by spammers
5804 in an attempt to bypass relaying restrictions, and also by open relay testing
5805 programs. Unless you really need them it is safest to reject these characters
5806 at this early stage. This configuration is heavy-handed in rejecting these
5807 characters for all messages it accepts from remote hosts. This is a deliberate
5808 policy of being as safe as possible.
5809
5810 The first rule above is stricter, and is applied to messages that are addressed
5811 to one of the local domains handled by this host. This is implemented by the
5812 first condition, which restricts it to domains that are listed in the
5813 &'local_domains'& domain list. The &"+"& character is used to indicate a
5814 reference to a named list. In this configuration, there is just one domain in
5815 &'local_domains'&, but in general there may be many.
5816
5817 The second condition on the first statement uses two regular expressions to
5818 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5819 or &"|"&. If you have local accounts that include these characters, you will
5820 have to modify this rule.
5821
5822 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5823 allows them because they have been encountered in practice. (Consider the
5824 common convention of local parts constructed as
5825 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5826 the author of Exim, who has no second initial.) However, a local part starting
5827 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5828 file name (for example, for a mailing list). This is also true for local parts
5829 that contain slashes. A pipe symbol can also be troublesome if the local part
5830 is incorporated unthinkingly into a shell command line.
5831
5832 The second rule above applies to all other domains, and is less strict. This
5833 allows your own users to send outgoing messages to sites that use slashes
5834 and vertical bars in their local parts. It blocks local parts that begin
5835 with a dot, slash, or vertical bar, but allows these characters within the
5836 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5837 and &"!"& is blocked, as before. The motivation here is to prevent your users
5838 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5839 .code
5840 accept  local_parts   = postmaster
5841         domains       = +local_domains
5842 .endd
5843 This statement, which has two conditions, accepts an incoming address if the
5844 local part is &'postmaster'& and the domain is one of those listed in the
5845 &'local_domains'& domain list. The &"+"& character is used to indicate a
5846 reference to a named list. In this configuration, there is just one domain in
5847 &'local_domains'&, but in general there may be many.
5848
5849 The presence of this statement means that mail to postmaster is never blocked
5850 by any of the subsequent tests. This can be helpful while sorting out problems
5851 in cases where the subsequent tests are incorrectly denying access.
5852 .code
5853 require verify        = sender
5854 .endd
5855 This statement requires the sender address to be verified before any subsequent
5856 ACL statement can be used. If verification fails, the incoming recipient
5857 address is refused. Verification consists of trying to route the address, to
5858 see if a bounce message could be delivered to it. In the case of remote
5859 addresses, basic verification checks only the domain, but &'callouts'& can be
5860 used for more verification if required. Section &<<SECTaddressverification>>&
5861 discusses the details of address verification.
5862 .code
5863 accept  hosts         = +relay_from_hosts
5864         control       = submission
5865 .endd
5866 This statement accepts the address if the message is coming from one of the
5867 hosts that are defined as being allowed to relay through this host. Recipient
5868 verification is omitted here, because in many cases the clients are dumb MUAs
5869 that do not cope well with SMTP error responses. For the same reason, the
5870 second line specifies &"submission mode"& for messages that are accepted. This
5871 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5872 messages that are deficient in some way, for example, because they lack a
5873 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5874 probably add recipient verification here, and disable submission mode.
5875 .code
5876 accept  authenticated = *
5877         control       = submission
5878 .endd
5879 This statement accepts the address if the client host has authenticated itself.
5880 Submission mode is again specified, on the grounds that such messages are most
5881 likely to come from MUAs. The default configuration does not define any
5882 authenticators, though it does include some nearly complete commented-out
5883 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5884 fact authenticate until you complete the authenticator definitions.
5885 .code
5886 require message = relay not permitted
5887         domains = +local_domains : +relay_to_domains
5888 .endd
5889 This statement rejects the address if its domain is neither a local domain nor
5890 one of the domains for which this host is a relay.
5891 .code
5892 require verify = recipient
5893 .endd
5894 This statement requires the recipient address to be verified; if verification
5895 fails, the address is rejected.
5896 .code
5897 # deny    message     = rejected because $sender_host_address \
5898 #                       is in a black list at $dnslist_domain\n\
5899 #                       $dnslist_text
5900 #         dnslists    = black.list.example
5901 #
5902 # warn    dnslists    = black.list.example
5903 #         add_header  = X-Warning: $sender_host_address is in \
5904 #                       a black list at $dnslist_domain
5905 #         log_message = found in $dnslist_domain
5906 .endd
5907 These commented-out lines are examples of how you could configure Exim to check
5908 sending hosts against a DNS black list. The first statement rejects messages
5909 from blacklisted hosts, whereas the second just inserts a warning header
5910 line.
5911 .code
5912 # require verify = csa
5913 .endd
5914 This commented-out line is an example of how you could turn on client SMTP
5915 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5916 records.
5917 .code
5918 accept
5919 .endd
5920 The final statement in the first ACL unconditionally accepts any recipient
5921 address that has successfully passed all the previous tests.
5922 .code
5923 acl_check_data:
5924 .endd
5925 This line marks the start of the second ACL, and names it. Most of the contents
5926 of this ACL are commented out:
5927 .code
5928 # deny    malware   = *
5929 #         message   = This message contains a virus \
5930 #                     ($malware_name).
5931 .endd
5932 These lines are examples of how to arrange for messages to be scanned for
5933 viruses when Exim has been compiled with the content-scanning extension, and a
5934 suitable virus scanner is installed. If the message is found to contain a
5935 virus, it is rejected with the given custom error message.
5936 .code
5937 # warn    spam      = nobody
5938 #         message   = X-Spam_score: $spam_score\n\
5939 #                     X-Spam_score_int: $spam_score_int\n\
5940 #                     X-Spam_bar: $spam_bar\n\
5941 #                     X-Spam_report: $spam_report
5942 .endd
5943 These lines are an example of how to arrange for messages to be scanned by
5944 SpamAssassin when Exim has been compiled with the content-scanning extension,
5945 and SpamAssassin has been installed. The SpamAssassin check is run with
5946 &`nobody`& as its user parameter, and the results are added to the message as a
5947 series of extra header line. In this case, the message is not rejected,
5948 whatever the spam score.
5949 .code
5950 accept
5951 .endd
5952 This final line in the DATA ACL accepts the message unconditionally.
5953
5954
5955 .section "Router configuration" "SECID55"
5956 .cindex "default" "routers"
5957 .cindex "routers" "default"
5958 The router configuration comes next in the default configuration, introduced
5959 by the line
5960 .code
5961 begin routers
5962 .endd
5963 Routers are the modules in Exim that make decisions about where to send
5964 messages. An address is passed to each router in turn, until it is either
5965 accepted, or failed. This means that the order in which you define the routers
5966 matters. Each router is fully described in its own chapter later in this
5967 manual. Here we give only brief overviews.
5968 .code
5969 # domain_literal:
5970 #   driver = ipliteral
5971 #   domains = !+local_domains
5972 #   transport = remote_smtp
5973 .endd
5974 .cindex "domain literal" "default router"
5975 This router is commented out because the majority of sites do not want to
5976 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5977 you uncomment this router, you also need to uncomment the setting of
5978 &%allow_domain_literals%& in the main part of the configuration.
5979 .code
5980 dnslookup:
5981   driver = dnslookup
5982   domains = ! +local_domains
5983   transport = remote_smtp
5984   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5985   no_more
5986 .endd
5987 The first uncommented router handles addresses that do not involve any local
5988 domains. This is specified by the line
5989 .code
5990 domains = ! +local_domains
5991 .endd
5992 The &%domains%& option lists the domains to which this router applies, but the
5993 exclamation mark is a negation sign, so the router is used only for domains
5994 that are not in the domain list called &'local_domains'& (which was defined at
5995 the start of the configuration). The plus sign before &'local_domains'&
5996 indicates that it is referring to a named list. Addresses in other domains are
5997 passed on to the following routers.
5998
5999 The name of the router driver is &(dnslookup)&,
6000 and is specified by the &%driver%& option. Do not be confused by the fact that
6001 the name of this router instance is the same as the name of the driver. The
6002 instance name is arbitrary, but the name set in the &%driver%& option must be
6003 one of the driver modules that is in the Exim binary.
6004
6005 The &(dnslookup)& router routes addresses by looking up their domains in the
6006 DNS in order to obtain a list of hosts to which the address is routed. If the
6007 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6008 specified by the &%transport%& option. If the router does not find the domain
6009 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6010 the address fails and is bounced.
6011
6012 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6013 be entirely ignored. This option is present because a number of cases have been
6014 encountered where MX records in the DNS point to host names
6015 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6016 Completely ignoring these IP addresses causes Exim to fail to route the
6017 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6018 continue to try to deliver the message periodically until the address timed
6019 out.
6020 .code
6021 system_aliases:
6022   driver = redirect
6023   allow_fail
6024   allow_defer
6025   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6026 # user = exim
6027   file_transport = address_file
6028   pipe_transport = address_pipe
6029 .endd
6030 Control reaches this and subsequent routers only for addresses in the local
6031 domains. This router checks to see whether the local part is defined as an
6032 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6033 data that it looks up from that file. If no data is found for the local part,
6034 the value of the &%data%& option is empty, causing the address to be passed to
6035 the next router.
6036
6037 &_/etc/aliases_& is a conventional name for the system aliases file that is
6038 often used. That is why it is referenced by from the default configuration
6039 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6040 &_Local/Makefile_& before building Exim.
6041 .code
6042 userforward:
6043   driver = redirect
6044   check_local_user
6045 # local_part_suffix = +* : -*
6046 # local_part_suffix_optional
6047   file = $home/.forward
6048 # allow_filter
6049   no_verify
6050   no_expn
6051   check_ancestor
6052   file_transport = address_file
6053   pipe_transport = address_pipe
6054   reply_transport = address_reply
6055 .endd
6056 This is the most complicated router in the default configuration. It is another
6057 redirection router, but this time it is looking for forwarding data set up by
6058 individual users. The &%check_local_user%& setting specifies a check that the
6059 local part of the address is the login name of a local user. If it is not, the
6060 router is skipped. The two commented options that follow &%check_local_user%&,
6061 namely:
6062 .code
6063 # local_part_suffix = +* : -*
6064 # local_part_suffix_optional
6065 .endd
6066 .vindex "&$local_part_suffix$&"
6067 show how you can specify the recognition of local part suffixes. If the first
6068 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6069 by any sequence of characters, is removed from the local part and placed in the
6070 variable &$local_part_suffix$&. The second suffix option specifies that the
6071 presence of a suffix in the local part is optional. When a suffix is present,
6072 the check for a local login uses the local part with the suffix removed.
6073
6074 When a local user account is found, the file called &_.forward_& in the user's
6075 home directory is consulted. If it does not exist, or is empty, the router
6076 declines. Otherwise, the contents of &_.forward_& are interpreted as
6077 redirection data (see chapter &<<CHAPredirect>>& for more details).
6078
6079 .cindex "Sieve filter" "enabling in default router"
6080 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6081 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6082 is commented out by default), the contents of the file are interpreted as a set
6083 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6084 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6085 separate document entitled &'Exim's interfaces to mail filtering'&.
6086
6087 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6088 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6089 There are two reasons for doing this:
6090
6091 .olist
6092 Whether or not a local user has a &_.forward_& file is not really relevant when
6093 checking an address for validity; it makes sense not to waste resources doing
6094 unnecessary work.
6095 .next
6096 More importantly, when Exim is verifying addresses or handling an EXPN
6097 command during an SMTP session, it is running as the Exim user, not as root.
6098 The group is the Exim group, and no additional groups are set up.
6099 It may therefore not be possible for Exim to read users' &_.forward_& files at
6100 this time.
6101 .endlist
6102
6103 The setting of &%check_ancestor%& prevents the router from generating a new
6104 address that is the same as any previous address that was redirected. (This
6105 works round a problem concerning a bad interaction between aliasing and
6106 forwarding &-- see section &<<SECTredlocmai>>&).
6107
6108 The final three option settings specify the transports that are to be used when
6109 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6110 auto-reply, respectively. For example, if a &_.forward_& file contains
6111 .code
6112 a.nother@elsewhere.example, /home/spqr/archive
6113 .endd
6114 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6115 transport.
6116 .code
6117 localuser:
6118   driver = accept
6119   check_local_user
6120 # local_part_suffix = +* : -*
6121 # local_part_suffix_optional
6122   transport = local_delivery
6123 .endd
6124 The final router sets up delivery into local mailboxes, provided that the local
6125 part is the name of a local login, by accepting the address and assigning it to
6126 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6127 routers, so the address is bounced. The commented suffix settings fulfil the
6128 same purpose as they do for the &(userforward)& router.
6129
6130
6131 .section "Transport configuration" "SECID56"
6132 .cindex "default" "transports"
6133 .cindex "transports" "default"
6134 Transports define mechanisms for actually delivering messages. They operate
6135 only when referenced from routers, so the order in which they are defined does
6136 not matter. The transports section of the configuration starts with
6137 .code
6138 begin transports
6139 .endd
6140 One remote transport and four local transports are defined.
6141 .code
6142 remote_smtp:
6143   driver = smtp
6144   hosts_try_prdr = *
6145 .endd
6146 This transport is used for delivering messages over SMTP connections.
6147 The list of remote hosts comes from the router.
6148 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6149 It is negotiated between client and server
6150 and not expected to cause problems but can be disabled if needed.
6151 All other options are defaulted.
6152 .code
6153 local_delivery:
6154   driver = appendfile
6155   file = /var/mail/$local_part
6156   delivery_date_add
6157   envelope_to_add
6158   return_path_add
6159 # group = mail
6160 # mode = 0660
6161 .endd
6162 This &(appendfile)& transport is used for local delivery to user mailboxes in
6163 traditional BSD mailbox format. By default it runs under the uid and gid of the
6164 local user, which requires the sticky bit to be set on the &_/var/mail_&
6165 directory. Some systems use the alternative approach of running mail deliveries
6166 under a particular group instead of using the sticky bit. The commented options
6167 show how this can be done.
6168
6169 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6170 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6171 similarly-named options above.
6172 .code
6173 address_pipe:
6174   driver = pipe
6175   return_output
6176 .endd
6177 This transport is used for handling deliveries to pipes that are generated by
6178 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6179 option specifies that any output on stdout or stderr generated by the pipe is to
6180 be returned to the sender.
6181 .code
6182 address_file:
6183   driver = appendfile
6184   delivery_date_add
6185   envelope_to_add
6186   return_path_add
6187 .endd
6188 This transport is used for handling deliveries to files that are generated by
6189 redirection. The name of the file is not specified in this instance of
6190 &(appendfile)&, because it comes from the &(redirect)& router.
6191 .code
6192 address_reply:
6193   driver = autoreply
6194 .endd
6195 This transport is used for handling automatic replies generated by users'
6196 filter files.
6197
6198
6199
6200 .section "Default retry rule" "SECID57"
6201 .cindex "retry" "default rule"
6202 .cindex "default" "retry rule"
6203 The retry section of the configuration file contains rules which affect the way
6204 Exim retries deliveries that cannot be completed at the first attempt. It is
6205 introduced by the line
6206 .code
6207 begin retry
6208 .endd
6209 In the default configuration, there is just one rule, which applies to all
6210 errors:
6211 .code
6212 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6213 .endd
6214 This causes any temporarily failing address to be retried every 15 minutes for
6215 2 hours, then at intervals starting at one hour and increasing by a factor of
6216 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6217 is not delivered after 4 days of temporary failure, it is bounced. The time is
6218 measured from first failure, not from the time the message was received.
6219
6220 If the retry section is removed from the configuration, or is empty (that is,
6221 if no retry rules are defined), Exim will not retry deliveries. This turns
6222 temporary errors into permanent errors.
6223
6224
6225 .section "Rewriting configuration" "SECID58"
6226 The rewriting section of the configuration, introduced by
6227 .code
6228 begin rewrite
6229 .endd
6230 contains rules for rewriting addresses in messages as they arrive. There are no
6231 rewriting rules in the default configuration file.
6232
6233
6234
6235 .section "Authenticators configuration" "SECTdefconfauth"
6236 .cindex "AUTH" "configuration"
6237 The authenticators section of the configuration, introduced by
6238 .code
6239 begin authenticators
6240 .endd
6241 defines mechanisms for the use of the SMTP AUTH command. The default
6242 configuration file contains two commented-out example authenticators
6243 which support plaintext username/password authentication using the
6244 standard PLAIN mechanism and the traditional but non-standard LOGIN
6245 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6246 to support most MUA software.
6247
6248 The example PLAIN authenticator looks like this:
6249 .code
6250 #PLAIN:
6251 #  driver                  = plaintext
6252 #  server_set_id           = $auth2
6253 #  server_prompts          = :
6254 #  server_condition        = Authentication is not yet configured
6255 #  server_advertise_condition = ${if def:tls_in_cipher }
6256 .endd
6257 And the example LOGIN authenticator looks like this:
6258 .code
6259 #LOGIN:
6260 #  driver                  = plaintext
6261 #  server_set_id           = $auth1
6262 #  server_prompts          = <| Username: | Password:
6263 #  server_condition        = Authentication is not yet configured
6264 #  server_advertise_condition = ${if def:tls_in_cipher }
6265 .endd
6266
6267 The &%server_set_id%& option makes Exim remember the authenticated username
6268 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6269 &%server_prompts%& option configures the &(plaintext)& authenticator so
6270 that it implements the details of the specific authentication mechanism,
6271 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6272 when Exim offers authentication to clients; in the examples, this is only
6273 when TLS or SSL has been started, so to enable the authenticators you also
6274 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6275
6276 The &%server_condition%& setting defines how to verify that the username and
6277 password are correct. In the examples it just produces an error message.
6278 To make the authenticators work, you can use a string expansion
6279 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6280
6281 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6282 usercode and password are in different positions.
6283 Chapter &<<CHAPplaintext>>& covers both.
6284
6285 .ecindex IIDconfiwal
6286
6287
6288
6289 . ////////////////////////////////////////////////////////////////////////////
6290 . ////////////////////////////////////////////////////////////////////////////
6291
6292 .chapter "Regular expressions" "CHAPregexp"
6293
6294 .cindex "regular expressions" "library"
6295 .cindex "PCRE"
6296 Exim supports the use of regular expressions in many of its options. It
6297 uses the PCRE regular expression library; this provides regular expression
6298 matching that is compatible with Perl 5. The syntax and semantics of
6299 regular expressions is discussed in
6300 online Perl manpages, in
6301 many Perl reference books, and also in
6302 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6303 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6304
6305 The documentation for the syntax and semantics of the regular expressions that
6306 are supported by PCRE is included in the PCRE distribution, and no further
6307 description is included here. The PCRE functions are called from Exim using
6308 the default option settings (that is, with no PCRE options set), except that
6309 the PCRE_CASELESS option is set when the matching is required to be
6310 case-insensitive.
6311
6312 In most cases, when a regular expression is required in an Exim configuration,
6313 it has to start with a circumflex, in order to distinguish it from plain text
6314 or an &"ends with"& wildcard. In this example of a configuration setting, the
6315 second item in the colon-separated list is a regular expression.
6316 .code
6317 domains = a.b.c : ^\\d{3} : *.y.z : ...
6318 .endd
6319 The doubling of the backslash is required because of string expansion that
6320 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6321 of this issue, and a way of avoiding the need for doubling backslashes. The
6322 regular expression that is eventually used in this example contains just one
6323 backslash. The circumflex is included in the regular expression, and has the
6324 normal effect of &"anchoring"& it to the start of the string that is being
6325 matched.
6326
6327 There are, however, two cases where a circumflex is not required for the
6328 recognition of a regular expression: these are the &%match%& condition in a
6329 string expansion, and the &%matches%& condition in an Exim filter file. In
6330 these cases, the relevant string is always treated as a regular expression; if
6331 it does not start with a circumflex, the expression is not anchored, and can
6332 match anywhere in the subject string.
6333
6334 In all cases, if you want a regular expression to match at the end of a string,
6335 you must code the $ metacharacter to indicate this. For example:
6336 .code
6337 domains = ^\\d{3}\\.example
6338 .endd
6339 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6340 You need to use:
6341 .code
6342 domains = ^\\d{3}\\.example\$
6343 .endd
6344 if you want &'example'& to be the top-level domain. The backslash before the
6345 $ is needed because string expansion also interprets dollar characters.
6346
6347
6348
6349 . ////////////////////////////////////////////////////////////////////////////
6350 . ////////////////////////////////////////////////////////////////////////////
6351
6352 .chapter "File and database lookups" "CHAPfdlookup"
6353 .scindex IIDfidalo1 "file" "lookups"
6354 .scindex IIDfidalo2 "database" "lookups"
6355 .cindex "lookup" "description of"
6356 Exim can be configured to look up data in files or databases as it processes
6357 messages. Two different kinds of syntax are used:
6358
6359 .olist
6360 A string that is to be expanded may contain explicit lookup requests. These
6361 cause parts of the string to be replaced by data that is obtained from the
6362 lookup. Lookups of this type are conditional expansion items. Different results
6363 can be defined for the cases of lookup success and failure. See chapter
6364 &<<CHAPexpand>>&, where string expansions are described in detail.
6365 The key for the lookup is specified as part of the string expansion.
6366 .next
6367 Lists of domains, hosts, and email addresses can contain lookup requests as a
6368 way of avoiding excessively long linear lists. In this case, the data that is
6369 returned by the lookup is often (but not always) discarded; whether the lookup
6370 succeeds or fails is what really counts. These kinds of list are described in
6371 chapter &<<CHAPdomhosaddlists>>&.
6372 The key for the lookup is given by the context in which the list is expanded.
6373 .endlist
6374
6375 String expansions, lists, and lookups interact with each other in such a way
6376 that there is no order in which to describe any one of them that does not
6377 involve references to the others. Each of these three chapters makes more sense
6378 if you have read the other two first. If you are reading this for the first
6379 time, be aware that some of it will make a lot more sense after you have read
6380 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6381
6382 .section "Examples of different lookup syntax" "SECID60"
6383 It is easy to confuse the two different kinds of lookup, especially as the
6384 lists that may contain the second kind are always expanded before being
6385 processed as lists. Therefore, they may also contain lookups of the first kind.
6386 Be careful to distinguish between the following two examples:
6387 .code
6388 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6389 domains = lsearch;/some/file
6390 .endd
6391 The first uses a string expansion, the result of which must be a domain list.
6392 No strings have been specified for a successful or a failing lookup; the
6393 defaults in this case are the looked-up data and an empty string, respectively.
6394 The expansion takes place before the string is processed as a list, and the
6395 file that is searched could contain lines like this:
6396 .code
6397 192.168.3.4: domain1:domain2:...
6398 192.168.1.9: domain3:domain4:...
6399 .endd
6400 When the lookup succeeds, the result of the expansion is a list of domains (and
6401 possibly other types of item that are allowed in domain lists).
6402
6403 In the second example, the lookup is a single item in a domain list. It causes
6404 Exim to use a lookup to see if the domain that is being processed can be found
6405 in the file. The file could contains lines like this:
6406 .code
6407 domain1:
6408 domain2:
6409 .endd
6410 Any data that follows the keys is not relevant when checking that the domain
6411 matches the list item.
6412
6413 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6414 Consider a file containing lines like this:
6415 .code
6416 192.168.5.6: lsearch;/another/file
6417 .endd
6418 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6419 first &%domains%& setting above generates the second setting, which therefore
6420 causes a second lookup to occur.
6421
6422 The rest of this chapter describes the different lookup types that are
6423 available. Any of them can be used in any part of the configuration where a
6424 lookup is permitted.
6425
6426
6427 .section "Lookup types" "SECID61"
6428 .cindex "lookup" "types of"
6429 .cindex "single-key lookup" "definition of"
6430 Two different types of data lookup are implemented:
6431
6432 .ilist
6433 The &'single-key'& type requires the specification of a file in which to look,
6434 and a single key to search for. The key must be a non-empty string for the
6435 lookup to succeed. The lookup type determines how the file is searched.
6436 .next
6437 .cindex "query-style lookup" "definition of"
6438 The &'query-style'& type accepts a generalized database query. No particular
6439 key value is assumed by Exim for query-style lookups. You can use whichever
6440 Exim variables you need to construct the database query.
6441 .endlist
6442
6443 The code for each lookup type is in a separate source file that is included in
6444 the binary of Exim only if the corresponding compile-time option is set. The
6445 default settings in &_src/EDITME_& are:
6446 .code
6447 LOOKUP_DBM=yes
6448 LOOKUP_LSEARCH=yes
6449 .endd
6450 which means that only linear searching and DBM lookups are included by default.
6451 For some types of lookup (e.g. SQL databases), you need to install appropriate
6452 libraries and header files before building Exim.
6453
6454
6455
6456
6457 .section "Single-key lookup types" "SECTsinglekeylookups"
6458 .cindex "lookup" "single-key types"
6459 .cindex "single-key lookup" "list of types"
6460 The following single-key lookup types are implemented:
6461
6462 .ilist
6463 .cindex "cdb" "description of"
6464 .cindex "lookup" "cdb"
6465 .cindex "binary zero" "in lookup key"
6466 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6467 string without a terminating binary zero. The cdb format is designed for
6468 indexed files that are read frequently and never updated, except by total
6469 re-creation. As such, it is particularly suitable for large files containing
6470 aliases or other indexed data referenced by an MTA. Information about cdb can
6471 be found in several places:
6472 .display
6473 &url(http://www.pobox.com/~djb/cdb.html)
6474 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6475 &url(http://packages.debian.org/stable/utils/freecdb.html)
6476 .endd
6477 A cdb distribution is not needed in order to build Exim with cdb support,
6478 because the code for reading cdb files is included directly in Exim itself.
6479 However, no means of building or testing cdb files is provided with Exim, so
6480 you need to obtain a cdb distribution in order to do this.
6481 .next
6482 .cindex "DBM" "lookup type"
6483 .cindex "lookup" "dbm"
6484 .cindex "binary zero" "in lookup key"
6485 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6486 DBM file by looking up the record with the given key. A terminating binary
6487 zero is included in the key that is passed to the DBM library. See section
6488 &<<SECTdb>>& for a discussion of DBM libraries.
6489
6490 .cindex "Berkeley DB library" "file format"
6491 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6492 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6493 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6494 the DB_UNKNOWN option. This enables it to handle any of the types of database
6495 that the library supports, and can be useful for accessing DBM files created by
6496 other applications. (For earlier DB versions, DB_HASH is always used.)
6497 .next
6498 .cindex "lookup" "dbmjz"
6499 .cindex "lookup" "dbm &-- embedded NULs"
6500 .cindex "sasldb2"
6501 .cindex "dbmjz lookup type"
6502 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6503 interpreted as an Exim list; the elements of the list are joined together with
6504 ASCII NUL characters to form the lookup key.  An example usage would be to
6505 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6506 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6507 &(cram_md5)& authenticator.
6508 .next
6509 .cindex "lookup" "dbmnz"
6510 .cindex "lookup" "dbm &-- terminating zero"
6511 .cindex "binary zero" "in lookup key"
6512 .cindex "Courier"
6513 .cindex "&_/etc/userdbshadow.dat_&"
6514 .cindex "dbmnz lookup type"
6515 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6516 is not included in the key that is passed to the DBM library. You may need this
6517 if you want to look up data in files that are created by or shared with some
6518 other application that does not use terminating zeros. For example, you need to
6519 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6520 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6521 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6522 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6523 .next
6524 .cindex "lookup" "dsearch"
6525 .cindex "dsearch lookup type"
6526 &(dsearch)&: The given file must be a directory; this is searched for an entry
6527 whose name is the key by calling the &[lstat()]& function. The key may not
6528 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6529 the lookup is the name of the entry, which may be a file, directory,
6530 symbolic link, or any other kind of directory entry. An example of how this
6531 lookup can be used to support virtual domains is given in section
6532 &<<SECTvirtualdomains>>&.
6533 .next
6534 .cindex "lookup" "iplsearch"
6535 .cindex "iplsearch lookup type"
6536 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6537 terminated by a colon or white space or the end of the line. The keys in the
6538 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6539 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6540 being interpreted as a key terminator. For example:
6541 .code
6542 1.2.3.4:           data for 1.2.3.4
6543 192.168.0.0/16:    data for 192.168.0.0/16
6544 "abcd::cdab":      data for abcd::cdab
6545 "abcd:abcd::/32"   data for abcd:abcd::/32
6546 .endd
6547 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6548 file is searched linearly, using the CIDR masks where present, until a matching
6549 key is found. The first key that matches is used; there is no attempt to find a
6550 &"best"& match. Apart from the way the keys are matched, the processing for
6551 &(iplsearch)& is the same as for &(lsearch)&.
6552
6553 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6554 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6555 lookup types support only literal keys.
6556
6557 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6558 the implicit key is the host's IP address rather than its name (see section
6559 &<<SECThoslispatsikey>>&).
6560 .next
6561 .cindex "linear search"
6562 .cindex "lookup" "lsearch"
6563 .cindex "lsearch lookup type"
6564 .cindex "case sensitivity" "in lsearch lookup"
6565 &(lsearch)&: The given file is a text file that is searched linearly for a
6566 line beginning with the search key, terminated by a colon or white space or the
6567 end of the line. The search is case-insensitive; that is, upper and lower case
6568 letters are treated as the same. The first occurrence of the key that is found
6569 in the file is used.
6570
6571 White space between the key and the colon is permitted. The remainder of the
6572 line, with leading and trailing white space removed, is the data. This can be
6573 continued onto subsequent lines by starting them with any amount of white
6574 space, but only a single space character is included in the data at such a
6575 junction. If the data begins with a colon, the key must be terminated by a
6576 colon, for example:
6577 .code
6578 baduser:  :fail:
6579 .endd
6580 Empty lines and lines beginning with # are ignored, even if they occur in the
6581 middle of an item. This is the traditional textual format of alias files. Note
6582 that the keys in an &(lsearch)& file are literal strings. There is no
6583 wildcarding of any kind.
6584
6585 .cindex "lookup" "lsearch &-- colons in keys"
6586 .cindex "white space" "in lsearch key"
6587 In most &(lsearch)& files, keys are not required to contain colons or #
6588 characters, or white space. However, if you need this feature, it is available.
6589 If a key begins with a doublequote character, it is terminated only by a
6590 matching quote (or end of line), and the normal escaping rules apply to its
6591 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6592 quoted keys (exactly as for unquoted keys). There is no special handling of
6593 quotes for the data part of an &(lsearch)& line.
6594
6595 .next
6596 .cindex "NIS lookup type"
6597 .cindex "lookup" "NIS"
6598 .cindex "binary zero" "in lookup key"
6599 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6600 the given key, without a terminating binary zero. There is a variant called
6601 &(nis0)& which does include the terminating binary zero in the key. This is
6602 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6603 aliases; the full map names must be used.
6604
6605 .next
6606 .cindex "wildlsearch lookup type"
6607 .cindex "lookup" "wildlsearch"
6608 .cindex "nwildlsearch lookup type"
6609 .cindex "lookup" "nwildlsearch"
6610 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6611 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6612 the file may be wildcarded. The difference between these two lookup types is
6613 that for &(wildlsearch)&, each key in the file is string-expanded before being
6614 used, whereas for &(nwildlsearch)&, no expansion takes place.
6615
6616 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6617 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6618 file that are regular expressions can be made case-sensitive by the use of
6619 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6620
6621 . ==== As this is a nested list, any displays it contains must be indented
6622 . ==== as otherwise they are too far to the left.
6623
6624 .olist
6625 The string may begin with an asterisk to mean &"ends with"&. For example:
6626 .code
6627     *.a.b.c       data for anything.a.b.c
6628     *fish         data for anythingfish
6629 .endd
6630 .next
6631 The string may begin with a circumflex to indicate a regular expression. For
6632 example, for &(wildlsearch)&:
6633 .code
6634     ^\N\d+\.a\.b\N    data for <digits>.a.b
6635 .endd
6636 Note the use of &`\N`& to disable expansion of the contents of the regular
6637 expression. If you are using &(nwildlsearch)&, where the keys are not
6638 string-expanded, the equivalent entry is:
6639 .code
6640     ^\d+\.a\.b        data for <digits>.a.b
6641 .endd
6642 The case-insensitive flag is set at the start of compiling the regular
6643 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6644 For example, to make the entire pattern case-sensitive:
6645 .code
6646     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6647 .endd
6648
6649 If the regular expression contains white space or colon characters, you must
6650 either quote it (see &(lsearch)& above), or represent these characters in other
6651 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6652 colon. This may be easier than quoting, because if you quote, you have to
6653 escape all the backslashes inside the quotes.
6654
6655 &*Note*&: It is not possible to capture substrings in a regular expression
6656 match for later use, because the results of all lookups are cached. If a lookup
6657 is repeated, the result is taken from the cache, and no actual pattern matching
6658 takes place. The values of all the numeric variables are unset after a
6659 &((n)wildlsearch)& match.
6660
6661 .next
6662 Although I cannot see it being of much use, the general matching function that
6663 is used to implement &((n)wildlsearch)& means that the string may begin with a
6664 lookup name terminated by a semicolon, and followed by lookup data. For
6665 example:
6666 .code
6667     cdb;/some/file  data for keys that match the file
6668 .endd
6669 The data that is obtained from the nested lookup is discarded.
6670 .endlist olist
6671
6672 Keys that do not match any of these patterns are interpreted literally. The
6673 continuation rules for the data are the same as for &(lsearch)&, and keys may
6674 be followed by optional colons.
6675
6676 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6677 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6678 lookup types support only literal keys.
6679 .endlist ilist
6680
6681
6682 .section "Query-style lookup types" "SECTquerystylelookups"
6683 .cindex "lookup" "query-style types"
6684 .cindex "query-style lookup" "list of types"
6685 The supported query-style lookup types are listed below. Further details about
6686 many of them are given in later sections.
6687
6688 .ilist
6689 .cindex "DNS" "as a lookup type"
6690 .cindex "lookup" "DNS"
6691 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6692 are given in the supplied query. The resulting data is the contents of the
6693 records. See section &<<SECTdnsdb>>&.
6694 .next
6695 .cindex "InterBase lookup type"
6696 .cindex "lookup" "InterBase"
6697 &(ibase)&: This does a lookup in an InterBase database.
6698 .next
6699 .cindex "LDAP" "lookup type"
6700 .cindex "lookup" "LDAP"
6701 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6702 returns attributes from a single entry. There is a variant called &(ldapm)&
6703 that permits values from multiple entries to be returned. A third variant
6704 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6705 any attribute values. See section &<<SECTldap>>&.
6706 .next
6707 .cindex "MySQL" "lookup type"
6708 .cindex "lookup" "MySQL"
6709 &(mysql)&: The format of the query is an SQL statement that is passed to a
6710 MySQL database. See section &<<SECTsql>>&.
6711 .next
6712 .cindex "NIS+ lookup type"
6713 .cindex "lookup" "NIS+"
6714 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6715 the field to be returned. See section &<<SECTnisplus>>&.
6716 .next
6717 .cindex "Oracle" "lookup type"
6718 .cindex "lookup" "Oracle"
6719 &(oracle)&: The format of the query is an SQL statement that is passed to an
6720 Oracle database. See section &<<SECTsql>>&.
6721 .next
6722 .cindex "lookup" "passwd"
6723 .cindex "passwd lookup type"
6724 .cindex "&_/etc/passwd_&"
6725 &(passwd)& is a query-style lookup with queries that are just user names. The
6726 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6727 success, the result string is the same as you would get from an &(lsearch)&
6728 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6729 password value. For example:
6730 .code
6731 *:42:42:King Rat:/home/kr:/bin/bash
6732 .endd
6733 .next
6734 .cindex "PostgreSQL lookup type"
6735 .cindex "lookup" "PostgreSQL"
6736 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6737 PostgreSQL database. See section &<<SECTsql>>&.
6738
6739 .next
6740 .cindex "Redis lookup type"
6741 .cindex lookup Redis
6742 &(redis)&: The format of the query is either a simple get or simple set,
6743 passed to a Redis database. See section &<<SECTsql>>&.
6744
6745 .next
6746 .cindex "sqlite lookup type"
6747 .cindex "lookup" "sqlite"
6748 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6749 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6750
6751 .next
6752 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6753 not likely to be useful in normal operation.
6754 .next
6755 .cindex "whoson lookup type"
6756 .cindex "lookup" "whoson"
6757 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6758 allows a server to check whether a particular (dynamically allocated) IP
6759 address is currently allocated to a known (trusted) user and, optionally, to
6760 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6761 at one time for &"POP before SMTP"& authentication, but that approach has been
6762 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6763 &"POP before SMTP"& checking using ACL statements such as
6764 .code
6765 require condition = \
6766   ${lookup whoson {$sender_host_address}{yes}{no}}
6767 .endd
6768 The query consists of a single IP address. The value returned is the name of
6769 the authenticated user, which is stored in the variable &$value$&. However, in
6770 this example, the data in &$value$& is not used; the result of the lookup is
6771 one of the fixed strings &"yes"& or &"no"&.
6772 .endlist
6773
6774
6775
6776 .section "Temporary errors in lookups" "SECID63"
6777 .cindex "lookup" "temporary error in"
6778 Lookup functions can return temporary error codes if the lookup cannot be
6779 completed. For example, an SQL or LDAP database might be unavailable. For this
6780 reason, it is not advisable to use a lookup that might do this for critical
6781 options such as a list of local domains.
6782
6783 When a lookup cannot be completed in a router or transport, delivery
6784 of the message (to the relevant address) is deferred, as for any other
6785 temporary error. In other circumstances Exim may assume the lookup has failed,
6786 or may give up altogether.
6787
6788
6789
6790 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6791 .cindex "wildcard lookups"
6792 .cindex "lookup" "default values"
6793 .cindex "lookup" "wildcard"
6794 .cindex "lookup" "* added to type"
6795 .cindex "default" "in single-key lookups"
6796 In this context, a &"default value"& is a value specified by the administrator
6797 that is to be used if a lookup fails.
6798
6799 &*Note:*& This section applies only to single-key lookups. For query-style
6800 lookups, the facilities of the query language must be used. An attempt to
6801 specify a default for a query-style lookup provokes an error.
6802
6803 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6804 and the initial lookup fails, the key &"*"& is looked up in the file to
6805 provide a default value. See also the section on partial matching below.
6806
6807 .cindex "*@ with single-key lookup"
6808 .cindex "lookup" "*@ added to type"
6809 .cindex "alias file" "per-domain default"
6810 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6811 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6812 character, a second lookup is done with everything before the last @ replaced
6813 by *. This makes it possible to provide per-domain defaults in alias files
6814 that include the domains in the keys. If the second lookup fails (or doesn't
6815 take place because there is no @ in the key), &"*"& is looked up.
6816 For example, a &(redirect)& router might contain:
6817 .code
6818 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6819 .endd
6820 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6821 looks up these keys, in this order:
6822 .code
6823 jane@eyre.example
6824 *@eyre.example
6825 *
6826 .endd
6827 The data is taken from whichever key it finds first. &*Note*&: In an
6828 &(lsearch)& file, this does not mean the first of these keys in the file. A
6829 complete scan is done for each key, and only if it is not found at all does
6830 Exim move on to try the next key.
6831
6832
6833
6834 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6835 .cindex "partial matching"
6836 .cindex "wildcard lookups"
6837 .cindex "lookup" "partial matching"
6838 .cindex "lookup" "wildcard"
6839 .cindex "asterisk" "in search type"
6840 The normal operation of a single-key lookup is to search the file for an exact
6841 match with the given key. However, in a number of situations where domains are
6842 being looked up, it is useful to be able to do partial matching. In this case,
6843 information in the file that has a key starting with &"*."& is matched by any
6844 domain that ends with the components that follow the full stop. For example, if
6845 a key in a DBM file is
6846 .code
6847 *.dates.fict.example
6848 .endd
6849 then when partial matching is enabled this is matched by (amongst others)
6850 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6851 by &'dates.fict.example'&, if that does not appear as a separate key in the
6852 file.
6853
6854 &*Note*&: Partial matching is not available for query-style lookups. It is
6855 also not available for any lookup items in address lists (see section
6856 &<<SECTaddresslist>>&).
6857
6858 Partial matching is implemented by doing a series of separate lookups using
6859 keys constructed by modifying the original subject key. This means that it can
6860 be used with any of the single-key lookup types, provided that
6861 partial matching keys
6862 beginning with a special prefix (default &"*."&) are included in the data file.
6863 Keys in the file that do not begin with the prefix are matched only by
6864 unmodified subject keys when partial matching is in use.
6865
6866 Partial matching is requested by adding the string &"partial-"& to the front of
6867 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6868 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6869 is added at the start of the subject key, and it is looked up again. If that
6870 fails, further lookups are tried with dot-separated components removed from the
6871 start of the subject key, one-by-one, and &"*."& added on the front of what
6872 remains.
6873
6874 A minimum number of two non-* components are required. This can be adjusted
6875 by including a number before the hyphen in the search type. For example,
6876 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6877 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6878 subject key is &'2250.dates.fict.example'& then the following keys are looked
6879 up when the minimum number of non-* components is two:
6880 .code
6881 2250.dates.fict.example
6882 *.2250.dates.fict.example
6883 *.dates.fict.example
6884 *.fict.example
6885 .endd
6886 As soon as one key in the sequence is successfully looked up, the lookup
6887 finishes.
6888
6889 .cindex "lookup" "partial matching &-- changing prefix"
6890 .cindex "prefix" "for partial matching"
6891 The use of &"*."& as the partial matching prefix is a default that can be
6892 changed. The motivation for this feature is to allow Exim to operate with file
6893 formats that are used by other MTAs. A different prefix can be supplied in
6894 parentheses instead of the hyphen after &"partial"&. For example:
6895 .code
6896 domains = partial(.)lsearch;/some/file
6897 .endd
6898 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6899 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6900 components is unchanged). The prefix may consist of any punctuation characters
6901 other than a closing parenthesis. It may be empty, for example:
6902 .code
6903 domains = partial1()cdb;/some/file
6904 .endd
6905 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6906 &`a.b.c`&, &`b.c`&, and &`c`&.
6907
6908 If &"partial0"& is specified, what happens at the end (when the lookup with
6909 just one non-wild component has failed, and the original key is shortened right
6910 down to the null string) depends on the prefix:
6911
6912 .ilist
6913 If the prefix has zero length, the whole lookup fails.
6914 .next
6915 If the prefix has length 1, a lookup for just the prefix is done. For
6916 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6917 .next
6918 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6919 remainder is looked up. With the default prefix, therefore, the final lookup is
6920 for &"*"& on its own.
6921 .next
6922 Otherwise, the whole prefix is looked up.
6923 .endlist
6924
6925
6926 If the search type ends in &"*"& or &"*@"& (see section
6927 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6928 this implies happens after all partial lookups have failed. If &"partial0"& is
6929 specified, adding &"*"& to the search type has no effect with the default
6930 prefix, because the &"*"& key is already included in the sequence of partial
6931 lookups. However, there might be a use for lookup types such as
6932 &"partial0(.)lsearch*"&.
6933
6934 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6935 in domain lists and the like. Partial matching works only in terms of
6936 dot-separated components; a key such as &`*fict.example`&
6937 in a database file is useless, because the asterisk in a partial matching
6938 subject key is always followed by a dot.
6939
6940
6941
6942
6943 .section "Lookup caching" "SECID64"
6944 .cindex "lookup" "caching"
6945 .cindex "caching" "lookup data"
6946 Exim caches all lookup results in order to avoid needless repetition of
6947 lookups. However, because (apart from the daemon) Exim operates as a collection
6948 of independent, short-lived processes, this caching applies only within a
6949 single Exim process. There is no inter-process lookup caching facility.
6950
6951 For single-key lookups, Exim keeps the relevant files open in case there is
6952 another lookup that needs them. In some types of configuration this can lead to
6953 many files being kept open for messages with many recipients. To avoid hitting
6954 the operating system limit on the number of simultaneously open files, Exim
6955 closes the least recently used file when it needs to open more files than its
6956 own internal limit, which can be changed via the &%lookup_open_max%& option.
6957
6958 The single-key lookup files are closed and the lookup caches are flushed at
6959 strategic points during delivery &-- for example, after all routing is
6960 complete.
6961
6962
6963
6964
6965 .section "Quoting lookup data" "SECID65"
6966 .cindex "lookup" "quoting"
6967 .cindex "quoting" "in lookups"
6968 When data from an incoming message is included in a query-style lookup, there
6969 is the possibility of special characters in the data messing up the syntax of
6970 the query. For example, a NIS+ query that contains
6971 .code
6972 [name=$local_part]
6973 .endd
6974 will be broken if the local part happens to contain a closing square bracket.
6975 For NIS+, data can be enclosed in double quotes like this:
6976 .code
6977 [name="$local_part"]
6978 .endd
6979 but this still leaves the problem of a double quote in the data. The rule for
6980 NIS+ is that double quotes must be doubled. Other lookup types have different
6981 rules, and to cope with the differing requirements, an expansion operator
6982 of the following form is provided:
6983 .code
6984 ${quote_<lookup-type>:<string>}
6985 .endd
6986 For example, the safest way to write the NIS+ query is
6987 .code
6988 [name="${quote_nisplus:$local_part}"]
6989 .endd
6990 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6991 operator can be used for all lookup types, but has no effect for single-key
6992 lookups, since no quoting is ever needed in their key strings.
6993
6994
6995
6996
6997 .section "More about dnsdb" "SECTdnsdb"
6998 .cindex "dnsdb lookup"
6999 .cindex "lookup" "dnsdb"
7000 .cindex "DNS" "as a lookup type"
7001 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7002 of a record type and a domain name, separated by an equals sign. For example,
7003 an expansion string could contain:
7004 .code
7005 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7006 .endd
7007 If the lookup succeeds, the result is placed in &$value$&, which in this case
7008 is used on its own as the result. If the lookup does not succeed, the
7009 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7010 &<<SECTforexpfai>>& for an explanation of what this means.
7011
7012 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7013 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7014 If no type is given, TXT is assumed.
7015
7016 For any record type, if multiple records are found, the data is returned as a
7017 concatenation, with newline as the default separator. The order, of course,
7018 depends on the DNS resolver. You can specify a different separator character
7019 between multiple records by putting a right angle-bracket followed immediately
7020 by the new separator at the start of the query. For example:
7021 .code
7022 ${lookup dnsdb{>: a=host1.example}}
7023 .endd
7024 It is permitted to specify a space as the separator character. Further
7025 white space is ignored.
7026 For lookup types that return multiple fields per record,
7027 an alternate field separator can be specified using a comma after the main
7028 separator character, followed immediately by the field separator.
7029
7030 .cindex "PTR record" "in &(dnsdb)& lookup"
7031 When the type is PTR,
7032 the data can be an IP address, written as normal; inversion and the addition of
7033 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7034 .code
7035 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7036 .endd
7037 If the data for a PTR record is not a syntactically valid IP address, it is not
7038 altered and nothing is added.
7039
7040 .cindex "MX record" "in &(dnsdb)& lookup"
7041 .cindex "SRV record" "in &(dnsdb)& lookup"
7042 For an MX lookup, both the preference value and the host name are returned for
7043 each record, separated by a space. For an SRV lookup, the priority, weight,
7044 port, and host name are returned for each record, separated by spaces.
7045 The field separator can be modified as above.
7046
7047 .cindex "TXT record" "in &(dnsdb)& lookup"
7048 .cindex "SPF record" "in &(dnsdb)& lookup"
7049 For TXT records with multiple items of data, only the first item is returned,
7050 unless a field separator is specified.
7051 To concatenate items without a separator, use a semicolon instead.
7052 For SPF records the
7053 default behaviour is to concatenate multiple items without using a separator.
7054 .code
7055 ${lookup dnsdb{>\n,: txt=a.b.example}}
7056 ${lookup dnsdb{>\n; txt=a.b.example}}
7057 ${lookup dnsdb{spf=example.org}}
7058 .endd
7059 It is permitted to specify a space as the separator character. Further
7060 white space is ignored.
7061
7062 .cindex "SOA record" "in &(dnsdb)& lookup"
7063 For an SOA lookup, while no result is obtained the lookup is redone with
7064 successively more leading components dropped from the given domain.
7065 Only the primary-nameserver field is returned unless a field separator is
7066 specified.
7067 .code
7068 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7069 .endd
7070
7071 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7072 .cindex "dnsdb modifiers"
7073 .cindex "modifiers" "dnsdb"
7074 .cindex "options" "dnsdb"
7075 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7076 each followed by a comma,
7077 that may appear before the record type.
7078
7079 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7080 temporary DNS error for any of them, the behaviour is controlled by
7081 a defer-option modifier.
7082 The possible keywords are
7083 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7084 With &"strict"& behaviour, any temporary DNS error causes the
7085 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7086 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7087 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7088 error causes the whole lookup to defer only if none of the other lookups
7089 succeed. The default is &"lax"&, so the following lookups are equivalent:
7090 .code
7091 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7092 ${lookup dnsdb{a=one.host.com:two.host.com}}
7093 .endd
7094 Thus, in the default case, as long as at least one of the DNS lookups
7095 yields some data, the lookup succeeds.
7096
7097 .cindex "DNSSEC" "dns lookup"
7098 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7099 The possible keywords are
7100 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7101 With &"strict"& or &"lax"& DNSSEC information is requested
7102 with the lookup.
7103 With &"strict"& a response from the DNS resolver that
7104 is not labelled as authenticated data
7105 is treated as equivalent to a temporary DNS error.
7106 The default is &"never"&.
7107
7108 See also the &$lookup_dnssec_authenticated$& variable.
7109
7110 .cindex timeout "dns lookup"
7111 .cindex "DNS" timeout
7112 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7113 The form is &"retrans_VAL"& where VAL is an Exim time specification
7114 (e.g. &"5s"&).
7115 The default value is set by the main configuration option &%dns_retrans%&.
7116
7117 Retries for the dnsdb lookup can be controlled by a retry modifier.
7118 The form if &"retry_VAL"& where VAL is an integer.
7119 The default count is set by the main configuration option &%dns_retry%&.
7120
7121 .cindex caching "of dns lookup"
7122 .cindex TTL "of dns lookup"
7123 .cindex DNS TTL
7124 Dnsdb lookup results are cached within a single process (and its children).
7125 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7126 value of the set of returned DNS records.
7127
7128
7129 .section "Pseudo dnsdb record types" "SECID66"
7130 .cindex "MX record" "in &(dnsdb)& lookup"
7131 By default, both the preference value and the host name are returned for
7132 each MX record, separated by a space. If you want only host names, you can use
7133 the pseudo-type MXH:
7134 .code
7135 ${lookup dnsdb{mxh=a.b.example}}
7136 .endd
7137 In this case, the preference values are omitted, and just the host names are
7138 returned.
7139
7140 .cindex "name server for enclosing domain"
7141 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7142 records on the given domain, but if none are found, it removes the first
7143 component of the domain name, and tries again. This process continues until NS
7144 records are found or there are no more components left (or there is a DNS
7145 error). In other words, it may return the name servers for a top-level domain,
7146 but it never returns the root name servers. If there are no NS records for the
7147 top-level domain, the lookup fails. Consider these examples:
7148 .code
7149 ${lookup dnsdb{zns=xxx.quercite.com}}
7150 ${lookup dnsdb{zns=xxx.edu}}
7151 .endd
7152 Assuming that in each case there are no NS records for the full domain name,
7153 the first returns the name servers for &%quercite.com%&, and the second returns
7154 the name servers for &%edu%&.
7155
7156 You should be careful about how you use this lookup because, unless the
7157 top-level domain does not exist, the lookup always returns some host names. The
7158 sort of use to which this might be put is for seeing if the name servers for a
7159 given domain are on a blacklist. You can probably assume that the name servers
7160 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7161 such a list.
7162
7163 .cindex "CSA" "in &(dnsdb)& lookup"
7164 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7165 records according to the CSA rules, which are described in section
7166 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7167 not sufficient because of the extra parent domain search behaviour of CSA. The
7168 result of a successful lookup such as:
7169 .code
7170 ${lookup dnsdb {csa=$sender_helo_name}}
7171 .endd
7172 has two space-separated fields: an authorization code and a target host name.
7173 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7174 authorization required but absent, or &"?"& for unknown.
7175
7176 .cindex "A+" "in &(dnsdb)& lookup"
7177 The pseudo-type A+ performs an AAAA
7178 and then an A lookup.  All results are returned; defer processing
7179 (see below) is handled separately for each lookup.  Example:
7180 .code
7181 ${lookup dnsdb {>; a+=$sender_helo_name}}
7182 .endd
7183
7184
7185 .section "Multiple dnsdb lookups" "SECID67"
7186 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7187 However, you can specify a list of domains or IP addresses in a single
7188 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7189 the default separator, but with the ability to change this. For example:
7190 .code
7191 ${lookup dnsdb{one.domain.com:two.domain.com}}
7192 ${lookup dnsdb{a=one.host.com:two.host.com}}
7193 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7194 .endd
7195 In order to retain backwards compatibility, there is one special case: if
7196 the lookup type is PTR and no change of separator is specified, Exim looks
7197 to see if the rest of the string is precisely one IPv6 address. In this
7198 case, it does not treat it as a list.
7199
7200 The data from each lookup is concatenated, with newline separators by default,
7201 in the same way that multiple DNS records for a single item are handled. A
7202 different separator can be specified, as described above.
7203
7204
7205
7206
7207 .section "More about LDAP" "SECTldap"
7208 .cindex "LDAP" "lookup, more about"
7209 .cindex "lookup" "LDAP"
7210 .cindex "Solaris" "LDAP"
7211 The original LDAP implementation came from the University of Michigan; this has
7212 become &"Open LDAP"&, and there are now two different releases. Another
7213 implementation comes from Netscape, and Solaris 7 and subsequent releases
7214 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7215 the lookup function level, their error handling is different. For this reason
7216 it is necessary to set a compile-time variable when building Exim with LDAP, to
7217 indicate which LDAP library is in use. One of the following should appear in
7218 your &_Local/Makefile_&:
7219 .code
7220 LDAP_LIB_TYPE=UMICHIGAN
7221 LDAP_LIB_TYPE=OPENLDAP1
7222 LDAP_LIB_TYPE=OPENLDAP2
7223 LDAP_LIB_TYPE=NETSCAPE
7224 LDAP_LIB_TYPE=SOLARIS
7225 .endd
7226 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7227 same interface as the University of Michigan version.
7228
7229 There are three LDAP lookup types in Exim. These behave slightly differently in
7230 the way they handle the results of a query:
7231
7232 .ilist
7233 &(ldap)& requires the result to contain just one entry; if there are more, it
7234 gives an error.
7235 .next
7236 &(ldapdn)& also requires the result to contain just one entry, but it is the
7237 Distinguished Name that is returned rather than any attribute values.
7238 .next
7239 &(ldapm)& permits the result to contain more than one entry; the attributes
7240 from all of them are returned.
7241 .endlist
7242
7243
7244 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7245 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7246 the data returned by a successful lookup is described in the next section.
7247 First we explain how LDAP queries are coded.
7248
7249
7250 .section "Format of LDAP queries" "SECTforldaque"
7251 .cindex "LDAP" "query format"
7252 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7253 the configuration of a &(redirect)& router one might have this setting:
7254 .code
7255 data = ${lookup ldap \
7256   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7257   c=UK?mailbox?base?}}
7258 .endd
7259 .cindex "LDAP" "with TLS"
7260 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7261 secure (encrypted) LDAP connections. The second of these ensures that an
7262 encrypted TLS connection is used.
7263
7264 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7265 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7266 See the &%ldap_start_tls%& option.
7267
7268 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7269 controlled. Every part of the TLS configuration can be configured by settings in
7270 &_exim.conf_&. Depending on the version of the client libraries installed on
7271 your system, some of the initialization may have required setting options in
7272 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7273 certificates. This revealed a nuance where the current UID that exim was
7274 running as could affect which config files it read. With Exim 4.83, these
7275 methods become optional, only taking effect if not specifically set in
7276 &_exim.conf_&.
7277
7278
7279 .section "LDAP quoting" "SECID68"
7280 .cindex "LDAP" "quoting"
7281 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7282 and the second because the LDAP query is represented as a URL. Furthermore,
7283 within an LDAP query, two different kinds of quoting are required. For this
7284 reason, there are two different LDAP-specific quoting operators.
7285
7286 The &%quote_ldap%& operator is designed for use on strings that are part of
7287 filter specifications. Conceptually, it first does the following conversions on
7288 the string:
7289 .code
7290 *   =>   \2A
7291 (   =>   \28
7292 )   =>   \29
7293 \   =>   \5C
7294 .endd
7295 in accordance with RFC 2254. The resulting string is then quoted according
7296 to the rules for URLs, that is, all non-alphanumeric characters except
7297 .code
7298 ! $ ' - . _ ( ) * +
7299 .endd
7300 are converted to their hex values, preceded by a percent sign. For example:
7301 .code
7302 ${quote_ldap: a(bc)*, a<yz>; }
7303 .endd
7304 yields
7305 .code
7306 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7307 .endd
7308 Removing the URL quoting, this is (with a leading and a trailing space):
7309 .code
7310 a\28bc\29\2A, a<yz>;
7311 .endd
7312 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7313 base DN specifications in queries. Conceptually, it first converts the string
7314 by inserting a backslash in front of any of the following characters:
7315 .code
7316 , + " \ < > ;
7317 .endd
7318 It also inserts a backslash before any leading spaces or # characters, and
7319 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7320 is then quoted according to the rules for URLs. For example:
7321 .code
7322 ${quote_ldap_dn: a(bc)*, a<yz>; }
7323 .endd
7324 yields
7325 .code
7326 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7327 .endd
7328 Removing the URL quoting, this is (with a trailing space):
7329 .code
7330 \ a(bc)*\, a\<yz\>\;\
7331 .endd
7332 There are some further comments about quoting in the section on LDAP
7333 authentication below.
7334
7335
7336 .section "LDAP connections" "SECID69"
7337 .cindex "LDAP" "connections"
7338 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7339 is in use, via a Unix domain socket. The example given above does not specify
7340 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7341 by starting it with
7342 .code
7343 ldap://<hostname>:<port>/...
7344 .endd
7345 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7346 used. When no server is specified in a query, a list of default servers is
7347 taken from the &%ldap_default_servers%& configuration option. This supplies a
7348 colon-separated list of servers which are tried in turn until one successfully
7349 handles a query, or there is a serious error. Successful handling either
7350 returns the requested data, or indicates that it does not exist. Serious errors
7351 are syntactical, or multiple values when only a single value is expected.
7352 Errors which cause the next server to be tried are connection failures, bind
7353 failures, and timeouts.
7354
7355 For each server name in the list, a port number can be given. The standard way
7356 of specifying a host and port is to use a colon separator (RFC 1738). Because
7357 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7358 doubled. For example
7359 .code
7360 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7361 .endd
7362 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7363 to the LDAP library with no server name, and the library's default (normally
7364 the local host) is used.
7365
7366 If you are using the OpenLDAP library, you can connect to an LDAP server using
7367 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7368 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7369 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7370 not available.
7371
7372 For this type of connection, instead of a host name for the server, a pathname
7373 for the socket is required, and the port number is not relevant. The pathname
7374 can be specified either as an item in &%ldap_default_servers%&, or inline in
7375 the query. In the former case, you can have settings such as
7376 .code
7377 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7378 .endd
7379 When the pathname is given in the query, you have to escape the slashes as
7380 &`%2F`& to fit in with the LDAP URL syntax. For example:
7381 .code
7382 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7383 .endd
7384 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7385 a pathname, it uses the Unix domain socket code, even if the query actually
7386 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7387 socket connection. This behaviour means that you can use a setting of
7388 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7389 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7390 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7391 backup host.
7392
7393 If an explicit &`ldapi`& type is given in a query when a host name is
7394 specified, an error is diagnosed. However, if there are more items in
7395 &%ldap_default_servers%&, they are tried. In other words:
7396
7397 .ilist
7398 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7399 interface.
7400 .next
7401 Using &`ldapi`& with a host name causes an error.
7402 .endlist
7403
7404
7405 Using &`ldapi`& with no host or path in the query, and no setting of
7406 &%ldap_default_servers%&, does whatever the library does by default.
7407
7408
7409
7410 .section "LDAP authentication and control information" "SECID70"
7411 .cindex "LDAP" "authentication"
7412 The LDAP URL syntax provides no way of passing authentication and other control
7413 information to the server. To make this possible, the URL in an LDAP query may
7414 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7415 spaces. If a value contains spaces it must be enclosed in double quotes, and
7416 when double quotes are used, backslash is interpreted in the usual way inside
7417 them. The following names are recognized:
7418 .display
7419 &`DEREFERENCE`&  set the dereferencing parameter
7420 &`NETTIME    `&  set a timeout for a network operation
7421 &`USER       `&  set the DN, for authenticating the LDAP bind
7422 &`PASS       `&  set the password, likewise
7423 &`REFERRALS  `&  set the referrals parameter
7424 &`SERVERS    `&  set alternate server list for this query only
7425 &`SIZE       `&  set the limit for the number of entries returned
7426 &`TIME       `&  set the maximum waiting time for a query
7427 .endd
7428 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7429 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7430 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7431 library from trying to follow referrals issued by the LDAP server.
7432
7433 .cindex LDAP timeout
7434 .cindex timeout "LDAP lookup"
7435 The name CONNECT is an obsolete name for NETTIME, retained for
7436 backwards compatibility. This timeout (specified as a number of seconds) is
7437 enforced from the client end for operations that can be carried out over a
7438 network. Specifically, it applies to network connections and calls to the
7439 &'ldap_result()'& function. If the value is greater than zero, it is used if
7440 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7441 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7442 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7443 Netscape SDK; for OpenLDAP no action is taken.
7444
7445 The TIME parameter (also a number of seconds) is passed to the server to
7446 set a server-side limit on the time taken to complete a search.
7447
7448 The SERVERS parameter allows you to specify an alternate list of ldap servers
7449 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7450 default list of ldap servers, and a single lookup can specify a single ldap
7451 server to use.  But when you need to do a lookup with a list of servers that is
7452 different than the default list (maybe different order, maybe a completely
7453 different set of servers), the SERVERS parameter allows you to specify this
7454 alternate list (colon-separated).
7455
7456 Here is an example of an LDAP query in an Exim lookup that uses some of these
7457 values. This is a single line, folded to fit on the page:
7458 .code
7459 ${lookup ldap
7460   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7461   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7462   {$value}fail}
7463 .endd
7464 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7465 any of the auxiliary data. Exim configuration settings that include lookups
7466 which contain password information should be preceded by &"hide"& to prevent
7467 non-admin users from using the &%-bP%& option to see their values.
7468
7469 The auxiliary data items may be given in any order. The default is no
7470 connection timeout (the system timeout is used), no user or password, no limit
7471 on the number of entries returned, and no time limit on queries.
7472
7473 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7474 removes any URL quoting that it may contain before passing it LDAP. Apparently
7475 some libraries do this for themselves, but some do not. Removing the URL
7476 quoting has two advantages:
7477
7478 .ilist
7479 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7480 DNs as with DNs inside actual queries.
7481 .next
7482 It permits spaces inside USER= DNs.
7483 .endlist
7484
7485 For example, a setting such as
7486 .code
7487 USER=cn=${quote_ldap_dn:$1}
7488 .endd
7489 should work even if &$1$& contains spaces.
7490
7491 Expanded data for the PASS= value should be quoted using the &%quote%&
7492 expansion operator, rather than the LDAP quote operators. The only reason this
7493 field needs quoting is to ensure that it conforms to the Exim syntax, which
7494 does not allow unquoted spaces. For example:
7495 .code
7496 PASS=${quote:$3}
7497 .endd
7498 The LDAP authentication mechanism can be used to check passwords as part of
7499 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7500 &<<CHAPexpand>>&.
7501
7502
7503
7504 .section "Format of data returned by LDAP" "SECID71"
7505 .cindex "LDAP" "returned data formats"
7506 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7507 as a sequence of values, for example
7508 .code
7509 cn=manager,o=University of Cambridge,c=UK
7510 .endd
7511 The &(ldap)& lookup type generates an error if more than one entry matches the
7512 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7513 the result between the data from different entries. It is possible for multiple
7514 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7515 you know that whatever values are returned all came from a single entry in the
7516 directory.
7517
7518 In the common case where you specify a single attribute in your LDAP query, the
7519 result is not quoted, and does not contain the attribute name. If the attribute
7520 has multiple values, they are separated by commas. Any comma that is
7521 part of an attribute's value is doubled.
7522
7523 If you specify multiple attributes, the result contains space-separated, quoted
7524 strings, each preceded by the attribute name and an equals sign. Within the
7525 quotes, the quote character, backslash, and newline are escaped with
7526 backslashes, and commas are used to separate multiple values for the attribute.
7527 Any commas in attribute values are doubled
7528 (permitting treatment of the values as a comma-separated list).
7529 Apart from the escaping, the string within quotes takes the same form as the
7530 output when a single attribute is requested. Specifying no attributes is the
7531 same as specifying all of an entry's attributes.
7532
7533 Here are some examples of the output format. The first line of each pair is an
7534 LDAP query, and the second is the data that is returned. The attribute called
7535 &%attr1%& has two values, one of them with an embedded comma, whereas
7536 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7537 (they have SUP &%attr%& in their schema definitions).
7538
7539 .code
7540 ldap:///o=base?attr1?sub?(uid=fred)
7541 value1.1,value1,,2
7542
7543 ldap:///o=base?attr2?sub?(uid=fred)
7544 value two
7545
7546 ldap:///o=base?attr?sub?(uid=fred)
7547 value1.1,value1,,2,value two
7548
7549 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7550 attr1="value1.1,value1,,2" attr2="value two"
7551
7552 ldap:///o=base??sub?(uid=fred)
7553 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7554 .endd
7555 You can
7556 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7557 results of LDAP lookups.
7558 The &%extract%& operator in string expansions can be used to pick out
7559 individual fields from data that consists of &'key'&=&'value'& pairs.
7560 The &%listextract%& operator should be used to pick out individual values
7561 of attributes, even when only a single value is expected.
7562 The doubling of embedded commas allows you to use the returned data as a
7563 comma separated list (using the "<," syntax for changing the input list separator).
7564
7565
7566
7567
7568 .section "More about NIS+" "SECTnisplus"
7569 .cindex "NIS+ lookup type"
7570 .cindex "lookup" "NIS+"
7571 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7572 and field name. If this is given, the result of a successful query is the
7573 contents of the named field; otherwise the result consists of a concatenation
7574 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7575 values containing spaces are quoted. For example, the query
7576 .code
7577 [name=mg1456],passwd.org_dir
7578 .endd
7579 might return the string
7580 .code
7581 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7582 home=/home/mg1456 shell=/bin/bash shadow=""
7583 .endd
7584 (split over two lines here to fit on the page), whereas
7585 .code
7586 [name=mg1456],passwd.org_dir:gcos
7587 .endd
7588 would just return
7589 .code
7590 Martin Guerre
7591 .endd
7592 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7593 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7594 operator is to double any quote characters within the text.
7595
7596
7597
7598 .section "SQL lookups" "SECTsql"
7599 .cindex "SQL lookup types"
7600 .cindex "MySQL" "lookup type"
7601 .cindex "PostgreSQL lookup type"
7602 .cindex "lookup" "MySQL"
7603 .cindex "lookup" "PostgreSQL"
7604 .cindex "Oracle" "lookup type"
7605 .cindex "lookup" "Oracle"
7606 .cindex "InterBase lookup type"
7607 .cindex "lookup" "InterBase"
7608 .cindex "Redis lookup type"
7609 .cindex lookup Redis
7610 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7611 and SQLite
7612 databases. Queries for these databases contain SQL statements, so an example
7613 might be
7614 .code
7615 ${lookup mysql{select mailbox from users where id='userx'}\
7616   {$value}fail}
7617 .endd
7618 If the result of the query contains more than one field, the data for each
7619 field in the row is returned, preceded by its name, so the result of
7620 .code
7621 ${lookup pgsql{select home,name from users where id='userx'}\
7622   {$value}}
7623 .endd
7624 might be
7625 .code
7626 home=/home/userx name="Mister X"
7627 .endd
7628 Empty values and values containing spaces are double quoted, with embedded
7629 quotes escaped by a backslash. If the result of the query contains just one
7630 field, the value is passed back verbatim, without a field name, for example:
7631 .code
7632 Mister X
7633 .endd
7634 If the result of the query yields more than one row, it is all concatenated,
7635 with a newline between the data for each row.
7636
7637
7638 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7639 .cindex "MySQL" "lookup type"
7640 .cindex "PostgreSQL lookup type"
7641 .cindex "lookup" "MySQL"
7642 .cindex "lookup" "PostgreSQL"
7643 .cindex "Oracle" "lookup type"
7644 .cindex "lookup" "Oracle"
7645 .cindex "InterBase lookup type"
7646 .cindex "lookup" "InterBase"
7647 .cindex "Redis lookup type"
7648 .cindex lookup Redis
7649 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7650 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7651 or &%redis_servers%&
7652 option (as appropriate) must be set to a colon-separated list of server
7653 information.
7654 (For MySQL and PostgreSQL, the global option need not be set if all
7655 queries contain their own server information &-- see section
7656 &<<SECTspeserque>>&.)
7657 For all but Redis
7658 each item in the list is a slash-separated list of four
7659 items: host name, database name, user name, and password. In the case of
7660 Oracle, the host name field is used for the &"service name"&, and the database
7661 name field is not used and should be empty. For example:
7662 .code
7663 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7664 .endd
7665 Because password data is sensitive, you should always precede the setting with
7666 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7667 option. Here is an example where two MySQL servers are listed:
7668 .code
7669 hide mysql_servers = localhost/users/root/secret:\
7670                      otherhost/users/root/othersecret
7671 .endd
7672 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7673 because this is a colon-separated list, the colon has to be doubled. For each
7674 query, these parameter groups are tried in order until a connection is made and
7675 a query is successfully processed. The result of a query may be that no data is
7676 found, but that is still a successful query. In other words, the list of
7677 servers provides a backup facility, not a list of different places to look.
7678
7679 For Redis the global option need not be specified if all queries contain their
7680 own server information &-- see section &<<SECTspeserque>>&.
7681 If specified, the option must be set to a colon-separated list of server
7682 information.
7683 Each item in the list is a slash-separated list of three items:
7684 host, database number, and password.
7685 .olist
7686 The host is required and may be either an IPv4 address and optional
7687 port number (separated by a colon, which needs doubling due to the
7688 higher-level list), or a Unix socket pathname enclosed in parentheses
7689 .next
7690 The database number is optional; if present that number is selected in the backend
7691 .next
7692 The password is optional; if present it is used to authenticate to the backend
7693 .endlist
7694
7695 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7696 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7697 respectively, and the characters single-quote, double-quote, and backslash
7698 itself are escaped with backslashes.
7699
7700 The &%quote_redis%& expansion operator
7701 escapes whitespace and backslash characters with a backslash.
7702
7703 .section "Specifying the server in the query" "SECTspeserque"
7704 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7705 it is possible to specify a list of servers with an individual query. This is
7706 done by starting the query with
7707 .display
7708 &`servers=`&&'server1:server2:server3:...'&&`;`&
7709 .endd
7710 Each item in the list may take one of two forms:
7711 .olist
7712 If it contains no slashes it is assumed to be just a host name. The appropriate
7713 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7714 of the same name, and the remaining parameters (database, user, password) are
7715 taken from there.
7716 .next
7717 If it contains any slashes, it is taken as a complete parameter set.
7718 .endlist
7719 The list of servers is used in exactly the same way as the global list.
7720 Once a connection to a server has happened and a query has been
7721 successfully executed, processing of the lookup ceases.
7722
7723 This feature is intended for use in master/slave situations where updates
7724 are occurring and you want to update the master rather than a slave. If the
7725 master is in the list as a backup for reading, you might have a global setting
7726 like this:
7727 .code
7728 mysql_servers = slave1/db/name/pw:\
7729                 slave2/db/name/pw:\
7730                 master/db/name/pw
7731 .endd
7732 In an updating lookup, you could then write:
7733 .code
7734 ${lookup mysql{servers=master; UPDATE ...} }
7735 .endd
7736 That query would then be sent only to the master server. If, on the other hand,
7737 the master is not to be used for reading, and so is not present in the global
7738 option, you can still update it by a query of this form:
7739 .code
7740 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7741 .endd
7742
7743
7744 .section "Special MySQL features" "SECID73"
7745 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7746 causes a connection to the server on the local host by means of a Unix domain
7747 socket. An alternate socket can be specified in parentheses.
7748 An option group name for MySQL option files can be specified in square brackets;
7749 the default value is &"exim"&.
7750 The full syntax of each item in &%mysql_servers%& is:
7751 .display
7752 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7753   <&'database'&>/<&'user'&>/<&'password'&>
7754 .endd
7755 Any of the four sub-parts of the first field can be omitted. For normal use on
7756 the local host it can be left blank or set to just &"localhost"&.
7757
7758 No database need be supplied &-- but if it is absent here, it must be given in
7759 the queries.
7760
7761 If a MySQL query is issued that does not request any data (an insert, update,
7762 or delete command), the result of the lookup is the number of rows affected.
7763
7764 &*Warning*&: This can be misleading. If an update does not actually change
7765 anything (for example, setting a field to the value it already has), the result
7766 is zero because no rows are affected.
7767
7768
7769 .section "Special PostgreSQL features" "SECID74"
7770 PostgreSQL lookups can also use Unix domain socket connections to the database.
7771 This is usually faster and costs less CPU time than a TCP/IP connection.
7772 However it can be used only if the mail server runs on the same machine as the
7773 database server. A configuration line for PostgreSQL via Unix domain sockets
7774 looks like this:
7775 .code
7776 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7777 .endd
7778 In other words, instead of supplying a host name, a path to the socket is
7779 given. The path name is enclosed in parentheses so that its slashes aren't
7780 visually confused with the delimiters for the other server parameters.
7781
7782 If a PostgreSQL query is issued that does not request any data (an insert,
7783 update, or delete command), the result of the lookup is the number of rows
7784 affected.
7785
7786 .section "More about SQLite" "SECTsqlite"
7787 .cindex "lookup" "SQLite"
7788 .cindex "sqlite lookup type"
7789 SQLite is different to the other SQL lookups because a file name is required in
7790 addition to the SQL query. An SQLite database is a single file, and there is no
7791 daemon as in the other SQL databases. The interface to Exim requires the name
7792 of the file, as an absolute path, to be given at the start of the query. It is
7793 separated from the query by white space. This means that the path name cannot
7794 contain white space. Here is a lookup expansion example:
7795 .code
7796 ${lookup sqlite {/some/thing/sqlitedb \
7797   select name from aliases where id='userx';}}
7798 .endd
7799 In a list, the syntax is similar. For example:
7800 .code
7801 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7802    select * from relays where ip='$sender_host_address';
7803 .endd
7804 The only character affected by the &%quote_sqlite%& operator is a single
7805 quote, which it doubles.
7806
7807 .cindex timeout SQLite
7808 .cindex sqlite "lookup timeout"
7809 The SQLite library handles multiple simultaneous accesses to the database
7810 internally. Multiple readers are permitted, but only one process can
7811 update at once. Attempts to access the database while it is being updated
7812 are rejected after a timeout period, during which the SQLite library
7813 waits for the lock to be released. In Exim, the default timeout is set
7814 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7815 option.
7816
7817 .section "More about Redis" "SECTredis"
7818 .cindex "lookup" "Redis"
7819 .cindex "redis lookup type"
7820 Redis is a non-SQL database. Commands are simple get and set.
7821 Examples:
7822 .code
7823 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
7824 ${lookup redis{get keyname}}
7825 .endd
7826
7827 .ecindex IIDfidalo1
7828 .ecindex IIDfidalo2
7829
7830
7831 . ////////////////////////////////////////////////////////////////////////////
7832 . ////////////////////////////////////////////////////////////////////////////
7833
7834 .chapter "Domain, host, address, and local part lists" &&&
7835          "CHAPdomhosaddlists" &&&
7836          "Domain, host, and address lists"
7837 .scindex IIDdohoadli "lists of domains; hosts; etc."
7838 A number of Exim configuration options contain lists of domains, hosts,
7839 email addresses, or local parts. For example, the &%hold_domains%& option
7840 contains a list of domains whose delivery is currently suspended. These lists
7841 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7842 arguments to expansion conditions such as &%match_domain%&.
7843
7844 Each item in one of these lists is a pattern to be matched against a domain,
7845 host, email address, or local part, respectively. In the sections below, the
7846 different types of pattern for each case are described, but first we cover some
7847 general facilities that apply to all four kinds of list.
7848
7849 Note that other parts of Exim use a &'string list'& which does not
7850 support all the complexity available in
7851 domain, host, address and local part lists.
7852
7853
7854
7855 .section "Expansion of lists" "SECTlistexpand"
7856 .cindex "expansion" "of lists"
7857 Each list is expanded as a single string before it is used.
7858
7859 &'Exception: the router headers_remove option, where list-item
7860 splitting is done before string-expansion.'&
7861
7862 The result of
7863 expansion must be a list, possibly containing empty items, which is split up
7864 into separate items for matching. By default, colon is the separator character,
7865 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7866 &<<SECTempitelis>>& for details of the list syntax; the second of these
7867 discusses the way to specify empty list items.
7868
7869
7870 If the string expansion is forced to fail, Exim behaves as if the item it is
7871 testing (domain, host, address, or local part) is not in the list. Other
7872 expansion failures cause temporary errors.
7873
7874 If an item in a list is a regular expression, backslashes, dollars and possibly
7875 other special characters in the expression must be protected against
7876 misinterpretation by the string expander. The easiest way to do this is to use
7877 the &`\N`& expansion feature to indicate that the contents of the regular
7878 expression should not be expanded. For example, in an ACL you might have:
7879 .code
7880 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7881                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7882 .endd
7883 The first item is a regular expression that is protected from expansion by
7884 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7885 senders based on the receiving domain.
7886
7887
7888
7889
7890 .section "Negated items in lists" "SECID76"
7891 .cindex "list" "negation"
7892 .cindex "negation" "in lists"
7893 Items in a list may be positive or negative. Negative items are indicated by a
7894 leading exclamation mark, which may be followed by optional white space. A list
7895 defines a set of items (domains, etc). When Exim processes one of these lists,
7896 it is trying to find out whether a domain, host, address, or local part
7897 (respectively) is in the set that is defined by the list. It works like this:
7898
7899 The list is scanned from left to right. If a positive item is matched, the
7900 subject that is being checked is in the set; if a negative item is matched, the
7901 subject is not in the set. If the end of the list is reached without the
7902 subject having matched any of the patterns, it is in the set if the last item
7903 was a negative one, but not if it was a positive one. For example, the list in
7904 .code
7905 domainlist relay_to_domains = !a.b.c : *.b.c
7906 .endd
7907 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7908 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7909 list is positive. However, if the setting were
7910 .code
7911 domainlist relay_to_domains = !a.b.c
7912 .endd
7913 then all domains other than &'a.b.c'& would match because the last item in the
7914 list is negative. In other words, a list that ends with a negative item behaves
7915 as if it had an extra item &`:*`& on the end.
7916
7917 Another way of thinking about positive and negative items in lists is to read
7918 the connector as &"or"& after a positive item and as &"and"& after a negative
7919 item.
7920
7921
7922
7923 .section "File names in lists" "SECTfilnamlis"
7924 .cindex "list" "file name in"
7925 If an item in a domain, host, address, or local part list is an absolute file
7926 name (beginning with a slash character), each line of the file is read and
7927 processed as if it were an independent item in the list, except that further
7928 file names are not allowed,
7929 and no expansion of the data from the file takes place.
7930 Empty lines in the file are ignored, and the file may also contain comment
7931 lines:
7932
7933 .ilist
7934 For domain and host lists, if a # character appears anywhere in a line of the
7935 file, it and all following characters are ignored.
7936 .next
7937 Because local parts may legitimately contain # characters, a comment in an
7938 address list or local part list file is recognized only if # is preceded by
7939 white space or the start of the line. For example:
7940 .code
7941 not#comment@x.y.z   # but this is a comment
7942 .endd
7943 .endlist
7944
7945 Putting a file name in a list has the same effect as inserting each line of the
7946 file as an item in the list (blank lines and comments excepted). However, there
7947 is one important difference: the file is read each time the list is processed,
7948 so if its contents vary over time, Exim's behaviour changes.
7949
7950 If a file name is preceded by an exclamation mark, the sense of any match
7951 within the file is inverted. For example, if
7952 .code
7953 hold_domains = !/etc/nohold-domains
7954 .endd
7955 and the file contains the lines
7956 .code
7957 !a.b.c
7958 *.b.c
7959 .endd
7960 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7961 any domain matching &`*.b.c`& is not.
7962
7963
7964
7965 .section "An lsearch file is not an out-of-line list" "SECID77"
7966 As will be described in the sections that follow, lookups can be used in lists
7967 to provide indexed methods of checking list membership. There has been some
7968 confusion about the way &(lsearch)& lookups work in lists. Because
7969 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7970 sometimes thought that it is allowed to contain wild cards and other kinds of
7971 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7972 always fixed strings, just as for any other single-key lookup type.
7973
7974 If you want to use a file to contain wild-card patterns that form part of a
7975 list, just give the file name on its own, without a search type, as described
7976 in the previous section. You could also use the &(wildlsearch)& or
7977 &(nwildlsearch)&, but there is no advantage in doing this.
7978
7979
7980
7981
7982 .section "Named lists" "SECTnamedlists"
7983 .cindex "named lists"
7984 .cindex "list" "named"
7985 A list of domains, hosts, email addresses, or local parts can be given a name
7986 which is then used to refer to the list elsewhere in the configuration. This is
7987 particularly convenient if the same list is required in several different
7988 places. It also allows lists to be given meaningful names, which can improve
7989 the readability of the configuration. For example, it is conventional to define
7990 a domain list called &'local_domains'& for all the domains that are handled
7991 locally on a host, using a configuration line such as
7992 .code
7993 domainlist local_domains = localhost:my.dom.example
7994 .endd
7995 Named lists are referenced by giving their name preceded by a plus sign, so,
7996 for example, a router that is intended to handle local domains would be
7997 configured with the line
7998 .code
7999 domains = +local_domains
8000 .endd
8001 The first router in a configuration is often one that handles all domains
8002 except the local ones, using a configuration with a negated item like this:
8003 .code
8004 dnslookup:
8005   driver = dnslookup
8006   domains = ! +local_domains
8007   transport = remote_smtp
8008   no_more
8009 .endd
8010 The four kinds of named list are created by configuration lines starting with
8011 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8012 respectively. Then there follows the name that you are defining, followed by an
8013 equals sign and the list itself. For example:
8014 .code
8015 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8016 addresslist bad_senders = cdb;/etc/badsenders
8017 .endd
8018 A named list may refer to other named lists:
8019 .code
8020 domainlist  dom1 = first.example : second.example
8021 domainlist  dom2 = +dom1 : third.example
8022 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8023 .endd
8024 &*Warning*&: If the last item in a referenced list is a negative one, the
8025 effect may not be what you intended, because the negation does not propagate
8026 out to the higher level. For example, consider:
8027 .code
8028 domainlist  dom1 = !a.b
8029 domainlist  dom2 = +dom1 : *.b
8030 .endd
8031 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8032 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8033 means it matches the second list as well. The effect is not the same as
8034 .code
8035 domainlist  dom2 = !a.b : *.b
8036 .endd
8037 where &'x.y'& does not match. It's best to avoid negation altogether in
8038 referenced lists if you can.
8039
8040 Named lists may have a performance advantage. When Exim is routing an
8041 address or checking an incoming message, it caches the result of tests on named
8042 lists. So, if you have a setting such as
8043 .code
8044 domains = +local_domains
8045 .endd
8046 on several of your routers
8047 or in several ACL statements,
8048 the actual test is done only for the first one. However, the caching works only
8049 if there are no expansions within the list itself or any sublists that it
8050 references. In other words, caching happens only for lists that are known to be
8051 the same each time they are referenced.
8052
8053 By default, there may be up to 16 named lists of each type. This limit can be
8054 extended by changing a compile-time variable. The use of domain and host lists
8055 is recommended for concepts such as local domains, relay domains, and relay
8056 hosts. The default configuration is set up like this.
8057
8058
8059
8060 .section "Named lists compared with macros" "SECID78"
8061 .cindex "list" "named compared with macro"
8062 .cindex "macro" "compared with named list"
8063 At first sight, named lists might seem to be no different from macros in the
8064 configuration file. However, macros are just textual substitutions. If you
8065 write
8066 .code
8067 ALIST = host1 : host2
8068 auth_advertise_hosts = !ALIST
8069 .endd
8070 it probably won't do what you want, because that is exactly the same as
8071 .code
8072 auth_advertise_hosts = !host1 : host2
8073 .endd
8074 Notice that the second host name is not negated. However, if you use a host
8075 list, and write
8076 .code
8077 hostlist alist = host1 : host2
8078 auth_advertise_hosts = ! +alist
8079 .endd
8080 the negation applies to the whole list, and so that is equivalent to
8081 .code
8082 auth_advertise_hosts = !host1 : !host2
8083 .endd
8084
8085
8086 .section "Named list caching" "SECID79"
8087 .cindex "list" "caching of named"
8088 .cindex "caching" "named lists"
8089 While processing a message, Exim caches the result of checking a named list if
8090 it is sure that the list is the same each time. In practice, this means that
8091 the cache operates only if the list contains no $ characters, which guarantees
8092 that it will not change when it is expanded. Sometimes, however, you may have
8093 an expanded list that you know will be the same each time within a given
8094 message. For example:
8095 .code
8096 domainlist special_domains = \
8097            ${lookup{$sender_host_address}cdb{/some/file}}
8098 .endd
8099 This provides a list of domains that depends only on the sending host's IP
8100 address. If this domain list is referenced a number of times (for example,
8101 in several ACL lines, or in several routers) the result of the check is not
8102 cached by default, because Exim does not know that it is going to be the
8103 same list each time.
8104
8105 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8106 cache the result anyway. For example:
8107 .code
8108 domainlist_cache special_domains = ${lookup{...
8109 .endd
8110 If you do this, you should be absolutely sure that caching is going to do
8111 the right thing in all cases. When in doubt, leave it out.
8112
8113
8114
8115 .section "Domain lists" "SECTdomainlist"
8116 .cindex "domain list" "patterns for"
8117 .cindex "list" "domain list"
8118 Domain lists contain patterns that are to be matched against a mail domain.
8119 The following types of item may appear in domain lists:
8120
8121 .ilist
8122 .cindex "primary host name"
8123 .cindex "host name" "matched in domain list"
8124 .oindex "&%primary_hostname%&"
8125 .cindex "domain list" "matching primary host name"
8126 .cindex "@ in a domain list"
8127 If a pattern consists of a single @ character, it matches the local host name,
8128 as set by the &%primary_hostname%& option (or defaulted). This makes it
8129 possible to use the same configuration file on several different hosts that
8130 differ only in their names.
8131 .next
8132 .cindex "@[] in a domain list"
8133 .cindex "domain list" "matching local IP interfaces"
8134 .cindex "domain literal"
8135 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8136 in square brackets (as in an email address that contains a domain literal), but
8137 only if that IP address is recognized as local for email routing purposes. The
8138 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8139 control which of a host's several IP addresses are treated as local.
8140 In today's Internet, the use of domain literals is controversial.
8141 .next
8142 .cindex "@mx_any"
8143 .cindex "@mx_primary"
8144 .cindex "@mx_secondary"
8145 .cindex "domain list" "matching MX pointers to local host"
8146 If a pattern consists of the string &`@mx_any`& it matches any domain that
8147 has an MX record pointing to the local host or to any host that is listed in
8148 .oindex "&%hosts_treat_as_local%&"
8149 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8150 are similar, except that the first matches only when a primary MX target is the
8151 local host, and the second only when no primary MX target is the local host,
8152 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8153 preference value &-- there may of course be more than one of them.
8154
8155 The MX lookup that takes place when matching a pattern of this type is
8156 performed with the resolver options for widening names turned off. Thus, for
8157 example, a single-component domain will &'not'& be expanded by adding the
8158 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8159 options of the &(dnslookup)& router for a discussion of domain widening.
8160
8161 Sometimes you may want to ignore certain IP addresses when using one of these
8162 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8163 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8164 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8165 on a router). For example:
8166 .code
8167 domains = @mx_any/ignore=127.0.0.1
8168 .endd
8169 This example matches any domain that has an MX record pointing to one of
8170 the local host's IP addresses other than 127.0.0.1.
8171
8172 The list of IP addresses is in fact processed by the same code that processes
8173 host lists, so it may contain CIDR-coded network specifications and it may also
8174 contain negative items.
8175
8176 Because the list of IP addresses is a sublist within a domain list, you have to
8177 be careful about delimiters if there is more than one address. Like any other
8178 list, the default delimiter can be changed. Thus, you might have:
8179 .code
8180 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8181           an.other.domain : ...
8182 .endd
8183 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8184 involved, it is easiest to change the delimiter for the main list as well:
8185 .code
8186 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8187           an.other.domain ? ...
8188 .endd
8189 .next
8190 .cindex "asterisk" "in domain list"
8191 .cindex "domain list" "asterisk in"
8192 .cindex "domain list" "matching &""ends with""&"
8193 If a pattern starts with an asterisk, the remaining characters of the pattern
8194 are compared with the terminating characters of the domain. The use of &"*"& in
8195 domain lists differs from its use in partial matching lookups. In a domain
8196 list, the character following the asterisk need not be a dot, whereas partial
8197 matching works only in terms of dot-separated components. For example, a domain
8198 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8199 &'cipher.key.ex'&.
8200
8201 .next
8202 .cindex "regular expressions" "in domain list"
8203 .cindex "domain list" "matching regular expression"
8204 If a pattern starts with a circumflex character, it is treated as a regular
8205 expression, and matched against the domain using a regular expression matching
8206 function. The circumflex is treated as part of the regular expression.
8207 Email domains are case-independent, so this regular expression match is by
8208 default case-independent, but you can make it case-dependent by starting it
8209 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8210 are given in chapter &<<CHAPregexp>>&.
8211
8212 &*Warning*&: Because domain lists are expanded before being processed, you
8213 must escape any backslash and dollar characters in the regular expression, or
8214 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8215 it is not to be expanded (unless you really do want to build a regular
8216 expression by expansion, of course).
8217 .next
8218 .cindex "lookup" "in domain list"
8219 .cindex "domain list" "matching by lookup"
8220 If a pattern starts with the name of a single-key lookup type followed by a
8221 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8222 must be a file name in a suitable format for the lookup type. For example, for
8223 &"cdb;"& it must be an absolute path:
8224 .code
8225 domains = cdb;/etc/mail/local_domains.cdb
8226 .endd
8227 The appropriate type of lookup is done on the file using the domain name as the
8228 key. In most cases, the data that is looked up is not used; Exim is interested
8229 only in whether or not the key is present in the file. However, when a lookup
8230 is used for the &%domains%& option on a router
8231 or a &%domains%& condition in an ACL statement, the data is preserved in the
8232 &$domain_data$& variable and can be referred to in other router options or
8233 other statements in the same ACL.
8234
8235 .next
8236 Any of the single-key lookup type names may be preceded by
8237 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8238 .code
8239 domains = partial-dbm;/partial/domains
8240 .endd
8241 This causes partial matching logic to be invoked; a description of how this
8242 works is given in section &<<SECTpartiallookup>>&.
8243
8244 .next
8245 .cindex "asterisk" "in lookup type"
8246 Any of the single-key lookup types may be followed by an asterisk. This causes
8247 a default lookup for a key consisting of a single asterisk to be done if the
8248 original lookup fails. This is not a useful feature when using a domain list to
8249 select particular domains (because any domain would match), but it might have
8250 value if the result of the lookup is being used via the &$domain_data$&
8251 expansion variable.
8252 .next
8253 If the pattern starts with the name of a query-style lookup type followed by a
8254 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8255 pattern must be an appropriate query for the lookup type, as described in
8256 chapter &<<CHAPfdlookup>>&. For example:
8257 .code
8258 hold_domains = mysql;select domain from holdlist \
8259   where domain = '${quote_mysql:$domain}';
8260 .endd
8261 In most cases, the data that is looked up is not used (so for an SQL query, for
8262 example, it doesn't matter what field you select). Exim is interested only in
8263 whether or not the query succeeds. However, when a lookup is used for the
8264 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8265 variable and can be referred to in other options.
8266 .next
8267 .cindex "domain list" "matching literal domain name"
8268 If none of the above cases apply, a caseless textual comparison is made
8269 between the pattern and the domain.
8270 .endlist
8271
8272 Here is an example that uses several different kinds of pattern:
8273 .code
8274 domainlist funny_domains = \
8275   @ : \
8276   lib.unseen.edu : \
8277   *.foundation.fict.example : \
8278   \N^[1-2]\d{3}\.fict\.example$\N : \
8279   partial-dbm;/opt/data/penguin/book : \
8280   nis;domains.byname : \
8281   nisplus;[name=$domain,status=local],domains.org_dir
8282 .endd
8283 There are obvious processing trade-offs among the various matching modes. Using
8284 an asterisk is faster than a regular expression, and listing a few names
8285 explicitly probably is too. The use of a file or database lookup is expensive,
8286 but may be the only option if hundreds of names are required. Because the
8287 patterns are tested in order, it makes sense to put the most commonly matched
8288 patterns earlier.
8289
8290
8291
8292 .section "Host lists" "SECThostlist"
8293 .cindex "host list" "patterns in"
8294 .cindex "list" "host list"
8295 Host lists are used to control what remote hosts are allowed to do. For
8296 example, some hosts may be allowed to use the local host as a relay, and some
8297 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8298 two different ways, by name or by IP address. In a host list, some types of
8299 pattern are matched to a host name, and some are matched to an IP address.
8300 You need to be particularly careful with this when single-key lookups are
8301 involved, to ensure that the right value is being used as the key.
8302
8303
8304 .section "Special host list patterns" "SECID80"
8305 .cindex "empty item in hosts list"
8306 .cindex "host list" "empty string in"
8307 If a host list item is the empty string, it matches only when no remote host is
8308 involved. This is the case when a message is being received from a local
8309 process using SMTP on the standard input, that is, when a TCP/IP connection is
8310 not used.
8311
8312 .cindex "asterisk" "in host list"
8313 The special pattern &"*"& in a host list matches any host or no host. Neither
8314 the IP address nor the name is actually inspected.
8315
8316
8317
8318 .section "Host list patterns that match by IP address" "SECThoslispatip"
8319 .cindex "host list" "matching IP addresses"
8320 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8321 the incoming address actually appears in the IPv6 host as
8322 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8323 list, it is converted into a traditional IPv4 address first. (Not all operating
8324 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8325 concerns.)
8326
8327 The following types of pattern in a host list check the remote host by
8328 inspecting its IP address:
8329
8330 .ilist
8331 If the pattern is a plain domain name (not a regular expression, not starting
8332 with *, not a lookup of any kind), Exim calls the operating system function
8333 to find the associated IP address(es). Exim uses the newer
8334 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8335 This typically causes a forward DNS lookup of the name. The result is compared
8336 with the IP address of the subject host.
8337
8338 If there is a temporary problem (such as a DNS timeout) with the host name
8339 lookup, a temporary error occurs. For example, if the list is being used in an
8340 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8341 temporary SMTP error code. If no IP address can be found for the host name,
8342 what happens is described in section &<<SECTbehipnot>>& below.
8343
8344 .next
8345 .cindex "@ in a host list"
8346 If the pattern is &"@"&, the primary host name is substituted and used as a
8347 domain name, as just described.
8348
8349 .next
8350 If the pattern is an IP address, it is matched against the IP address of the
8351 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8352 IPv6 addresses can be given in colon-separated format, but the colons have to
8353 be doubled so as not to be taken as item separators when the default list
8354 separator is used. IPv6 addresses are recognized even when Exim is compiled
8355 without IPv6 support. This means that if they appear in a host list on an
8356 IPv4-only host, Exim will not treat them as host names. They are just addresses
8357 that can never match a client host.
8358
8359 .next
8360 .cindex "@[] in a host list"
8361 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8362 the local host. For example, if the local host is an IPv4 host with one
8363 interface address 10.45.23.56, these two ACL statements have the same effect:
8364 .code
8365 accept hosts = 127.0.0.1 : 10.45.23.56
8366 accept hosts = @[]
8367 .endd
8368 .next
8369 .cindex "CIDR notation"
8370 If the pattern is an IP address followed by a slash and a mask length (for
8371 example 10.11.42.0/24), it is matched against the IP address of the subject
8372 host under the given mask. This allows, an entire network of hosts to be
8373 included (or excluded) by a single item. The mask uses CIDR notation; it
8374 specifies the number of address bits that must match, starting from the most
8375 significant end of the address.
8376
8377 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8378 of a range of addresses. It is the number of bits in the network portion of the
8379 address. The above example specifies a 24-bit netmask, so it matches all 256
8380 addresses in the 10.11.42.0 network. An item such as
8381 .code
8382 192.168.23.236/31
8383 .endd
8384 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8385 32 for an IPv4 address is the same as no mask at all; just a single address
8386 matches.
8387
8388 Here is another example which shows an IPv4 and an IPv6 network:
8389 .code
8390 recipient_unqualified_hosts = 192.168.0.0/16: \
8391                               3ffe::ffff::836f::::/48
8392 .endd
8393 The doubling of list separator characters applies only when these items
8394 appear inline in a host list. It is not required when indirecting via a file.
8395 For example:
8396 .code
8397 recipient_unqualified_hosts = /opt/exim/unqualnets
8398 .endd
8399 could make use of a file containing
8400 .code
8401 172.16.0.0/12
8402 3ffe:ffff:836f::/48
8403 .endd
8404 to have exactly the same effect as the previous example. When listing IPv6
8405 addresses inline, it is usually more convenient to use the facility for
8406 changing separator characters. This list contains the same two networks:
8407 .code
8408 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8409                                  3ffe:ffff:836f::/48
8410 .endd
8411 The separator is changed to semicolon by the leading &"<;"& at the start of the
8412 list.
8413 .endlist
8414
8415
8416
8417 .section "Host list patterns for single-key lookups by host address" &&&
8418          "SECThoslispatsikey"
8419 .cindex "host list" "lookup of IP address"
8420 When a host is to be identified by a single-key lookup of its complete IP
8421 address, the pattern takes this form:
8422 .display
8423 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8424 .endd
8425 For example:
8426 .code
8427 hosts_lookup = net-cdb;/hosts-by-ip.db
8428 .endd
8429 The text form of the IP address of the subject host is used as the lookup key.
8430 IPv6 addresses are converted to an unabbreviated form, using lower case
8431 letters, with dots as separators because colon is the key terminator in
8432 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8433 quoting the keys, but this is a facility that was added later.] The data
8434 returned by the lookup is not used.
8435
8436 .cindex "IP address" "masking"
8437 .cindex "host list" "masked IP address"
8438 Single-key lookups can also be performed using masked IP addresses, using
8439 patterns of this form:
8440 .display
8441 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8442 .endd
8443 For example:
8444 .code
8445 net24-dbm;/networks.db
8446 .endd
8447 The IP address of the subject host is masked using <&'number'&> as the mask
8448 length. A textual string is constructed from the masked value, followed by the
8449 mask, and this is used as the lookup key. For example, if the host's IP address
8450 is 192.168.34.6, the key that is looked up for the above example is
8451 &"192.168.34.0/24"&.
8452
8453 When an IPv6 address is converted to a string, dots are normally used instead
8454 of colons, so that keys in &(lsearch)& files need not contain colons (which
8455 terminate &(lsearch)& keys). This was implemented some time before the ability
8456 to quote keys was made available in &(lsearch)& files. However, the more
8457 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8458 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8459 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8460 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8461 addresses are always used.
8462
8463 Ideally, it would be nice to tidy up this anomalous situation by changing to
8464 colons in all cases, given that quoting is now available for &(lsearch)&.
8465 However, this would be an incompatible change that might break some existing
8466 configurations.
8467
8468 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8469 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8470 the former case the key strings include the mask value, whereas in the latter
8471 case the IP address is used on its own.
8472
8473
8474
8475 .section "Host list patterns that match by host name" "SECThoslispatnam"
8476 .cindex "host" "lookup failures"
8477 .cindex "unknown host name"
8478 .cindex "host list" "matching host name"
8479 There are several types of pattern that require Exim to know the name of the
8480 remote host. These are either wildcard patterns or lookups by name. (If a
8481 complete hostname is given without any wildcarding, it is used to find an IP
8482 address to match against, as described in section &<<SECThoslispatip>>&
8483 above.)
8484
8485 If the remote host name is not already known when Exim encounters one of these
8486 patterns, it has to be found from the IP address.
8487 Although many sites on the Internet are conscientious about maintaining reverse
8488 DNS data for their hosts, there are also many that do not do this.
8489 Consequently, a name cannot always be found, and this may lead to unwanted
8490 effects. Take care when configuring host lists with wildcarded name patterns.
8491 Consider what will happen if a name cannot be found.
8492
8493 Because of the problems of determining host names from IP addresses, matching
8494 against host names is not as common as matching against IP addresses.
8495
8496 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8497 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8498 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8499 are done can be changed by setting the &%host_lookup_order%& option. For
8500 security, once Exim has found one or more names, it looks up the IP addresses
8501 for these names and compares them with the IP address that it started with.
8502 Only those names whose IP addresses match are accepted. Any other names are
8503 discarded. If no names are left, Exim behaves as if the host name cannot be
8504 found. In the most common case there is only one name and one IP address.
8505
8506 There are some options that control what happens if a host name cannot be
8507 found. These are described in section &<<SECTbehipnot>>& below.
8508
8509 .cindex "host" "alias for"
8510 .cindex "alias for host"
8511 As a result of aliasing, hosts may have more than one name. When processing any
8512 of the following types of pattern, all the host's names are checked:
8513
8514 .ilist
8515 .cindex "asterisk" "in host list"
8516 If a pattern starts with &"*"& the remainder of the item must match the end of
8517 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8518 &'.b.c'&. This special simple form is provided because this is a very common
8519 requirement. Other kinds of wildcarding require the use of a regular
8520 expression.
8521 .next
8522 .cindex "regular expressions" "in host list"
8523 .cindex "host list" "regular expression in"
8524 If the item starts with &"^"& it is taken to be a regular expression which is
8525 matched against the host name. Host names are case-independent, so this regular
8526 expression match is by default case-independent, but you can make it
8527 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8528 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8529 example,
8530 .code
8531 ^(a|b)\.c\.d$
8532 .endd
8533 is a regular expression that matches either of the two hosts &'a.c.d'& or
8534 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8535 that backslash and dollar characters are not misinterpreted as part of the
8536 string expansion. The simplest way to do this is to use &`\N`& to mark that
8537 part of the string as non-expandable. For example:
8538 .code
8539 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8540 .endd
8541 &*Warning*&: If you want to match a complete host name, you must include the
8542 &`$`& terminating metacharacter in the regular expression, as in the above
8543 example. Without it, a match at the start of the host name is all that is
8544 required.
8545 .endlist
8546
8547
8548
8549
8550 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8551 .cindex "host" "lookup failures, permanent"
8552 While processing a host list, Exim may need to look up an IP address from a
8553 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8554 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8555 behaviour when it fails to find the information it is seeking is the same.
8556
8557 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8558 apply to temporary DNS errors, whose handling is described in the next section.
8559
8560 .cindex "&`+include_unknown`&"
8561 .cindex "&`+ignore_unknown`&"
8562 Exim parses a host list from left to right. If it encounters a permanent
8563 lookup failure in any item in the host list before it has found a match,
8564 Exim treats it as a failure and the default behavior is as if the host
8565 does not match the list. This may not always be what you want to happen.
8566 To change Exim's behaviour, the special items &`+include_unknown`& or
8567 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8568 not recognized in an indirected file).
8569
8570 .ilist
8571 If any item that follows &`+include_unknown`& requires information that
8572 cannot found, Exim behaves as if the host does match the list. For example,
8573 .code
8574 host_reject_connection = +include_unknown:*.enemy.ex
8575 .endd
8576 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8577 any hosts whose name it cannot find.
8578
8579 .next
8580 If any item that follows &`+ignore_unknown`& requires information that cannot
8581 be found, Exim ignores that item and proceeds to the rest of the list. For
8582 example:
8583 .code
8584 accept hosts = +ignore_unknown : friend.example : \
8585                192.168.4.5
8586 .endd
8587 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8588 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8589 name can be found for 192.168.4.5, it is rejected.
8590 .endlist
8591
8592 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8593 list. The effect of each one lasts until the next, or until the end of the
8594 list.
8595
8596 .section "Mixing wildcarded host names and addresses in host lists" &&&
8597          "SECTmixwilhos"
8598 .cindex "host list" "mixing names and addresses in"
8599
8600 This section explains the host/ip processing logic with the same concepts
8601 as the previous section, but specifically addresses what happens when a
8602 wildcarded hostname is one of the items in the hostlist.
8603
8604 .ilist
8605 If you have name lookups or wildcarded host names and
8606 IP addresses in the same host list, you should normally put the IP
8607 addresses first. For example, in an ACL you could have:
8608 .code
8609 accept hosts = 10.9.8.7 : *.friend.example
8610 .endd
8611 The reason you normally would order it this way lies in the
8612 left-to-right way that Exim processes lists.  It can test IP addresses
8613 without doing any DNS lookups, but when it reaches an item that requires
8614 a host name, it fails if it cannot find a host name to compare with the
8615 pattern. If the above list is given in the opposite order, the
8616 &%accept%& statement fails for a host whose name cannot be found, even
8617 if its IP address is 10.9.8.7.
8618
8619 .next
8620 If you really do want to do the name check first, and still recognize the IP
8621 address, you can rewrite the ACL like this:
8622 .code
8623 accept hosts = *.friend.example
8624 accept hosts = 10.9.8.7
8625 .endd
8626 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8627 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8628 &`+ignore_unknown`&, which was discussed in depth in the first example in
8629 this section.
8630 .endlist
8631
8632
8633 .section "Temporary DNS errors when looking up host information" &&&
8634          "SECTtemdnserr"
8635 .cindex "host" "lookup failures, temporary"
8636 .cindex "&`+include_defer`&"
8637 .cindex "&`+ignore_defer`&"
8638 A temporary DNS lookup failure normally causes a defer action (except when
8639 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8640 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8641 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8642 section. These options should be used with care, probably only in non-critical
8643 host lists such as whitelists.
8644
8645
8646
8647 .section "Host list patterns for single-key lookups by host name" &&&
8648          "SECThoslispatnamsk"
8649 .cindex "unknown host name"
8650 .cindex "host list" "matching host name"
8651 If a pattern is of the form
8652 .display
8653 <&'single-key-search-type'&>;<&'search-data'&>
8654 .endd
8655 for example
8656 .code
8657 dbm;/host/accept/list
8658 .endd
8659 a single-key lookup is performed, using the host name as its key. If the
8660 lookup succeeds, the host matches the item. The actual data that is looked up
8661 is not used.
8662
8663 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8664 keys in the file, not IP addresses. If you want to do lookups based on IP
8665 addresses, you must precede the search type with &"net-"& (see section
8666 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8667 two items in the same list, one doing an address lookup and one doing a name
8668 lookup, both using the same file.
8669
8670
8671
8672 .section "Host list patterns for query-style lookups" "SECID81"
8673 If a pattern is of the form
8674 .display
8675 <&'query-style-search-type'&>;<&'query'&>
8676 .endd
8677 the query is obeyed, and if it succeeds, the host matches the item. The actual
8678 data that is looked up is not used. The variables &$sender_host_address$& and
8679 &$sender_host_name$& can be used in the query. For example:
8680 .code
8681 hosts_lookup = pgsql;\
8682   select ip from hostlist where ip='$sender_host_address'
8683 .endd
8684 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8685 can use the &%sg%& expansion item to change this if you need to. If you want to
8686 use masked IP addresses in database queries, you can use the &%mask%& expansion
8687 operator.
8688
8689 If the query contains a reference to &$sender_host_name$&, Exim automatically
8690 looks up the host name if it has not already done so. (See section
8691 &<<SECThoslispatnam>>& for comments on finding host names.)
8692
8693 Historical note: prior to release 4.30, Exim would always attempt to find a
8694 host name before running the query, unless the search type was preceded by
8695 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8696 still recognized for query-style lookups, but its presence or absence has no
8697 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8698 See section &<<SECThoslispatsikey>>&.)
8699
8700
8701
8702
8703
8704 .section "Address lists" "SECTaddresslist"
8705 .cindex "list" "address list"
8706 .cindex "address list" "empty item"
8707 .cindex "address list" "patterns"
8708 Address lists contain patterns that are matched against mail addresses. There
8709 is one special case to be considered: the sender address of a bounce message is
8710 always empty. You can test for this by providing an empty item in an address
8711 list. For example, you can set up a router to process bounce messages by
8712 using this option setting:
8713 .code
8714 senders = :
8715 .endd
8716 The presence of the colon creates an empty item. If you do not provide any
8717 data, the list is empty and matches nothing. The empty sender can also be
8718 detected by a regular expression that matches an empty string,
8719 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8720
8721 Non-empty items in an address list can be straightforward email addresses. For
8722 example:
8723 .code
8724 senders = jbc@askone.example : hs@anacreon.example
8725 .endd
8726 A certain amount of wildcarding is permitted. If a pattern contains an @
8727 character, but is not a regular expression and does not begin with a
8728 semicolon-terminated lookup type (described below), the local part of the
8729 subject address is compared with the local part of the pattern, which may start
8730 with an asterisk. If the local parts match, the domain is checked in exactly
8731 the same way as for a pattern in a domain list. For example, the domain can be
8732 wildcarded, refer to a named list, or be a lookup:
8733 .code
8734 deny senders = *@*.spamming.site:\
8735                *@+hostile_domains:\
8736                bozo@partial-lsearch;/list/of/dodgy/sites:\
8737                *@dbm;/bad/domains.db
8738 .endd
8739 .cindex "local part" "starting with !"
8740 .cindex "address list" "local part starting with !"
8741 If a local part that begins with an exclamation mark is required, it has to be
8742 specified using a regular expression, because otherwise the exclamation mark is
8743 treated as a sign of negation, as is standard in lists.
8744
8745 If a non-empty pattern that is not a regular expression or a lookup does not
8746 contain an @ character, it is matched against the domain part of the subject
8747 address. The only two formats that are recognized this way are a literal
8748 domain, or a domain pattern that starts with *. In both these cases, the effect
8749 is the same as if &`*@`& preceded the pattern. For example:
8750 .code
8751 deny senders = enemy.domain : *.enemy.domain
8752 .endd
8753
8754 The following kinds of more complicated address list pattern can match any
8755 address, including the empty address that is characteristic of bounce message
8756 senders:
8757
8758 .ilist
8759 .cindex "regular expressions" "in address list"
8760 .cindex "address list" "regular expression in"
8761 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8762 done against the complete address, with the pattern as the regular expression.
8763 You must take care that backslash and dollar characters are not misinterpreted
8764 as part of the string expansion. The simplest way to do this is to use &`\N`&
8765 to mark that part of the string as non-expandable. For example:
8766 .code
8767 deny senders = \N^.*this.*@example\.com$\N : \
8768                \N^\d{8}.+@spamhaus.example$\N : ...
8769 .endd
8770 The &`\N`& sequences are removed by the expansion, so these items do indeed
8771 start with &"^"& by the time they are being interpreted as address patterns.
8772
8773 .next
8774 .cindex "address list" "lookup for complete address"
8775 Complete addresses can be looked up by using a pattern that starts with a
8776 lookup type terminated by a semicolon, followed by the data for the lookup. For
8777 example:
8778 .code
8779 deny senders = cdb;/etc/blocked.senders : \
8780   mysql;select address from blocked where \
8781   address='${quote_mysql:$sender_address}'
8782 .endd
8783 Both query-style and single-key lookup types can be used. For a single-key
8784 lookup type, Exim uses the complete address as the key. However, empty keys are
8785 not supported for single-key lookups, so a match against the empty address
8786 always fails. This restriction does not apply to query-style lookups.
8787
8788 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8789 cannot be used, and is ignored if specified, with an entry being written to the
8790 panic log.
8791 .cindex "*@ with single-key lookup"
8792 However, you can configure lookup defaults, as described in section
8793 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8794 default. For example, with this lookup:
8795 .code
8796 accept senders = lsearch*@;/some/file
8797 .endd
8798 the file could contains lines like this:
8799 .code
8800 user1@domain1.example
8801 *@domain2.example
8802 .endd
8803 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8804 that are tried is:
8805 .code
8806 nimrod@jaeger.example
8807 *@jaeger.example
8808 *
8809 .endd
8810 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8811 would mean that every address matches, thus rendering the test useless.
8812
8813 &*Warning 2*&: Do not confuse these two kinds of item:
8814 .code
8815 deny recipients = dbm*@;/some/file
8816 deny recipients = *@dbm;/some/file
8817 .endd
8818 The first does a whole address lookup, with defaulting, as just described,
8819 because it starts with a lookup type. The second matches the local part and
8820 domain independently, as described in a bullet point below.
8821 .endlist
8822
8823
8824 The following kinds of address list pattern can match only non-empty addresses.
8825 If the subject address is empty, a match against any of these pattern types
8826 always fails.
8827
8828
8829 .ilist
8830 .cindex "@@ with single-key lookup"
8831 .cindex "address list" "@@ lookup type"
8832 .cindex "address list" "split local part and domain"
8833 If a pattern starts with &"@@"& followed by a single-key lookup item
8834 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8835 split into a local part and a domain. The domain is looked up in the file. If
8836 it is not found, there is no match. If it is found, the data that is looked up
8837 from the file is treated as a colon-separated list of local part patterns, each
8838 of which is matched against the subject local part in turn.
8839
8840 .cindex "asterisk" "in address list"
8841 The lookup may be a partial one, and/or one involving a search for a default
8842 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8843 patterns that are looked up can be regular expressions or begin with &"*"&, or
8844 even be further lookups. They may also be independently negated. For example,
8845 with
8846 .code
8847 deny senders = @@dbm;/etc/reject-by-domain
8848 .endd
8849 the data from which the DBM file is built could contain lines like
8850 .code
8851 baddomain.com:  !postmaster : *
8852 .endd
8853 to reject all senders except &%postmaster%& from that domain.
8854
8855 .cindex "local part" "starting with !"
8856 If a local part that actually begins with an exclamation mark is required, it
8857 has to be specified using a regular expression. In &(lsearch)& files, an entry
8858 may be split over several lines by indenting the second and subsequent lines,
8859 but the separating colon must still be included at line breaks. White space
8860 surrounding the colons is ignored. For example:
8861 .code
8862 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8863   spammer3 : spammer4
8864 .endd
8865 As in all colon-separated lists in Exim, a colon can be included in an item by
8866 doubling.
8867
8868 If the last item in the list starts with a right angle-bracket, the remainder
8869 of the item is taken as a new key to look up in order to obtain a continuation
8870 list of local parts. The new key can be any sequence of characters. Thus one
8871 might have entries like
8872 .code
8873 aol.com: spammer1 : spammer 2 : >*
8874 xyz.com: spammer3 : >*
8875 *:       ^\d{8}$
8876 .endd
8877 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8878 local parts for all domains, in addition to the specific local parts listed for
8879 each domain. Of course, using this feature costs another lookup each time a
8880 chain is followed, but the effort needed to maintain the data is reduced.
8881
8882 .cindex "loop" "in lookups"
8883 It is possible to construct loops using this facility, and in order to catch
8884 them, the chains may be no more than fifty items long.
8885
8886 .next
8887 The @@<&'lookup'&> style of item can also be used with a query-style
8888 lookup, but in this case, the chaining facility is not available. The lookup
8889 can only return a single list of local parts.
8890 .endlist
8891
8892 &*Warning*&: There is an important difference between the address list items
8893 in these two examples:
8894 .code
8895 senders = +my_list
8896 senders = *@+my_list
8897 .endd
8898 In the first one, &`my_list`& is a named address list, whereas in the second
8899 example it is a named domain list.
8900
8901
8902
8903
8904 .section "Case of letters in address lists" "SECTcasletadd"
8905 .cindex "case of local parts"
8906 .cindex "address list" "case forcing"
8907 .cindex "case forcing in address lists"
8908 Domains in email addresses are always handled caselessly, but for local parts
8909 case may be significant on some systems (see &%caseful_local_part%& for how
8910 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8911 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8912 blocking lists should be done in a case-independent manner. Since most address
8913 lists in Exim are used for this kind of control, Exim attempts to do this by
8914 default.
8915
8916 The domain portion of an address is always lowercased before matching it to an
8917 address list. The local part is lowercased by default, and any string
8918 comparisons that take place are done caselessly. This means that the data in
8919 the address list itself, in files included as plain file names, and in any file
8920 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8921 keys in files that are looked up by a search type other than &(lsearch)& (which
8922 works caselessly) must be in lower case, because these lookups are not
8923 case-independent.
8924
8925 .cindex "&`+caseful`&"
8926 To allow for the possibility of caseful address list matching, if an item in
8927 an address list is the string &"+caseful"&, the original case of the local
8928 part is restored for any comparisons that follow, and string comparisons are no
8929 longer case-independent. This does not affect the domain, which remains in
8930 lower case. However, although independent matches on the domain alone are still
8931 performed caselessly, regular expressions that match against an entire address
8932 become case-sensitive after &"+caseful"& has been seen.
8933
8934
8935
8936 .section "Local part lists" "SECTlocparlis"
8937 .cindex "list" "local part list"
8938 .cindex "local part" "list"
8939 Case-sensitivity in local part lists is handled in the same way as for address
8940 lists, as just described. The &"+caseful"& item can be used if required. In a
8941 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8942 set false, the subject is lowercased and the matching is initially
8943 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8944 matching in the local part list, but not elsewhere in the router. If
8945 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8946 option is case-sensitive from the start.
8947
8948 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8949 comments are handled in the same way as address lists &-- they are recognized
8950 only if the # is preceded by white space or the start of the line.
8951 Otherwise, local part lists are matched in the same way as domain lists, except
8952 that the special items that refer to the local host (&`@`&, &`@[]`&,
8953 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8954 Refer to section &<<SECTdomainlist>>& for details of the other available item
8955 types.
8956 .ecindex IIDdohoadli
8957
8958
8959
8960
8961 . ////////////////////////////////////////////////////////////////////////////
8962 . ////////////////////////////////////////////////////////////////////////////
8963
8964 .chapter "String expansions" "CHAPexpand"
8965 .scindex IIDstrexp "expansion" "of strings"
8966 Many strings in Exim's run time configuration are expanded before use. Some of
8967 them are expanded every time they are used; others are expanded only once.
8968
8969 When a string is being expanded it is copied verbatim from left to right except
8970 when a dollar or backslash character is encountered. A dollar specifies the
8971 start of a portion of the string that is interpreted and replaced as described
8972 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8973 escape character, as described in the following section.
8974
8975 Whether a string is expanded depends upon the context.  Usually this is solely
8976 dependent upon the option for which a value is sought; in this documentation,
8977 options for which string expansion is performed are marked with &dagger; after
8978 the data type.  ACL rules always expand strings.  A couple of expansion
8979 conditions do not expand some of the brace-delimited branches, for security
8980 reasons.
8981
8982
8983
8984 .section "Literal text in expanded strings" "SECTlittext"
8985 .cindex "expansion" "including literal text"
8986 An uninterpreted dollar can be included in an expanded string by putting a
8987 backslash in front of it. A backslash can be used to prevent any special
8988 character being treated specially in an expansion, including backslash itself.
8989 If the string appears in quotes in the configuration file, two backslashes are
8990 required because the quotes themselves cause interpretation of backslashes when
8991 the string is read in (see section &<<SECTstrings>>&).
8992
8993 .cindex "expansion" "non-expandable substrings"
8994 A portion of the string can specified as non-expandable by placing it between
8995 two occurrences of &`\N`&. This is particularly useful for protecting regular
8996 expressions, which often contain backslashes and dollar signs. For example:
8997 .code
8998 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8999 .endd
9000 On encountering the first &`\N`&, the expander copies subsequent characters
9001 without interpretation until it reaches the next &`\N`& or the end of the
9002 string.
9003
9004
9005
9006 .section "Character escape sequences in expanded strings" "SECID82"
9007 .cindex "expansion" "escape sequences"
9008 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9009 expanded string is recognized as an escape sequence for the character newline,
9010 carriage return, or tab, respectively. A backslash followed by up to three
9011 octal digits is recognized as an octal encoding for a single character, and a
9012 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9013 encoding.
9014
9015 These escape sequences are also recognized in quoted strings when they are read
9016 in. Their interpretation in expansions as well is useful for unquoted strings,
9017 and for other cases such as looked-up strings that are then expanded.
9018
9019
9020 .section "Testing string expansions" "SECID83"
9021 .cindex "expansion" "testing"
9022 .cindex "testing" "string expansion"
9023 .oindex "&%-be%&"
9024 Many expansions can be tested by calling Exim with the &%-be%& option. This
9025 takes the command arguments, or lines from the standard input if there are no
9026 arguments, runs them through the string expansion code, and writes the results
9027 to the standard output. Variables based on configuration values are set up, but
9028 since no message is being processed, variables such as &$local_part$& have no
9029 value. Nevertheless the &%-be%& option can be useful for checking out file and
9030 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9031 and &%nhash%&.
9032
9033 Exim gives up its root privilege when it is called with the &%-be%& option, and
9034 instead runs under the uid and gid it was called with, to prevent users from
9035 using &%-be%& for reading files to which they do not have access.
9036
9037 .oindex "&%-bem%&"
9038 If you want to test expansions that include variables whose values are taken
9039 from a message, there are two other options that can be used. The &%-bem%&
9040 option is like &%-be%& except that it is followed by a file name. The file is
9041 read as a message before doing the test expansions. For example:
9042 .code
9043 exim -bem /tmp/test.message '$h_subject:'
9044 .endd
9045 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9046 Exim message identifier. For example:
9047 .code
9048 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9049 .endd
9050 This loads the message from Exim's spool before doing the test expansions, and
9051 is therefore restricted to admin users.
9052
9053
9054 .section "Forced expansion failure" "SECTforexpfai"
9055 .cindex "expansion" "forced failure"
9056 A number of expansions that are described in the following section have
9057 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9058 (which are sometimes called &"curly brackets"&). Which of the two strings is
9059 used depends on some condition that is evaluated as part of the expansion. If,
9060 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9061 the entire string expansion fails in a way that can be detected by the code
9062 that requested the expansion. This is called &"forced expansion failure"&, and
9063 its consequences depend on the circumstances. In some cases it is no different
9064 from any other expansion failure, but in others a different action may be
9065 taken. Such variations are mentioned in the documentation of the option that is
9066 being expanded.
9067
9068
9069
9070
9071 .section "Expansion items" "SECTexpansionitems"
9072 The following items are recognized in expanded strings. White space may be used
9073 between sub-items that are keywords or substrings enclosed in braces inside an
9074 outer set of braces, to improve readability. &*Warning*&: Within braces,
9075 white space is significant.
9076
9077 .vlist
9078 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9079 .cindex "expansion" "variables"
9080 Substitute the contents of the named variable, for example:
9081 .code
9082 $local_part
9083 ${domain}
9084 .endd
9085 The second form can be used to separate the name from subsequent alphanumeric
9086 characters. This form (using braces) is available only for variables; it does
9087 &'not'& apply to message headers. The names of the variables are given in
9088 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9089 given, the expansion fails.
9090
9091 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9092 .cindex "expansion" "operators"
9093 The string is first itself expanded, and then the operation specified by
9094 <&'op'&> is applied to it. For example:
9095 .code
9096 ${lc:$local_part}
9097 .endd
9098 The string starts with the first character after the colon, which may be
9099 leading white space. A list of operators is given in section &<<SECTexpop>>&
9100 below. The operator notation is used for simple expansion items that have just
9101 one argument, because it reduces the number of braces and therefore makes the
9102 string easier to understand.
9103
9104 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9105 This item inserts &"basic"& header lines. It is described with the &%header%&
9106 expansion item below.
9107
9108
9109 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9110 .cindex "expansion" "calling an acl"
9111 .cindex "&%acl%&" "call from expansion"
9112 The name and zero to nine argument strings are first expanded separately.  The expanded
9113 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9114 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9115 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9116 and may use the variables; if another acl expansion is used the values
9117 are restored after it returns.  If the ACL sets
9118 a value using a "message =" modifier and returns accept or deny, the value becomes
9119 the result of the expansion.
9120 If no message is set and the ACL returns accept or deny
9121 the expansion result is an empty string.
9122 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9123
9124
9125 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9126        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9127 .cindex "expansion" "extracting certificate fields"
9128 .cindex "&%certextract%&" "certificate fields"
9129 .cindex "certificate" "extracting fields"
9130 The <&'certificate'&> must be a variable of type certificate.
9131 The field name is expanded and used to retrieve the relevant field from
9132 the certificate.  Supported fields are:
9133 .display
9134 &`version        `&
9135 &`serial_number  `&
9136 &`subject        `& RFC4514 DN
9137 &`issuer         `& RFC4514 DN
9138 &`notbefore      `& time
9139 &`notafter       `& time
9140 &`sig_algorithm  `&
9141 &`signature      `&
9142 &`subj_altname   `& tagged list
9143 &`ocsp_uri       `& list
9144 &`crl_uri        `& list
9145 .endd
9146 If the field is found,
9147 <&'string2'&> is expanded, and replaces the whole item;
9148 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9149 variable &$value$& contains the value that has been extracted. Afterwards, it
9150 is restored to any previous value it might have had.
9151
9152 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9153 key is not found. If {<&'string2'&>} is also omitted, the value that was
9154 extracted is used.
9155
9156 Some field names take optional modifiers, appended and separated by commas.
9157
9158 The field selectors marked as "RFC4514" above
9159 output a Distinguished Name string which is
9160 not quite
9161 parseable by Exim as a comma-separated tagged list
9162 (the exceptions being elements containing commas).
9163 RDN elements of a single type may be selected by
9164 a modifier of the type label; if so the expansion
9165 result is a list (newline-separated by default).
9166 The separator may be changed by another modifier of
9167 a right angle-bracket followed immediately by the new separator.
9168 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9169
9170 The field selectors marked as "time" above
9171 take an optional modifier of "int"
9172 for which the result is the number of seconds since epoch.
9173 Otherwise the result is a human-readable string
9174 in the timezone selected by the main "timezone" option.
9175
9176 The field selectors marked as "list" above return a list,
9177 newline-separated by default,
9178 (embedded separator characters in elements are doubled).
9179 The separator may be changed by a modifier of
9180 a right angle-bracket followed immediately by the new separator.
9181
9182 The field selectors marked as "tagged" above
9183 prefix each list element with a type string and an equals sign.
9184 Elements of only one type may be selected by a modifier
9185 which is one of "dns", "uri" or "mail";
9186 if so the element tags are omitted.
9187
9188 If not otherwise noted field values are presented in human-readable form.
9189
9190 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9191        {*&<&'arg'&>&*}...}*&"
9192 .cindex &%dlfunc%&
9193 This expansion dynamically loads and then calls a locally-written C function.
9194 This functionality is available only if Exim is compiled with
9195 .code
9196 EXPAND_DLFUNC=yes
9197 .endd
9198 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9199 object so that it doesn't reload the same object file in the same Exim process
9200 (but of course Exim does start new processes frequently).
9201
9202 There may be from zero to eight arguments to the function. When compiling
9203 a local function that is to be called in this way, &_local_scan.h_& should be
9204 included. The Exim variables and functions that are defined by that API
9205 are also available for dynamically loaded functions. The function itself
9206 must have the following type:
9207 .code
9208 int dlfunction(uschar **yield, int argc, uschar *argv[])
9209 .endd
9210 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9211 function should return one of the following values:
9212
9213 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9214 into the expanded string that is being built.
9215
9216 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9217 from &'yield'&, if it is set.
9218
9219 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9220 taken from &'yield'& if it is set.
9221
9222 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9223
9224 When compiling a function that is to be used in this way with gcc,
9225 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9226 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9227
9228
9229 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9230 .cindex "expansion" "extracting value from environment"
9231 .cindex "environment" "values from"
9232 The key is first expanded separately, and leading and trailing white space
9233 removed.
9234 This is then searched for as a name in the environment.
9235 If a variable is found then its value is placed in &$value$&
9236 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9237
9238 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9239 appear, for example:
9240 .code
9241 ${env{USER}{$value} fail }
9242 .endd
9243 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9244 {<&'string1'&>} must be present for &"fail"& to be recognized.
9245
9246 If {<&'string2'&>} is omitted an empty string is substituted on
9247 search failure.
9248 If {<&'string1'&>} is omitted the search result is substituted on
9249 search success.
9250
9251 The environment is adjusted by the &%keep_environment%& and
9252 &%add_environment%& main section options.
9253
9254
9255 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9256        {*&<&'string3'&>&*}}*&"
9257 .cindex "expansion" "extracting substrings by key"
9258 .cindex "&%extract%&" "substrings by key"
9259 The key and <&'string1'&> are first expanded separately. Leading and trailing
9260 white space is removed from the key (but not from any of the strings). The key
9261 must not be empty and must not consist entirely of digits.
9262 The expanded <&'string1'&> must be of the form:
9263 .display
9264 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9265 .endd
9266 .vindex "&$value$&"
9267 where the equals signs and spaces (but not both) are optional. If any of the
9268 values contain white space, they must be enclosed in double quotes, and any
9269 values that are enclosed in double quotes are subject to escape processing as
9270 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9271 for the value that corresponds to the key. The search is case-insensitive. If
9272 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9273 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9274 variable &$value$& contains the value that has been extracted. Afterwards, it
9275 is restored to any previous value it might have had.
9276
9277 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9278 key is not found. If {<&'string2'&>} is also omitted, the value that was
9279 extracted is used. Thus, for example, these two expansions are identical, and
9280 yield &"2001"&:
9281 .code
9282 ${extract{gid}{uid=1984 gid=2001}}
9283 ${extract{gid}{uid=1984 gid=2001}{$value}}
9284 .endd
9285 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9286 appear, for example:
9287 .code
9288 ${extract{Z}{A=... B=...}{$value} fail }
9289 .endd
9290 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9291 {<&'string2'&>} must be present for &"fail"& to be recognized.
9292
9293
9294 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9295         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9296 .cindex "expansion" "extracting substrings by number"
9297 .cindex "&%extract%&" "substrings by number"
9298 The <&'number'&> argument must consist entirely of decimal digits,
9299 apart from leading and trailing white space, which is ignored.
9300 This is what distinguishes this form of &%extract%& from the previous kind. It
9301 behaves in the same way, except that, instead of extracting a named field, it
9302 extracts from <&'string1'&> the field whose number is given as the first
9303 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9304 <&'string3'&> as before.
9305
9306 The fields in the string are separated by any one of the characters in the
9307 separator string. These may include space or tab characters.
9308 The first field is numbered one. If the number is negative, the fields are
9309 counted from the end of the string, with the rightmost one numbered -1. If the
9310 number given is zero, the entire string is returned. If the modulus of the
9311 number is greater than the number of fields in the string, the result is the
9312 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9313 provided. For example:
9314 .code
9315 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9316 .endd
9317 yields &"42"&, and
9318 .code
9319 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9320 .endd
9321 yields &"99"&. Two successive separators mean that the field between them is
9322 empty (for example, the fifth field above).
9323
9324
9325 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9326 .cindex "list" "selecting by condition"
9327 .cindex "expansion" "selecting from list by condition"
9328 .vindex "&$item$&"
9329 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9330 default, but the separator can be changed in the usual way. For each item
9331 in this list, its value is place in &$item$&, and then the condition is
9332 evaluated. If the condition is true, &$item$& is added to the output as an
9333 item in a new list; if the condition is false, the item is discarded. The
9334 separator used for the output list is the same as the one used for the
9335 input, but a separator setting is not included in the output. For example:
9336 .code
9337 ${filter{a:b:c}{!eq{$item}{b}}
9338 .endd
9339 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9340 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9341
9342
9343 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9344 .cindex "hash function" "textual"
9345 .cindex "expansion" "textual hash"
9346 This is a textual hashing function, and was the first to be implemented in
9347 early versions of Exim. In current releases, there are other hashing functions
9348 (numeric, MD5, and SHA-1), which are described below.
9349
9350 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9351 <&'n'&>. If you are using fixed values for these numbers, that is, if
9352 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9353 use the simpler operator notation that avoids some of the braces:
9354 .code
9355 ${hash_<n>_<m>:<string>}
9356 .endd
9357 The second number is optional (in both notations). If <&'n'&> is greater than
9358 or equal to the length of the string, the expansion item returns the string.
9359 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9360 function to the string. The new string consists of characters taken from the
9361 first <&'m'&> characters of the string
9362 .code
9363 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9364 .endd
9365 If <&'m'&> is not present the value 26 is used, so that only lower case
9366 letters appear. For example:
9367 .display
9368 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9369 &`$hash{5}{monty}}           `&   yields  &`monty`&
9370 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9371 .endd
9372
9373 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9374         &*$h_*&<&'header&~name'&>&*:*&" &&&
9375        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9376         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9377        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9378         &*$rh_*&<&'header&~name'&>&*:*&"
9379 .cindex "expansion" "header insertion"
9380 .vindex "&$header_$&"
9381 .vindex "&$bheader_$&"
9382 .vindex "&$rheader_$&"
9383 .cindex "header lines" "in expansion strings"
9384 .cindex "header lines" "character sets"
9385 .cindex "header lines" "decoding"
9386 Substitute the contents of the named message header line, for example
9387 .code
9388 $header_reply-to:
9389 .endd
9390 The newline that terminates a header line is not included in the expansion, but
9391 internal newlines (caused by splitting the header line over several physical
9392 lines) may be present.
9393
9394 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9395 the data in the header line is interpreted.
9396
9397 .ilist
9398 .cindex "white space" "in header lines"
9399 &%rheader%& gives the original &"raw"& content of the header line, with no
9400 processing at all, and without the removal of leading and trailing white space.
9401
9402 .next
9403 .cindex "base64 encoding" "in header lines"
9404 &%bheader%& removes leading and trailing white space, and then decodes base64
9405 or quoted-printable MIME &"words"& within the header text, but does no
9406 character set translation. If decoding of what looks superficially like a MIME
9407 &"word"& fails, the raw string is returned. If decoding
9408 .cindex "binary zero" "in header line"
9409 produces a binary zero character, it is replaced by a question mark &-- this is
9410 what Exim does for binary zeros that are actually received in header lines.
9411
9412 .next
9413 &%header%& tries to translate the string as decoded by &%bheader%& to a
9414 standard character set. This is an attempt to produce the same string as would
9415 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9416 returned. Translation is attempted only on operating systems that support the
9417 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9418 a system Makefile or in &_Local/Makefile_&.
9419 .endlist ilist
9420
9421 In a filter file, the target character set for &%header%& can be specified by a
9422 command of the following form:
9423 .code
9424 headers charset "UTF-8"
9425 .endd
9426 This command affects all references to &$h_$& (or &$header_$&) expansions in
9427 subsequently obeyed filter commands. In the absence of this command, the target
9428 character set in a filter is taken from the setting of the &%headers_charset%&
9429 option in the runtime configuration. The value of this option defaults to the
9430 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9431 ISO-8859-1.
9432
9433 Header names follow the syntax of RFC 2822, which states that they may contain
9434 any printing characters except space and colon. Consequently, curly brackets
9435 &'do not'& terminate header names, and should not be used to enclose them as
9436 if they were variables. Attempting to do so causes a syntax error.
9437
9438 Only header lines that are common to all copies of a message are visible to
9439 this mechanism. These are the original header lines that are received with the
9440 message, and any that are added by an ACL statement or by a system
9441 filter. Header lines that are added to a particular copy of a message by a
9442 router or transport are not accessible.
9443
9444 For incoming SMTP messages, no header lines are visible in
9445 ACLs that are obeyed before the data phase completes,
9446 because the header structure is not set up until the message is received.
9447 They are visible in DKIM, PRDR and DATA ACLs.
9448 Header lines that are added in a RCPT ACL (for example)
9449 are saved until the message's incoming header lines are available, at which
9450 point they are added.
9451 When any of the above ACLs ar
9452 running, however, header lines added by earlier ACLs are visible.
9453
9454 Upper case and lower case letters are synonymous in header names. If the
9455 following character is white space, the terminating colon may be omitted, but
9456 this is not recommended, because you may then forget it when it is needed. When
9457 white space terminates the header name, this white space is included in the
9458 expanded string.  If the message does not contain the given header, the
9459 expansion item is replaced by an empty string. (See the &%def%& condition in
9460 section &<<SECTexpcond>>& for a means of testing for the existence of a
9461 header.)
9462
9463 If there is more than one header with the same name, they are all concatenated
9464 to form the substitution string, up to a maximum length of 64K. Unless
9465 &%rheader%& is being used, leading and trailing white space is removed from
9466 each header before concatenation, and a completely empty header is ignored. A
9467 newline character is then inserted between non-empty headers, but there is no
9468 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9469 those headers that contain lists of addresses, a comma is also inserted at the
9470 junctions between headers. This does not happen for the &%rheader%& expansion.
9471
9472
9473 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9474 .cindex "expansion" "hmac hashing"
9475 .cindex &%hmac%&
9476 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9477 shared secret and some text into a message authentication code, as specified in
9478 RFC 2104. This differs from &`${md5:secret_text...}`& or
9479 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9480 cryptographic hash, allowing for authentication that is not possible with MD5
9481 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9482 present. For example:
9483 .code
9484 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9485 .endd
9486 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9487 produces:
9488 .code
9489 dd97e3ba5d1a61b5006108f8c8252953
9490 .endd
9491 As an example of how this might be used, you might put in the main part of
9492 an Exim configuration:
9493 .code
9494 SPAMSCAN_SECRET=cohgheeLei2thahw
9495 .endd
9496 In a router or a transport you could then have:
9497 .code
9498 headers_add = \
9499   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9500   ${hmac{md5}{SPAMSCAN_SECRET}\
9501   {${primary_hostname},${message_exim_id},$h_message-id:}}
9502 .endd
9503 Then given a message, you can check where it was scanned by looking at the
9504 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9505 this header line is authentic by recomputing the authentication code from the
9506 host name, message ID and the &'Message-id:'& header line. This can be done
9507 using Exim's &%-be%& option, or by other means, for example by using the
9508 &'hmac_md5_hex()'& function in Perl.
9509
9510
9511 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9512 .cindex "expansion" "conditional"
9513 .cindex "&%if%&, expansion item"
9514 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9515 item; otherwise <&'string2'&> is used. The available conditions are described
9516 in section &<<SECTexpcond>>& below. For example:
9517 .code
9518 ${if eq {$local_part}{postmaster} {yes}{no} }
9519 .endd
9520 The second string need not be present; if it is not and the condition is not
9521 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9522 be present instead of the second string (without any curly brackets). In this
9523 case, the expansion is forced to fail if the condition is not true (see section
9524 &<<SECTforexpfai>>&).
9525
9526 If both strings are omitted, the result is the string &`true`& if the condition
9527 is true, and the empty string if the condition is false. This makes it less
9528 cumbersome to write custom ACL and router conditions. For example, instead of
9529 .code
9530 condition = ${if >{$acl_m4}{3}{true}{false}}
9531 .endd
9532 you can use
9533 .code
9534 condition = ${if >{$acl_m4}{3}}
9535 .endd
9536
9537
9538
9539 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9540 .cindex expansion "imap folder"
9541 .cindex "&%imapfolder%& expansion item"
9542 This item converts a (possibly multilevel, or with non-ASCII characters)
9543 folder specification to a Maildir name for filesystem use.
9544 For information on internationalisation support see &<<SECTi18nMDA>>&.
9545
9546
9547
9548 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9549 .cindex "expansion" "string truncation"
9550 .cindex "&%length%& expansion item"
9551 The &%length%& item is used to extract the initial portion of a string. Both
9552 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9553 you are using a fixed value for the number, that is, if <&'string1'&> does not
9554 change when expanded, you can use the simpler operator notation that avoids
9555 some of the braces:
9556 .code
9557 ${length_<n>:<string>}
9558 .endd
9559 The result of this item is either the first <&'n'&> characters or the whole
9560 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9561 &%strlen%&, which gives the length of a string.
9562
9563
9564 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9565         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9566 .cindex "expansion" "extracting list elements by number"
9567 .cindex "&%listextract%&" "extract list elements by number"
9568 .cindex "list" "extracting elements by number"
9569 The <&'number'&> argument must consist entirely of decimal digits,
9570 apart from an optional leading minus,
9571 and leading and trailing white space (which is ignored).
9572
9573 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9574 default, but the separator can be changed in the usual way.
9575
9576 The first field of the list is numbered one.
9577 If the number is negative, the fields are
9578 counted from the end of the list, with the rightmost one numbered -1.
9579 The numbered element of the list is extracted and placed in &$value$&,
9580 then <&'string2'&> is expanded as the result.
9581
9582 If the modulus of the
9583 number is zero or greater than the number of fields in the string,
9584 the result is the expansion of <&'string3'&>.
9585
9586 For example:
9587 .code
9588 ${listextract{2}{x:42:99}}
9589 .endd
9590 yields &"42"&, and
9591 .code
9592 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9593 .endd
9594 yields &"result: 42"&.
9595
9596 If {<&'string3'&>} is omitted, an empty string is used for string3.
9597 If {<&'string2'&>} is also omitted, the value that was
9598 extracted is used.
9599 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9600
9601
9602 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9603         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9604 This is the first of one of two different types of lookup item, which are both
9605 described in the next item.
9606
9607 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9608         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9609 .cindex "expansion" "lookup in"
9610 .cindex "file" "lookups"
9611 .cindex "lookup" "in expanded string"
9612 The two forms of lookup item specify data lookups in files and databases, as
9613 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9614 lookups, and the second is used for query-style lookups. The <&'key'&>,
9615 <&'file'&>, and <&'query'&> strings are expanded before use.
9616
9617 If there is any white space in a lookup item which is part of a filter command,
9618 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9619 other place where white space is significant, the lookup item must be enclosed
9620 in double quotes. The use of data lookups in users' filter files may be locked
9621 out by the system administrator.
9622
9623 .vindex "&$value$&"
9624 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9625 During its expansion, the variable &$value$& contains the data returned by the
9626 lookup. Afterwards it reverts to the value it had previously (at the outer
9627 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9628 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9629 string on failure. If <&'string2'&> is provided, it can itself be a nested
9630 lookup, thus providing a mechanism for looking up a default value when the
9631 original lookup fails.
9632
9633 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9634 data for the outer lookup while the parameters of the second lookup are
9635 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9636 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9637 appear, and in this case, if the lookup fails, the entire expansion is forced
9638 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9639 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9640 successful lookup, and nothing in the case of failure.
9641
9642 For single-key lookups, the string &"partial"& is permitted to precede the
9643 search type in order to do partial matching, and * or *@ may follow a search
9644 type to request default lookups if the key does not match (see sections
9645 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9646
9647 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9648 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9649 and non-wild parts of the key during the expansion of the replacement text.
9650 They return to their previous values at the end of the lookup item.
9651
9652 This example looks up the postmaster alias in the conventional alias file:
9653 .code
9654 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9655 .endd
9656 This example uses NIS+ to look up the full name of the user corresponding to
9657 the local part of an address, forcing the expansion to fail if it is not found:
9658 .code
9659 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9660   {$value}fail}
9661 .endd
9662
9663
9664 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9665 .cindex "expansion" "list creation"
9666 .vindex "&$item$&"
9667 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9668 default, but the separator can be changed in the usual way. For each item
9669 in this list, its value is place in &$item$&, and then <&'string2'&> is
9670 expanded and added to the output as an item in a new list. The separator used
9671 for the output list is the same as the one used for the input, but a separator
9672 setting is not included in the output. For example:
9673 .code
9674 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9675 .endd
9676 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9677 value of &$item$& is restored to what it was before. See also the &*filter*&
9678 and &*reduce*& expansion items.
9679
9680 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9681 .cindex "expansion" "numeric hash"
9682 .cindex "hash function" "numeric"
9683 The three strings are expanded; the first two must yield numbers. Call them
9684 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9685 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9686 can use the simpler operator notation that avoids some of the braces:
9687 .code
9688 ${nhash_<n>_<m>:<string>}
9689 .endd
9690 The second number is optional (in both notations). If there is only one number,
9691 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9692 processed by a div/mod hash function that returns two numbers, separated by a
9693 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9694 example,
9695 .code
9696 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9697 .endd
9698 returns the string &"6/33"&.
9699
9700
9701
9702 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9703 .cindex "Perl" "use in expanded string"
9704 .cindex "expansion" "calling Perl from"
9705 This item is available only if Exim has been built to include an embedded Perl
9706 interpreter. The subroutine name and the arguments are first separately
9707 expanded, and then the Perl subroutine is called with those arguments. No
9708 additional arguments need be given; the maximum number permitted, including the
9709 name of the subroutine, is nine.
9710
9711 The return value of the subroutine is inserted into the expanded string, unless
9712 the return value is &%undef%&. In that case, the expansion fails in the same
9713 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9714 Whatever you return is evaluated in a scalar context. For example, if you
9715 return the name of a Perl vector, the return value is the size of the vector,
9716 not its contents.
9717
9718 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9719 with the error message that was passed to &%die%&. More details of the embedded
9720 Perl facility are given in chapter &<<CHAPperl>>&.
9721
9722 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9723 out the use of this expansion item in filter files.
9724
9725
9726 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9727 .cindex "&%prvs%& expansion item"
9728 The first argument is a complete email address and the second is secret
9729 keystring. The third argument, specifying a key number, is optional. If absent,
9730 it defaults to 0. The result of the expansion is a prvs-signed email address,
9731 to be typically used with the &%return_path%& option on an &(smtp)& transport
9732 as part of a bounce address tag validation (BATV) scheme. For more discussion
9733 and an example, see section &<<SECTverifyPRVS>>&.
9734
9735 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9736         {*&<&'string'&>&*}}*&"
9737 .cindex "&%prvscheck%& expansion item"
9738 This expansion item is the complement of the &%prvs%& item. It is used for
9739 checking prvs-signed addresses. If the expansion of the first argument does not
9740 yield a syntactically valid prvs-signed address, the whole item expands to the
9741 empty string. When the first argument does expand to a syntactically valid
9742 prvs-signed address, the second argument is expanded, with the prvs-decoded
9743 version of the address and the key number extracted from the address in the
9744 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9745
9746 These two variables can be used in the expansion of the second argument to
9747 retrieve the secret. The validity of the prvs-signed address is then checked
9748 against the secret. The result is stored in the variable &$prvscheck_result$&,
9749 which is empty for failure or &"1"& for success.
9750
9751 The third argument is optional; if it is missing, it defaults to an empty
9752 string. This argument is now expanded. If the result is an empty string, the
9753 result of the expansion is the decoded version of the address. This is the case
9754 whether or not the signature was valid. Otherwise, the result of the expansion
9755 is the expansion of the third argument.
9756
9757 All three variables can be used in the expansion of the third argument.
9758 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9759 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9760
9761 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9762 .cindex "expansion" "inserting an entire file"
9763 .cindex "file" "inserting into expansion"
9764 .cindex "&%readfile%& expansion item"
9765 The file name and end-of-line string are first expanded separately. The file is
9766 then read, and its contents replace the entire item. All newline characters in
9767 the file are replaced by the end-of-line string if it is present. Otherwise,
9768 newlines are left in the string.
9769 String expansion is not applied to the contents of the file. If you want this,
9770 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9771 the string expansion fails.
9772
9773 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9774 locks out the use of this expansion item in filter files.
9775
9776
9777
9778 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9779         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9780 .cindex "expansion" "inserting from a socket"
9781 .cindex "socket, use of in expansion"
9782 .cindex "&%readsocket%& expansion item"
9783 This item inserts data from a Unix domain or TCP socket into the expanded
9784 string. The minimal way of using it uses just two arguments, as in these
9785 examples:
9786 .code
9787 ${readsocket{/socket/name}{request string}}
9788 ${readsocket{inet:some.host:1234}{request string}}
9789 .endd
9790 For a Unix domain socket, the first substring must be the path to the socket.
9791 For an Internet socket, the first substring must contain &`inet:`& followed by
9792 a host name or IP address, followed by a colon and a port, which can be a
9793 number or the name of a TCP port in &_/etc/services_&. An IP address may
9794 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9795 example:
9796 .code
9797 ${readsocket{inet:[::1]:1234}{request string}}
9798 .endd
9799 Only a single host name may be given, but if looking it up yields more than
9800 one IP address, they are each tried in turn until a connection is made. For
9801 both kinds of socket, Exim makes a connection, writes the request string
9802 unless it is an empty string; and no terminating NUL is ever sent)
9803 and reads from the socket until an end-of-file
9804 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9805 extend what can be done. Firstly, you can vary the timeout. For example:
9806 .code
9807 ${readsocket{/socket/name}{request string}{3s}}
9808 .endd
9809 The third argument is a list of options, of which the first element is the timeout
9810 and must be present if the argument is given.
9811 Further elements are options of form &'name=value'&.
9812 One option type is currently recognised, defining whether (the default)
9813 or not a shutdown is done on the connection after sending the request.
9814 Example, to not do so (preferred, eg. by some webservers):
9815 .code
9816 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
9817 .endd
9818 A fourth argument allows you to change any newlines that are in the data
9819 that is read, in the same way as for &%readfile%& (see above). This example
9820 turns them into spaces:
9821 .code
9822 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9823 .endd
9824 As with all expansions, the substrings are expanded before the processing
9825 happens. Errors in these sub-expansions cause the expansion to fail. In
9826 addition, the following errors can occur:
9827
9828 .ilist
9829 Failure to create a socket file descriptor;
9830 .next
9831 Failure to connect the socket;
9832 .next
9833 Failure to write the request string;
9834 .next
9835 Timeout on reading from the socket.
9836 .endlist
9837
9838 By default, any of these errors causes the expansion to fail. However, if
9839 you supply a fifth substring, it is expanded and used when any of the above
9840 errors occurs. For example:
9841 .code
9842 ${readsocket{/socket/name}{request string}{3s}{\n}\
9843   {socket failure}}
9844 .endd
9845 You can test for the existence of a Unix domain socket by wrapping this
9846 expansion in &`${if exists`&, but there is a race condition between that test
9847 and the actual opening of the socket, so it is safer to use the fifth argument
9848 if you want to be absolutely sure of avoiding an expansion error for a
9849 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9850
9851 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9852 locks out the use of this expansion item in filter files.
9853
9854
9855 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9856 .cindex "expansion" "reducing a list to a scalar"
9857 .cindex "list" "reducing to a scalar"
9858 .vindex "&$value$&"
9859 .vindex "&$item$&"
9860 This operation reduces a list to a single, scalar string. After expansion,
9861 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9862 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9863 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9864 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9865 them. The result of that expansion is assigned to &$value$& before the next
9866 iteration. When the end of the list is reached, the final value of &$value$& is
9867 added to the expansion output. The &*reduce*& expansion item can be used in a
9868 number of ways. For example, to add up a list of numbers:
9869 .code
9870 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9871 .endd
9872 The result of that expansion would be &`6`&. The maximum of a list of numbers
9873 can be found:
9874 .code
9875 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9876 .endd
9877 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9878 restored to what they were before. See also the &*filter*& and &*map*&
9879 expansion items.
9880
9881 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9882 This item inserts &"raw"& header lines. It is described with the &%header%&
9883 expansion item above.
9884
9885 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9886         {*&<&'string2'&>&*}}*&"
9887 .cindex "expansion" "running a command"
9888 .cindex "&%run%& expansion item"
9889 The command and its arguments are first expanded as one string. The string is
9890 split apart into individual arguments by spaces, and then the command is run
9891 in a separate process, but under the same uid and gid.  As in other command
9892 executions from Exim, a shell is not used by default. If the command requires
9893 a shell, you must explicitly code it.
9894
9895 Since the arguments are split by spaces, when there is a variable expansion
9896 which has an empty result, it will cause the situation that the argument will
9897 simply be omitted when the program is actually executed by Exim. If the
9898 script/program requires a specific number of arguments and the expanded
9899 variable could possibly result in this empty expansion, the variable must be
9900 quoted. This is more difficult if the expanded variable itself could result
9901 in a string containing quotes, because it would interfere with the quotes
9902 around the command arguments. A possible guard against this is to wrap the
9903 variable in the &%sg%& operator to change any quote marks to some other
9904 character.
9905
9906 The standard input for the command exists, but is empty. The standard output
9907 and standard error are set to the same file descriptor.
9908 .cindex "return code" "from &%run%& expansion"
9909 .vindex "&$value$&"
9910 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9911 and replaces the entire item; during this expansion, the standard output/error
9912 from the command is in the variable &$value$&. If the command fails,
9913 <&'string2'&>, if present, is expanded and used. Once again, during the
9914 expansion, the standard output/error from the command is in the variable
9915 &$value$&.
9916
9917 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9918 can be the word &"fail"& (not in braces) to force expansion failure if the
9919 command does not succeed. If both strings are omitted, the result is contents
9920 of the standard output/error on success, and nothing on failure.
9921
9922 .vindex "&$run_in_acl$&"
9923 The standard output/error of the command is put in the variable &$value$&.
9924 In this ACL example, the output of a command is logged for the admin to
9925 troubleshoot:
9926 .code
9927 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9928       log_message  = Output of id: $value
9929 .endd
9930 If the command requires shell idioms, such as the > redirect operator, the
9931 shell must be invoked directly, such as with:
9932 .code
9933 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9934 .endd
9935
9936 .vindex "&$runrc$&"
9937 The return code from the command is put in the variable &$runrc$&, and this
9938 remains set afterwards, so in a filter file you can do things like this:
9939 .code
9940 if "${run{x y z}{}}$runrc" is 1 then ...
9941   elif $runrc is 2 then ...
9942   ...
9943 endif
9944 .endd
9945 If execution of the command fails (for example, the command does not exist),
9946 the return code is 127 &-- the same code that shells use for non-existent
9947 commands.
9948
9949 &*Warning*&: In a router or transport, you cannot assume the order in which
9950 option values are expanded, except for those preconditions whose order of
9951 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9952 by the expansion of one option, and use it in another.
9953
9954 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9955 out the use of this expansion item in filter files.
9956
9957
9958 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9959 .cindex "expansion" "string substitution"
9960 .cindex "&%sg%& expansion item"
9961 This item works like Perl's substitution operator (s) with the global (/g)
9962 option; hence its name. However, unlike the Perl equivalent, Exim does not
9963 modify the subject string; instead it returns the modified string for insertion
9964 into the overall expansion. The item takes three arguments: the subject string,
9965 a regular expression, and a substitution string. For example:
9966 .code
9967 ${sg{abcdefabcdef}{abc}{xyz}}
9968 .endd
9969 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9970 if any $ or \ characters are required in the regular expression or in the
9971 substitution string, they have to be escaped. For example:
9972 .code
9973 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9974 .endd
9975 yields &"defabc"&, and
9976 .code
9977 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9978 .endd
9979 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9980 the regular expression from string expansion.
9981
9982
9983
9984 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9985 .cindex sorting "a list"
9986 .cindex list sorting
9987 .cindex expansion "list sorting"
9988 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9989 default, but the separator can be changed in the usual way.
9990 The <&'comparator'&> argument is interpreted as the operator
9991 of a two-argument expansion condition.
9992 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9993 The comparison should return true when applied to two values
9994 if the first value should sort before the second value.
9995 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9996 the element being placed in &$item$&,
9997 to give values for comparison.
9998
9999 The item result is a sorted list,
10000 with the original list separator,
10001 of the list elements (in full) of the original.
10002
10003 Examples:
10004 .code
10005 ${sort{3:2:1:4}{<}{$item}}
10006 .endd
10007 sorts a list of numbers, and
10008 .code
10009 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10010 .endd
10011 will sort an MX lookup into priority order.
10012
10013
10014 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10015 .cindex "&%substr%& expansion item"
10016 .cindex "substring extraction"
10017 .cindex "expansion" "substring extraction"
10018 The three strings are expanded; the first two must yield numbers. Call them
10019 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10020 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10021 can use the simpler operator notation that avoids some of the braces:
10022 .code
10023 ${substr_<n>_<m>:<string>}
10024 .endd
10025 The second number is optional (in both notations).
10026 If it is absent in the simpler format, the preceding underscore must also be
10027 omitted.
10028
10029 The &%substr%& item can be used to extract more general substrings than
10030 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10031 length required. For example
10032 .code
10033 ${substr{3}{2}{$local_part}}
10034 .endd
10035 If the starting offset is greater than the string length the result is the
10036 null string; if the length plus starting offset is greater than the string
10037 length, the result is the right-hand part of the string, starting from the
10038 given offset. The first character in the string has offset zero.
10039
10040 The &%substr%& expansion item can take negative offset values to count
10041 from the right-hand end of its operand. The last character is offset -1, the
10042 second-last is offset -2, and so on. Thus, for example,
10043 .code
10044 ${substr{-5}{2}{1234567}}
10045 .endd
10046 yields &"34"&. If the absolute value of a negative offset is greater than the
10047 length of the string, the substring starts at the beginning of the string, and
10048 the length is reduced by the amount of overshoot. Thus, for example,
10049 .code
10050 ${substr{-5}{2}{12}}
10051 .endd
10052 yields an empty string, but
10053 .code
10054 ${substr{-3}{2}{12}}
10055 .endd
10056 yields &"1"&.
10057
10058 When the second number is omitted from &%substr%&, the remainder of the string
10059 is taken if the offset is positive. If it is negative, all characters in the
10060 string preceding the offset point are taken. For example, an offset of -1 and
10061 no length, as in these semantically identical examples:
10062 .code
10063 ${substr_-1:abcde}
10064 ${substr{-1}{abcde}}
10065 .endd
10066 yields all but the last character of the string, that is, &"abcd"&.
10067
10068
10069
10070 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10071         {*&<&'replacements'&>&*}}*&"
10072 .cindex "expansion" "character translation"
10073 .cindex "&%tr%& expansion item"
10074 This item does single-character translation on its subject string. The second
10075 argument is a list of characters to be translated in the subject string. Each
10076 matching character is replaced by the corresponding character from the
10077 replacement list. For example
10078 .code
10079 ${tr{abcdea}{ac}{13}}
10080 .endd
10081 yields &`1b3de1`&. If there are duplicates in the second character string, the
10082 last occurrence is used. If the third string is shorter than the second, its
10083 last character is replicated. However, if it is empty, no translation takes
10084 place.
10085 .endlist
10086
10087
10088
10089 .section "Expansion operators" "SECTexpop"
10090 .cindex "expansion" "operators"
10091 For expansion items that perform transformations on a single argument string,
10092 the &"operator"& notation is used because it is simpler and uses fewer braces.
10093 The substring is first expanded before the operation is applied to it. The
10094 following operations can be performed:
10095
10096 .vlist
10097 .vitem &*${address:*&<&'string'&>&*}*&
10098 .cindex "expansion" "RFC 2822 address handling"
10099 .cindex "&%address%& expansion item"
10100 The string is interpreted as an RFC 2822 address, as it might appear in a
10101 header line, and the effective address is extracted from it. If the string does
10102 not parse successfully, the result is empty.
10103
10104
10105 .vitem &*${addresses:*&<&'string'&>&*}*&
10106 .cindex "expansion" "RFC 2822 address handling"
10107 .cindex "&%addresses%& expansion item"
10108 The string (after expansion) is interpreted as a list of addresses in RFC
10109 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10110 operative address (&'local-part@domain'&) is extracted from each item, and the
10111 result of the expansion is a colon-separated list, with appropriate
10112 doubling of colons should any happen to be present in the email addresses.
10113 Syntactically invalid RFC2822 address items are omitted from the output.
10114
10115 It is possible to specify a character other than colon for the output
10116 separator by starting the string with > followed by the new separator
10117 character. For example:
10118 .code
10119 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10120 .endd
10121 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10122 expansion item, which extracts the working address from a single RFC2822
10123 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10124 processing lists.
10125
10126 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10127 a strict interpretation of header line formatting.  Exim parses the bare,
10128 unquoted portion of an email address and if it finds a comma, treats it as an
10129 email address separator. For the example header line:
10130 .code
10131 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10132 .endd
10133 The first example below demonstrates that Q-encoded email addresses are parsed
10134 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10135 It does not see the comma because it's still encoded as "=2C".  The second
10136 example below is passed the contents of &`$header_from:`&, meaning it gets
10137 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10138 The third example shows that the presence of a comma is skipped when it is
10139 quoted.
10140 .code
10141 # exim -be '${addresses:From: \
10142 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10143 user@example.com
10144 # exim -be '${addresses:From: Last, First <user@example.com>}'
10145 Last:user@example.com
10146 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10147 user@example.com
10148 .endd
10149
10150 .vitem &*${base32:*&<&'digits'&>&*}*&
10151 .cindex "&%base32%& expansion item"
10152 .cindex "expansion" "conversion to base 32"
10153 The string must consist entirely of decimal digits. The number is converted to
10154 base 32 and output as a (empty, for zero) string of characters.
10155 Only lowercase letters are used.
10156
10157 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10158 .cindex "&%base32d%& expansion item"
10159 .cindex "expansion" "conversion to base 32"
10160 The string must consist entirely of base-32 digits.
10161 The number is converted to decimal and output as a string.
10162
10163 .vitem &*${base62:*&<&'digits'&>&*}*&
10164 .cindex "&%base62%& expansion item"
10165 .cindex "expansion" "conversion to base 62"
10166 The string must consist entirely of decimal digits. The number is converted to
10167 base 62 and output as a string of six characters, including leading zeros. In
10168 the few operating environments where Exim uses base 36 instead of base 62 for
10169 its message identifiers (because those systems do not have case-sensitive file
10170 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10171 be absolutely clear: this is &'not'& base64 encoding.
10172
10173 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10174 .cindex "&%base62d%& expansion item"
10175 .cindex "expansion" "conversion to base 62"
10176 The string must consist entirely of base-62 digits, or, in operating
10177 environments where Exim uses base 36 instead of base 62 for its message
10178 identifiers, base-36 digits. The number is converted to decimal and output as a
10179 string.
10180
10181 .vitem &*${base64:*&<&'string'&>&*}*&
10182 .cindex "expansion" "base64 encoding"
10183 .cindex "base64 encoding" "in string expansion"
10184 .cindex "&%base64%& expansion item"
10185 .cindex certificate "base64 of DER"
10186 This operator converts a string into one that is base64 encoded.
10187
10188 If the string is a single variable of type certificate,
10189 returns the base64 encoding of the DER form of the certificate.
10190
10191
10192 .vitem &*${base64d:*&<&'string'&>&*}*&
10193 .cindex "expansion" "base64 decoding"
10194 .cindex "base64 decoding" "in string expansion"
10195 .cindex "&%base64d%& expansion item"
10196 This operator converts a base64-encoded string into the un-coded form.
10197
10198
10199 .vitem &*${domain:*&<&'string'&>&*}*&
10200 .cindex "domain" "extraction"
10201 .cindex "expansion" "domain extraction"
10202 The string is interpreted as an RFC 2822 address and the domain is extracted
10203 from it. If the string does not parse successfully, the result is empty.
10204
10205
10206 .vitem &*${escape:*&<&'string'&>&*}*&
10207 .cindex "expansion" "escaping non-printing characters"
10208 .cindex "&%escape%& expansion item"
10209 If the string contains any non-printing characters, they are converted to
10210 escape sequences starting with a backslash. Whether characters with the most
10211 significant bit set (so-called &"8-bit characters"&) count as printing or not
10212 is controlled by the &%print_topbitchars%& option.
10213
10214 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10215 .cindex "expansion" "escaping 8-bit characters"
10216 .cindex "&%escape8bit%& expansion item"
10217 If the string contains and characters with the most significant bit set,
10218 they are converted to escape sequences starting with a backslash.
10219 Backslashes and DEL characters are also converted.
10220
10221
10222 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10223 .cindex "expansion" "expression evaluation"
10224 .cindex "expansion" "arithmetic expression"
10225 .cindex "&%eval%& expansion item"
10226 These items supports simple arithmetic and bitwise logical operations in
10227 expansion strings. The string (after expansion) must be a conventional
10228 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10229 logical operators, and parentheses. All operations are carried out using
10230 integer arithmetic. The operator priorities are as follows (the same as in the
10231 C programming language):
10232 .table2 70pt 300pt
10233 .irow &'highest:'& "not (~), negate (-)"
10234 .irow ""   "multiply (*), divide (/), remainder (%)"
10235 .irow ""   "plus (+), minus (-)"
10236 .irow ""   "shift-left (<<), shift-right (>>)"
10237 .irow ""   "and (&&)"
10238 .irow ""   "xor (^)"
10239 .irow &'lowest:'&  "or (|)"
10240 .endtable
10241 Binary operators with the same priority are evaluated from left to right. White
10242 space is permitted before or after operators.
10243
10244 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10245 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10246 decimal, even if they start with a leading zero; hexadecimal numbers are not
10247 permitted. This can be useful when processing numbers extracted from dates or
10248 times, which often do have leading zeros.
10249
10250 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10251 or 1024*1024*1024,
10252 respectively. Negative numbers are supported. The result of the computation is
10253 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10254
10255 .display
10256 &`${eval:1+1}            `&  yields 2
10257 &`${eval:1+2*3}          `&  yields 7
10258 &`${eval:(1+2)*3}        `&  yields 9
10259 &`${eval:2+42%5}         `&  yields 4
10260 &`${eval:0xc&amp;5}          `&  yields 4
10261 &`${eval:0xc|5}          `&  yields 13
10262 &`${eval:0xc^5}          `&  yields 9
10263 &`${eval:0xc>>1}         `&  yields 6
10264 &`${eval:0xc<<1}         `&  yields 24
10265 &`${eval:~255&amp;0x1234}    `&  yields 4608
10266 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10267 .endd
10268
10269 As a more realistic example, in an ACL you might have
10270 .code
10271 deny   message = Too many bad recipients
10272        condition =                    \
10273          ${if and {                   \
10274            {>{$rcpt_count}{10}}       \
10275            {                          \
10276            <                          \
10277              {$recipients_count}      \
10278              {${eval:$rcpt_count/2}}  \
10279            }                          \
10280          }{yes}{no}}
10281 .endd
10282 The condition is true if there have been more than 10 RCPT commands and
10283 fewer than half of them have resulted in a valid recipient.
10284
10285
10286 .vitem &*${expand:*&<&'string'&>&*}*&
10287 .cindex "expansion" "re-expansion of substring"
10288 The &%expand%& operator causes a string to be expanded for a second time. For
10289 example,
10290 .code
10291 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10292 .endd
10293 first looks up a string in a file while expanding the operand for &%expand%&,
10294 and then re-expands what it has found.
10295
10296
10297 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10298 .cindex "Unicode"
10299 .cindex "UTF-8" "conversion from"
10300 .cindex "expansion" "UTF-8 conversion"
10301 .cindex "&%from_utf8%& expansion item"
10302 The world is slowly moving towards Unicode, although there are no standards for
10303 email yet. However, other applications (including some databases) are starting
10304 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10305 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10306 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10307 the result is an undefined sequence of bytes.
10308
10309 Unicode code points with values less than 256 are compatible with ASCII and
10310 ISO-8859-1 (also known as Latin-1).
10311 For example, character 169 is the copyright symbol in both cases, though the
10312 way it is encoded is different. In UTF-8, more than one byte is needed for
10313 characters with code values greater than 127, whereas ISO-8859-1 is a
10314 single-byte encoding (but thereby limited to 256 characters). This makes
10315 translation from UTF-8 to ISO-8859-1 straightforward.
10316
10317
10318 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10319 .cindex "hash function" "textual"
10320 .cindex "expansion" "textual hash"
10321 The &%hash%& operator is a simpler interface to the hashing function that can
10322 be used when the two parameters are fixed numbers (as opposed to strings that
10323 change when expanded). The effect is the same as
10324 .code
10325 ${hash{<n>}{<m>}{<string>}}
10326 .endd
10327 See the description of the general &%hash%& item above for details. The
10328 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10329
10330
10331
10332 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10333 .cindex "base64 encoding" "conversion from hex"
10334 .cindex "expansion" "hex to base64"
10335 .cindex "&%hex2b64%& expansion item"
10336 This operator converts a hex string into one that is base64 encoded. This can
10337 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10338
10339
10340
10341 .vitem &*${hexquote:*&<&'string'&>&*}*&
10342 .cindex "quoting" "hex-encoded unprintable characters"
10343 .cindex "&%hexquote%& expansion item"
10344 This operator converts non-printable characters in a string into a hex
10345 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10346 as is, and other byte values are converted to &`\xNN`&, for example a
10347 byte value 127 is converted to &`\x7f`&.
10348
10349
10350 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10351 .cindex "&%ipv6denorm%& expansion item"
10352 .cindex "IP address" normalisation
10353 This expands an IPv6 address to a full eight-element colon-separated set
10354 of hex digits including leading zeroes.
10355 A trailing ipv4-style dotted-decimal set is converted to hex.
10356 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10357
10358 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10359 .cindex "&%ipv6norm%& expansion item"
10360 .cindex "IP address" normalisation
10361 .cindex "IP address" "canonical form"
10362 This converts an IPv6 address to canonical form.
10363 Leading zeroes of groups are omitted, and the longest
10364 set of zero-valued groups is replaced with a double colon.
10365 A trailing ipv4-style dotted-decimal set is converted to hex.
10366 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10367
10368
10369 .vitem &*${lc:*&<&'string'&>&*}*&
10370 .cindex "case forcing in strings"
10371 .cindex "string" "case forcing"
10372 .cindex "lower casing"
10373 .cindex "expansion" "case forcing"
10374 .cindex "&%lc%& expansion item"
10375 This forces the letters in the string into lower-case, for example:
10376 .code
10377 ${lc:$local_part}
10378 .endd
10379
10380 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10381 .cindex "expansion" "string truncation"
10382 .cindex "&%length%& expansion item"
10383 The &%length%& operator is a simpler interface to the &%length%& function that
10384 can be used when the parameter is a fixed number (as opposed to a string that
10385 changes when expanded). The effect is the same as
10386 .code
10387 ${length{<number>}{<string>}}
10388 .endd
10389 See the description of the general &%length%& item above for details. Note that
10390 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10391 when &%length%& is used as an operator.
10392
10393
10394 .vitem &*${listcount:*&<&'string'&>&*}*&
10395 .cindex "expansion" "list item count"
10396 .cindex "list" "item count"
10397 .cindex "list" "count of items"
10398 .cindex "&%listcount%& expansion item"
10399 The string is interpreted as a list and the number of items is returned.
10400
10401
10402 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10403 .cindex "expansion" "named list"
10404 .cindex "&%listnamed%& expansion item"
10405 The name is interpreted as a named list and the content of the list is returned,
10406 expanding any referenced lists, re-quoting as needed for colon-separation.
10407 If the optional type is given it must be one of "a", "d", "h" or "l"
10408 and selects address-, domain-, host- or localpart- lists to search among respectively.
10409 Otherwise all types are searched in an undefined order and the first
10410 matching list is returned.
10411
10412
10413 .vitem &*${local_part:*&<&'string'&>&*}*&
10414 .cindex "expansion" "local part extraction"
10415 .cindex "&%local_part%& expansion item"
10416 The string is interpreted as an RFC 2822 address and the local part is
10417 extracted from it. If the string does not parse successfully, the result is
10418 empty.
10419
10420
10421 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10422 .cindex "masked IP address"
10423 .cindex "IP address" "masking"
10424 .cindex "CIDR notation"
10425 .cindex "expansion" "IP address masking"
10426 .cindex "&%mask%& expansion item"
10427 If the form of the string to be operated on is not an IP address followed by a
10428 slash and an integer (that is, a network address in CIDR notation), the
10429 expansion fails. Otherwise, this operator converts the IP address to binary,
10430 masks off the least significant bits according to the bit count, and converts
10431 the result back to text, with mask appended. For example,
10432 .code
10433 ${mask:10.111.131.206/28}
10434 .endd
10435 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10436 be mostly used for looking up masked addresses in files, the result for an IPv6
10437 address uses dots to separate components instead of colons, because colon
10438 terminates a key string in lsearch files. So, for example,
10439 .code
10440 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10441 .endd
10442 returns the string
10443 .code
10444 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10445 .endd
10446 Letters in IPv6 addresses are always output in lower case.
10447
10448
10449 .vitem &*${md5:*&<&'string'&>&*}*&
10450 .cindex "MD5 hash"
10451 .cindex "expansion" "MD5 hash"
10452 .cindex certificate fingerprint
10453 .cindex "&%md5%& expansion item"
10454 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10455 as a 32-digit hexadecimal number, in which any letters are in lower case.
10456
10457 If the string is a single variable of type certificate,
10458 returns the MD5 hash fingerprint of the certificate.
10459
10460
10461 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10462 .cindex "expansion" "numeric hash"
10463 .cindex "hash function" "numeric"
10464 The &%nhash%& operator is a simpler interface to the numeric hashing function
10465 that can be used when the two parameters are fixed numbers (as opposed to
10466 strings that change when expanded). The effect is the same as
10467 .code
10468 ${nhash{<n>}{<m>}{<string>}}
10469 .endd
10470 See the description of the general &%nhash%& item above for details.
10471
10472
10473 .vitem &*${quote:*&<&'string'&>&*}*&
10474 .cindex "quoting" "in string expansions"
10475 .cindex "expansion" "quoting"
10476 .cindex "&%quote%& expansion item"
10477 The &%quote%& operator puts its argument into double quotes if it
10478 is an empty string or
10479 contains anything other than letters, digits, underscores, dots, and hyphens.
10480 Any occurrences of double quotes and backslashes are escaped with a backslash.
10481 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10482 respectively For example,
10483 .code
10484 ${quote:ab"*"cd}
10485 .endd
10486 becomes
10487 .code
10488 "ab\"*\"cd"
10489 .endd
10490 The place where this is useful is when the argument is a substitution from a
10491 variable or a message header.
10492
10493 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10494 .cindex "&%quote_local_part%& expansion item"
10495 This operator is like &%quote%&, except that it quotes the string only if
10496 required to do so by the rules of RFC 2822 for quoting local parts. For
10497 example, a plus sign would not cause quoting (but it would for &%quote%&).
10498 If you are creating a new email address from the contents of &$local_part$&
10499 (or any other unknown data), you should always use this operator.
10500
10501
10502 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10503 .cindex "quoting" "lookup-specific"
10504 This operator applies lookup-specific quoting rules to the string. Each
10505 query-style lookup type has its own quoting rules which are described with
10506 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10507 .code
10508 ${quote_ldap:two * two}
10509 .endd
10510 returns
10511 .code
10512 two%20%5C2A%20two
10513 .endd
10514 For single-key lookup types, no quoting is ever necessary and this operator
10515 yields an unchanged string.
10516
10517
10518 .vitem &*${randint:*&<&'n'&>&*}*&
10519 .cindex "random number"
10520 This operator returns a somewhat random number which is less than the
10521 supplied number and is at least 0.  The quality of this randomness depends
10522 on how Exim was built; the values are not suitable for keying material.
10523 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10524 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10525 for versions of GnuTLS with that function.
10526 Otherwise, the implementation may be arc4random(), random() seeded by
10527 srandomdev() or srandom(), or a custom implementation even weaker than
10528 random().
10529
10530
10531 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10532 .cindex "expansion" "IP address"
10533 This operator reverses an IP address; for IPv4 addresses, the result is in
10534 dotted-quad decimal form, while for IPv6 addresses the result is in
10535 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10536 for DNS.  For example,
10537 .code
10538 ${reverse_ip:192.0.2.4}
10539 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10540 .endd
10541 returns
10542 .code
10543 4.2.0.192
10544 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
10545 .endd
10546
10547
10548 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10549 .cindex "expansion" "RFC 2047"
10550 .cindex "RFC 2047" "expansion operator"
10551 .cindex "&%rfc2047%& expansion item"
10552 This operator encodes text according to the rules of RFC 2047. This is an
10553 encoding that is used in header lines to encode non-ASCII characters. It is
10554 assumed that the input string is in the encoding specified by the
10555 &%headers_charset%& option, which gets its default at build time. If the string
10556 contains only characters in the range 33&--126, and no instances of the
10557 characters
10558 .code
10559 ? = ( ) < > @ , ; : \ " . [ ] _
10560 .endd
10561 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10562 string, using as many &"encoded words"& as necessary to encode all the
10563 characters.
10564
10565
10566 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10567 .cindex "expansion" "RFC 2047"
10568 .cindex "RFC 2047" "decoding"
10569 .cindex "&%rfc2047d%& expansion item"
10570 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10571 bytes are replaced by question marks. Characters are converted into the
10572 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10573 not recognized unless &%check_rfc2047_length%& is set false.
10574
10575 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10576 access a header line, RFC 2047 decoding is done automatically. You do not need
10577 to use this operator as well.
10578
10579
10580
10581 .vitem &*${rxquote:*&<&'string'&>&*}*&
10582 .cindex "quoting" "in regular expressions"
10583 .cindex "regular expressions" "quoting"
10584 .cindex "&%rxquote%& expansion item"
10585 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10586 characters in its argument. This is useful when substituting the values of
10587 variables or headers inside regular expressions.
10588
10589
10590 .vitem &*${sha1:*&<&'string'&>&*}*&
10591 .cindex "SHA-1 hash"
10592 .cindex "expansion" "SHA-1 hashing"
10593 .cindex certificate fingerprint
10594 .cindex "&%sha1%& expansion item"
10595 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10596 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10597
10598 If the string is a single variable of type certificate,
10599 returns the SHA-1 hash fingerprint of the certificate.
10600
10601
10602 .vitem &*${sha256:*&<&'string'&>&*}*&
10603 .cindex "SHA-256 hash"
10604 .cindex certificate fingerprint
10605 .cindex "expansion" "SHA-256 hashing"
10606 .cindex "&%sha256%& expansion item"
10607 The &%sha256%& operator computes the SHA-256 hash value of the string
10608 and returns
10609 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10610
10611 If the string is a single variable of type certificate,
10612 returns the SHA-256 hash fingerprint of the certificate.
10613
10614
10615 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10616        &*${sha3_<n>:*&<&'string'&>&*}*&
10617 .cindex "SHA3 hash"
10618 .cindex "expansion" "SHA3 hashing"
10619 .cindex "&%sha3%& expansion item"
10620 The &%sha3%& operator computes the SHA3-256 hash value of the string
10621 and returns
10622 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10623
10624 If a number is appended, separated by an underbar, it specifies
10625 the output length.  Values of 224, 256, 384 and 512 are accepted;
10626 with 256 being the default.
10627
10628 The &%sha3%& expansion item is only supported if Exim has been
10629 compiled with GnuTLS 3.5.0 or later.
10630
10631
10632 .vitem &*${stat:*&<&'string'&>&*}*&
10633 .cindex "expansion" "statting a file"
10634 .cindex "file" "extracting characteristics"
10635 .cindex "&%stat%& expansion item"
10636 The string, after expansion, must be a file path. A call to the &[stat()]&
10637 function is made for this path. If &[stat()]& fails, an error occurs and the
10638 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10639 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10640 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10641 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10642 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10643 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10644 can extract individual fields using the &%extract%& expansion item.
10645
10646 The use of the &%stat%& expansion in users' filter files can be locked out by
10647 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10648 systems for files larger than 2GB.
10649
10650 .vitem &*${str2b64:*&<&'string'&>&*}*&
10651 .cindex "&%str2b64%& expansion item"
10652 Now deprecated, a synonym for the &%base64%& expansion operator.
10653
10654
10655
10656 .vitem &*${strlen:*&<&'string'&>&*}*&
10657 .cindex "expansion" "string length"
10658 .cindex "string" "length in expansion"
10659 .cindex "&%strlen%& expansion item"
10660 The item is replace by the length of the expanded string, expressed as a
10661 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10662
10663
10664 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10665 .cindex "&%substr%& expansion item"
10666 .cindex "substring extraction"
10667 .cindex "expansion" "substring expansion"
10668 The &%substr%& operator is a simpler interface to the &%substr%& function that
10669 can be used when the two parameters are fixed numbers (as opposed to strings
10670 that change when expanded). The effect is the same as
10671 .code
10672 ${substr{<start>}{<length>}{<string>}}
10673 .endd
10674 See the description of the general &%substr%& item above for details. The
10675 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10676
10677 .vitem &*${time_eval:*&<&'string'&>&*}*&
10678 .cindex "&%time_eval%& expansion item"
10679 .cindex "time interval" "decoding"
10680 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10681 seconds.
10682
10683 .vitem &*${time_interval:*&<&'string'&>&*}*&
10684 .cindex "&%time_interval%& expansion item"
10685 .cindex "time interval" "formatting"
10686 The argument (after sub-expansion) must be a sequence of decimal digits that
10687 represents an interval of time as a number of seconds. It is converted into a
10688 number of larger units and output in Exim's normal time format, for example,
10689 &`1w3d4h2m6s`&.
10690
10691 .vitem &*${uc:*&<&'string'&>&*}*&
10692 .cindex "case forcing in strings"
10693 .cindex "string" "case forcing"
10694 .cindex "upper casing"
10695 .cindex "expansion" "case forcing"
10696 .cindex "&%uc%& expansion item"
10697 This forces the letters in the string into upper-case.
10698
10699 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10700 .cindex "correction of invalid utf-8 sequences in strings"
10701 .cindex "utf-8" "utf-8 sequences"
10702 .cindex "incorrect utf-8"
10703 .cindex "expansion" "utf-8 forcing"
10704 .cindex "&%utf8clean%& expansion item"
10705 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10706
10707 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10708        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10709        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10710        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10711 .cindex expansion UTF-8
10712 .cindex UTF-8 expansion
10713 .cindex EAI
10714 .cindex internationalisation
10715 .cindex "&%utf8_domain_to_alabel%& expansion item"
10716 .cindex "&%utf8_domain_from_alabel%& expansion item"
10717 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10718 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10719 These convert EAI mail name components between UTF-8 and a-label forms.
10720 For information on internationalisation support see &<<SECTi18nMTA>>&.
10721 .endlist
10722
10723
10724
10725
10726
10727
10728 .section "Expansion conditions" "SECTexpcond"
10729 .scindex IIDexpcond "expansion" "conditions"
10730 The following conditions are available for testing by the &%${if%& construct
10731 while expanding strings:
10732
10733 .vlist
10734 .vitem &*!*&<&'condition'&>
10735 .cindex "expansion" "negating a condition"
10736 .cindex "negation" "in expansion condition"
10737 Preceding any condition with an exclamation mark negates the result of the
10738 condition.
10739
10740 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10741 .cindex "numeric comparison"
10742 .cindex "expansion" "numeric comparison"
10743 There are a number of symbolic operators for doing numeric comparisons. They
10744 are:
10745 .display
10746 &`=   `&   equal
10747 &`==  `&   equal
10748 &`>   `&   greater
10749 &`>=  `&   greater or equal
10750 &`<   `&   less
10751 &`<=  `&   less or equal
10752 .endd
10753 For example:
10754 .code
10755 ${if >{$message_size}{10M} ...
10756 .endd
10757 Note that the general negation operator provides for inequality testing. The
10758 two strings must take the form of optionally signed decimal integers,
10759 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10760 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10761 As a special case, the numerical value of an empty string is taken as
10762 zero.
10763
10764 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10765 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10766 10M, not if 10M is larger than &$message_size$&.
10767
10768
10769 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10770         {*&<&'arg2'&>&*}...}*&
10771 .cindex "expansion" "calling an acl"
10772 .cindex "&%acl%&" "expansion condition"
10773 The name and zero to nine argument strings are first expanded separately.  The expanded
10774 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10775 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10776 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10777 and may use the variables; if another acl expansion is used the values
10778 are restored after it returns.  If the ACL sets
10779 a value using a "message =" modifier the variable $value becomes
10780 the result of the expansion, otherwise it is empty.
10781 If the ACL returns accept the condition is true; if deny, false.
10782 If the ACL returns defer the result is a forced-fail.
10783
10784 .vitem &*bool&~{*&<&'string'&>&*}*&
10785 .cindex "expansion" "boolean parsing"
10786 .cindex "&%bool%& expansion condition"
10787 This condition turns a string holding a true or false representation into
10788 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10789 (case-insensitively); also integer numbers map to true if non-zero,
10790 false if zero.
10791 An empty string is treated as false.
10792 Leading and trailing whitespace is ignored;
10793 thus a string consisting only of whitespace is false.
10794 All other string values will result in expansion failure.
10795
10796 When combined with ACL variables, this expansion condition will let you
10797 make decisions in one place and act on those decisions in another place.
10798 For example:
10799 .code
10800 ${if bool{$acl_m_privileged_sender} ...
10801 .endd
10802
10803
10804 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10805 .cindex "expansion" "boolean parsing"
10806 .cindex "&%bool_lax%& expansion condition"
10807 Like &%bool%&, this condition turns a string into a boolean state.  But
10808 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10809 loose definition that the Router &%condition%& option uses.  The empty string
10810 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10811 true.  Leading and trailing whitespace is ignored.
10812
10813 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10814
10815 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10816 .cindex "expansion" "encrypted comparison"
10817 .cindex "encrypted strings, comparing"
10818 .cindex "&%crypteq%& expansion condition"
10819 This condition is included in the Exim binary if it is built to support any
10820 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10821 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10822 included in the binary.
10823
10824 The &%crypteq%& condition has two arguments. The first is encrypted and
10825 compared against the second, which is already encrypted. The second string may
10826 be in the LDAP form for storing encrypted strings, which starts with the
10827 encryption type in curly brackets, followed by the data. If the second string
10828 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10829 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10830 Typically this will be a field from a password file. An example of an encrypted
10831 string in LDAP form is:
10832 .code
10833 {md5}CY9rzUYh03PK3k6DJie09g==
10834 .endd
10835 If such a string appears directly in an expansion, the curly brackets have to
10836 be quoted, because they are part of the expansion syntax. For example:
10837 .code
10838 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10839 .endd
10840 The following encryption types (whose names are matched case-independently) are
10841 supported:
10842
10843 .ilist
10844 .cindex "MD5 hash"
10845 .cindex "base64 encoding" "in encrypted password"
10846 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10847 printable characters to compare with the remainder of the second string. If the
10848 length of the comparison string is 24, Exim assumes that it is base64 encoded
10849 (as in the above example). If the length is 32, Exim assumes that it is a
10850 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10851 comparison fails.
10852
10853 .next
10854 .cindex "SHA-1 hash"
10855 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10856 printable characters to compare with the remainder of the second string. If the
10857 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10858 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10859 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10860
10861 .next
10862 .cindex "&[crypt()]&"
10863 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10864 only the first eight characters of the password. However, in modern operating
10865 systems this is no longer true, and in many cases the entire password is used,
10866 whatever its length.
10867
10868 .next
10869 .cindex "&[crypt16()]&"
10870 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10871 use up to 16 characters of the password in some operating systems. Again, in
10872 modern operating systems, more characters may be used.
10873 .endlist
10874 Exim has its own version of &[crypt16()]&, which is just a double call to
10875 &[crypt()]&. For operating systems that have their own version, setting
10876 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10877 operating system version instead of its own. This option is set by default in
10878 the OS-dependent &_Makefile_& for those operating systems that are known to
10879 support &[crypt16()]&.
10880
10881 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10882 it was not using the same algorithm as some operating systems' versions. It
10883 turns out that as well as &[crypt16()]& there is a function called
10884 &[bigcrypt()]& in some operating systems. This may or may not use the same
10885 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10886
10887 However, since there is now a move away from the traditional &[crypt()]&
10888 functions towards using SHA1 and other algorithms, tidying up this area of
10889 Exim is seen as very low priority.
10890
10891 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10892 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10893 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10894 default is &`{crypt}`&. Whatever the default, you can always use either
10895 function by specifying it explicitly in curly brackets.
10896
10897 .vitem &*def:*&<&'variable&~name'&>
10898 .cindex "expansion" "checking for empty variable"
10899 .cindex "&%def%& expansion condition"
10900 The &%def%& condition must be followed by the name of one of the expansion
10901 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10902 variable does not contain the empty string. For example:
10903 .code
10904 ${if def:sender_ident {from $sender_ident}}
10905 .endd
10906 Note that the variable name is given without a leading &%$%& character. If the
10907 variable does not exist, the expansion fails.
10908
10909 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10910         &~&*def:h_*&<&'header&~name'&>&*:*&"
10911 .cindex "expansion" "checking header line existence"
10912 This condition is true if a message is being processed and the named header
10913 exists in the message. For example,
10914 .code
10915 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10916 .endd
10917 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10918 the header name must be terminated by a colon if white space does not follow.
10919
10920 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10921        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10922 .cindex "string" "comparison"
10923 .cindex "expansion" "string comparison"
10924 .cindex "&%eq%& expansion condition"
10925 .cindex "&%eqi%& expansion condition"
10926 The two substrings are first expanded. The condition is true if the two
10927 resulting strings are identical. For &%eq%& the comparison includes the case of
10928 letters, whereas for &%eqi%& the comparison is case-independent.
10929
10930 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10931 .cindex "expansion" "file existence test"
10932 .cindex "file" "existence test"
10933 .cindex "&%exists%&, expansion condition"
10934 The substring is first expanded and then interpreted as an absolute path. The
10935 condition is true if the named file (or directory) exists. The existence test
10936 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10937 users' filter files may be locked out by the system administrator.
10938
10939 .vitem &*first_delivery*&
10940 .cindex "delivery" "first"
10941 .cindex "first delivery"
10942 .cindex "expansion" "first delivery test"
10943 .cindex "&%first_delivery%& expansion condition"
10944 This condition, which has no data, is true during a message's first delivery
10945 attempt. It is false during any subsequent delivery attempts.
10946
10947
10948 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10949        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10950 .cindex "list" "iterative conditions"
10951 .cindex "expansion" "&*forall*& condition"
10952 .cindex "expansion" "&*forany*& condition"
10953 .vindex "&$item$&"
10954 These conditions iterate over a list. The first argument is expanded to form
10955 the list. By default, the list separator is a colon, but it can be changed by
10956 the normal method. The second argument is interpreted as a condition that is to
10957 be applied to each item in the list in turn. During the interpretation of the
10958 condition, the current list item is placed in a variable called &$item$&.
10959 .ilist
10960 For &*forany*&, interpretation stops if the condition is true for any item, and
10961 the result of the whole condition is true. If the condition is false for all
10962 items in the list, the overall condition is false.
10963 .next
10964 For &*forall*&, interpretation stops if the condition is false for any item,
10965 and the result of the whole condition is false. If the condition is true for
10966 all items in the list, the overall condition is true.
10967 .endlist
10968 Note that negation of &*forany*& means that the condition must be false for all
10969 items for the overall condition to succeed, and negation of &*forall*& means
10970 that the condition must be false for at least one item. In this example, the
10971 list separator is changed to a comma:
10972 .code
10973 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10974 .endd
10975 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10976 being processed, to enable these expansion items to be nested.
10977
10978 To scan a named list, expand it with the &*listnamed*& operator.
10979
10980
10981 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10982        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10983 .cindex "string" "comparison"
10984 .cindex "expansion" "string comparison"
10985 .cindex "&%ge%& expansion condition"
10986 .cindex "&%gei%& expansion condition"
10987 The two substrings are first expanded. The condition is true if the first
10988 string is lexically greater than or equal to the second string. For &%ge%& the
10989 comparison includes the case of letters, whereas for &%gei%& the comparison is
10990 case-independent.
10991
10992 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10993        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10994 .cindex "string" "comparison"
10995 .cindex "expansion" "string comparison"
10996 .cindex "&%gt%& expansion condition"
10997 .cindex "&%gti%& expansion condition"
10998 The two substrings are first expanded. The condition is true if the first
10999 string is lexically greater than the second string. For &%gt%& the comparison
11000 includes the case of letters, whereas for &%gti%& the comparison is
11001 case-independent.
11002
11003 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11004        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11005 .cindex "string" "comparison"
11006 .cindex "list" "iterative conditions"
11007 Both strings are expanded; the second string is treated as a list of simple
11008 strings; if the first string is a member of the second, then the condition
11009 is true.
11010
11011 These are simpler to use versions of the more powerful &*forany*& condition.
11012 Examples, and the &*forany*& equivalents:
11013 .code
11014 ${if inlist{needle}{foo:needle:bar}}
11015   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11016 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11017   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11018 .endd
11019
11020 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11021        &*isip4&~{*&<&'string'&>&*}*& &&&
11022        &*isip6&~{*&<&'string'&>&*}*&
11023 .cindex "IP address" "testing string format"
11024 .cindex "string" "testing for IP address"
11025 .cindex "&%isip%& expansion condition"
11026 .cindex "&%isip4%& expansion condition"
11027 .cindex "&%isip6%& expansion condition"
11028 The substring is first expanded, and then tested to see if it has the form of
11029 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11030 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11031
11032 For an IPv4 address, the test is for four dot-separated components, each of
11033 which consists of from one to three digits. For an IPv6 address, up to eight
11034 colon-separated components are permitted, each containing from one to four
11035 hexadecimal digits. There may be fewer than eight components if an empty
11036 component (adjacent colons) is present. Only one empty component is permitted.
11037
11038 .new
11039 &*Note*&: The checks used to be just on the form of the address; actual numerical
11040 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11041 check.
11042 This is no longer the case.
11043 .wen
11044
11045 The main use of these tests is to distinguish between IP addresses and
11046 host names, or between IPv4 and IPv6 addresses. For example, you could use
11047 .code
11048 ${if isip4{$sender_host_address}...
11049 .endd
11050 to test which IP version an incoming SMTP connection is using.
11051
11052 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11053 .cindex "LDAP" "use for authentication"
11054 .cindex "expansion" "LDAP authentication test"
11055 .cindex "&%ldapauth%& expansion condition"
11056 This condition supports user authentication using LDAP. See section
11057 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11058 queries. For this use, the query must contain a user name and password. The
11059 query itself is not used, and can be empty. The condition is true if the
11060 password is not empty, and the user name and password are accepted by the LDAP
11061 server. An empty password is rejected without calling LDAP because LDAP binds
11062 with an empty password are considered anonymous regardless of the username, and
11063 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11064 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11065 this can be used.
11066
11067
11068 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11069        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11070 .cindex "string" "comparison"
11071 .cindex "expansion" "string comparison"
11072 .cindex "&%le%& expansion condition"
11073 .cindex "&%lei%& expansion condition"
11074 The two substrings are first expanded. The condition is true if the first
11075 string is lexically less than or equal to the second string. For &%le%& the
11076 comparison includes the case of letters, whereas for &%lei%& the comparison is
11077 case-independent.
11078
11079 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11080        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11081 .cindex "string" "comparison"
11082 .cindex "expansion" "string comparison"
11083 .cindex "&%lt%& expansion condition"
11084 .cindex "&%lti%& expansion condition"
11085 The two substrings are first expanded. The condition is true if the first
11086 string is lexically less than the second string. For &%lt%& the comparison
11087 includes the case of letters, whereas for &%lti%& the comparison is
11088 case-independent.
11089
11090
11091 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11092 .cindex "expansion" "regular expression comparison"
11093 .cindex "regular expressions" "match in expanded string"
11094 .cindex "&%match%& expansion condition"
11095 The two substrings are first expanded. The second is then treated as a regular
11096 expression and applied to the first. Because of the pre-expansion, if the
11097 regular expression contains dollar, or backslash characters, they must be
11098 escaped. Care must also be taken if the regular expression contains braces
11099 (curly brackets). A closing brace must be escaped so that it is not taken as a
11100 premature termination of <&'string2'&>. The easiest approach is to use the
11101 &`\N`& feature to disable expansion of the regular expression.
11102 For example,
11103 .code
11104 ${if match {$local_part}{\N^\d{3}\N} ...
11105 .endd
11106 If the whole expansion string is in double quotes, further escaping of
11107 backslashes is also required.
11108
11109 The condition is true if the regular expression match succeeds.
11110 The regular expression is not required to begin with a circumflex
11111 metacharacter, but if there is no circumflex, the expression is not anchored,
11112 and it may match anywhere in the subject, not just at the start. If you want
11113 the pattern to match at the end of the subject, you must include the &`$`&
11114 metacharacter at an appropriate point.
11115
11116 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11117 At the start of an &%if%& expansion the values of the numeric variable
11118 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11119 succeeds causes them to be reset to the substrings of that condition and they
11120 will have these values during the expansion of the success string. At the end
11121 of the &%if%& expansion, the previous values are restored. After testing a
11122 combination of conditions using &%or%&, the subsequent values of the numeric
11123 variables are those of the condition that succeeded.
11124
11125 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11126 .cindex "&%match_address%& expansion condition"
11127 See &*match_local_part*&.
11128
11129 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11130 .cindex "&%match_domain%& expansion condition"
11131 See &*match_local_part*&.
11132
11133 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11134 .cindex "&%match_ip%& expansion condition"
11135 This condition matches an IP address to a list of IP address patterns. It must
11136 be followed by two argument strings. The first (after expansion) must be an IP
11137 address or an empty string. The second (not expanded) is a restricted host
11138 list that can match only an IP address, not a host name. For example:
11139 .code
11140 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11141 .endd
11142 The specific types of host list item that are permitted in the list are:
11143
11144 .ilist
11145 An IP address, optionally with a CIDR mask.
11146 .next
11147 A single asterisk, which matches any IP address.
11148 .next
11149 An empty item, which matches only if the IP address is empty. This could be
11150 useful for testing for a locally submitted message or one from specific hosts
11151 in a single test such as
11152 . ==== As this is a nested list, any displays it contains must be indented
11153 . ==== as otherwise they are too far to the left. This comment applies to
11154 . ==== the use of xmlto plus fop. There's no problem when formatting with
11155 . ==== sdop, with or without the extra indent.
11156 .code
11157   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11158 .endd
11159 where the first item in the list is the empty string.
11160 .next
11161 The item @[] matches any of the local host's interface addresses.
11162 .next
11163 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11164 even if &`net-`& is not specified. There is never any attempt to turn the IP
11165 address into a host name. The most common type of linear search for
11166 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11167 masks. For example:
11168 .code
11169   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11170 .endd
11171 It is of course possible to use other kinds of lookup, and in such a case, you
11172 do need to specify the &`net-`& prefix if you want to specify a specific
11173 address mask, for example:
11174 .code
11175   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11176 .endd
11177 However, unless you are combining a &%match_ip%& condition with others, it is
11178 just as easy to use the fact that a lookup is itself a condition, and write:
11179 .code
11180   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11181 .endd
11182 .endlist ilist
11183
11184 Note that <&'string2'&> is not itself subject to string expansion, unless
11185 Exim was built with the EXPAND_LISTMATCH_RHS option.
11186
11187 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11188
11189 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11190 .cindex "domain list" "in expansion condition"
11191 .cindex "address list" "in expansion condition"
11192 .cindex "local part" "list, in expansion condition"
11193 .cindex "&%match_local_part%& expansion condition"
11194 This condition, together with &%match_address%& and &%match_domain%&, make it
11195 possible to test domain, address, and local part lists within expansions. Each
11196 condition requires two arguments: an item and a list to match. A trivial
11197 example is:
11198 .code
11199 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11200 .endd
11201 In each case, the second argument may contain any of the allowable items for a
11202 list of the appropriate type. Also, because the second argument
11203 is a standard form of list, it is possible to refer to a named list.
11204 Thus, you can use conditions like this:
11205 .code
11206 ${if match_domain{$domain}{+local_domains}{...
11207 .endd
11208 .cindex "&`+caseful`&"
11209 For address lists, the matching starts off caselessly, but the &`+caseful`&
11210 item can be used, as in all address lists, to cause subsequent items to
11211 have their local parts matched casefully. Domains are always matched
11212 caselessly.
11213
11214 Note that <&'string2'&> is not itself subject to string expansion, unless
11215 Exim was built with the EXPAND_LISTMATCH_RHS option.
11216
11217 &*Note*&: Host lists are &'not'& supported in this way. This is because
11218 hosts have two identities: a name and an IP address, and it is not clear
11219 how to specify cleanly how such a test would work. However, IP addresses can be
11220 matched using &%match_ip%&.
11221
11222 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11223 .cindex "PAM authentication"
11224 .cindex "AUTH" "with PAM"
11225 .cindex "Solaris" "PAM support"
11226 .cindex "expansion" "PAM authentication test"
11227 .cindex "&%pam%& expansion condition"
11228 &'Pluggable Authentication Modules'&
11229 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11230 available in the latest releases of Solaris and in some GNU/Linux
11231 distributions. The Exim support, which is intended for use in conjunction with
11232 the SMTP AUTH command, is available only if Exim is compiled with
11233 .code
11234 SUPPORT_PAM=yes
11235 .endd
11236 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11237 in some releases of GNU/Linux &%-ldl%& is also needed.
11238
11239 The argument string is first expanded, and the result must be a
11240 colon-separated list of strings. Leading and trailing white space is ignored.
11241 The PAM module is initialized with the service name &"exim"& and the user name
11242 taken from the first item in the colon-separated data string (<&'string1'&>).
11243 The remaining items in the data string are passed over in response to requests
11244 from the authentication function. In the simple case there will only be one
11245 request, for a password, so the data consists of just two strings.
11246
11247 There can be problems if any of the strings are permitted to contain colon
11248 characters. In the usual way, these have to be doubled to avoid being taken as
11249 separators. If the data is being inserted from a variable, the &%sg%& expansion
11250 item can be used to double any existing colons. For example, the configuration
11251 of a LOGIN authenticator might contain this setting:
11252 .code
11253 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11254 .endd
11255 For a PLAIN authenticator you could use:
11256 .code
11257 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11258 .endd
11259 In some operating systems, PAM authentication can be done only from a process
11260 running as root. Since Exim is running as the Exim user when receiving
11261 messages, this means that PAM cannot be used directly in those systems.
11262 A patched version of the &'pam_unix'& module that comes with the
11263 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11264 The patched module allows one special uid/gid combination, in addition to root,
11265 to authenticate. If you build the patched module to allow the Exim user and
11266 group, PAM can then be used from an Exim authenticator.
11267
11268
11269 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11270 .cindex "&'pwcheck'& daemon"
11271 .cindex "Cyrus"
11272 .cindex "expansion" "&'pwcheck'& authentication test"
11273 .cindex "&%pwcheck%& expansion condition"
11274 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11275 This is one way of making it possible for passwords to be checked by a process
11276 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11277 deprecated. Its replacement is &'saslauthd'& (see below).
11278
11279 The pwcheck support is not included in Exim by default. You need to specify
11280 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11281 building Exim. For example:
11282 .code
11283 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11284 .endd
11285 You do not need to install the full Cyrus software suite in order to use
11286 the pwcheck daemon. You can compile and install just the daemon alone
11287 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11288 access to the &_/var/pwcheck_& directory.
11289
11290 The &%pwcheck%& condition takes one argument, which must be the user name and
11291 password, separated by a colon. For example, in a LOGIN authenticator
11292 configuration, you might have this:
11293 .code
11294 server_condition = ${if pwcheck{$auth1:$auth2}}
11295 .endd
11296 Again, for a PLAIN authenticator configuration, this would be:
11297 .code
11298 server_condition = ${if pwcheck{$auth2:$auth3}}
11299 .endd
11300 .vitem &*queue_running*&
11301 .cindex "queue runner" "detecting when delivering from"
11302 .cindex "expansion" "queue runner test"
11303 .cindex "&%queue_running%& expansion condition"
11304 This condition, which has no data, is true during delivery attempts that are
11305 initiated by queue runner processes, and false otherwise.
11306
11307
11308 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11309 .cindex "Radius"
11310 .cindex "expansion" "Radius authentication"
11311 .cindex "&%radius%& expansion condition"
11312 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11313 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11314 the Radius client configuration file in order to build Exim with Radius
11315 support.
11316
11317 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11318 library, using the original API. If you are using release 0.4.0 or later of
11319 this library, you need to set
11320 .code
11321 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11322 .endd
11323 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11324 &%libradius%& library that comes with FreeBSD. To do this, set
11325 .code
11326 RADIUS_LIB_TYPE=RADLIB
11327 .endd
11328 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11329 You may also have to supply a suitable setting in EXTRALIBS so that the
11330 Radius library can be found when Exim is linked.
11331
11332 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11333 Radius client library, which calls the Radius server. The condition is true if
11334 the authentication is successful. For example:
11335 .code
11336 server_condition = ${if radius{<arguments>}}
11337 .endd
11338
11339
11340 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11341         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11342 .cindex "&'saslauthd'& daemon"
11343 .cindex "Cyrus"
11344 .cindex "expansion" "&'saslauthd'& authentication test"
11345 .cindex "&%saslauthd%& expansion condition"
11346 This condition supports user authentication using the Cyrus &'saslauthd'&
11347 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11348 Using this daemon is one way of making it possible for passwords to be checked
11349 by a process that is not running as root.
11350
11351 The saslauthd support is not included in Exim by default. You need to specify
11352 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11353 building Exim. For example:
11354 .code
11355 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11356 .endd
11357 You do not need to install the full Cyrus software suite in order to use
11358 the saslauthd daemon. You can compile and install just the daemon alone
11359 from the Cyrus SASL library.
11360
11361 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11362 two are mandatory. For example:
11363 .code
11364 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11365 .endd
11366 The service and the realm are optional (which is why the arguments are enclosed
11367 in their own set of braces). For details of the meaning of the service and
11368 realm, and how to run the daemon, consult the Cyrus documentation.
11369 .endlist vlist
11370
11371
11372
11373 .section "Combining expansion conditions" "SECID84"
11374 .cindex "expansion" "combining conditions"
11375 Several conditions can be tested at once by combining them using the &%and%&
11376 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11377 conditions on their own, and precede their lists of sub-conditions. Each
11378 sub-condition must be enclosed in braces within the overall braces that contain
11379 the list. No repetition of &%if%& is used.
11380
11381
11382 .vlist
11383 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11384 .cindex "&""or""& expansion condition"
11385 .cindex "expansion" "&""or""& of conditions"
11386 The sub-conditions are evaluated from left to right. The condition is true if
11387 any one of the sub-conditions is true.
11388 For example,
11389 .code
11390 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11391 .endd
11392 When a true sub-condition is found, the following ones are parsed but not
11393 evaluated. If there are several &"match"& sub-conditions the values of the
11394 numeric variables afterwards are taken from the first one that succeeds.
11395
11396 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11397 .cindex "&""and""& expansion condition"
11398 .cindex "expansion" "&""and""& of conditions"
11399 The sub-conditions are evaluated from left to right. The condition is true if
11400 all of the sub-conditions are true. If there are several &"match"&
11401 sub-conditions, the values of the numeric variables afterwards are taken from
11402 the last one. When a false sub-condition is found, the following ones are
11403 parsed but not evaluated.
11404 .endlist
11405 .ecindex IIDexpcond
11406
11407
11408
11409
11410 .section "Expansion variables" "SECTexpvar"
11411 .cindex "expansion" "variables, list of"
11412 This section contains an alphabetical list of all the expansion variables. Some
11413 of them are available only when Exim is compiled with specific options such as
11414 support for TLS or the content scanning extension.
11415
11416 .vlist
11417 .vitem "&$0$&, &$1$&, etc"
11418 .cindex "numerical variables (&$1$& &$2$& etc)"
11419 When a &%match%& expansion condition succeeds, these variables contain the
11420 captured substrings identified by the regular expression during subsequent
11421 processing of the success string of the containing &%if%& expansion item.
11422 In the expansion condition case
11423 they do not retain their values afterwards; in fact, their previous
11424 values are restored at the end of processing an &%if%& item. The numerical
11425 variables may also be set externally by some other matching process which
11426 precedes the expansion of the string. For example, the commands available in
11427 Exim filter files include an &%if%& command with its own regular expression
11428 matching condition.
11429
11430 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11431 Within an acl condition, expansion condition or expansion item
11432 any arguments are copied to these variables,
11433 any unused variables being made empty.
11434
11435 .vitem "&$acl_c...$&"
11436 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11437 can be given any name that starts with &$acl_c$& and is at least six characters
11438 long, but the sixth character must be either a digit or an underscore. For
11439 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11440 variables persist throughout the lifetime of an SMTP connection. They can be
11441 used to pass information between ACLs and between different invocations of the
11442 same ACL. When a message is received, the values of these variables are saved
11443 with the message, and can be accessed by filters, routers, and transports
11444 during subsequent delivery.
11445
11446 .vitem "&$acl_m...$&"
11447 These variables are like the &$acl_c...$& variables, except that their values
11448 are reset after a message has been received. Thus, if several messages are
11449 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11450 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11451 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11452 message is received, the values of these variables are saved with the message,
11453 and can be accessed by filters, routers, and transports during subsequent
11454 delivery.
11455
11456 .vitem &$acl_narg$&
11457 Within an acl condition, expansion condition or expansion item
11458 this variable has the number of arguments.
11459
11460 .vitem &$acl_verify_message$&
11461 .vindex "&$acl_verify_message$&"
11462 After an address verification has failed, this variable contains the failure
11463 message. It retains its value for use in subsequent modifiers. The message can
11464 be preserved by coding like this:
11465 .code
11466 warn !verify = sender
11467      set acl_m0 = $acl_verify_message
11468 .endd
11469 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11470 &%log_message%& modifiers, to include information about the verification
11471 failure.
11472
11473 .vitem &$address_data$&
11474 .vindex "&$address_data$&"
11475 This variable is set by means of the &%address_data%& option in routers. The
11476 value then remains with the address while it is processed by subsequent routers
11477 and eventually a transport. If the transport is handling multiple addresses,
11478 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11479 for more details. &*Note*&: The contents of &$address_data$& are visible in
11480 user filter files.
11481
11482 If &$address_data$& is set when the routers are called from an ACL to verify
11483 a recipient address, the final value is still in the variable for subsequent
11484 conditions and modifiers of the ACL statement. If routing the address caused it
11485 to be redirected to just one address, the child address is also routed as part
11486 of the verification, and in this case the final value of &$address_data$& is
11487 from the child's routing.
11488
11489 If &$address_data$& is set when the routers are called from an ACL to verify a
11490 sender address, the final value is also preserved, but this time in
11491 &$sender_address_data$&, to distinguish it from data from a recipient
11492 address.
11493
11494 In both cases (recipient and sender verification), the value does not persist
11495 after the end of the current ACL statement. If you want to preserve
11496 these values for longer, you can save them in ACL variables.
11497
11498 .vitem &$address_file$&
11499 .vindex "&$address_file$&"
11500 When, as a result of aliasing, forwarding, or filtering, a message is directed
11501 to a specific file, this variable holds the name of the file when the transport
11502 is running. At other times, the variable is empty. For example, using the
11503 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11504 .code
11505 /home/r2d2/savemail
11506 .endd
11507 then when the &(address_file)& transport is running, &$address_file$&
11508 contains the text string &`/home/r2d2/savemail`&.
11509 .cindex "Sieve filter" "value of &$address_file$&"
11510 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11511 then up to the transport configuration to generate an appropriate absolute path
11512 to the relevant file.
11513
11514 .vitem &$address_pipe$&
11515 .vindex "&$address_pipe$&"
11516 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11517 this variable holds the pipe command when the transport is running.
11518
11519 .vitem "&$auth1$& &-- &$auth3$&"
11520 .vindex "&$auth1$&, &$auth2$&, etc"
11521 These variables are used in SMTP authenticators (see chapters
11522 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11523
11524 .vitem &$authenticated_id$&
11525 .cindex "authentication" "id"
11526 .vindex "&$authenticated_id$&"
11527 When a server successfully authenticates a client it may be configured to
11528 preserve some of the authentication information in the variable
11529 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11530 user/password authenticator configuration might preserve the user name for use
11531 in the routers. Note that this is not the same information that is saved in
11532 &$sender_host_authenticated$&.
11533 When a message is submitted locally (that is, not over a TCP connection)
11534 the value of &$authenticated_id$& is normally the login name of the calling
11535 process. However, a trusted user can override this by means of the &%-oMai%&
11536 command line option.
11537
11538 .vitem &$authenticated_fail_id$&
11539 .cindex "authentication" "fail" "id"
11540 .vindex "&$authenticated_fail_id$&"
11541 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11542 will contain the failed authentication id. If more than one authentication
11543 id is attempted, it will contain only the last one. The variable is
11544 available for processing in the ACL's, generally the quit or notquit ACL.
11545 A message to a local recipient could still be accepted without requiring
11546 authentication, which means this variable could also be visible in all of
11547 the ACL's as well.
11548
11549
11550 .vitem &$authenticated_sender$&
11551 .cindex "sender" "authenticated"
11552 .cindex "authentication" "sender"
11553 .cindex "AUTH" "on MAIL command"
11554 .vindex "&$authenticated_sender$&"
11555 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11556 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11557 described in section &<<SECTauthparamail>>&. Unless the data is the string
11558 &"<>"&, it is set as the authenticated sender of the message, and the value is
11559 available during delivery in the &$authenticated_sender$& variable. If the
11560 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11561
11562 .vindex "&$qualify_domain$&"
11563 When a message is submitted locally (that is, not over a TCP connection), the
11564 value of &$authenticated_sender$& is an address constructed from the login
11565 name of the calling process and &$qualify_domain$&, except that a trusted user
11566 can override this by means of the &%-oMas%& command line option.
11567
11568
11569 .vitem &$authentication_failed$&
11570 .cindex "authentication" "failure"
11571 .vindex "&$authentication_failed$&"
11572 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11573 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11574 possible to distinguish between &"did not try to authenticate"&
11575 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11576 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11577 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11578 negative response to an AUTH command, including (for example) an attempt to use
11579 an undefined mechanism.
11580
11581 .vitem &$av_failed$&
11582 .cindex "content scanning" "AV scanner failure"
11583 This variable is available when Exim is compiled with the content-scanning
11584 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11585 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11586 the ACL malware condition.
11587
11588 .vitem &$body_linecount$&
11589 .cindex "message body" "line count"
11590 .cindex "body of message" "line count"
11591 .vindex "&$body_linecount$&"
11592 When a message is being received or delivered, this variable contains the
11593 number of lines in the message's body. See also &$message_linecount$&.
11594
11595 .vitem &$body_zerocount$&
11596 .cindex "message body" "binary zero count"
11597 .cindex "body of message" "binary zero count"
11598 .cindex "binary zero" "in message body"
11599 .vindex "&$body_zerocount$&"
11600 When a message is being received or delivered, this variable contains the
11601 number of binary zero bytes (ASCII NULs) in the message's body.
11602
11603 .vitem &$bounce_recipient$&
11604 .vindex "&$bounce_recipient$&"
11605 This is set to the recipient address of a bounce message while Exim is creating
11606 it. It is useful if a customized bounce message text file is in use (see
11607 chapter &<<CHAPemsgcust>>&).
11608
11609 .vitem &$bounce_return_size_limit$&
11610 .vindex "&$bounce_return_size_limit$&"
11611 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11612 up to a multiple of 1000. It is useful when a customized error message text
11613 file is in use (see chapter &<<CHAPemsgcust>>&).
11614
11615 .vitem &$caller_gid$&
11616 .cindex "gid (group id)" "caller"
11617 .vindex "&$caller_gid$&"
11618 The real group id under which the process that called Exim was running. This is
11619 not the same as the group id of the originator of a message (see
11620 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11621 incarnation normally contains the Exim gid.
11622
11623 .vitem &$caller_uid$&
11624 .cindex "uid (user id)" "caller"
11625 .vindex "&$caller_uid$&"
11626 The real user id under which the process that called Exim was running. This is
11627 not the same as the user id of the originator of a message (see
11628 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11629 incarnation normally contains the Exim uid.
11630
11631 .vitem &$callout_address$&
11632 .vindex "&$callout_address$&"
11633 After a callout for verification, spamd or malware daemon service, the
11634 address that was connected to.
11635
11636 .vitem &$compile_number$&
11637 .vindex "&$compile_number$&"
11638 The building process for Exim keeps a count of the number
11639 of times it has been compiled. This serves to distinguish different
11640 compilations of the same version of the program.
11641
11642 .vitem &$config_dir$&
11643 .vindex "&$config_dir$&"
11644 The directory name of the main configuration file. That is, the content of
11645 &$config_file$& with the last component stripped. The value does not
11646 contain the trailing slash. If &$config_file$& does not contain a slash,
11647 &$config_dir$& is ".".
11648
11649 .vitem &$config_file$&
11650 .vindex "&$config_file$&"
11651 The name of the main configuration file Exim is using.
11652
11653 .vitem &$dkim_cur_signer$& &&&
11654        &$dkim_verify_status$& &&&
11655        &$dkim_verify_reason$& &&&
11656        &$dkim_domain$& &&&
11657        &$dkim_identity$& &&&
11658        &$dkim_selector$& &&&
11659        &$dkim_algo$& &&&
11660        &$dkim_canon_body$& &&&
11661        &$dkim_canon_headers$& &&&
11662        &$dkim_copiedheaders$& &&&
11663        &$dkim_bodylength$& &&&
11664        &$dkim_created$& &&&
11665        &$dkim_expires$& &&&
11666        &$dkim_headernames$& &&&
11667        &$dkim_key_testing$& &&&
11668        &$dkim_key_nosubdomains$& &&&
11669        &$dkim_key_srvtype$& &&&
11670        &$dkim_key_granularity$& &&&
11671        &$dkim_key_notes$& &&&
11672        &$dkim_key_length$&
11673 These variables are only available within the DKIM ACL.
11674 For details see chapter &<<CHAPdkim>>&.
11675
11676 .vitem &$dkim_signers$&
11677 .vindex &$dkim_signers$&
11678 When a message has been received this variable contains
11679 a colon-separated list of signer domains and identities for the message.
11680 For details see chapter &<<CHAPdkim>>&.
11681
11682 .vitem &$dnslist_domain$& &&&
11683        &$dnslist_matched$& &&&
11684        &$dnslist_text$& &&&
11685        &$dnslist_value$&
11686 .vindex "&$dnslist_domain$&"
11687 .vindex "&$dnslist_matched$&"
11688 .vindex "&$dnslist_text$&"
11689 .vindex "&$dnslist_value$&"
11690 .cindex "black list (DNS)"
11691 When a DNS (black) list lookup succeeds, these variables are set to contain
11692 the following data from the lookup: the list's domain name, the key that was
11693 looked up, the contents of any associated TXT record, and the value from the
11694 main A record. See section &<<SECID204>>& for more details.
11695
11696 .vitem &$domain$&
11697 .vindex "&$domain$&"
11698 When an address is being routed, or delivered on its own, this variable
11699 contains the domain. Uppercase letters in the domain are converted into lower
11700 case for &$domain$&.
11701
11702 Global address rewriting happens when a message is received, so the value of
11703 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11704 is set during user filtering, but not during system filtering, because a
11705 message may have many recipients and the system filter is called just once.
11706
11707 When more than one address is being delivered at once (for example, several
11708 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11709 have the same domain. Transports can be restricted to handling only one domain
11710 at a time if the value of &$domain$& is required at transport time &-- this is
11711 the default for local transports. For further details of the environment in
11712 which local transports are run, see chapter &<<CHAPenvironment>>&.
11713
11714 .oindex "&%delay_warning_condition%&"
11715 At the end of a delivery, if all deferred addresses have the same domain, it is
11716 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11717
11718 The &$domain$& variable is also used in some other circumstances:
11719
11720 .ilist
11721 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11722 the recipient address. The domain of the &'sender'& address is in
11723 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11724 normally set during the running of the MAIL ACL. However, if the sender address
11725 is verified with a callout during the MAIL ACL, the sender domain is placed in
11726 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11727 the &(smtp)& transport.
11728
11729 .next
11730 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11731 &$domain$& contains the domain portion of the address that is being rewritten;
11732 it can be used in the expansion of the replacement address, for example, to
11733 rewrite domains by file lookup.
11734
11735 .next
11736 With one important exception, whenever a domain list is being scanned,
11737 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11738 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11739 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11740 that, in a RCPT ACL, the sender domain list can be dependent on the
11741 recipient domain (which is what is in &$domain$& at this time).
11742
11743 .next
11744 .cindex "ETRN" "value of &$domain$&"
11745 .oindex "&%smtp_etrn_command%&"
11746 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11747 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11748 .endlist
11749
11750
11751 .vitem &$domain_data$&
11752 .vindex "&$domain_data$&"
11753 When the &%domains%& option on a router matches a domain by
11754 means of a lookup, the data read by the lookup is available during the running
11755 of the router as &$domain_data$&. In addition, if the driver routes the
11756 address to a transport, the value is available in that transport. If the
11757 transport is handling multiple addresses, the value from the first address is
11758 used.
11759
11760 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11761 domain by means of a lookup. The data read by the lookup is available during
11762 the rest of the ACL statement. In all other situations, this variable expands
11763 to nothing.
11764
11765 .vitem &$exim_gid$&
11766 .vindex "&$exim_gid$&"
11767 This variable contains the numerical value of the Exim group id.
11768
11769 .vitem &$exim_path$&
11770 .vindex "&$exim_path$&"
11771 This variable contains the path to the Exim binary.
11772
11773 .vitem &$exim_uid$&
11774 .vindex "&$exim_uid$&"
11775 This variable contains the numerical value of the Exim user id.
11776
11777 .vitem &$exim_version$&
11778 .vindex "&$exim_version$&"
11779 This variable contains the version string of the Exim build.
11780 The first character is a major version number, currently 4.
11781 Then after a dot, the next group of digits is a minor version number.
11782 There may be other characters following the minor version.
11783
11784 .vitem &$header_$&<&'name'&>
11785 This is not strictly an expansion variable. It is expansion syntax for
11786 inserting the message header line with the given name. Note that the name must
11787 be terminated by colon or white space, because it may contain a wide variety of
11788 characters. Note also that braces must &'not'& be used.
11789
11790 .vitem &$headers_added$&
11791 .vindex "&$headers_added$&"
11792 Within an ACL this variable contains the headers added so far by
11793 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11794 The headers are a newline-separated list.
11795
11796 .vitem &$home$&
11797 .vindex "&$home$&"
11798 When the &%check_local_user%& option is set for a router, the user's home
11799 directory is placed in &$home$& when the check succeeds. In particular, this
11800 means it is set during the running of users' filter files. A router may also
11801 explicitly set a home directory for use by a transport; this can be overridden
11802 by a setting on the transport itself.
11803
11804 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11805 of the environment variable HOME, which is subject to the
11806 &%keep_environment%& and &%add_environment%& main config options.
11807
11808 .vitem &$host$&
11809 .vindex "&$host$&"
11810 If a router assigns an address to a transport (any transport), and passes a
11811 list of hosts with the address, the value of &$host$& when the transport starts
11812 to run is the name of the first host on the list. Note that this applies both
11813 to local and remote transports.
11814
11815 .cindex "transport" "filter"
11816 .cindex "filter" "transport filter"
11817 For the &(smtp)& transport, if there is more than one host, the value of
11818 &$host$& changes as the transport works its way through the list. In
11819 particular, when the &(smtp)& transport is expanding its options for encryption
11820 using TLS, or for specifying a transport filter (see chapter
11821 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11822 is connected.
11823
11824 When used in the client part of an authenticator configuration (see chapter
11825 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11826 client is connected.
11827
11828
11829 .vitem &$host_address$&
11830 .vindex "&$host_address$&"
11831 This variable is set to the remote host's IP address whenever &$host$& is set
11832 for a remote connection. It is also set to the IP address that is being checked
11833 when the &%ignore_target_hosts%& option is being processed.
11834
11835 .vitem &$host_data$&
11836 .vindex "&$host_data$&"
11837 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11838 result of the lookup is made available in the &$host_data$& variable. This
11839 allows you, for example, to do things like this:
11840 .code
11841 deny  hosts = net-lsearch;/some/file
11842 message = $host_data
11843 .endd
11844 .vitem &$host_lookup_deferred$&
11845 .cindex "host name" "lookup, failure of"
11846 .vindex "&$host_lookup_deferred$&"
11847 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11848 message comes from a remote host and there is an attempt to look up the host's
11849 name from its IP address, and the attempt is not successful, one of these
11850 variables is set to &"1"&.
11851
11852 .ilist
11853 If the lookup receives a definite negative response (for example, a DNS lookup
11854 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11855
11856 .next
11857 If there is any kind of problem during the lookup, such that Exim cannot
11858 tell whether or not the host name is defined (for example, a timeout for a DNS
11859 lookup), &$host_lookup_deferred$& is set to &"1"&.
11860 .endlist ilist
11861
11862 Looking up a host's name from its IP address consists of more than just a
11863 single reverse lookup. Exim checks that a forward lookup of at least one of the
11864 names it receives from a reverse lookup yields the original IP address. If this
11865 is not the case, Exim does not accept the looked up name(s), and
11866 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11867 IP address (for example, the existence of a PTR record in the DNS) is not
11868 sufficient on its own for the success of a host name lookup. If the reverse
11869 lookup succeeds, but there is a lookup problem such as a timeout when checking
11870 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11871 &"1"&. See also &$sender_host_name$&.
11872
11873 .vitem &$host_lookup_failed$&
11874 .vindex "&$host_lookup_failed$&"
11875 See &$host_lookup_deferred$&.
11876
11877 .vitem &$host_port$&
11878 .vindex "&$host_port$&"
11879 This variable is set to the remote host's TCP port whenever &$host$& is set
11880 for an outbound connection.
11881
11882 .vitem &$initial_cwd$&
11883 .vindex "&$initial_cwd$&
11884 This variable contains the full path name of the initial working
11885 directory of the current Exim process. This may differ from the current
11886 working directory, as Exim changes this to "/" during early startup, and
11887 to &$spool_directory$& later.
11888
11889 .vitem &$inode$&
11890 .vindex "&$inode$&"
11891 The only time this variable is set is while expanding the &%directory_file%&
11892 option in the &(appendfile)& transport. The variable contains the inode number
11893 of the temporary file which is about to be renamed. It can be used to construct
11894 a unique name for the file.
11895
11896 .vitem &$interface_address$&
11897 .vindex "&$interface_address$&"
11898 This is an obsolete name for &$received_ip_address$&.
11899
11900 .vitem &$interface_port$&
11901 .vindex "&$interface_port$&"
11902 This is an obsolete name for &$received_port$&.
11903
11904 .vitem &$item$&
11905 .vindex "&$item$&"
11906 This variable is used during the expansion of &*forall*& and &*forany*&
11907 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11908 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11909 empty.
11910
11911 .vitem &$ldap_dn$&
11912 .vindex "&$ldap_dn$&"
11913 This variable, which is available only when Exim is compiled with LDAP support,
11914 contains the DN from the last entry in the most recently successful LDAP
11915 lookup.
11916
11917 .vitem &$load_average$&
11918 .vindex "&$load_average$&"
11919 This variable contains the system load average, multiplied by 1000 so that it
11920 is an integer. For example, if the load average is 0.21, the value of the
11921 variable is 210. The value is recomputed every time the variable is referenced.
11922
11923 .vitem &$local_part$&
11924 .vindex "&$local_part$&"
11925 When an address is being routed, or delivered on its own, this
11926 variable contains the local part. When a number of addresses are being
11927 delivered together (for example, multiple RCPT commands in an SMTP
11928 session), &$local_part$& is not set.
11929
11930 Global address rewriting happens when a message is received, so the value of
11931 &$local_part$& during routing and delivery is the value after rewriting.
11932 &$local_part$& is set during user filtering, but not during system filtering,
11933 because a message may have many recipients and the system filter is called just
11934 once.
11935
11936 .vindex "&$local_part_prefix$&"
11937 .vindex "&$local_part_suffix$&"
11938 If a local part prefix or suffix has been recognized, it is not included in the
11939 value of &$local_part$& during routing and subsequent delivery. The values of
11940 any prefix or suffix are in &$local_part_prefix$& and
11941 &$local_part_suffix$&, respectively.
11942
11943 When a message is being delivered to a file, pipe, or autoreply transport as a
11944 result of aliasing or forwarding, &$local_part$& is set to the local part of
11945 the parent address, not to the file name or command (see &$address_file$& and
11946 &$address_pipe$&).
11947
11948 When an ACL is running for a RCPT command, &$local_part$& contains the
11949 local part of the recipient address.
11950
11951 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11952 &$local_part$& contains the local part of the address that is being rewritten;
11953 it can be used in the expansion of the replacement address, for example.
11954
11955 In all cases, all quoting is removed from the local part. For example, for both
11956 the addresses
11957 .code
11958 "abc:xyz"@test.example
11959 abc\:xyz@test.example
11960 .endd
11961 the value of &$local_part$& is
11962 .code
11963 abc:xyz
11964 .endd
11965 If you use &$local_part$& to create another address, you should always wrap it
11966 inside a quoting operator. For example, in a &(redirect)& router you could
11967 have:
11968 .code
11969 data = ${quote_local_part:$local_part}@new.domain.example
11970 .endd
11971 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11972 to process local parts in a case-dependent manner in a router, you can set the
11973 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11974
11975 .vitem &$local_part_data$&
11976 .vindex "&$local_part_data$&"
11977 When the &%local_parts%& option on a router matches a local part by means of a
11978 lookup, the data read by the lookup is available during the running of the
11979 router as &$local_part_data$&. In addition, if the driver routes the address
11980 to a transport, the value is available in that transport. If the transport is
11981 handling multiple addresses, the value from the first address is used.
11982
11983 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11984 matches a local part by means of a lookup. The data read by the lookup is
11985 available during the rest of the ACL statement. In all other situations, this
11986 variable expands to nothing.
11987
11988 .vitem &$local_part_prefix$&
11989 .vindex "&$local_part_prefix$&"
11990 When an address is being routed or delivered, and a
11991 specific prefix for the local part was recognized, it is available in this
11992 variable, having been removed from &$local_part$&.
11993
11994 .vitem &$local_part_suffix$&
11995 .vindex "&$local_part_suffix$&"
11996 When an address is being routed or delivered, and a
11997 specific suffix for the local part was recognized, it is available in this
11998 variable, having been removed from &$local_part$&.
11999
12000 .vitem &$local_scan_data$&
12001 .vindex "&$local_scan_data$&"
12002 This variable contains the text returned by the &[local_scan()]& function when
12003 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12004
12005 .vitem &$local_user_gid$&
12006 .vindex "&$local_user_gid$&"
12007 See &$local_user_uid$&.
12008
12009 .vitem &$local_user_uid$&
12010 .vindex "&$local_user_uid$&"
12011 This variable and &$local_user_gid$& are set to the uid and gid after the
12012 &%check_local_user%& router precondition succeeds. This means that their values
12013 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12014 and &%condition%&), for the &%address_data%& expansion, and for any
12015 router-specific expansions. At all other times, the values in these variables
12016 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12017
12018 .vitem &$localhost_number$&
12019 .vindex "&$localhost_number$&"
12020 This contains the expanded value of the
12021 &%localhost_number%& option. The expansion happens after the main options have
12022 been read.
12023
12024 .vitem &$log_inodes$&
12025 .vindex "&$log_inodes$&"
12026 The number of free inodes in the disk partition where Exim's
12027 log files are being written. The value is recalculated whenever the variable is
12028 referenced. If the relevant file system does not have the concept of inodes,
12029 the value of is -1. See also the &%check_log_inodes%& option.
12030
12031 .vitem &$log_space$&
12032 .vindex "&$log_space$&"
12033 The amount of free space (as a number of kilobytes) in the disk
12034 partition where Exim's log files are being written. The value is recalculated
12035 whenever the variable is referenced. If the operating system does not have the
12036 ability to find the amount of free space (only true for experimental systems),
12037 the space value is -1. See also the &%check_log_space%& option.
12038
12039
12040 .vitem &$lookup_dnssec_authenticated$&
12041 .vindex "&$lookup_dnssec_authenticated$&"
12042 This variable is set after a DNS lookup done by
12043 a dnsdb lookup expansion, dnslookup router or smtp transport.
12044 .cindex "DNS" "DNSSEC"
12045 It will be empty if &(DNSSEC)& was not requested,
12046 &"no"& if the result was not labelled as authenticated data
12047 and &"yes"& if it was.
12048 Results that are labelled as authoritative answer that match
12049 the &%dns_trust_aa%& configuration variable count also
12050 as authenticated data.
12051
12052 .vitem &$mailstore_basename$&
12053 .vindex "&$mailstore_basename$&"
12054 This variable is set only when doing deliveries in &"mailstore"& format in the
12055 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12056 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12057 contains the basename of the files that are being written, that is, the name
12058 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12059 variable is empty.
12060
12061 .vitem &$malware_name$&
12062 .vindex "&$malware_name$&"
12063 This variable is available when Exim is compiled with the
12064 content-scanning extension. It is set to the name of the virus that was found
12065 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12066
12067 .vitem &$max_received_linelength$&
12068 .vindex "&$max_received_linelength$&"
12069 .cindex "maximum" "line length"
12070 .cindex "line length" "maximum"
12071 This variable contains the number of bytes in the longest line that was
12072 received as part of the message, not counting the line termination
12073 character(s).
12074 .new
12075 It is not valid if the &%spool_files_wireformat%& option is used.
12076 .wen
12077
12078 .vitem &$message_age$&
12079 .cindex "message" "age of"
12080 .vindex "&$message_age$&"
12081 This variable is set at the start of a delivery attempt to contain the number
12082 of seconds since the message was received. It does not change during a single
12083 delivery attempt.
12084
12085 .vitem &$message_body$&
12086 .cindex "body of message" "expansion variable"
12087 .cindex "message body" "in expansion"
12088 .cindex "binary zero" "in message body"
12089 .vindex "&$message_body$&"
12090 .oindex "&%message_body_visible%&"
12091 This variable contains the initial portion of a message's body while it is
12092 being delivered, and is intended mainly for use in filter files. The maximum
12093 number of characters of the body that are put into the variable is set by the
12094 &%message_body_visible%& configuration option; the default is 500.
12095
12096 .oindex "&%message_body_newlines%&"
12097 By default, newlines are converted into spaces in &$message_body$&, to make it
12098 easier to search for phrases that might be split over a line break. However,
12099 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12100 zeros are always converted into spaces.
12101
12102 .vitem &$message_body_end$&
12103 .cindex "body of message" "expansion variable"
12104 .cindex "message body" "in expansion"
12105 .vindex "&$message_body_end$&"
12106 This variable contains the final portion of a message's
12107 body while it is being delivered. The format and maximum size are as for
12108 &$message_body$&.
12109
12110 .vitem &$message_body_size$&
12111 .cindex "body of message" "size"
12112 .cindex "message body" "size"
12113 .vindex "&$message_body_size$&"
12114 When a message is being delivered, this variable contains the size of the body
12115 in bytes. The count starts from the character after the blank line that
12116 separates the body from the header. Newlines are included in the count. See
12117 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12118
12119 .new
12120 If the spool file is wireformat
12121 (see the &%spool_files_wireformat%& main option)
12122 the CRLF line-terminators are included in the count.
12123 .wen
12124
12125 .vitem &$message_exim_id$&
12126 .vindex "&$message_exim_id$&"
12127 When a message is being received or delivered, this variable contains the
12128 unique message id that is generated and used by Exim to identify the message.
12129 An id is not created for a message until after its header has been successfully
12130 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12131 line; it is the local id that Exim assigns to the message, for example:
12132 &`1BXTIK-0001yO-VA`&.
12133
12134 .vitem &$message_headers$&
12135 .vindex &$message_headers$&
12136 This variable contains a concatenation of all the header lines when a message
12137 is being processed, except for lines added by routers or transports. The header
12138 lines are separated by newline characters. Their contents are decoded in the
12139 same way as a header line that is inserted by &%bheader%&.
12140
12141 .vitem &$message_headers_raw$&
12142 .vindex &$message_headers_raw$&
12143 This variable is like &$message_headers$& except that no processing of the
12144 contents of header lines is done.
12145
12146 .vitem &$message_id$&
12147 This is an old name for &$message_exim_id$&. It is now deprecated.
12148
12149 .vitem &$message_linecount$&
12150 .vindex "&$message_linecount$&"
12151 This variable contains the total number of lines in the header and body of the
12152 message. Compare &$body_linecount$&, which is the count for the body only.
12153 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12154 number of lines received. Before delivery happens (that is, before filters,
12155 routers, and transports run) the count is increased to include the
12156 &'Received:'& header line that Exim standardly adds, and also any other header
12157 lines that are added by ACLs. The blank line that separates the message header
12158 from the body is not counted.
12159
12160 As with the special case of &$message_size$&, during the expansion of the
12161 appendfile transport's maildir_tag option in maildir format, the value of
12162 &$message_linecount$& is the precise size of the number of newlines in the
12163 file that has been written (minus one for the blank line between the
12164 header and the body).
12165
12166 Here is an example of the use of this variable in a DATA ACL:
12167 .code
12168 deny message   = Too many lines in message header
12169      condition = \
12170       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12171 .endd
12172 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12173 message has not yet been received.
12174
12175 .new
12176 This variable is not valid if the &%spool_files_wireformat%& option is used.
12177 .wen
12178
12179 .vitem &$message_size$&
12180 .cindex "size" "of message"
12181 .cindex "message" "size"
12182 .vindex "&$message_size$&"
12183 When a message is being processed, this variable contains its size in bytes. In
12184 most cases, the size includes those headers that were received with the
12185 message, but not those (such as &'Envelope-to:'&) that are added to individual
12186 deliveries as they are written. However, there is one special case: during the
12187 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12188 doing a delivery in maildir format, the value of &$message_size$& is the
12189 precise size of the file that has been written. See also
12190 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12191
12192 .cindex "RCPT" "value of &$message_size$&"
12193 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12194 contains the size supplied on the MAIL command, or -1 if no size was given. The
12195 value may not, of course, be truthful.
12196
12197 .vitem &$mime_$&&'xxx'&
12198 A number of variables whose names start with &$mime$& are
12199 available when Exim is compiled with the content-scanning extension. For
12200 details, see section &<<SECTscanmimepart>>&.
12201
12202 .vitem "&$n0$& &-- &$n9$&"
12203 These variables are counters that can be incremented by means
12204 of the &%add%& command in filter files.
12205
12206 .vitem &$original_domain$&
12207 .vindex "&$domain$&"
12208 .vindex "&$original_domain$&"
12209 When a top-level address is being processed for delivery, this contains the
12210 same value as &$domain$&. However, if a &"child"& address (for example,
12211 generated by an alias, forward, or filter file) is being processed, this
12212 variable contains the domain of the original address (lower cased). This
12213 differs from &$parent_domain$& only when there is more than one level of
12214 aliasing or forwarding. When more than one address is being delivered in a
12215 single transport run, &$original_domain$& is not set.
12216
12217 If a new address is created by means of a &%deliver%& command in a system
12218 filter, it is set up with an artificial &"parent"& address. This has the local
12219 part &'system-filter'& and the default qualify domain.
12220
12221 .vitem &$original_local_part$&
12222 .vindex "&$local_part$&"
12223 .vindex "&$original_local_part$&"
12224 When a top-level address is being processed for delivery, this contains the
12225 same value as &$local_part$&, unless a prefix or suffix was removed from the
12226 local part, because &$original_local_part$& always contains the full local
12227 part. When a &"child"& address (for example, generated by an alias, forward, or
12228 filter file) is being processed, this variable contains the full local part of
12229 the original address.
12230
12231 If the router that did the redirection processed the local part
12232 case-insensitively, the value in &$original_local_part$& is in lower case.
12233 This variable differs from &$parent_local_part$& only when there is more than
12234 one level of aliasing or forwarding. When more than one address is being
12235 delivered in a single transport run, &$original_local_part$& is not set.
12236
12237 If a new address is created by means of a &%deliver%& command in a system
12238 filter, it is set up with an artificial &"parent"& address. This has the local
12239 part &'system-filter'& and the default qualify domain.
12240
12241 .vitem &$originator_gid$&
12242 .cindex "gid (group id)" "of originating user"
12243 .cindex "sender" "gid"
12244 .vindex "&$caller_gid$&"
12245 .vindex "&$originator_gid$&"
12246 This variable contains the value of &$caller_gid$& that was set when the
12247 message was received. For messages received via the command line, this is the
12248 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12249 normally the gid of the Exim user.
12250
12251 .vitem &$originator_uid$&
12252 .cindex "uid (user id)" "of originating user"
12253 .cindex "sender" "uid"
12254 .vindex "&$caller_uid$&"
12255 .vindex "&$originator_uid$&"
12256 The value of &$caller_uid$& that was set when the message was received. For
12257 messages received via the command line, this is the uid of the sending user.
12258 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12259 user.
12260
12261 .vitem &$parent_domain$&
12262 .vindex "&$parent_domain$&"
12263 This variable is similar to &$original_domain$& (see
12264 above), except that it refers to the immediately preceding parent address.
12265
12266 .vitem &$parent_local_part$&
12267 .vindex "&$parent_local_part$&"
12268 This variable is similar to &$original_local_part$&
12269 (see above), except that it refers to the immediately preceding parent address.
12270
12271 .vitem &$pid$&
12272 .cindex "pid (process id)" "of current process"
12273 .vindex "&$pid$&"
12274 This variable contains the current process id.
12275
12276 .vitem &$pipe_addresses$&
12277 .cindex "filter" "transport filter"
12278 .cindex "transport" "filter"
12279 .vindex "&$pipe_addresses$&"
12280 This is not an expansion variable, but is mentioned here because the string
12281 &`$pipe_addresses`& is handled specially in the command specification for the
12282 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12283 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12284 It cannot be used in general expansion strings, and provokes an &"unknown
12285 variable"& error if encountered.
12286
12287 .vitem &$primary_hostname$&
12288 .vindex "&$primary_hostname$&"
12289 This variable contains the value set by &%primary_hostname%& in the
12290 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12291 a single-component name, Exim calls &[gethostbyname()]& (or
12292 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12293 qualified host name. See also &$smtp_active_hostname$&.
12294
12295
12296 .vitem &$proxy_external_address$& &&&
12297        &$proxy_external_port$& &&&
12298        &$proxy_local_address$& &&&
12299        &$proxy_local_port$& &&&
12300        &$proxy_session$&
12301 These variables are only available when built with Proxy Protocol
12302 or SOCKS5 support.
12303 For details see chapter &<<SECTproxyInbound>>&.
12304
12305 .vitem &$prdr_requested$&
12306 .cindex "PRDR" "variable for"
12307 This variable is set to &"yes"& if PRDR was requested by the client for the
12308 current message, otherwise &"no"&.
12309
12310 .vitem &$prvscheck_address$&
12311 This variable is used in conjunction with the &%prvscheck%& expansion item,
12312 which is described in sections &<<SECTexpansionitems>>& and
12313 &<<SECTverifyPRVS>>&.
12314
12315 .vitem &$prvscheck_keynum$&
12316 This variable is used in conjunction with the &%prvscheck%& expansion item,
12317 which is described in sections &<<SECTexpansionitems>>& and
12318 &<<SECTverifyPRVS>>&.
12319
12320 .vitem &$prvscheck_result$&
12321 This variable is used in conjunction with the &%prvscheck%& expansion item,
12322 which is described in sections &<<SECTexpansionitems>>& and
12323 &<<SECTverifyPRVS>>&.
12324
12325 .vitem &$qualify_domain$&
12326 .vindex "&$qualify_domain$&"
12327 The value set for the &%qualify_domain%& option in the configuration file.
12328
12329 .vitem &$qualify_recipient$&
12330 .vindex "&$qualify_recipient$&"
12331 The value set for the &%qualify_recipient%& option in the configuration file,
12332 or if not set, the value of &$qualify_domain$&.
12333
12334 .vitem &$queue_name$&
12335 .vindex &$queue_name$&
12336 .cindex "named queues"
12337 .cindex queues named
12338 The name of the spool queue in use; empty for the default queue.
12339
12340 .vitem &$rcpt_count$&
12341 .vindex "&$rcpt_count$&"
12342 When a message is being received by SMTP, this variable contains the number of
12343 RCPT commands received for the current message. If this variable is used in a
12344 RCPT ACL, its value includes the current command.
12345
12346 .vitem &$rcpt_defer_count$&
12347 .vindex "&$rcpt_defer_count$&"
12348 .cindex "4&'xx'& responses" "count of"
12349 When a message is being received by SMTP, this variable contains the number of
12350 RCPT commands in the current message that have previously been rejected with a
12351 temporary (4&'xx'&) response.
12352
12353 .vitem &$rcpt_fail_count$&
12354 .vindex "&$rcpt_fail_count$&"
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 permanent (5&'xx'&) response.
12358
12359 .vitem &$received_count$&
12360 .vindex "&$received_count$&"
12361 This variable contains the number of &'Received:'& header lines in the message,
12362 including the one added by Exim (so its value is always greater than zero). It
12363 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12364 delivering.
12365
12366 .vitem &$received_for$&
12367 .vindex "&$received_for$&"
12368 If there is only a single recipient address in an incoming message, this
12369 variable contains that address when the &'Received:'& header line is being
12370 built. The value is copied after recipient rewriting has happened, but before
12371 the &[local_scan()]& function is run.
12372
12373 .vitem &$received_ip_address$&
12374 .vindex "&$received_ip_address$&"
12375 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12376 variable is set to the address of the local IP interface, and &$received_port$&
12377 is set to the local port number. (The remote IP address and port are in
12378 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12379 the port value is -1 unless it has been set using the &%-oMi%& command line
12380 option.
12381
12382 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12383 could be used, for example, to make the file name for a TLS certificate depend
12384 on which interface and/or port is being used for the incoming connection. The
12385 values of &$received_ip_address$& and &$received_port$& are saved with any
12386 messages that are received, thus making these variables available at delivery
12387 time.
12388 For outbound connections see &$sending_ip_address$&.
12389
12390 .vitem &$received_port$&
12391 .vindex "&$received_port$&"
12392 See &$received_ip_address$&.
12393
12394 .vitem &$received_protocol$&
12395 .vindex "&$received_protocol$&"
12396 When a message is being processed, this variable contains the name of the
12397 protocol by which it was received. Most of the names used by Exim are defined
12398 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12399 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12400 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12401 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12402 connection and the client was successfully authenticated.
12403
12404 Exim uses the protocol name &"smtps"& for the case when encryption is
12405 automatically set up on connection without the use of STARTTLS (see
12406 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12407 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12408 where the client initially uses EHLO, sets up an encrypted connection using
12409 STARTTLS, and then uses HELO afterwards.
12410
12411 The &%-oMr%& option provides a way of specifying a custom protocol name for
12412 messages that are injected locally by trusted callers. This is commonly used to
12413 identify messages that are being re-injected after some kind of scanning.
12414
12415 .vitem &$received_time$&
12416 .vindex "&$received_time$&"
12417 This variable contains the date and time when the current message was received,
12418 as a number of seconds since the start of the Unix epoch.
12419
12420 .vitem &$recipient_data$&
12421 .vindex "&$recipient_data$&"
12422 This variable is set after an indexing lookup success in an ACL &%recipients%&
12423 condition. It contains the data from the lookup, and the value remains set
12424 until the next &%recipients%& test. Thus, you can do things like this:
12425 .display
12426 &`require recipients  = cdb*@;/some/file`&
12427 &`deny    `&&'some further test involving'& &`$recipient_data`&
12428 .endd
12429 &*Warning*&: This variable is set only when a lookup is used as an indexing
12430 method in the address list, using the semicolon syntax as in the example above.
12431 The variable is not set for a lookup that is used as part of the string
12432 expansion that all such lists undergo before being interpreted.
12433
12434 .vitem &$recipient_verify_failure$&
12435 .vindex "&$recipient_verify_failure$&"
12436 In an ACL, when a recipient verification fails, this variable contains
12437 information about the failure. It is set to one of the following words:
12438
12439 .ilist
12440 &"qualify"&: The address was unqualified (no domain), and the message
12441 was neither local nor came from an exempted host.
12442
12443 .next
12444 &"route"&: Routing failed.
12445
12446 .next
12447 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12448 or before the MAIL command (that is, on initial connection, HELO, or
12449 MAIL).
12450
12451 .next
12452 &"recipient"&: The RCPT command in a callout was rejected.
12453 .next
12454
12455 &"postmaster"&: The postmaster check in a callout was rejected.
12456 .endlist
12457
12458 The main use of this variable is expected to be to distinguish between
12459 rejections of MAIL and rejections of RCPT.
12460
12461 .vitem &$recipients$&
12462 .vindex "&$recipients$&"
12463 This variable contains a list of envelope recipients for a message. A comma and
12464 a space separate the addresses in the replacement text. However, the variable
12465 is not generally available, to prevent exposure of Bcc recipients in
12466 unprivileged users' filter files. You can use &$recipients$& only in these
12467 cases:
12468
12469 .olist
12470 In a system filter file.
12471 .next
12472 In the ACLs associated with the DATA command and with non-SMTP messages, that
12473 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12474 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12475 &%acl_not_smtp_mime%&.
12476 .next
12477 From within a &[local_scan()]& function.
12478 .endlist
12479
12480
12481 .vitem &$recipients_count$&
12482 .vindex "&$recipients_count$&"
12483 When a message is being processed, this variable contains the number of
12484 envelope recipients that came with the message. Duplicates are not excluded
12485 from the count. While a message is being received over SMTP, the number
12486 increases for each accepted recipient. It can be referenced in an ACL.
12487
12488
12489 .vitem &$regex_match_string$&
12490 .vindex "&$regex_match_string$&"
12491 This variable is set to contain the matching regular expression after a
12492 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12493
12494 .vitem "&$regex1$&, &$regex2$&, etc"
12495 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12496 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12497 these variables contain the
12498 captured substrings identified by the regular expression.
12499
12500
12501 .vitem &$reply_address$&
12502 .vindex "&$reply_address$&"
12503 When a message is being processed, this variable contains the contents of the
12504 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12505 contents of the &'From:'& header line. Apart from the removal of leading
12506 white space, the value is not processed in any way. In particular, no RFC 2047
12507 decoding or character code translation takes place.
12508
12509 .vitem &$return_path$&
12510 .vindex "&$return_path$&"
12511 When a message is being delivered, this variable contains the return path &--
12512 the sender field that will be sent as part of the envelope. It is not enclosed
12513 in <> characters. At the start of routing an address, &$return_path$& has the
12514 same value as &$sender_address$&, but if, for example, an incoming message to a
12515 mailing list has been expanded by a router which specifies a different address
12516 for bounce messages, &$return_path$& subsequently contains the new bounce
12517 address, whereas &$sender_address$& always contains the original sender address
12518 that was received with the message. In other words, &$sender_address$& contains
12519 the incoming envelope sender, and &$return_path$& contains the outgoing
12520 envelope sender.
12521
12522 .vitem &$return_size_limit$&
12523 .vindex "&$return_size_limit$&"
12524 This is an obsolete name for &$bounce_return_size_limit$&.
12525
12526 .vitem &$router_name$&
12527 .cindex "router" "name"
12528 .cindex "name" "of router"
12529 .vindex "&$router_name$&"
12530 During the running of a router this variable contains its name.
12531
12532 .vitem &$runrc$&
12533 .cindex "return code" "from &%run%& expansion"
12534 .vindex "&$runrc$&"
12535 This variable contains the return code from a command that is run by the
12536 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12537 assume the order in which option values are expanded, except for those
12538 preconditions whose order of testing is documented. Therefore, you cannot
12539 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12540 another.
12541
12542 .vitem &$self_hostname$&
12543 .oindex "&%self%&" "value of host name"
12544 .vindex "&$self_hostname$&"
12545 When an address is routed to a supposedly remote host that turns out to be the
12546 local host, what happens is controlled by the &%self%& generic router option.
12547 One of its values causes the address to be passed to another router. When this
12548 happens, &$self_hostname$& is set to the name of the local host that the
12549 original router encountered. In other circumstances its contents are null.
12550
12551 .vitem &$sender_address$&
12552 .vindex "&$sender_address$&"
12553 When a message is being processed, this variable contains the sender's address
12554 that was received in the message's envelope. The case of letters in the address
12555 is retained, in both the local part and the domain. For bounce messages, the
12556 value of this variable is the empty string. See also &$return_path$&.
12557
12558 .vitem &$sender_address_data$&
12559 .vindex "&$address_data$&"
12560 .vindex "&$sender_address_data$&"
12561 If &$address_data$& is set when the routers are called from an ACL to verify a
12562 sender address, the final value is preserved in &$sender_address_data$&, to
12563 distinguish it from data from a recipient address. The value does not persist
12564 after the end of the current ACL statement. If you want to preserve it for
12565 longer, you can save it in an ACL variable.
12566
12567 .vitem &$sender_address_domain$&
12568 .vindex "&$sender_address_domain$&"
12569 The domain portion of &$sender_address$&.
12570
12571 .vitem &$sender_address_local_part$&
12572 .vindex "&$sender_address_local_part$&"
12573 The local part portion of &$sender_address$&.
12574
12575 .vitem &$sender_data$&
12576 .vindex "&$sender_data$&"
12577 This variable is set after a lookup success in an ACL &%senders%& condition or
12578 in a router &%senders%& option. It contains the data from the lookup, and the
12579 value remains set until the next &%senders%& test. Thus, you can do things like
12580 this:
12581 .display
12582 &`require senders      = cdb*@;/some/file`&
12583 &`deny    `&&'some further test involving'& &`$sender_data`&
12584 .endd
12585 &*Warning*&: This variable is set only when a lookup is used as an indexing
12586 method in the address list, using the semicolon syntax as in the example above.
12587 The variable is not set for a lookup that is used as part of the string
12588 expansion that all such lists undergo before being interpreted.
12589
12590 .vitem &$sender_fullhost$&
12591 .vindex "&$sender_fullhost$&"
12592 When a message is received from a remote host, this variable contains the host
12593 name and IP address in a single string. It ends with the IP address in square
12594 brackets, followed by a colon and a port number if the logging of ports is
12595 enabled. The format of the rest of the string depends on whether the host
12596 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12597 looking up its IP address. (Looking up the IP address can be forced by the
12598 &%host_lookup%& option, independent of verification.) A plain host name at the
12599 start of the string is a verified host name; if this is not present,
12600 verification either failed or was not requested. A host name in parentheses is
12601 the argument of a HELO or EHLO command. This is omitted if it is identical to
12602 the verified host name or to the host's IP address in square brackets.
12603
12604 .vitem &$sender_helo_dnssec$&
12605 .vindex "&$sender_helo_dnssec$&"
12606 This boolean variable is true if a successful HELO verification was
12607 .cindex "DNS" "DNSSEC"
12608 done using DNS information the resolver library stated was authenticated data.
12609
12610 .vitem &$sender_helo_name$&
12611 .vindex "&$sender_helo_name$&"
12612 When a message is received from a remote host that has issued a HELO or EHLO
12613 command, the argument of that command is placed in this variable. It is also
12614 set if HELO or EHLO is used when a message is received using SMTP locally via
12615 the &%-bs%& or &%-bS%& options.
12616
12617 .vitem &$sender_host_address$&
12618 .vindex "&$sender_host_address$&"
12619 When a message is received from a remote host using SMTP,
12620 this variable contains that
12621 host's IP address. For locally non-SMTP submitted messages, it is empty.
12622
12623 .vitem &$sender_host_authenticated$&
12624 .vindex "&$sender_host_authenticated$&"
12625 This variable contains the name (not the public name) of the authenticator
12626 driver that successfully authenticated the client from which the message was
12627 received. It is empty if there was no successful authentication. See also
12628 &$authenticated_id$&.
12629
12630 .vitem &$sender_host_dnssec$&
12631 .vindex "&$sender_host_dnssec$&"
12632 If an attempt to populate &$sender_host_name$& has been made
12633 (by reference, &%hosts_lookup%& or
12634 otherwise) then this boolean will have been set true if, and only if, the
12635 resolver library states that both
12636 the reverse and forward DNS were authenticated data.  At all
12637 other times, this variable is false.
12638
12639 .cindex "DNS" "DNSSEC"
12640 It is likely that you will need to coerce DNSSEC support on in the resolver
12641 library, by setting:
12642 .code
12643 dns_dnssec_ok = 1
12644 .endd
12645
12646 Exim does not perform DNSSEC validation itself, instead leaving that to a
12647 validating resolver (e.g. unbound, or bind with suitable configuration).
12648
12649 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12650 mechanism in the list, then this variable will be false.
12651
12652 This requires that your system resolver library support EDNS0 (and that
12653 DNSSEC flags exist in the system headers).  If the resolver silently drops
12654 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
12655 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
12656
12657
12658 .vitem &$sender_host_name$&
12659 .vindex "&$sender_host_name$&"
12660 When a message is received from a remote host, this variable contains the
12661 host's name as obtained by looking up its IP address. For messages received by
12662 other means, this variable is empty.
12663
12664 .vindex "&$host_lookup_failed$&"
12665 If the host name has not previously been looked up, a reference to
12666 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12667 A looked up name is accepted only if it leads back to the original IP address
12668 via a forward lookup. If either the reverse or the forward lookup fails to find
12669 any data, or if the forward lookup does not yield the original IP address,
12670 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12671
12672 .vindex "&$host_lookup_deferred$&"
12673 However, if either of the lookups cannot be completed (for example, there is a
12674 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12675 &$host_lookup_failed$& remains set to &"0"&.
12676
12677 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12678 host name again if there is a subsequent reference to &$sender_host_name$&
12679 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12680 is set to &"1"&.
12681
12682 Exim does not automatically look up every calling host's name. If you want
12683 maximum efficiency, you should arrange your configuration so that it avoids
12684 these lookups altogether. The lookup happens only if one or more of the
12685 following are true:
12686
12687 .ilist
12688 A string containing &$sender_host_name$& is expanded.
12689 .next
12690 The calling host matches the list in &%host_lookup%&. In the default
12691 configuration, this option is set to *, so it must be changed if lookups are
12692 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12693 .next
12694 Exim needs the host name in order to test an item in a host list. The items
12695 that require this are described in sections &<<SECThoslispatnam>>& and
12696 &<<SECThoslispatnamsk>>&.
12697 .next
12698 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12699 In this case, the host name is required to compare with the name quoted in any
12700 EHLO or HELO commands that the client issues.
12701 .next
12702 The remote host issues a EHLO or HELO command that quotes one of the
12703 domains in &%helo_lookup_domains%&. The default value of this option is
12704 . ==== As this is a nested list, any displays it contains must be indented
12705 . ==== as otherwise they are too far to the left.
12706 .code
12707   helo_lookup_domains = @ : @[]
12708 .endd
12709 which causes a lookup if a remote host (incorrectly) gives the server's name or
12710 IP address in an EHLO or HELO command.
12711 .endlist
12712
12713
12714 .vitem &$sender_host_port$&
12715 .vindex "&$sender_host_port$&"
12716 When a message is received from a remote host, this variable contains the port
12717 number that was used on the remote host.
12718
12719 .vitem &$sender_ident$&
12720 .vindex "&$sender_ident$&"
12721 When a message is received from a remote host, this variable contains the
12722 identification received in response to an RFC 1413 request. When a message has
12723 been received locally, this variable contains the login name of the user that
12724 called Exim.
12725
12726 .vitem &$sender_rate_$&&'xxx'&
12727 A number of variables whose names begin &$sender_rate_$& are set as part of the
12728 &%ratelimit%& ACL condition. Details are given in section
12729 &<<SECTratelimiting>>&.
12730
12731 .vitem &$sender_rcvhost$&
12732 .cindex "DNS" "reverse lookup"
12733 .cindex "reverse DNS lookup"
12734 .vindex "&$sender_rcvhost$&"
12735 This is provided specifically for use in &'Received:'& headers. It starts with
12736 either the verified host name (as obtained from a reverse DNS lookup) or, if
12737 there is no verified host name, the IP address in square brackets. After that
12738 there may be text in parentheses. When the first item is a verified host name,
12739 the first thing in the parentheses is the IP address in square brackets,
12740 followed by a colon and a port number if port logging is enabled. When the
12741 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12742 the parentheses.
12743
12744 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12745 was used and its argument was not identical to the real host name or IP
12746 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12747 all three items are present in the parentheses, a newline and tab are inserted
12748 into the string, to improve the formatting of the &'Received:'& header.
12749
12750 .vitem &$sender_verify_failure$&
12751 .vindex "&$sender_verify_failure$&"
12752 In an ACL, when a sender verification fails, this variable contains information
12753 about the failure. The details are the same as for
12754 &$recipient_verify_failure$&.
12755
12756 .vitem &$sending_ip_address$&
12757 .vindex "&$sending_ip_address$&"
12758 This variable is set whenever an outgoing SMTP connection to another host has
12759 been set up. It contains the IP address of the local interface that is being
12760 used. This is useful if a host that has more than one IP address wants to take
12761 on different personalities depending on which one is being used. For incoming
12762 connections, see &$received_ip_address$&.
12763
12764 .vitem &$sending_port$&
12765 .vindex "&$sending_port$&"
12766 This variable is set whenever an outgoing SMTP connection to another host has
12767 been set up. It contains the local port that is being used. For incoming
12768 connections, see &$received_port$&.
12769
12770 .vitem &$smtp_active_hostname$&
12771 .vindex "&$smtp_active_hostname$&"
12772 During an incoming SMTP session, this variable contains the value of the active
12773 host name, as specified by the &%smtp_active_hostname%& option. The value of
12774 &$smtp_active_hostname$& is saved with any message that is received, so its
12775 value can be consulted during routing and delivery.
12776
12777 .vitem &$smtp_command$&
12778 .vindex "&$smtp_command$&"
12779 During the processing of an incoming SMTP command, this variable contains the
12780 entire command. This makes it possible to distinguish between HELO and EHLO in
12781 the HELO ACL, and also to distinguish between commands such as these:
12782 .code
12783 MAIL FROM:<>
12784 MAIL FROM: <>
12785 .endd
12786 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12787 command, the address in &$smtp_command$& is the original address before any
12788 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12789 the address after SMTP-time rewriting.
12790
12791 .vitem &$smtp_command_argument$&
12792 .cindex "SMTP" "command, argument for"
12793 .vindex "&$smtp_command_argument$&"
12794 While an ACL is running to check an SMTP command, this variable contains the
12795 argument, that is, the text that follows the command name, with leading white
12796 space removed. Following the introduction of &$smtp_command$&, this variable is
12797 somewhat redundant, but is retained for backwards compatibility.
12798
12799 .new
12800 .vitem &$smtp_command_history$&
12801 .cindex SMTP "command history"
12802 .vindex "&$smtp_command_history$&"
12803 A comma-separated list (with no whitespace) of the most-recent SMTP commands
12804 received, in time-order left to right.  Only a limited number of commands
12805 are remembered.
12806 .wen
12807
12808 .vitem &$smtp_count_at_connection_start$&
12809 .vindex "&$smtp_count_at_connection_start$&"
12810 This variable is set greater than zero only in processes spawned by the Exim
12811 daemon for handling incoming SMTP connections. The name is deliberately long,
12812 in order to emphasize what the contents are. When the daemon accepts a new
12813 connection, it increments this variable. A copy of the variable is passed to
12814 the child process that handles the connection, but its value is fixed, and
12815 never changes. It is only an approximation of how many incoming connections
12816 there actually are, because many other connections may come and go while a
12817 single connection is being processed. When a child process terminates, the
12818 daemon decrements its copy of the variable.
12819
12820 .vitem "&$sn0$& &-- &$sn9$&"
12821 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12822 that were current at the end of the system filter file. This allows a system
12823 filter file to set values that can be tested in users' filter files. For
12824 example, a system filter could set a value indicating how likely it is that a
12825 message is junk mail.
12826
12827 .vitem &$spam_$&&'xxx'&
12828 A number of variables whose names start with &$spam$& are available when Exim
12829 is compiled with the content-scanning extension. For details, see section
12830 &<<SECTscanspamass>>&.
12831
12832
12833 .vitem &$spool_directory$&
12834 .vindex "&$spool_directory$&"
12835 The name of Exim's spool directory.
12836
12837 .vitem &$spool_inodes$&
12838 .vindex "&$spool_inodes$&"
12839 The number of free inodes in the disk partition where Exim's spool files are
12840 being written. The value is recalculated whenever the variable is referenced.
12841 If the relevant file system does not have the concept of inodes, the value of
12842 is -1. See also the &%check_spool_inodes%& option.
12843
12844 .vitem &$spool_space$&
12845 .vindex "&$spool_space$&"
12846 The amount of free space (as a number of kilobytes) in the disk partition where
12847 Exim's spool files are being written. The value is recalculated whenever the
12848 variable is referenced. If the operating system does not have the ability to
12849 find the amount of free space (only true for experimental systems), the space
12850 value is -1. For example, to check in an ACL that there is at least 50
12851 megabytes free on the spool, you could write:
12852 .code
12853 condition = ${if > {$spool_space}{50000}}
12854 .endd
12855 See also the &%check_spool_space%& option.
12856
12857
12858 .vitem &$thisaddress$&
12859 .vindex "&$thisaddress$&"
12860 This variable is set only during the processing of the &%foranyaddress%&
12861 command in a filter file. Its use is explained in the description of that
12862 command, which can be found in the separate document entitled &'Exim's
12863 interfaces to mail filtering'&.
12864
12865 .vitem &$tls_in_bits$&
12866 .vindex "&$tls_in_bits$&"
12867 Contains an approximation of the TLS cipher's bit-strength
12868 on the inbound connection; the meaning of
12869 this depends upon the TLS implementation used.
12870 If TLS has not been negotiated, the value will be 0.
12871 The value of this is automatically fed into the Cyrus SASL authenticator
12872 when acting as a server, to specify the "external SSF" (a SASL term).
12873
12874 The deprecated &$tls_bits$& variable refers to the inbound side
12875 except when used in the context of an outbound SMTP delivery, when it refers to
12876 the outbound.
12877
12878 .vitem &$tls_out_bits$&
12879 .vindex "&$tls_out_bits$&"
12880 Contains an approximation of the TLS cipher's bit-strength
12881 on an outbound SMTP connection; the meaning of
12882 this depends upon the TLS implementation used.
12883 If TLS has not been negotiated, the value will be 0.
12884
12885 .vitem &$tls_in_ourcert$&
12886 .vindex "&$tls_in_ourcert$&"
12887 .cindex certificate variables
12888 This variable refers to the certificate presented to the peer of an
12889 inbound connection when the message was received.
12890 It is only useful as the argument of a
12891 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12892 or a &%def%& condition.
12893
12894 .vitem &$tls_in_peercert$&
12895 .vindex "&$tls_in_peercert$&"
12896 This variable refers to the certificate presented by the peer of an
12897 inbound connection when the message was received.
12898 It is only useful as the argument of a
12899 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12900 or a &%def%& condition.
12901 If certificate verification fails it may refer to a failing chain element
12902 which is not the leaf.
12903
12904 .vitem &$tls_out_ourcert$&
12905 .vindex "&$tls_out_ourcert$&"
12906 This variable refers to the certificate presented to the peer of an
12907 outbound connection.  It is only useful as the argument of a
12908 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12909 or a &%def%& condition.
12910
12911 .vitem &$tls_out_peercert$&
12912 .vindex "&$tls_out_peercert$&"
12913 This variable refers to the certificate presented by 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 If certificate verification fails it may refer to a failing chain element
12918 which is not the leaf.
12919
12920 .vitem &$tls_in_certificate_verified$&
12921 .vindex "&$tls_in_certificate_verified$&"
12922 This variable is set to &"1"& if a TLS certificate was verified when the
12923 message was received, and &"0"& otherwise.
12924
12925 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12926 except when used in the context of an outbound SMTP delivery, when it refers to
12927 the outbound.
12928
12929 .vitem &$tls_out_certificate_verified$&
12930 .vindex "&$tls_out_certificate_verified$&"
12931 This variable is set to &"1"& if a TLS certificate was verified when an
12932 outbound SMTP connection was made,
12933 and &"0"& otherwise.
12934
12935 .vitem &$tls_in_cipher$&
12936 .vindex "&$tls_in_cipher$&"
12937 .vindex "&$tls_cipher$&"
12938 When a message is received from a remote host over an encrypted SMTP
12939 connection, this variable is set to the cipher suite that was negotiated, for
12940 example DES-CBC3-SHA. In other circumstances, in particular, for message
12941 received over unencrypted connections, the variable is empty. Testing
12942 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
12943 non-encrypted connections during ACL processing.
12944
12945 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12946 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12947 becomes the same as &$tls_out_cipher$&.
12948
12949 .vitem &$tls_out_cipher$&
12950 .vindex "&$tls_out_cipher$&"
12951 This variable is
12952 cleared before any outgoing SMTP connection is made,
12953 and then set to the outgoing cipher suite if one is negotiated. See chapter
12954 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12955 details of the &(smtp)& transport.
12956
12957 .vitem &$tls_in_ocsp$&
12958 .vindex "&$tls_in_ocsp$&"
12959 When a message is received from a remote client connection
12960 the result of any OCSP request from the client is encoded in this variable:
12961 .code
12962 0 OCSP proof was not requested (default value)
12963 1 No response to request
12964 2 Response not verified
12965 3 Verification failed
12966 4 Verification succeeded
12967 .endd
12968
12969 .vitem &$tls_out_ocsp$&
12970 .vindex "&$tls_out_ocsp$&"
12971 When a message is sent to a remote host connection
12972 the result of any OCSP request made is encoded in this variable.
12973 See &$tls_in_ocsp$& for values.
12974
12975 .vitem &$tls_in_peerdn$&
12976 .vindex "&$tls_in_peerdn$&"
12977 .vindex "&$tls_peerdn$&"
12978 .cindex certificate "extracting fields"
12979 When a message is received from a remote host over an encrypted SMTP
12980 connection, and Exim is configured to request a certificate from the client,
12981 the value of the Distinguished Name of the certificate is made available in the
12982 &$tls_in_peerdn$& during subsequent processing.
12983 If certificate verification fails it may refer to a failing chain element
12984 which is not the leaf.
12985
12986 The deprecated &$tls_peerdn$& variable refers to the inbound side
12987 except when used in the context of an outbound SMTP delivery, when it refers to
12988 the outbound.
12989
12990 .vitem &$tls_out_peerdn$&
12991 .vindex "&$tls_out_peerdn$&"
12992 When a message is being delivered to a remote host over an encrypted SMTP
12993 connection, and Exim is configured to request a certificate from the server,
12994 the value of the Distinguished Name of the certificate is made available in the
12995 &$tls_out_peerdn$& during subsequent processing.
12996 If certificate verification fails it may refer to a failing chain element
12997 which is not the leaf.
12998
12999 .vitem &$tls_in_sni$&
13000 .vindex "&$tls_in_sni$&"
13001 .vindex "&$tls_sni$&"
13002 .cindex "TLS" "Server Name Indication"
13003 When a TLS session is being established, if the client sends the Server
13004 Name Indication extension, the value will be placed in this variable.
13005 If the variable appears in &%tls_certificate%& then this option and
13006 some others, described in &<<SECTtlssni>>&,
13007 will be re-expanded early in the TLS session, to permit
13008 a different certificate to be presented (and optionally a different key to be
13009 used) to the client, based upon the value of the SNI extension.
13010
13011 The deprecated &$tls_sni$& variable refers to the inbound side
13012 except when used in the context of an outbound SMTP delivery, when it refers to
13013 the outbound.
13014
13015 .vitem &$tls_out_sni$&
13016 .vindex "&$tls_out_sni$&"
13017 .cindex "TLS" "Server Name Indication"
13018 During outbound
13019 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13020 the transport.
13021
13022 .vitem &$tod_bsdinbox$&
13023 .vindex "&$tod_bsdinbox$&"
13024 The time of day and the date, in the format required for BSD-style mailbox
13025 files, for example: Thu Oct 17 17:14:09 1995.
13026
13027 .vitem &$tod_epoch$&
13028 .vindex "&$tod_epoch$&"
13029 The time and date as a number of seconds since the start of the Unix epoch.
13030
13031 .vitem &$tod_epoch_l$&
13032 .vindex "&$tod_epoch_l$&"
13033 The time and date as a number of microseconds since the start of the Unix epoch.
13034
13035 .vitem &$tod_full$&
13036 .vindex "&$tod_full$&"
13037 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13038 +0100. The timezone is always given as a numerical offset from UTC, with
13039 positive values used for timezones that are ahead (east) of UTC, and negative
13040 values for those that are behind (west).
13041
13042 .vitem &$tod_log$&
13043 .vindex "&$tod_log$&"
13044 The time and date in the format used for writing Exim's log files, for example:
13045 1995-10-12 15:32:29, but without a timezone.
13046
13047 .vitem &$tod_logfile$&
13048 .vindex "&$tod_logfile$&"
13049 This variable contains the date in the format yyyymmdd. This is the format that
13050 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13051 flag.
13052
13053 .vitem &$tod_zone$&
13054 .vindex "&$tod_zone$&"
13055 This variable contains the numerical value of the local timezone, for example:
13056 -0500.
13057
13058 .vitem &$tod_zulu$&
13059 .vindex "&$tod_zulu$&"
13060 This variable contains the UTC date and time in &"Zulu"& format, as specified
13061 by ISO 8601, for example: 20030221154023Z.
13062
13063 .vitem &$transport_name$&
13064 .cindex "transport" "name"
13065 .cindex "name" "of transport"
13066 .vindex "&$transport_name$&"
13067 During the running of a transport, this variable contains its name.
13068
13069 .vitem &$value$&
13070 .vindex "&$value$&"
13071 This variable contains the result of an expansion lookup, extraction operation,
13072 or external command, as described above. It is also used during a
13073 &*reduce*& expansion.
13074
13075 .vitem &$verify_mode$&
13076 .vindex "&$verify_mode$&"
13077 While a router or transport is being run in verify mode or for cutthrough delivery,
13078 contains "S" for sender-verification or "R" for recipient-verification.
13079 Otherwise, empty.
13080
13081 .vitem &$version_number$&
13082 .vindex "&$version_number$&"
13083 The version number of Exim.
13084
13085 .vitem &$warn_message_delay$&
13086 .vindex "&$warn_message_delay$&"
13087 This variable is set only during the creation of a message warning about a
13088 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13089
13090 .vitem &$warn_message_recipients$&
13091 .vindex "&$warn_message_recipients$&"
13092 This variable is set only during the creation of a message warning about a
13093 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13094 .endlist
13095 .ecindex IIDstrexp
13096
13097
13098
13099 . ////////////////////////////////////////////////////////////////////////////
13100 . ////////////////////////////////////////////////////////////////////////////
13101
13102 .chapter "Embedded Perl" "CHAPperl"
13103 .scindex IIDperl "Perl" "calling from Exim"
13104 Exim can be built to include an embedded Perl interpreter. When this is done,
13105 Perl subroutines can be called as part of the string expansion process. To make
13106 use of the Perl support, you need version 5.004 or later of Perl installed on
13107 your system. To include the embedded interpreter in the Exim binary, include
13108 the line
13109 .code
13110 EXIM_PERL = perl.o
13111 .endd
13112 in your &_Local/Makefile_& and then build Exim in the normal way.
13113
13114
13115 .section "Setting up so Perl can be used" "SECID85"
13116 .oindex "&%perl_startup%&"
13117 Access to Perl subroutines is via a global configuration option called
13118 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13119 no &%perl_startup%& option in the Exim configuration file then no Perl
13120 interpreter is started and there is almost no overhead for Exim (since none of
13121 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13122 option then the associated value is taken to be Perl code which is executed in
13123 a newly created Perl interpreter.
13124
13125 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13126 need backslashes before any characters to escape special meanings. The option
13127 should usually be something like
13128 .code
13129 perl_startup = do '/etc/exim.pl'
13130 .endd
13131 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13132 use from Exim. Exim can be configured either to start up a Perl interpreter as
13133 soon as it is entered, or to wait until the first time it is needed. Starting
13134 the interpreter at the beginning ensures that it is done while Exim still has
13135 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13136 fact used in a particular run. Also, note that this does not mean that Exim is
13137 necessarily running as root when Perl is called at a later time. By default,
13138 the interpreter is started only when it is needed, but this can be changed in
13139 two ways:
13140
13141 .ilist
13142 .oindex "&%perl_at_start%&"
13143 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13144 a startup when Exim is entered.
13145 .next
13146 The command line option &%-ps%& also requests a startup when Exim is entered,
13147 overriding the setting of &%perl_at_start%&.
13148 .endlist
13149
13150 There is also a command line option &%-pd%& (for delay) which suppresses the
13151 initial startup, even if &%perl_at_start%& is set.
13152
13153 .ilist
13154 .oindex "&%perl_taintmode%&"
13155 .cindex "Perl" "taintmode"
13156 To provide more security executing Perl code via the embedded Perl
13157 interpreter, the &%perl_taintmode%& option can be set. This enables the
13158 taint mode of the Perl interpreter. You are encouraged to set this
13159 option to a true value. To avoid breaking existing installations, it
13160 defaults to false.
13161
13162
13163 .section "Calling Perl subroutines" "SECID86"
13164 When the configuration file includes a &%perl_startup%& option you can make use
13165 of the string expansion item to call the Perl subroutines that are defined
13166 by the &%perl_startup%& code. The operator is used in any of the following
13167 forms:
13168 .code
13169 ${perl{foo}}
13170 ${perl{foo}{argument}}
13171 ${perl{foo}{argument1}{argument2} ... }
13172 .endd
13173 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13174 arguments may be passed. Passing more than this results in an expansion failure
13175 with an error message of the form
13176 .code
13177 Too many arguments passed to Perl subroutine "foo" (max is 8)
13178 .endd
13179 The return value of the Perl subroutine is evaluated in a scalar context before
13180 it is passed back to Exim to be inserted into the expanded string. If the
13181 return value is &'undef'&, the expansion is forced to fail in the same way as
13182 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13183 by obeying Perl's &%die%& function, the expansion fails with the error message
13184 that was passed to &%die%&.
13185
13186
13187 .section "Calling Exim functions from Perl" "SECID87"
13188 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13189 is available to call back into Exim's string expansion function. For example,
13190 the Perl code
13191 .code
13192 my $lp = Exim::expand_string('$local_part');
13193 .endd
13194 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13195 Note those are single quotes and not double quotes to protect against
13196 &$local_part$& being interpolated as a Perl variable.
13197
13198 If the string expansion is forced to fail by a &"fail"& item, the result of
13199 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13200 expansion string, the Perl call from the original expansion string fails with
13201 an appropriate error message, in the same way as if &%die%& were used.
13202
13203 .cindex "debugging" "from embedded Perl"
13204 .cindex "log" "writing from embedded Perl"
13205 Two other Exim functions are available for use from within Perl code.
13206 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13207 debugging is enabled. If you want a newline at the end, you must supply it.
13208 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13209 timestamp. In this case, you should not supply a terminating newline.
13210
13211
13212 .section "Use of standard output and error by Perl" "SECID88"
13213 .cindex "Perl" "standard output and error"
13214 You should not write to the standard error or output streams from within your
13215 Perl code, as it is not defined how these are set up. In versions of Exim
13216 before 4.50, it is possible for the standard output or error to refer to the
13217 SMTP connection during message reception via the daemon. Writing to this stream
13218 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13219 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13220 avoided, but the output is lost.
13221
13222 .cindex "Perl" "use of &%warn%&"
13223 The Perl &%warn%& statement writes to the standard error stream by default.
13224 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13225 you have no control. When Exim starts up the Perl interpreter, it arranges for
13226 output from the &%warn%& statement to be written to the Exim main log. You can
13227 change this by including appropriate Perl magic somewhere in your Perl code.
13228 For example, to discard &%warn%& output completely, you need this:
13229 .code
13230 $SIG{__WARN__} = sub { };
13231 .endd
13232 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13233 example, the code for the subroutine is empty, so it does nothing, but you can
13234 include any Perl code that you like. The text of the &%warn%& message is passed
13235 as the first subroutine argument.
13236 .ecindex IIDperl
13237
13238
13239 . ////////////////////////////////////////////////////////////////////////////
13240 . ////////////////////////////////////////////////////////////////////////////
13241
13242 .chapter "Starting the daemon and the use of network interfaces" &&&
13243          "CHAPinterfaces" &&&
13244          "Starting the daemon"
13245 .cindex "daemon" "starting"
13246 .cindex "interface" "listening"
13247 .cindex "network interface"
13248 .cindex "interface" "network"
13249 .cindex "IP address" "for listening"
13250 .cindex "daemon" "listening IP addresses"
13251 .cindex "TCP/IP" "setting listening interfaces"
13252 .cindex "TCP/IP" "setting listening ports"
13253 A host that is connected to a TCP/IP network may have one or more physical
13254 hardware network interfaces. Each of these interfaces may be configured as one
13255 or more &"logical"& interfaces, which are the entities that a program actually
13256 works with. Each of these logical interfaces is associated with an IP address.
13257 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13258 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13259 knowledge about the host's interfaces for use in three different circumstances:
13260
13261 .olist
13262 When a listening daemon is started, Exim needs to know which interfaces
13263 and ports to listen on.
13264 .next
13265 When Exim is routing an address, it needs to know which IP addresses
13266 are associated with local interfaces. This is required for the correct
13267 processing of MX lists by removing the local host and others with the
13268 same or higher priority values. Also, Exim needs to detect cases
13269 when an address is routed to an IP address that in fact belongs to the
13270 local host. Unless the &%self%& router option or the &%allow_localhost%&
13271 option of the smtp transport is set (as appropriate), this is treated
13272 as an error situation.
13273 .next
13274 When Exim connects to a remote host, it may need to know which interface to use
13275 for the outgoing connection.
13276 .endlist
13277
13278
13279 Exim's default behaviour is likely to be appropriate in the vast majority
13280 of cases. If your host has only one interface, and you want all its IP
13281 addresses to be treated in the same way, and you are using only the
13282 standard SMTP port, you should not need to take any special action. The
13283 rest of this chapter does not apply to you.
13284
13285 In a more complicated situation you may want to listen only on certain
13286 interfaces, or on different ports, and for this reason there are a number of
13287 options that can be used to influence Exim's behaviour. The rest of this
13288 chapter describes how they operate.
13289
13290 When a message is received over TCP/IP, the interface and port that were
13291 actually used are set in &$received_ip_address$& and &$received_port$&.
13292
13293
13294
13295 .section "Starting a listening daemon" "SECID89"
13296 When a listening daemon is started (by means of the &%-bd%& command line
13297 option), the interfaces and ports on which it listens are controlled by the
13298 following options:
13299
13300 .ilist
13301 &%daemon_smtp_ports%& contains a list of default ports
13302 or service names.
13303 (For backward compatibility, this option can also be specified in the singular.)
13304 .next
13305 &%local_interfaces%& contains list of interface IP addresses on which to
13306 listen. Each item may optionally also specify a port.
13307 .endlist
13308
13309 The default list separator in both cases is a colon, but this can be changed as
13310 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13311 it is usually best to change the separator to avoid having to double all the
13312 colons. For example:
13313 .code
13314 local_interfaces = <; 127.0.0.1 ; \
13315                       192.168.23.65 ; \
13316                       ::1 ; \
13317                       3ffe:ffff:836f::fe86:a061
13318 .endd
13319 There are two different formats for specifying a port along with an IP address
13320 in &%local_interfaces%&:
13321
13322 .olist
13323 The port is added onto the address with a dot separator. For example, to listen
13324 on port 1234 on two different IP addresses:
13325 .code
13326 local_interfaces = <; 192.168.23.65.1234 ; \
13327                       3ffe:ffff:836f::fe86:a061.1234
13328 .endd
13329 .next
13330 The IP address is enclosed in square brackets, and the port is added
13331 with a colon separator, for example:
13332 .code
13333 local_interfaces = <; [192.168.23.65]:1234 ; \
13334                       [3ffe:ffff:836f::fe86:a061]:1234
13335 .endd
13336 .endlist
13337
13338 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13339 default setting contains just one port:
13340 .code
13341 daemon_smtp_ports = smtp
13342 .endd
13343 If more than one port is listed, each interface that does not have its own port
13344 specified listens on all of them. Ports that are listed in
13345 &%daemon_smtp_ports%& can be identified either by name (defined in
13346 &_/etc/services_&) or by number. However, when ports are given with individual
13347 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13348
13349
13350
13351 .section "Special IP listening addresses" "SECID90"
13352 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13353 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13354 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13355 instead of setting up separate listening sockets for each interface. The
13356 default value of &%local_interfaces%& is
13357 .code
13358 local_interfaces = 0.0.0.0
13359 .endd
13360 when Exim is built without IPv6 support; otherwise it is:
13361 .code
13362 local_interfaces = <; ::0 ; 0.0.0.0
13363 .endd
13364 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13365
13366
13367
13368 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13369 The &%-oX%& command line option can be used to override the values of
13370 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13371 instance. Another way of doing this would be to use macros and the &%-D%&
13372 option. However, &%-oX%& can be used by any admin user, whereas modification of
13373 the runtime configuration by &%-D%& is allowed only when the caller is root or
13374 exim.
13375
13376 The value of &%-oX%& is a list of items. The default colon separator can be
13377 changed in the usual way if required. If there are any items that do not
13378 contain dots or colons (that is, are not IP addresses), the value of
13379 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13380 items that do contain dots or colons, the value of &%local_interfaces%& is
13381 replaced by those items. Thus, for example,
13382 .code
13383 -oX 1225
13384 .endd
13385 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13386 whereas
13387 .code
13388 -oX 192.168.34.5.1125
13389 .endd
13390 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13391 (However, since &%local_interfaces%& now contains no items without ports, the
13392 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13393
13394
13395
13396 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13397 .cindex "ssmtp protocol"
13398 .cindex "smtps protocol"
13399 .cindex "SMTP" "ssmtp protocol"
13400 .cindex "SMTP" "smtps protocol"
13401 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13402 before the STARTTLS command was standardized for SMTP. Some legacy clients
13403 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13404 list of port numbers or service names,
13405 connections to those ports must use SSMTP. The most
13406 common use of this option is expected to be
13407 .code
13408 tls_on_connect_ports = 465
13409 .endd
13410 because 465 is the usual port number used by the legacy clients. There is also
13411 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13412 this way when a daemon is started.
13413
13414 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13415 daemon to listen on those ports. You must still specify them in
13416 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13417 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13418 connections via the daemon.)
13419
13420
13421
13422
13423 .section "IPv6 address scopes" "SECID92"
13424 .cindex "IPv6" "address scopes"
13425 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13426 can, in principle, have the same link-local IPv6 address on different
13427 interfaces. Thus, additional information is needed, over and above the IP
13428 address, to distinguish individual interfaces. A convention of using a
13429 percent sign followed by something (often the interface name) has been
13430 adopted in some cases, leading to addresses like this:
13431 .code
13432 fe80::202:b3ff:fe03:45c1%eth0
13433 .endd
13434 To accommodate this usage, a percent sign followed by an arbitrary string is
13435 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13436 to convert a textual IPv6 address for actual use. This function recognizes the
13437 percent convention in operating systems that support it, and it processes the
13438 address appropriately. Unfortunately, some older libraries have problems with
13439 &[getaddrinfo()]&. If
13440 .code
13441 IPV6_USE_INET_PTON=yes
13442 .endd
13443 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13444 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13445 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13446 function.) Of course, this means that the additional functionality of
13447 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13448
13449 .section "Disabling IPv6" "SECID93"
13450 .cindex "IPv6" "disabling"
13451 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13452 run on a host whose kernel does not support IPv6. The binary will fall back to
13453 using IPv4, but it may waste resources looking up AAAA records, and trying to
13454 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13455 .oindex "&%disable_ipv6%&"
13456 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13457 activities take place. AAAA records are never looked up, and any IPv6 addresses
13458 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13459 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13460 to handle IPv6 literal addresses.
13461
13462 On the other hand, when IPv6 is in use, there may be times when you want to
13463 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13464 option to globally suppress the lookup of AAAA records for specified domains,
13465 and you can use the &%ignore_target_hosts%& generic router option to ignore
13466 IPv6 addresses in an individual router.
13467
13468
13469
13470 .section "Examples of starting a listening daemon" "SECID94"
13471 The default case in an IPv6 environment is
13472 .code
13473 daemon_smtp_ports = smtp
13474 local_interfaces = <; ::0 ; 0.0.0.0
13475 .endd
13476 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13477 Either one or two sockets may be used, depending on the characteristics of
13478 the TCP/IP stack. (This is complicated and messy; for more information,
13479 read the comments in the &_daemon.c_& source file.)
13480
13481 To specify listening on ports 25 and 26 on all interfaces:
13482 .code
13483 daemon_smtp_ports = 25 : 26
13484 .endd
13485 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13486 .code
13487 local_interfaces = <; ::0.25     ; ::0.26 \
13488                       0.0.0.0.25 ; 0.0.0.0.26
13489 .endd
13490 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13491 IPv4 loopback address only:
13492 .code
13493 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13494 .endd
13495 To specify listening on the default port on specific interfaces only:
13496 .code
13497 local_interfaces = 10.0.0.67 : 192.168.34.67
13498 .endd
13499 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13500
13501
13502
13503 .section "Recognizing the local host" "SECTreclocipadd"
13504 The &%local_interfaces%& option is also used when Exim needs to determine
13505 whether or not an IP address refers to the local host. That is, the IP
13506 addresses of all the interfaces on which a daemon is listening are always
13507 treated as local.
13508
13509 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13510 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13511 available interfaces from the operating system, and extracts the relevant
13512 (that is, IPv4 or IPv6) addresses to use for checking.
13513
13514 Some systems set up large numbers of virtual interfaces in order to provide
13515 many virtual web servers. In this situation, you may want to listen for
13516 email on only a few of the available interfaces, but nevertheless treat all
13517 interfaces as local when routing. You can do this by setting
13518 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13519 &"all"& wildcard values. These addresses are recognized as local, but are not
13520 used for listening. Consider this example:
13521 .code
13522 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13523                       192.168.53.235 ; \
13524                       3ffe:2101:12:1:a00:20ff:fe86:a061
13525
13526 extra_local_interfaces = <; ::0 ; 0.0.0.0
13527 .endd
13528 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13529 address, but all available interface addresses are treated as local when
13530 Exim is routing.
13531
13532 In some environments the local host name may be in an MX list, but with an IP
13533 address that is not assigned to any local interface. In other cases it may be
13534 desirable to treat other host names as if they referred to the local host. Both
13535 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13536 This contains host names rather than IP addresses. When a host is referenced
13537 during routing, either via an MX record or directly, it is treated as the local
13538 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13539 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13540
13541
13542
13543 .section "Delivering to a remote host" "SECID95"
13544 Delivery to a remote host is handled by the smtp transport. By default, it
13545 allows the system's TCP/IP functions to choose which interface to use (if
13546 there is more than one) when connecting to a remote host. However, the
13547 &%interface%& option can be set to specify which interface is used. See the
13548 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13549 details.
13550
13551
13552
13553
13554 . ////////////////////////////////////////////////////////////////////////////
13555 . ////////////////////////////////////////////////////////////////////////////
13556
13557 .chapter "Main configuration" "CHAPmainconfig"
13558 .scindex IIDconfima "configuration file" "main section"
13559 .scindex IIDmaiconf "main configuration"
13560 The first part of the run time configuration file contains three types of item:
13561
13562 .ilist
13563 Macro definitions: These lines start with an upper case letter. See section
13564 &<<SECTmacrodefs>>& for details of macro processing.
13565 .next
13566 Named list definitions: These lines start with one of the words &"domainlist"&,
13567 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13568 section &<<SECTnamedlists>>&.
13569 .next
13570 Main configuration settings: Each setting occupies one line of the file
13571 (with possible continuations). If any setting is preceded by the word
13572 &"hide"&, the &%-bP%& command line option displays its value to admin users
13573 only. See section &<<SECTcos>>& for a description of the syntax of these option
13574 settings.
13575 .endlist
13576
13577 This chapter specifies all the main configuration options, along with their
13578 types and default values. For ease of finding a particular option, they appear
13579 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13580 are now so many options, they are first listed briefly in functional groups, as
13581 an aid to finding the name of the option you are looking for. Some options are
13582 listed in more than one group.
13583
13584 .section "Miscellaneous" "SECID96"
13585 .table2
13586 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13587 .row &%debug_store%&                 "do extra internal checks"
13588 .row &%disable_ipv6%&                "do no IPv6 processing"
13589 .row &%keep_malformed%&              "for broken files &-- should not happen"
13590 .row &%localhost_number%&            "for unique message ids in clusters"
13591 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13592 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13593 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13594 .row &%print_topbitchars%&           "top-bit characters are printing"
13595 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
13596 .row &%timezone%&                    "force time zone"
13597 .endtable
13598
13599
13600 .section "Exim parameters" "SECID97"
13601 .table2
13602 .row &%exim_group%&                  "override compiled-in value"
13603 .row &%exim_path%&                   "override compiled-in value"
13604 .row &%exim_user%&                   "override compiled-in value"
13605 .row &%primary_hostname%&            "default from &[uname()]&"
13606 .row &%split_spool_directory%&       "use multiple directories"
13607 .row &%spool_directory%&             "override compiled-in value"
13608 .endtable
13609
13610
13611
13612 .section "Privilege controls" "SECID98"
13613 .table2
13614 .row &%admin_groups%&                "groups that are Exim admin users"
13615 .row &%commandline_checks_require_admin%& "require admin for various checks"
13616 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13617 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13618 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13619 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13620 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13621 .row &%never_users%&                 "do not run deliveries as these"
13622 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13623 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13624 .row &%trusted_groups%&              "groups that are trusted"
13625 .row &%trusted_users%&               "users that are trusted"
13626 .endtable
13627
13628
13629
13630 .section "Logging" "SECID99"
13631 .table2
13632 .row &%event_action%&                "custom logging"
13633 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13634 .row &%log_file_path%&               "override compiled-in value"
13635 .row &%log_selector%&                "set/unset optional logging"
13636 .row &%log_timezone%&                "add timezone to log lines"
13637 .row &%message_logs%&                "create per-message logs"
13638 .row &%preserve_message_logs%&       "after message completion"
13639 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13640 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13641 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13642 .row &%syslog_facility%&             "set syslog &""facility""& field"
13643 .row &%syslog_pid%&                  "pid in syslog lines"
13644 .row &%syslog_processname%&          "set syslog &""ident""& field"
13645 .row &%syslog_timestamp%&            "timestamp syslog lines"
13646 .row &%write_rejectlog%&             "control use of message log"
13647 .endtable
13648
13649
13650
13651 .section "Frozen messages" "SECID100"
13652 .table2
13653 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13654 .row &%freeze_tell%&                 "send message when freezing"
13655 .row &%move_frozen_messages%&        "to another directory"
13656 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13657 .endtable
13658
13659
13660
13661 .section "Data lookups" "SECID101"
13662 .table2
13663 .row &%ibase_servers%&               "InterBase servers"
13664 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13665 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13666 .row &%ldap_cert_file%&              "client cert file for LDAP"
13667 .row &%ldap_cert_key%&               "client key file for LDAP"
13668 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13669 .row &%ldap_default_servers%&        "used if no server in query"
13670 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13671 .row &%ldap_start_tls%&              "require TLS within LDAP"
13672 .row &%ldap_version%&                "set protocol version"
13673 .row &%lookup_open_max%&             "lookup files held open"
13674 .row &%mysql_servers%&               "default MySQL servers"
13675 .row &%oracle_servers%&              "Oracle servers"
13676 .row &%pgsql_servers%&               "default PostgreSQL servers"
13677 .row &%sqlite_lock_timeout%&         "as it says"
13678 .endtable
13679
13680
13681
13682 .section "Message ids" "SECID102"
13683 .table2
13684 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13685 .row &%message_id_header_text%&      "ditto"
13686 .endtable
13687
13688
13689
13690 .section "Embedded Perl Startup" "SECID103"
13691 .table2
13692 .row &%perl_at_start%&               "always start the interpreter"
13693 .row &%perl_startup%&                "code to obey when starting Perl"
13694 .row &%perl_taintmode%&              "enable taint mode in Perl"
13695 .endtable
13696
13697
13698
13699 .section "Daemon" "SECID104"
13700 .table2
13701 .row &%daemon_smtp_ports%&           "default ports"
13702 .row &%daemon_startup_retries%&      "number of times to retry"
13703 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13704 .row &%extra_local_interfaces%&      "not necessarily listened on"
13705 .row &%local_interfaces%&            "on which to listen, with optional ports"
13706 .row &%pid_file_path%&               "override compiled-in value"
13707 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13708 .endtable
13709
13710
13711
13712 .section "Resource control" "SECID105"
13713 .table2
13714 .row &%check_log_inodes%&            "before accepting a message"
13715 .row &%check_log_space%&             "before accepting a message"
13716 .row &%check_spool_inodes%&          "before accepting a message"
13717 .row &%check_spool_space%&           "before accepting a message"
13718 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13719 .row &%queue_only_load%&             "queue incoming if load high"
13720 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13721 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13722 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13723 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13724 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13725 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13726 .row &%smtp_accept_max_per_connection%& "messages per connection"
13727 .row &%smtp_accept_max_per_host%&    "connections from one host"
13728 .row &%smtp_accept_queue%&           "queue mail if more connections"
13729 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13730                                            connection"
13731 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13732 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13733 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13734 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13735 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13736 .endtable
13737
13738
13739
13740 .section "Policy controls" "SECID106"
13741 .table2
13742 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13743 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13744 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13745 .row &%acl_smtp_auth%&               "ACL for AUTH"
13746 .row &%acl_smtp_connect%&            "ACL for connection"
13747 .row &%acl_smtp_data%&               "ACL for DATA"
13748 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13749 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13750 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13751 .row &%acl_smtp_expn%&               "ACL for EXPN"
13752 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13753 .row &%acl_smtp_mail%&               "ACL for MAIL"
13754 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13755 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13756 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13757 .row &%acl_smtp_predata%&            "ACL for start of data"
13758 .row &%acl_smtp_quit%&               "ACL for QUIT"
13759 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13760 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13761 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13762 .row &%av_scanner%&                  "specify virus scanner"
13763 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13764                                       words""&"
13765 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13766 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13767 .row &%header_maxsize%&              "total size of message header"
13768 .row &%header_line_maxsize%&         "individual header line limit"
13769 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13770 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13771 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13772 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13773 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13774 .row &%host_lookup%&                 "host name looked up for these hosts"
13775 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13776 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13777 .row &%host_reject_connection%&      "reject connection from these hosts"
13778 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13779 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13780 .row &%message_size_limit%&          "for all messages"
13781 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13782 .row &%spamd_address%&               "set interface to SpamAssassin"
13783 .row &%strict_acl_vars%&             "object to unset ACL variables"
13784 .endtable
13785
13786
13787
13788 .section "Callout cache" "SECID107"
13789 .table2
13790 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13791                                          item"
13792 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13793                                          item"
13794 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13795 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13796 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13797 .endtable
13798
13799
13800
13801 .section "TLS" "SECID108"
13802 .table2
13803 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13804 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13805 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13806 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13807 .row &%tls_certificate%&             "location of server certificate"
13808 .row &%tls_crl%&                     "certificate revocation list"
13809 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13810 .row &%tls_dhparam%&                 "DH parameters for server"
13811 .row &%tls_eccurve%&                 "EC curve selection for server"
13812 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13813 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13814 .row &%tls_privatekey%&              "location of server private key"
13815 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13816 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13817 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13818 .row &%tls_verify_certificates%&     "expected client certificates"
13819 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13820 .endtable
13821
13822
13823
13824 .section "Local user handling" "SECID109"
13825 .table2
13826 .row &%finduser_retries%&            "useful in NIS environments"
13827 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13828 .row &%gecos_pattern%&               "ditto"
13829 .row &%max_username_length%&         "for systems that truncate"
13830 .row &%unknown_login%&               "used when no login name found"
13831 .row &%unknown_username%&            "ditto"
13832 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13833 .row &%uucp_from_sender%&            "ditto"
13834 .endtable
13835
13836
13837
13838 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13839 .table2
13840 .row &%header_maxsize%&              "total size of message header"
13841 .row &%header_line_maxsize%&         "individual header line limit"
13842 .row &%message_size_limit%&          "applies to all messages"
13843 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13844 .row &%received_header_text%&        "expanded to make &'Received:'&"
13845 .row &%received_headers_max%&        "for mail loop detection"
13846 .row &%recipients_max%&              "limit per message"
13847 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13848 .endtable
13849
13850
13851
13852
13853 .section "Non-SMTP incoming messages" "SECID111"
13854 .table2
13855 .row &%receive_timeout%&             "for non-SMTP messages"
13856 .endtable
13857
13858
13859
13860
13861
13862 .section "Incoming SMTP messages" "SECID112"
13863 See also the &'Policy controls'& section above.
13864
13865 .table2
13866 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13867 .row &%host_lookup%&                 "host name looked up for these hosts"
13868 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13869 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13870 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13871 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13872 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13873 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13874 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13875 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13876 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13877 .row &%smtp_accept_max_per_connection%& "messages per connection"
13878 .row &%smtp_accept_max_per_host%&    "connections from one host"
13879 .row &%smtp_accept_queue%&           "queue mail if more connections"
13880 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13881                                            connection"
13882 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13883 .row &%smtp_active_hostname%&        "host name to use in messages"
13884 .row &%smtp_banner%&                 "text for welcome banner"
13885 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13886 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13887 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13888 .row &%smtp_etrn_command%&           "what to run for ETRN"
13889 .row &%smtp_etrn_serialize%&         "only one at once"
13890 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13891 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13892 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13893 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13894 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13895 .row &%smtp_receive_timeout%&        "per command or data line"
13896 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13897 .row &%smtp_return_error_details%&   "give detail on rejections"
13898 .endtable
13899
13900
13901
13902 .section "SMTP extensions" "SECID113"
13903 .table2
13904 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13905 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13906 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
13907 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13908 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13909 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13910 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13911 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13912 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13913 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13914 .endtable
13915
13916
13917
13918 .section "Processing messages" "SECID114"
13919 .table2
13920 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13921 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13922 .row &%allow_utf8_domains%&          "in addresses"
13923 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13924                                       words""&"
13925 .row &%delivery_date_remove%&        "from incoming messages"
13926 .row &%envelope_to_remove%&          "from incoming messages"
13927 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13928 .row &%headers_charset%&             "default for translations"
13929 .row &%qualify_domain%&              "default for senders"
13930 .row &%qualify_recipient%&           "default for recipients"
13931 .row &%return_path_remove%&          "from incoming messages"
13932 .row &%strip_excess_angle_brackets%& "in addresses"
13933 .row &%strip_trailing_dot%&          "at end of addresses"
13934 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13935 .endtable
13936
13937
13938
13939 .section "System filter" "SECID115"
13940 .table2
13941 .row &%system_filter%&               "locate system filter"
13942 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13943                                             directory"
13944 .row &%system_filter_file_transport%& "transport for delivery to a file"
13945 .row &%system_filter_group%&         "group for filter running"
13946 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13947 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13948 .row &%system_filter_user%&          "user for filter running"
13949 .endtable
13950
13951
13952
13953 .section "Routing and delivery" "SECID116"
13954 .table2
13955 .row &%disable_ipv6%&                "do no IPv6 processing"
13956 .row &%dns_again_means_nonexist%&    "for broken domains"
13957 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13958 .row &%dns_dnssec_ok%&               "parameter for resolver"
13959 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13960 .row &%dns_retrans%&                 "parameter for resolver"
13961 .row &%dns_retry%&                   "parameter for resolver"
13962 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13963 .row &%dns_use_edns0%&               "parameter for resolver"
13964 .row &%hold_domains%&                "hold delivery for these domains"
13965 .row &%local_interfaces%&            "for routing checks"
13966 .row &%queue_domains%&               "no immediate delivery for these"
13967 .row &%queue_only%&                  "no immediate delivery at all"
13968 .row &%queue_only_file%&             "no immediate delivery if file exists"
13969 .row &%queue_only_load%&             "no immediate delivery if load is high"
13970 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13971 .row &%queue_only_override%&         "allow command line to override"
13972 .row &%queue_run_in_order%&          "order of arrival"
13973 .row &%queue_run_max%&               "of simultaneous queue runners"
13974 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13975 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13976 .row &%remote_sort_domains%&         "order of remote deliveries"
13977 .row &%retry_data_expire%&           "timeout for retry data"
13978 .row &%retry_interval_max%&          "safety net for retry rules"
13979 .endtable
13980
13981
13982
13983 .section "Bounce and warning messages" "SECID117"
13984 .table2
13985 .row &%bounce_message_file%&         "content of bounce"
13986 .row &%bounce_message_text%&         "content of bounce"
13987 .row &%bounce_return_body%&          "include body if returning message"
13988 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13989 .row &%bounce_return_message%&       "include original message in bounce"
13990 .row &%bounce_return_size_limit%&    "limit on returned message"
13991 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13992 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13993 .row &%errors_copy%&                 "copy bounce messages"
13994 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13995 .row &%delay_warning%&               "time schedule"
13996 .row &%delay_warning_condition%&     "condition for warning messages"
13997 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13998 .row &%smtp_return_error_details%&   "give detail on rejections"
13999 .row &%warn_message_file%&           "content of warning message"
14000 .endtable
14001
14002
14003
14004 .section "Alphabetical list of main options" "SECTalomo"
14005 Those options that undergo string expansion before use are marked with
14006 &dagger;.
14007
14008 .option accept_8bitmime main boolean true
14009 .cindex "8BITMIME"
14010 .cindex "8-bit characters"
14011 .cindex "log" "selectors"
14012 .cindex "log" "8BITMIME"
14013 This option causes Exim to send 8BITMIME in its response to an SMTP
14014 EHLO command, and to accept the BODY= parameter on MAIL commands.
14015 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14016 takes no steps to do anything special with messages received by this route.
14017
14018 Historically Exim kept this option off by default, but the maintainers
14019 feel that in today's Internet, this causes more problems than it solves.
14020 It now defaults to true.
14021 A more detailed analysis of the issues is provided by Dan Bernstein:
14022 .display
14023 &url(http://cr.yp.to/smtp/8bitmime.html)
14024 .endd
14025
14026 To log received 8BITMIME status use
14027 .code
14028 log_selector = +8bitmime
14029 .endd
14030
14031 .option acl_not_smtp main string&!! unset
14032 .cindex "&ACL;" "for non-SMTP messages"
14033 .cindex "non-SMTP messages" "ACLs for"
14034 This option defines the ACL that is run when a non-SMTP message has been
14035 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14036 further details.
14037
14038 .option acl_not_smtp_mime main string&!! unset
14039 This option defines the ACL that is run for individual MIME parts of non-SMTP
14040 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14041 SMTP messages.
14042
14043 .option acl_not_smtp_start main string&!! unset
14044 .cindex "&ACL;" "at start of non-SMTP message"
14045 .cindex "non-SMTP messages" "ACLs for"
14046 This option defines the ACL that is run before Exim starts reading a
14047 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14048
14049 .option acl_smtp_auth main string&!! unset
14050 .cindex "&ACL;" "setting up for SMTP commands"
14051 .cindex "AUTH" "ACL for"
14052 This option defines the ACL that is run when an SMTP AUTH command is
14053 received. See chapter &<<CHAPACL>>& for further details.
14054
14055 .option acl_smtp_connect main string&!! unset
14056 .cindex "&ACL;" "on SMTP connection"
14057 This option defines the ACL that is run when an SMTP connection is received.
14058 See chapter &<<CHAPACL>>& for further details.
14059
14060 .option acl_smtp_data main string&!! unset
14061 .cindex "DATA" "ACL for"
14062 This option defines the ACL that is run after an SMTP DATA command has been
14063 processed and the message itself has been received, but before the final
14064 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14065
14066 .option acl_smtp_data_prdr main string&!! accept
14067 .cindex "PRDR" "ACL for"
14068 .cindex "DATA" "PRDR ACL for"
14069 .cindex "&ACL;" "PRDR-related"
14070 .cindex "&ACL;" "per-user data processing"
14071 This option defines the ACL that,
14072 if the PRDR feature has been negotiated,
14073 is run for each recipient after an SMTP DATA command has been
14074 processed and the message itself has been received, but before the
14075 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14076
14077 .option acl_smtp_dkim main string&!! unset
14078 .cindex DKIM "ACL for"
14079 This option defines the ACL that is run for each DKIM signature
14080 (by default, or as specified in the dkim_verify_signers option)
14081 of a received message.
14082 See chapter &<<CHAPdkim>>& for further details.
14083
14084 .option acl_smtp_etrn main string&!! unset
14085 .cindex "ETRN" "ACL for"
14086 This option defines the ACL that is run when an SMTP ETRN command is
14087 received. See chapter &<<CHAPACL>>& for further details.
14088
14089 .option acl_smtp_expn main string&!! unset
14090 .cindex "EXPN" "ACL for"
14091 This option defines the ACL that is run when an SMTP EXPN command is
14092 received. See chapter &<<CHAPACL>>& for further details.
14093
14094 .option acl_smtp_helo main string&!! unset
14095 .cindex "EHLO" "ACL for"
14096 .cindex "HELO" "ACL for"
14097 This option defines the ACL that is run when an SMTP EHLO or HELO
14098 command is received. See chapter &<<CHAPACL>>& for further details.
14099
14100
14101 .option acl_smtp_mail main string&!! unset
14102 .cindex "MAIL" "ACL for"
14103 This option defines the ACL that is run when an SMTP MAIL command is
14104 received. See chapter &<<CHAPACL>>& for further details.
14105
14106 .option acl_smtp_mailauth main string&!! unset
14107 .cindex "AUTH" "on MAIL command"
14108 This option defines the ACL that is run when there is an AUTH parameter on
14109 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14110 &<<CHAPSMTPAUTH>>& for details of authentication.
14111
14112 .option acl_smtp_mime main string&!! unset
14113 .cindex "MIME content scanning" "ACL for"
14114 This option is available when Exim is built with the content-scanning
14115 extension. It defines the ACL that is run for each MIME part in a message. See
14116 section &<<SECTscanmimepart>>& for details.
14117
14118 .option acl_smtp_notquit main string&!! unset
14119 .cindex "not-QUIT, ACL for"
14120 This option defines the ACL that is run when an SMTP session
14121 ends without a QUIT command being received.
14122 See chapter &<<CHAPACL>>& for further details.
14123
14124 .option acl_smtp_predata main string&!! unset
14125 This option defines the ACL that is run when an SMTP DATA command is
14126 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14127 further details.
14128
14129 .option acl_smtp_quit main string&!! unset
14130 .cindex "QUIT, ACL for"
14131 This option defines the ACL that is run when an SMTP QUIT command is
14132 received. See chapter &<<CHAPACL>>& for further details.
14133
14134 .option acl_smtp_rcpt main string&!! unset
14135 .cindex "RCPT" "ACL for"
14136 This option defines the ACL that is run when an SMTP RCPT command is
14137 received. See chapter &<<CHAPACL>>& for further details.
14138
14139 .option acl_smtp_starttls main string&!! unset
14140 .cindex "STARTTLS, ACL for"
14141 This option defines the ACL that is run when an SMTP STARTTLS command is
14142 received. See chapter &<<CHAPACL>>& for further details.
14143
14144 .option acl_smtp_vrfy main string&!! unset
14145 .cindex "VRFY" "ACL for"
14146 This option defines the ACL that is run when an SMTP VRFY command is
14147 received. See chapter &<<CHAPACL>>& for further details.
14148
14149 .option add_environment main "string list" empty
14150 .cindex "environment" "set values"
14151 This option allows to set individual environment variables that the
14152 currently linked libraries and programs in child processes use.
14153 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14154
14155 .option admin_groups main "string list&!!" unset
14156 .cindex "admin user"
14157 This option is expanded just once, at the start of Exim's processing. If the
14158 current group or any of the supplementary groups of an Exim caller is in this
14159 colon-separated list, the caller has admin privileges. If all your system
14160 programmers are in a specific group, for example, you can give them all Exim
14161 admin privileges by putting that group in &%admin_groups%&. However, this does
14162 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14163 To permit this, you have to add individuals to the Exim group.
14164
14165 .option allow_domain_literals main boolean false
14166 .cindex "domain literal"
14167 If this option is set, the RFC 2822 domain literal format is permitted in
14168 email addresses. The option is not set by default, because the domain literal
14169 format is not normally required these days, and few people know about it. It
14170 has, however, been exploited by mail abusers.
14171
14172 Unfortunately, it seems that some DNS black list maintainers are using this
14173 format to report black listing to postmasters. If you want to accept messages
14174 addressed to your hosts by IP address, you need to set
14175 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14176 domains (defined in the named domain list &%local_domains%& in the default
14177 configuration). This &"magic string"& matches the domain literal form of all
14178 the local host's IP addresses.
14179
14180
14181 .option allow_mx_to_ip main boolean false
14182 .cindex "MX record" "pointing to IP address"
14183 It appears that more and more DNS zone administrators are breaking the rules
14184 and putting domain names that look like IP addresses on the right hand side of
14185 MX records. Exim follows the rules and rejects this, giving an error message
14186 that explains the misconfiguration. However, some other MTAs support this
14187 practice, so to avoid &"Why can't Exim do this?"& complaints,
14188 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14189 recommended, except when you have no other choice.
14190
14191 .option allow_utf8_domains main boolean false
14192 .cindex "domain" "UTF-8 characters in"
14193 .cindex "UTF-8" "in domain name"
14194 Lots of discussion is going on about internationalized domain names. One
14195 camp is strongly in favour of just using UTF-8 characters, and it seems
14196 that at least two other MTAs permit this. This option allows Exim users to
14197 experiment if they wish.
14198
14199 If it is set true, Exim's domain parsing function allows valid
14200 UTF-8 multicharacters to appear in domain name components, in addition to
14201 letters, digits, and hyphens. However, just setting this option is not
14202 enough; if you want to look up these domain names in the DNS, you must also
14203 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14204 suitable setting is:
14205 .code
14206 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14207   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14208 .endd
14209 Alternatively, you can just disable this feature by setting
14210 .code
14211 dns_check_names_pattern =
14212 .endd
14213 That is, set the option to an empty string so that no check is done.
14214
14215
14216 .option auth_advertise_hosts main "host list&!!" *
14217 .cindex "authentication" "advertising"
14218 .cindex "AUTH" "advertising"
14219 If any server authentication mechanisms are configured, Exim advertises them in
14220 response to an EHLO command only if the calling host matches this list.
14221 Otherwise, Exim does not advertise AUTH.
14222 Exim does not accept AUTH commands from clients to which it has not
14223 advertised the availability of AUTH. The advertising of individual
14224 authentication mechanisms can be controlled by the use of the
14225 &%server_advertise_condition%& generic authenticator option on the individual
14226 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14227
14228 Certain mail clients (for example, Netscape) require the user to provide a name
14229 and password for authentication if AUTH is advertised, even though it may
14230 not be needed (the host may accept messages from hosts on its local LAN without
14231 authentication, for example). The &%auth_advertise_hosts%& option can be used
14232 to make these clients more friendly by excluding them from the set of hosts to
14233 which Exim advertises AUTH.
14234
14235 .cindex "AUTH" "advertising when encrypted"
14236 If you want to advertise the availability of AUTH only when the connection
14237 is encrypted using TLS, you can make use of the fact that the value of this
14238 option is expanded, with a setting like this:
14239 .code
14240 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14241 .endd
14242 .vindex "&$tls_in_cipher$&"
14243 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14244 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14245 expansion is *, which matches all hosts.
14246
14247
14248 .option auto_thaw main time 0s
14249 .cindex "thawing messages"
14250 .cindex "unfreezing messages"
14251 If this option is set to a time greater than zero, a queue runner will try a
14252 new delivery attempt on any frozen message, other than a bounce message, if
14253 this much time has passed since it was frozen. This may result in the message
14254 being re-frozen if nothing has changed since the last attempt. It is a way of
14255 saying &"keep on trying, even though there are big problems"&.
14256
14257 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14258 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14259 thought to be very useful any more, and its use should probably be avoided.
14260
14261
14262 .option av_scanner main string "see below"
14263 This option is available if Exim is built with the content-scanning extension.
14264 It specifies which anti-virus scanner to use. The default value is:
14265 .code
14266 sophie:/var/run/sophie
14267 .endd
14268 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14269 before use. See section &<<SECTscanvirus>>& for further details.
14270
14271
14272 .option bi_command main string unset
14273 .oindex "&%-bi%&"
14274 This option supplies the name of a command that is run when Exim is called with
14275 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14276 just the command name, it is not a complete command line. If an argument is
14277 required, it must come from the &%-oA%& command line option.
14278
14279
14280 .option bounce_message_file main string unset
14281 .cindex "bounce message" "customizing"
14282 .cindex "customizing" "bounce message"
14283 This option defines a template file containing paragraphs of text to be used
14284 for constructing bounce messages.  Details of the file's contents are given in
14285 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14286
14287
14288 .option bounce_message_text main string unset
14289 When this option is set, its contents are included in the default bounce
14290 message immediately after &"This message was created automatically by mail
14291 delivery software."& It is not used if &%bounce_message_file%& is set.
14292
14293 .option bounce_return_body main boolean true
14294 .cindex "bounce message" "including body"
14295 This option controls whether the body of an incoming message is included in a
14296 bounce message when &%bounce_return_message%& is true. The default setting
14297 causes the entire message, both header and body, to be returned (subject to the
14298 value of &%bounce_return_size_limit%&). If this option is false, only the
14299 message header is included. In the case of a non-SMTP message containing an
14300 error that is detected during reception, only those header lines preceding the
14301 point at which the error was detected are returned.
14302 .cindex "bounce message" "including original"
14303
14304 .option bounce_return_linesize_limit main integer 998
14305 .cindex "size" "of bounce lines, limit"
14306 .cindex "bounce message" "line length limit"
14307 .cindex "limit" "bounce message line length"
14308 This option sets a limit in bytes on the line length of messages
14309 that are returned to senders due to delivery problems,
14310 when &%bounce_return_message%& is true.
14311 The default value corresponds to RFC limits.
14312 If the message being returned has lines longer than this value it is
14313 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14314
14315 The option also applies to bounces returned when an error is detected
14316 during reception of a message.
14317 In this case lines from the original are truncated.
14318
14319 The option does not apply to messages generated by an &(autoreply)& transport.
14320
14321
14322 .option bounce_return_message main boolean true
14323 If this option is set false, none of the original message is included in
14324 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14325 &%bounce_return_body%&.
14326
14327
14328 .option bounce_return_size_limit main integer 100K
14329 .cindex "size" "of bounce, limit"
14330 .cindex "bounce message" "size limit"
14331 .cindex "limit" "bounce message size"
14332 This option sets a limit in bytes on the size of messages that are returned to
14333 senders as part of bounce messages when &%bounce_return_message%& is true. The
14334 limit should be less than the value of the global &%message_size_limit%& and of
14335 any &%message_size_limit%& settings on transports, to allow for the bounce text
14336 that Exim generates. If this option is set to zero there is no limit.
14337
14338 When the body of any message that is to be included in a bounce message is
14339 greater than the limit, it is truncated, and a comment pointing this out is
14340 added at the top. The actual cutoff may be greater than the value given, owing
14341 to the use of buffering for transferring the message in chunks (typically 8K in
14342 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14343 messages.
14344
14345 .option bounce_sender_authentication main string unset
14346 .cindex "bounce message" "sender authentication"
14347 .cindex "authentication" "bounce message"
14348 .cindex "AUTH" "on bounce message"
14349 This option provides an authenticated sender address that is sent with any
14350 bounce messages generated by Exim that are sent over an authenticated SMTP
14351 connection. A typical setting might be:
14352 .code
14353 bounce_sender_authentication = mailer-daemon@my.domain.example
14354 .endd
14355 which would cause bounce messages to be sent using the SMTP command:
14356 .code
14357 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14358 .endd
14359 The value of &%bounce_sender_authentication%& must always be a complete email
14360 address.
14361
14362 .option callout_domain_negative_expire main time 3h
14363 .cindex "caching" "callout timeouts"
14364 .cindex "callout" "caching timeouts"
14365 This option specifies the expiry time for negative callout cache data for a
14366 domain. See section &<<SECTcallver>>& for details of callout verification, and
14367 section &<<SECTcallvercache>>& for details of the caching.
14368
14369
14370 .option callout_domain_positive_expire main time 7d
14371 This option specifies the expiry time for positive callout cache data for a
14372 domain. See section &<<SECTcallver>>& for details of callout verification, and
14373 section &<<SECTcallvercache>>& for details of the caching.
14374
14375
14376 .option callout_negative_expire main time 2h
14377 This option specifies the expiry time for negative callout cache data for an
14378 address. See section &<<SECTcallver>>& for details of callout verification, and
14379 section &<<SECTcallvercache>>& for details of the caching.
14380
14381
14382 .option callout_positive_expire main time 24h
14383 This option specifies the expiry time for positive callout cache data for an
14384 address. See section &<<SECTcallver>>& for details of callout verification, and
14385 section &<<SECTcallvercache>>& for details of the caching.
14386
14387
14388 .option callout_random_local_part main string&!! "see below"
14389 This option defines the &"random"& local part that can be used as part of
14390 callout verification. The default value is
14391 .code
14392 $primary_hostname-$tod_epoch-testing
14393 .endd
14394 See section &<<CALLaddparcall>>& for details of how this value is used.
14395
14396
14397 .option check_log_inodes main integer 100
14398 See &%check_spool_space%& below.
14399
14400
14401 .option check_log_space main integer 10M
14402 See &%check_spool_space%& below.
14403
14404 .oindex "&%check_rfc2047_length%&"
14405 .cindex "RFC 2047" "disabling length check"
14406 .option check_rfc2047_length main boolean true
14407 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14408 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14409 word; strings to be encoded that exceed this length are supposed to use
14410 multiple encoded words. By default, Exim does not recognize encoded words that
14411 exceed the maximum length. However, it seems that some software, in violation
14412 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14413 set false, Exim recognizes encoded words of any length.
14414
14415
14416 .option check_spool_inodes main integer 100
14417 See &%check_spool_space%& below.
14418
14419
14420 .option check_spool_space main integer 10M
14421 .cindex "checking disk space"
14422 .cindex "disk space, checking"
14423 .cindex "spool directory" "checking space"
14424 The four &%check_...%& options allow for checking of disk resources before a
14425 message is accepted.
14426
14427 .vindex "&$log_inodes$&"
14428 .vindex "&$log_space$&"
14429 .vindex "&$spool_inodes$&"
14430 .vindex "&$spool_space$&"
14431 When any of these options are nonzero, they apply to all incoming messages. If you
14432 want to apply different checks to different kinds of message, you can do so by
14433 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14434 &$spool_space$& in an ACL with appropriate additional conditions.
14435
14436
14437 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14438 either value is greater than zero, for example:
14439 .code
14440 check_spool_space = 100M
14441 check_spool_inodes = 100
14442 .endd
14443 The spool partition is the one that contains the directory defined by
14444 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14445 transit.
14446
14447 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14448 files are written if either is greater than zero. These should be set only if
14449 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14450
14451 If there is less space or fewer inodes than requested, Exim refuses to accept
14452 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14453 error response to the MAIL command. If ESMTP is in use and there was a
14454 SIZE parameter on the MAIL command, its value is added to the
14455 &%check_spool_space%& value, and the check is performed even if
14456 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14457
14458 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14459 number of kilobytes (though specified in bytes).
14460 If a non-multiple of 1024 is specified, it is rounded up.
14461
14462 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14463 failure a message is written to stderr and Exim exits with a non-zero code, as
14464 it obviously cannot send an error message of any kind.
14465
14466 There is a slight performance penalty for these checks.
14467 Versions of Exim preceding 4.88 had these disabled by default;
14468 high-rate installations confident they will never run out of resources
14469 may wish to deliberately disable them.
14470
14471 .option chunking_advertise_hosts main "host list&!!" *
14472 .cindex CHUNKING advertisement
14473 .cindex "RFC 3030" "CHUNKING"
14474 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14475 these hosts.
14476 Hosts may use the BDAT command as an alternate to DATA.
14477
14478 .new
14479 .option commandline_checks_require_admin main boolean &`false`&
14480 .cindex "restricting access to features"
14481 This option restricts various basic checking features to require an
14482 administrative user.
14483 This affects most of the &%-b*%& options, such as &%-be%&.
14484 .wen
14485
14486 .option debug_store main boolean &`false`&
14487 .cindex debugging "memory corruption"
14488 .cindex memory debugging
14489 This option, when true, enables extra checking in Exim's internal memory
14490 management.  For use when a memory corruption issue is being investigated,
14491 it should normally be left as default.
14492
14493 .option daemon_smtp_ports main string &`smtp`&
14494 .cindex "port" "for daemon"
14495 .cindex "TCP/IP" "setting listening ports"
14496 This option specifies one or more default SMTP ports on which the Exim daemon
14497 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14498 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14499
14500 .option daemon_startup_retries main integer 9
14501 .cindex "daemon startup, retrying"
14502 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14503 the daemon at startup when it cannot immediately bind a listening socket
14504 (typically because the socket is already in use): &%daemon_startup_retries%&
14505 defines the number of retries after the first failure, and
14506 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14507
14508 .option daemon_startup_sleep main time 30s
14509 See &%daemon_startup_retries%&.
14510
14511 .option delay_warning main "time list" 24h
14512 .cindex "warning of delay"
14513 .cindex "delay warning, specifying"
14514 .cindex "queue" "delay warning"
14515 When a message is delayed, Exim sends a warning message to the sender at
14516 intervals specified by this option. The data is a colon-separated list of times
14517 after which to send warning messages. If the value of the option is an empty
14518 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14519 message has been on the queue for longer than the last time, the last interval
14520 between the times is used to compute subsequent warning times. For example,
14521 with
14522 .code
14523 delay_warning = 4h:8h:24h
14524 .endd
14525 the first message is sent after 4 hours, the second after 8 hours, and
14526 the third one after 24 hours. After that, messages are sent every 16 hours,
14527 because that is the interval between the last two times on the list. If you set
14528 just one time, it specifies the repeat interval. For example, with:
14529 .code
14530 delay_warning = 6h
14531 .endd
14532 messages are repeated every six hours. To stop warnings after a given time, set
14533 a very large time at the end of the list. For example:
14534 .code
14535 delay_warning = 2h:12h:99d
14536 .endd
14537 Note that the option is only evaluated at the time a delivery attempt fails,
14538 which depends on retry and queue-runner configuration.
14539 Typically retries will be configured more frequently than warning messages.
14540
14541 .option delay_warning_condition main string&!! "see below"
14542 .vindex "&$domain$&"
14543 The string is expanded at the time a warning message might be sent. If all the
14544 deferred addresses have the same domain, it is set in &$domain$& during the
14545 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14546 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14547 &"false"& (the comparison being done caselessly) then the warning message is
14548 not sent. The default is:
14549 .code
14550 delay_warning_condition = ${if or {\
14551   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14552   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14553   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14554   } {no}{yes}}
14555 .endd
14556 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14557 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14558 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14559 &"auto-replied"& in an &'Auto-Submitted:'& header.
14560
14561 .option deliver_drop_privilege main boolean false
14562 .cindex "unprivileged delivery"
14563 .cindex "delivery" "unprivileged"
14564 If this option is set true, Exim drops its root privilege at the start of a
14565 delivery process, and runs as the Exim user throughout. This severely restricts
14566 the kinds of local delivery that are possible, but is viable in certain types
14567 of configuration. There is a discussion about the use of root privilege in
14568 chapter &<<CHAPsecurity>>&.
14569
14570 .option deliver_queue_load_max main fixed-point unset
14571 .cindex "load average"
14572 .cindex "queue runner" "abandoning"
14573 When this option is set, a queue run is abandoned if the system load average
14574 becomes greater than the value of the option. The option has no effect on
14575 ancient operating systems on which Exim cannot determine the load average.
14576 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14577
14578
14579 .option delivery_date_remove main boolean true
14580 .cindex "&'Delivery-date:'& header line"
14581 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14582 message when it is delivered, in exactly the same way as &'Return-path:'& is
14583 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14584 should not be present in incoming messages, and this option causes them to be
14585 removed at the time the message is received, to avoid any problems that might
14586 occur when a delivered message is subsequently sent on to some other recipient.
14587
14588 .option disable_fsync main boolean false
14589 .cindex "&[fsync()]&, disabling"
14590 This option is available only if Exim was built with the compile-time option
14591 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14592 a runtime configuration generates an &"unknown option"& error. You should not
14593 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14594 really, really, really understand what you are doing. &'No pre-compiled
14595 distributions of Exim should ever make this option available.'&
14596
14597 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14598 updated files' data to be written to disc before continuing. Unexpected events
14599 such as crashes and power outages may cause data to be lost or scrambled.
14600 Here be Dragons. &*Beware.*&
14601
14602
14603 .option disable_ipv6 main boolean false
14604 .cindex "IPv6" "disabling"
14605 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14606 activities take place. AAAA records are never looked up, and any IPv6 addresses
14607 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14608 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14609 to handle IPv6 literal addresses.
14610
14611
14612 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14613 .cindex DKIM "controlling calls to the ACL"
14614 This option gives a list of DKIM domains for which the DKIM ACL is run.
14615 It is expanded after the message is received; by default it runs
14616 the ACL once for each signature in the message.
14617 See chapter &<<CHAPdkim>>&.
14618
14619
14620 .option dns_again_means_nonexist main "domain list&!!" unset
14621 .cindex "DNS" "&""try again""& response; overriding"
14622 DNS lookups give a &"try again"& response for the DNS errors
14623 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14624 keep trying to deliver a message, or to give repeated temporary errors to
14625 incoming mail. Sometimes the effect is caused by a badly set up name server and
14626 may persist for a long time. If a domain which exhibits this problem matches
14627 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14628 This option should be used with care. You can make it apply to reverse lookups
14629 by a setting such as this:
14630 .code
14631 dns_again_means_nonexist = *.in-addr.arpa
14632 .endd
14633 This option applies to all DNS lookups that Exim does. It also applies when the
14634 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14635 since these are most likely to be caused by DNS lookup problems. The
14636 &(dnslookup)& router has some options of its own for controlling what happens
14637 when lookups for MX or SRV records give temporary errors. These more specific
14638 options are applied after this global option.
14639
14640 .option dns_check_names_pattern main string "see below"
14641 .cindex "DNS" "pre-check of name syntax"
14642 When this option is set to a non-empty string, it causes Exim to check domain
14643 names for characters that are not allowed in host names before handing them to
14644 the DNS resolver, because some resolvers give temporary errors for names that
14645 contain unusual characters. If a domain name contains any unwanted characters,
14646 a &"not found"& result is forced, and the resolver is not called. The check is
14647 done by matching the domain name against a regular expression, which is the
14648 value of this option. The default pattern is
14649 .code
14650 dns_check_names_pattern = \
14651   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14652 .endd
14653 which permits only letters, digits, slashes, and hyphens in components, but
14654 they must start and end with a letter or digit. Slashes are not, in fact,
14655 permitted in host names, but they are found in certain NS records (which can be
14656 accessed in Exim by using a &%dnsdb%& lookup). If you set
14657 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14658 empty string.
14659
14660 .option dns_csa_search_limit main integer 5
14661 This option controls the depth of parental searching for CSA SRV records in the
14662 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14663
14664 .option dns_csa_use_reverse main boolean true
14665 This option controls whether or not an IP address, given as a CSA domain, is
14666 reversed and looked up in the reverse DNS, as described in more detail in
14667 section &<<SECTverifyCSA>>&.
14668
14669
14670 .option dns_dnssec_ok main integer -1
14671 .cindex "DNS" "resolver options"
14672 .cindex "DNS" "DNSSEC"
14673 If this option is set to a non-negative number then Exim will initialise the
14674 DNS resolver library to either use or not use DNSSEC, overriding the system
14675 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14676
14677 If the resolver library does not support DNSSEC then this option has no effect.
14678
14679
14680 .option dns_ipv4_lookup main "domain list&!!" unset
14681 .cindex "IPv6" "DNS lookup for AAAA records"
14682 .cindex "DNS" "IPv6 lookup for AAAA records"
14683 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14684 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14685 (A records) when trying to find IP addresses for hosts, unless the host's
14686 domain matches this list.
14687
14688 This is a fudge to help with name servers that give big delays or otherwise do
14689 not work for the AAAA record type. In due course, when the world's name
14690 servers have all been upgraded, there should be no need for this option.
14691
14692
14693 .option dns_retrans main time 0s
14694 .cindex "DNS" "resolver options"
14695 .cindex timeout "dns lookup"
14696 .cindex "DNS" timeout
14697 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14698 retransmission and retry parameters for DNS lookups. Values of zero (the
14699 defaults) leave the system default settings unchanged. The first value is the
14700 time between retries, and the second is the number of retries. It isn't
14701 totally clear exactly how these settings affect the total time a DNS lookup may
14702 take. I haven't found any documentation about timeouts on DNS lookups; these
14703 parameter values are available in the external resolver interface structure,
14704 but nowhere does it seem to describe how they are used or what you might want
14705 to set in them.
14706 See also the &%slow_lookup_log%& option.
14707
14708
14709 .option dns_retry main integer 0
14710 See &%dns_retrans%& above.
14711
14712
14713 .option dns_trust_aa main "domain list&!!" unset
14714 .cindex "DNS" "resolver options"
14715 .cindex "DNS" "DNSSEC"
14716 If this option is set then lookup results marked with the AA bit
14717 (Authoritative Answer) are trusted the same way as if they were
14718 DNSSEC-verified. The authority section's name of the answer must
14719 match with this expanded domain list.
14720
14721 Use this option only if you talk directly to a resolver that is
14722 authoritative for some zones and does not set the AD (Authentic Data)
14723 bit in the answer. Some DNS servers may have an configuration option to
14724 mark the answers from their own zones as verified (they set the AD bit).
14725 Others do not have this option. It is considered as poor practice using
14726 a resolver that is an authoritative server for some zones.
14727
14728 Use this option only if you really have to (e.g. if you want
14729 to use DANE for remote delivery to a server that is listed in the DNS
14730 zones that your resolver is authoritative for).
14731
14732 If the DNS answer packet has the AA bit set and contains resource record
14733 in the answer section, the name of the first NS record appearing in the
14734 authority section is compared against the list. If the answer packet is
14735 authoritative but the answer section is empty, the name of the first SOA
14736 record in the authoritative section is used instead.
14737
14738 .cindex "DNS" "resolver options"
14739 .option dns_use_edns0 main integer -1
14740 .cindex "DNS" "resolver options"
14741 .cindex "DNS" "EDNS0"
14742 .cindex "DNS" "OpenBSD
14743 If this option is set to a non-negative number then Exim will initialise the
14744 DNS resolver library to either use or not use EDNS0 extensions, overriding
14745 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14746 on.
14747
14748 If the resolver library does not support EDNS0 then this option has no effect.
14749
14750 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
14751 means that DNSSEC will not work with Exim on that platform either, unless Exim
14752 is linked against an alternative DNS client library.
14753
14754
14755 .option drop_cr main boolean false
14756 This is an obsolete option that is now a no-op. It used to affect the way Exim
14757 handled CR and LF characters in incoming messages. What happens now is
14758 described in section &<<SECTlineendings>>&.
14759
14760 .option dsn_advertise_hosts main "host list&!!" unset
14761 .cindex "bounce messages" "success"
14762 .cindex "DSN" "success"
14763 .cindex "Delivery Status Notification" "success"
14764 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14765 and accepted from, these hosts.
14766 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14767 and RET and ORCPT options on MAIL FROM commands.
14768 A NOTIFY=SUCCESS option requests success-DSN messages.
14769 A NOTIFY= option with no argument requests that no delay or failure DSNs
14770 are sent.
14771
14772 .option dsn_from main "string&!!" "see below"
14773 .cindex "&'From:'& header line" "in bounces"
14774 .cindex "bounce messages" "&'From:'& line, specifying"
14775 This option can be used to vary the contents of &'From:'& header lines in
14776 bounces and other automatically generated messages (&"Delivery Status
14777 Notifications"& &-- hence the name of the option). The default setting is:
14778 .code
14779 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14780 .endd
14781 The value is expanded every time it is needed. If the expansion fails, a
14782 panic is logged, and the default value is used.
14783
14784 .option envelope_to_remove main boolean true
14785 .cindex "&'Envelope-to:'& header line"
14786 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14787 message when it is delivered, in exactly the same way as &'Return-path:'& is
14788 handled. &'Envelope-to:'& records the original recipient address from the
14789 message's envelope that caused the delivery to happen. Such headers should not
14790 be present in incoming messages, and this option causes them to be removed at
14791 the time the message is received, to avoid any problems that might occur when a
14792 delivered message is subsequently sent on to some other recipient.
14793
14794
14795 .option errors_copy main "string list&!!" unset
14796 .cindex "bounce message" "copy to other address"
14797 .cindex "copy of bounce message"
14798 Setting this option causes Exim to send bcc copies of bounce messages that it
14799 generates to other addresses. &*Note*&: This does not apply to bounce messages
14800 coming from elsewhere. The value of the option is a colon-separated list of
14801 items. Each item consists of a pattern, terminated by white space, followed by
14802 a comma-separated list of email addresses. If a pattern contains spaces, it
14803 must be enclosed in double quotes.
14804
14805 Each pattern is processed in the same way as a single item in an address list
14806 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14807 the bounce message, the message is copied to the addresses on the list. The
14808 items are scanned in order, and once a matching one is found, no further items
14809 are examined. For example:
14810 .code
14811 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14812               rqps@mydomain   hostmaster@mydomain.example,\
14813                               postmaster@mydomain.example
14814 .endd
14815 .vindex "&$domain$&"
14816 .vindex "&$local_part$&"
14817 The address list is expanded before use. The expansion variables &$local_part$&
14818 and &$domain$& are set from the original recipient of the error message, and if
14819 there was any wildcard matching in the pattern, the expansion
14820 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14821 variables &$0$&, &$1$&, etc. are set in the normal way.
14822
14823
14824 .option errors_reply_to main string unset
14825 .cindex "bounce message" "&'Reply-to:'& in"
14826 By default, Exim's bounce and delivery warning messages contain the header line
14827 .display
14828 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14829 .endd
14830 .oindex &%quota_warn_message%&
14831 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14832 A warning message that is generated by the &%quota_warn_message%& option in an
14833 &(appendfile)& transport may contain its own &'From:'& header line that
14834 overrides the default.
14835
14836 Experience shows that people reply to bounce messages. If the
14837 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14838 and warning messages. For example:
14839 .code
14840 errors_reply_to = postmaster@my.domain.example
14841 .endd
14842 The value of the option is not expanded. It must specify a valid RFC 2822
14843 address. However, if a warning message that is generated by the
14844 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14845 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14846 not used.
14847
14848
14849 .option event_action main string&!! unset
14850 .cindex events
14851 This option declares a string to be expanded for Exim's events mechanism.
14852 For details see chapter &<<CHAPevents>>&.
14853
14854
14855 .option exim_group main string "compile-time configured"
14856 .cindex "gid (group id)" "Exim's own"
14857 .cindex "Exim group"
14858 This option changes the gid under which Exim runs when it gives up root
14859 privilege. The default value is compiled into the binary. The value of this
14860 option is used only when &%exim_user%& is also set. Unless it consists entirely
14861 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14862 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14863 security issues.
14864
14865
14866 .option exim_path main string "see below"
14867 .cindex "Exim binary, path name"
14868 This option specifies the path name of the Exim binary, which is used when Exim
14869 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14870 the directory configured at compile time by the BIN_DIRECTORY setting. It
14871 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14872 other place.
14873 &*Warning*&: Do not use a macro to define the value of this option, because
14874 you will break those Exim utilities that scan the configuration file to find
14875 where the binary is. (They then use the &%-bP%& option to extract option
14876 settings such as the value of &%spool_directory%&.)
14877
14878
14879 .option exim_user main string "compile-time configured"
14880 .cindex "uid (user id)" "Exim's own"
14881 .cindex "Exim user"
14882 This option changes the uid under which Exim runs when it gives up root
14883 privilege. The default value is compiled into the binary. Ownership of the run
14884 time configuration file and the use of the &%-C%& and &%-D%& command line
14885 options is checked against the values in the binary, not what is set here.
14886
14887 Unless it consists entirely of digits, the string is looked up using
14888 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14889 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14890 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14891
14892
14893 .option extra_local_interfaces main "string list" unset
14894 This option defines network interfaces that are to be considered local when
14895 routing, but which are not used for listening by the daemon. See section
14896 &<<SECTreclocipadd>>& for details.
14897
14898
14899 . Allow this long option name to split; give it unsplit as a fifth argument
14900 . for the automatic .oindex that is generated by .option.
14901
14902 .option "extract_addresses_remove_arguments" main boolean true &&&
14903          extract_addresses_remove_arguments
14904 .oindex "&%-t%&"
14905 .cindex "command line" "addresses with &%-t%&"
14906 .cindex "Sendmail compatibility" "&%-t%& option"
14907 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14908 are present on the command line when the &%-t%& option is used to build an
14909 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14910 line addresses are removed from the recipients list. This is also how Smail
14911 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14912 command line addresses are added to those obtained from the header lines. When
14913 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14914 argument headers. If it is set false, Exim adds rather than removes argument
14915 addresses.
14916
14917
14918 .option finduser_retries main integer 0
14919 .cindex "NIS, retrying user lookups"
14920 On systems running NIS or other schemes in which user and group information is
14921 distributed from a remote system, there can be times when &[getpwnam()]& and
14922 related functions fail, even when given valid data, because things time out.
14923 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14924 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14925 many extra times to find a user or a group, waiting for one second between
14926 retries.
14927
14928 .cindex "&_/etc/passwd_&" "multiple reading of"
14929 You should not set this option greater than zero if your user information is in
14930 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14931 search the file multiple times for non-existent users, and also cause delay.
14932
14933
14934
14935 .option freeze_tell main "string list, comma separated" unset
14936 .cindex "freezing messages" "sending a message when freezing"
14937 On encountering certain errors, or when configured to do so in a system filter,
14938 ACL, or special router, Exim freezes a message. This means that no further
14939 delivery attempts take place until an administrator thaws the message, or the
14940 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14941 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14942 warning message whenever it freezes something, unless the message it is
14943 freezing is a locally-generated bounce message. (Without this exception there
14944 is the possibility of looping.) The warning message is sent to the addresses
14945 supplied as the comma-separated value of this option. If several of the
14946 message's addresses cause freezing, only a single message is sent. If the
14947 freezing was automatic, the reason(s) for freezing can be found in the message
14948 log. If you configure freezing in a filter or ACL, you must arrange for any
14949 logging that you require.
14950
14951
14952 .option gecos_name main string&!! unset
14953 .cindex "HP-UX"
14954 .cindex "&""gecos""& field, parsing"
14955 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14956 password file to hold other information in addition to users' real names. Exim
14957 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14958 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14959 of the field are used unchanged, except that, if an ampersand is encountered,
14960 it is replaced by the user's login name with the first character forced to
14961 upper case, since this is a convention that is observed on many systems.
14962
14963 When these options are set, &%gecos_pattern%& is treated as a regular
14964 expression that is to be applied to the field (again with && replaced by the
14965 login name), and if it matches, &%gecos_name%& is expanded and used as the
14966 user's name.
14967
14968 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14969 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14970 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14971 name terminates at the first comma, the following can be used:
14972 .code
14973 gecos_pattern = ([^,]*)
14974 gecos_name = $1
14975 .endd
14976
14977 .option gecos_pattern main string unset
14978 See &%gecos_name%& above.
14979
14980
14981 .option gnutls_compat_mode main boolean unset
14982 This option controls whether GnuTLS is used in compatibility mode in an Exim
14983 server. This reduces security slightly, but improves interworking with older
14984 implementations of TLS.
14985
14986
14987 option gnutls_allow_auto_pkcs11 main boolean unset
14988 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14989 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14990
14991 See
14992 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14993 for documentation.
14994
14995
14996
14997 .option headers_charset main string "see below"
14998 This option sets a default character set for translating from encoded MIME
14999 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15000 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15001 ultimate default is ISO-8859-1. For more details see the description of header
15002 insertions in section &<<SECTexpansionitems>>&.
15003
15004
15005
15006 .option header_maxsize main integer "see below"
15007 .cindex "header section" "maximum size of"
15008 .cindex "limit" "size of message header section"
15009 This option controls the overall maximum size of a message's header
15010 section. The default is the value of HEADER_MAXSIZE in
15011 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15012 sections are rejected.
15013
15014
15015 .option header_line_maxsize main integer 0
15016 .cindex "header lines" "maximum size of"
15017 .cindex "limit" "size of one header line"
15018 This option limits the length of any individual header line in a message, after
15019 all the continuations have been joined together. Messages with individual
15020 header lines that are longer than the limit are rejected. The default value of
15021 zero means &"no limit"&.
15022
15023
15024
15025
15026 .option helo_accept_junk_hosts main "host list&!!" unset
15027 .cindex "HELO" "accepting junk data"
15028 .cindex "EHLO" "accepting junk data"
15029 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15030 mail, and gives an error response for invalid data. Unfortunately, there are
15031 some SMTP clients that send syntactic junk. They can be accommodated by setting
15032 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15033 if you want to do semantic checking.
15034 See also &%helo_allow_chars%& for a way of extending the permitted character
15035 set.
15036
15037
15038 .option helo_allow_chars main string unset
15039 .cindex "HELO" "underscores in"
15040 .cindex "EHLO" "underscores in"
15041 .cindex "underscore in EHLO/HELO"
15042 This option can be set to a string of rogue characters that are permitted in
15043 all EHLO and HELO names in addition to the standard letters, digits,
15044 hyphens, and dots. If you really must allow underscores, you can set
15045 .code
15046 helo_allow_chars = _
15047 .endd
15048 Note that the value is one string, not a list.
15049
15050
15051 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15052 .cindex "HELO" "forcing reverse lookup"
15053 .cindex "EHLO" "forcing reverse lookup"
15054 If the domain given by a client in a HELO or EHLO command matches this
15055 list, a reverse lookup is done in order to establish the host's true name. The
15056 default forces a lookup if the client host gives the server's name or any of
15057 its IP addresses (in brackets), something that broken clients have been seen to
15058 do.
15059
15060
15061 .option helo_try_verify_hosts main "host list&!!" unset
15062 .cindex "HELO verifying" "optional"
15063 .cindex "EHLO" "verifying, optional"
15064 By default, Exim just checks the syntax of HELO and EHLO commands (see
15065 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15066 to do more extensive checking of the data supplied by these commands. The ACL
15067 condition &`verify = helo`& is provided to make this possible.
15068 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15069 to force the check to occur. From release 4.53 onwards, this is no longer
15070 necessary. If the check has not been done before &`verify = helo`& is
15071 encountered, it is done at that time. Consequently, this option is obsolete.
15072 Its specification is retained here for backwards compatibility.
15073
15074 When an EHLO or HELO command is received, if the calling host matches
15075 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15076 EHLO command either:
15077
15078 .ilist
15079 is an IP literal matching the calling address of the host, or
15080 .next
15081 .cindex "DNS" "reverse lookup"
15082 .cindex "reverse DNS lookup"
15083 matches the host name that Exim obtains by doing a reverse lookup of the
15084 calling host address, or
15085 .next
15086 when looked up in DNS yields the calling host address.
15087 .endlist
15088
15089 However, the EHLO or HELO command is not rejected if any of the checks
15090 fail. Processing continues, but the result of the check is remembered, and can
15091 be detected later in an ACL by the &`verify = helo`& condition.
15092
15093 If DNS was used for successful verification, the variable
15094 .cindex "DNS" "DNSSEC"
15095 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15096
15097 .option helo_verify_hosts main "host list&!!" unset
15098 .cindex "HELO verifying" "mandatory"
15099 .cindex "EHLO" "verifying, mandatory"
15100 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15101 backwards compatibility. For hosts that match this option, Exim checks the host
15102 name given in the HELO or EHLO in the same way as for
15103 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15104 rejected with a 550 error, and entries are written to the main and reject logs.
15105 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15106 error.
15107
15108 .option hold_domains main "domain list&!!" unset
15109 .cindex "domain" "delaying delivery"
15110 .cindex "delivery" "delaying certain domains"
15111 This option allows mail for particular domains to be held on the queue
15112 manually. The option is overridden if a message delivery is forced with the
15113 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15114 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15115 item in &%hold_domains%&, no routing or delivery for that address is done, and
15116 it is deferred every time the message is looked at.
15117
15118 This option is intended as a temporary operational measure for delaying the
15119 delivery of mail while some problem is being sorted out, or some new
15120 configuration tested. If you just want to delay the processing of some
15121 domains until a queue run occurs, you should use &%queue_domains%& or
15122 &%queue_smtp_domains%&, not &%hold_domains%&.
15123
15124 A setting of &%hold_domains%& does not override Exim's code for removing
15125 messages from the queue if they have been there longer than the longest retry
15126 time in any retry rule. If you want to hold messages for longer than the normal
15127 retry times, insert a dummy retry rule with a long retry time.
15128
15129
15130 .option host_lookup main "host list&!!" unset
15131 .cindex "host name" "lookup, forcing"
15132 Exim does not look up the name of a calling host from its IP address unless it
15133 is required to compare against some host list, or the host matches
15134 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15135 option (which normally contains IP addresses rather than host names). The
15136 default configuration file contains
15137 .code
15138 host_lookup = *
15139 .endd
15140 which causes a lookup to happen for all hosts. If the expense of these lookups
15141 is felt to be too great, the setting can be changed or removed.
15142
15143 After a successful reverse lookup, Exim does a forward lookup on the name it
15144 has obtained, to verify that it yields the IP address that it started with. If
15145 this check fails, Exim behaves as if the name lookup failed.
15146
15147 .vindex "&$host_lookup_failed$&"
15148 .vindex "&$sender_host_name$&"
15149 After any kind of failure, the host name (in &$sender_host_name$&) remains
15150 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15151 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15152 &`verify = reverse_host_lookup`& in ACLs.
15153
15154
15155 .option host_lookup_order main "string list" &`bydns:byaddr`&
15156 This option specifies the order of different lookup methods when Exim is trying
15157 to find a host name from an IP address. The default is to do a DNS lookup
15158 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15159 if that fails. You can change the order of these lookups, or omit one entirely,
15160 if you want.
15161
15162 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15163 multiple PTR records in the DNS and the IP address is not listed in
15164 &_/etc/hosts_&. Different operating systems give different results in this
15165 case. That is why the default tries a DNS lookup first.
15166
15167
15168
15169 .option host_reject_connection main "host list&!!" unset
15170 .cindex "host" "rejecting connections from"
15171 If this option is set, incoming SMTP calls from the hosts listed are rejected
15172 as soon as the connection is made.
15173 This option is obsolete, and retained only for backward compatibility, because
15174 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15175 connections immediately.
15176
15177 The ability to give an immediate rejection (either by this option or using an
15178 ACL) is provided for use in unusual cases. Many hosts will just try again,
15179 sometimes without much delay. Normally, it is better to use an ACL to reject
15180 incoming messages at a later stage, such as after RCPT commands. See
15181 chapter &<<CHAPACL>>&.
15182
15183
15184 .option hosts_connection_nolog main "host list&!!" unset
15185 .cindex "host" "not logging connections from"
15186 This option defines a list of hosts for which connection logging does not
15187 happen, even though the &%smtp_connection%& log selector is set. For example,
15188 you might want not to log SMTP connections from local processes, or from
15189 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15190 the daemon; you should therefore strive to restrict its value to a short inline
15191 list of IP addresses and networks. To disable logging SMTP connections from
15192 local processes, you must create a host list with an empty item. For example:
15193 .code
15194 hosts_connection_nolog = :
15195 .endd
15196 If the &%smtp_connection%& log selector is not set, this option has no effect.
15197
15198
15199
15200 .option hosts_proxy main "host list&!!" unset
15201 .cindex proxy "proxy protocol"
15202 This option enables use of Proxy Protocol proxies for incoming
15203 connections.  For details see section &<<SECTproxyInbound>>&.
15204
15205
15206 .option hosts_treat_as_local main "domain list&!!" unset
15207 .cindex "local host" "domains treated as"
15208 .cindex "host" "treated as local"
15209 If this option is set, any host names that match the domain list are treated as
15210 if they were the local host when Exim is scanning host lists obtained from MX
15211 records
15212 or other sources. Note that the value of this option is a domain list, not a
15213 host list, because it is always used to check host names, not IP addresses.
15214
15215 This option also applies when Exim is matching the special items
15216 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15217 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15218 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15219 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15220 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15221 interfaces and recognizing the local host.
15222
15223
15224 .option ibase_servers main "string list" unset
15225 .cindex "InterBase" "server list"
15226 This option provides a list of InterBase servers and associated connection data,
15227 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15228 The option is available only if Exim has been built with InterBase support.
15229
15230
15231
15232 .option ignore_bounce_errors_after main time 10w
15233 .cindex "bounce message" "discarding"
15234 .cindex "discarding bounce message"
15235 This option affects the processing of bounce messages that cannot be delivered,
15236 that is, those that suffer a permanent delivery failure. (Bounce messages that
15237 suffer temporary delivery failures are of course retried in the usual way.)
15238
15239 After a permanent delivery failure, bounce messages are frozen,
15240 because there is no sender to whom they can be returned. When a frozen bounce
15241 message has been on the queue for more than the given time, it is unfrozen at
15242 the next queue run, and a further delivery is attempted. If delivery fails
15243 again, the bounce message is discarded. This makes it possible to keep failed
15244 bounce messages around for a shorter time than the normal maximum retry time
15245 for frozen messages. For example,
15246 .code
15247 ignore_bounce_errors_after = 12h
15248 .endd
15249 retries failed bounce message deliveries after 12 hours, discarding any further
15250 failures. If the value of this option is set to a zero time period, bounce
15251 failures are discarded immediately. Setting a very long time (as in the default
15252 value) has the effect of disabling this option. For ways of automatically
15253 dealing with other kinds of frozen message, see &%auto_thaw%& and
15254 &%timeout_frozen_after%&.
15255
15256
15257 .option ignore_fromline_hosts main "host list&!!" unset
15258 .cindex "&""From""& line"
15259 .cindex "UUCP" "&""From""& line"
15260 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15261 the headers of a message. By default this is treated as the start of the
15262 message's body, which means that any following headers are not recognized as
15263 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15264 match those hosts that insist on sending it. If the sender is actually a local
15265 process rather than a remote host, and is using &%-bs%& to inject the messages,
15266 &%ignore_fromline_local%& must be set to achieve this effect.
15267
15268
15269 .option ignore_fromline_local main boolean false
15270 See &%ignore_fromline_hosts%& above.
15271
15272 .option keep_environment main "string list" unset
15273 .cindex "environment" "values from"
15274 This option contains a string list of environment variables to keep.
15275 You have to trust these variables or you have to be sure that
15276 these variables do not impose any security risk. Keep in mind that
15277 during the startup phase Exim is running with an effective UID 0 in most
15278 installations. As the default value is an empty list, the default
15279 environment for using libraries, running embedded Perl code, or running
15280 external binaries is empty, and does not not even contain PATH or HOME.
15281
15282 Actually the list is interpreted as a list of patterns
15283 (&<<SECTlistexpand>>&), except that it is not expanded first.
15284
15285 WARNING: Macro substitution is still done first, so having a macro
15286 FOO and having FOO_HOME in your &%keep_environment%& option may have
15287 unexpected results. You may work around this using a regular expression
15288 that does not match the macro name: ^[F]OO_HOME$.
15289
15290 Current versions of Exim issue a warning during startup if you do not mention
15291 &%keep_environment%& in your runtime configuration file and if your
15292 current environment is not empty. Future versions may not issue that warning
15293 anymore.
15294
15295 See the &%add_environment%& main config option for a way to set
15296 environment variables to a fixed value.  The environment for &(pipe)&
15297 transports is handled separately, see section &<<SECTpipeenv>>& for
15298 details.
15299
15300
15301 .option keep_malformed main time 4d
15302 This option specifies the length of time to keep messages whose spool files
15303 have been corrupted in some way. This should, of course, never happen. At the
15304 next attempt to deliver such a message, it gets removed. The incident is
15305 logged.
15306
15307
15308 .option ldap_ca_cert_dir main string unset
15309 .cindex "LDAP", "TLS CA certificate directory"
15310 .cindex certificate "directory for LDAP"
15311 This option indicates which directory contains CA certificates for verifying
15312 a TLS certificate presented by an LDAP server.
15313 While Exim does not provide a default value, your SSL library may.
15314 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15315 and constrained to be a directory.
15316
15317
15318 .option ldap_ca_cert_file main string unset
15319 .cindex "LDAP", "TLS CA certificate file"
15320 .cindex certificate "file for LDAP"
15321 This option indicates which file contains CA certificates for verifying
15322 a TLS certificate presented by an LDAP server.
15323 While Exim does not provide a default value, your SSL library may.
15324 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15325 and constrained to be a file.
15326
15327
15328 .option ldap_cert_file main string unset
15329 .cindex "LDAP" "TLS client certificate file"
15330 .cindex certificate "file for LDAP"
15331 This option indicates which file contains an TLS client certificate which
15332 Exim should present to the LDAP server during TLS negotiation.
15333 Should be used together with &%ldap_cert_key%&.
15334
15335
15336 .option ldap_cert_key main string unset
15337 .cindex "LDAP" "TLS client key file"
15338 .cindex certificate "key for LDAP"
15339 This option indicates which file contains the secret/private key to use
15340 to prove identity to the LDAP server during TLS negotiation.
15341 Should be used together with &%ldap_cert_file%&, which contains the
15342 identity to be proven.
15343
15344
15345 .option ldap_cipher_suite main string unset
15346 .cindex "LDAP" "TLS cipher suite"
15347 This controls the TLS cipher-suite negotiation during TLS negotiation with
15348 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15349 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15350
15351
15352 .option ldap_default_servers main "string list" unset
15353 .cindex "LDAP" "default servers"
15354 This option provides a list of LDAP servers which are tried in turn when an
15355 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15356 details of LDAP queries. This option is available only when Exim has been built
15357 with LDAP support.
15358
15359
15360 .option ldap_require_cert main string unset.
15361 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15362 This should be one of the values "hard", "demand", "allow", "try" or "never".
15363 A value other than one of these is interpreted as "never".
15364 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15365 Although Exim does not set a default, the LDAP library probably defaults
15366 to hard/demand.
15367
15368
15369 .option ldap_start_tls main boolean false
15370 .cindex "LDAP" "whether or not to negotiate TLS"
15371 If set, Exim will attempt to negotiate TLS with the LDAP server when
15372 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15373 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15374 of SSL-on-connect.
15375 In the event of failure to negotiate TLS, the action taken is controlled
15376 by &%ldap_require_cert%&.
15377 This option is ignored for &`ldapi`& connections.
15378
15379
15380 .option ldap_version main integer unset
15381 .cindex "LDAP" "protocol version, forcing"
15382 This option can be used to force Exim to set a specific protocol version for
15383 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15384 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15385 the LDAP headers; otherwise it is 2. This option is available only when Exim
15386 has been built with LDAP support.
15387
15388
15389
15390 .option local_from_check main boolean true
15391 .cindex "&'Sender:'& header line" "disabling addition of"
15392 .cindex "&'From:'& header line" "disabling checking of"
15393 When a message is submitted locally (that is, not over a TCP/IP connection) by
15394 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15395 checks that the &'From:'& header line matches the login of the calling user and
15396 the domain specified by &%qualify_domain%&.
15397
15398 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15399 locally submitted message is automatically qualified by Exim, unless the
15400 &%-bnq%& command line option is used.
15401
15402 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15403 on the local part. If the &'From:'& header line does not match, Exim adds a
15404 &'Sender:'& header with an address constructed from the calling user's login
15405 and the default qualify domain.
15406
15407 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15408 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15409 &'Sender:'& header lines supplied by untrusted users, you must also set
15410 &%local_sender_retain%& to be true.
15411
15412 .cindex "envelope sender"
15413 These options affect only the header lines in the message. The envelope sender
15414 is still forced to be the login id at the qualify domain unless
15415 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15416
15417 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15418 request similar header line checking. See section &<<SECTthesenhea>>&, which
15419 has more details about &'Sender:'& processing.
15420
15421
15422
15423
15424 .option local_from_prefix main string unset
15425 When Exim checks the &'From:'& header line of locally submitted messages for
15426 matching the login id (see &%local_from_check%& above), it can be configured to
15427 ignore certain prefixes and suffixes in the local part of the address. This is
15428 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15429 appropriate lists, in the same form as the &%local_part_prefix%& and
15430 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15431 example, if
15432 .code
15433 local_from_prefix = *-
15434 .endd
15435 is set, a &'From:'& line containing
15436 .code
15437 From: anything-user@your.domain.example
15438 .endd
15439 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15440 matches the actual sender address that is constructed from the login name and
15441 qualify domain.
15442
15443
15444 .option local_from_suffix main string unset
15445 See &%local_from_prefix%& above.
15446
15447
15448 .option local_interfaces main "string list" "see below"
15449 This option controls which network interfaces are used by the daemon for
15450 listening; they are also used to identify the local host when routing. Chapter
15451 &<<CHAPinterfaces>>& contains a full description of this option and the related
15452 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15453 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15454 &%local_interfaces%& is
15455 .code
15456 local_interfaces = 0.0.0.0
15457 .endd
15458 when Exim is built without IPv6 support; otherwise it is
15459 .code
15460 local_interfaces = <; ::0 ; 0.0.0.0
15461 .endd
15462
15463 .option local_scan_timeout main time 5m
15464 .cindex "timeout" "for &[local_scan()]& function"
15465 .cindex "&[local_scan()]& function" "timeout"
15466 This timeout applies to the &[local_scan()]& function (see chapter
15467 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15468 the incoming message is rejected with a temporary error if it is an SMTP
15469 message. For a non-SMTP message, the message is dropped and Exim ends with a
15470 non-zero code. The incident is logged on the main and reject logs.
15471
15472
15473
15474 .option local_sender_retain main boolean false
15475 .cindex "&'Sender:'& header line" "retaining from local submission"
15476 When a message is submitted locally (that is, not over a TCP/IP connection) by
15477 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15478 do not want this to happen, you must set &%local_sender_retain%&, and you must
15479 also set &%local_from_check%& to be false (Exim will complain if you do not).
15480 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15481 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15482
15483
15484
15485
15486 .option localhost_number main string&!! unset
15487 .cindex "host" "locally unique number for"
15488 .cindex "message ids" "with multiple hosts"
15489 .vindex "&$localhost_number$&"
15490 Exim's message ids are normally unique only within the local host. If
15491 uniqueness among a set of hosts is required, each host must set a different
15492 value for the &%localhost_number%& option. The string is expanded immediately
15493 after reading the configuration file (so that a number can be computed from the
15494 host name, for example) and the result of the expansion must be a number in the
15495 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15496 systems). This is available in subsequent string expansions via the variable
15497 &$localhost_number$&. When &%localhost_number is set%&, the final two
15498 characters of the message id, instead of just being a fractional part of the
15499 time, are computed from the time and the local host number as described in
15500 section &<<SECTmessiden>>&.
15501
15502
15503
15504 .option log_file_path main "string list&!!" "set at compile time"
15505 .cindex "log" "file path for"
15506 This option sets the path which is used to determine the names of Exim's log
15507 files, or indicates that logging is to be to syslog, or both. It is expanded
15508 when Exim is entered, so it can, for example, contain a reference to the host
15509 name. If no specific path is set for the log files at compile or run time,
15510 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15511 they are written in a sub-directory called &_log_& in Exim's spool directory.
15512 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15513 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15514 used. If this string is fixed at your installation (contains no expansion
15515 variables) it is recommended that you do not set this option in the
15516 configuration file, but instead supply the path using LOG_FILE_PATH in
15517 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15518 early on &-- in particular, failure to read the configuration file.
15519
15520
15521 .option log_selector main string unset
15522 .cindex "log" "selectors"
15523 This option can be used to reduce or increase the number of things that Exim
15524 writes to its log files. Its argument is made up of names preceded by plus or
15525 minus characters. For example:
15526 .code
15527 log_selector = +arguments -retry_defer
15528 .endd
15529 A list of possible names and what they control is given in the chapter on
15530 logging, in section &<<SECTlogselector>>&.
15531
15532
15533 .option log_timezone main boolean false
15534 .cindex "log" "timezone for entries"
15535 .vindex "&$tod_log$&"
15536 .vindex "&$tod_zone$&"
15537 By default, the timestamps on log lines are in local time without the
15538 timezone. This means that if your timezone changes twice a year, the timestamps
15539 in log lines are ambiguous for an hour when the clocks go back. One way of
15540 avoiding this problem is to set the timezone to UTC. An alternative is to set
15541 &%log_timezone%& true. This turns on the addition of the timezone offset to
15542 timestamps in log lines. Turning on this option can add quite a lot to the size
15543 of log files because each line is extended by 6 characters. Note that the
15544 &$tod_log$& variable contains the log timestamp without the zone, but there is
15545 another variable called &$tod_zone$& that contains just the timezone offset.
15546
15547
15548 .option lookup_open_max main integer 25
15549 .cindex "too many open files"
15550 .cindex "open files, too many"
15551 .cindex "file" "too many open"
15552 .cindex "lookup" "maximum open files"
15553 .cindex "limit" "open files for lookups"
15554 This option limits the number of simultaneously open files for single-key
15555 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15556 Exim normally keeps these files open during routing, because often the same
15557 file is required several times. If the limit is reached, Exim closes the least
15558 recently used file. Note that if you are using the &'ndbm'& library, it
15559 actually opens two files for each logical DBM database, though it still counts
15560 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15561 open files"& errors with NDBM, you need to reduce the value of
15562 &%lookup_open_max%&.
15563
15564
15565 .option max_username_length main integer 0
15566 .cindex "length of login name"
15567 .cindex "user name" "maximum length"
15568 .cindex "limit" "user name length"
15569 Some operating systems are broken in that they truncate long arguments to
15570 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15571 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15572 an argument that is longer behaves as if &[getpwnam()]& failed.
15573
15574
15575 .option message_body_newlines main bool false
15576 .cindex "message body" "newlines in variables"
15577 .cindex "newline" "in message body variables"
15578 .vindex "&$message_body$&"
15579 .vindex "&$message_body_end$&"
15580 By default, newlines in the message body are replaced by spaces when setting
15581 the &$message_body$& and &$message_body_end$& expansion variables. If this
15582 option is set true, this no longer happens.
15583
15584
15585 .option message_body_visible main integer 500
15586 .cindex "body of message" "visible size"
15587 .cindex "message body" "visible size"
15588 .vindex "&$message_body$&"
15589 .vindex "&$message_body_end$&"
15590 This option specifies how much of a message's body is to be included in the
15591 &$message_body$& and &$message_body_end$& expansion variables.
15592
15593
15594 .option message_id_header_domain main string&!! unset
15595 .cindex "&'Message-ID:'& header line"
15596 If this option is set, the string is expanded and used as the right hand side
15597 (domain) of the &'Message-ID:'& header that Exim creates if a
15598 locally-originated incoming message does not have one. &"Locally-originated"&
15599 means &"not received over TCP/IP."&
15600 Otherwise, the primary host name is used.
15601 Only letters, digits, dot and hyphen are accepted; any other characters are
15602 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15603 empty string, the option is ignored.
15604
15605
15606 .option message_id_header_text main string&!! unset
15607 If this variable is set, the string is expanded and used to augment the text of
15608 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15609 message does not have one. The text of this header is required by RFC 2822 to
15610 take the form of an address. By default, Exim uses its internal message id as
15611 the local part, and the primary host name as the domain. If this option is set,
15612 it is expanded, and provided the expansion is not forced to fail, and does not
15613 yield an empty string, the result is inserted into the header immediately
15614 before the @, separated from the internal message id by a dot. Any characters
15615 that are illegal in an address are automatically converted into hyphens. This
15616 means that variables such as &$tod_log$& can be used, because the spaces and
15617 colons will become hyphens.
15618
15619
15620 .option message_logs main boolean true
15621 .cindex "message logs" "disabling"
15622 .cindex "log" "message log; disabling"
15623 If this option is turned off, per-message log files are not created in the
15624 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15625 Exim, by reducing the number of files involved in handling a message from a
15626 minimum of four (header spool file, body spool file, delivery journal, and
15627 per-message log) to three. The other major I/O activity is Exim's main log,
15628 which is not affected by this option.
15629
15630
15631 .option message_size_limit main string&!! 50M
15632 .cindex "message" "size limit"
15633 .cindex "limit" "message size"
15634 .cindex "size" "of message, limit"
15635 This option limits the maximum size of message that Exim will process. The
15636 value is expanded for each incoming connection so, for example, it can be made
15637 to depend on the IP address of the remote host for messages arriving via
15638 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15639 optionally followed by K or M.
15640
15641 &*Note*&: This limit cannot be made to depend on a message's sender or any
15642 other properties of an individual message, because it has to be advertised in
15643 the server's response to EHLO. String expansion failure causes a temporary
15644 error. A value of zero means no limit, but its use is not recommended. See also
15645 &%bounce_return_size_limit%&.
15646
15647 Incoming SMTP messages are failed with a 552 error if the limit is
15648 exceeded; locally-generated messages either get a stderr message or a delivery
15649 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15650 an oversized message is logged in both the main and the reject logs. See also
15651 the generic transport option &%message_size_limit%&, which limits the size of
15652 message that an individual transport can process.
15653
15654 If you use a virus-scanner and set this option to to a value larger than the
15655 maximum size that your virus-scanner is configured to support, you may get
15656 failures triggered by large mails.  The right size to configure for the
15657 virus-scanner depends upon what data is passed and the options in use but it's
15658 probably safest to just set it to a little larger than this value.  E.g., with a
15659 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15660 some problems may result.
15661
15662 A value of 0 will disable size limit checking; Exim will still advertise the
15663 SIZE extension in an EHLO response, but without a limit, so as to permit
15664 SMTP clients to still indicate the message size along with the MAIL verb.
15665
15666
15667 .option move_frozen_messages main boolean false
15668 .cindex "frozen messages" "moving"
15669 This option, which is available only if Exim has been built with the setting
15670 .code
15671 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15672 .endd
15673 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15674 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15675 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15676 standard utilities for handling such moved messages, and they do not show up in
15677 lists generated by &%-bp%& or by the Exim monitor.
15678
15679
15680 .option mua_wrapper main boolean false
15681 Setting this option true causes Exim to run in a very restrictive mode in which
15682 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15683 contains a full description of this facility.
15684
15685
15686
15687 .option mysql_servers main "string list" unset
15688 .cindex "MySQL" "server list"
15689 This option provides a list of MySQL servers and associated connection data, to
15690 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15691 option is available only if Exim has been built with MySQL support.
15692
15693
15694 .option never_users main "string list&!!" unset
15695 This option is expanded just once, at the start of Exim's processing. Local
15696 message deliveries are normally run in processes that are setuid to the
15697 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15698 It is usually desirable to prevent any deliveries from running as root, as a
15699 safety precaution.
15700
15701 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15702 list of users that must not be used for local deliveries. This list is fixed in
15703 the binary and cannot be overridden by the configuration file. By default, it
15704 contains just the single user name &"root"&. The &%never_users%& runtime option
15705 can be used to add more users to the fixed list.
15706
15707 If a message is to be delivered as one of the users on the fixed list or the
15708 &%never_users%& list, an error occurs, and delivery is deferred. A common
15709 example is
15710 .code
15711 never_users = root:daemon:bin
15712 .endd
15713 Including root is redundant if it is also on the fixed list, but it does no
15714 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15715 transport driver.
15716
15717
15718 .option openssl_options main "string list" "+no_sslv2 +single_dh_use +no_ticket"
15719 .cindex "OpenSSL "compatibility options"
15720 This option allows an administrator to adjust the SSL options applied
15721 by OpenSSL to connections.  It is given as a space-separated list of items,
15722 each one to be +added or -subtracted from the current value.
15723
15724 This option is only available if Exim is built against OpenSSL.  The values
15725 available for this option vary according to the age of your OpenSSL install.
15726 The &"all"& value controls a subset of flags which are available, typically
15727 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15728 list the values known on your system and Exim should support all the
15729 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15730 names lose the leading &"SSL_OP_"& and are lower-cased.
15731
15732 Note that adjusting the options can have severe impact upon the security of
15733 SSL as used by Exim.  It is possible to disable safety checks and shoot
15734 yourself in the foot in various unpleasant ways.  This option should not be
15735 adjusted lightly.  An unrecognised item will be detected at startup, by
15736 invoking Exim with the &%-bV%& flag.
15737
15738 The option affects Exim operating both as a server and as a client.
15739
15740 Historical note: prior to release 4.80, Exim defaulted this value to
15741 "+dont_insert_empty_fragments", which may still be needed for compatibility
15742 with some clients, but which lowers security by increasing exposure to
15743 some now infamous attacks.
15744
15745 Examples:
15746 .code
15747 # Make both old MS and old Eudora happy:
15748 openssl_options = -all +microsoft_big_sslv3_buffer \
15749                        +dont_insert_empty_fragments
15750
15751 # Disable older protocol versions:
15752 openssl_options = +no_sslv2 +no_sslv3
15753 .endd
15754
15755 Possible options may include:
15756 .ilist
15757 &`all`&
15758 .next
15759 &`allow_unsafe_legacy_renegotiation`&
15760 .next
15761 &`cipher_server_preference`&
15762 .next
15763 &`dont_insert_empty_fragments`&
15764 .next
15765 &`ephemeral_rsa`&
15766 .next
15767 &`legacy_server_connect`&
15768 .next
15769 &`microsoft_big_sslv3_buffer`&
15770 .next
15771 &`microsoft_sess_id_bug`&
15772 .next
15773 &`msie_sslv2_rsa_padding`&
15774 .next
15775 &`netscape_challenge_bug`&
15776 .next
15777 &`netscape_reuse_cipher_change_bug`&
15778 .next
15779 &`no_compression`&
15780 .next
15781 &`no_session_resumption_on_renegotiation`&
15782 .next
15783 &`no_sslv2`&
15784 .next
15785 &`no_sslv3`&
15786 .next
15787 &`no_ticket`&
15788 .next
15789 &`no_tlsv1`&
15790 .next
15791 &`no_tlsv1_1`&
15792 .next
15793 &`no_tlsv1_2`&
15794 .next
15795 &`safari_ecdhe_ecdsa_bug`&
15796 .next
15797 &`single_dh_use`&
15798 .next
15799 &`single_ecdh_use`&
15800 .next
15801 &`ssleay_080_client_dh_bug`&
15802 .next
15803 &`sslref2_reuse_cert_type_bug`&
15804 .next
15805 &`tls_block_padding_bug`&
15806 .next
15807 &`tls_d5_bug`&
15808 .next
15809 &`tls_rollback_bug`&
15810 .endlist
15811
15812 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15813 all clients connecting using the MacOS SecureTransport TLS facility prior
15814 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15815 to negotiate TLS then this option value might help, provided that your OpenSSL
15816 release is new enough to contain this work-around.  This may be a situation
15817 where you have to upgrade OpenSSL to get buggy clients working.
15818
15819
15820 .option oracle_servers main "string list" unset
15821 .cindex "Oracle" "server list"
15822 This option provides a list of Oracle servers and associated connection data,
15823 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15824 The option is available only if Exim has been built with Oracle support.
15825
15826
15827 .option percent_hack_domains main "domain list&!!" unset
15828 .cindex "&""percent hack""&"
15829 .cindex "source routing" "in email address"
15830 .cindex "address" "source-routed"
15831 The &"percent hack"& is the convention whereby a local part containing a
15832 percent sign is re-interpreted as a new email address, with the percent
15833 replaced by @. This is sometimes called &"source routing"&, though that term is
15834 also applied to RFC 2822 addresses that begin with an @ character. If this
15835 option is set, Exim implements the percent facility for those domains listed,
15836 but no others. This happens before an incoming SMTP address is tested against
15837 an ACL.
15838
15839 &*Warning*&: The &"percent hack"& has often been abused by people who are
15840 trying to get round relaying restrictions. For this reason, it is best avoided
15841 if at all possible. Unfortunately, a number of less security-conscious MTAs
15842 implement it unconditionally. If you are running Exim on a gateway host, and
15843 routing mail through to internal MTAs without processing the local parts, it is
15844 a good idea to reject recipient addresses with percent characters in their
15845 local parts. Exim's default configuration does this.
15846
15847
15848 .option perl_at_start main boolean false
15849 .cindex "Perl"
15850 This option is available only when Exim is built with an embedded Perl
15851 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15852
15853
15854 .option perl_startup main string unset
15855 .cindex "Perl"
15856 This option is available only when Exim is built with an embedded Perl
15857 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15858
15859 .option perl_startup main boolean false
15860 .cindex "Perl"
15861 This Option enables the taint mode of the embedded Perl interpreter.
15862
15863
15864 .option pgsql_servers main "string list" unset
15865 .cindex "PostgreSQL lookup type" "server list"
15866 This option provides a list of PostgreSQL servers and associated connection
15867 data, to be used in conjunction with &(pgsql)& lookups (see section
15868 &<<SECID72>>&). The option is available only if Exim has been built with
15869 PostgreSQL support.
15870
15871
15872 .option pid_file_path main string&!! "set at compile time"
15873 .cindex "daemon" "pid file path"
15874 .cindex "pid file, path for"
15875 This option sets the name of the file to which the Exim daemon writes its
15876 process id. The string is expanded, so it can contain, for example, references
15877 to the host name:
15878 .code
15879 pid_file_path = /var/log/$primary_hostname/exim.pid
15880 .endd
15881 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15882 spool directory.
15883 The value set by the option can be overridden by the &%-oP%& command line
15884 option. A pid file is not written if a &"non-standard"& daemon is run by means
15885 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15886
15887
15888 .option pipelining_advertise_hosts main "host list&!!" *
15889 .cindex "PIPELINING" "suppressing advertising"
15890 This option can be used to suppress the advertisement of the SMTP
15891 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15892 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15893 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15894 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15895 that clients will use it; &"out of order"& commands that are &"expected"& do
15896 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15897
15898
15899 .option prdr_enable main boolean false
15900 .cindex "PRDR" "enabling on server"
15901 This option can be used to enable the Per-Recipient Data Response extension
15902 to SMTP, defined by Eric Hall.
15903 If the option is set, PRDR is advertised by Exim when operating as a server.
15904 If the client requests PRDR, and more than one recipient, for a message
15905 an additional ACL is called for each recipient after the message content
15906 is received.  See section &<<SECTPRDRACL>>&.
15907
15908 .option preserve_message_logs main boolean false
15909 .cindex "message logs" "preserving"
15910 If this option is set, message log files are not deleted when messages are
15911 completed. Instead, they are moved to a sub-directory of the spool directory
15912 called &_msglog.OLD_&, where they remain available for statistical or debugging
15913 purposes. This is a dangerous option to set on systems with any appreciable
15914 volume of mail. Use with care!
15915
15916
15917 .option primary_hostname main string "see below"
15918 .cindex "name" "of local host"
15919 .cindex "host" "name of local"
15920 .cindex "local host" "name of"
15921 .vindex "&$primary_hostname$&"
15922 This specifies the name of the current host. It is used in the default EHLO or
15923 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15924 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15925 The value is also used by default in some SMTP response messages from an Exim
15926 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15927
15928 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15929 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15930 contains only one component, Exim passes it to &[gethostbyname()]& (or
15931 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15932 version. The variable &$primary_hostname$& contains the host name, whether set
15933 explicitly by this option, or defaulted.
15934
15935
15936 .option print_topbitchars main boolean false
15937 .cindex "printing characters"
15938 .cindex "8-bit characters"
15939 By default, Exim considers only those characters whose codes lie in the range
15940 32&--126 to be printing characters. In a number of circumstances (for example,
15941 when writing log entries) non-printing characters are converted into escape
15942 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15943 is set, code values of 128 and above are also considered to be printing
15944 characters.
15945
15946 This option also affects the header syntax checks performed by the
15947 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15948 the user's full name when constructing From: and Sender: addresses (as
15949 described in section &<<SECTconstr>>&). Setting this option can cause
15950 Exim to generate eight bit message headers that do not conform to the
15951 standards.
15952
15953
15954 .option process_log_path main string unset
15955 .cindex "process log path"
15956 .cindex "log" "process log"
15957 .cindex "&'exiwhat'&"
15958 This option sets the name of the file to which an Exim process writes its
15959 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15960 utility script. If this option is unset, the file called &_exim-process.info_&
15961 in Exim's spool directory is used. The ability to specify the name explicitly
15962 can be useful in environments where two different Exims are running, using
15963 different spool directories.
15964
15965
15966 .option prod_requires_admin main boolean true
15967 .cindex "restricting access to features"
15968 .oindex "&%-M%&"
15969 .oindex "&%-R%&"
15970 .oindex "&%-q%&"
15971 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15972 admin user unless &%prod_requires_admin%& is set false. See also
15973 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
15974
15975
15976 .option qualify_domain main string "see below"
15977 .cindex "domain" "for qualifying addresses"
15978 .cindex "address" "qualification"
15979 This option specifies the domain name that is added to any envelope sender
15980 addresses that do not have a domain qualification. It also applies to
15981 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15982 are accepted by default only for locally-generated messages. Qualification is
15983 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15984 locally-generated messages, unless the &%-bnq%& command line option is used.
15985
15986 Messages from external sources must always contain fully qualified addresses,
15987 unless the sending host matches &%sender_unqualified_hosts%& or
15988 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15989 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15990 necessary. Internally, Exim always works with fully qualified envelope
15991 addresses. If &%qualify_domain%& is not set, it defaults to the
15992 &%primary_hostname%& value.
15993
15994
15995 .option qualify_recipient main string "see below"
15996 This option allows you to specify a different domain for qualifying recipient
15997 addresses to the one that is used for senders. See &%qualify_domain%& above.
15998
15999
16000
16001 .option queue_domains main "domain list&!!" unset
16002 .cindex "domain" "specifying non-immediate delivery"
16003 .cindex "queueing incoming messages"
16004 .cindex "message" "queueing certain domains"
16005 This option lists domains for which immediate delivery is not required.
16006 A delivery process is started whenever a message is received, but only those
16007 domains that do not match are processed. All other deliveries wait until the
16008 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16009
16010
16011 .option queue_list_requires_admin main boolean true
16012 .cindex "restricting access to features"
16013 .oindex "&%-bp%&"
16014 The &%-bp%& command-line option, which lists the messages that are on the
16015 queue, requires the caller to be an admin user unless
16016 &%queue_list_requires_admin%& is set false.
16017 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16018
16019
16020 .option queue_only main boolean false
16021 .cindex "queueing incoming messages"
16022 .cindex "message" "queueing unconditionally"
16023 If &%queue_only%& is set, a delivery process is not automatically started
16024 whenever a message is received. Instead, the message waits on the queue for the
16025 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16026 delivered immediately when certain conditions (such as heavy load) occur.
16027
16028 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16029 and &%-odi%& command line options override &%queue_only%& unless
16030 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16031 &%queue_only_load%&, and &%smtp_accept_queue%&.
16032
16033
16034 .option queue_only_file main string unset
16035 .cindex "queueing incoming messages"
16036 .cindex "message" "queueing by file existence"
16037 This option can be set to a colon-separated list of absolute path names, each
16038 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16039 it tests for the existence of each listed path using a call to &[stat()]&. For
16040 each path that exists, the corresponding queueing option is set.
16041 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16042 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16043 .code
16044 queue_only_file = smtp/some/file
16045 .endd
16046 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16047 &_/some/file_& exists.
16048
16049
16050 .option queue_only_load main fixed-point unset
16051 .cindex "load average"
16052 .cindex "queueing incoming messages"
16053 .cindex "message" "queueing by load"
16054 If the system load average is higher than this value, incoming messages from
16055 all sources are queued, and no automatic deliveries are started. If this
16056 happens during local or remote SMTP input, all subsequent messages received on
16057 the same SMTP connection are queued by default, whatever happens to the load in
16058 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16059 false.
16060
16061 Deliveries will subsequently be performed by queue runner processes. This
16062 option has no effect on ancient operating systems on which Exim cannot
16063 determine the load average. See also &%deliver_queue_load_max%& and
16064 &%smtp_load_reserve%&.
16065
16066
16067 .option queue_only_load_latch main boolean true
16068 .cindex "load average" "re-evaluating per message"
16069 When this option is true (the default), once one message has been queued
16070 because the load average is higher than the value set by &%queue_only_load%&,
16071 all subsequent messages received on the same SMTP connection are also queued.
16072 This is a deliberate choice; even though the load average may fall below the
16073 threshold, it doesn't seem right to deliver later messages on the same
16074 connection when not delivering earlier ones. However, there are special
16075 circumstances such as very long-lived connections from scanning appliances
16076 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16077 should be set false. This causes the value of the load average to be
16078 re-evaluated for each message.
16079
16080
16081 .option queue_only_override main boolean true
16082 .cindex "queueing incoming messages"
16083 When this option is true, the &%-od%&&'x'& command line options override the
16084 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16085 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16086 to override; they are accepted, but ignored.
16087
16088
16089 .option queue_run_in_order main boolean false
16090 .cindex "queue runner" "processing messages in order"
16091 If this option is set, queue runs happen in order of message arrival instead of
16092 in an arbitrary order. For this to happen, a complete list of the entire queue
16093 must be set up before the deliveries start. When the queue is all held in a
16094 single directory (the default), a single list is created for both the ordered
16095 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16096 single list is not created when &%queue_run_in_order%& is false. In this case,
16097 the sub-directories are processed one at a time (in a random order), and this
16098 avoids setting up one huge list for the whole queue. Thus, setting
16099 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16100 when the queue is large, because of the extra work in setting up the single,
16101 large list. In most situations, &%queue_run_in_order%& should not be set.
16102
16103
16104
16105 .option queue_run_max main integer&!! 5
16106 .cindex "queue runner" "maximum number of"
16107 This controls the maximum number of queue runner processes that an Exim daemon
16108 can run simultaneously. This does not mean that it starts them all at once,
16109 but rather that if the maximum number are still running when the time comes to
16110 start another one, it refrains from starting another one. This can happen with
16111 very large queues and/or very sluggish deliveries. This option does not,
16112 however, interlock with other processes, so additional queue runners can be
16113 started by other means, or by killing and restarting the daemon.
16114
16115 Setting this option to zero does not suppress queue runs; rather, it disables
16116 the limit, allowing any number of simultaneous queue runner processes to be
16117 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16118 the daemon's command line.
16119
16120 .cindex queues named
16121 .cindex "named queues"
16122 To set limits for different named queues use
16123 an expansion depending on the &$queue_name$& variable.
16124
16125 .option queue_smtp_domains main "domain list&!!" unset
16126 .cindex "queueing incoming messages"
16127 .cindex "message" "queueing remote deliveries"
16128 When this option is set, a delivery process is started whenever a message is
16129 received, routing is performed, and local deliveries take place.
16130 However, if any SMTP deliveries are required for domains that match
16131 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16132 message waits on the queue for the next queue run. Since routing of the message
16133 has taken place, Exim knows to which remote hosts it must be delivered, and so
16134 when the queue run happens, multiple messages for the same host are delivered
16135 over a single SMTP connection. The &%-odqs%& command line option causes all
16136 SMTP deliveries to be queued in this way, and is equivalent to setting
16137 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16138 &%queue_domains%&.
16139
16140
16141 .option receive_timeout main time 0s
16142 .cindex "timeout" "for non-SMTP input"
16143 This option sets the timeout for accepting a non-SMTP message, that is, the
16144 maximum time that Exim waits when reading a message on the standard input. If
16145 the value is zero, it will wait for ever. This setting is overridden by the
16146 &%-or%& command line option. The timeout for incoming SMTP messages is
16147 controlled by &%smtp_receive_timeout%&.
16148
16149 .option received_header_text main string&!! "see below"
16150 .cindex "customizing" "&'Received:'& header"
16151 .cindex "&'Received:'& header line" "customizing"
16152 This string defines the contents of the &'Received:'& message header that is
16153 added to each message, except for the timestamp, which is automatically added
16154 on at the end (preceded by a semicolon). The string is expanded each time it is
16155 used. If the expansion yields an empty string, no &'Received:'& header line is
16156 added to the message. Otherwise, the string should start with the text
16157 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16158 header lines. The default setting is:
16159
16160 .code
16161 received_header_text = Received: \
16162   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16163   {${if def:sender_ident \
16164   {from ${quote_local_part:$sender_ident} }}\
16165   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16166   by $primary_hostname \
16167   ${if def:received_protocol {with $received_protocol}} \
16168   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16169   (Exim $version_number)\n\t\
16170   ${if def:sender_address \
16171   {(envelope-from <$sender_address>)\n\t}}\
16172   id $message_exim_id\
16173   ${if def:received_for {\n\tfor $received_for}}
16174 .endd
16175
16176 The reference to the TLS cipher is omitted when Exim is built without TLS
16177 support. The use of conditional expansions ensures that this works for both
16178 locally generated messages and messages received from remote hosts, giving
16179 header lines such as the following:
16180 .code
16181 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16182 by marley.carol.example with esmtp (Exim 4.00)
16183 (envelope-from <bob@carol.example>)
16184 id 16IOWa-00019l-00
16185 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16186 Received: by scrooge.carol.example with local (Exim 4.00)
16187 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16188 .endd
16189 Until the body of the message has been received, the timestamp is the time when
16190 the message started to be received. Once the body has arrived, and all policy
16191 checks have taken place, the timestamp is updated to the time at which the
16192 message was accepted.
16193
16194
16195 .option received_headers_max main integer 30
16196 .cindex "loop" "prevention"
16197 .cindex "mail loop prevention"
16198 .cindex "&'Received:'& header line" "counting"
16199 When a message is to be delivered, the number of &'Received:'& headers is
16200 counted, and if it is greater than this parameter, a mail loop is assumed to
16201 have occurred, the delivery is abandoned, and an error message is generated.
16202 This applies to both local and remote deliveries.
16203
16204
16205 .option recipient_unqualified_hosts main "host list&!!" unset
16206 .cindex "unqualified addresses"
16207 .cindex "host" "unqualified addresses from"
16208 This option lists those hosts from which Exim is prepared to accept unqualified
16209 recipient addresses in message envelopes. The addresses are made fully
16210 qualified by the addition of the &%qualify_recipient%& value. This option also
16211 affects message header lines. Exim does not reject unqualified recipient
16212 addresses in headers, but it qualifies them only if the message came from a
16213 host that matches &%recipient_unqualified_hosts%&,
16214 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16215 option was not set.
16216
16217
16218 .option recipients_max main integer 0
16219 .cindex "limit" "number of recipients"
16220 .cindex "recipient" "maximum number"
16221 If this option is set greater than zero, it specifies the maximum number of
16222 original recipients for any message. Additional recipients that are generated
16223 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16224 all recipients over the limit; earlier recipients are delivered as normal.
16225 Non-SMTP messages with too many recipients are failed, and no deliveries are
16226 done.
16227
16228 .cindex "RCPT" "maximum number of incoming"
16229 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16230 RCPT commands in a single message.
16231
16232
16233 .option recipients_max_reject main boolean false
16234 If this option is set true, Exim rejects SMTP messages containing too many
16235 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16236 error to the eventual DATA command. Otherwise (the default) it gives a 452
16237 error to the surplus RCPT commands and accepts the message on behalf of the
16238 initial set of recipients. The remote server should then re-send the message
16239 for the remaining recipients at a later time.
16240
16241
16242 .option remote_max_parallel main integer 2
16243 .cindex "delivery" "parallelism for remote"
16244 This option controls parallel delivery of one message to a number of remote
16245 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16246 does all the remote deliveries for a message one by one. Otherwise, if a single
16247 message has to be delivered to more than one remote host, or if several copies
16248 have to be sent to the same remote host, up to &%remote_max_parallel%&
16249 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16250 deliveries are required, the maximum number of processes are started, and as
16251 each one finishes, another is begun. The order of starting processes is the
16252 same as if sequential delivery were being done, and can be controlled by the
16253 &%remote_sort_domains%& option. If parallel delivery takes place while running
16254 with debugging turned on, the debugging output from each delivery process is
16255 tagged with its process id.
16256
16257 This option controls only the maximum number of parallel deliveries for one
16258 message in one Exim delivery process. Because Exim has no central queue
16259 manager, there is no way of controlling the total number of simultaneous
16260 deliveries if the configuration allows a delivery attempt as soon as a message
16261 is received.
16262
16263 .cindex "number of deliveries"
16264 .cindex "delivery" "maximum number of"
16265 If you want to control the total number of deliveries on the system, you
16266 need to set the &%queue_only%& option. This ensures that all incoming messages
16267 are added to the queue without starting a delivery process. Then set up an Exim
16268 daemon to start queue runner processes at appropriate intervals (probably
16269 fairly often, for example, every minute), and limit the total number of queue
16270 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16271 delivers only one message at a time, the maximum number of deliveries that can
16272 then take place at once is &%queue_run_max%& multiplied by
16273 &%remote_max_parallel%&.
16274
16275 If it is purely remote deliveries you want to control, use
16276 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16277 doing the SMTP routing before queueing, so that several messages for the same
16278 host will eventually get delivered down the same connection.
16279
16280
16281 .option remote_sort_domains main "domain list&!!" unset
16282 .cindex "sorting remote deliveries"
16283 .cindex "delivery" "sorting remote"
16284 When there are a number of remote deliveries for a message, they are sorted by
16285 domain into the order given by this list. For example,
16286 .code
16287 remote_sort_domains = *.cam.ac.uk:*.uk
16288 .endd
16289 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16290 then to those in the &%uk%& domain, then to any others.
16291
16292
16293 .option retry_data_expire main time 7d
16294 .cindex "hints database" "data expiry"
16295 This option sets a &"use before"& time on retry information in Exim's hints
16296 database. Any older retry data is ignored. This means that, for example, once a
16297 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16298 past failures.
16299
16300
16301 .option retry_interval_max main time 24h
16302 .cindex "retry" "limit on interval"
16303 .cindex "limit" "on retry interval"
16304 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16305 intervals between delivery attempts for messages that cannot be delivered
16306 straight away. This option sets an overall limit to the length of time between
16307 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16308 the default value.
16309
16310
16311 .option return_path_remove main boolean true
16312 .cindex "&'Return-path:'& header line" "removing"
16313 RFC 2821, section 4.4, states that an SMTP server must insert a
16314 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16315 The &'Return-path:'& header preserves the sender address as received in the
16316 MAIL command. This description implies that this header should not be present
16317 in an incoming message. If &%return_path_remove%& is true, any existing
16318 &'Return-path:'& headers are removed from messages at the time they are
16319 received. Exim's transports have options for adding &'Return-path:'& headers at
16320 the time of delivery. They are normally used only for final local deliveries.
16321
16322
16323 .option return_size_limit main integer 100K
16324 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16325
16326
16327 .option rfc1413_hosts main "host list&!!" @[]
16328 .cindex "RFC 1413"
16329 .cindex "host" "for RFC 1413 calls"
16330 RFC 1413 identification calls are made to any client host which matches
16331 an item in the list.
16332 The default value specifies just this host, being any local interface
16333 for the system.
16334
16335 .option rfc1413_query_timeout main time 0s
16336 .cindex "RFC 1413" "query timeout"
16337 .cindex "timeout" "for RFC 1413 call"
16338 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16339 no RFC 1413 calls are ever made.
16340
16341
16342 .option sender_unqualified_hosts main "host list&!!" unset
16343 .cindex "unqualified addresses"
16344 .cindex "host" "unqualified addresses from"
16345 This option lists those hosts from which Exim is prepared to accept unqualified
16346 sender addresses. The addresses are made fully qualified by the addition of
16347 &%qualify_domain%&. This option also affects message header lines. Exim does
16348 not reject unqualified addresses in headers that contain sender addresses, but
16349 it qualifies them only if the message came from a host that matches
16350 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16351 using TCP/IP), and the &%-bnq%& option was not set.
16352
16353 .option set_environment main "string list" empty
16354 .cindex "environment"
16355 This option allows to set individual environment variables that the
16356 currently linked libraries and programs in child processes use. The
16357 default list is empty,
16358
16359
16360 .option slow_lookup_log main integer 0
16361 .cindex "logging" "slow lookups"
16362 .cindex "dns" "logging slow lookups"
16363 This option controls logging of slow lookups.
16364 If the value is nonzero it is taken as a number of milliseconds
16365 and lookups taking longer than this are logged.
16366 Currently this applies only to DNS lookups.
16367
16368
16369
16370 .option smtp_accept_keepalive main boolean true
16371 .cindex "keepalive" "on incoming connection"
16372 This option controls the setting of the SO_KEEPALIVE option on incoming
16373 TCP/IP socket connections. When set, it causes the kernel to probe idle
16374 connections periodically, by sending packets with &"old"& sequence numbers. The
16375 other end of the connection should send an acknowledgment if the connection is
16376 still okay or a reset if the connection has been aborted. The reason for doing
16377 this is that it has the beneficial effect of freeing up certain types of
16378 connection that can get stuck when the remote host is disconnected without
16379 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16380 hours to detect unreachable hosts.
16381
16382
16383
16384 .option smtp_accept_max main integer 20
16385 .cindex "limit" "incoming SMTP connections"
16386 .cindex "SMTP" "incoming connection count"
16387 .cindex "inetd"
16388 This option specifies the maximum number of simultaneous incoming SMTP calls
16389 that Exim will accept. It applies only to the listening daemon; there is no
16390 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16391 value is set to zero, no limit is applied. However, it is required to be
16392 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16393 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16394
16395 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16396 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16397 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16398 and &%smtp_load_reserve%& are then checked before accepting the connection.
16399
16400
16401 .option smtp_accept_max_nonmail main integer 10
16402 .cindex "limit" "non-mail SMTP commands"
16403 .cindex "SMTP" "limiting non-mail commands"
16404 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16405 the connection if there are too many. This option defines &"too many"&. The
16406 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16407 client looping sending EHLO, for example. The check is applied only if the
16408 client host matches &%smtp_accept_max_nonmail_hosts%&.
16409
16410 When a new message is expected, one occurrence of RSET is not counted. This
16411 allows a client to send one RSET between messages (this is not necessary,
16412 but some clients do it). Exim also allows one uncounted occurrence of HELO
16413 or EHLO, and one occurrence of STARTTLS between messages. After
16414 starting up a TLS session, another EHLO is expected, and so it too is not
16415 counted. The first occurrence of AUTH in a connection, or immediately
16416 following STARTTLS is not counted. Otherwise, all commands other than
16417 MAIL, RCPT, DATA, and QUIT are counted.
16418
16419
16420 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16421 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16422 check by setting this option. The default value makes it apply to all hosts. By
16423 changing the value, you can exclude any badly-behaved hosts that you have to
16424 live with.
16425
16426
16427 . Allow this long option name to split; give it unsplit as a fifth argument
16428 . for the automatic .oindex that is generated by .option.
16429 . We insert " &~&~" which is both pretty nasty visually and results in
16430 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16431 . zero-width-space, which would be nicer visually and results in (at least)
16432 . html that Firefox will split on when it's forced to reflow (rather than
16433 . inserting a horizontal scrollbar).  However, the text is still not
16434 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16435 . the option name to split.
16436
16437 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16438          smtp_accept_max_per_connection
16439 .cindex "SMTP" "limiting incoming message count"
16440 .cindex "limit" "messages per SMTP connection"
16441 The value of this option limits the number of MAIL commands that Exim is
16442 prepared to accept over a single SMTP connection, whether or not each command
16443 results in the transfer of a message. After the limit is reached, a 421
16444 response is given to subsequent MAIL commands. This limit is a safety
16445 precaution against a client that goes mad (incidents of this type have been
16446 seen).
16447
16448
16449 .option smtp_accept_max_per_host main string&!! unset
16450 .cindex "limit" "SMTP connections from one host"
16451 .cindex "host" "limiting SMTP connections from"
16452 This option restricts the number of simultaneous IP connections from a single
16453 host (strictly, from a single IP address) to the Exim daemon. The option is
16454 expanded, to enable different limits to be applied to different hosts by
16455 reference to &$sender_host_address$&. Once the limit is reached, additional
16456 connection attempts from the same host are rejected with error code 421. This
16457 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16458 of zero imposes no limit. If this option is set greater than zero, it is
16459 required that &%smtp_accept_max%& be non-zero.
16460
16461 &*Warning*&: When setting this option you should not use any expansion
16462 constructions that take an appreciable amount of time. The expansion and test
16463 happen in the main daemon loop, in order to reject additional connections
16464 without forking additional processes (otherwise a denial-of-service attack
16465 could cause a vast number or processes to be created). While the daemon is
16466 doing this processing, it cannot accept any other incoming connections.
16467
16468
16469
16470 .option smtp_accept_queue main integer 0
16471 .cindex "SMTP" "incoming connection count"
16472 .cindex "queueing incoming messages"
16473 .cindex "message" "queueing by SMTP connection count"
16474 If the number of simultaneous incoming SMTP connections being handled via the
16475 listening daemon exceeds this value, messages received by SMTP are just placed
16476 on the queue; no delivery processes are started automatically. The count is
16477 fixed at the start of an SMTP connection. It cannot be updated in the
16478 subprocess that receives messages, and so the queueing or not queueing applies
16479 to all messages received in the same connection.
16480
16481 A value of zero implies no limit, and clearly any non-zero value is useful only
16482 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16483 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16484 various &%-od%&&'x'& command line options.
16485
16486
16487 . See the comment on smtp_accept_max_per_connection
16488
16489 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16490          smtp_accept_queue_per_connection
16491 .cindex "queueing incoming messages"
16492 .cindex "message" "queueing by message count"
16493 This option limits the number of delivery processes that Exim starts
16494 automatically when receiving messages via SMTP, whether via the daemon or by
16495 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16496 and the number of messages received in a single SMTP session exceeds this
16497 number, subsequent messages are placed on the queue, but no delivery processes
16498 are started. This helps to limit the number of Exim processes when a server
16499 restarts after downtime and there is a lot of mail waiting for it on other
16500 systems. On large systems, the default should probably be increased, and on
16501 dial-in client systems it should probably be set to zero (that is, disabled).
16502
16503
16504 .option smtp_accept_reserve main integer 0
16505 .cindex "SMTP" "incoming call count"
16506 .cindex "host" "reserved"
16507 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16508 number of SMTP connections that are reserved for connections from the hosts
16509 that are specified in &%smtp_reserve_hosts%&. The value set in
16510 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16511 restricted to this number of connections; the option specifies a minimum number
16512 of connection slots for them, not a maximum. It is a guarantee that this group
16513 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16514 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16515 individual host.
16516
16517 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16518 set to 5, once there are 45 active connections (from any hosts), new
16519 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16520 provided the other criteria for acceptance are met.
16521
16522
16523 .option smtp_active_hostname main string&!! unset
16524 .cindex "host" "name in SMTP responses"
16525 .cindex "SMTP" "host name in responses"
16526 .vindex "&$primary_hostname$&"
16527 This option is provided for multi-homed servers that want to masquerade as
16528 several different hosts. At the start of an incoming SMTP connection, its value
16529 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16530 responses. For example, it is used as domain name in the response to an
16531 incoming HELO or EHLO command.
16532
16533 .vindex "&$smtp_active_hostname$&"
16534 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16535 is saved with any messages that are received. It is therefore available for use
16536 in routers and transports when the message is later delivered.
16537
16538 If this option is unset, or if its expansion is forced to fail, or if the
16539 expansion results in an empty string, the value of &$primary_hostname$& is
16540 used. Other expansion failures cause a message to be written to the main and
16541 panic logs, and the SMTP command receives a temporary error. Typically, the
16542 value of &%smtp_active_hostname%& depends on the incoming interface address.
16543 For example:
16544 .code
16545 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16546   {cox.mydomain}{box.mydomain}}
16547 .endd
16548
16549 Although &$smtp_active_hostname$& is primarily concerned with incoming
16550 messages, it is also used as the default for HELO commands in callout
16551 verification if there is no remote transport from which to obtain a
16552 &%helo_data%& value.
16553
16554 .option smtp_banner main string&!! "see below"
16555 .cindex "SMTP" "welcome banner"
16556 .cindex "banner for SMTP"
16557 .cindex "welcome banner for SMTP"
16558 .cindex "customizing" "SMTP banner"
16559 This string, which is expanded every time it is used, is output as the initial
16560 positive response to an SMTP connection. The default setting is:
16561 .code
16562 smtp_banner = $smtp_active_hostname ESMTP Exim \
16563   $version_number $tod_full
16564 .endd
16565 Failure to expand the string causes a panic error. If you want to create a
16566 multiline response to the initial SMTP connection, use &"\n"& in the string at
16567 appropriate points, but not at the end. Note that the 220 code is not included
16568 in this string. Exim adds it automatically (several times in the case of a
16569 multiline response).
16570
16571
16572 .option smtp_check_spool_space main boolean true
16573 .cindex "checking disk space"
16574 .cindex "disk space, checking"
16575 .cindex "spool directory" "checking space"
16576 When this option is set, if an incoming SMTP session encounters the SIZE
16577 option on a MAIL command, it checks that there is enough space in the
16578 spool directory's partition to accept a message of that size, while still
16579 leaving free the amount specified by &%check_spool_space%& (even if that value
16580 is zero). If there isn't enough space, a temporary error code is returned.
16581
16582
16583 .option smtp_connect_backlog main integer 20
16584 .cindex "connection backlog"
16585 .cindex "SMTP" "connection backlog"
16586 .cindex "backlog of connections"
16587 This option specifies a maximum number of waiting SMTP connections. Exim passes
16588 this value to the TCP/IP system when it sets up its listener. Once this number
16589 of connections are waiting for the daemon's attention, subsequent connection
16590 attempts are refused at the TCP/IP level. At least, that is what the manuals
16591 say; in some circumstances such connection attempts have been observed to time
16592 out instead. For large systems it is probably a good idea to increase the
16593 value (to 50, say). It also gives some protection against denial-of-service
16594 attacks by SYN flooding.
16595
16596
16597 .option smtp_enforce_sync main boolean true
16598 .cindex "SMTP" "synchronization checking"
16599 .cindex "synchronization checking in SMTP"
16600 The SMTP protocol specification requires the client to wait for a response from
16601 the server at certain points in the dialogue. Without PIPELINING these
16602 synchronization points are after every command; with PIPELINING they are
16603 fewer, but they still exist.
16604
16605 Some spamming sites send out a complete set of SMTP commands without waiting
16606 for any response. Exim protects against this by rejecting a message if the
16607 client has sent further input when it should not have. The error response &"554
16608 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16609 for this error cannot be perfect because of transmission delays (unexpected
16610 input may be on its way but not yet received when Exim checks). However, it
16611 does detect many instances.
16612
16613 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16614 If you want to disable the check selectively (for example, only for certain
16615 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16616 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16617
16618
16619
16620 .option smtp_etrn_command main string&!! unset
16621 .cindex "ETRN" "command to be run"
16622 .vindex "&$domain$&"
16623 If this option is set, the given command is run whenever an SMTP ETRN
16624 command is received from a host that is permitted to issue such commands (see
16625 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16626 are independently expanded. The expansion variable &$domain$& is set to the
16627 argument of the ETRN command, and no syntax checking is done on it. For
16628 example:
16629 .code
16630 smtp_etrn_command = /etc/etrn_command $domain \
16631                     $sender_host_address
16632 .endd
16633 A new process is created to run the command, but Exim does not wait for it to
16634 complete. Consequently, its status cannot be checked. If the command cannot be
16635 run, a line is written to the panic log, but the ETRN caller still receives
16636 a 250 success response. Exim is normally running under its own uid when
16637 receiving SMTP, so it is not possible for it to change the uid before running
16638 the command.
16639
16640
16641 .option smtp_etrn_serialize main boolean true
16642 .cindex "ETRN" "serializing"
16643 When this option is set, it prevents the simultaneous execution of more than
16644 one identical command as a result of ETRN in an SMTP connection. See
16645 section &<<SECTETRN>>& for details.
16646
16647
16648 .option smtp_load_reserve main fixed-point unset
16649 .cindex "load average"
16650 If the system load average ever gets higher than this, incoming SMTP calls are
16651 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16652 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16653 the load is over the limit. The option has no effect on ancient operating
16654 systems on which Exim cannot determine the load average. See also
16655 &%deliver_queue_load_max%& and &%queue_only_load%&.
16656
16657
16658
16659 .option smtp_max_synprot_errors main integer 3
16660 .cindex "SMTP" "limiting syntax and protocol errors"
16661 .cindex "limit" "SMTP syntax and protocol errors"
16662 Exim rejects SMTP commands that contain syntax or protocol errors. In
16663 particular, a syntactically invalid email address, as in this command:
16664 .code
16665 RCPT TO:<abc xyz@a.b.c>
16666 .endd
16667 causes immediate rejection of the command, before any other tests are done.
16668 (The ACL cannot be run if there is no valid address to set up for it.) An
16669 example of a protocol error is receiving RCPT before MAIL. If there are
16670 too many syntax or protocol errors in one SMTP session, the connection is
16671 dropped. The limit is set by this option.
16672
16673 .cindex "PIPELINING" "expected errors"
16674 When the PIPELINING extension to SMTP is in use, some protocol errors are
16675 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16676 Exim assumes that PIPELINING will be used if it advertises it (see
16677 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16678 not count towards the limit.
16679
16680
16681
16682 .option smtp_max_unknown_commands main integer 3
16683 .cindex "SMTP" "limiting unknown commands"
16684 .cindex "limit" "unknown SMTP commands"
16685 If there are too many unrecognized commands in an incoming SMTP session, an
16686 Exim server drops the connection. This is a defence against some kinds of abuse
16687 that subvert web
16688 clients
16689 into making connections to SMTP ports; in these circumstances, a number of
16690 non-SMTP command lines are sent first.
16691
16692
16693
16694 .option smtp_ratelimit_hosts main "host list&!!" unset
16695 .cindex "SMTP" "rate limiting"
16696 .cindex "limit" "rate of message arrival"
16697 .cindex "RCPT" "rate limiting"
16698 Some sites find it helpful to be able to limit the rate at which certain hosts
16699 can send them messages, and the rate at which an individual message can specify
16700 recipients.
16701
16702 Exim has two rate-limiting facilities. This section describes the older
16703 facility, which can limit rates within a single connection. The newer
16704 &%ratelimit%& ACL condition can limit rates across all connections. See section
16705 &<<SECTratelimiting>>& for details of the newer facility.
16706
16707 When a host matches &%smtp_ratelimit_hosts%&, the values of
16708 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16709 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16710 respectively. Each option, if set, must contain a set of four comma-separated
16711 values:
16712
16713 .ilist
16714 A threshold, before which there is no rate limiting.
16715 .next
16716 An initial time delay. Unlike other times in Exim, numbers with decimal
16717 fractional parts are allowed here.
16718 .next
16719 A factor by which to increase the delay each time.
16720 .next
16721 A maximum value for the delay. This should normally be less than 5 minutes,
16722 because after that time, the client is liable to timeout the SMTP command.
16723 .endlist
16724
16725 For example, these settings have been used successfully at the site which
16726 first suggested this feature, for controlling mail from their customers:
16727 .code
16728 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16729 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16730 .endd
16731 The first setting specifies delays that are applied to MAIL commands after
16732 two have been received over a single connection. The initial delay is 0.5
16733 seconds, increasing by a factor of 1.05 each time. The second setting applies
16734 delays to RCPT commands when more than four occur in a single message.
16735
16736
16737 .option smtp_ratelimit_mail main string unset
16738 See &%smtp_ratelimit_hosts%& above.
16739
16740
16741 .option smtp_ratelimit_rcpt main string unset
16742 See &%smtp_ratelimit_hosts%& above.
16743
16744
16745 .option smtp_receive_timeout main time&!! 5m
16746 .cindex "timeout" "for SMTP input"
16747 .cindex "SMTP" "input timeout"
16748 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16749 input, including batch SMTP. If a line of input (either an SMTP command or a
16750 data line) is not received within this time, the SMTP connection is dropped and
16751 the message is abandoned.
16752 A line is written to the log containing one of the following messages:
16753 .code
16754 SMTP command timeout on connection from...
16755 SMTP data timeout on connection from...
16756 .endd
16757 The former means that Exim was expecting to read an SMTP command; the latter
16758 means that it was in the DATA phase, reading the contents of a message.
16759
16760 If the first character of the option is a &"$"& the option is
16761 expanded before use and may depend on
16762 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16763
16764
16765 .oindex "&%-os%&"
16766 The value set by this option can be overridden by the
16767 &%-os%& command-line option. A setting of zero time disables the timeout, but
16768 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16769 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16770 timeout is controlled by &%receive_timeout%& and &%-or%&.
16771
16772
16773 .option smtp_reserve_hosts main "host list&!!" unset
16774 This option defines hosts for which SMTP connections are reserved; see
16775 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16776
16777
16778 .option smtp_return_error_details main boolean false
16779 .cindex "SMTP" "details policy failures"
16780 .cindex "policy control" "rejection, returning details"
16781 In the default state, Exim uses bland messages such as
16782 &"Administrative prohibition"& when it rejects SMTP commands for policy
16783 reasons. Many sysadmins like this because it gives away little information
16784 to spammers. However, some other sysadmins who are applying strict checking
16785 policies want to give out much fuller information about failures. Setting
16786 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16787 example, instead of &"Administrative prohibition"&, it might give:
16788 .code
16789 550-Rejected after DATA: '>' missing at end of address:
16790 550 failing address in "From" header is: <user@dom.ain
16791 .endd
16792
16793
16794 .option smtputf8_advertise_hosts main "host list&!!" *
16795 .cindex "SMTPUTF8" "advertising"
16796 When Exim is built with support for internationalised mail names,
16797 the availability thereof is advertised in
16798 response to EHLO only to those client hosts that match this option. See
16799 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16800
16801
16802 .option spamd_address main string "see below"
16803 This option is available when Exim is compiled with the content-scanning
16804 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16805 The default value is
16806 .code
16807 127.0.0.1 783
16808 .endd
16809 See section &<<SECTscanspamass>>& for more details.
16810
16811
16812
16813 .option split_spool_directory main boolean false
16814 .cindex "multiple spool directories"
16815 .cindex "spool directory" "split"
16816 .cindex "directories, multiple"
16817 If this option is set, it causes Exim to split its input directory into 62
16818 subdirectories, each with a single alphanumeric character as its name. The
16819 sixth character of the message id is used to allocate messages to
16820 subdirectories; this is the least significant base-62 digit of the time of
16821 arrival of the message.
16822
16823 Splitting up the spool in this way may provide better performance on systems
16824 where there are long mail queues, by reducing the number of files in any one
16825 directory. The msglog directory is also split up in a similar way to the input
16826 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16827 are still placed in the single directory &_msglog.OLD_&.
16828
16829 It is not necessary to take any special action for existing messages when
16830 changing &%split_spool_directory%&. Exim notices messages that are in the
16831 &"wrong"& place, and continues to process them. If the option is turned off
16832 after a period of being on, the subdirectories will eventually empty and be
16833 automatically deleted.
16834
16835 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16836 changes. Instead of creating a list of all messages in the queue, and then
16837 trying to deliver each one in turn, it constructs a list of those in one
16838 sub-directory and tries to deliver them, before moving on to the next
16839 sub-directory. The sub-directories are processed in a random order. This
16840 spreads out the scanning of the input directories, and uses less memory. It is
16841 particularly beneficial when there are lots of messages on the queue. However,
16842 if &%queue_run_in_order%& is set, none of this new processing happens. The
16843 entire queue has to be scanned and sorted before any deliveries can start.
16844
16845
16846 .option spool_directory main string&!! "set at compile time"
16847 .cindex "spool directory" "path to"
16848 This defines the directory in which Exim keeps its spool, that is, the messages
16849 it is waiting to deliver. The default value is taken from the compile-time
16850 configuration setting, if there is one. If not, this option must be set. The
16851 string is expanded, so it can contain, for example, a reference to
16852 &$primary_hostname$&.
16853
16854 If the spool directory name is fixed on your installation, it is recommended
16855 that you set it at build time rather than from this option, particularly if the
16856 log files are being written to the spool directory (see &%log_file_path%&).
16857 Otherwise log files cannot be used for errors that are detected early on, such
16858 as failures in the configuration file.
16859
16860 By using this option to override the compiled-in path, it is possible to run
16861 tests of Exim without using the standard spool.
16862
16863 .new
16864 .option spool_wireformat main boolean false
16865 .cindex "spool directory" "file formats"
16866 If this option is set, Exim may for some messages use an alternate format
16867 for data-files in the spool which matches the wire format.
16868 Doing this permits more efficient message reception and transmission.
16869 Currently it is only done for messages received using the EMSTP CHUNKING
16870 option.
16871
16872 The following variables will not have useful values:
16873 .code
16874 $max_received_linelength
16875 $body_linecount
16876 $body_zerocount
16877 .endd
16878
16879 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
16880 and any external programs which are passed a reference to a message data file
16881 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
16882 will need to be aware of the potential different format.
16883
16884 Using any of the ACL conditions noted will negate the reception benefit
16885 (as a Unix-mbox-format file is contructed for them).
16886 The transimssion benefit is maintained.
16887 .wen
16888
16889 .option sqlite_lock_timeout main time 5s
16890 .cindex "sqlite lookup type" "lock timeout"
16891 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16892 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16893
16894 .option strict_acl_vars main boolean false
16895 .cindex "&ACL;" "variables, handling unset"
16896 This option controls what happens if a syntactically valid but undefined ACL
16897 variable is referenced. If it is false (the default), an empty string
16898 is substituted; if it is true, an error is generated. See section
16899 &<<SECTaclvariables>>& for details of ACL variables.
16900
16901 .option strip_excess_angle_brackets main boolean false
16902 .cindex "angle brackets, excess"
16903 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16904 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16905 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16906 passed on to another MTA, the excess angle brackets are not passed on. If this
16907 option is not set, multiple pairs of angle brackets cause a syntax error.
16908
16909
16910 .option strip_trailing_dot main boolean false
16911 .cindex "trailing dot on domain"
16912 .cindex "dot" "trailing on domain"
16913 If this option is set, a trailing dot at the end of a domain in an address is
16914 ignored. If this is in the envelope and the message is passed on to another
16915 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16916 domain causes a syntax error.
16917 However, addresses in header lines are checked only when an ACL requests header
16918 syntax checking.
16919
16920
16921 .option syslog_duplication main boolean true
16922 .cindex "syslog" "duplicate log lines; suppressing"
16923 When Exim is logging to syslog, it writes the log lines for its three
16924 separate logs at different syslog priorities so that they can in principle
16925 be separated on the logging hosts. Some installations do not require this
16926 separation, and in those cases, the duplication of certain log lines is a
16927 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16928 particular log line is written to syslog. For lines that normally go to
16929 both the main log and the reject log, the reject log version (possibly
16930 containing message header lines) is written, at LOG_NOTICE priority.
16931 Lines that normally go to both the main and the panic log are written at
16932 the LOG_ALERT priority.
16933
16934
16935 .option syslog_facility main string unset
16936 .cindex "syslog" "facility; setting"
16937 This option sets the syslog &"facility"& name, used when Exim is logging to
16938 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16939 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16940 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16941 details of Exim's logging.
16942
16943
16944 .option syslog_pid main boolean true
16945 .cindex "syslog" "pid"
16946 If &%syslog_pid%& is set false, the PID on Exim's log lines are
16947 omitted when these lines are sent to syslog. (Syslog normally prefixes
16948 the log lines with the PID of the logging process automatically.) You need
16949 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
16950 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
16951
16952
16953
16954 .option syslog_processname main string &`exim`&
16955 .cindex "syslog" "process name; setting"
16956 This option sets the syslog &"ident"& name, used when Exim is logging to
16957 syslog. The value must be no longer than 32 characters. See chapter
16958 &<<CHAPlog>>& for details of Exim's logging.
16959
16960
16961
16962 .option syslog_timestamp main boolean true
16963 .cindex "syslog" "timestamps"
16964 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16965 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16966 details of Exim's logging.
16967
16968
16969 .option system_filter main string&!! unset
16970 .cindex "filter" "system filter"
16971 .cindex "system filter" "specifying"
16972 .cindex "Sieve filter" "not available for system filter"
16973 This option specifies an Exim filter file that is applied to all messages at
16974 the start of each delivery attempt, before any routing is done. System filters
16975 must be Exim filters; they cannot be Sieve filters. If the system filter
16976 generates any deliveries to files or pipes, or any new mail messages, the
16977 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16978 which transports are to be used. Details of this facility are given in chapter
16979 &<<CHAPsystemfilter>>&.
16980 A forced expansion failure results in no filter operation.
16981
16982
16983 .option system_filter_directory_transport main string&!! unset
16984 .vindex "&$address_file$&"
16985 This sets the name of the transport driver that is to be used when the
16986 &%save%& command in a system message filter specifies a path ending in &"/"&,
16987 implying delivery of each message into a separate file in some directory.
16988 During the delivery, the variable &$address_file$& contains the path name.
16989
16990
16991 .option system_filter_file_transport main string&!! unset
16992 .cindex "file" "transport for system filter"
16993 This sets the name of the transport driver that is to be used when the &%save%&
16994 command in a system message filter specifies a path not ending in &"/"&. During
16995 the delivery, the variable &$address_file$& contains the path name.
16996
16997 .option system_filter_group main string unset
16998 .cindex "gid (group id)" "system filter"
16999 This option is used only when &%system_filter_user%& is also set. It sets the
17000 gid under which the system filter is run, overriding any gid that is associated
17001 with the user. The value may be numerical or symbolic.
17002
17003 .option system_filter_pipe_transport main string&!! unset
17004 .cindex "&(pipe)& transport" "for system filter"
17005 .vindex "&$address_pipe$&"
17006 This specifies the transport driver that is to be used when a &%pipe%& command
17007 is used in a system filter. During the delivery, the variable &$address_pipe$&
17008 contains the pipe command.
17009
17010
17011 .option system_filter_reply_transport main string&!! unset
17012 .cindex "&(autoreply)& transport" "for system filter"
17013 This specifies the transport driver that is to be used when a &%mail%& command
17014 is used in a system filter.
17015
17016
17017 .option system_filter_user main string unset
17018 .cindex "uid (user id)" "system filter"
17019 If this option is set to root, the system filter is run in the main Exim
17020 delivery process, as root.  Otherwise, the system filter runs in a separate
17021 process, as the given user, defaulting to the Exim run-time user.
17022 Unless the string consists entirely of digits, it
17023 is looked up in the password data. Failure to find the named user causes a
17024 configuration error. The gid is either taken from the password data, or
17025 specified by &%system_filter_group%&. When the uid is specified numerically,
17026 &%system_filter_group%& is required to be set.
17027
17028 If the system filter generates any pipe, file, or reply deliveries, the uid
17029 under which the filter is run is used when transporting them, unless a
17030 transport option overrides.
17031
17032
17033 .option tcp_nodelay main boolean true
17034 .cindex "daemon" "TCP_NODELAY on sockets"
17035 .cindex "Nagle algorithm"
17036 .cindex "TCP_NODELAY on listening sockets"
17037 If this option is set false, it stops the Exim daemon setting the
17038 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17039 turns off the &"Nagle algorithm"&, which is a way of improving network
17040 performance in interactive (character-by-character) situations. Turning it off
17041 should improve Exim's performance a bit, so that is what happens by default.
17042 However, it appears that some broken clients cannot cope, and time out. Hence
17043 this option. It affects only those sockets that are set up for listening by the
17044 daemon. Sockets created by the smtp transport for delivering mail always set
17045 TCP_NODELAY.
17046
17047
17048 .option timeout_frozen_after main time 0s
17049 .cindex "frozen messages" "timing out"
17050 .cindex "timeout" "frozen messages"
17051 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17052 message of any kind that has been on the queue for longer than the given time
17053 is automatically cancelled at the next queue run. If the frozen message is a
17054 bounce message, it is just discarded; otherwise, a bounce is sent to the
17055 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17056 If you want to timeout frozen bounce messages earlier than other kinds of
17057 frozen message, see &%ignore_bounce_errors_after%&.
17058
17059 &*Note:*& the default value of zero means no timeouts; with this setting,
17060 frozen messages remain on the queue forever (except for any frozen bounce
17061 messages that are released by &%ignore_bounce_errors_after%&).
17062
17063
17064 .option timezone main string unset
17065 .cindex "timezone, setting"
17066 .cindex "environment" "values from"
17067 The value of &%timezone%& is used to set the environment variable TZ while
17068 running Exim (if it is different on entry). This ensures that all timestamps
17069 created by Exim are in the required timezone. If you want all your timestamps
17070 to be in UTC (aka GMT) you should set
17071 .code
17072 timezone = UTC
17073 .endd
17074 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17075 or, if that is not set, from the value of the TZ environment variable when Exim
17076 is built. If &%timezone%& is set to the empty string, either at build or run
17077 time, any existing TZ variable is removed from the environment when Exim
17078 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17079 unfortunately not all, operating systems.
17080
17081
17082 .option tls_advertise_hosts main "host list&!!" *
17083 .cindex "TLS" "advertising"
17084 .cindex "encryption" "on SMTP connection"
17085 .cindex "SMTP" "encrypted connection"
17086 When Exim is built with support for TLS encrypted connections, the availability
17087 of the STARTTLS command to set up an encrypted session is advertised in
17088 response to EHLO only to those client hosts that match this option. See
17089 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17090 Note that the default value requires that a certificate be supplied
17091 using the &%tls_certificate%& option.  If TLS support for incoming connections
17092 is not required the &%tls_advertise_hosts%& option should be set empty.
17093
17094
17095 .option tls_certificate main string&!! unset
17096 .cindex "TLS" "server certificate; location of"
17097 .cindex "certificate" "server, location of"
17098 The value of this option is expanded, and must then be the absolute path to a
17099 file which contains the server's certificates. The server's private key is also
17100 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17101 &<<CHAPTLS>>& for further details.
17102
17103 &*Note*&: The certificates defined by this option are used only when Exim is
17104 receiving incoming messages as a server. If you want to supply certificates for
17105 use when sending messages as a client, you must set the &%tls_certificate%&
17106 option in the relevant &(smtp)& transport.
17107
17108 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17109 if the OpenSSL build supports TLS extensions and the TLS client sends the
17110 Server Name Indication extension, then this option and others documented in
17111 &<<SECTtlssni>>& will be re-expanded.
17112
17113 If this option is unset or empty a fresh self-signed certificate will be
17114 generated for every connection.
17115
17116 .option tls_crl main string&!! unset
17117 .cindex "TLS" "server certificate revocation list"
17118 .cindex "certificate" "revocation list for server"
17119 This option specifies a certificate revocation list. The expanded value must
17120 be the name of a file that contains a CRL in PEM format.
17121
17122 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17123
17124
17125 .option tls_dh_max_bits main integer 2236
17126 .cindex "TLS" "D-H bit count"
17127 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17128 the chosen TLS library.  That value might prove to be too high for
17129 interoperability.  This option provides a maximum clamp on the value
17130 suggested, trading off security for interoperability.
17131
17132 The value must be at least 1024.
17133
17134 The value 2236 was chosen because, at time of adding the option, it was the
17135 hard-coded maximum value supported by the NSS cryptographic library, as used
17136 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17137
17138 If you prefer more security and are willing to break some clients, raise this
17139 number.
17140
17141 Note that the value passed to GnuTLS for *generating* a new prime may be a
17142 little less than this figure, because GnuTLS is inexact and may produce a
17143 larger prime than requested.
17144
17145
17146 .option tls_dhparam main string&!! unset
17147 .cindex "TLS" "D-H parameters for server"
17148 The value of this option is expanded and indicates the source of DH parameters
17149 to be used by Exim.
17150
17151 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17152 local DH parameters*&, which has been supported across all versions of Exim.  The
17153 other specific constants available are a fallback so that even when
17154 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17155
17156 If &%tls_dhparam%& is a filename starting with a &`/`&,
17157 then it names a file from which DH
17158 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17159 PKCS#3 representation of the DH prime.  If the file does not exist, for
17160 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17161 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17162 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17163 and treated as though the &%tls_dhparam%& were set to "none".
17164
17165 If this option expands to the string "none", then no DH parameters will be
17166 loaded by Exim.
17167
17168 If this option expands to the string "historic" and Exim is using GnuTLS, then
17169 Exim will attempt to load a file from inside the spool directory.  If the file
17170 does not exist, Exim will attempt to create it.
17171 See section &<<SECTgnutlsparam>>& for further details.
17172
17173 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17174 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17175
17176 In older versions of Exim the default was the 2048 bit prime described in section
17177 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17178 in IKE is assigned number 23.
17179
17180 Otherwise, the option must expand to the name used by Exim for any of a number
17181 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17182 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17183 the number used by IKE, or "default" which corresponds to
17184 &`exim.dev.20160529.3`&.
17185
17186 The available standard primes are:
17187 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17188 &`ike1`&, &`ike2`&, &`ike5`&,
17189 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17190 &`ike22`&, &`ike23`& and &`ike24`&.
17191
17192 The available additional primes are:
17193 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17194
17195 Some of these will be too small to be accepted by clients.
17196 Some may be too large to be accepted by clients.
17197 The open cryptographic community has suspicions about the integrity of some
17198 of the later IKE values, which led into RFC7919 providing new fixed constants
17199 (the "ffdhe" identifiers).
17200
17201 At this point, all of the "ike" values should be considered obsolete;
17202 they're still in Exim to avoid breaking unusual configurations, but are
17203 candidates for removal the next time we have backwards-incompatible changes.
17204
17205 The TLS protocol does not negotiate an acceptable size for this; clients tend
17206 to hard-drop connections if what is offered by the server is unacceptable,
17207 whether too large or too small, and there's no provision for the client to
17208 tell the server what these constraints are.  Thus, as a server operator, you
17209 need to make an educated guess as to what is most likely to work for your
17210 userbase.
17211
17212 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17213 is most likely to maximise interoperability.  The upper bound comes from
17214 applications using the Mozilla Network Security Services (NSS) library, which
17215 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17216 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17217 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17218 acceptable bound from 1024 to 2048.
17219
17220
17221 .option tls_eccurve main string&!! &`auto`&
17222 .cindex TLS "EC cryptography"
17223 This option selects a EC curve for use by Exim when used with OpenSSL.
17224 It has no effect when Exim is used with GnuTLS.
17225
17226 After expansion it must contain a valid EC curve parameter, such as
17227 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17228 for valid selections.
17229
17230 For OpenSSL versions before (and not including) 1.0.2, the string
17231 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17232 &`auto`& tells the library to choose.
17233
17234 If the option expands to an empty string, no EC curves will be enabled.
17235
17236
17237 .option tls_ocsp_file main string&!! unset
17238 .cindex TLS "certificate status"
17239 .cindex TLS "OCSP proof file"
17240 This option
17241 must if set expand to the absolute path to a file which contains a current
17242 status proof for the server's certificate, as obtained from the
17243 Certificate Authority.
17244
17245 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17246
17247
17248 .option tls_on_connect_ports main "string list" unset
17249 .cindex SSMTP
17250 .cindex SMTPS
17251 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17252 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17253 set up without waiting for the client to issue a STARTTLS command. For
17254 further details, see section &<<SECTsupobssmt>>&.
17255
17256
17257
17258 .option tls_privatekey main string&!! unset
17259 .cindex "TLS" "server private key; location of"
17260 The value of this option is expanded, and must then be the absolute path to a
17261 file which contains the server's private key. If this option is unset, or if
17262 the expansion is forced to fail, or the result is an empty string, the private
17263 key is assumed to be in the same file as the server's certificates. See chapter
17264 &<<CHAPTLS>>& for further details.
17265
17266 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17267
17268
17269 .option tls_remember_esmtp main boolean false
17270 .cindex "TLS" "esmtp state; remembering"
17271 .cindex "TLS" "broken clients"
17272 If this option is set true, Exim violates the RFCs by remembering that it is in
17273 &"esmtp"& state after successfully negotiating a TLS session. This provides
17274 support for broken clients that fail to send a new EHLO after starting a
17275 TLS session.
17276
17277
17278 .option tls_require_ciphers main string&!! unset
17279 .cindex "TLS" "requiring specific ciphers"
17280 .cindex "cipher" "requiring specific"
17281 This option controls which ciphers can be used for incoming TLS connections.
17282 The &(smtp)& transport has an option of the same name for controlling outgoing
17283 connections. This option is expanded for each connection, so can be varied for
17284 different clients if required. The value of this option must be a list of
17285 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17286 in somewhat different ways. If GnuTLS is being used, the client controls the
17287 preference order of the available ciphers. Details are given in sections
17288 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17289
17290
17291 .option tls_try_verify_hosts main "host list&!!" unset
17292 .cindex "TLS" "client certificate verification"
17293 .cindex "certificate" "verification of client"
17294 See &%tls_verify_hosts%& below.
17295
17296
17297 .option tls_verify_certificates main string&!! system
17298 .cindex "TLS" "client certificate verification"
17299 .cindex "certificate" "verification of client"
17300 The value of this option is expanded, and must then be either the
17301 word "system"
17302 or the absolute path to
17303 a file or directory containing permitted certificates for clients that
17304 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17305
17306 The "system" value for the option will use a
17307 system default location compiled into the SSL library.
17308 This is not available for GnuTLS versions preceding 3.0.20,
17309 and will be taken as empty; an explicit location
17310 must be specified.
17311
17312 The use of a directory for the option value is not available for GnuTLS versions
17313 preceding 3.3.6 and a single file must be used.
17314
17315 With OpenSSL the certificates specified
17316 explicitly
17317 either by file or directory
17318 are added to those given by the system default location.
17319
17320 These certificates should be for the certificate authorities trusted, rather
17321 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17322 the value is a file then the certificates are sent by Exim as a server to
17323 connecting clients, defining the list of accepted certificate authorities.
17324 Thus the values defined should be considered public data.  To avoid this,
17325 use the explicit directory version.
17326
17327 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17328
17329 A forced expansion failure or setting to an empty string is equivalent to
17330 being unset.
17331
17332
17333 .option tls_verify_hosts main "host list&!!" unset
17334 .cindex "TLS" "client certificate verification"
17335 .cindex "certificate" "verification of client"
17336 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17337 certificates from clients. The expected certificates are defined by
17338 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17339 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17340 &%tls_verify_certificates%& is not set.
17341
17342 Any client that matches &%tls_verify_hosts%& is constrained by
17343 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17344 present one of the listed certificates. If it does not, the connection is
17345 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17346 the host to use TLS. It can still send SMTP commands through unencrypted
17347 connections. Forcing a client to use TLS has to be done separately using an
17348 ACL to reject inappropriate commands when the connection is not encrypted.
17349
17350 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17351 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17352 certificate and checks it against &%tls_verify_certificates%&, but does not
17353 abort the connection if there is no certificate or if it does not match. This
17354 state can be detected in an ACL, which makes it possible to implement policies
17355 such as &"accept for relay only if a verified certificate has been received,
17356 but accept for local delivery if encrypted, even without a verified
17357 certificate"&.
17358
17359 Client hosts that match neither of these lists are not asked to present
17360 certificates.
17361
17362
17363 .option trusted_groups main "string list&!!" unset
17364 .cindex "trusted groups"
17365 .cindex "groups" "trusted"
17366 This option is expanded just once, at the start of Exim's processing. If this
17367 option is set, any process that is running in one of the listed groups, or
17368 which has one of them as a supplementary group, is trusted. The groups can be
17369 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17370 details of what trusted callers are permitted to do. If neither
17371 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17372 are trusted.
17373
17374 .option trusted_users main "string list&!!" unset
17375 .cindex "trusted users"
17376 .cindex "user" "trusted"
17377 This option is expanded just once, at the start of Exim's processing. If this
17378 option is set, any process that is running as one of the listed users is
17379 trusted. The users can be specified numerically or by name. See section
17380 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17381 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17382 Exim user are trusted.
17383
17384 .option unknown_login main string&!! unset
17385 .cindex "uid (user id)" "unknown caller"
17386 .vindex "&$caller_uid$&"
17387 This is a specialized feature for use in unusual configurations. By default, if
17388 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17389 gives up. The &%unknown_login%& option can be used to set a login name to be
17390 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17391 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17392 is used for the user's real name (gecos field), unless this has been set by the
17393 &%-F%& option.
17394
17395 .option unknown_username main string unset
17396 See &%unknown_login%&.
17397
17398 .option untrusted_set_sender main "address list&!!" unset
17399 .cindex "trusted users"
17400 .cindex "sender" "setting by untrusted user"
17401 .cindex "untrusted user setting sender"
17402 .cindex "user" "untrusted setting sender"
17403 .cindex "envelope sender"
17404 When an untrusted user submits a message to Exim using the standard input, Exim
17405 normally creates an envelope sender address from the user's login and the
17406 default qualification domain. Data from the &%-f%& option (for setting envelope
17407 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17408 is used) is ignored.
17409
17410 However, untrusted users are permitted to set an empty envelope sender address,
17411 to declare that a message should never generate any bounces. For example:
17412 .code
17413 exim -f '<>' user@domain.example
17414 .endd
17415 .vindex "&$sender_ident$&"
17416 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17417 other envelope sender addresses in a controlled way. When it is set, untrusted
17418 users are allowed to set envelope sender addresses that match any of the
17419 patterns in the list. Like all address lists, the string is expanded. The
17420 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17421 users to setting senders that start with their login ids
17422 followed by a hyphen
17423 by a setting like this:
17424 .code
17425 untrusted_set_sender = ^$sender_ident-
17426 .endd
17427 If you want to allow untrusted users to set envelope sender addresses without
17428 restriction, you can use
17429 .code
17430 untrusted_set_sender = *
17431 .endd
17432 The &%untrusted_set_sender%& option applies to all forms of local input, but
17433 only to the setting of the envelope sender. It does not permit untrusted users
17434 to use the other options which trusted user can use to override message
17435 parameters. Furthermore, it does not stop Exim from removing an existing
17436 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17437 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17438 overriding these actions. The handling of the &'Sender:'& header is also
17439 described in section &<<SECTthesenhea>>&.
17440
17441 The log line for a message's arrival shows the envelope sender following
17442 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17443 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17444 envelope sender address, the user's login is shown in parentheses after the
17445 sender address.
17446
17447
17448 .option uucp_from_pattern main string "see below"
17449 .cindex "&""From""& line"
17450 .cindex "UUCP" "&""From""& line"
17451 Some applications that pass messages to an MTA via a command line interface use
17452 an initial line starting with &"From&~"& to pass the envelope sender. In
17453 particular, this is used by UUCP software. Exim recognizes such a line by means
17454 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17455 matches, the sender address is constructed by expanding the contents of
17456 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17457 default pattern recognizes lines in the following two forms:
17458 .code
17459 From ph10 Fri Jan  5 12:35 GMT 1996
17460 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17461 .endd
17462 The pattern can be seen by running
17463 .code
17464 exim -bP uucp_from_pattern
17465 .endd
17466 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17467 year in the second case. The first word after &"From&~"& is matched in the
17468 regular expression by a parenthesized subpattern. The default value for
17469 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17470 (&"ph10"& in the example above) as the message's sender. See also
17471 &%ignore_fromline_hosts%&.
17472
17473
17474 .option uucp_from_sender main string&!! &`$1`&
17475 See &%uucp_from_pattern%& above.
17476
17477
17478 .option warn_message_file main string unset
17479 .cindex "warning of delay" "customizing the message"
17480 .cindex "customizing" "warning message"
17481 This option defines a template file containing paragraphs of text to be used
17482 for constructing the warning message which is sent by Exim when a message has
17483 been on the queue for a specified amount of time, as specified by
17484 &%delay_warning%&. Details of the file's contents are given in chapter
17485 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17486
17487
17488 .option write_rejectlog main boolean true
17489 .cindex "reject log" "disabling"
17490 If this option is set false, Exim no longer writes anything to the reject log.
17491 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17492 .ecindex IIDconfima
17493 .ecindex IIDmaiconf
17494
17495
17496
17497
17498 . ////////////////////////////////////////////////////////////////////////////
17499 . ////////////////////////////////////////////////////////////////////////////
17500
17501 .chapter "Generic options for routers" "CHAProutergeneric"
17502 .scindex IIDgenoprou1 "options" "generic; for routers"
17503 .scindex IIDgenoprou2 "generic options" "router"
17504 This chapter describes the generic options that apply to all routers.
17505 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17506
17507 For a general description of how a router operates, see sections
17508 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17509 which the preconditions are tested. The order of expansion of the options that
17510 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17511 &%headers_remove%&, &%transport%&.
17512
17513
17514
17515 .option address_data routers string&!! unset
17516 .cindex "router" "data attached to address"
17517 The string is expanded just before the router is run, that is, after all the
17518 precondition tests have succeeded. If the expansion is forced to fail, the
17519 router declines, the value of &%address_data%& remains unchanged, and the
17520 &%more%& option controls what happens next. Other expansion failures cause
17521 delivery of the address to be deferred.
17522
17523 .vindex "&$address_data$&"
17524 When the expansion succeeds, the value is retained with the address, and can be
17525 accessed using the variable &$address_data$& in the current router, subsequent
17526 routers, and the eventual transport.
17527
17528 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17529 that runs a user's filter file, the contents of &$address_data$& are accessible
17530 in the filter. This is not normally a problem, because such data is usually
17531 either not confidential or it &"belongs"& to the current user, but if you do
17532 put confidential data into &$address_data$& you need to remember this point.
17533
17534 Even if the router declines or passes, the value of &$address_data$& remains
17535 with the address, though it can be changed by another &%address_data%& setting
17536 on a subsequent router. If a router generates child addresses, the value of
17537 &$address_data$& propagates to them. This also applies to the special kind of
17538 &"child"& that is generated by a router with the &%unseen%& option.
17539
17540 The idea of &%address_data%& is that you can use it to look up a lot of data
17541 for the address once, and then pick out parts of the data later. For example,
17542 you could use a single LDAP lookup to return a string of the form
17543 .code
17544 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17545 .endd
17546 In the transport you could pick out the mailbox by a setting such as
17547 .code
17548 file = ${extract{mailbox}{$address_data}}
17549 .endd
17550 This makes the configuration file less messy, and also reduces the number of
17551 lookups (though Exim does cache lookups).
17552
17553 .vindex "&$sender_address_data$&"
17554 .vindex "&$address_data$&"
17555 The &%address_data%& facility is also useful as a means of passing information
17556 from one router to another, and from a router to a transport. In addition, if
17557 &$address_data$& is set by a router when verifying a recipient address from an
17558 ACL, it remains available for use in the rest of the ACL statement. After
17559 verifying a sender, the value is transferred to &$sender_address_data$&.
17560
17561
17562
17563 .option address_test routers&!? boolean true
17564 .oindex "&%-bt%&"
17565 .cindex "router" "skipping when address testing"
17566 If this option is set false, the router is skipped when routing is being tested
17567 by means of the &%-bt%& command line option. This can be a convenience when
17568 your first router sends messages to an external scanner, because it saves you
17569 having to set the &"already scanned"& indicator when testing real address
17570 routing.
17571
17572
17573
17574 .option cannot_route_message routers string&!! unset
17575 .cindex "router" "customizing &""cannot route""& message"
17576 .cindex "customizing" "&""cannot route""& message"
17577 This option specifies a text message that is used when an address cannot be
17578 routed because Exim has run out of routers. The default message is
17579 &"Unrouteable address"&. This option is useful only on routers that have
17580 &%more%& set false, or on the very last router in a configuration, because the
17581 value that is used is taken from the last router that is considered. This
17582 includes a router that is skipped because its preconditions are not met, as
17583 well as a router that declines. For example, using the default configuration,
17584 you could put:
17585 .code
17586 cannot_route_message = Remote domain not found in DNS
17587 .endd
17588 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17589 and
17590 .code
17591 cannot_route_message = Unknown local user
17592 .endd
17593 on the final router that checks for local users. If string expansion fails for
17594 this option, the default message is used. Unless the expansion failure was
17595 explicitly forced, a message about the failure is written to the main and panic
17596 logs, in addition to the normal message about the routing failure.
17597
17598
17599 .option caseful_local_part routers boolean false
17600 .cindex "case of local parts"
17601 .cindex "router" "case of local parts"
17602 By default, routers handle the local parts of addresses in a case-insensitive
17603 manner, though the actual case is preserved for transmission with the message.
17604 If you want the case of letters to be significant in a router, you must set
17605 this option true. For individual router options that contain address or local
17606 part lists (for example, &%local_parts%&), case-sensitive matching can be
17607 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17608 more details.
17609
17610 .vindex "&$local_part$&"
17611 .vindex "&$original_local_part$&"
17612 .vindex "&$parent_local_part$&"
17613 The value of the &$local_part$& variable is forced to lower case while a
17614 router is running unless &%caseful_local_part%& is set. When a router assigns
17615 an address to a transport, the value of &$local_part$& when the transport runs
17616 is the same as it was in the router. Similarly, when a router generates child
17617 addresses by aliasing or forwarding, the values of &$original_local_part$&
17618 and &$parent_local_part$& are those that were used by the redirecting router.
17619
17620 This option applies to the processing of an address by a router. When a
17621 recipient address is being processed in an ACL, there is a separate &%control%&
17622 modifier that can be used to specify case-sensitive processing within the ACL
17623 (see section &<<SECTcontrols>>&).
17624
17625
17626
17627 .option check_local_user routers&!? boolean false
17628 .cindex "local user, checking in router"
17629 .cindex "router" "checking for local user"
17630 .cindex "&_/etc/passwd_&"
17631 .vindex "&$home$&"
17632 When this option is true, Exim checks that the local part of the recipient
17633 address (with affixes removed if relevant) is the name of an account on the
17634 local system. The check is done by calling the &[getpwnam()]& function rather
17635 than trying to read &_/etc/passwd_& directly. This means that other methods of
17636 holding password data (such as NIS) are supported. If the local part is a local
17637 user, &$home$& is set from the password data, and can be tested in other
17638 preconditions that are evaluated after this one (the order of evaluation is
17639 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17640 overridden by &%router_home_directory%&. If the local part is not a local user,
17641 the router is skipped.
17642
17643 If you want to check that the local part is either the name of a local user
17644 or matches something else, you cannot combine &%check_local_user%& with a
17645 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17646 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17647 setting to achieve this. For example:
17648 .code
17649 local_parts = passwd;$local_part : lsearch;/etc/other/users
17650 .endd
17651 Note, however, that the side effects of &%check_local_user%& (such as setting
17652 up a home directory) do not occur when a &(passwd)& lookup is used in a
17653 &%local_parts%& (or any other) precondition.
17654
17655
17656
17657 .option condition routers&!? string&!! unset
17658 .cindex "router" "customized precondition"
17659 This option specifies a general precondition test that has to succeed for the
17660 router to be called. The &%condition%& option is the last precondition to be
17661 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17662 result is a forced failure, or an empty string, or one of the strings &"0"& or
17663 &"no"& or &"false"& (checked without regard to the case of the letters), the
17664 router is skipped, and the address is offered to the next one.
17665
17666 If the result is any other value, the router is run (as this is the last
17667 precondition to be evaluated, all the other preconditions must be true).
17668
17669 This option is unusual in that multiple &%condition%& options may be present.
17670 All &%condition%& options must succeed.
17671
17672 The &%condition%& option provides a means of applying custom conditions to the
17673 running of routers. Note that in the case of a simple conditional expansion,
17674 the default expansion values are exactly what is wanted. For example:
17675 .code
17676 condition = ${if >{$message_age}{600}}
17677 .endd
17678 Because of the default behaviour of the string expansion, this is equivalent to
17679 .code
17680 condition = ${if >{$message_age}{600}{true}{}}
17681 .endd
17682
17683 A multiple condition example, which succeeds:
17684 .code
17685 condition = ${if >{$message_age}{600}}
17686 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17687 condition = foobar
17688 .endd
17689
17690 If the expansion fails (other than forced failure) delivery is deferred. Some
17691 of the other precondition options are common special cases that could in fact
17692 be specified using &%condition%&.
17693
17694 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17695 are far older, and use one set of semantics.  ACLs are newer and when
17696 they were created, the ACL &%condition%& process was given far stricter
17697 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17698 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17699 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17700 Router rules processing behavior.
17701
17702 This is best illustrated in an example:
17703 .code
17704 # If used in an ACL condition will fail with a syntax error, but
17705 # in a router condition any extra characters are treated as a string
17706
17707 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17708 true {yes} {no}}
17709
17710 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17711  {yes} {no}}
17712 .endd
17713 In each example above, the &%if%& statement actually ends after
17714 &"{google.com}}"&.  Since no true or false braces were defined, the
17715 default &%if%& behavior is to return a boolean true or a null answer
17716 (which evaluates to false). The rest of the line is then treated as a
17717 string. So the first example resulted in the boolean answer &"true"&
17718 with the string &" {yes} {no}}"& appended to it. The second example
17719 resulted in the null output (indicating false) with the string
17720 &" {yes} {no}}"& appended to it.
17721
17722 In fact you can put excess forward braces in too.  In the router
17723 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17724 mean something, like after a &"$"& or when required as part of a
17725 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17726 string characters.
17727
17728 Thus, in a Router, the above expansion strings will both always evaluate
17729 true, as the result of expansion is a non-empty string which doesn't
17730 match an explicit false value.  This can be tricky to debug.  By
17731 contrast, in an ACL either of those strings will always result in an
17732 expansion error because the result doesn't look sufficiently boolean.
17733
17734
17735 .option debug_print routers string&!! unset
17736 .cindex "testing" "variables in drivers"
17737 If this option is set and debugging is enabled (see the &%-d%& command line
17738 option) or in address-testing mode (see the &%-bt%& command line option),
17739 the string is expanded and included in the debugging output.
17740 If expansion of the string fails, the error message is written to the debugging
17741 output, and Exim carries on processing.
17742 This option is provided to help with checking out the values of variables and
17743 so on when debugging router configurations. For example, if a &%condition%&
17744 option appears not to be working, &%debug_print%& can be used to output the
17745 variables it references. The output happens after checks for &%domains%&,
17746 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17747 are tested. A newline is added to the text if it does not end with one.
17748 The variable &$router_name$& contains the name of the router.
17749
17750
17751
17752 .option disable_logging routers boolean false
17753 If this option is set true, nothing is logged for any routing errors
17754 or for any deliveries caused by this router. You should not set this option
17755 unless you really, really know what you are doing. See also the generic
17756 transport option of the same name.
17757
17758 .option dnssec_request_domains routers "domain list&!!" unset
17759 .cindex "MX record" "security"
17760 .cindex "DNSSEC" "MX lookup"
17761 .cindex "security" "MX lookup"
17762 .cindex "DNS" "DNSSEC"
17763 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17764 the dnssec request bit set.
17765 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17766
17767 .option dnssec_require_domains routers "domain list&!!" unset
17768 .cindex "MX record" "security"
17769 .cindex "DNSSEC" "MX lookup"
17770 .cindex "security" "MX lookup"
17771 .cindex "DNS" "DNSSEC"
17772 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17773 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17774 (AD bit) set will be ignored and logged as a host-lookup failure.
17775 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17776
17777
17778 .option domains routers&!? "domain list&!!" unset
17779 .cindex "router" "restricting to specific domains"
17780 .vindex "&$domain_data$&"
17781 If this option is set, the router is skipped unless the current domain matches
17782 the list. If the match is achieved by means of a file lookup, the data that the
17783 lookup returned for the domain is placed in &$domain_data$& for use in string
17784 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17785 a list of the order in which preconditions are evaluated.
17786
17787
17788
17789 .option driver routers string unset
17790 This option must always be set. It specifies which of the available routers is
17791 to be used.
17792
17793
17794 .option dsn_lasthop routers boolean false
17795 .cindex "DSN" "success"
17796 .cindex "Delivery Status Notification" "success"
17797 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17798 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17799 instead send a success DSN as if the next hop does not support DSN.
17800 Not effective on redirect routers.
17801
17802
17803
17804 .option errors_to routers string&!! unset
17805 .cindex "envelope sender"
17806 .cindex "router" "changing address for errors"
17807 If a router successfully handles an address, it may assign the address to a
17808 transport for delivery or it may generate child addresses. In both cases, if
17809 there is a delivery problem during later processing, the resulting bounce
17810 message is sent to the address that results from expanding this string,
17811 provided that the address verifies successfully. The &%errors_to%& option is
17812 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17813
17814 The &%errors_to%& setting associated with an address can be overridden if it
17815 subsequently passes through other routers that have their own &%errors_to%&
17816 settings, or if the message is delivered by a transport with a &%return_path%&
17817 setting.
17818
17819 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17820 the expansion fails to verify, the errors address associated with the incoming
17821 address is used. At top level, this is the envelope sender. A non-forced
17822 expansion failure causes delivery to be deferred.
17823
17824 If an address for which &%errors_to%& has been set ends up being delivered over
17825 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17826 any bounces that are generated by other MTAs on the delivery route are also
17827 sent there. You can set &%errors_to%& to the empty string by either of these
17828 settings:
17829 .code
17830 errors_to =
17831 errors_to = ""
17832 .endd
17833 An expansion item that yields an empty string has the same effect. If you do
17834 this, a locally detected delivery error for addresses processed by this router
17835 no longer gives rise to a bounce message; the error is discarded. If the
17836 address is delivered to a remote host, the return path is set to &`<>`&, unless
17837 overridden by the &%return_path%& option on the transport.
17838
17839 .vindex "&$address_data$&"
17840 If for some reason you want to discard local errors, but use a non-empty
17841 MAIL command for remote delivery, you can preserve the original return
17842 path in &$address_data$& in the router, and reinstate it in the transport by
17843 setting &%return_path%&.
17844
17845 The most common use of &%errors_to%& is to direct mailing list bounces to the
17846 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17847 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17848
17849
17850
17851 .option expn routers&!? boolean true
17852 .cindex "address" "testing"
17853 .cindex "testing" "addresses"
17854 .cindex "EXPN" "router skipping"
17855 .cindex "router" "skipping for EXPN"
17856 If this option is turned off, the router is skipped when testing an address
17857 as a result of processing an SMTP EXPN command. You might, for example,
17858 want to turn it off on a router for users' &_.forward_& files, while leaving it
17859 on for the system alias file.
17860 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17861 are evaluated.
17862
17863 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17864 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17865 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17866
17867
17868
17869 .option fail_verify routers boolean false
17870 .cindex "router" "forcing verification failure"
17871 Setting this option has the effect of setting both &%fail_verify_sender%& and
17872 &%fail_verify_recipient%& to the same value.
17873
17874
17875
17876 .option fail_verify_recipient routers boolean false
17877 If this option is true and an address is accepted by this router when
17878 verifying a recipient, verification fails.
17879
17880
17881
17882 .option fail_verify_sender routers boolean false
17883 If this option is true and an address is accepted by this router when
17884 verifying a sender, verification fails.
17885
17886
17887
17888 .option fallback_hosts routers "string list" unset
17889 .cindex "router" "fallback hosts"
17890 .cindex "fallback" "hosts specified on router"
17891 String expansion is not applied to this option. The argument must be a
17892 colon-separated list of host names or IP addresses. The list separator can be
17893 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17894 each name or address. In fact, the format of each item is exactly the same as
17895 defined for the list of hosts in a &(manualroute)& router (see section
17896 &<<SECTformatonehostitem>>&).
17897
17898 If a router queues an address for a remote transport, this host list is
17899 associated with the address, and used instead of the transport's fallback host
17900 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17901 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17902 transport for further details.
17903
17904
17905 .option group routers string&!! "see below"
17906 .cindex "gid (group id)" "local delivery"
17907 .cindex "local transports" "uid and gid"
17908 .cindex "transport" "local"
17909 .cindex "router" "setting group"
17910 When a router queues an address for a transport, and the transport does not
17911 specify a group, the group given here is used when running the delivery
17912 process.
17913 The group may be specified numerically or by name. If expansion fails, the
17914 error is logged and delivery is deferred.
17915 The default is unset, unless &%check_local_user%& is set, when the default
17916 is taken from the password information. See also &%initgroups%& and &%user%&
17917 and the discussion in chapter &<<CHAPenvironment>>&.
17918
17919
17920
17921 .option headers_add routers list&!! unset
17922 .cindex "header lines" "adding"
17923 .cindex "router" "adding header lines"
17924 This option specifies a list of text headers,
17925 newline-separated (by default, changeable in the usual way),
17926 that is associated with any addresses that are accepted by the router.
17927 Each item is separately expanded, at routing time.  However, this
17928 option has no effect when an address is just being verified. The way in which
17929 the text is used to add header lines at transport time is described in section
17930 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17931 message is in the process of being transported. This means that references to
17932 header lines in string expansions in the transport's configuration do not
17933 &"see"& the added header lines.
17934
17935 The &%headers_add%& option is expanded after &%errors_to%&, but before
17936 &%headers_remove%& and &%transport%&. If an item is empty, or if
17937 an item expansion is forced to fail, the item has no effect. Other expansion
17938 failures are treated as configuration errors.
17939
17940 Unlike most options, &%headers_add%& can be specified multiple times
17941 for a router; all listed headers are added.
17942
17943 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17944 router that has the &%one_time%& option set.
17945
17946 .cindex "duplicate addresses"
17947 .oindex "&%unseen%&"
17948 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17949 additions are deleted when the address is passed on to subsequent routers.
17950 For a &%redirect%& router, if a generated address is the same as the incoming
17951 address, this can lead to duplicate addresses with different header
17952 modifications. Exim does not do duplicate deliveries (except, in certain
17953 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17954 which of the duplicates is discarded, so this ambiguous situation should be
17955 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17956
17957
17958
17959 .option headers_remove routers list&!! unset
17960 .cindex "header lines" "removing"
17961 .cindex "router" "removing header lines"
17962 This option specifies a list of text headers,
17963 colon-separated (by default, changeable in the usual way),
17964 that is associated with any addresses that are accepted by the router.
17965 Each item is separately expanded, at routing time.  However, this
17966 option has no effect when an address is just being verified. The way in which
17967 the text is used to remove header lines at transport time is described in
17968 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17969 the message is in the process of being transported. This means that references
17970 to header lines in string expansions in the transport's configuration still
17971 &"see"& the original header lines.
17972
17973 The &%headers_remove%& option is expanded after &%errors_to%& and
17974 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17975 the item has no effect. Other expansion failures are treated as configuration
17976 errors.
17977
17978 Unlike most options, &%headers_remove%& can be specified multiple times
17979 for a router; all listed headers are removed.
17980
17981 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17982 router that has the &%one_time%& option set.
17983
17984 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17985 removal requests are deleted when the address is passed on to subsequent
17986 routers, and this can lead to problems with duplicates -- see the similar
17987 warning for &%headers_add%& above.
17988
17989 &*Warning 3*&: Because of the separate expansion of the list items,
17990 items that contain a list separator must have it doubled.
17991 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17992
17993
17994
17995 .option ignore_target_hosts routers "host list&!!" unset
17996 .cindex "IP address" "discarding"
17997 .cindex "router" "discarding IP addresses"
17998 Although this option is a host list, it should normally contain IP address
17999 entries rather than names. If any host that is looked up by the router has an
18000 IP address that matches an item in this list, Exim behaves as if that IP
18001 address did not exist. This option allows you to cope with rogue DNS entries
18002 like
18003 .code
18004 remote.domain.example.  A  127.0.0.1
18005 .endd
18006 by setting
18007 .code
18008 ignore_target_hosts = 127.0.0.1
18009 .endd
18010 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18011 discarded in this way, the router declines. In a conventional configuration, an
18012 attempt to mail to such a domain would normally provoke the &"unrouteable
18013 domain"& error, and an attempt to verify an address in the domain would fail.
18014 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18015 router declines if presented with one of the listed addresses.
18016
18017 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18018 means of the first or the second of the following settings, respectively:
18019 .code
18020 ignore_target_hosts = 0.0.0.0/0
18021 ignore_target_hosts = <; 0::0/0
18022 .endd
18023 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18024 in the second line matches all IPv6 addresses.
18025
18026 This option may also be useful for ignoring link-local and site-local IPv6
18027 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18028 is expanded before use as a list, it is possible to make it dependent on the
18029 domain that is being routed.
18030
18031 .vindex "&$host_address$&"
18032 During its expansion, &$host_address$& is set to the IP address that is being
18033 checked.
18034
18035 .option initgroups routers boolean false
18036 .cindex "additional groups"
18037 .cindex "groups" "additional"
18038 .cindex "local transports" "uid and gid"
18039 .cindex "transport" "local"
18040 If the router queues an address for a transport, and this option is true, and
18041 the uid supplied by the router is not overridden by the transport, the
18042 &[initgroups()]& function is called when running the transport to ensure that
18043 any additional groups associated with the uid are set up. See also &%group%&
18044 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18045
18046
18047
18048 .option local_part_prefix routers&!? "string list" unset
18049 .cindex "router" "prefix for local part"
18050 .cindex "prefix" "for local part, used in router"
18051 If this option is set, the router is skipped unless the local part starts with
18052 one of the given strings, or &%local_part_prefix_optional%& is true. See
18053 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18054 evaluated.
18055
18056 The list is scanned from left to right, and the first prefix that matches is
18057 used. A limited form of wildcard is available; if the prefix begins with an
18058 asterisk, it matches the longest possible sequence of arbitrary characters at
18059 the start of the local part. An asterisk should therefore always be followed by
18060 some character that does not occur in normal local parts.
18061 .cindex "multiple mailboxes"
18062 .cindex "mailbox" "multiple"
18063 Wildcarding can be used to set up multiple user mailboxes, as described in
18064 section &<<SECTmulbox>>&.
18065
18066 .vindex "&$local_part$&"
18067 .vindex "&$local_part_prefix$&"
18068 During the testing of the &%local_parts%& option, and while the router is
18069 running, the prefix is removed from the local part, and is available in the
18070 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18071 the router accepts the address, this remains true during subsequent delivery by
18072 a transport. In particular, the local part that is transmitted in the RCPT
18073 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18074 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18075 the relevant transport.
18076
18077 When an address is being verified, &%local_part_prefix%& affects only the
18078 behaviour of the router. If the callout feature of verification is in use, this
18079 means that the full address, including the prefix, will be used during the
18080 callout.
18081
18082 The prefix facility is commonly used to handle local parts of the form
18083 &%owner-something%&. Another common use is to support local parts of the form
18084 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18085 to tell a user their forwarding is broken &-- by placing a router like this one
18086 immediately before the router that handles &_.forward_& files:
18087 .code
18088 real_localuser:
18089   driver = accept
18090   local_part_prefix = real-
18091   check_local_user
18092   transport = local_delivery
18093 .endd
18094 For security, it would probably be a good idea to restrict the use of this
18095 router to locally-generated messages, using a condition such as this:
18096 .code
18097   condition = ${if match {$sender_host_address}\
18098                          {\N^(|127\.0\.0\.1)$\N}}
18099 .endd
18100
18101 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18102 both conditions must be met if not optional. Care must be taken if wildcards
18103 are used in both a prefix and a suffix on the same router. Different
18104 separator characters must be used to avoid ambiguity.
18105
18106
18107 .option local_part_prefix_optional routers boolean false
18108 See &%local_part_prefix%& above.
18109
18110
18111
18112 .option local_part_suffix routers&!? "string list" unset
18113 .cindex "router" "suffix for local part"
18114 .cindex "suffix for local part" "used in router"
18115 This option operates in the same way as &%local_part_prefix%&, except that the
18116 local part must end (rather than start) with the given string, the
18117 &%local_part_suffix_optional%& option determines whether the suffix is
18118 mandatory, and the wildcard * character, if present, must be the last
18119 character of the suffix. This option facility is commonly used to handle local
18120 parts of the form &%something-request%& and multiple user mailboxes of the form
18121 &%username-foo%&.
18122
18123
18124 .option local_part_suffix_optional routers boolean false
18125 See &%local_part_suffix%& above.
18126
18127
18128
18129 .option local_parts routers&!? "local part list&!!" unset
18130 .cindex "router" "restricting to specific local parts"
18131 .cindex "local part" "checking in router"
18132 The router is run only if the local part of the address matches the list.
18133 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18134 are evaluated, and
18135 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18136 string is expanded, it is possible to make it depend on the domain, for
18137 example:
18138 .code
18139 local_parts = dbm;/usr/local/specials/$domain
18140 .endd
18141 .vindex "&$local_part_data$&"
18142 If the match is achieved by a lookup, the data that the lookup returned
18143 for the local part is placed in the variable &$local_part_data$& for use in
18144 expansions of the router's private options. You might use this option, for
18145 example, if you have a large number of local virtual domains, and you want to
18146 send all postmaster mail to the same place without having to set up an alias in
18147 each virtual domain:
18148 .code
18149 postmaster:
18150   driver = redirect
18151   local_parts = postmaster
18152   data = postmaster@real.domain.example
18153 .endd
18154
18155
18156 .option log_as_local routers boolean "see below"
18157 .cindex "log" "delivery line"
18158 .cindex "delivery" "log line format"
18159 Exim has two logging styles for delivery, the idea being to make local
18160 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18161 recipient address is given just as the local part, without a domain. The use of
18162 this style is controlled by this option. It defaults to true for the &(accept)&
18163 router, and false for all the others. This option applies only when a
18164 router assigns an address to a transport. It has no effect on routers that
18165 redirect addresses.
18166
18167
18168
18169 .option more routers boolean&!! true
18170 The result of string expansion for this option must be a valid boolean value,
18171 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18172 result causes an error, and delivery is deferred. If the expansion is forced to
18173 fail, the default value for the option (true) is used. Other failures cause
18174 delivery to be deferred.
18175
18176 If this option is set false, and the router declines to handle the address, no
18177 further routers are tried, routing fails, and the address is bounced.
18178 .oindex "&%self%&"
18179 However, if the router explicitly passes an address to the following router by
18180 means of the setting
18181 .code
18182 self = pass
18183 .endd
18184 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18185 does not affect the behaviour if one of the precondition tests fails. In that
18186 case, the address is always passed to the next router.
18187
18188 Note that &%address_data%& is not considered to be a precondition. If its
18189 expansion is forced to fail, the router declines, and the value of &%more%&
18190 controls what happens next.
18191
18192
18193 .option pass_on_timeout routers boolean false
18194 .cindex "timeout" "of router"
18195 .cindex "router" "timeout"
18196 If a router times out during a host lookup, it normally causes deferral of the
18197 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18198 router, overriding &%no_more%&. This may be helpful for systems that are
18199 intermittently connected to the Internet, or those that want to pass to a smart
18200 host any messages that cannot immediately be delivered.
18201
18202 There are occasional other temporary errors that can occur while doing DNS
18203 lookups. They are treated in the same way as a timeout, and this option
18204 applies to all of them.
18205
18206
18207
18208 .option pass_router routers string unset
18209 .cindex "router" "go to after &""pass""&"
18210 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18211 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18212 routing to continue, and overriding a false setting of &%more%&. When one of
18213 these routers returns &"pass"&, the address is normally handed on to the next
18214 router in sequence. This can be changed by setting &%pass_router%& to the name
18215 of another router. However (unlike &%redirect_router%&) the named router must
18216 be below the current router, to avoid loops. Note that this option applies only
18217 to the special case of &"pass"&. It does not apply when a router returns
18218 &"decline"& because it cannot handle an address.
18219
18220
18221
18222 .option redirect_router routers string unset
18223 .cindex "router" "start at after redirection"
18224 Sometimes an administrator knows that it is pointless to reprocess addresses
18225 generated from alias or forward files with the same router again. For
18226 example, if an alias file translates real names into login ids there is no
18227 point searching the alias file a second time, especially if it is a large file.
18228
18229 The &%redirect_router%& option can be set to the name of any router instance.
18230 It causes the routing of any generated addresses to start at the named router
18231 instead of at the first router. This option has no effect if the router in
18232 which it is set does not generate new addresses.
18233
18234
18235
18236 .option require_files routers&!? "string list&!!" unset
18237 .cindex "file" "requiring for router"
18238 .cindex "router" "requiring file existence"
18239 This option provides a general mechanism for predicating the running of a
18240 router on the existence or non-existence of certain files or directories.
18241 Before running a router, as one of its precondition tests, Exim works its way
18242 through the &%require_files%& list, expanding each item separately.
18243
18244 Because the list is split before expansion, any colons in expansion items must
18245 be doubled, or the facility for using a different list separator must be used.
18246 If any expansion is forced to fail, the item is ignored. Other expansion
18247 failures cause routing of the address to be deferred.
18248
18249 If any expanded string is empty, it is ignored. Otherwise, except as described
18250 below, each string must be a fully qualified file path, optionally preceded by
18251 &"!"&. The paths are passed to the &[stat()]& function to test for the
18252 existence of the files or directories. The router is skipped if any paths not
18253 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18254
18255 .cindex "NFS"
18256 If &[stat()]& cannot determine whether a file exists or not, delivery of
18257 the message is deferred. This can happen when NFS-mounted filesystems are
18258 unavailable.
18259
18260 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18261 options, so you cannot use it to check for the existence of a file in which to
18262 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18263 full list of the order in which preconditions are evaluated.) However, as
18264 these options are all expanded, you can use the &%exists%& expansion condition
18265 to make such tests. The &%require_files%& option is intended for checking files
18266 that the router may be going to use internally, or which are needed by a
18267 transport (for example &_.procmailrc_&).
18268
18269 During delivery, the &[stat()]& function is run as root, but there is a
18270 facility for some checking of the accessibility of a file by another user.
18271 This is not a proper permissions check, but just a &"rough"& check that
18272 operates as follows:
18273
18274 If an item in a &%require_files%& list does not contain any forward slash
18275 characters, it is taken to be the user (and optional group, separated by a
18276 comma) to be checked for subsequent files in the list. If no group is specified
18277 but the user is specified symbolically, the gid associated with the uid is
18278 used. For example:
18279 .code
18280 require_files = mail:/some/file
18281 require_files = $local_part:$home/.procmailrc
18282 .endd
18283 If a user or group name in a &%require_files%& list does not exist, the
18284 &%require_files%& condition fails.
18285
18286 Exim performs the check by scanning along the components of the file path, and
18287 checking the access for the given uid and gid. It checks for &"x"& access on
18288 directories, and &"r"& access on the final file. Note that this means that file
18289 access control lists, if the operating system has them, are ignored.
18290
18291 &*Warning 1*&: When the router is being run to verify addresses for an
18292 incoming SMTP message, Exim is not running as root, but under its own uid. This
18293 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18294 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18295 user is not permitted to read one of the directories on the file's path.
18296
18297 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18298 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18299 without root access. In this case, if a check for access by a particular user
18300 is requested, Exim creates a subprocess that runs as that user, and tries the
18301 check again in that process.
18302
18303 The default action for handling an unresolved EACCES is to consider it to
18304 be caused by a configuration error, and routing is deferred because the
18305 existence or non-existence of the file cannot be determined. However, in some
18306 circumstances it may be desirable to treat this condition as if the file did
18307 not exist. If the file name (or the exclamation mark that precedes the file
18308 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18309 as if the file did not exist. For example:
18310 .code
18311 require_files = +/some/file
18312 .endd
18313 If the router is not an essential part of verification (for example, it
18314 handles users' &_.forward_& files), another solution is to set the &%verify%&
18315 option false so that the router is skipped when verifying.
18316
18317
18318
18319 .option retry_use_local_part routers boolean "see below"
18320 .cindex "hints database" "retry keys"
18321 .cindex "local part" "in retry keys"
18322 When a delivery suffers a temporary routing failure, a retry record is created
18323 in Exim's hints database. For addresses whose routing depends only on the
18324 domain, the key for the retry record should not involve the local part, but for
18325 other addresses, both the domain and the local part should be included.
18326 Usually, remote routing is of the former kind, and local routing is of the
18327 latter kind.
18328
18329 This option controls whether the local part is used to form the key for retry
18330 hints for addresses that suffer temporary errors while being handled by this
18331 router. The default value is true for any router that has &%check_local_user%&
18332 set, and false otherwise. Note that this option does not apply to hints keys
18333 for transport delays; they are controlled by a generic transport option of the
18334 same name.
18335
18336 The setting of &%retry_use_local_part%& applies only to the router on which it
18337 appears. If the router generates child addresses, they are routed
18338 independently; this setting does not become attached to them.
18339
18340
18341
18342 .option router_home_directory routers string&!! unset
18343 .cindex "router" "home directory for"
18344 .cindex "home directory" "for router"
18345 .vindex "&$home$&"
18346 This option sets a home directory for use while the router is running. (Compare
18347 &%transport_home_directory%&, which sets a home directory for later
18348 transporting.) In particular, if used on a &(redirect)& router, this option
18349 sets a value for &$home$& while a filter is running. The value is expanded;
18350 forced expansion failure causes the option to be ignored &-- other failures
18351 cause the router to defer.
18352
18353 Expansion of &%router_home_directory%& happens immediately after the
18354 &%check_local_user%& test (if configured), before any further expansions take
18355 place.
18356 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18357 are evaluated.)
18358 While the router is running, &%router_home_directory%& overrides the value of
18359 &$home$& that came from &%check_local_user%&.
18360
18361 When a router accepts an address and assigns it to a local transport (including
18362 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18363 delivery), the home directory setting for the transport is taken from the first
18364 of these values that is set:
18365
18366 .ilist
18367 The &%home_directory%& option on the transport;
18368 .next
18369 The &%transport_home_directory%& option on the router;
18370 .next
18371 The password data if &%check_local_user%& is set on the router;
18372 .next
18373 The &%router_home_directory%& option on the router.
18374 .endlist
18375
18376 In other words, &%router_home_directory%& overrides the password data for the
18377 router, but not for the transport.
18378
18379
18380
18381 .option self routers string freeze
18382 .cindex "MX record" "pointing to local host"
18383 .cindex "local host" "MX pointing to"
18384 This option applies to those routers that use a recipient address to find a
18385 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18386 and &(manualroute)& routers.
18387 Certain configurations of the &(queryprogram)& router can also specify a list
18388 of remote hosts.
18389 Usually such routers are configured to send the message to a remote host via an
18390 &(smtp)& transport. The &%self%& option specifies what happens when the first
18391 host on the list turns out to be the local host.
18392 The way in which Exim checks for the local host is described in section
18393 &<<SECTreclocipadd>>&.
18394
18395 Normally this situation indicates either an error in Exim's configuration (for
18396 example, the router should be configured not to process this domain), or an
18397 error in the DNS (for example, the MX should not point to this host). For this
18398 reason, the default action is to log the incident, defer the address, and
18399 freeze the message. The following alternatives are provided for use in special
18400 cases:
18401
18402 .vlist
18403 .vitem &%defer%&
18404 Delivery of the message is tried again later, but the message is not frozen.
18405
18406 .vitem "&%reroute%&: <&'domain'&>"
18407 The domain is changed to the given domain, and the address is passed back to
18408 be reprocessed by the routers. No rewriting of headers takes place. This
18409 behaviour is essentially a redirection.
18410
18411 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18412 The domain is changed to the given domain, and the address is passed back to be
18413 reprocessed by the routers. Any headers that contain the original domain are
18414 rewritten.
18415
18416 .vitem &%pass%&
18417 .oindex "&%more%&"
18418 .vindex "&$self_hostname$&"
18419 The router passes the address to the next router, or to the router named in the
18420 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18421 subsequent routing and delivery, the variable &$self_hostname$& contains the
18422 name of the local host that the router encountered. This can be used to
18423 distinguish between different cases for hosts with multiple names. The
18424 combination
18425 .code
18426 self = pass
18427 no_more
18428 .endd
18429 ensures that only those addresses that routed to the local host are passed on.
18430 Without &%no_more%&, addresses that were declined for other reasons would also
18431 be passed to the next router.
18432
18433 .vitem &%fail%&
18434 Delivery fails and an error report is generated.
18435
18436 .vitem &%send%&
18437 .cindex "local host" "sending to"
18438 The anomaly is ignored and the address is queued for the transport. This
18439 setting should be used with extreme caution. For an &(smtp)& transport, it
18440 makes sense only in cases where the program that is listening on the SMTP port
18441 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18442 different configuration file that handles the domain in another way.
18443 .endlist
18444
18445
18446
18447 .option senders routers&!? "address list&!!" unset
18448 .cindex "router" "checking senders"
18449 If this option is set, the router is skipped unless the message's sender
18450 address matches something on the list.
18451 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18452 are evaluated.
18453
18454 There are issues concerning verification when the running of routers is
18455 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18456 setting, it sets the sender to the null string. When using the &%-bt%& option
18457 to check a configuration file, it is necessary also to use the &%-f%& option to
18458 set an appropriate sender. For incoming mail, the sender is unset when
18459 verifying the sender, but is available when verifying any recipients. If the
18460 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18461 matters.
18462
18463
18464 .option translate_ip_address routers string&!! unset
18465 .cindex "IP address" "translating"
18466 .cindex "packet radio"
18467 .cindex "router" "IP address translation"
18468 There exist some rare networking situations (for example, packet radio) where
18469 it is helpful to be able to translate IP addresses generated by normal routing
18470 mechanisms into other IP addresses, thus performing a kind of manual IP
18471 routing. This should be done only if the normal IP routing of the TCP/IP stack
18472 is inadequate or broken. Because this is an extremely uncommon requirement, the
18473 code to support this option is not included in the Exim binary unless
18474 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18475
18476 .vindex "&$host_address$&"
18477 The &%translate_ip_address%& string is expanded for every IP address generated
18478 by the router, with the generated address set in &$host_address$&. If the
18479 expansion is forced to fail, no action is taken.
18480 For any other expansion error, delivery of the message is deferred.
18481 If the result of the expansion is an IP address, that replaces the original
18482 address; otherwise the result is assumed to be a host name &-- this is looked
18483 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18484 produce one or more replacement IP addresses. For example, to subvert all IP
18485 addresses in some specific networks, this could be added to a router:
18486 .code
18487 translate_ip_address = \
18488   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18489     {$value}fail}}
18490 .endd
18491 The file would contain lines like
18492 .code
18493 10.2.3.128/26    some.host
18494 10.8.4.34/26     10.44.8.15
18495 .endd
18496 You should not make use of this facility unless you really understand what you
18497 are doing.
18498
18499
18500
18501 .option transport routers string&!! unset
18502 This option specifies the transport to be used when a router accepts an address
18503 and sets it up for delivery. A transport is never needed if a router is used
18504 only for verification. The value of the option is expanded at routing time,
18505 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18506 and result must be the name of one of the configured transports. If it is not,
18507 delivery is deferred.
18508
18509 The &%transport%& option is not used by the &(redirect)& router, but it does
18510 have some private options that set up transports for pipe and file deliveries
18511 (see chapter &<<CHAPredirect>>&).
18512
18513
18514
18515 .option transport_current_directory routers string&!! unset
18516 .cindex "current directory for local transport"
18517 This option associates a current directory with any address that is routed
18518 to a local transport. This can happen either because a transport is
18519 explicitly configured for the router, or because it generates a delivery to a
18520 file or a pipe. During the delivery process (that is, at transport time), this
18521 option string is expanded and is set as the current directory, unless
18522 overridden by a setting on the transport.
18523 If the expansion fails for any reason, including forced failure, an error is
18524 logged, and delivery is deferred.
18525 See chapter &<<CHAPenvironment>>& for details of the local delivery
18526 environment.
18527
18528
18529
18530
18531 .option transport_home_directory routers string&!! "see below"
18532 .cindex "home directory" "for local transport"
18533 This option associates a home directory with any address that is routed to a
18534 local transport. This can happen either because a transport is explicitly
18535 configured for the router, or because it generates a delivery to a file or a
18536 pipe. During the delivery process (that is, at transport time), the option
18537 string is expanded and is set as the home directory, unless overridden by a
18538 setting of &%home_directory%& on the transport.
18539 If the expansion fails for any reason, including forced failure, an error is
18540 logged, and delivery is deferred.
18541
18542 If the transport does not specify a home directory, and
18543 &%transport_home_directory%& is not set for the router, the home directory for
18544 the transport is taken from the password data if &%check_local_user%& is set for
18545 the router. Otherwise it is taken from &%router_home_directory%& if that option
18546 is set; if not, no home directory is set for the transport.
18547
18548 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18549 environment.
18550
18551
18552
18553
18554 .option unseen routers boolean&!! false
18555 .cindex "router" "carrying on after success"
18556 The result of string expansion for this option must be a valid boolean value,
18557 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18558 result causes an error, and delivery is deferred. If the expansion is forced to
18559 fail, the default value for the option (false) is used. Other failures cause
18560 delivery to be deferred.
18561
18562 When this option is set true, routing does not cease if the router accepts the
18563 address. Instead, a copy of the incoming address is passed to the next router,
18564 overriding a false setting of &%more%&. There is little point in setting
18565 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18566 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18567 sometimes true and sometimes false).
18568
18569 .cindex "copy of message (&%unseen%& option)"
18570 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18571 qualifier in filter files. It can be used to cause copies of messages to be
18572 delivered to some other destination, while also carrying out a normal delivery.
18573 In effect, the current address is made into a &"parent"& that has two children
18574 &-- one that is delivered as specified by this router, and a clone that goes on
18575 to be routed further. For this reason, &%unseen%& may not be combined with the
18576 &%one_time%& option in a &(redirect)& router.
18577
18578 &*Warning*&: Header lines added to the address (or specified for removal) by
18579 this router or by previous routers affect the &"unseen"& copy of the message
18580 only. The clone that continues to be processed by further routers starts with
18581 no added headers and none specified for removal. For a &%redirect%& router, if
18582 a generated address is the same as the incoming address, this can lead to
18583 duplicate addresses with different header modifications. Exim does not do
18584 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18585 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18586 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18587 &%redirect%& router may be of help.
18588
18589 Unlike the handling of header modifications, any data that was set by the
18590 &%address_data%& option in the current or previous routers &'is'& passed on to
18591 subsequent routers.
18592
18593
18594 .option user routers string&!! "see below"
18595 .cindex "uid (user id)" "local delivery"
18596 .cindex "local transports" "uid and gid"
18597 .cindex "transport" "local"
18598 .cindex "router" "user for filter processing"
18599 .cindex "filter" "user for processing"
18600 When a router queues an address for a transport, and the transport does not
18601 specify a user, the user given here is used when running the delivery process.
18602 The user may be specified numerically or by name. If expansion fails, the
18603 error is logged and delivery is deferred.
18604 This user is also used by the &(redirect)& router when running a filter file.
18605 The default is unset, except when &%check_local_user%& is set. In this case,
18606 the default is taken from the password information. If the user is specified as
18607 a name, and &%group%& is not set, the group associated with the user is used.
18608 See also &%initgroups%& and &%group%& and the discussion in chapter
18609 &<<CHAPenvironment>>&.
18610
18611
18612
18613 .option verify routers&!? boolean true
18614 Setting this option has the effect of setting &%verify_sender%& and
18615 &%verify_recipient%& to the same value.
18616
18617
18618 .option verify_only routers&!? boolean false
18619 .cindex "EXPN" "with &%verify_only%&"
18620 .oindex "&%-bv%&"
18621 .cindex "router" "used only when verifying"
18622 If this option is set, the router is used only when verifying an address,
18623 delivering in cutthrough mode or
18624 testing with the &%-bv%& option, not when actually doing a delivery, testing
18625 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18626 restricted to verifying only senders or recipients by means of
18627 &%verify_sender%& and &%verify_recipient%&.
18628
18629 &*Warning*&: When the router is being run to verify addresses for an incoming
18630 SMTP message, Exim is not running as root, but under its own uid. If the router
18631 accesses any files, you need to make sure that they are accessible to the Exim
18632 user or group.
18633
18634
18635 .option verify_recipient routers&!? boolean true
18636 If this option is false, the router is skipped when verifying recipient
18637 addresses,
18638 delivering in cutthrough mode
18639 or testing recipient verification using &%-bv%&.
18640 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18641 are evaluated.
18642 See also the &$verify_mode$& variable.
18643
18644
18645 .option verify_sender routers&!? boolean true
18646 If this option is false, the router is skipped when verifying sender addresses
18647 or testing sender verification using &%-bvs%&.
18648 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18649 are evaluated.
18650 See also the &$verify_mode$& variable.
18651 .ecindex IIDgenoprou1
18652 .ecindex IIDgenoprou2
18653
18654
18655
18656
18657
18658
18659 . ////////////////////////////////////////////////////////////////////////////
18660 . ////////////////////////////////////////////////////////////////////////////
18661
18662 .chapter "The accept router" "CHID4"
18663 .cindex "&(accept)& router"
18664 .cindex "routers" "&(accept)&"
18665 The &(accept)& router has no private options of its own. Unless it is being
18666 used purely for verification (see &%verify_only%&) a transport is required to
18667 be defined by the generic &%transport%& option. If the preconditions that are
18668 specified by generic options are met, the router accepts the address and queues
18669 it for the given transport. The most common use of this router is for setting
18670 up deliveries to local mailboxes. For example:
18671 .code
18672 localusers:
18673   driver = accept
18674   domains = mydomain.example
18675   check_local_user
18676   transport = local_delivery
18677 .endd
18678 The &%domains%& condition in this example checks the domain of the address, and
18679 &%check_local_user%& checks that the local part is the login of a local user.
18680 When both preconditions are met, the &(accept)& router runs, and queues the
18681 address for the &(local_delivery)& transport.
18682
18683
18684
18685
18686
18687
18688 . ////////////////////////////////////////////////////////////////////////////
18689 . ////////////////////////////////////////////////////////////////////////////
18690
18691 .chapter "The dnslookup router" "CHAPdnslookup"
18692 .scindex IIDdnsrou1 "&(dnslookup)& router"
18693 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18694 The &(dnslookup)& router looks up the hosts that handle mail for the
18695 recipient's domain in the DNS. A transport must always be set for this router,
18696 unless &%verify_only%& is set.
18697
18698 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18699 SRV records. If none are found, or if SRV support is not configured,
18700 MX records are looked up. If no MX records exist, address records are sought.
18701 However, &%mx_domains%& can be set to disable the direct use of address
18702 records.
18703
18704 MX records of equal priority are sorted by Exim into a random order. Exim then
18705 looks for address records for the host names obtained from MX or SRV records.
18706 When a host has more than one IP address, they are sorted into a random order,
18707 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18708 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18709 generic option, the router declines.
18710
18711 Unless they have the highest priority (lowest MX value), MX records that point
18712 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18713 are discarded, together with any other MX records of equal or lower priority.
18714
18715 .cindex "MX record" "pointing to local host"
18716 .cindex "local host" "MX pointing to"
18717 .oindex "&%self%&" "in &(dnslookup)& router"
18718 If the host pointed to by the highest priority MX record, or looked up as an
18719 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18720 happens is controlled by the generic &%self%& option.
18721
18722
18723 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18724 There have been problems with DNS servers when SRV records are looked up.
18725 Some misbehaving servers return a DNS error or timeout when a non-existent
18726 SRV record is sought. Similar problems have in the past been reported for
18727 MX records. The global &%dns_again_means_nonexist%& option can help with this
18728 problem, but it is heavy-handed because it is a global option.
18729
18730 For this reason, there are two options, &%srv_fail_domains%& and
18731 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18732 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18733 an attempt to look up an SRV or MX record causes one of these results, and the
18734 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18735 such record"&. In the case of an SRV lookup, this means that the router
18736 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18737 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18738 case routing fails.
18739
18740
18741 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18742 .cindex "&(dnslookup)& router" "declines"
18743 There are a few cases where a &(dnslookup)& router will decline to accept
18744 an address; if such a router is expected to handle "all remaining non-local
18745 domains", then it is important to set &%no_more%&.
18746
18747 The router will defer rather than decline if the domain
18748 is found in the &%fail_defer_domains%& router option.
18749
18750 Reasons for a &(dnslookup)& router to decline currently include:
18751 .ilist
18752 The domain does not exist in DNS
18753 .next
18754 The domain exists but the MX record's host part is just "."; this is a common
18755 convention (borrowed from SRV) used to indicate that there is no such service
18756 for this domain and to not fall back to trying A/AAAA records.
18757 .next
18758 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18759 .next
18760 MX record points to a non-existent host.
18761 .next
18762 MX record points to an IP address and the main section option
18763 &%allow_mx_to_ip%& is not set.
18764 .next
18765 MX records exist and point to valid hosts, but all hosts resolve only to
18766 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18767 .next
18768 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18769 &%dns_check_names_pattern%& for handling one variant of this)
18770 .next
18771 &%check_secondary_mx%& is set on this router but the local host can
18772 not be found in the MX records (see below)
18773 .endlist
18774
18775
18776
18777
18778 .section "Private options for dnslookup" "SECID118"
18779 .cindex "options" "&(dnslookup)& router"
18780 The private options for the &(dnslookup)& router are as follows:
18781
18782 .option check_secondary_mx dnslookup boolean false
18783 .cindex "MX record" "checking for secondary"
18784 If this option is set, the router declines unless the local host is found in
18785 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18786 process domains for which the local host is a secondary mail exchanger
18787 differently to other domains. The way in which Exim decides whether a host is
18788 the local host is described in section &<<SECTreclocipadd>>&.
18789
18790
18791 .option check_srv dnslookup string&!! unset
18792 .cindex "SRV record" "enabling use of"
18793 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18794 addition to MX and address records. The support is disabled by default. To
18795 enable SRV support, set the &%check_srv%& option to the name of the service
18796 required. For example,
18797 .code
18798 check_srv = smtp
18799 .endd
18800 looks for SRV records that refer to the normal smtp service. The option is
18801 expanded, so the service name can vary from message to message or address
18802 to address. This might be helpful if SRV records are being used for a
18803 submission service. If the expansion is forced to fail, the &%check_srv%&
18804 option is ignored, and the router proceeds to look for MX records in the
18805 normal way.
18806
18807 When the expansion succeeds, the router searches first for SRV records for
18808 the given service (it assumes TCP protocol). A single SRV record with a
18809 host name that consists of just a single dot indicates &"no such service for
18810 this domain"&; if this is encountered, the router declines. If other kinds of
18811 SRV record are found, they are used to construct a host list for delivery
18812 according to the rules of RFC 2782. MX records are not sought in this case.
18813
18814 When no SRV records are found, MX records (and address records) are sought in
18815 the traditional way. In other words, SRV records take precedence over MX
18816 records, just as MX records take precedence over address records. Note that
18817 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18818 defined it. It is apparently believed that MX records are sufficient for email
18819 and that SRV records should not be used for this purpose. However, SRV records
18820 have an additional &"weight"& feature which some people might find useful when
18821 trying to split an SMTP load between hosts of different power.
18822
18823 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18824 when there is a DNS lookup error.
18825
18826
18827
18828
18829 .option fail_defer_domains dnslookup "domain list&!!" unset
18830 .cindex "MX record" "not found"
18831 DNS lookups for domains matching &%fail_defer_domains%&
18832 which find no matching record will cause the router to defer
18833 rather than the default behaviour of decline.
18834 This maybe be useful for queueing messages for a newly created
18835 domain while the DNS configuration is not ready.
18836 However, it will result in any message with mistyped domains
18837 also being queued.
18838
18839
18840 .option mx_domains dnslookup "domain list&!!" unset
18841 .cindex "MX record" "required to exist"
18842 .cindex "SRV record" "required to exist"
18843 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18844 record in order to be recognized. (The name of this option could be improved.)
18845 For example, if all the mail hosts in &'fict.example'& are known to have MX
18846 records, except for those in &'discworld.fict.example'&, you could use this
18847 setting:
18848 .code
18849 mx_domains = ! *.discworld.fict.example : *.fict.example
18850 .endd
18851 This specifies that messages addressed to a domain that matches the list but
18852 has no MX record should be bounced immediately instead of being routed using
18853 the address record.
18854
18855
18856 .option mx_fail_domains dnslookup "domain list&!!" unset
18857 If the DNS lookup for MX records for one of the domains in this list causes a
18858 DNS lookup error, Exim behaves as if no MX records were found. See section
18859 &<<SECTprowitdnsloo>>& for more discussion.
18860
18861
18862
18863
18864 .option qualify_single dnslookup boolean true
18865 .cindex "DNS" "resolver options"
18866 .cindex "DNS" "qualifying single-component names"
18867 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18868 lookups. Typically, but not standardly, this causes the resolver to qualify
18869 single-component names with the default domain. For example, on a machine
18870 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18871 &'thesaurus.ref.example'& inside the resolver. For details of what your
18872 resolver actually does, consult your man pages for &'resolver'& and
18873 &'resolv.conf'&.
18874
18875
18876
18877 .option rewrite_headers dnslookup boolean true
18878 .cindex "rewriting" "header lines"
18879 .cindex "header lines" "rewriting"
18880 If the domain name in the address that is being processed is not fully
18881 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18882 an address is specified as &'dormouse@teaparty'&, the domain might be
18883 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18884 occur as a result of setting the &%widen_domains%& option. If
18885 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18886 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18887 header lines of the message are rewritten with the full domain name.
18888
18889 This option should be turned off only when it is known that no message is
18890 ever going to be sent outside an environment where the abbreviation makes
18891 sense.
18892
18893 When an MX record is looked up in the DNS and matches a wildcard record, name
18894 servers normally return a record containing the name that has been looked up,
18895 making it impossible to detect whether a wildcard was present or not. However,
18896 some name servers have recently been seen to return the wildcard entry. If the
18897 name returned by a DNS lookup begins with an asterisk, it is not used for
18898 header rewriting.
18899
18900
18901 .option same_domain_copy_routing dnslookup boolean false
18902 .cindex "address" "copying routing"
18903 Addresses with the same domain are normally routed by the &(dnslookup)& router
18904 to the same list of hosts. However, this cannot be presumed, because the router
18905 options and preconditions may refer to the local part of the address. By
18906 default, therefore, Exim routes each address in a message independently. DNS
18907 servers run caches, so repeated DNS lookups are not normally expensive, and in
18908 any case, personal messages rarely have more than a few recipients.
18909
18910 If you are running mailing lists with large numbers of subscribers at the same
18911 domain, and you are using a &(dnslookup)& router which is independent of the
18912 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18913 lookups for identical domains in one message. In this case, when &(dnslookup)&
18914 routes an address to a remote transport, any other unrouted addresses in the
18915 message that have the same domain are automatically given the same routing
18916 without processing them independently,
18917 provided the following conditions are met:
18918
18919 .ilist
18920 No router that processed the address specified &%headers_add%& or
18921 &%headers_remove%&.
18922 .next
18923 The router did not change the address in any way, for example, by &"widening"&
18924 the domain.
18925 .endlist
18926
18927
18928
18929
18930 .option search_parents dnslookup boolean false
18931 .cindex "DNS" "resolver options"
18932 When this option is true, the resolver option RES_DNSRCH is set for DNS
18933 lookups. This is different from the &%qualify_single%& option in that it
18934 applies to domains containing dots. Typically, but not standardly, it causes
18935 the resolver to search for the name in the current domain and in parent
18936 domains. For example, on a machine in the &'fict.example'& domain, if looking
18937 up &'teaparty.wonderland'& failed, the resolver would try
18938 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18939 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18940
18941 Setting this option true can cause problems in domains that have a wildcard MX
18942 record, because any domain that does not have its own MX record matches the
18943 local wildcard.
18944
18945
18946
18947 .option srv_fail_domains dnslookup "domain list&!!" unset
18948 If the DNS lookup for SRV records for one of the domains in this list causes a
18949 DNS lookup error, Exim behaves as if no SRV records were found. See section
18950 &<<SECTprowitdnsloo>>& for more discussion.
18951
18952
18953
18954
18955 .option widen_domains dnslookup "string list" unset
18956 .cindex "domain" "partial; widening"
18957 If a DNS lookup fails and this option is set, each of its strings in turn is
18958 added onto the end of the domain, and the lookup is tried again. For example,
18959 if
18960 .code
18961 widen_domains = fict.example:ref.example
18962 .endd
18963 is set and a lookup of &'klingon.dictionary'& fails,
18964 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18965 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18966 and &%search_parents%& options can cause some widening to be undertaken inside
18967 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18968 when verifying, unless &%rewrite_headers%& is false (not the default).
18969
18970
18971 .section "Effect of qualify_single and search_parents" "SECID119"
18972 When a domain from an envelope recipient is changed by the resolver as a result
18973 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18974 corresponding address in the message's header lines unless &%rewrite_headers%&
18975 is set false. Exim then re-routes the address, using the full domain.
18976
18977 These two options affect only the DNS lookup that takes place inside the router
18978 for the domain of the address that is being routed. They do not affect lookups
18979 such as that implied by
18980 .code
18981 domains = @mx_any
18982 .endd
18983 that may happen while processing a router precondition before the router is
18984 entered. No widening ever takes place for these lookups.
18985 .ecindex IIDdnsrou1
18986 .ecindex IIDdnsrou2
18987
18988
18989
18990
18991
18992
18993
18994
18995
18996 . ////////////////////////////////////////////////////////////////////////////
18997 . ////////////////////////////////////////////////////////////////////////////
18998
18999 .chapter "The ipliteral router" "CHID5"
19000 .cindex "&(ipliteral)& router"
19001 .cindex "domain literal" "routing"
19002 .cindex "routers" "&(ipliteral)&"
19003 This router has no private options. Unless it is being used purely for
19004 verification (see &%verify_only%&) a transport is required to be defined by the
19005 generic &%transport%& option. The router accepts the address if its domain part
19006 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19007 router handles the address
19008 .code
19009 root@[192.168.1.1]
19010 .endd
19011 by setting up delivery to the host with that IP address. IPv4 domain literals
19012 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19013 are similar, but the address is preceded by &`ipv6:`&. For example:
19014 .code
19015 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19016 .endd
19017 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19018 grounds that sooner or later somebody will try it.
19019
19020 .oindex "&%self%&" "in &(ipliteral)& router"
19021 If the IP address matches something in &%ignore_target_hosts%&, the router
19022 declines. If an IP literal turns out to refer to the local host, the generic
19023 &%self%& option determines what happens.
19024
19025 The RFCs require support for domain literals; however, their use is
19026 controversial in today's Internet. If you want to use this router, you must
19027 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19028 Exim will not recognize the domain literal syntax in addresses.
19029
19030
19031
19032 . ////////////////////////////////////////////////////////////////////////////
19033 . ////////////////////////////////////////////////////////////////////////////
19034
19035 .chapter "The iplookup router" "CHID6"
19036 .cindex "&(iplookup)& router"
19037 .cindex "routers" "&(iplookup)&"
19038 The &(iplookup)& router was written to fulfil a specific requirement in
19039 Cambridge University (which in fact no longer exists). For this reason, it is
19040 not included in the binary of Exim by default. If you want to include it, you
19041 must set
19042 .code
19043 ROUTER_IPLOOKUP=yes
19044 .endd
19045 in your &_Local/Makefile_& configuration file.
19046
19047 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19048 connection to one or more specific hosts. The host can then return the same or
19049 a different address &-- in effect rewriting the recipient address in the
19050 message's envelope. The new address is then passed on to subsequent routers. If
19051 this process fails, the address can be passed on to other routers, or delivery
19052 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19053 must not be specified for it.
19054
19055 .cindex "options" "&(iplookup)& router"
19056 .option hosts iplookup string unset
19057 This option must be supplied. Its value is a colon-separated list of host
19058 names. The hosts are looked up using &[gethostbyname()]&
19059 (or &[getipnodebyname()]& when available)
19060 and are tried in order until one responds to the query. If none respond, what
19061 happens is controlled by &%optional%&.
19062
19063
19064 .option optional iplookup boolean false
19065 If &%optional%& is true, if no response is obtained from any host, the address
19066 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19067 delivery to the address is deferred.
19068
19069
19070 .option port iplookup integer 0
19071 .cindex "port" "&(iplookup)& router"
19072 This option must be supplied. It specifies the port number for the TCP or UDP
19073 call.
19074
19075
19076 .option protocol iplookup string udp
19077 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19078 protocols is to be used.
19079
19080
19081 .option query iplookup string&!! "see below"
19082 This defines the content of the query that is sent to the remote hosts. The
19083 default value is:
19084 .code
19085 $local_part@$domain $local_part@$domain
19086 .endd
19087 The repetition serves as a way of checking that a response is to the correct
19088 query in the default case (see &%response_pattern%& below).
19089
19090
19091 .option reroute iplookup string&!! unset
19092 If this option is not set, the rerouted address is precisely the byte string
19093 returned by the remote host, up to the first white space, if any. If set, the
19094 string is expanded to form the rerouted address. It can include parts matched
19095 in the response by &%response_pattern%& by means of numeric variables such as
19096 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19097 whether or not a pattern is in use. In all cases, the rerouted address must end
19098 up in the form &'local_part@domain'&.
19099
19100
19101 .option response_pattern iplookup string unset
19102 This option can be set to a regular expression that is applied to the string
19103 returned from the remote host. If the pattern does not match the response, the
19104 router declines. If &%response_pattern%& is not set, no checking of the
19105 response is done, unless the query was defaulted, in which case there is a
19106 check that the text returned after the first white space is the original
19107 address. This checks that the answer that has been received is in response to
19108 the correct question. For example, if the response is just a new domain, the
19109 following could be used:
19110 .code
19111 response_pattern = ^([^@]+)$
19112 reroute = $local_part@$1
19113 .endd
19114
19115 .option timeout iplookup time 5s
19116 This specifies the amount of time to wait for a response from the remote
19117 machine. The same timeout is used for the &[connect()]& function for a TCP
19118 call. It does not apply to UDP.
19119
19120
19121
19122
19123 . ////////////////////////////////////////////////////////////////////////////
19124 . ////////////////////////////////////////////////////////////////////////////
19125
19126 .chapter "The manualroute router" "CHID7"
19127 .scindex IIDmanrou1 "&(manualroute)& router"
19128 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19129 .cindex "domain" "manually routing"
19130 The &(manualroute)& router is so-called because it provides a way of manually
19131 routing an address according to its domain. It is mainly used when you want to
19132 route addresses to remote hosts according to your own rules, bypassing the
19133 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19134 route to local transports, a facility that may be useful if you want to save
19135 messages for dial-in hosts in local files.
19136
19137 The &(manualroute)& router compares a list of domain patterns with the domain
19138 it is trying to route. If there is no match, the router declines. Each pattern
19139 has associated with it a list of hosts and some other optional data, which may
19140 include a transport. The combination of a pattern and its data is called a
19141 &"routing rule"&. For patterns that do not have an associated transport, the
19142 generic &%transport%& option must specify a transport, unless the router is
19143 being used purely for verification (see &%verify_only%&).
19144
19145 .vindex "&$host$&"
19146 In the case of verification, matching the domain pattern is sufficient for the
19147 router to accept the address. When actually routing an address for delivery,
19148 an address that matches a domain pattern is queued for the associated
19149 transport. If the transport is not a local one, a host list must be associated
19150 with the pattern; IP addresses are looked up for the hosts, and these are
19151 passed to the transport along with the mail address. For local transports, a
19152 host list is optional. If it is present, it is passed in &$host$& as a single
19153 text string.
19154
19155 The list of routing rules can be provided as an inline string in
19156 &%route_list%&, or the data can be obtained by looking up the domain in a file
19157 or database by setting &%route_data%&. Only one of these settings may appear in
19158 any one instance of &(manualroute)&. The format of routing rules is described
19159 below, following the list of private options.
19160
19161
19162 .section "Private options for manualroute" "SECTprioptman"
19163
19164 .cindex "options" "&(manualroute)& router"
19165 The private options for the &(manualroute)& router are as follows:
19166
19167 .option host_all_ignored manualroute string defer
19168 See &%host_find_failed%&.
19169
19170 .option host_find_failed manualroute string freeze
19171 This option controls what happens when &(manualroute)& tries to find an IP
19172 address for a host, and the host does not exist. The option can be set to one
19173 of the following values:
19174 .code
19175 decline
19176 defer
19177 fail
19178 freeze
19179 ignore
19180 pass
19181 .endd
19182 The default (&"freeze"&) assumes that this state is a serious configuration
19183 error. The difference between &"pass"& and &"decline"& is that the former
19184 forces the address to be passed to the next router (or the router defined by
19185 &%pass_router%&),
19186 .oindex "&%more%&"
19187 overriding &%no_more%&, whereas the latter passes the address to the next
19188 router only if &%more%& is true.
19189
19190 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19191 cannot be found. If all the hosts in the list are ignored, the behaviour is
19192 controlled by the &%host_all_ignored%& option. This takes the same values
19193 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19194
19195 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19196 state; if a host lookup gets a temporary error, delivery is deferred unless the
19197 generic &%pass_on_timeout%& option is set.
19198
19199
19200 .option hosts_randomize manualroute boolean false
19201 .cindex "randomized host list"
19202 .cindex "host" "list of; randomized"
19203 If this option is set, the order of the items in a host list in a routing rule
19204 is randomized each time the list is used, unless an option in the routing rule
19205 overrides (see below). Randomizing the order of a host list can be used to do
19206 crude load sharing. However, if more than one mail address is routed by the
19207 same router to the same host list, the host lists are considered to be the same
19208 (even though they may be randomized into different orders) for the purpose of
19209 deciding whether to batch the deliveries into a single SMTP transaction.
19210
19211 When &%hosts_randomize%& is true, a host list may be split
19212 into groups whose order is separately randomized. This makes it possible to
19213 set up MX-like behaviour. The boundaries between groups are indicated by an
19214 item that is just &`+`& in the host list. For example:
19215 .code
19216 route_list = * host1:host2:host3:+:host4:host5
19217 .endd
19218 The order of the first three hosts and the order of the last two hosts is
19219 randomized for each use, but the first three always end up before the last two.
19220 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19221 randomized host list is passed to an &(smtp)& transport that also has
19222 &%hosts_randomize set%&, the list is not re-randomized.
19223
19224
19225 .option route_data manualroute string&!! unset
19226 If this option is set, it must expand to yield the data part of a routing rule.
19227 Typically, the expansion string includes a lookup based on the domain. For
19228 example:
19229 .code
19230 route_data = ${lookup{$domain}dbm{/etc/routes}}
19231 .endd
19232 If the expansion is forced to fail, or the result is an empty string, the
19233 router declines. Other kinds of expansion failure cause delivery to be
19234 deferred.
19235
19236
19237 .option route_list manualroute "string list" unset
19238 This string is a list of routing rules, in the form defined below. Note that,
19239 unlike most string lists, the items are separated by semicolons. This is so
19240 that they may contain colon-separated host lists.
19241
19242
19243 .option same_domain_copy_routing manualroute boolean false
19244 .cindex "address" "copying routing"
19245 Addresses with the same domain are normally routed by the &(manualroute)&
19246 router to the same list of hosts. However, this cannot be presumed, because the
19247 router options and preconditions may refer to the local part of the address. By
19248 default, therefore, Exim routes each address in a message independently. DNS
19249 servers run caches, so repeated DNS lookups are not normally expensive, and in
19250 any case, personal messages rarely have more than a few recipients.
19251
19252 If you are running mailing lists with large numbers of subscribers at the same
19253 domain, and you are using a &(manualroute)& router which is independent of the
19254 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19255 lookups for identical domains in one message. In this case, when
19256 &(manualroute)& routes an address to a remote transport, any other unrouted
19257 addresses in the message that have the same domain are automatically given the
19258 same routing without processing them independently. However, this is only done
19259 if &%headers_add%& and &%headers_remove%& are unset.
19260
19261
19262
19263
19264 .section "Routing rules in route_list" "SECID120"
19265 The value of &%route_list%& is a string consisting of a sequence of routing
19266 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19267 entered as two semicolons. Alternatively, the list separator can be changed as
19268 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19269 Empty rules are ignored. The format of each rule is
19270 .display
19271 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19272 .endd
19273 The following example contains two rules, each with a simple domain pattern and
19274 no options:
19275 .code
19276 route_list = \
19277   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19278   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19279 .endd
19280 The three parts of a rule are separated by white space. The pattern and the
19281 list of hosts can be enclosed in quotes if necessary, and if they are, the
19282 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19283 single domain pattern, which is the only mandatory item in the rule. The
19284 pattern is in the same format as one item in a domain list (see section
19285 &<<SECTdomainlist>>&),
19286 except that it may not be the name of an interpolated file.
19287 That is, it may be wildcarded, or a regular expression, or a file or database
19288 lookup (with semicolons doubled, because of the use of semicolon as a separator
19289 in a &%route_list%&).
19290
19291 The rules in &%route_list%& are searched in order until one of the patterns
19292 matches the domain that is being routed. The list of hosts and then options are
19293 then used as described below. If there is no match, the router declines. When
19294 &%route_list%& is set, &%route_data%& must not be set.
19295
19296
19297
19298 .section "Routing rules in route_data" "SECID121"
19299 The use of &%route_list%& is convenient when there are only a small number of
19300 routing rules. For larger numbers, it is easier to use a file or database to
19301 hold the routing information, and use the &%route_data%& option instead.
19302 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19303 Most commonly, &%route_data%& is set as a string that contains an
19304 expansion lookup. For example, suppose we place two routing rules in a file
19305 like this:
19306 .code
19307 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19308 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19309 .endd
19310 This data can be accessed by setting
19311 .code
19312 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19313 .endd
19314 Failure of the lookup results in an empty string, causing the router to
19315 decline. However, you do not have to use a lookup in &%route_data%&. The only
19316 requirement is that the result of expanding the string is a list of hosts,
19317 possibly followed by options, separated by white space. The list of hosts must
19318 be enclosed in quotes if it contains white space.
19319
19320
19321
19322
19323 .section "Format of the list of hosts" "SECID122"
19324 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19325 always separately expanded before use. If the expansion fails, the router
19326 declines. The result of the expansion must be a colon-separated list of names
19327 and/or IP addresses, optionally also including ports. The format of each item
19328 in the list is described in the next section. The list separator can be changed
19329 as described in section &<<SECTlistconstruct>>&.
19330
19331 If the list of hosts was obtained from a &%route_list%& item, the following
19332 variables are set during its expansion:
19333
19334 .ilist
19335 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19336 If the domain was matched against a regular expression, the numeric variables
19337 &$1$&, &$2$&, etc. may be set. For example:
19338 .code
19339 route_list = ^domain(\d+)   host-$1.text.example
19340 .endd
19341 .next
19342 &$0$& is always set to the entire domain.
19343 .next
19344 &$1$& is also set when partial matching is done in a file lookup.
19345
19346 .next
19347 .vindex "&$value$&"
19348 If the pattern that matched the domain was a lookup item, the data that was
19349 looked up is available in the expansion variable &$value$&. For example:
19350 .code
19351 route_list = lsearch;;/some/file.routes  $value
19352 .endd
19353 .endlist
19354
19355 Note the doubling of the semicolon in the pattern that is necessary because
19356 semicolon is the default route list separator.
19357
19358
19359
19360 .section "Format of one host item" "SECTformatonehostitem"
19361 Each item in the list of hosts is either a host name or an IP address,
19362 optionally with an attached port number. When no port is given, an IP address
19363 is not enclosed in brackets. When a port is specified, it overrides the port
19364 specification on the transport. The port is separated from the name or address
19365 by a colon. This leads to some complications:
19366
19367 .ilist
19368 Because colon is the default separator for the list of hosts, either
19369 the colon that specifies a port must be doubled, or the list separator must
19370 be changed. The following two examples have the same effect:
19371 .code
19372 route_list = * "host1.tld::1225 : host2.tld::1226"
19373 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19374 .endd
19375 .next
19376 When IPv6 addresses are involved, it gets worse, because they contain
19377 colons of their own. To make this case easier, it is permitted to
19378 enclose an IP address (either v4 or v6) in square brackets if a port
19379 number follows. For example:
19380 .code
19381 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19382 .endd
19383 .endlist
19384
19385 .section "How the list of hosts is used" "SECThostshowused"
19386 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19387 the hosts is tried, in the order specified, when carrying out the SMTP
19388 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19389 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19390 transport.
19391
19392 Hosts may be listed by name or by IP address. An unadorned name in the list of
19393 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19394 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19395 records in the DNS. For example:
19396 .code
19397 route_list = *  x.y.z:p.q.r/MX:e.f.g
19398 .endd
19399 If this feature is used with a port specifier, the port must come last. For
19400 example:
19401 .code
19402 route_list = *  dom1.tld/mx::1225
19403 .endd
19404 If the &%hosts_randomize%& option is set, the order of the items in the list is
19405 randomized before any lookups are done. Exim then scans the list; for any name
19406 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19407 be an interface on the local host and the item is not the first in the list,
19408 Exim discards it and any subsequent items. If it is the first item, what
19409 happens is controlled by the
19410 .oindex "&%self%&" "in &(manualroute)& router"
19411 &%self%& option of the router.
19412
19413 A name on the list that is followed by &`/MX`& is replaced with the list of
19414 hosts obtained by looking up MX records for the name. This is always a DNS
19415 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19416 below) are not relevant here. The order of these hosts is determined by the
19417 preference values in the MX records, according to the usual rules. Because
19418 randomizing happens before the MX lookup, it does not affect the order that is
19419 defined by MX preferences.
19420
19421 If the local host is present in the sublist obtained from MX records, but is
19422 not the most preferred host in that list, it and any equally or less
19423 preferred hosts are removed before the sublist is inserted into the main list.
19424
19425 If the local host is the most preferred host in the MX list, what happens
19426 depends on where in the original list of hosts the &`/MX`& item appears. If it
19427 is not the first item (that is, there are previous hosts in the main list),
19428 Exim discards this name and any subsequent items in the main list.
19429
19430 If the MX item is first in the list of hosts, and the local host is the
19431 most preferred host, what happens is controlled by the &%self%& option of the
19432 router.
19433
19434 DNS failures when lookup up the MX records are treated in the same way as DNS
19435 failures when looking up IP addresses: &%pass_on_timeout%& and
19436 &%host_find_failed%& are used when relevant.
19437
19438 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19439 whether obtained from an MX lookup or not.
19440
19441
19442
19443 .section "How the options are used" "SECThowoptused"
19444 The options are a sequence of words; in practice no more than three are ever
19445 present. One of the words can be the name of a transport; this overrides the
19446 &%transport%& option on the router for this particular routing rule only. The
19447 other words (if present) control randomization of the list of hosts on a
19448 per-rule basis, and how the IP addresses of the hosts are to be found when
19449 routing to a remote transport. These options are as follows:
19450
19451 .ilist
19452 &%randomize%&: randomize the order of the hosts in this list, overriding the
19453 setting of &%hosts_randomize%& for this routing rule only.
19454 .next
19455 &%no_randomize%&: do not randomize the order of the hosts in this list,
19456 overriding the setting of &%hosts_randomize%& for this routing rule only.
19457 .next
19458 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19459 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19460 also look in &_/etc/hosts_& or other sources of information.
19461 .next
19462 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19463 no address records are found. If there is a temporary DNS error (such as a
19464 timeout), delivery is deferred.
19465 .endlist
19466
19467 For example:
19468 .code
19469 route_list = domain1  host1:host2:host3  randomize bydns;\
19470              domain2  host4:host5
19471 .endd
19472 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19473 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19474 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19475 or &[gethostbyname()]&, and the result of the lookup is the result of that
19476 call.
19477
19478 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19479 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19480 instead of TRY_AGAIN. That is why the default action is to try a DNS
19481 lookup first. Only if that gives a definite &"no such host"& is the local
19482 function called.
19483
19484 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
19485 inadvertent constraint that a transport name as an option had to be the last
19486 option specified.
19487
19488
19489
19490 If no IP address for a host can be found, what happens is controlled by the
19491 &%host_find_failed%& option.
19492
19493 .vindex "&$host$&"
19494 When an address is routed to a local transport, IP addresses are not looked up.
19495 The host list is passed to the transport in the &$host$& variable.
19496
19497
19498
19499 .section "Manualroute examples" "SECID123"
19500 In some of the examples that follow, the presence of the &%remote_smtp%&
19501 transport, as defined in the default configuration file, is assumed:
19502
19503 .ilist
19504 .cindex "smart host" "example router"
19505 The &(manualroute)& router can be used to forward all external mail to a
19506 &'smart host'&. If you have set up, in the main part of the configuration, a
19507 named domain list that contains your local domains, for example:
19508 .code
19509 domainlist local_domains = my.domain.example
19510 .endd
19511 You can arrange for all other domains to be routed to a smart host by making
19512 your first router something like this:
19513 .code
19514 smart_route:
19515   driver = manualroute
19516   domains = !+local_domains
19517   transport = remote_smtp
19518   route_list = * smarthost.ref.example
19519 .endd
19520 This causes all non-local addresses to be sent to the single host
19521 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19522 they are tried in order
19523 (but you can use &%hosts_randomize%& to vary the order each time).
19524 Another way of configuring the same thing is this:
19525 .code
19526 smart_route:
19527   driver = manualroute
19528   transport = remote_smtp
19529   route_list = !+local_domains  smarthost.ref.example
19530 .endd
19531 There is no difference in behaviour between these two routers as they stand.
19532 However, they behave differently if &%no_more%& is added to them. In the first
19533 example, the router is skipped if the domain does not match the &%domains%&
19534 precondition; the following router is always tried. If the router runs, it
19535 always matches the domain and so can never decline. Therefore, &%no_more%&
19536 would have no effect. In the second case, the router is never skipped; it
19537 always runs. However, if it doesn't match the domain, it declines. In this case
19538 &%no_more%& would prevent subsequent routers from running.
19539
19540 .next
19541 .cindex "mail hub example"
19542 A &'mail hub'& is a host which receives mail for a number of domains via MX
19543 records in the DNS and delivers it via its own private routing mechanism. Often
19544 the final destinations are behind a firewall, with the mail hub being the one
19545 machine that can connect to machines both inside and outside the firewall. The
19546 &(manualroute)& router is usually used on a mail hub to route incoming messages
19547 to the correct hosts. For a small number of domains, the routing can be inline,
19548 using the &%route_list%& option, but for a larger number a file or database
19549 lookup is easier to manage.
19550
19551 If the domain names are in fact the names of the machines to which the mail is
19552 to be sent by the mail hub, the configuration can be quite simple. For
19553 example:
19554 .code
19555 hub_route:
19556   driver = manualroute
19557   transport = remote_smtp
19558   route_list = *.rhodes.tvs.example  $domain
19559 .endd
19560 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19561 whose names are the same as the mail domains. A similar approach can be taken
19562 if the host name can be obtained from the domain name by a string manipulation
19563 that the expansion facilities can handle. Otherwise, a lookup based on the
19564 domain can be used to find the host:
19565 .code
19566 through_firewall:
19567   driver = manualroute
19568   transport = remote_smtp
19569   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19570 .endd
19571 The result of the lookup must be the name or IP address of the host (or
19572 hosts) to which the address is to be routed. If the lookup fails, the route
19573 data is empty, causing the router to decline. The address then passes to the
19574 next router.
19575
19576 .next
19577 .cindex "batched SMTP output example"
19578 .cindex "SMTP" "batched outgoing; example"
19579 You can use &(manualroute)& to deliver messages to pipes or files in batched
19580 SMTP format for onward transportation by some other means. This is one way of
19581 storing mail for a dial-up host when it is not connected. The route list entry
19582 can be as simple as a single domain name in a configuration like this:
19583 .code
19584 save_in_file:
19585   driver = manualroute
19586   transport = batchsmtp_appendfile
19587   route_list = saved.domain.example
19588 .endd
19589 though often a pattern is used to pick up more than one domain. If there are
19590 several domains or groups of domains with different transport requirements,
19591 different transports can be listed in the routing information:
19592 .code
19593 save_in_file:
19594   driver = manualroute
19595   route_list = \
19596     *.saved.domain1.example  $domain  batch_appendfile; \
19597     *.saved.domain2.example  \
19598       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19599       batch_pipe
19600 .endd
19601 .vindex "&$domain$&"
19602 .vindex "&$host$&"
19603 The first of these just passes the domain in the &$host$& variable, which
19604 doesn't achieve much (since it is also in &$domain$&), but the second does a
19605 file lookup to find a value to pass, causing the router to decline to handle
19606 the address if the lookup fails.
19607
19608 .next
19609 .cindex "UUCP" "example of router for"
19610 Routing mail directly to UUCP software is a specific case of the use of
19611 &(manualroute)& in a gateway to another mail environment. This is an example of
19612 one way it can be done:
19613 .code
19614 # Transport
19615 uucp:
19616   driver = pipe
19617   user = nobody
19618   command = /usr/local/bin/uux -r - \
19619     ${substr_-5:$host}!rmail ${local_part}
19620   return_fail_output = true
19621
19622 # Router
19623 uucphost:
19624   transport = uucp
19625   driver = manualroute
19626   route_data = \
19627     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19628 .endd
19629 The file &_/usr/local/exim/uucphosts_& contains entries like
19630 .code
19631 darksite.ethereal.example:           darksite.UUCP
19632 .endd
19633 It can be set up more simply without adding and removing &".UUCP"& but this way
19634 makes clear the distinction between the domain name
19635 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19636 .endlist
19637 .ecindex IIDmanrou1
19638 .ecindex IIDmanrou2
19639
19640
19641
19642
19643
19644
19645
19646
19647 . ////////////////////////////////////////////////////////////////////////////
19648 . ////////////////////////////////////////////////////////////////////////////
19649
19650 .chapter "The queryprogram router" "CHAPdriverlast"
19651 .scindex IIDquerou1 "&(queryprogram)& router"
19652 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19653 .cindex "routing" "by external program"
19654 The &(queryprogram)& router routes an address by running an external command
19655 and acting on its output. This is an expensive way to route, and is intended
19656 mainly for use in lightly-loaded systems, or for performing experiments.
19657 However, if it is possible to use the precondition options (&%domains%&,
19658 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19659 be used in special cases, even on a busy host. There are the following private
19660 options:
19661 .cindex "options" "&(queryprogram)& router"
19662
19663 .option command queryprogram string&!! unset
19664 This option must be set. It specifies the command that is to be run. The
19665 command is split up into a command name and arguments, and then each is
19666 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19667 &<<CHAPpipetransport>>&).
19668
19669
19670 .option command_group queryprogram string unset
19671 .cindex "gid (group id)" "in &(queryprogram)& router"
19672 This option specifies a gid to be set when running the command while routing an
19673 address for deliver. It must be set if &%command_user%& specifies a numerical
19674 uid. If it begins with a digit, it is interpreted as the numerical value of the
19675 gid. Otherwise it is looked up using &[getgrnam()]&.
19676
19677
19678 .option command_user queryprogram string unset
19679 .cindex "uid (user id)" "for &(queryprogram)&"
19680 This option must be set. It specifies the uid which is set when running the
19681 command while routing an address for delivery. If the value begins with a digit,
19682 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19683 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19684 not set, a value for the gid also.
19685
19686 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19687 root, which it does during a normal delivery in a conventional configuration.
19688 However, when an address is being verified during message reception, Exim is
19689 usually running as the Exim user, not as root. If the &(queryprogram)& router
19690 is called from a non-root process, Exim cannot change uid or gid before running
19691 the command. In this circumstance the command runs under the current uid and
19692 gid.
19693
19694
19695 .option current_directory queryprogram string /
19696 This option specifies an absolute path which is made the current directory
19697 before running the command.
19698
19699
19700 .option timeout queryprogram time 1h
19701 If the command does not complete within the timeout period, its process group
19702 is killed and the message is frozen. A value of zero time specifies no
19703 timeout.
19704
19705
19706 The standard output of the command is connected to a pipe, which is read when
19707 the command terminates. It should consist of a single line of output,
19708 containing up to five fields, separated by white space. The maximum length of
19709 the line is 1023 characters. Longer lines are silently truncated. The first
19710 field is one of the following words (case-insensitive):
19711
19712 .ilist
19713 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19714 below).
19715 .next
19716 &'Decline'&: the router declines; pass the address to the next router, unless
19717 &%no_more%& is set.
19718 .next
19719 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19720 subsequent text on the line is an error message. If the router is run as part
19721 of address verification during an incoming SMTP message, the message is
19722 included in the SMTP response.
19723 .next
19724 &'Defer'&: routing could not be completed at this time; try again later. Any
19725 subsequent text on the line is an error message which is logged. It is not
19726 included in any SMTP response.
19727 .next
19728 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19729 .next
19730 &'Pass'&: pass the address to the next router (or the router specified by
19731 &%pass_router%&), overriding &%no_more%&.
19732 .next
19733 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19734 new addresses, which are routed independently, starting with the first router,
19735 or the router specified by &%redirect_router%&, if set.
19736 .endlist
19737
19738 When the first word is &'accept'&, the remainder of the line consists of a
19739 number of keyed data values, as follows (split into two lines here, to fit on
19740 the page):
19741 .code
19742 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19743 LOOKUP=byname|bydns DATA=<text>
19744 .endd
19745 The data items can be given in any order, and all are optional. If no transport
19746 is included, the transport specified by the generic &%transport%& option is
19747 used. The list of hosts and the lookup type are needed only if the transport is
19748 an &(smtp)& transport that does not itself supply a list of hosts.
19749
19750 The format of the list of hosts is the same as for the &(manualroute)& router.
19751 As well as host names and IP addresses with optional port numbers, as described
19752 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19753 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19754 (see section &<<SECThostshowused>>&).
19755
19756 If the lookup type is not specified, Exim behaves as follows when trying to
19757 find an IP address for each host: First, a DNS lookup is done. If this yields
19758 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19759 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19760 result of the lookup is the result of that call.
19761
19762 .vindex "&$address_data$&"
19763 If the DATA field is set, its value is placed in the &$address_data$&
19764 variable. For example, this return line
19765 .code
19766 accept hosts=x1.y.example:x2.y.example data="rule1"
19767 .endd
19768 routes the address to the default transport, passing a list of two hosts. When
19769 the transport runs, the string &"rule1"& is in &$address_data$&.
19770 .ecindex IIDquerou1
19771 .ecindex IIDquerou2
19772
19773
19774
19775
19776 . ////////////////////////////////////////////////////////////////////////////
19777 . ////////////////////////////////////////////////////////////////////////////
19778
19779 .chapter "The redirect router" "CHAPredirect"
19780 .scindex IIDredrou1 "&(redirect)& router"
19781 .scindex IIDredrou2 "routers" "&(redirect)&"
19782 .cindex "alias file" "in a &(redirect)& router"
19783 .cindex "address redirection" "&(redirect)& router"
19784 The &(redirect)& router handles several kinds of address redirection. Its most
19785 common uses are for resolving local part aliases from a central alias file
19786 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19787 files, but it has many other potential uses. The incoming address can be
19788 redirected in several different ways:
19789
19790 .ilist
19791 It can be replaced by one or more new addresses which are themselves routed
19792 independently.
19793 .next
19794 It can be routed to be delivered to a given file or directory.
19795 .next
19796 It can be routed to be delivered to a specified pipe command.
19797 .next
19798 It can cause an automatic reply to be generated.
19799 .next
19800 It can be forced to fail, optionally with a custom error message.
19801 .next
19802 It can be temporarily deferred, optionally with a custom message.
19803 .next
19804 It can be discarded.
19805 .endlist
19806
19807 The generic &%transport%& option must not be set for &(redirect)& routers.
19808 However, there are some private options which define transports for delivery to
19809 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19810 &%pipe_transport%& and &%reply_transport%& descriptions below.
19811
19812 If success DSNs have been requested
19813 .cindex "DSN" "success"
19814 .cindex "Delivery Status Notification" "success"
19815 redirection triggers one and the DSN options are not passed any further.
19816
19817
19818
19819 .section "Redirection data" "SECID124"
19820 The router operates by interpreting a text string which it obtains either by
19821 expanding the contents of the &%data%& option, or by reading the entire
19822 contents of a file whose name is given in the &%file%& option. These two
19823 options are mutually exclusive. The first is commonly used for handling system
19824 aliases, in a configuration like this:
19825 .code
19826 system_aliases:
19827   driver = redirect
19828   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19829 .endd
19830 If the lookup fails, the expanded string in this example is empty. When the
19831 expansion of &%data%& results in an empty string, the router declines. A forced
19832 expansion failure also causes the router to decline; other expansion failures
19833 cause delivery to be deferred.
19834
19835 A configuration using &%file%& is commonly used for handling users'
19836 &_.forward_& files, like this:
19837 .code
19838 userforward:
19839   driver = redirect
19840   check_local_user
19841   file = $home/.forward
19842   no_verify
19843 .endd
19844 If the file does not exist, or causes no action to be taken (for example, it is
19845 empty or consists only of comments), the router declines. &*Warning*&: This
19846 is not the case when the file contains syntactically valid items that happen to
19847 yield empty addresses, for example, items containing only RFC 2822 address
19848 comments.
19849
19850
19851
19852 .section "Forward files and address verification" "SECID125"
19853 .cindex "address redirection" "while verifying"
19854 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19855 &_.forward_& files, as in the example above. There are two reasons for this:
19856
19857 .ilist
19858 When Exim is receiving an incoming SMTP message from a remote host, it is
19859 running under the Exim uid, not as root. Exim is unable to change uid to read
19860 the file as the user, and it may not be able to read it as the Exim user. So in
19861 practice the router may not be able to operate.
19862 .next
19863 However, even when the router can operate, the existence of a &_.forward_& file
19864 is unimportant when verifying an address. What should be checked is whether the
19865 local part is a valid user name or not. Cutting out the redirection processing
19866 saves some resources.
19867 .endlist
19868
19869
19870
19871
19872
19873
19874 .section "Interpreting redirection data" "SECID126"
19875 .cindex "Sieve filter" "specifying in redirection data"
19876 .cindex "filter" "specifying in redirection data"
19877 The contents of the data string, whether obtained from &%data%& or &%file%&,
19878 can be interpreted in two different ways:
19879
19880 .ilist
19881 If the &%allow_filter%& option is set true, and the data begins with the text
19882 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19883 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19884 respectively. Details of the syntax and semantics of filter files are described
19885 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19886 document is intended for use by end users.
19887 .next
19888 Otherwise, the data must be a comma-separated list of redirection items, as
19889 described in the next section.
19890 .endlist
19891
19892 When a message is redirected to a file (a &"mail folder"&), the file name given
19893 in a non-filter redirection list must always be an absolute path. A filter may
19894 generate a relative path &-- how this is handled depends on the transport's
19895 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19896 for the &(appendfile)& transport.
19897
19898
19899
19900 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19901 .cindex "address redirection" "non-filter list items"
19902 When the redirection data is not an Exim or Sieve filter, for example, if it
19903 comes from a conventional alias or forward file, it consists of a list of
19904 addresses, file names, pipe commands, or certain special items (see section
19905 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19906 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19907 depending on their default values. The items in the list are separated by
19908 commas or newlines.
19909 If a comma is required in an item, the entire item must be enclosed in double
19910 quotes.
19911
19912 Lines starting with a # character are comments, and are ignored, and # may
19913 also appear following a comma, in which case everything between the # and the
19914 next newline character is ignored.
19915
19916 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19917 double quotes are retained because some forms of mail address require their use
19918 (but never to enclose the entire address). In the following description,
19919 &"item"& refers to what remains after any surrounding double quotes have been
19920 removed.
19921
19922 .vindex "&$local_part$&"
19923 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19924 and the expansion contains a reference to &$local_part$&, you should make use
19925 of the &%quote_local_part%& expansion operator, in case the local part contains
19926 special characters. For example, to redirect all mail for the domain
19927 &'obsolete.example'&, retaining the existing local part, you could use this
19928 setting:
19929 .code
19930 data = ${quote_local_part:$local_part}@newdomain.example
19931 .endd
19932
19933
19934 .section "Redirecting to a local mailbox" "SECTredlocmai"
19935 .cindex "routing" "loops in"
19936 .cindex "loop" "while routing, avoidance of"
19937 .cindex "address redirection" "to local mailbox"
19938 A redirection item may safely be the same as the address currently under
19939 consideration. This does not cause a routing loop, because a router is
19940 automatically skipped if any ancestor of the address that is being processed
19941 is the same as the current address and was processed by the current router.
19942 Such an address is therefore passed to the following routers, so it is handled
19943 as if there were no redirection. When making this loop-avoidance test, the
19944 complete local part, including any prefix or suffix, is used.
19945
19946 .cindex "address redirection" "local part without domain"
19947 Specifying the same local part without a domain is a common usage in personal
19948 filter files when the user wants to have messages delivered to the local
19949 mailbox and also forwarded elsewhere. For example, the user whose login is
19950 &'cleo'& might have a &_.forward_& file containing this:
19951 .code
19952 cleo, cleopatra@egypt.example
19953 .endd
19954 .cindex "backslash in alias file"
19955 .cindex "alias file" "backslash in"
19956 For compatibility with other MTAs, such unqualified local parts may be
19957 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19958 it does make a difference if more than one domain is being handled
19959 synonymously.
19960
19961 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19962 2822 address that does not include a domain, the item is qualified using the
19963 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19964 addresses are qualified using the value in &%qualify_recipient%&, but you can
19965 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19966
19967 Care must be taken if there are alias names for local users.
19968 Consider an MTA handling a single local domain where the system alias file
19969 contains:
19970 .code
19971 Sam.Reman: spqr
19972 .endd
19973 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19974 messages in the local mailbox, and also forward copies elsewhere. He creates
19975 this forward file:
19976 .code
19977 Sam.Reman, spqr@reme.elsewhere.example
19978 .endd
19979 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19980 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19981 second time round, because it has previously routed it,
19982 and the following routers presumably cannot handle the alias. The forward file
19983 should really contain
19984 .code
19985 spqr, spqr@reme.elsewhere.example
19986 .endd
19987 but because this is such a common error, the &%check_ancestor%& option (see
19988 below) exists to provide a way to get round it. This is normally set on a
19989 &(redirect)& router that is handling users' &_.forward_& files.
19990
19991
19992
19993 .section "Special items in redirection lists" "SECTspecitredli"
19994 In addition to addresses, the following types of item may appear in redirection
19995 lists (that is, in non-filter redirection data):
19996
19997 .ilist
19998 .cindex "pipe" "in redirection list"
19999 .cindex "address redirection" "to pipe"
20000 An item is treated as a pipe command if it begins with &"|"& and does not parse
20001 as a valid RFC 2822 address that includes a domain. A transport for running the
20002 command must be specified by the &%pipe_transport%& option.
20003 Normally, either the router or the transport specifies a user and a group under
20004 which to run the delivery. The default is to use the Exim user and group.
20005
20006 Single or double quotes can be used for enclosing the individual arguments of
20007 the pipe command; no interpretation of escapes is done for single quotes. If
20008 the command contains a comma character, it is necessary to put the whole item
20009 in double quotes, for example:
20010 .code
20011 "|/some/command ready,steady,go"
20012 .endd
20013 since items in redirection lists are terminated by commas. Do not, however,
20014 quote just the command. An item such as
20015 .code
20016 |"/some/command ready,steady,go"
20017 .endd
20018 is interpreted as a pipe with a rather strange command name, and no arguments.
20019
20020 Note that the above example assumes that the text comes from a lookup source
20021 of some sort, so that the quotes are part of the data.  If composing a
20022 redirect router with a &%data%& option directly specifying this command, the
20023 quotes will be used by the configuration parser to define the extent of one
20024 string, but will not be passed down into the redirect router itself.  There
20025 are two main approaches to get around this: escape quotes to be part of the
20026 data itself, or avoid using this mechanism and instead create a custom
20027 transport with the &%command%& option set and reference that transport from
20028 an &%accept%& router.
20029
20030 .next
20031 .cindex "file" "in redirection list"
20032 .cindex "address redirection" "to file"
20033 An item is interpreted as a path name if it begins with &"/"& and does not
20034 parse as a valid RFC 2822 address that includes a domain. For example,
20035 .code
20036 /home/world/minbari
20037 .endd
20038 is treated as a file name, but
20039 .code
20040 /s=molari/o=babylon/@x400gate.way
20041 .endd
20042 is treated as an address. For a file name, a transport must be specified using
20043 the &%file_transport%& option. However, if the generated path name ends with a
20044 forward slash character, it is interpreted as a directory name rather than a
20045 file name, and &%directory_transport%& is used instead.
20046
20047 Normally, either the router or the transport specifies a user and a group under
20048 which to run the delivery. The default is to use the Exim user and group.
20049
20050 .cindex "&_/dev/null_&"
20051 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20052 bypassed at a high level, and the log entry shows &"**bypassed**"&
20053 instead of a transport name. In this case the user and group are not used.
20054
20055 .next
20056 .cindex "included address list"
20057 .cindex "address redirection" "included external list"
20058 If an item is of the form
20059 .code
20060 :include:<path name>
20061 .endd
20062 a list of further items is taken from the given file and included at that
20063 point. &*Note*&: Such a file can not be a filter file; it is just an
20064 out-of-line addition to the list. The items in the included list are separated
20065 by commas or newlines and are not subject to expansion. If this is the first
20066 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20067 the alias name. This example is incorrect:
20068 .code
20069 list1    :include:/opt/lists/list1
20070 .endd
20071 It must be given as
20072 .code
20073 list1:   :include:/opt/lists/list1
20074 .endd
20075 .next
20076 .cindex "address redirection" "to black hole"
20077 .cindex "delivery" "discard"
20078 .cindex "delivery" "blackhole"
20079 .cindex "black hole"
20080 .cindex "abandoning mail"
20081 Sometimes you want to throw away mail to a particular local part.  Making the
20082 &%data%& option expand to an empty string does not work, because that causes
20083 the router to decline. Instead, the alias item
20084 .code
20085 :blackhole:
20086 .endd
20087 can be used. It does what its name implies. No delivery is
20088 done, and no error message is generated. This has the same effect as specifying
20089 &_/dev/null_& as a destination, but it can be independently disabled.
20090
20091 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20092 delivery is done for the original local part, even if other redirection items
20093 are present. If you are generating a multi-item list (for example, by reading a
20094 database) and need the ability to provide a no-op item, you must use
20095 &_/dev/null_&.
20096
20097 .next
20098 .cindex "delivery" "forcing failure"
20099 .cindex "delivery" "forcing deferral"
20100 .cindex "failing delivery" "forcing"
20101 .cindex "deferred delivery, forcing"
20102 .cindex "customizing" "failure message"
20103 An attempt to deliver a particular address can be deferred or forced to fail by
20104 redirection items of the form
20105 .code
20106 :defer:
20107 :fail:
20108 .endd
20109 respectively. When a redirection list contains such an item, it applies
20110 to the entire redirection; any other items in the list are ignored. Any
20111 text following &':fail:'& or &':defer:'& is placed in the error text
20112 associated with the failure. For example, an alias file might contain:
20113 .code
20114 X.Employee:  :fail: Gone away, no forwarding address
20115 .endd
20116 In the case of an address that is being verified from an ACL or as the subject
20117 of a
20118 .cindex "VRFY" "error text, display of"
20119 VRFY command, the text is included in the SMTP error response by
20120 default.
20121 .cindex "EXPN" "error text, display of"
20122 The text is not included in the response to an EXPN command. In non-SMTP cases
20123 the text is included in the error message that Exim generates.
20124
20125 .cindex "SMTP" "error codes"
20126 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20127 &':fail:'&. However, if the message starts with three digits followed by a
20128 space, optionally followed by an extended code of the form &'n.n.n'&, also
20129 followed by a space, and the very first digit is the same as the default error
20130 code, the code from the message is used instead. If the very first digit is
20131 incorrect, a panic error is logged, and the default code is used. You can
20132 suppress the use of the supplied code in a redirect router by setting the
20133 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20134 ignored.
20135
20136 .vindex "&$acl_verify_message$&"
20137 In an ACL, an explicitly provided message overrides the default, but the
20138 default message is available in the variable &$acl_verify_message$& and can
20139 therefore be included in a custom message if this is desired.
20140
20141 Normally the error text is the rest of the redirection list &-- a comma does
20142 not terminate it &-- but a newline does act as a terminator. Newlines are not
20143 normally present in alias expansions. In &(lsearch)& lookups they are removed
20144 as part of the continuation process, but they may exist in other kinds of
20145 lookup and in &':include:'& files.
20146
20147 During routing for message delivery (as opposed to verification), a redirection
20148 containing &':fail:'& causes an immediate failure of the incoming address,
20149 whereas &':defer:'& causes the message to remain on the queue so that a
20150 subsequent delivery attempt can happen at a later time. If an address is
20151 deferred for too long, it will ultimately fail, because the normal retry
20152 rules still apply.
20153
20154 .next
20155 .cindex "alias file" "exception to default"
20156 Sometimes it is useful to use a single-key search type with a default (see
20157 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20158 for exceptions to the default. These can be handled by aliasing them to
20159 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20160 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20161 results in an empty redirection list has the same effect.
20162 .endlist
20163
20164
20165 .section "Duplicate addresses" "SECTdupaddr"
20166 .cindex "duplicate addresses"
20167 .cindex "address duplicate, discarding"
20168 .cindex "pipe" "duplicated"
20169 Exim removes duplicate addresses from the list to which it is delivering, so as
20170 to deliver just one copy to each address. This does not apply to deliveries
20171 routed to pipes by different immediate parent addresses, but an indirect
20172 aliasing scheme of the type
20173 .code
20174 pipe:       |/some/command $local_part
20175 localpart1: pipe
20176 localpart2: pipe
20177 .endd
20178 does not work with a message that is addressed to both local parts, because
20179 when the second is aliased to the intermediate local part &"pipe"& it gets
20180 discarded as being the same as a previously handled address. However, a scheme
20181 such as
20182 .code
20183 localpart1: |/some/command $local_part
20184 localpart2: |/some/command $local_part
20185 .endd
20186 does result in two different pipe deliveries, because the immediate parents of
20187 the pipes are distinct.
20188
20189
20190
20191 .section "Repeated redirection expansion" "SECID128"
20192 .cindex "repeated redirection expansion"
20193 .cindex "address redirection" "repeated for each delivery attempt"
20194 When a message cannot be delivered to all of its recipients immediately,
20195 leading to two or more delivery attempts, redirection expansion is carried out
20196 afresh each time for those addresses whose children were not all previously
20197 delivered. If redirection is being used as a mailing list, this can lead to new
20198 members of the list receiving copies of old messages. The &%one_time%& option
20199 can be used to avoid this.
20200
20201
20202 .section "Errors in redirection lists" "SECID129"
20203 .cindex "address redirection" "errors"
20204 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20205 error is skipped, and an entry is written to the main log. This may be useful
20206 for mailing lists that are automatically managed. Otherwise, if an error is
20207 detected while generating the list of new addresses, the original address is
20208 deferred. See also &%syntax_errors_to%&.
20209
20210
20211
20212 .section "Private options for the redirect router" "SECID130"
20213
20214 .cindex "options" "&(redirect)& router"
20215 The private options for the &(redirect)& router are as follows:
20216
20217
20218 .option allow_defer redirect boolean false
20219 Setting this option allows the use of &':defer:'& in non-filter redirection
20220 data, or the &%defer%& command in an Exim filter file.
20221
20222
20223 .option allow_fail redirect boolean false
20224 .cindex "failing delivery" "from filter"
20225 If this option is true, the &':fail:'& item can be used in a redirection list,
20226 and the &%fail%& command may be used in an Exim filter file.
20227
20228
20229 .option allow_filter redirect boolean false
20230 .cindex "filter" "enabling use of"
20231 .cindex "Sieve filter" "enabling use of"
20232 Setting this option allows Exim to interpret redirection data that starts with
20233 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20234 are some features of Exim filter files that some administrators may wish to
20235 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20236
20237 It is also possible to lock out Exim filters or Sieve filters while allowing
20238 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20239
20240
20241 The filter is run using the uid and gid set by the generic &%user%& and
20242 &%group%& options. These take their defaults from the password data if
20243 &%check_local_user%& is set, so in the normal case of users' personal filter
20244 files, the filter is run as the relevant user. When &%allow_filter%& is set
20245 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20246
20247
20248
20249 .option allow_freeze redirect boolean false
20250 .cindex "freezing messages" "allowing in filter"
20251 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20252 This command is more normally encountered in system filters, and is disabled by
20253 default for redirection filters because it isn't something you usually want to
20254 let ordinary users do.
20255
20256
20257
20258 .option check_ancestor redirect boolean false
20259 This option is concerned with handling generated addresses that are the same
20260 as some address in the list of redirection ancestors of the current address.
20261 Although it is turned off by default in the code, it is set in the default
20262 configuration file for handling users' &_.forward_& files. It is recommended
20263 for this use of the &(redirect)& router.
20264
20265 When &%check_ancestor%& is set, if a generated address (including the domain)
20266 is the same as any ancestor of the current address, it is replaced by a copy of
20267 the current address. This helps in the case where local part A is aliased to B,
20268 and B has a &_.forward_& file pointing back to A. For example, within a single
20269 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20270 &_&~jb/.forward_& contains:
20271 .code
20272 \Joe.Bloggs, <other item(s)>
20273 .endd
20274 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20275 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20276 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20277 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20278 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20279 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20280 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20281 original address. See also the &%repeat_use%& option below.
20282
20283
20284 .option check_group redirect boolean "see below"
20285 When the &%file%& option is used, the group owner of the file is checked only
20286 when this option is set. The permitted groups are those listed in the
20287 &%owngroups%& option, together with the user's default group if
20288 &%check_local_user%& is set. If the file has the wrong group, routing is
20289 deferred. The default setting for this option is true if &%check_local_user%&
20290 is set and the &%modemask%& option permits the group write bit, or if the
20291 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20292
20293
20294
20295 .option check_owner redirect boolean "see below"
20296 When the &%file%& option is used, the owner of the file is checked only when
20297 this option is set. If &%check_local_user%& is set, the local user is
20298 permitted; otherwise the owner must be one of those listed in the &%owners%&
20299 option. The default value for this option is true if &%check_local_user%& or
20300 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20301
20302
20303 .option data redirect string&!! unset
20304 This option is mutually exclusive with &%file%&. One or other of them must be
20305 set, but not both. The contents of &%data%& are expanded, and then used as the
20306 list of forwarding items, or as a set of filtering instructions. If the
20307 expansion is forced to fail, or the result is an empty string or a string that
20308 has no effect (consists entirely of comments), the router declines.
20309
20310 When filtering instructions are used, the string must begin with &"#Exim
20311 filter"&, and all comments in the string, including this initial one, must be
20312 terminated with newline characters. For example:
20313 .code
20314 data = #Exim filter\n\
20315        if $h_to: contains Exim then save $home/mail/exim endif
20316 .endd
20317 If you are reading the data from a database where newlines cannot be included,
20318 you can use the &${sg}$& expansion item to turn the escape string of your
20319 choice into a newline.
20320
20321
20322 .option directory_transport redirect string&!! unset
20323 A &(redirect)& router sets up a direct delivery to a directory when a path name
20324 ending with a slash is specified as a new &"address"&. The transport used is
20325 specified by this option, which, after expansion, must be the name of a
20326 configured transport. This should normally be an &(appendfile)& transport.
20327
20328
20329 .option file redirect string&!! unset
20330 This option specifies the name of a file that contains the redirection data. It
20331 is mutually exclusive with the &%data%& option. The string is expanded before
20332 use; if the expansion is forced to fail, the router declines. Other expansion
20333 failures cause delivery to be deferred. The result of a successful expansion
20334 must be an absolute path. The entire file is read and used as the redirection
20335 data. If the data is an empty string or a string that has no effect (consists
20336 entirely of comments), the router declines.
20337
20338 .cindex "NFS" "checking for file existence"
20339 If the attempt to open the file fails with a &"does not exist"& error, Exim
20340 runs a check on the containing directory,
20341 unless &%ignore_enotdir%& is true (see below).
20342 If the directory does not appear to exist, delivery is deferred. This can
20343 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20344 is a mount problem. If the containing directory does exist, but the file does
20345 not, the router declines.
20346
20347
20348 .option file_transport redirect string&!! unset
20349 .vindex "&$address_file$&"
20350 A &(redirect)& router sets up a direct delivery to a file when a path name not
20351 ending in a slash is specified as a new &"address"&. The transport used is
20352 specified by this option, which, after expansion, must be the name of a
20353 configured transport. This should normally be an &(appendfile)& transport. When
20354 it is running, the file name is in &$address_file$&.
20355
20356
20357 .option filter_prepend_home redirect boolean true
20358 When this option is true, if a &(save)& command in an Exim filter specifies a
20359 relative path, and &$home$& is defined, it is automatically prepended to the
20360 relative path. If this option is set false, this action does not happen. The
20361 relative path is then passed to the transport unmodified.
20362
20363
20364 .option forbid_blackhole redirect boolean false
20365 .cindex "restricting access to features"
20366 .cindex "filter" "locking out certain features"
20367 If this option is true, the &':blackhole:'& item may not appear in a
20368 redirection list.
20369
20370
20371 .option forbid_exim_filter redirect boolean false
20372 .cindex "restricting access to features"
20373 .cindex "filter" "locking out certain features"
20374 If this option is set true, only Sieve filters are permitted when
20375 &%allow_filter%& is true.
20376
20377
20378
20379
20380 .option forbid_file redirect boolean false
20381 .cindex "restricting access to features"
20382 .cindex "delivery" "to file; forbidding"
20383 .cindex "filter" "locking out certain features"
20384 .cindex "Sieve filter" "forbidding delivery to a file"
20385 .cindex "Sieve filter" "&""keep""& facility; disabling"
20386 If this option is true, this router may not generate a new address that
20387 specifies delivery to a local file or directory, either from a filter or from a
20388 conventional forward file. This option is forced to be true if &%one_time%& is
20389 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20390 locks out the Sieve's &"keep"& facility.
20391
20392
20393 .option forbid_filter_dlfunc redirect boolean false
20394 .cindex "restricting access to features"
20395 .cindex "filter" "locking out certain features"
20396 If this option is true, string expansions in Exim filters are not allowed to
20397 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20398 functions.
20399
20400 .option forbid_filter_existstest redirect boolean false
20401 .cindex "restricting access to features"
20402 .cindex "filter" "locking out certain features"
20403 .cindex "expansion" "statting a file"
20404 If this option is true, string expansions in Exim filters are not allowed to
20405 make use of the &%exists%& condition or the &%stat%& expansion item.
20406
20407 .option forbid_filter_logwrite redirect boolean false
20408 .cindex "restricting access to features"
20409 .cindex "filter" "locking out certain features"
20410 If this option is true, use of the logging facility in Exim filters is not
20411 permitted. Logging is in any case available only if the filter is being run
20412 under some unprivileged uid (which is normally the case for ordinary users'
20413 &_.forward_& files).
20414
20415
20416 .option forbid_filter_lookup redirect boolean false
20417 .cindex "restricting access to features"
20418 .cindex "filter" "locking out certain features"
20419 If this option is true, string expansions in Exim filter files are not allowed
20420 to make use of &%lookup%& items.
20421
20422
20423 .option forbid_filter_perl redirect boolean false
20424 .cindex "restricting access to features"
20425 .cindex "filter" "locking out certain features"
20426 This option has an effect only if Exim is built with embedded Perl support. If
20427 it is true, string expansions in Exim filter files are not allowed to make use
20428 of the embedded Perl support.
20429
20430
20431 .option forbid_filter_readfile redirect boolean false
20432 .cindex "restricting access to features"
20433 .cindex "filter" "locking out certain features"
20434 If this option is true, string expansions in Exim filter files are not allowed
20435 to make use of &%readfile%& items.
20436
20437
20438 .option forbid_filter_readsocket redirect boolean false
20439 .cindex "restricting access to features"
20440 .cindex "filter" "locking out certain features"
20441 If this option is true, string expansions in Exim filter files are not allowed
20442 to make use of &%readsocket%& items.
20443
20444
20445 .option forbid_filter_reply redirect boolean false
20446 .cindex "restricting access to features"
20447 .cindex "filter" "locking out certain features"
20448 If this option is true, this router may not generate an automatic reply
20449 message. Automatic replies can be generated only from Exim or Sieve filter
20450 files, not from traditional forward files. This option is forced to be true if
20451 &%one_time%& is set.
20452
20453
20454 .option forbid_filter_run redirect boolean false
20455 .cindex "restricting access to features"
20456 .cindex "filter" "locking out certain features"
20457 If this option is true, string expansions in Exim filter files are not allowed
20458 to make use of &%run%& items.
20459
20460
20461 .option forbid_include redirect boolean false
20462 .cindex "restricting access to features"
20463 .cindex "filter" "locking out certain features"
20464 If this option is true, items of the form
20465 .code
20466 :include:<path name>
20467 .endd
20468 are not permitted in non-filter redirection lists.
20469
20470
20471 .option forbid_pipe redirect boolean false
20472 .cindex "restricting access to features"
20473 .cindex "filter" "locking out certain features"
20474 .cindex "delivery" "to pipe; forbidding"
20475 If this option is true, this router may not generate a new address which
20476 specifies delivery to a pipe, either from an Exim filter or from a conventional
20477 forward file. This option is forced to be true if &%one_time%& is set.
20478
20479
20480 .option forbid_sieve_filter redirect boolean false
20481 .cindex "restricting access to features"
20482 .cindex "filter" "locking out certain features"
20483 If this option is set true, only Exim filters are permitted when
20484 &%allow_filter%& is true.
20485
20486
20487 .cindex "SMTP" "error codes"
20488 .option forbid_smtp_code redirect boolean false
20489 If this option is set true, any SMTP error codes that are present at the start
20490 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20491 the default codes (451 and 550, respectively) are always used.
20492
20493
20494
20495
20496 .option hide_child_in_errmsg redirect boolean false
20497 .cindex "bounce message" "redirection details; suppressing"
20498 If this option is true, it prevents Exim from quoting a child address if it
20499 generates a bounce or delay message for it. Instead it says &"an address
20500 generated from <&'the top level address'&>"&. Of course, this applies only to
20501 bounces generated locally. If a message is forwarded to another host, &'its'&
20502 bounce may well quote the generated address.
20503
20504
20505 .option ignore_eacces redirect boolean false
20506 .cindex "EACCES"
20507 If this option is set and an attempt to open a redirection file yields the
20508 EACCES error (permission denied), the &(redirect)& router behaves as if the
20509 file did not exist.
20510
20511
20512 .option ignore_enotdir redirect boolean false
20513 .cindex "ENOTDIR"
20514 If this option is set and an attempt to open a redirection file yields the
20515 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20516 router behaves as if the file did not exist.
20517
20518 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20519 router that has the &%file%& option set discovers that the file does not exist
20520 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20521 against unmounted NFS directories. If the parent can not be statted, delivery
20522 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20523 is set, because that option tells Exim to ignore &"something on the path is not
20524 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20525 that some operating systems give ENOENT where others give ENOTDIR.
20526
20527
20528
20529 .option include_directory redirect string unset
20530 If this option is set, the path names of any &':include:'& items in a
20531 redirection list must start with this directory.
20532
20533
20534 .option modemask redirect "octal integer" 022
20535 This specifies mode bits which must not be set for a file specified by the
20536 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20537
20538
20539 .option one_time redirect boolean false
20540 .cindex "one-time aliasing/forwarding expansion"
20541 .cindex "alias file" "one-time expansion"
20542 .cindex "forward file" "one-time expansion"
20543 .cindex "mailing lists" "one-time expansion"
20544 .cindex "address redirection" "one-time expansion"
20545 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20546 files each time it tries to deliver a message causes a problem when one or more
20547 of the generated addresses fails be delivered at the first attempt. The problem
20548 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20549 but of what happens when the redirection list changes during the time that the
20550 message is on Exim's queue. This is particularly true in the case of mailing
20551 lists, where new subscribers might receive copies of messages that were posted
20552 before they subscribed.
20553
20554 If &%one_time%& is set and any addresses generated by the router fail to
20555 deliver at the first attempt, the failing addresses are added to the message as
20556 &"top level"& addresses, and the parent address that generated them is marked
20557 &"delivered"&. Thus, redirection does not happen again at the next delivery
20558 attempt.
20559
20560 &*Warning 1*&: Any header line addition or removal that is specified by this
20561 router would be lost if delivery did not succeed at the first attempt. For this
20562 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20563 permitted when &%one_time%& is set.
20564
20565 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20566 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20567 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20568
20569 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20570 &%one_time%&.
20571
20572 The original top-level address is remembered with each of the generated
20573 addresses, and is output in any log messages. However, any intermediate parent
20574 addresses are not recorded. This makes a difference to the log only if
20575 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20576 typically be used for mailing lists, where there is normally just one level of
20577 expansion.
20578
20579
20580 .option owners redirect "string list" unset
20581 .cindex "ownership" "alias file"
20582 .cindex "ownership" "forward file"
20583 .cindex "alias file" "ownership"
20584 .cindex "forward file" "ownership"
20585 This specifies a list of permitted owners for the file specified by &%file%&.
20586 This list is in addition to the local user when &%check_local_user%& is set.
20587 See &%check_owner%& above.
20588
20589
20590 .option owngroups redirect "string list" unset
20591 This specifies a list of permitted groups for the file specified by &%file%&.
20592 The list is in addition to the local user's primary group when
20593 &%check_local_user%& is set. See &%check_group%& above.
20594
20595
20596 .option pipe_transport redirect string&!! unset
20597 .vindex "&$address_pipe$&"
20598 A &(redirect)& router sets up a direct delivery to a pipe when a string
20599 starting with a vertical bar character is specified as a new &"address"&. The
20600 transport used is specified by this option, which, after expansion, must be the
20601 name of a configured transport. This should normally be a &(pipe)& transport.
20602 When the transport is run, the pipe command is in &$address_pipe$&.
20603
20604
20605 .option qualify_domain redirect string&!! unset
20606 .vindex "&$qualify_recipient$&"
20607 If this option is set, and an unqualified address (one without a domain) is
20608 generated, and that address would normally be qualified by the global setting
20609 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20610 expanding this string. If the expansion fails, the router declines. If you want
20611 to revert to the default, you can have the expansion generate
20612 &$qualify_recipient$&.
20613
20614 This option applies to all unqualified addresses generated by Exim filters,
20615 but for traditional &_.forward_& files, it applies only to addresses that are
20616 not preceded by a backslash. Sieve filters cannot generate unqualified
20617 addresses.
20618
20619 .option qualify_preserve_domain redirect boolean false
20620 .cindex "domain" "in redirection; preserving"
20621 .cindex "preserving domain in redirection"
20622 .cindex "address redirection" "domain; preserving"
20623 If this option is set, the router's local &%qualify_domain%& option must not be
20624 set (a configuration error occurs if it is). If an unqualified address (one
20625 without a domain) is generated, it is qualified with the domain of the parent
20626 address (the immediately preceding ancestor) instead of the global
20627 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20628 this applies whether or not the address is preceded by a backslash.
20629
20630
20631 .option repeat_use redirect boolean true
20632 If this option is set false, the router is skipped for a child address that has
20633 any ancestor that was routed by this router. This test happens before any of
20634 the other preconditions are tested. Exim's default anti-looping rules skip
20635 only when the ancestor is the same as the current address. See also
20636 &%check_ancestor%& above and the generic &%redirect_router%& option.
20637
20638
20639 .option reply_transport redirect string&!! unset
20640 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20641 &%vacation%& command is used in a filter file. The transport used is specified
20642 by this option, which, after expansion, must be the name of a configured
20643 transport. This should normally be an &(autoreply)& transport. Other transports
20644 are unlikely to do anything sensible or useful.
20645
20646
20647 .option rewrite redirect boolean true
20648 .cindex "address redirection" "disabling rewriting"
20649 If this option is set false, addresses generated by the router are not
20650 subject to address rewriting. Otherwise, they are treated like new addresses
20651 and are rewritten according to the global rewriting rules.
20652
20653
20654 .option sieve_subaddress redirect string&!! unset
20655 The value of this option is passed to a Sieve filter to specify the
20656 :subaddress part of an address.
20657
20658 .option sieve_useraddress redirect string&!! unset
20659 The value of this option is passed to a Sieve filter to specify the :user part
20660 of an address. However, if it is unset, the entire original local part
20661 (including any prefix or suffix) is used for :user.
20662
20663
20664 .option sieve_vacation_directory redirect string&!! unset
20665 .cindex "Sieve filter" "vacation directory"
20666 To enable the &"vacation"& extension for Sieve filters, you must set
20667 &%sieve_vacation_directory%& to the directory where vacation databases are held
20668 (do not put anything else in that directory), and ensure that the
20669 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20670 needs their own directory; Exim will create it if necessary.
20671
20672
20673
20674 .option skip_syntax_errors redirect boolean false
20675 .cindex "forward file" "broken"
20676 .cindex "address redirection" "broken files"
20677 .cindex "alias file" "broken"
20678 .cindex "broken alias or forward files"
20679 .cindex "ignoring faulty addresses"
20680 .cindex "skipping faulty addresses"
20681 .cindex "error" "skipping bad syntax"
20682 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20683 non-filter redirection data are skipped, and each failing address is logged. If
20684 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20685 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20686 are expanded and placed at the head of the error message generated by
20687 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20688 be the same address as the generic &%errors_to%& option. The
20689 &%skip_syntax_errors%& option is often used when handling mailing lists.
20690
20691 If all the addresses in a redirection list are skipped because of syntax
20692 errors, the router declines to handle the original address, and it is passed to
20693 the following routers.
20694
20695 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20696 error in the filter causes filtering to be abandoned without any action being
20697 taken. The incident is logged, and the router declines to handle the address,
20698 so it is passed to the following routers.
20699
20700 .cindex "Sieve filter" "syntax errors in"
20701 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20702 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20703 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20704
20705 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20706 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20707 option, used with an address that does not get redirected, can be used to
20708 notify users of these errors, by means of a router like this:
20709 .code
20710 userforward:
20711   driver = redirect
20712   allow_filter
20713   check_local_user
20714   file = $home/.forward
20715   file_transport = address_file
20716   pipe_transport = address_pipe
20717   reply_transport = address_reply
20718   no_verify
20719   skip_syntax_errors
20720   syntax_errors_to = real-$local_part@$domain
20721   syntax_errors_text = \
20722    This is an automatically generated message. An error has\n\
20723    been found in your .forward file. Details of the error are\n\
20724    reported below. While this error persists, you will receive\n\
20725    a copy of this message for every message that is addressed\n\
20726    to you. If your .forward file is a filter file, or if it is\n\
20727    a non-filter file containing no valid forwarding addresses,\n\
20728    a copy of each incoming message will be put in your normal\n\
20729    mailbox. If a non-filter file contains at least one valid\n\
20730    forwarding address, forwarding to the valid addresses will\n\
20731    happen, and those will be the only deliveries that occur.
20732 .endd
20733 You also need a router to ensure that local addresses that are prefixed by
20734 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20735 put this immediately before the &(userforward)& router:
20736 .code
20737 real_localuser:
20738   driver = accept
20739   check_local_user
20740   local_part_prefix = real-
20741   transport = local_delivery
20742 .endd
20743 For security, it would probably be a good idea to restrict the use of this
20744 router to locally-generated messages, using a condition such as this:
20745 .code
20746   condition = ${if match {$sender_host_address}\
20747                          {\N^(|127\.0\.0\.1)$\N}}
20748 .endd
20749
20750
20751 .option syntax_errors_text redirect string&!! unset
20752 See &%skip_syntax_errors%& above.
20753
20754
20755 .option syntax_errors_to redirect string unset
20756 See &%skip_syntax_errors%& above.
20757 .ecindex IIDredrou1
20758 .ecindex IIDredrou2
20759
20760
20761
20762
20763
20764
20765 . ////////////////////////////////////////////////////////////////////////////
20766 . ////////////////////////////////////////////////////////////////////////////
20767
20768 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20769          "Environment for local transports"
20770 .scindex IIDenvlotra1 "local transports" "environment for"
20771 .scindex IIDenvlotra2 "environment" "local transports"
20772 .scindex IIDenvlotra3 "transport" "local; environment for"
20773 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20774 transport can be thought of as similar to a pipe.) Exim always runs transports
20775 in subprocesses, under specified uids and gids. Typical deliveries to local
20776 mailboxes run under the uid and gid of the local user.
20777
20778 Exim also sets a specific current directory while running the transport; for
20779 some transports a home directory setting is also relevant. The &(pipe)&
20780 transport is the only one that sets up environment variables; see section
20781 &<<SECTpipeenv>>& for details.
20782
20783 The values used for the uid, gid, and the directories may come from several
20784 different places. In many cases, the router that handles the address associates
20785 settings with that address as a result of its &%check_local_user%&, &%group%&,
20786 or &%user%& options. However, values may also be given in the transport's own
20787 configuration, and these override anything that comes from the router.
20788
20789
20790
20791 .section "Concurrent deliveries" "SECID131"
20792 .cindex "concurrent deliveries"
20793 .cindex "simultaneous deliveries"
20794 If two different messages for the same local recipient arrive more or less
20795 simultaneously, the two delivery processes are likely to run concurrently. When
20796 the &(appendfile)& transport is used to write to a file, Exim applies locking
20797 rules to stop concurrent processes from writing to the same file at the same
20798 time.
20799
20800 However, when you use a &(pipe)& transport, it is up to you to arrange any
20801 locking that is needed. Here is a silly example:
20802 .code
20803 my_transport:
20804   driver = pipe
20805   command = /bin/sh -c 'cat >>/some/file'
20806 .endd
20807 This is supposed to write the message at the end of the file. However, if two
20808 messages arrive at the same time, the file will be scrambled. You can use the
20809 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20810 file using the same algorithm that Exim itself uses.
20811
20812
20813
20814
20815 .section "Uids and gids" "SECTenvuidgid"
20816 .cindex "local transports" "uid and gid"
20817 .cindex "transport" "local; uid and gid"
20818 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20819 overrides any group that the router set in the address, even if &%user%& is not
20820 set for the transport. This makes it possible, for example, to run local mail
20821 delivery under the uid of the recipient (set by the router), but in a special
20822 group (set by the transport). For example:
20823 .code
20824 # Routers ...
20825 # User/group are set by check_local_user in this router
20826 local_users:
20827   driver = accept
20828   check_local_user
20829   transport = group_delivery
20830
20831 # Transports ...
20832 # This transport overrides the group
20833 group_delivery:
20834   driver = appendfile
20835   file = /var/spool/mail/$local_part
20836   group = mail
20837 .endd
20838 If &%user%& is set for a transport, its value overrides what is set in the
20839 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20840 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20841 set.
20842
20843 .oindex "&%initgroups%&"
20844 When the uid is taken from the transport's configuration, the &[initgroups()]&
20845 function is called for the groups associated with that uid if the
20846 &%initgroups%& option is set for the transport. When the uid is not specified
20847 by the transport, but is associated with the address by a router, the option
20848 for calling &[initgroups()]& is taken from the router configuration.
20849
20850 .cindex "&(pipe)& transport" "uid for"
20851 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20852 is set and &%user%& is not set, the uid of the process that called Exim to
20853 receive the message is used, and if &%group%& is not set, the corresponding
20854 original gid is also used.
20855
20856 This is the detailed preference order for obtaining a gid; the first of the
20857 following that is set is used:
20858
20859 .ilist
20860 A &%group%& setting of the transport;
20861 .next
20862 A &%group%& setting of the router;
20863 .next
20864 A gid associated with a user setting of the router, either as a result of
20865 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20866 .next
20867 The group associated with a non-numeric &%user%& setting of the transport;
20868 .next
20869 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20870 the uid is the creator's uid;
20871 .next
20872 The Exim gid if the Exim uid is being used as a default.
20873 .endlist
20874
20875 If, for example, the user is specified numerically on the router and there are
20876 no group settings, no gid is available. In this situation, an error occurs.
20877 This is different for the uid, for which there always is an ultimate default.
20878 The first of the following that is set is used:
20879
20880 .ilist
20881 A &%user%& setting of the transport;
20882 .next
20883 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20884 .next
20885 A &%user%& setting of the router;
20886 .next
20887 A &%check_local_user%& setting of the router;
20888 .next
20889 The Exim uid.
20890 .endlist
20891
20892 Of course, an error will still occur if the uid that is chosen is on the
20893 &%never_users%& list.
20894
20895
20896
20897
20898
20899 .section "Current and home directories" "SECID132"
20900 .cindex "current directory for local transport"
20901 .cindex "home directory" "for local transport"
20902 .cindex "transport" "local; home directory for"
20903 .cindex "transport" "local; current directory for"
20904 Routers may set current and home directories for local transports by means of
20905 the &%transport_current_directory%& and &%transport_home_directory%& options.
20906 However, if the transport's &%current_directory%& or &%home_directory%& options
20907 are set, they override the router's values. In detail, the home directory
20908 for a local transport is taken from the first of these values that is set:
20909
20910 .ilist
20911 The &%home_directory%& option on the transport;
20912 .next
20913 The &%transport_home_directory%& option on the router;
20914 .next
20915 The password data if &%check_local_user%& is set on the router;
20916 .next
20917 The &%router_home_directory%& option on the router.
20918 .endlist
20919
20920 The current directory is taken from the first of these values that is set:
20921
20922 .ilist
20923 The &%current_directory%& option on the transport;
20924 .next
20925 The &%transport_current_directory%& option on the router.
20926 .endlist
20927
20928
20929 If neither the router nor the transport sets a current directory, Exim uses the
20930 value of the home directory, if it is set. Otherwise it sets the current
20931 directory to &_/_& before running a local transport.
20932
20933
20934
20935 .section "Expansion variables derived from the address" "SECID133"
20936 .vindex "&$domain$&"
20937 .vindex "&$local_part$&"
20938 .vindex "&$original_domain$&"
20939 Normally a local delivery is handling a single address, and in that case the
20940 variables such as &$domain$& and &$local_part$& are set during local
20941 deliveries. However, in some circumstances more than one address may be handled
20942 at once (for example, while writing batch SMTP for onward transmission by some
20943 other means). In this case, the variables associated with the local part are
20944 never set, &$domain$& is set only if all the addresses have the same domain,
20945 and &$original_domain$& is never set.
20946 .ecindex IIDenvlotra1
20947 .ecindex IIDenvlotra2
20948 .ecindex IIDenvlotra3
20949
20950
20951
20952
20953
20954
20955
20956 . ////////////////////////////////////////////////////////////////////////////
20957 . ////////////////////////////////////////////////////////////////////////////
20958
20959 .chapter "Generic options for transports" "CHAPtransportgeneric"
20960 .scindex IIDgenoptra1 "generic options" "transport"
20961 .scindex IIDgenoptra2 "options" "generic; for transports"
20962 .scindex IIDgenoptra3 "transport" "generic options for"
20963 The following generic options apply to all transports:
20964
20965
20966 .option body_only transports boolean false
20967 .cindex "transport" "body only"
20968 .cindex "message" "transporting body only"
20969 .cindex "body of message" "transporting"
20970 If this option is set, the message's headers are not transported. It is
20971 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20972 or &(pipe)& transports, the settings of &%message_prefix%& and
20973 &%message_suffix%& should be checked, because this option does not
20974 automatically suppress them.
20975
20976
20977 .option current_directory transports string&!! unset
20978 .cindex "transport" "current directory for"
20979 This specifies the current directory that is to be set while running the
20980 transport, overriding any value that may have been set by the router.
20981 If the expansion fails for any reason, including forced failure, an error is
20982 logged, and delivery is deferred.
20983
20984
20985 .option disable_logging transports boolean false
20986 If this option is set true, nothing is logged for any
20987 deliveries by the transport or for any
20988 transport errors. You should not set this option unless you really, really know
20989 what you are doing.
20990
20991
20992 .option debug_print transports string&!! unset
20993 .cindex "testing" "variables in drivers"
20994 If this option is set and debugging is enabled (see the &%-d%& command line
20995 option), the string is expanded and included in the debugging output when the
20996 transport is run.
20997 If expansion of the string fails, the error message is written to the debugging
20998 output, and Exim carries on processing.
20999 This facility is provided to help with checking out the values of variables and
21000 so on when debugging driver configurations. For example, if a &%headers_add%&
21001 option is not working properly, &%debug_print%& could be used to output the
21002 variables it references. A newline is added to the text if it does not end with
21003 one.
21004 The variables &$transport_name$& and &$router_name$& contain the name of the
21005 transport and the router that called it.
21006
21007 .option delivery_date_add transports boolean false
21008 .cindex "&'Delivery-date:'& header line"
21009 If this option is true, a &'Delivery-date:'& header is added to the message.
21010 This gives the actual time the delivery was made. As this is not a standard
21011 header, Exim has a configuration option (&%delivery_date_remove%&) which
21012 requests its removal from incoming messages, so that delivered messages can
21013 safely be resent to other recipients.
21014
21015
21016 .option driver transports string unset
21017 This specifies which of the available transport drivers is to be used.
21018 There is no default, and this option must be set for every transport.
21019
21020
21021 .option envelope_to_add transports boolean false
21022 .cindex "&'Envelope-to:'& header line"
21023 If this option is true, an &'Envelope-to:'& header is added to the message.
21024 This gives the original address(es) in the incoming envelope that caused this
21025 delivery to happen. More than one address may be present if the transport is
21026 configured to handle several addresses at once, or if more than one original
21027 address was redirected to the same final address. As this is not a standard
21028 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21029 its removal from incoming messages, so that delivered messages can safely be
21030 resent to other recipients.
21031
21032
21033 .option event_action transports string&!! unset
21034 .cindex events
21035 This option declares a string to be expanded for Exim's events mechanism.
21036 For details see chapter &<<CHAPevents>>&.
21037
21038
21039 .option group transports string&!! "Exim group"
21040 .cindex "transport" "group; specifying"
21041 This option specifies a gid for running the transport process, overriding any
21042 value that the router supplies, and also overriding any value associated with
21043 &%user%& (see below).
21044
21045
21046 .option headers_add transports list&!! unset
21047 .cindex "header lines" "adding in transport"
21048 .cindex "transport" "header lines; adding"
21049 This option specifies a list of text headers,
21050 newline-separated (by default, changeable in the usual way),
21051 which are (separately) expanded and added to the header
21052 portion of a message as it is transported, as described in section
21053 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21054 routers. If the result of the expansion is an empty string, or if the expansion
21055 is forced to fail, no action is taken. Other expansion failures are treated as
21056 errors and cause the delivery to be deferred.
21057
21058 Unlike most options, &%headers_add%& can be specified multiple times
21059 for a transport; all listed headers are added.
21060
21061
21062 .option headers_only transports boolean false
21063 .cindex "transport" "header lines only"
21064 .cindex "message" "transporting headers only"
21065 .cindex "header lines" "transporting"
21066 If this option is set, the message's body is not transported. It is mutually
21067 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21068 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21069 checked, since this option does not automatically suppress them.
21070
21071
21072 .option headers_remove transports list&!! unset
21073 .cindex "header lines" "removing"
21074 .cindex "transport" "header lines; removing"
21075 This option specifies a list of header names,
21076 colon-separated (by default, changeable in the usual way);
21077 these headers are omitted from the message as it is transported, as described
21078 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21079 routers.
21080 Each list item is separately expanded.
21081 If the result of the expansion is an empty string, or if the expansion
21082 is forced to fail, no action is taken. Other expansion failures are treated as
21083 errors and cause the delivery to be deferred.
21084
21085 Unlike most options, &%headers_remove%& can be specified multiple times
21086 for a transport; all listed headers are removed.
21087
21088 &*Warning*&: Because of the separate expansion of the list items,
21089 items that contain a list separator must have it doubled.
21090 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21091
21092
21093
21094 .option headers_rewrite transports string unset
21095 .cindex "transport" "header lines; rewriting"
21096 .cindex "rewriting" "at transport time"
21097 This option allows addresses in header lines to be rewritten at transport time,
21098 that is, as the message is being copied to its destination. The contents of the
21099 option are a colon-separated list of rewriting rules. Each rule is in exactly
21100 the same form as one of the general rewriting rules that are applied when a
21101 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21102 example,
21103 .code
21104 headers_rewrite = a@b c@d f : \
21105                   x@y w@z
21106 .endd
21107 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21108 &'w@z'& in all address-bearing header lines. The rules are applied to the
21109 header lines just before they are written out at transport time, so they affect
21110 only those copies of the message that pass through the transport. However, only
21111 the message's original header lines, and any that were added by a system
21112 filter, are rewritten. If a router or transport adds header lines, they are not
21113 affected by this option. These rewriting rules are &'not'& applied to the
21114 envelope. You can change the return path using &%return_path%&, but you cannot
21115 change envelope recipients at this time.
21116
21117
21118 .option home_directory transports string&!! unset
21119 .cindex "transport" "home directory for"
21120 .vindex "&$home$&"
21121 This option specifies a home directory setting for a local transport,
21122 overriding any value that may be set by the router. The home directory is
21123 placed in &$home$& while expanding the transport's private options. It is also
21124 used as the current directory if no current directory is set by the
21125 &%current_directory%& option on the transport or the
21126 &%transport_current_directory%& option on the router. If the expansion fails
21127 for any reason, including forced failure, an error is logged, and delivery is
21128 deferred.
21129
21130
21131 .option initgroups transports boolean false
21132 .cindex "additional groups"
21133 .cindex "groups" "additional"
21134 .cindex "transport" "group; additional"
21135 If this option is true and the uid for the delivery process is provided by the
21136 transport, the &[initgroups()]& function is called when running the transport
21137 to ensure that any additional groups associated with the uid are set up.
21138
21139
21140 .option max_parallel transports integer&!! unset
21141 .cindex limit "transport parallelism"
21142 .cindex transport "parallel processes"
21143 .cindex transport "concurrency limit"
21144 .cindex "delivery" "parallelism for transport"
21145 If this option is set and expands to an integer greater than zero
21146 it limits the number of concurrent runs of the transport.
21147 The control does not apply to shadow transports.
21148
21149 .cindex "hints database" "transport concurrency control"
21150 Exim implements this control by means of a hints database in which a record is
21151 incremented whenever a transport process is being created. The record
21152 is decremented and possibly removed when the process terminates.
21153 Obviously there is scope for
21154 records to get left lying around if there is a system or program crash. To
21155 guard against this, Exim ignores any records that are more than six hours old.
21156
21157 If you use this option, you should also arrange to delete the
21158 relevant hints database whenever your system reboots. The names of the files
21159 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21160 may be one or two files, depending on the type of DBM in use. The same files
21161 are used for ETRN and smtp transport serialization.
21162
21163
21164 .option message_size_limit transports string&!! 0
21165 .cindex "limit" "message size per transport"
21166 .cindex "size" "of message, limit"
21167 .cindex "transport" "message size; limiting"
21168 This option controls the size of messages passed through the transport. It is
21169 expanded before use; the result of the expansion must be a sequence of decimal
21170 digits, optionally followed by K or M. If the expansion fails for any reason,
21171 including forced failure, or if the result is not of the required form,
21172 delivery is deferred. If the value is greater than zero and the size of a
21173 message exceeds this limit, the address is failed. If there is any chance that
21174 the resulting bounce message could be routed to the same transport, you should
21175 ensure that &%return_size_limit%& is less than the transport's
21176 &%message_size_limit%&, as otherwise the bounce message will fail to get
21177 delivered.
21178
21179
21180
21181 .option rcpt_include_affixes transports boolean false
21182 .cindex "prefix" "for local part, including in envelope"
21183 .cindex "suffix for local part" "including in envelope"
21184 .cindex "local part" "prefix"
21185 .cindex "local part" "suffix"
21186 When this option is false (the default), and an address that has had any
21187 affixes (prefixes or suffixes) removed from the local part is delivered by any
21188 form of SMTP or LMTP, the affixes are not included. For example, if a router
21189 that contains
21190 .code
21191 local_part_prefix = *-
21192 .endd
21193 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21194 is delivered with
21195 .code
21196 RCPT TO:<xyz@some.domain>
21197 .endd
21198 This is also the case when an ACL-time callout is being used to verify a
21199 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21200 whole local part is included in the RCPT command. This option applies to BSMTP
21201 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21202 &(lmtp)& and &(smtp)& transports.
21203
21204
21205 .option retry_use_local_part transports boolean "see below"
21206 .cindex "hints database" "retry keys"
21207 When a delivery suffers a temporary failure, a retry record is created
21208 in Exim's hints database. For remote deliveries, the key for the retry record
21209 is based on the name and/or IP address of the failing remote host. For local
21210 deliveries, the key is normally the entire address, including both the local
21211 part and the domain. This is suitable for most common cases of local delivery
21212 temporary failure &-- for example, exceeding a mailbox quota should delay only
21213 deliveries to that mailbox, not to the whole domain.
21214
21215 However, in some special cases you may want to treat a temporary local delivery
21216 as a failure associated with the domain, and not with a particular local part.
21217 (For example, if you are storing all mail for some domain in files.) You can do
21218 this by setting &%retry_use_local_part%& false.
21219
21220 For all the local transports, its default value is true. For remote transports,
21221 the default value is false for tidiness, but changing the value has no effect
21222 on a remote transport in the current implementation.
21223
21224
21225 .option return_path transports string&!! unset
21226 .cindex "envelope sender"
21227 .cindex "transport" "return path; changing"
21228 .cindex "return path" "changing in transport"
21229 If this option is set, the string is expanded at transport time and replaces
21230 the existing return path (envelope sender) value in the copy of the message
21231 that is being delivered. An empty return path is permitted. This feature is
21232 designed for remote deliveries, where the value of this option is used in the
21233 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21234 only effect is to change the address that is placed in the &'Return-path:'&
21235 header line, if one is added to the message (see the next option).
21236
21237 &*Note:*& A changed return path is not logged unless you add
21238 &%return_path_on_delivery%& to the log selector.
21239
21240 .vindex "&$return_path$&"
21241 The expansion can refer to the existing value via &$return_path$&. This is
21242 either the message's envelope sender, or an address set by the
21243 &%errors_to%& option on a router. If the expansion is forced to fail, no
21244 replacement occurs; if it fails for another reason, delivery is deferred. This
21245 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21246 section &<<SECTverp>>&.
21247
21248 &*Note*&: If a delivery error is detected locally, including the case when a
21249 remote server rejects a message at SMTP time, the bounce message is not sent to
21250 the value of this option. It is sent to the previously set errors address.
21251 This defaults to the incoming sender address, but can be changed by setting
21252 &%errors_to%& in a router.
21253
21254
21255
21256 .option return_path_add transports boolean false
21257 .cindex "&'Return-path:'& header line"
21258 If this option is true, a &'Return-path:'& header is added to the message.
21259 Although the return path is normally available in the prefix line of BSD
21260 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21261 have easy access to it.
21262
21263 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21264 the delivery SMTP server makes the final delivery"&. This implies that this
21265 header should not be present in incoming messages. Exim has a configuration
21266 option, &%return_path_remove%&, which requests removal of this header from
21267 incoming messages, so that delivered messages can safely be resent to other
21268 recipients.
21269
21270
21271 .option shadow_condition transports string&!! unset
21272 See &%shadow_transport%& below.
21273
21274
21275 .option shadow_transport transports string unset
21276 .cindex "shadow transport"
21277 .cindex "transport" "shadow"
21278 A local transport may set the &%shadow_transport%& option to the name of
21279 another local transport. Shadow remote transports are not supported.
21280
21281 Whenever a delivery to the main transport succeeds, and either
21282 &%shadow_condition%& is unset, or its expansion does not result in the empty
21283 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21284 passed to the shadow transport, with the same delivery address or addresses. If
21285 expansion fails, no action is taken except that non-forced expansion failures
21286 cause a log line to be written.
21287
21288 The result of the shadow transport is discarded and does not affect the
21289 subsequent processing of the message. Only a single level of shadowing is
21290 provided; the &%shadow_transport%& option is ignored on any transport when it
21291 is running as a shadow. Options concerned with output from pipes are also
21292 ignored. The log line for the successful delivery has an item added on the end,
21293 of the form
21294 .code
21295 ST=<shadow transport name>
21296 .endd
21297 If the shadow transport did not succeed, the error message is put in
21298 parentheses afterwards. Shadow transports can be used for a number of different
21299 purposes, including keeping more detailed log information than Exim normally
21300 provides, and implementing automatic acknowledgment policies based on message
21301 headers that some sites insist on.
21302
21303
21304 .option transport_filter transports string&!! unset
21305 .cindex "transport" "filter"
21306 .cindex "filter" "transport filter"
21307 This option sets up a filtering (in the Unix shell sense) process for messages
21308 at transport time. It should not be confused with mail filtering as set up by
21309 individual users or via a system filter.
21310 If unset, or expanding to an empty string, no filtering is done.
21311
21312 When the message is about to be written out, the command specified by
21313 &%transport_filter%& is started up in a separate, parallel process, and
21314 the entire message, including the header lines, is passed to it on its standard
21315 input (this in fact is done from a third process, to avoid deadlock). The
21316 command must be specified as an absolute path.
21317
21318 The lines of the message that are written to the transport filter are
21319 terminated by newline (&"\n"&). The message is passed to the filter before any
21320 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21321 lines beginning with a dot, and also before any processing implied by the
21322 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21323 &(pipe)& transports.
21324
21325 The standard error for the filter process is set to the same destination as its
21326 standard output; this is read and written to the message's ultimate
21327 destination. The process that writes the message to the filter, the
21328 filter itself, and the original process that reads the result and delivers it
21329 are all run in parallel, like a shell pipeline.
21330
21331 The filter can perform any transformations it likes, but of course should take
21332 care not to break RFC 2822 syntax. Exim does not check the result, except to
21333 test for a final newline when SMTP is in use. All messages transmitted over
21334 SMTP must end with a newline, so Exim supplies one if it is missing.
21335
21336 .cindex "content scanning" "per user"
21337 A transport filter can be used to provide content-scanning on a per-user basis
21338 at delivery time if the only required effect of the scan is to modify the
21339 message. For example, a content scan could insert a new header line containing
21340 a spam score. This could be interpreted by a filter in the user's MUA. It is
21341 not possible to discard a message at this stage.
21342
21343 .cindex "SMTP" "SIZE"
21344 A problem might arise if the filter increases the size of a message that is
21345 being sent down an SMTP connection. If the receiving SMTP server has indicated
21346 support for the SIZE parameter, Exim will have sent the size of the message
21347 at the start of the SMTP session. If what is actually sent is substantially
21348 more, the server might reject the message. This can be worked round by setting
21349 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21350 additions to the message, or to disable the use of SIZE altogether.
21351
21352 .vindex "&$pipe_addresses$&"
21353 The value of the &%transport_filter%& option is the command string for starting
21354 the filter, which is run directly from Exim, not under a shell. The string is
21355 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21356 Exim breaks it up into arguments and then expands each argument separately (see
21357 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21358 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21359 of arguments, one for each address that applies to this delivery. (This isn't
21360 an ideal name for this feature here, but as it was already implemented for the
21361 &(pipe)& transport, it seemed sensible not to change it.)
21362
21363 .vindex "&$host$&"
21364 .vindex "&$host_address$&"
21365 The expansion variables &$host$& and &$host_address$& are available when the
21366 transport is a remote one. They contain the name and IP address of the host to
21367 which the message is being sent. For example:
21368 .code
21369 transport_filter = /some/directory/transport-filter.pl \
21370   $host $host_address $sender_address $pipe_addresses
21371 .endd
21372
21373 Two problems arise if you want to use more complicated expansion items to
21374 generate transport filter commands, both of which due to the fact that the
21375 command is split up &'before'& expansion.
21376 .ilist
21377 If an expansion item contains white space, you must quote it, so that it is all
21378 part of the same command item. If the entire option setting is one such
21379 expansion item, you have to take care what kind of quoting you use. For
21380 example:
21381 .code
21382 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21383 .endd
21384 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21385 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21386 stripped by Exim when it read the option's value. When the value is used, if
21387 the single quotes were missing, the line would be split into two items,
21388 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21389 Exim tried to expand the first one.
21390 .next
21391 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21392 expansion cannot generate multiple arguments, or a command name followed by
21393 arguments. Consider this example:
21394 .code
21395 transport_filter = ${lookup{$host}lsearch{/a/file}\
21396                     {$value}{/bin/cat}}
21397 .endd
21398 The result of the lookup is interpreted as the name of the command, even
21399 if it contains white space. The simplest way round this is to use a shell:
21400 .code
21401 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21402                                {$value}{/bin/cat}}
21403 .endd
21404 .endlist
21405
21406 The filter process is run under the same uid and gid as the normal delivery.
21407 For remote deliveries this is the Exim uid/gid by default. The command should
21408 normally yield a zero return code. Transport filters are not supposed to fail.
21409 A non-zero code is taken to mean that the transport filter encountered some
21410 serious problem. Delivery of the message is deferred; the message remains on
21411 the queue and is tried again later. It is not possible to cause a message to be
21412 bounced from a transport filter.
21413
21414 If a transport filter is set on an autoreply transport, the original message is
21415 passed through the filter as it is being copied into the newly generated
21416 message, which happens if the &%return_message%& option is set.
21417
21418
21419 .option transport_filter_timeout transports time 5m
21420 .cindex "transport" "filter, timeout"
21421 When Exim is reading the output of a transport filter, it applies a timeout
21422 that can be set by this option. Exceeding the timeout is normally treated as a
21423 temporary delivery failure. However, if a transport filter is used with a
21424 &(pipe)& transport, a timeout in the transport filter is treated in the same
21425 way as a timeout in the pipe command itself. By default, a timeout is a hard
21426 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21427 becomes a temporary error.
21428
21429
21430 .option user transports string&!! "Exim user"
21431 .cindex "uid (user id)" "local delivery"
21432 .cindex "transport" "user, specifying"
21433 This option specifies the user under whose uid the delivery process is to be
21434 run, overriding any uid that may have been set by the router. If the user is
21435 given as a name, the uid is looked up from the password data, and the
21436 associated group is taken as the value of the gid to be used if the &%group%&
21437 option is not set.
21438
21439 For deliveries that use local transports, a user and group are normally
21440 specified explicitly or implicitly (for example, as a result of
21441 &%check_local_user%&) by the router or transport.
21442
21443 .cindex "hints database" "access by remote transport"
21444 For remote transports, you should leave this option unset unless you really are
21445 sure you know what you are doing. When a remote transport is running, it needs
21446 to be able to access Exim's hints databases, because each host may have its own
21447 retry data.
21448 .ecindex IIDgenoptra1
21449 .ecindex IIDgenoptra2
21450 .ecindex IIDgenoptra3
21451
21452
21453
21454
21455
21456
21457 . ////////////////////////////////////////////////////////////////////////////
21458 . ////////////////////////////////////////////////////////////////////////////
21459
21460 .chapter "Address batching in local transports" "CHAPbatching" &&&
21461          "Address batching"
21462 .cindex "transport" "local; address batching in"
21463 The only remote transport (&(smtp)&) is normally configured to handle more than
21464 one address at a time, so that when several addresses are routed to the same
21465 remote host, just one copy of the message is sent. Local transports, however,
21466 normally handle one address at a time. That is, a separate instance of the
21467 transport is run for each address that is routed to the transport. A separate
21468 copy of the message is delivered each time.
21469
21470 .cindex "batched local delivery"
21471 .oindex "&%batch_max%&"
21472 .oindex "&%batch_id%&"
21473 In special cases, it may be desirable to handle several addresses at once in a
21474 local transport, for example:
21475
21476 .ilist
21477 In an &(appendfile)& transport, when storing messages in files for later
21478 delivery by some other means, a single copy of the message with multiple
21479 recipients saves space.
21480 .next
21481 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21482 a single copy saves time, and is the normal way LMTP is expected to work.
21483 .next
21484 In a &(pipe)& transport, when passing the message
21485 to a scanner program or
21486 to some other delivery mechanism such as UUCP, multiple recipients may be
21487 acceptable.
21488 .endlist
21489
21490 These three local transports all have the same options for controlling multiple
21491 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21492 repeating the information for each transport, these options are described here.
21493
21494 The &%batch_max%& option specifies the maximum number of addresses that can be
21495 delivered together in a single run of the transport. Its default value is one
21496 (no batching). When more than one address is routed to a transport that has a
21497 &%batch_max%& value greater than one, the addresses are delivered in a batch
21498 (that is, in a single run of the transport with multiple recipients), subject
21499 to certain conditions:
21500
21501 .ilist
21502 .vindex "&$local_part$&"
21503 If any of the transport's options contain a reference to &$local_part$&, no
21504 batching is possible.
21505 .next
21506 .vindex "&$domain$&"
21507 If any of the transport's options contain a reference to &$domain$&, only
21508 addresses with the same domain are batched.
21509 .next
21510 .cindex "customizing" "batching condition"
21511 If &%batch_id%& is set, it is expanded for each address, and only those
21512 addresses with the same expanded value are batched. This allows you to specify
21513 customized batching conditions. Failure of the expansion for any reason,
21514 including forced failure, disables batching, but it does not stop the delivery
21515 from taking place.
21516 .next
21517 Batched addresses must also have the same errors address (where to send
21518 delivery errors), the same header additions and removals, the same user and
21519 group for the transport, and if a host list is present, the first host must
21520 be the same.
21521 .endlist
21522
21523 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21524 both when the file or pipe command is specified in the transport, and when it
21525 is specified by a &(redirect)& router, but all the batched addresses must of
21526 course be routed to the same file or pipe command. These two transports have an
21527 option called &%use_bsmtp%&, which causes them to deliver the message in
21528 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21529 &%check_string%& and &%escape_string%& options are forced to the values
21530 .code
21531 check_string = "."
21532 escape_string = ".."
21533 .endd
21534 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21535 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21536 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21537
21538 .cindex "&'Envelope-to:'& header line"
21539 If the generic &%envelope_to_add%& option is set for a batching transport, the
21540 &'Envelope-to:'& header that is added to the message contains all the addresses
21541 that are being processed together. If you are using a batching &(appendfile)&
21542 transport without &%use_bsmtp%&, the only way to preserve the recipient
21543 addresses is to set the &%envelope_to_add%& option.
21544
21545 .cindex "&(pipe)& transport" "with multiple addresses"
21546 .vindex "&$pipe_addresses$&"
21547 If you are using a &(pipe)& transport without BSMTP, and setting the
21548 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21549 the command. This is not a true variable; it is a bit of magic that causes each
21550 of the recipient addresses to be inserted into the command as a separate
21551 argument. This provides a way of accessing all the addresses that are being
21552 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21553 are specified by a &(redirect)& router.
21554
21555
21556
21557
21558 . ////////////////////////////////////////////////////////////////////////////
21559 . ////////////////////////////////////////////////////////////////////////////
21560
21561 .chapter "The appendfile transport" "CHAPappendfile"
21562 .scindex IIDapptra1 "&(appendfile)& transport"
21563 .scindex IIDapptra2 "transports" "&(appendfile)&"
21564 .cindex "directory creation"
21565 .cindex "creating directories"
21566 The &(appendfile)& transport delivers a message by appending it to an existing
21567 file, or by creating an entirely new file in a specified directory. Single
21568 files to which messages are appended can be in the traditional Unix mailbox
21569 format, or optionally in the MBX format supported by the Pine MUA and
21570 University of Washington IMAP daemon, &'inter alia'&. When each message is
21571 being delivered as a separate file, &"maildir"& format can optionally be used
21572 to give added protection against failures that happen part-way through the
21573 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21574 supported. For all file formats, Exim attempts to create as many levels of
21575 directory as necessary, provided that &%create_directory%& is set.
21576
21577 The code for the optional formats is not included in the Exim binary by
21578 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21579 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21580 included.
21581
21582 .cindex "quota" "system"
21583 Exim recognizes system quota errors, and generates an appropriate message. Exim
21584 also supports its own quota control within the transport, for use when the
21585 system facility is unavailable or cannot be used for some reason.
21586
21587 If there is an error while appending to a file (for example, quota exceeded or
21588 partition filled), Exim attempts to reset the file's length and last
21589 modification time back to what they were before. If there is an error while
21590 creating an entirely new file, the new file is removed.
21591
21592 Before appending to a file, a number of security checks are made, and the
21593 file is locked. A detailed description is given below, after the list of
21594 private options.
21595
21596 The &(appendfile)& transport is most commonly used for local deliveries to
21597 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21598 putting messages into files for remote delivery by some means other than Exim.
21599 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21600 option).
21601
21602
21603
21604 .section "The file and directory options" "SECTfildiropt"
21605 The &%file%& option specifies a single file, to which the message is appended;
21606 the &%directory%& option specifies a directory, in which a new file containing
21607 the message is created. Only one of these two options can be set, and for
21608 normal deliveries to mailboxes, one of them &'must'& be set.
21609
21610 .vindex "&$address_file$&"
21611 .vindex "&$local_part$&"
21612 However, &(appendfile)& is also used for delivering messages to files or
21613 directories whose names (or parts of names) are obtained from alias,
21614 forwarding, or filtering operations (for example, a &%save%& command in a
21615 user's Exim filter). When such a transport is running, &$local_part$& contains
21616 the local part that was aliased or forwarded, and &$address_file$& contains the
21617 name (or partial name) of the file or directory generated by the redirection
21618 operation. There are two cases:
21619
21620 .ilist
21621 If neither &%file%& nor &%directory%& is set, the redirection operation
21622 must specify an absolute path (one that begins with &`/`&). This is the most
21623 common case when users with local accounts use filtering to sort mail into
21624 different folders. See for example, the &(address_file)& transport in the
21625 default configuration. If the path ends with a slash, it is assumed to be the
21626 name of a directory. A delivery to a directory can also be forced by setting
21627 &%maildir_format%& or &%mailstore_format%&.
21628 .next
21629 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21630 used to determine the file or directory name for the delivery. Normally, the
21631 contents of &$address_file$& are used in some way in the string expansion.
21632 .endlist
21633
21634
21635 .cindex "Sieve filter" "configuring &(appendfile)&"
21636 .cindex "Sieve filter" "relative mailbox path handling"
21637 As an example of the second case, consider an environment where users do not
21638 have home directories. They may be permitted to use Exim filter commands of the
21639 form:
21640 .code
21641 save folder23
21642 .endd
21643 or Sieve filter commands of the form:
21644 .code
21645 require "fileinto";
21646 fileinto "folder23";
21647 .endd
21648 In this situation, the expansion of &%file%& or &%directory%& in the transport
21649 must transform the relative path into an appropriate absolute file name. In the
21650 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21651 is used as a result of a &"keep"& action in the filter. This example shows one
21652 way of handling this requirement:
21653 .code
21654 file = ${if eq{$address_file}{inbox} \
21655             {/var/mail/$local_part} \
21656             {${if eq{${substr_0_1:$address_file}}{/} \
21657                   {$address_file} \
21658                   {$home/mail/$address_file} \
21659             }} \
21660        }
21661 .endd
21662 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21663 location, absolute paths are used without change, and other folders are in the
21664 &_mail_& directory within the home directory.
21665
21666 &*Note 1*&: While processing an Exim filter, a relative path such as
21667 &_folder23_& is turned into an absolute path if a home directory is known to
21668 the router. In particular, this is the case if &%check_local_user%& is set. If
21669 you want to prevent this happening at routing time, you can set
21670 &%router_home_directory%& empty. This forces the router to pass the relative
21671 path to the transport.
21672
21673 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21674 the &%file%& or &%directory%& option is still used if it is set.
21675
21676
21677
21678
21679 .section "Private options for appendfile" "SECID134"
21680 .cindex "options" "&(appendfile)& transport"
21681
21682
21683
21684 .option allow_fifo appendfile boolean false
21685 .cindex "fifo (named pipe)"
21686 .cindex "named pipe (fifo)"
21687 .cindex "pipe" "named (fifo)"
21688 Setting this option permits delivery to named pipes (FIFOs) as well as to
21689 regular files. If no process is reading the named pipe at delivery time, the
21690 delivery is deferred.
21691
21692
21693 .option allow_symlink appendfile boolean false
21694 .cindex "symbolic link" "to mailbox"
21695 .cindex "mailbox" "symbolic link"
21696 By default, &(appendfile)& will not deliver if the path name for the file is
21697 that of a symbolic link. Setting this option relaxes that constraint, but there
21698 are security issues involved in the use of symbolic links. Be sure you know
21699 what you are doing if you set this. Details of exactly what this option affects
21700 are included in the discussion which follows this list of options.
21701
21702
21703 .option batch_id appendfile string&!! unset
21704 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21705 However, batching is automatically disabled for &(appendfile)& deliveries that
21706 happen as a result of forwarding or aliasing or other redirection directly to a
21707 file.
21708
21709
21710 .option batch_max appendfile integer 1
21711 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21712
21713
21714 .option check_group appendfile boolean false
21715 When this option is set, the group owner of the file defined by the &%file%&
21716 option is checked to see that it is the same as the group under which the
21717 delivery process is running. The default setting is false because the default
21718 file mode is 0600, which means that the group is irrelevant.
21719
21720
21721 .option check_owner appendfile boolean true
21722 When this option is set, the owner of the file defined by the &%file%& option
21723 is checked to ensure that it is the same as the user under which the delivery
21724 process is running.
21725
21726
21727 .option check_string appendfile string "see below"
21728 .cindex "&""From""& line"
21729 As &(appendfile)& writes the message, the start of each line is tested for
21730 matching &%check_string%&, and if it does, the initial matching characters are
21731 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21732 a literal string, not a regular expression, and the case of any letters it
21733 contains is significant.
21734
21735 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21736 are forced to &"."& and &".."& respectively, and any settings in the
21737 configuration are ignored. Otherwise, they default to &"From&~"& and
21738 &">From&~"& when the &%file%& option is set, and unset when any of the
21739 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21740
21741 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21742 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21743 &"From&~"& indicates the start of a new message. All four options need changing
21744 if another format is used. For example, to deliver to mailboxes in MMDF format:
21745 .cindex "MMDF format mailbox"
21746 .cindex "mailbox" "MMDF format"
21747 .code
21748 check_string = "\1\1\1\1\n"
21749 escape_string = "\1\1\1\1 \n"
21750 message_prefix = "\1\1\1\1\n"
21751 message_suffix = "\1\1\1\1\n"
21752 .endd
21753 .option create_directory appendfile boolean true
21754 .cindex "directory creation"
21755 When this option is true, Exim attempts to create any missing superior
21756 directories for the file that it is about to write. A created directory's mode
21757 is given by the &%directory_mode%& option.
21758
21759 The group ownership of a newly created directory is highly dependent on the
21760 operating system (and possibly the file system) that is being used. For
21761 example, in Solaris, if the parent directory has the setgid bit set, its group
21762 is propagated to the child; if not, the currently set group is used. However,
21763 in FreeBSD, the parent's group is always used.
21764
21765
21766
21767 .option create_file appendfile string anywhere
21768 This option constrains the location of files and directories that are created
21769 by this transport. It applies to files defined by the &%file%& option and
21770 directories defined by the &%directory%& option. In the case of maildir
21771 delivery, it applies to the top level directory, not the maildir directories
21772 beneath.
21773
21774 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21775 &"belowhome"&. In the second and third cases, a home directory must have been
21776 set for the transport. This option is not useful when an explicit file name is
21777 given for normal mailbox deliveries. It is intended for the case when file
21778 names are generated from users' &_.forward_& files. These are usually handled
21779 by an &(appendfile)& transport called &%address_file%&. See also
21780 &%file_must_exist%&.
21781
21782
21783 .option directory appendfile string&!! unset
21784 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21785 or &%directory%& must be set, unless the delivery is the direct result of a
21786 redirection (see section &<<SECTfildiropt>>&).
21787
21788 When &%directory%& is set, the string is expanded, and the message is delivered
21789 into a new file or files in or below the given directory, instead of being
21790 appended to a single mailbox file. A number of different formats are provided
21791 (see &%maildir_format%& and &%mailstore_format%&), and see section
21792 &<<SECTopdir>>& for further details of this form of delivery.
21793
21794
21795 .option directory_file appendfile string&!! "see below"
21796 .cindex "base62"
21797 .vindex "&$inode$&"
21798 When &%directory%& is set, but neither &%maildir_format%& nor
21799 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21800 whose name is obtained by expanding this string. The default value is:
21801 .code
21802 q${base62:$tod_epoch}-$inode
21803 .endd
21804 This generates a unique name from the current time, in base 62 form, and the
21805 inode of the file. The variable &$inode$& is available only when expanding this
21806 option.
21807
21808
21809 .option directory_mode appendfile "octal integer" 0700
21810 If &(appendfile)& creates any directories as a result of the
21811 &%create_directory%& option, their mode is specified by this option.
21812
21813
21814 .option escape_string appendfile string "see description"
21815 See &%check_string%& above.
21816
21817
21818 .option file appendfile string&!! unset
21819 This option is mutually exclusive with the &%directory%& option, but one of
21820 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21821 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21822 specifies a single file, to which the message is appended. One or more of
21823 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21824 &%file%&.
21825
21826 .cindex "NFS" "lock file"
21827 .cindex "locking files"
21828 .cindex "lock files"
21829 If you are using more than one host to deliver over NFS into the same
21830 mailboxes, you should always use lock files.
21831
21832 The string value is expanded for each delivery, and must yield an absolute
21833 path. The most common settings of this option are variations on one of these
21834 examples:
21835 .code
21836 file = /var/spool/mail/$local_part
21837 file = /home/$local_part/inbox
21838 file = $home/inbox
21839 .endd
21840 .cindex "&""sticky""& bit"
21841 In the first example, all deliveries are done into the same directory. If Exim
21842 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21843 create a file in the directory, so the &"sticky"& bit must be turned on for
21844 deliveries to be possible, or alternatively the &%group%& option can be used to
21845 run the delivery under a group id which has write access to the directory.
21846
21847
21848
21849 .option file_format appendfile string unset
21850 .cindex "file" "mailbox; checking existing format"
21851 This option requests the transport to check the format of an existing file
21852 before adding to it. The check consists of matching a specific string at the
21853 start of the file. The value of the option consists of an even number of
21854 colon-separated strings. The first of each pair is the test string, and the
21855 second is the name of a transport. If the transport associated with a matched
21856 string is not the current transport, control is passed over to the other
21857 transport. For example, suppose the standard &(local_delivery)& transport has
21858 this added to it:
21859 .code
21860 file_format = "From       : local_delivery :\
21861                \1\1\1\1\n : local_mmdf_delivery"
21862 .endd
21863 Mailboxes that begin with &"From"& are still handled by this transport, but if
21864 a mailbox begins with four binary ones followed by a newline, control is passed
21865 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21866 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21867 is assumed to match the current transport. If the start of a mailbox doesn't
21868 match any string, or if the transport named for a given string is not defined,
21869 delivery is deferred.
21870
21871
21872 .option file_must_exist appendfile boolean false
21873 If this option is true, the file specified by the &%file%& option must exist.
21874 A temporary error occurs if it does not, causing delivery to be deferred.
21875 If this option is false, the file is created if it does not exist.
21876
21877
21878 .option lock_fcntl_timeout appendfile time 0s
21879 .cindex "timeout" "mailbox locking"
21880 .cindex "mailbox" "locking, blocking and non-blocking"
21881 .cindex "locking files"
21882 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21883 when locking an open mailbox file. If the call fails, the delivery process
21884 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21885 Non-blocking calls are used so that the file is not kept open during the wait
21886 for the lock; the reason for this is to make it as safe as possible for
21887 deliveries over NFS in the case when processes might be accessing an NFS
21888 mailbox without using a lock file. This should not be done, but
21889 misunderstandings and hence misconfigurations are not unknown.
21890
21891 On a busy system, however, the performance of a non-blocking lock approach is
21892 not as good as using a blocking lock with a timeout. In this case, the waiting
21893 is done inside the system call, and Exim's delivery process acquires the lock
21894 and can proceed as soon as the previous lock holder releases it.
21895
21896 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21897 timeout, are used. There may still be some retrying: the maximum number of
21898 retries is
21899 .code
21900 (lock_retries * lock_interval) / lock_fcntl_timeout
21901 .endd
21902 rounded up to the next whole number. In other words, the total time during
21903 which &(appendfile)& is trying to get a lock is roughly the same, unless
21904 &%lock_fcntl_timeout%& is set very large.
21905
21906 You should consider setting this option if you are getting a lot of delayed
21907 local deliveries because of errors of the form
21908 .code
21909 failed to lock mailbox /some/file (fcntl)
21910 .endd
21911
21912 .option lock_flock_timeout appendfile time 0s
21913 This timeout applies to file locking when using &[flock()]& (see
21914 &%use_flock%&); the timeout operates in a similar manner to
21915 &%lock_fcntl_timeout%&.
21916
21917
21918 .option lock_interval appendfile time 3s
21919 This specifies the time to wait between attempts to lock the file. See below
21920 for details of locking.
21921
21922
21923 .option lock_retries appendfile integer 10
21924 This specifies the maximum number of attempts to lock the file. A value of zero
21925 is treated as 1. See below for details of locking.
21926
21927
21928 .option lockfile_mode appendfile "octal integer" 0600
21929 This specifies the mode of the created lock file, when a lock file is being
21930 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21931
21932
21933 .option lockfile_timeout appendfile time 30m
21934 .cindex "timeout" "mailbox locking"
21935 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21936 exists and is older than this value, it is assumed to have been left behind by
21937 accident, and Exim attempts to remove it.
21938
21939
21940 .option mailbox_filecount appendfile string&!! unset
21941 .cindex "mailbox" "specifying size of"
21942 .cindex "size" "of mailbox"
21943 If this option is set, it is expanded, and the result is taken as the current
21944 number of files in the mailbox. It must be a decimal number, optionally
21945 followed by K or M. This provides a way of obtaining this information from an
21946 external source that maintains the data.
21947
21948
21949 .option mailbox_size appendfile string&!! unset
21950 .cindex "mailbox" "specifying size of"
21951 .cindex "size" "of mailbox"
21952 If this option is set, it is expanded, and the result is taken as the current
21953 size the mailbox. It must be a decimal number, optionally followed by K or M.
21954 This provides a way of obtaining this information from an external source that
21955 maintains the data. This is likely to be helpful for maildir deliveries where
21956 it is computationally expensive to compute the size of a mailbox.
21957
21958
21959
21960 .option maildir_format appendfile boolean false
21961 .cindex "maildir format" "specifying"
21962 If this option is set with the &%directory%& option, the delivery is into a new
21963 file, in the &"maildir"& format that is used by other mail software. When the
21964 transport is activated directly from a &(redirect)& router (for example, the
21965 &(address_file)& transport in the default configuration), setting
21966 &%maildir_format%& causes the path received from the router to be treated as a
21967 directory, whether or not it ends with &`/`&. This option is available only if
21968 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21969 &<<SECTmaildirdelivery>>& below for further details.
21970
21971
21972 .option maildir_quota_directory_regex appendfile string "See below"
21973 .cindex "maildir format" "quota; directories included in"
21974 .cindex "quota" "maildir; directories included in"
21975 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21976 a regular expression for specifying directories, relative to the quota
21977 directory (see &%quota_directory%&), that should be included in the quota
21978 calculation. The default value is:
21979 .code
21980 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21981 .endd
21982 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21983 (directories whose names begin with a dot). If you want to exclude the
21984 &_Trash_&
21985 folder from the count (as some sites do), you need to change this setting to
21986 .code
21987 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21988 .endd
21989 This uses a negative lookahead in the regular expression to exclude the
21990 directory whose name is &_.Trash_&. When a directory is excluded from quota
21991 calculations, quota processing is bypassed for any messages that are delivered
21992 directly into that directory.
21993
21994
21995 .option maildir_retries appendfile integer 10
21996 This option specifies the number of times to retry when writing a file in
21997 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21998
21999
22000 .option maildir_tag appendfile string&!! unset
22001 This option applies only to deliveries in maildir format, and is described in
22002 section &<<SECTmaildirdelivery>>& below.
22003
22004
22005 .option maildir_use_size_file appendfile&!! boolean false
22006 .cindex "maildir format" "&_maildirsize_& file"
22007 The result of string expansion for this option must be a valid boolean value.
22008 If it is true, it enables support for &_maildirsize_& files. Exim
22009 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22010 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22011 value is zero. See &%maildir_quota_directory_regex%& above and section
22012 &<<SECTmaildirdelivery>>& below for further details.
22013
22014 .option maildirfolder_create_regex appendfile string unset
22015 .cindex "maildir format" "&_maildirfolder_& file"
22016 .cindex "&_maildirfolder_&, creating"
22017 The value of this option is a regular expression. If it is unset, it has no
22018 effect. Otherwise, before a maildir delivery takes place, the pattern is
22019 matched against the name of the maildir directory, that is, the directory
22020 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22021 delivery. If there is a match, Exim checks for the existence of a file called
22022 &_maildirfolder_& in the directory, and creates it if it does not exist.
22023 See section &<<SECTmaildirdelivery>>& for more details.
22024
22025
22026 .option mailstore_format appendfile boolean false
22027 .cindex "mailstore format" "specifying"
22028 If this option is set with the &%directory%& option, the delivery is into two
22029 new files in  &"mailstore"& format. The option is available only if
22030 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22031 below for further details.
22032
22033
22034 .option mailstore_prefix appendfile string&!! unset
22035 This option applies only to deliveries in mailstore format, and is described in
22036 section &<<SECTopdir>>& below.
22037
22038
22039 .option mailstore_suffix appendfile string&!! unset
22040 This option applies only to deliveries in mailstore format, and is described in
22041 section &<<SECTopdir>>& below.
22042
22043
22044 .option mbx_format appendfile boolean false
22045 .cindex "locking files"
22046 .cindex "file" "locking"
22047 .cindex "file" "MBX format"
22048 .cindex "MBX format, specifying"
22049 This option is available only if Exim has been compiled with SUPPORT_MBX
22050 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22051 the message is appended to the mailbox file in MBX format instead of
22052 traditional Unix format. This format is supported by Pine4 and its associated
22053 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22054
22055 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22056 automatically changed by the use of &%mbx_format%&. They should normally be set
22057 empty when using MBX format, so this option almost always appears in this
22058 combination:
22059 .code
22060 mbx_format = true
22061 message_prefix =
22062 message_suffix =
22063 .endd
22064 If none of the locking options are mentioned in the configuration,
22065 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22066 is possible to specify the other kinds of locking with &%mbx_format%&, but
22067 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22068 interworks with &'c-client'&, providing for shared access to the mailbox. It
22069 should not be used if any program that does not use this form of locking is
22070 going to access the mailbox, nor should it be used if the mailbox file is NFS
22071 mounted, because it works only when the mailbox is accessed from a single host.
22072
22073 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22074 the standard version of &'c-client'&, because as long as it has a mailbox open
22075 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22076 append messages to it.
22077
22078
22079 .option message_prefix appendfile string&!! "see below"
22080 .cindex "&""From""& line"
22081 The string specified here is expanded and output at the start of every message.
22082 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22083 in which case it is:
22084 .code
22085 message_prefix = "From ${if def:return_path{$return_path}\
22086   {MAILER-DAEMON}} $tod_bsdinbox\n"
22087 .endd
22088 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22089 &`\n`& to &`\r\n`& in &%message_prefix%&.
22090
22091 .option message_suffix appendfile string&!! "see below"
22092 The string specified here is expanded and output at the end of every message.
22093 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22094 in which case it is a single newline character. The suffix can be suppressed by
22095 setting
22096 .code
22097 message_suffix =
22098 .endd
22099 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22100 &`\n`& to &`\r\n`& in &%message_suffix%&.
22101
22102 .option mode appendfile "octal integer" 0600
22103 If the output file is created, it is given this mode. If it already exists and
22104 has wider permissions, they are reduced to this mode. If it has narrower
22105 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22106 if the delivery is the result of a &%save%& command in a filter file specifying
22107 a particular mode, the mode of the output file is always forced to take that
22108 value, and this option is ignored.
22109
22110
22111 .option mode_fail_narrower appendfile boolean true
22112 This option applies in the case when an existing mailbox file has a narrower
22113 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22114 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22115 continues with the delivery attempt, using the existing mode of the file.
22116
22117
22118 .option notify_comsat appendfile boolean false
22119 If this option is true, the &'comsat'& daemon is notified after every
22120 successful delivery to a user mailbox. This is the daemon that notifies logged
22121 on users about incoming mail.
22122
22123
22124 .option quota appendfile string&!! unset
22125 .cindex "quota" "imposed by Exim"
22126 This option imposes a limit on the size of the file to which Exim is appending,
22127 or to the total space used in the directory tree when the &%directory%& option
22128 is set. In the latter case, computation of the space used is expensive, because
22129 all the files in the directory (and any sub-directories) have to be
22130 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22131 &%maildir_use_size_file%& for ways to avoid this in environments where users
22132 have no shell access to their mailboxes).
22133
22134 As there is no interlock against two simultaneous deliveries into a
22135 multi-file mailbox, it is possible for the quota to be overrun in this case.
22136 For single-file mailboxes, of course, an interlock is a necessity.
22137
22138 A file's size is taken as its &'used'& value. Because of blocking effects, this
22139 may be a lot less than the actual amount of disk space allocated to the file.
22140 If the sizes of a number of files are being added up, the rounding effect can
22141 become quite noticeable, especially on systems that have large block sizes.
22142 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22143 the obvious value which users understand most easily.
22144
22145 The value of the option is expanded, and must then be a numerical value
22146 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22147 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22148 and further option modifiers. If Exim is running on a system with
22149 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22150 be handled.
22151
22152 The option modifier &%no_check%& can be used to force delivery even if the over
22153 quota condition is met. The quota gets updated as usual.
22154
22155 &*Note*&: A value of zero is interpreted as &"no quota"&.
22156
22157 The expansion happens while Exim is running as root, before it changes uid for
22158 the delivery. This means that files that are inaccessible to the end user can
22159 be used to hold quota values that are looked up in the expansion. When delivery
22160 fails because this quota is exceeded, the handling of the error is as for
22161 system quota failures.
22162
22163 By default, Exim's quota checking mimics system quotas, and restricts the
22164 mailbox to the specified maximum size, though the value is not accurate to the
22165 last byte, owing to separator lines and additional headers that may get added
22166 during message delivery. When a mailbox is nearly full, large messages may get
22167 refused even though small ones are accepted, because the size of the current
22168 message is added to the quota when the check is made. This behaviour can be
22169 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22170 for exceeding the quota does not include the current message. Thus, deliveries
22171 continue until the quota has been exceeded; thereafter, no further messages are
22172 delivered. See also &%quota_warn_threshold%&.
22173
22174
22175 .option quota_directory appendfile string&!! unset
22176 This option defines the directory to check for quota purposes when delivering
22177 into individual files. The default is the delivery directory, or, if a file
22178 called &_maildirfolder_& exists in a maildir directory, the parent of the
22179 delivery directory.
22180
22181
22182 .option quota_filecount appendfile string&!! 0
22183 This option applies when the &%directory%& option is set. It limits the total
22184 number of files in the directory (compare the inode limit in system quotas). It
22185 can only be used if &%quota%& is also set. The value is expanded; an expansion
22186 failure causes delivery to be deferred. A value of zero is interpreted as
22187 &"no quota"&.
22188
22189 The option modifier &%no_check%& can be used to force delivery even if the over
22190 quota condition is met. The quota gets updated as usual.
22191
22192 .option quota_is_inclusive appendfile boolean true
22193 See &%quota%& above.
22194
22195
22196 .option quota_size_regex appendfile string unset
22197 This option applies when one of the delivery modes that writes a separate file
22198 for each message is being used. When Exim wants to find the size of one of
22199 these files in order to test the quota, it first checks &%quota_size_regex%&.
22200 If this is set to a regular expression that matches the file name, and it
22201 captures one string, that string is interpreted as a representation of the
22202 file's size. The value of &%quota_size_regex%& is not expanded.
22203
22204 This feature is useful only when users have no shell access to their mailboxes
22205 &-- otherwise they could defeat the quota simply by renaming the files. This
22206 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22207 the file length to the file name. For example:
22208 .code
22209 maildir_tag = ,S=$message_size
22210 quota_size_regex = ,S=(\d+)
22211 .endd
22212 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22213 number of lines in the message.
22214
22215 The regular expression should not assume that the length is at the end of the
22216 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22217 sometimes add other information onto the ends of message file names.
22218
22219 Section &<<SECID136>>& contains further information.
22220
22221
22222 .option quota_warn_message appendfile string&!! "see below"
22223 See below for the use of this option. If it is not set when
22224 &%quota_warn_threshold%& is set, it defaults to
22225 .code
22226 quota_warn_message = "\
22227   To: $local_part@$domain\n\
22228   Subject: Your mailbox\n\n\
22229   This message is automatically created \
22230   by mail delivery software.\n\n\
22231   The size of your mailbox has exceeded \
22232   a warning threshold that is\n\
22233   set by the system administrator.\n"
22234 .endd
22235
22236
22237 .option quota_warn_threshold appendfile string&!! 0
22238 .cindex "quota" "warning threshold"
22239 .cindex "mailbox" "size warning"
22240 .cindex "size" "of mailbox"
22241 This option is expanded in the same way as &%quota%& (see above). If the
22242 resulting value is greater than zero, and delivery of the message causes the
22243 size of the file or total space in the directory tree to cross the given
22244 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22245 may be specified as a percentage of it by following the value with a percent
22246 sign. For example:
22247 .code
22248 quota = 10M
22249 quota_warn_threshold = 75%
22250 .endd
22251 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22252 percent sign is ignored.
22253
22254 The warning message itself is specified by the &%quota_warn_message%& option,
22255 and it must start with a &'To:'& header line containing the recipient(s) of the
22256 warning message. These do not necessarily have to include the recipient(s) of
22257 the original message. A &'Subject:'& line should also normally be supplied. You
22258 can include any other header lines that you want. If you do not include a
22259 &'From:'& line, the default is:
22260 .code
22261 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22262 .endd
22263 .oindex &%errors_reply_to%&
22264 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22265 option.
22266
22267 The &%quota%& option does not have to be set in order to use this option; they
22268 are independent of one another except when the threshold is specified as a
22269 percentage.
22270
22271
22272 .option use_bsmtp appendfile boolean false
22273 .cindex "envelope sender"
22274 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22275 format, with the envelope sender and recipient(s) included as SMTP commands. If
22276 you want to include a leading HELO command with such messages, you can do
22277 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22278 for details of batch SMTP.
22279
22280
22281 .option use_crlf appendfile boolean false
22282 .cindex "carriage return"
22283 .cindex "linefeed"
22284 This option causes lines to be terminated with the two-character CRLF sequence
22285 (carriage return, linefeed) instead of just a linefeed character. In the case
22286 of batched SMTP, the byte sequence written to the file is then an exact image
22287 of what would be sent down a real SMTP connection.
22288
22289 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22290 (which are used to supply the traditional &"From&~"& and blank line separators
22291 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22292 carriage return characters if these are needed. In cases where these options
22293 have non-empty defaults, the values end with a single linefeed, so they must be
22294 changed to end with &`\r\n`& if &%use_crlf%& is set.
22295
22296
22297 .option use_fcntl_lock appendfile boolean "see below"
22298 This option controls the use of the &[fcntl()]& function to lock a file for
22299 exclusive use when a message is being appended. It is set by default unless
22300 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22301 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22302 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22303
22304
22305 .option use_flock_lock appendfile boolean false
22306 This option is provided to support the use of &[flock()]& for file locking, for
22307 the few situations where it is needed. Most modern operating systems support
22308 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22309 each other. Exim uses &[fcntl()]& locking by default.
22310
22311 This option is required only if you are using an operating system where
22312 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22313 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22314 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22315
22316 .cindex "Solaris" "&[flock()]& support"
22317 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22318 have it (and some, I think, provide a not quite right version built on top of
22319 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22320 the ability to use it, and any attempt to do so will cause a configuration
22321 error.
22322
22323 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22324 is just being mapped onto &[fcntl()]& by the OS).
22325
22326
22327 .option use_lockfile appendfile boolean "see below"
22328 If this option is turned off, Exim does not attempt to create a lock file when
22329 appending to a mailbox file. In this situation, the only locking is by
22330 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22331 sure that every MUA that is ever going to look at your users' mailboxes uses
22332 &[fcntl()]& rather than a lock file, and even then only when you are not
22333 delivering over NFS from more than one host.
22334
22335 .cindex "NFS" "lock file"
22336 In order to append to an NFS file safely from more than one host, it is
22337 necessary to take out a lock &'before'& opening the file, and the lock file
22338 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22339 file corruption.
22340
22341 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22342 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22343 except when &%mbx_format%& is set.
22344
22345
22346 .option use_mbx_lock appendfile boolean "see below"
22347 This option is available only if Exim has been compiled with SUPPORT_MBX
22348 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22349 locking rules be used. It is set by default if &%mbx_format%& is set and none
22350 of the locking options are mentioned in the configuration. The locking rules
22351 are the same as are used by the &'c-client'& library that underlies Pine and
22352 the IMAP4 and POP daemons that come with it (see the discussion below). The
22353 rules allow for shared access to the mailbox. However, this kind of locking
22354 does not work when the mailbox is NFS mounted.
22355
22356 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22357 &%use_flock_lock%& to control what kind of locking is used in implementing the
22358 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22359 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22360
22361
22362
22363
22364 .section "Operational details for appending" "SECTopappend"
22365 .cindex "appending to a file"
22366 .cindex "file" "appending"
22367 Before appending to a file, the following preparations are made:
22368
22369 .ilist
22370 If the name of the file is &_/dev/null_&, no action is taken, and a success
22371 return is given.
22372
22373 .next
22374 .cindex "directory creation"
22375 If any directories on the file's path are missing, Exim creates them if the
22376 &%create_directory%& option is set. A created directory's mode is given by the
22377 &%directory_mode%& option.
22378
22379 .next
22380 If &%file_format%& is set, the format of an existing file is checked. If this
22381 indicates that a different transport should be used, control is passed to that
22382 transport.
22383
22384 .next
22385 .cindex "file" "locking"
22386 .cindex "locking files"
22387 .cindex "NFS" "lock file"
22388 If &%use_lockfile%& is set, a lock file is built in a way that will work
22389 reliably over NFS, as follows:
22390
22391 .olist
22392 Create a &"hitching post"& file whose name is that of the lock file with the
22393 current time, primary host name, and process id added, by opening for writing
22394 as a new file. If this fails with an access error, delivery is deferred.
22395 .next
22396 Close the hitching post file, and hard link it to the lock file name.
22397 .next
22398 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22399 Unlink the hitching post name.
22400 .next
22401 Otherwise, use &[stat()]& to get information about the hitching post file, and
22402 then unlink hitching post name. If the number of links is exactly two, creation
22403 of the lock file succeeded but something (for example, an NFS server crash and
22404 restart) caused this fact not to be communicated to the &[link()]& call.
22405 .next
22406 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22407 up to &%lock_retries%& times. However, since any program that writes to a
22408 mailbox should complete its task very quickly, it is reasonable to time out old
22409 lock files that are normally the result of user agent and system crashes. If an
22410 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22411 it before trying again.
22412 .endlist olist
22413
22414 .next
22415 A call is made to &[lstat()]& to discover whether the main file exists, and if
22416 so, what its characteristics are. If &[lstat()]& fails for any reason other
22417 than non-existence, delivery is deferred.
22418
22419 .next
22420 .cindex "symbolic link" "to mailbox"
22421 .cindex "mailbox" "symbolic link"
22422 If the file does exist and is a symbolic link, delivery is deferred, unless the
22423 &%allow_symlink%& option is set, in which case the ownership of the link is
22424 checked, and then &[stat()]& is called to find out about the real file, which
22425 is then subjected to the checks below. The check on the top-level link
22426 ownership prevents one user creating a link for another's mailbox in a sticky
22427 directory, though allowing symbolic links in this case is definitely not a good
22428 idea. If there is a chain of symbolic links, the intermediate ones are not
22429 checked.
22430
22431 .next
22432 If the file already exists but is not a regular file, or if the file's owner
22433 and group (if the group is being checked &-- see &%check_group%& above) are
22434 different from the user and group under which the delivery is running,
22435 delivery is deferred.
22436
22437 .next
22438 If the file's permissions are more generous than specified, they are reduced.
22439 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22440 is set false, in which case the delivery is tried using the existing
22441 permissions.
22442
22443 .next
22444 The file's inode number is saved, and the file is then opened for appending.
22445 If this fails because the file has vanished, &(appendfile)& behaves as if it
22446 hadn't existed (see below). For any other failures, delivery is deferred.
22447
22448 .next
22449 If the file is opened successfully, check that the inode number hasn't
22450 changed, that it is still a regular file, and that the owner and permissions
22451 have not changed. If anything is wrong, defer delivery and freeze the message.
22452
22453 .next
22454 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22455 option is set. Otherwise, check that the file is being created in a permitted
22456 directory if the &%create_file%& option is set (deferring on failure), and then
22457 open for writing as a new file, with the O_EXCL and O_CREAT options,
22458 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22459 set). In this case, which can happen if the link points to a non-existent file,
22460 the file is opened for writing using O_CREAT but not O_EXCL, because
22461 that prevents link following.
22462
22463 .next
22464 .cindex "loop" "while file testing"
22465 If opening fails because the file exists, obey the tests given above for
22466 existing files. However, to avoid looping in a situation where the file is
22467 being continuously created and destroyed, the exists/not-exists loop is broken
22468 after 10 repetitions, and the message is then frozen.
22469
22470 .next
22471 If opening fails with any other error, defer delivery.
22472
22473 .next
22474 .cindex "file" "locking"
22475 .cindex "locking files"
22476 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22477 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22478 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22479 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22480 file, and an exclusive lock on the file whose name is
22481 .code
22482 /tmp/.<device-number>.<inode-number>
22483 .endd
22484 using the device and inode numbers of the open mailbox file, in accordance with
22485 the MBX locking rules. This file is created with a mode that is specified by
22486 the &%lockfile_mode%& option.
22487
22488 If Exim fails to lock the file, there are two possible courses of action,
22489 depending on the value of the locking timeout. This is obtained from
22490 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22491
22492 If the timeout value is zero, the file is closed, Exim waits for
22493 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22494 to lock it again. This happens up to &%lock_retries%& times, after which the
22495 delivery is deferred.
22496
22497 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22498 &[flock()]& are used (with the given timeout), so there has already been some
22499 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22500 immediately. It retries up to
22501 .code
22502 (lock_retries * lock_interval) / <timeout>
22503 .endd
22504 times (rounded up).
22505 .endlist
22506
22507 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22508 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22509
22510
22511 .section "Operational details for delivery to a new file" "SECTopdir"
22512 .cindex "delivery" "to single file"
22513 .cindex "&""From""& line"
22514 When the &%directory%& option is set instead of &%file%&, each message is
22515 delivered into a newly-created file or set of files. When &(appendfile)& is
22516 activated directly from a &(redirect)& router, neither &%file%& nor
22517 &%directory%& is normally set, because the path for delivery is supplied by the
22518 router. (See for example, the &(address_file)& transport in the default
22519 configuration.) In this case, delivery is to a new file if either the path name
22520 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22521
22522 No locking is required while writing the message to a new file, so the various
22523 locking options of the transport are ignored. The &"From"& line that by default
22524 separates messages in a single file is not normally needed, nor is the escaping
22525 of message lines that start with &"From"&, and there is no need to ensure a
22526 newline at the end of each message. Consequently, the default values for
22527 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22528 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22529
22530 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22531 the files in the delivery directory by default. However, you can specify a
22532 different directory by setting &%quota_directory%&. Also, for maildir
22533 deliveries (see below) the &_maildirfolder_& convention is honoured.
22534
22535
22536 .cindex "maildir format"
22537 .cindex "mailstore format"
22538 There are three different ways in which delivery to individual files can be
22539 done, controlled by the settings of the &%maildir_format%& and
22540 &%mailstore_format%& options. Note that code to support maildir or mailstore
22541 formats is not included in the binary unless SUPPORT_MAILDIR or
22542 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22543
22544 .cindex "directory creation"
22545 In all three cases an attempt is made to create the directory and any necessary
22546 sub-directories if they do not exist, provided that the &%create_directory%&
22547 option is set (the default). The location of a created directory can be
22548 constrained by setting &%create_file%&. A created directory's mode is given by
22549 the &%directory_mode%& option. If creation fails, or if the
22550 &%create_directory%& option is not set when creation is required, delivery is
22551 deferred.
22552
22553
22554
22555 .section "Maildir delivery" "SECTmaildirdelivery"
22556 .cindex "maildir format" "description of"
22557 If the &%maildir_format%& option is true, Exim delivers each message by writing
22558 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22559 directory that is defined by the &%directory%& option (the &"delivery
22560 directory"&). If the delivery is successful, the file is renamed into the
22561 &_new_& subdirectory.
22562
22563 In the file name, <&'stime'&> is the current time of day in seconds, and
22564 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22565 Exim checks that the time-of-day clock has moved on by at least one microsecond
22566 before terminating the delivery process. This guarantees uniqueness for the
22567 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22568 opening it. If any response other than ENOENT (does not exist) is given,
22569 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22570
22571 Before Exim carries out a maildir delivery, it ensures that subdirectories
22572 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22573 do not exist, Exim tries to create them and any superior directories in their
22574 path, subject to the &%create_directory%& and &%create_file%& options. If the
22575 &%maildirfolder_create_regex%& option is set, and the regular expression it
22576 contains matches the delivery directory, Exim also ensures that a file called
22577 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22578 &_maildirfolder_& file cannot be created, delivery is deferred.
22579
22580 These features make it possible to use Exim to create all the necessary files
22581 and directories in a maildir mailbox, including subdirectories for maildir++
22582 folders. Consider this example:
22583 .code
22584 maildir_format = true
22585 directory = /var/mail/$local_part\
22586            ${if eq{$local_part_suffix}{}{}\
22587            {/.${substr_1:$local_part_suffix}}}
22588 maildirfolder_create_regex = /\.[^/]+$
22589 .endd
22590 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22591 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22592 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22593 not match this name, so Exim will not look for or create the file
22594 &_/var/mail/pimbo/maildirfolder_&, though it will create
22595 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22596
22597 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22598 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22599 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22600 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22601 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22602
22603 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22604 not inadvertently match the toplevel maildir directory, because a
22605 &_maildirfolder_& file at top level would completely break quota calculations.
22606
22607 .cindex "quota" "in maildir delivery"
22608 .cindex "maildir++"
22609 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22610 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22611 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22612 Exim assumes the directory is a maildir++ folder directory, which is one level
22613 down from the user's top level mailbox directory. This causes it to start at
22614 the parent directory instead of the current directory when calculating the
22615 amount of space used.
22616
22617 One problem with delivering into a multi-file mailbox is that it is
22618 computationally expensive to compute the size of the mailbox for quota
22619 checking. Various approaches have been taken to reduce the amount of work
22620 needed. The next two sections describe two of them. A third alternative is to
22621 use some external process for maintaining the size data, and use the expansion
22622 of the &%mailbox_size%& option as a way of importing it into Exim.
22623
22624
22625
22626
22627 .section "Using tags to record message sizes" "SECID135"
22628 If &%maildir_tag%& is set, the string is expanded for each delivery.
22629 When the maildir file is renamed into the &_new_& sub-directory, the
22630 tag is added to its name. However, if adding the tag takes the length of the
22631 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22632 the tag is dropped and the maildir file is created with no tag.
22633
22634
22635 .vindex "&$message_size$&"
22636 Tags can be used to encode the size of files in their names; see
22637 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22638 happens after the message has been written. The value of the &$message_size$&
22639 variable is set to the number of bytes actually written. If the expansion is
22640 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22641 be deferred. The expanded tag may contain any printing characters except &"/"&.
22642 Non-printing characters in the string are ignored; if the resulting string is
22643 empty, it is ignored. If it starts with an alphanumeric character, a leading
22644 colon is inserted; this default has not proven to be the path that popular
22645 maildir implementations have chosen (but changing it in Exim would break
22646 backwards compatibility).
22647
22648 For one common implementation, you might set:
22649 .code
22650 maildir_tag = ,S=${message_size}
22651 .endd
22652 but you should check the documentation of the other software to be sure.
22653
22654 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22655 as this allows Exim to extract the size from your tag, instead of having to
22656 &[stat()]& each message file.
22657
22658
22659 .section "Using a maildirsize file" "SECID136"
22660 .cindex "quota" "in maildir delivery"
22661 .cindex "maildir format" "&_maildirsize_& file"
22662 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22663 storing quota and message size information in a file called &_maildirsize_&
22664 within the toplevel maildir directory. If this file does not exist, Exim
22665 creates it, setting the quota from the &%quota%& option of the transport. If
22666 the maildir directory itself does not exist, it is created before any attempt
22667 to write a &_maildirsize_& file.
22668
22669 The &_maildirsize_& file is used to hold information about the sizes of
22670 messages in the maildir, thus speeding up quota calculations. The quota value
22671 in the file is just a cache; if the quota is changed in the transport, the new
22672 value overrides the cached value when the next message is delivered. The cache
22673 is maintained for the benefit of other programs that access the maildir and
22674 need to know the quota.
22675
22676 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22677 file is maintained (with a zero quota setting), but no quota is imposed.
22678
22679 A regular expression is available for controlling which directories in the
22680 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22681 See the description of the &%maildir_quota_directory_regex%& option above for
22682 details.
22683
22684
22685 .section "Mailstore delivery" "SECID137"
22686 .cindex "mailstore format" "description of"
22687 If the &%mailstore_format%& option is true, each message is written as two
22688 files in the given directory. A unique base name is constructed from the
22689 message id and the current delivery process, and the files that are written use
22690 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22691 contains the message's envelope, and the &_.msg_& file contains the message
22692 itself. The base name is placed in the variable &$mailstore_basename$&.
22693
22694 During delivery, the envelope is first written to a file with the suffix
22695 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22696 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22697 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22698 file before accessing either of them. An alternative approach is to wait for
22699 the absence of a &_.tmp_& file.
22700
22701 The envelope file starts with any text defined by the &%mailstore_prefix%&
22702 option, expanded and terminated by a newline if there isn't one. Then follows
22703 the sender address on one line, then all the recipient addresses, one per line.
22704 There can be more than one recipient only if the &%batch_max%& option is set
22705 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22706 appended to the file, followed by a newline if it does not end with one.
22707
22708 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22709 failure, it is ignored. Other expansion errors are treated as serious
22710 configuration errors, and delivery is deferred. The variable
22711 &$mailstore_basename$& is available for use during these expansions.
22712
22713
22714 .section "Non-special new file delivery" "SECID138"
22715 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22716 file is created directly in the named directory. For example, when delivering
22717 messages into files in batched SMTP format for later delivery to some host (see
22718 section &<<SECTbatchSMTP>>&), a setting such as
22719 .code
22720 directory = /var/bsmtp/$host
22721 .endd
22722 might be used. A message is written to a file with a temporary name, which is
22723 then renamed when the delivery is complete. The final name is obtained by
22724 expanding the contents of the &%directory_file%& option.
22725 .ecindex IIDapptra1
22726 .ecindex IIDapptra2
22727
22728
22729
22730
22731
22732
22733 . ////////////////////////////////////////////////////////////////////////////
22734 . ////////////////////////////////////////////////////////////////////////////
22735
22736 .chapter "The autoreply transport" "CHID8"
22737 .scindex IIDauttra1 "transports" "&(autoreply)&"
22738 .scindex IIDauttra2 "&(autoreply)& transport"
22739 The &(autoreply)& transport is not a true transport in that it does not cause
22740 the message to be transmitted. Instead, it generates a new mail message as an
22741 automatic reply to the incoming message. &'References:'& and
22742 &'Auto-Submitted:'& header lines are included. These are constructed according
22743 to the rules in RFCs 2822 and 3834, respectively.
22744
22745 If the router that passes the message to this transport does not have the
22746 &%unseen%& option set, the original message (for the current recipient) is not
22747 delivered anywhere. However, when the &%unseen%& option is set on the router
22748 that passes the message to this transport, routing of the address continues, so
22749 another router can set up a normal message delivery.
22750
22751
22752 The &(autoreply)& transport is usually run as the result of mail filtering, a
22753 &"vacation"& message being the standard example. However, it can also be run
22754 directly from a router like any other transport. To reduce the possibility of
22755 message cascades, messages created by the &(autoreply)& transport always have
22756 empty envelope sender addresses, like bounce messages.
22757
22758 The parameters of the message to be sent can be specified in the configuration
22759 by options described below. However, these are used only when the address
22760 passed to the transport does not contain its own reply information. When the
22761 transport is run as a consequence of a
22762 &%mail%&
22763 or &%vacation%& command in a filter file, the parameters of the message are
22764 supplied by the filter, and passed with the address. The transport's options
22765 that define the message are then ignored (so they are not usually set in this
22766 case). The message is specified entirely by the filter or by the transport; it
22767 is never built from a mixture of options. However, the &%file_optional%&,
22768 &%mode%&, and &%return_message%& options apply in all cases.
22769
22770 &(Autoreply)& is implemented as a local transport. When used as a result of a
22771 command in a user's filter file, &(autoreply)& normally runs under the uid and
22772 gid of the user, and with appropriate current and home directories (see chapter
22773 &<<CHAPenvironment>>&).
22774
22775 There is a subtle difference between routing a message to a &(pipe)& transport
22776 that generates some text to be returned to the sender, and routing it to an
22777 &(autoreply)& transport. This difference is noticeable only if more than one
22778 address from the same message is so handled. In the case of a pipe, the
22779 separate outputs from the different addresses are gathered up and returned to
22780 the sender in a single message, whereas if &(autoreply)& is used, a separate
22781 message is generated for each address that is passed to it.
22782
22783 Non-printing characters are not permitted in the header lines generated for the
22784 message that &(autoreply)& creates, with the exception of newlines that are
22785 immediately followed by white space. If any non-printing characters are found,
22786 the transport defers.
22787 Whether characters with the top bit set count as printing characters or not is
22788 controlled by the &%print_topbitchars%& global option.
22789
22790 If any of the generic options for manipulating headers (for example,
22791 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22792 of the original message that is included in the generated message when
22793 &%return_message%& is set. They do not apply to the generated message itself.
22794
22795 .vindex "&$sender_address$&"
22796 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22797 the message, indicating that there were no recipients, it does not treat this
22798 as an error. This means that autoreplies sent to &$sender_address$& when this
22799 is empty (because the incoming message is a bounce message) do not cause
22800 problems. They are just discarded.
22801
22802
22803
22804 .section "Private options for autoreply" "SECID139"
22805 .cindex "options" "&(autoreply)& transport"
22806
22807 .option bcc autoreply string&!! unset
22808 This specifies the addresses that are to receive &"blind carbon copies"& of the
22809 message when the message is specified by the transport.
22810
22811
22812 .option cc autoreply string&!! unset
22813 This specifies recipients of the message and the contents of the &'Cc:'& header
22814 when the message is specified by the transport.
22815
22816
22817 .option file autoreply string&!! unset
22818 The contents of the file are sent as the body of the message when the message
22819 is specified by the transport. If both &%file%& and &%text%& are set, the text
22820 string comes first.
22821
22822
22823 .option file_expand autoreply boolean false
22824 If this is set, the contents of the file named by the &%file%& option are
22825 subjected to string expansion as they are added to the message.
22826
22827
22828 .option file_optional autoreply boolean false
22829 If this option is true, no error is generated if the file named by the &%file%&
22830 option or passed with the address does not exist or cannot be read.
22831
22832
22833 .option from autoreply string&!! unset
22834 This specifies the contents of the &'From:'& header when the message is
22835 specified by the transport.
22836
22837
22838 .option headers autoreply string&!! unset
22839 This specifies additional RFC 2822 headers that are to be added to the message
22840 when the message is specified by the transport. Several can be given by using
22841 &"\n"& to separate them. There is no check on the format.
22842
22843
22844 .option log autoreply string&!! unset
22845 This option names a file in which a record of every message sent is logged when
22846 the message is specified by the transport.
22847
22848
22849 .option mode autoreply "octal integer" 0600
22850 If either the log file or the &"once"& file has to be created, this mode is
22851 used.
22852
22853
22854 .option never_mail autoreply "address list&!!" unset
22855 If any run of the transport creates a message with a recipient that matches any
22856 item in the list, that recipient is quietly discarded. If all recipients are
22857 discarded, no message is created. This applies both when the recipients are
22858 generated by a filter and when they are specified in the transport.
22859
22860
22861
22862 .option once autoreply string&!! unset
22863 This option names a file or DBM database in which a record of each &'To:'&
22864 recipient is kept when the message is specified by the transport. &*Note*&:
22865 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22866
22867 If &%once%& is unset, or is set to an empty string, the message is always sent.
22868 By default, if &%once%& is set to a non-empty file name, the message
22869 is not sent if a potential recipient is already listed in the database.
22870 However, if the &%once_repeat%& option specifies a time greater than zero, the
22871 message is sent if that much time has elapsed since a message was last sent to
22872 this recipient. A setting of zero time for &%once_repeat%& (the default)
22873 prevents a message from being sent a second time &-- in this case, zero means
22874 infinity.
22875
22876 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22877 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22878 greater than zero, it changes the way Exim implements the &%once%& option.
22879 Instead of using a DBM file to record every recipient it sends to, it uses a
22880 regular file, whose size will never get larger than the given value.
22881
22882 In the file, Exim keeps a linear list of recipient addresses and the times at
22883 which they were sent messages. If the file is full when a new address needs to
22884 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22885 means that a given recipient may receive multiple messages, but at
22886 unpredictable intervals that depend on the rate of turnover of addresses in the
22887 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22888
22889
22890 .option once_file_size autoreply integer 0
22891 See &%once%& above.
22892
22893
22894 .option once_repeat autoreply time&!! 0s
22895 See &%once%& above.
22896 After expansion, the value of this option must be a valid time value.
22897
22898
22899 .option reply_to autoreply string&!! unset
22900 This specifies the contents of the &'Reply-To:'& header when the message is
22901 specified by the transport.
22902
22903
22904 .option return_message autoreply boolean false
22905 If this is set, a copy of the original message is returned with the new
22906 message, subject to the maximum size set in the &%return_size_limit%& global
22907 configuration option.
22908
22909
22910 .option subject autoreply string&!! unset
22911 This specifies the contents of the &'Subject:'& header when the message is
22912 specified by the transport. It is tempting to quote the original subject in
22913 automatic responses. For example:
22914 .code
22915 subject = Re: $h_subject:
22916 .endd
22917 There is a danger in doing this, however. It may allow a third party to
22918 subscribe your users to an opt-in mailing list, provided that the list accepts
22919 bounce messages as subscription confirmations. Well-managed lists require a
22920 non-bounce message to confirm a subscription, so the danger is relatively
22921 small.
22922
22923
22924
22925 .option text autoreply string&!! unset
22926 This specifies a single string to be used as the body of the message when the
22927 message is specified by the transport. If both &%text%& and &%file%& are set,
22928 the text comes first.
22929
22930
22931 .option to autoreply string&!! unset
22932 This specifies recipients of the message and the contents of the &'To:'& header
22933 when the message is specified by the transport.
22934 .ecindex IIDauttra1
22935 .ecindex IIDauttra2
22936
22937
22938
22939
22940 . ////////////////////////////////////////////////////////////////////////////
22941 . ////////////////////////////////////////////////////////////////////////////
22942
22943 .chapter "The lmtp transport" "CHAPLMTP"
22944 .cindex "transports" "&(lmtp)&"
22945 .cindex "&(lmtp)& transport"
22946 .cindex "LMTP" "over a pipe"
22947 .cindex "LMTP" "over a socket"
22948 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22949 specified command
22950 or by interacting with a Unix domain socket.
22951 This transport is something of a cross between the &(pipe)& and &(smtp)&
22952 transports. Exim also has support for using LMTP over TCP/IP; this is
22953 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22954 to be of minority interest, the default build-time configure in &_src/EDITME_&
22955 has it commented out. You need to ensure that
22956 .code
22957 TRANSPORT_LMTP=yes
22958 .endd
22959 .cindex "options" "&(lmtp)& transport"
22960 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22961 included in the Exim binary. The private options of the &(lmtp)& transport are
22962 as follows:
22963
22964 .option batch_id lmtp string&!! unset
22965 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22966
22967
22968 .option batch_max lmtp integer 1
22969 This limits the number of addresses that can be handled in a single delivery.
22970 Most LMTP servers can handle several addresses at once, so it is normally a
22971 good idea to increase this value. See the description of local delivery
22972 batching in chapter &<<CHAPbatching>>&.
22973
22974
22975 .option command lmtp string&!! unset
22976 This option must be set if &%socket%& is not set. The string is a command which
22977 is run in a separate process. It is split up into a command name and list of
22978 arguments, each of which is separately expanded (so expansion cannot change the
22979 number of arguments). The command is run directly, not via a shell. The message
22980 is passed to the new process using the standard input and output to operate the
22981 LMTP protocol.
22982
22983 .option ignore_quota lmtp boolean false
22984 .cindex "LMTP" "ignoring quota errors"
22985 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22986 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22987 in its response to the LHLO command.
22988
22989 .option socket lmtp string&!! unset
22990 This option must be set if &%command%& is not set. The result of expansion must
22991 be the name of a Unix domain socket. The transport connects to the socket and
22992 delivers the message to it using the LMTP protocol.
22993
22994
22995 .option timeout lmtp time 5m
22996 The transport is aborted if the created process or Unix domain socket does not
22997 respond to LMTP commands or message input within this timeout. Delivery
22998 is deferred, and will be tried again later. Here is an example of a typical
22999 LMTP transport:
23000 .code
23001 lmtp:
23002   driver = lmtp
23003   command = /some/local/lmtp/delivery/program
23004   batch_max = 20
23005   user = exim
23006 .endd
23007 This delivers up to 20 addresses at a time, in a mixture of domains if
23008 necessary, running as the user &'exim'&.
23009
23010
23011
23012 . ////////////////////////////////////////////////////////////////////////////
23013 . ////////////////////////////////////////////////////////////////////////////
23014
23015 .chapter "The pipe transport" "CHAPpipetransport"
23016 .scindex IIDpiptra1 "transports" "&(pipe)&"
23017 .scindex IIDpiptra2 "&(pipe)& transport"
23018 The &(pipe)& transport is used to deliver messages via a pipe to a command
23019 running in another process. One example is the use of &(pipe)& as a
23020 pseudo-remote transport for passing messages to some other delivery mechanism
23021 (such as UUCP). Another is the use by individual users to automatically process
23022 their incoming messages. The &(pipe)& transport can be used in one of the
23023 following ways:
23024
23025 .ilist
23026 .vindex "&$local_part$&"
23027 A router routes one address to a transport in the normal way, and the
23028 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23029 contains the local part of the address (as usual), and the command that is run
23030 is specified by the &%command%& option on the transport.
23031 .next
23032 .vindex "&$pipe_addresses$&"
23033 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23034 transport can handle more than one address in a single run. In this case, when
23035 more than one address is routed to the transport, &$local_part$& is not set
23036 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23037 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23038 that are routed to the transport.
23039 .next
23040 .vindex "&$address_pipe$&"
23041 A router redirects an address directly to a pipe command (for example, from an
23042 alias or forward file). In this case, &$address_pipe$& contains the text of the
23043 pipe command, and the &%command%& option on the transport is ignored unless
23044 &%force_command%& is set. If only one address is being transported
23045 (&%batch_max%& is not greater than one, or only one address was redirected to
23046 this pipe command), &$local_part$& contains the local part that was redirected.
23047 .endlist
23048
23049
23050 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23051 deliver messages over pipes using the LMTP interactive protocol. This is
23052 implemented by the &(lmtp)& transport.
23053
23054 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23055 &_.forward_& file, the command runs under the uid and gid of that user. In
23056 other cases, the uid and gid have to be specified explicitly, either on the
23057 transport or on the router that handles the address. Current and &"home"&
23058 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23059 details of the local delivery environment and chapter &<<CHAPbatching>>&
23060 for a discussion of local delivery batching.
23061
23062
23063 .section "Concurrent delivery" "SECID140"
23064 If two messages arrive at almost the same time, and both are routed to a pipe
23065 delivery, the two pipe transports may be run concurrently. You must ensure that
23066 any pipe commands you set up are robust against this happening. If the commands
23067 write to a file, the &%exim_lock%& utility might be of use.
23068 Alternatively the &%max_parallel%& option could be used with a value
23069 of "1" to enforce serialization.
23070
23071
23072
23073
23074 .section "Returned status and data" "SECID141"
23075 .cindex "&(pipe)& transport" "returned data"
23076 If the command exits with a non-zero return code, the delivery is deemed to
23077 have failed, unless either the &%ignore_status%& option is set (in which case
23078 the return code is treated as zero), or the return code is one of those listed
23079 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23080 later"&. In this case, delivery is deferred. Details of a permanent failure are
23081 logged, but are not included in the bounce message, which merely contains
23082 &"local delivery failed"&.
23083
23084 If the command exits on a signal and the &%freeze_signal%& option is set then
23085 the message will be frozen in the queue. If that option is not set, a bounce
23086 will be sent as normal.
23087
23088 If the return code is greater than 128 and the command being run is a shell
23089 script, it normally means that the script was terminated by a signal whose
23090 value is the return code minus 128. The &%freeze_signal%& option does not
23091 apply in this case.
23092
23093 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23094 return code is set to 127. This is the value that a shell returns if it is
23095 asked to run a non-existent command. The wording for the log line suggests that
23096 a non-existent command may be the problem.
23097
23098 The &%return_output%& option can affect the result of a pipe delivery. If it is
23099 set and the command produces any output on its standard output or standard
23100 error streams, the command is considered to have failed, even if it gave a zero
23101 return code or if &%ignore_status%& is set. The output from the command is
23102 included as part of the bounce message. The &%return_fail_output%& option is
23103 similar, except that output is returned only when the command exits with a
23104 failure return code, that is, a value other than zero or a code that matches
23105 &%temp_errors%&.
23106
23107
23108
23109 .section "How the command is run" "SECThowcommandrun"
23110 .cindex "&(pipe)& transport" "path for command"
23111 The command line is (by default) broken down into a command name and arguments
23112 by the &(pipe)& transport itself. The &%allow_commands%& and
23113 &%restrict_to_path%& options can be used to restrict the commands that may be
23114 run.
23115
23116 .cindex "quoting" "in pipe command"
23117 Unquoted arguments are delimited by white space. If an argument appears in
23118 double quotes, backslash is interpreted as an escape character in the usual
23119 way. If an argument appears in single quotes, no escaping is done.
23120
23121 String expansion is applied to the command line except when it comes from a
23122 traditional &_.forward_& file (commands from a filter file are expanded). The
23123 expansion is applied to each argument in turn rather than to the whole line.
23124 For this reason, any string expansion item that contains white space must be
23125 quoted so as to be contained within a single argument. A setting such as
23126 .code
23127 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23128 .endd
23129 will not work, because the expansion item gets split between several
23130 arguments. You have to write
23131 .code
23132 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23133 .endd
23134 to ensure that it is all in one argument. The expansion is done in this way,
23135 argument by argument, so that the number of arguments cannot be changed as a
23136 result of expansion, and quotes or backslashes in inserted variables do not
23137 interact with external quoting. However, this leads to problems if you want to
23138 generate multiple arguments (or the command name plus arguments) from a single
23139 expansion. In this situation, the simplest solution is to use a shell. For
23140 example:
23141 .code
23142 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23143 .endd
23144
23145 .cindex "transport" "filter"
23146 .cindex "filter" "transport filter"
23147 .vindex "&$pipe_addresses$&"
23148 Special handling takes place when an argument consists of precisely the text
23149 &`$pipe_addresses`&. This is not a general expansion variable; the only
23150 place this string is recognized is when it appears as an argument for a pipe or
23151 transport filter command. It causes each address that is being handled to be
23152 inserted in the argument list at that point &'as a separate argument'&. This
23153 avoids any problems with spaces or shell metacharacters, and is of use when a
23154 &(pipe)& transport is handling groups of addresses in a batch.
23155
23156 If &%force_command%& is enabled on the transport, Special handling takes place
23157 for an argument that consists of precisely the text &`$address_pipe`&.  It
23158 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23159 argument is inserted in the argument list at that point
23160 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23161 the only item in the argument; in fact, if it were then &%force_command%&
23162 should behave as a no-op.  Rather, it should be used to adjust the command
23163 run while preserving the argument vector separation.
23164
23165 After splitting up into arguments and expansion, the resulting command is run
23166 in a subprocess directly from the transport, &'not'& under a shell. The
23167 message that is being delivered is supplied on the standard input, and the
23168 standard output and standard error are both connected to a single pipe that is
23169 read by Exim. The &%max_output%& option controls how much output the command
23170 may produce, and the &%return_output%& and &%return_fail_output%& options
23171 control what is done with it.
23172
23173 Not running the command under a shell (by default) lessens the security risks
23174 in cases when a command from a user's filter file is built out of data that was
23175 taken from an incoming message. If a shell is required, it can of course be
23176 explicitly specified as the command to be run. However, there are circumstances
23177 where existing commands (for example, in &_.forward_& files) expect to be run
23178 under a shell and cannot easily be modified. To allow for these cases, there is
23179 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23180 works. Instead of breaking up the command line as just described, it expands it
23181 as a single string and passes the result to &_/bin/sh_&. The
23182 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23183 with &%use_shell%&, and the whole mechanism is inherently less secure.
23184
23185
23186
23187 .section "Environment variables" "SECTpipeenv"
23188 .cindex "&(pipe)& transport" "environment for command"
23189 .cindex "environment" "&(pipe)& transport"
23190 The environment variables listed below are set up when the command is invoked.
23191 This list is a compromise for maximum compatibility with other MTAs. Note that
23192 the &%environment%& option can be used to add additional variables to this
23193 environment. The environment for the &(pipe)& transport is not subject
23194 to the &%add_environment%& and &%keep_environment%& main config options.
23195 .display
23196 &`DOMAIN            `&   the domain of the address
23197 &`HOME              `&   the home directory, if set
23198 &`HOST              `&   the host name when called from a router (see below)
23199 &`LOCAL_PART        `&   see below
23200 &`LOCAL_PART_PREFIX `&   see below
23201 &`LOCAL_PART_SUFFIX `&   see below
23202 &`LOGNAME           `&   see below
23203 &`MESSAGE_ID        `&   Exim's local ID for the message
23204 &`PATH              `&   as specified by the &%path%& option below
23205 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23206 &`RECIPIENT         `&   the complete recipient address
23207 &`SENDER            `&   the sender of the message (empty if a bounce)
23208 &`SHELL             `&   &`/bin/sh`&
23209 &`TZ                `&   the value of the &%timezone%& option, if set
23210 &`USER              `&   see below
23211 .endd
23212 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23213 router, LOCAL_PART is set to the local part of the address. When it is
23214 called as a result of a forward or alias expansion, LOCAL_PART is set to
23215 the local part of the address that was expanded. In both cases, any affixes are
23216 removed from the local part, and made available in LOCAL_PART_PREFIX and
23217 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23218 same value as LOCAL_PART for compatibility with other MTAs.
23219
23220 .cindex "HOST"
23221 HOST is set only when a &(pipe)& transport is called from a router that
23222 associates hosts with an address, typically when using &(pipe)& as a
23223 pseudo-remote transport. HOST is set to the first host name specified by
23224 the router.
23225
23226 .cindex "HOME"
23227 If the transport's generic &%home_directory%& option is set, its value is used
23228 for the HOME environment variable. Otherwise, a home directory may be set
23229 by the router's &%transport_home_directory%& option, which defaults to the
23230 user's home directory if &%check_local_user%& is set.
23231
23232
23233 .section "Private options for pipe" "SECID142"
23234 .cindex "options" "&(pipe)& transport"
23235
23236
23237
23238 .option allow_commands pipe "string list&!!" unset
23239 .cindex "&(pipe)& transport" "permitted commands"
23240 The string is expanded, and is then interpreted as a colon-separated list of
23241 permitted commands. If &%restrict_to_path%& is not set, the only commands
23242 permitted are those in the &%allow_commands%& list. They need not be absolute
23243 paths; the &%path%& option is still used for relative paths. If
23244 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23245 in the &%allow_commands%& list, or a name without any slashes that is found on
23246 the path. In other words, if neither &%allow_commands%& nor
23247 &%restrict_to_path%& is set, there is no restriction on the command, but
23248 otherwise only commands that are permitted by one or the other are allowed. For
23249 example, if
23250 .code
23251 allow_commands = /usr/bin/vacation
23252 .endd
23253 and &%restrict_to_path%& is not set, the only permitted command is
23254 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23255 &%use_shell%& is set.
23256
23257
23258 .option batch_id pipe string&!! unset
23259 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23260
23261
23262 .option batch_max pipe integer 1
23263 This limits the number of addresses that can be handled in a single delivery.
23264 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23265
23266
23267 .option check_string pipe string unset
23268 As &(pipe)& writes the message, the start of each line is tested for matching
23269 &%check_string%&, and if it does, the initial matching characters are replaced
23270 by the contents of &%escape_string%&, provided both are set. The value of
23271 &%check_string%& is a literal string, not a regular expression, and the case of
23272 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23273 of &%check_string%& and &%escape_string%& are forced to values that implement
23274 the SMTP escaping protocol. Any settings made in the configuration file are
23275 ignored.
23276
23277
23278 .option command pipe string&!! unset
23279 This option need not be set when &(pipe)& is being used to deliver to pipes
23280 obtained directly from address redirections. In other cases, the option must be
23281 set, to provide a command to be run. It need not yield an absolute path (see
23282 the &%path%& option below). The command is split up into separate arguments by
23283 Exim, and each argument is separately expanded, as described in section
23284 &<<SECThowcommandrun>>& above.
23285
23286
23287 .option environment pipe string&!! unset
23288 .cindex "&(pipe)& transport" "environment for command"
23289 .cindex "environment" "&(pipe)& transport"
23290 This option is used to add additional variables to the environment in which the
23291 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23292 a string which is expanded, and then interpreted as a colon-separated list of
23293 environment settings of the form <&'name'&>=<&'value'&>.
23294
23295
23296 .option escape_string pipe string unset
23297 See &%check_string%& above.
23298
23299
23300 .option freeze_exec_fail pipe boolean false
23301 .cindex "exec failure"
23302 .cindex "failure of exec"
23303 .cindex "&(pipe)& transport" "failure of exec"
23304 Failure to exec the command in a pipe transport is by default treated like
23305 any other failure while running the command. However, if &%freeze_exec_fail%&
23306 is set, failure to exec is treated specially, and causes the message to be
23307 frozen, whatever the setting of &%ignore_status%&.
23308
23309
23310 .option freeze_signal pipe boolean false
23311 .cindex "signal exit"
23312 .cindex "&(pipe)& transport", "signal exit"
23313 Normally if the process run by a command in a pipe transport exits on a signal,
23314 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23315 frozen in Exim's queue instead.
23316
23317
23318 .option force_command pipe boolean false
23319 .cindex "force command"
23320 .cindex "&(pipe)& transport", "force command"
23321 Normally when a router redirects an address directly to a pipe command
23322 the &%command%& option on the transport is ignored.  If &%force_command%&
23323 is set, the &%command%& option will used. This is especially
23324 useful for forcing a wrapper or additional argument to be added to the
23325 command. For example:
23326 .code
23327 command = /usr/bin/remote_exec myhost -- $address_pipe
23328 force_command
23329 .endd
23330
23331 Note that &$address_pipe$& is handled specially in &%command%& when
23332 &%force_command%& is set, expanding out to the original argument vector as
23333 separate items, similarly to a Unix shell &`"$@"`& construct.
23334
23335
23336 .option ignore_status pipe boolean false
23337 If this option is true, the status returned by the subprocess that is set up to
23338 run the command is ignored, and Exim behaves as if zero had been returned.
23339 Otherwise, a non-zero status or termination by signal causes an error return
23340 from the transport unless the status value is one of those listed in
23341 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23342
23343 &*Note*&: This option does not apply to timeouts, which do not return a status.
23344 See the &%timeout_defer%& option for how timeouts are handled.
23345
23346
23347 .option log_defer_output pipe boolean false
23348 .cindex "&(pipe)& transport" "logging output"
23349 If this option is set, and the status returned by the command is
23350 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23351 and any output was produced on stdout or stderr, the first line of it is
23352 written to the main log.
23353
23354
23355 .option log_fail_output pipe boolean false
23356 If this option is set, and the command returns any output on stdout or
23357 stderr, and also ends with a return code that is neither zero nor one of
23358 the return codes listed in &%temp_errors%& (that is, the delivery
23359 failed), the first line of output is written to the main log. This
23360 option and &%log_output%& are mutually exclusive.  Only one of them may
23361 be set.
23362
23363
23364 .option log_output pipe boolean false
23365 If this option is set and the command returns any output on stdout or
23366 stderr, the first line of output is written to the main log, whatever
23367 the return code. This option and &%log_fail_output%& are mutually
23368 exclusive. Only one of them may be set.
23369
23370
23371 .option max_output pipe integer 20K
23372 This specifies the maximum amount of output that the command may produce on its
23373 standard output and standard error file combined. If the limit is exceeded, the
23374 process running the command is killed. This is intended as a safety measure to
23375 catch runaway processes. The limit is applied independently of the settings of
23376 the options that control what is done with such output (for example,
23377 &%return_output%&). Because of buffering effects, the amount of output may
23378 exceed the limit by a small amount before Exim notices.
23379
23380
23381 .option message_prefix pipe string&!! "see below"
23382 The string specified here is expanded and output at the start of every message.
23383 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23384 .code
23385 message_prefix = \
23386   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23387   ${tod_bsdinbox}\n
23388 .endd
23389 .cindex "Cyrus"
23390 .cindex "&%tmail%&"
23391 .cindex "&""From""& line"
23392 This is required by the commonly used &_/usr/bin/vacation_& program.
23393 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23394 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23395 setting
23396 .code
23397 message_prefix =
23398 .endd
23399 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23400 &`\n`& to &`\r\n`& in &%message_prefix%&.
23401
23402
23403 .option message_suffix pipe string&!! "see below"
23404 The string specified here is expanded and output at the end of every message.
23405 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23406 The suffix can be suppressed by setting
23407 .code
23408 message_suffix =
23409 .endd
23410 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23411 &`\n`& to &`\r\n`& in &%message_suffix%&.
23412
23413
23414 .option path pipe string&!! "/bin:/usr/bin"
23415 This option is expanded and
23416 specifies the string that is set up in the PATH environment
23417 variable of the subprocess.
23418 If the &%command%& option does not yield an absolute path name, the command is
23419 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23420 apply to a command specified as a transport filter.
23421
23422
23423 .option permit_coredump pipe boolean false
23424 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23425 a core-dump of a pipe command, enable this command.  This enables core-dumps
23426 during delivery and affects both the Exim binary and the pipe command run.
23427 It is recommended that this option remain off unless and until you have a need
23428 for it and that this only be enabled when needed, as the risk of excessive
23429 resource consumption can be quite high.  Note also that Exim is typically
23430 installed as a setuid binary and most operating systems will inhibit coredumps
23431 of these by default, so further OS-specific action may be required.
23432
23433
23434 .option pipe_as_creator pipe boolean false
23435 .cindex "uid (user id)" "local delivery"
23436 If the generic &%user%& option is not set and this option is true, the delivery
23437 process is run under the uid that was in force when Exim was originally called
23438 to accept the message. If the group id is not otherwise set (via the generic
23439 &%group%& option), the gid that was in force when Exim was originally called to
23440 accept the message is used.
23441
23442
23443 .option restrict_to_path pipe boolean false
23444 When this option is set, any command name not listed in &%allow_commands%& must
23445 contain no slashes. The command is searched for only in the directories listed
23446 in the &%path%& option. This option is intended for use in the case when a pipe
23447 command has been generated from a user's &_.forward_& file. This is usually
23448 handled by a &(pipe)& transport called &%address_pipe%&.
23449
23450
23451 .option return_fail_output pipe boolean false
23452 If this option is true, and the command produced any output and ended with a
23453 return code other than zero or one of the codes listed in &%temp_errors%& (that
23454 is, the delivery failed), the output is returned in the bounce message.
23455 However, if the message has a null sender (that is, it is itself a bounce
23456 message), output from the command is discarded. This option and
23457 &%return_output%& are mutually exclusive. Only one of them may be set.
23458
23459
23460
23461 .option return_output pipe boolean false
23462 If this option is true, and the command produced any output, the delivery is
23463 deemed to have failed whatever the return code from the command, and the output
23464 is returned in the bounce message. Otherwise, the output is just discarded.
23465 However, if the message has a null sender (that is, it is a bounce message),
23466 output from the command is always discarded, whatever the setting of this
23467 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23468 of them may be set.
23469
23470
23471
23472 .option temp_errors pipe "string list" "see below"
23473 .cindex "&(pipe)& transport" "temporary failure"
23474 This option contains either a colon-separated list of numbers, or a single
23475 asterisk. If &%ignore_status%& is false
23476 and &%return_output%& is not set,
23477 and the command exits with a non-zero return code, the failure is treated as
23478 temporary and the delivery is deferred if the return code matches one of the
23479 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23480 codes are treated as permanent errors. The default setting contains the codes
23481 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23482 compiled on a system that does not define these macros, it assumes values of 75
23483 and 73, respectively.
23484
23485
23486 .option timeout pipe time 1h
23487 If the command fails to complete within this time, it is killed. This normally
23488 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23489 specifies no timeout. In order to ensure that any subprocesses created by the
23490 command are also killed, Exim makes the initial process a process group leader,
23491 and kills the whole process group on a timeout. However, this can be defeated
23492 if one of the processes starts a new process group.
23493
23494 .option timeout_defer pipe boolean false
23495 A timeout in a &(pipe)& transport, either in the command that the transport
23496 runs, or in a transport filter that is associated with it, is by default
23497 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23498 is set true, both kinds of timeout become temporary errors, causing the
23499 delivery to be deferred.
23500
23501 .option umask pipe "octal integer" 022
23502 This specifies the umask setting for the subprocess that runs the command.
23503
23504
23505 .option use_bsmtp pipe boolean false
23506 .cindex "envelope sender"
23507 If this option is set true, the &(pipe)& transport writes messages in &"batch
23508 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23509 commands. If you want to include a leading HELO command with such messages,
23510 you can do so by setting the &%message_prefix%& option. See section
23511 &<<SECTbatchSMTP>>& for details of batch SMTP.
23512
23513 .option use_classresources pipe boolean false
23514 .cindex "class resources (BSD)"
23515 This option is available only when Exim is running on FreeBSD, NetBSD, or
23516 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23517 resource limits when a &(pipe)& transport is run to perform a delivery. The
23518 limits for the uid under which the pipe is to run are obtained from the login
23519 class database.
23520
23521
23522 .option use_crlf pipe boolean false
23523 .cindex "carriage return"
23524 .cindex "linefeed"
23525 This option causes lines to be terminated with the two-character CRLF sequence
23526 (carriage return, linefeed) instead of just a linefeed character. In the case
23527 of batched SMTP, the byte sequence written to the pipe is then an exact image
23528 of what would be sent down a real SMTP connection.
23529
23530 The contents of the &%message_prefix%& and &%message_suffix%& options are
23531 written verbatim, so must contain their own carriage return characters if these
23532 are needed. When &%use_bsmtp%& is not set, the default values for both
23533 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23534 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23535
23536
23537 .option use_shell pipe boolean false
23538 .vindex "&$pipe_addresses$&"
23539 If this option is set, it causes the command to be passed to &_/bin/sh_&
23540 instead of being run directly from the transport, as described in section
23541 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23542 where the command is expected to be run under a shell and cannot easily be
23543 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23544 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23545 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23546 its &%-c%& option.
23547
23548
23549
23550 .section "Using an external local delivery agent" "SECID143"
23551 .cindex "local delivery" "using an external agent"
23552 .cindex "&'procmail'&"
23553 .cindex "external local delivery"
23554 .cindex "delivery" "&'procmail'&"
23555 .cindex "delivery" "by external agent"
23556 The &(pipe)& transport can be used to pass all messages that require local
23557 delivery to a separate local delivery agent such as &%procmail%&. When doing
23558 this, care must be taken to ensure that the pipe is run under an appropriate
23559 uid and gid. In some configurations one wants this to be a uid that is trusted
23560 by the delivery agent to supply the correct sender of the message. It may be
23561 necessary to recompile or reconfigure the delivery agent so that it trusts an
23562 appropriate user. The following is an example transport and router
23563 configuration for &%procmail%&:
23564 .code
23565 # transport
23566 procmail_pipe:
23567   driver = pipe
23568   command = /usr/local/bin/procmail -d $local_part
23569   return_path_add
23570   delivery_date_add
23571   envelope_to_add
23572   check_string = "From "
23573   escape_string = ">From "
23574   umask = 077
23575   user = $local_part
23576   group = mail
23577
23578 # router
23579 procmail:
23580   driver = accept
23581   check_local_user
23582   transport = procmail_pipe
23583 .endd
23584 In this example, the pipe is run as the local user, but with the group set to
23585 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23586 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23587 user to supply a correct sender address. If you do not specify either a
23588 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23589 home directory is the user's home directory by default.
23590
23591 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23592 .code
23593 IFS=" "
23594 .endd
23595 as shown in some &%procmail%& documentation, because Exim does not by default
23596 use a shell to run pipe commands.
23597
23598 .cindex "Cyrus"
23599 The next example shows a transport and a router for a system where local
23600 deliveries are handled by the Cyrus IMAP server.
23601 .code
23602 # transport
23603 local_delivery_cyrus:
23604   driver = pipe
23605   command = /usr/cyrus/bin/deliver \
23606             -m ${substr_1:$local_part_suffix} -- $local_part
23607   user = cyrus
23608   group = mail
23609   return_output
23610   log_output
23611   message_prefix =
23612   message_suffix =
23613
23614 # router
23615 local_user_cyrus:
23616   driver = accept
23617   check_local_user
23618   local_part_suffix = .*
23619   transport = local_delivery_cyrus
23620 .endd
23621 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23622 &%return_output%& to cause any text written by Cyrus to be returned to the
23623 sender.
23624 .ecindex IIDpiptra1
23625 .ecindex IIDpiptra2
23626
23627
23628 . ////////////////////////////////////////////////////////////////////////////
23629 . ////////////////////////////////////////////////////////////////////////////
23630
23631 .chapter "The smtp transport" "CHAPsmtptrans"
23632 .scindex IIDsmttra1 "transports" "&(smtp)&"
23633 .scindex IIDsmttra2 "&(smtp)& transport"
23634 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23635 or LMTP protocol. The list of hosts to try can either be taken from the address
23636 that is being processed (having been set up by the router), or specified
23637 explicitly for the transport. Timeout and retry processing (see chapter
23638 &<<CHAPretry>>&) is applied to each IP address independently.
23639
23640
23641 .section "Multiple messages on a single connection" "SECID144"
23642 The sending of multiple messages over a single TCP/IP connection can arise in
23643 two ways:
23644
23645 .ilist
23646 If a message contains more than &%max_rcpt%& (see below) addresses that are
23647 routed to the same host, more than one copy of the message has to be sent to
23648 that host. In this situation, multiple copies may be sent in a single run of
23649 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23650 does when it has too many addresses to send in one message also depends on the
23651 value of the global &%remote_max_parallel%& option. Details are given in
23652 section &<<SECToutSMTPTCP>>&.)
23653 .next
23654 .cindex "hints database" "remembering routing"
23655 When a message has been successfully delivered over a TCP/IP connection, Exim
23656 looks in its hints database to see if there are any other messages awaiting a
23657 connection to the same host. If there are, a new delivery process is started
23658 for one of them, and the current TCP/IP connection is passed on to it. The new
23659 process may in turn send multiple copies and possibly create yet another
23660 process.
23661 .endlist
23662
23663
23664 For each copy sent over the same TCP/IP connection, a sequence counter is
23665 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23666 no further messages are sent over that connection.
23667
23668
23669
23670 .section "Use of the $host and $host_address variables" "SECID145"
23671 .vindex "&$host$&"
23672 .vindex "&$host_address$&"
23673 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23674 &$host_address$& are the name and IP address of the first host on the host list
23675 passed by the router. However, when the transport is about to connect to a
23676 specific host, and while it is connected to that host, &$host$& and
23677 &$host_address$& are set to the values for that host. These are the values
23678 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23679 &%serialize_hosts%&, and the various TLS options are expanded.
23680
23681
23682 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23683 .vindex &$tls_bits$&
23684 .vindex &$tls_cipher$&
23685 .vindex &$tls_peerdn$&
23686 .vindex &$tls_sni$&
23687 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23688 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23689 are the values that were set when the message was received.
23690 These are the values that are used for options that are expanded before any
23691 SMTP connections are made. Just before each connection is made, these four
23692 variables are emptied. If TLS is subsequently started, they are set to the
23693 appropriate values for the outgoing connection, and these are the values that
23694 are in force when any authenticators are run and when the
23695 &%authenticated_sender%& option is expanded.
23696
23697 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23698 and will be removed in a future release.
23699
23700
23701 .section "Private options for smtp" "SECID146"
23702 .cindex "options" "&(smtp)& transport"
23703 The private options of the &(smtp)& transport are as follows:
23704
23705
23706 .option address_retry_include_sender smtp boolean true
23707 .cindex "4&'xx'& responses" "retrying after"
23708 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23709 is the combination of sender and recipient that is delayed in subsequent queue
23710 runs until the retry time is reached. You can delay the recipient without
23711 reference to the sender (which is what earlier versions of Exim did), by
23712 setting &%address_retry_include_sender%& false. However, this can lead to
23713 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23714
23715 .option allow_localhost smtp boolean false
23716 .cindex "local host" "sending to"
23717 .cindex "fallback" "hosts specified on transport"
23718 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23719 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23720 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23721 the delivery anyway. This should be used only in special cases when the
23722 configuration ensures that no looping will result (for example, a differently
23723 configured Exim is listening on the port to which the message is sent).
23724
23725
23726 .option authenticated_sender smtp string&!! unset
23727 .cindex "Cyrus"
23728 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23729 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23730 overriding any existing authenticated sender value. If the string expansion is
23731 forced to fail, the option is ignored. Other expansion failures cause delivery
23732 to be deferred. If the result of expansion is an empty string, that is also
23733 ignored.
23734
23735 The expansion happens after the outgoing connection has been made and TLS
23736 started, if required. This means that the &$host$&, &$host_address$&,
23737 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23738 particular connection.
23739
23740 If the SMTP session is not authenticated, the expansion of
23741 &%authenticated_sender%& still happens (and can cause the delivery to be
23742 deferred if it fails), but no AUTH= item is added to MAIL commands
23743 unless &%authenticated_sender_force%& is true.
23744
23745 This option allows you to use the &(smtp)& transport in LMTP mode to
23746 deliver mail to Cyrus IMAP and provide the proper local part as the
23747 &"authenticated sender"&, via a setting such as:
23748 .code
23749 authenticated_sender = $local_part
23750 .endd
23751 This removes the need for IMAP subfolders to be assigned special ACLs to
23752 allow direct delivery to those subfolders.
23753
23754 Because of expected uses such as that just described for Cyrus (when no
23755 domain is involved), there is no checking on the syntax of the provided
23756 value.
23757
23758
23759 .option authenticated_sender_force smtp boolean false
23760 If this option is set true, the &%authenticated_sender%& option's value
23761 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23762 authenticated as a client.
23763
23764
23765 .option command_timeout smtp time 5m
23766 This sets a timeout for receiving a response to an SMTP command that has been
23767 sent out. It is also used when waiting for the initial banner line from the
23768 remote host. Its value must not be zero.
23769
23770
23771 .option connect_timeout smtp time 5m
23772 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23773 to a remote host. A setting of zero allows the system timeout (typically
23774 several minutes) to act. To have any effect, the value of this option must be
23775 less than the system timeout. However, it has been observed that on some
23776 systems there is no system timeout, which is why the default value for this
23777 option is 5 minutes, a value recommended by RFC 1123.
23778
23779
23780 .option connection_max_messages smtp integer 500
23781 .cindex "SMTP" "passed connection"
23782 .cindex "SMTP" "multiple deliveries"
23783 .cindex "multiple SMTP deliveries"
23784 This controls the maximum number of separate message deliveries that are sent
23785 over a single TCP/IP connection. If the value is zero, there is no limit.
23786 For testing purposes, this value can be overridden by the &%-oB%& command line
23787 option.
23788
23789
23790 .option data_timeout smtp time 5m
23791 This sets a timeout for the transmission of each block in the data portion of
23792 the message. As a result, the overall timeout for a message depends on the size
23793 of the message. Its value must not be zero. See also &%final_timeout%&.
23794
23795
23796 .option dkim_domain smtp string list&!! unset
23797 .option dkim_selector smtp string&!! unset
23798 .option dkim_private_key smtp string&!! unset
23799 .option dkim_canon smtp string&!! unset
23800 .option dkim_strict smtp string&!! unset
23801 .option dkim_sign_headers smtp string&!! unset
23802 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
23803
23804
23805 .option delay_after_cutoff smtp boolean true
23806 This option controls what happens when all remote IP addresses for a given
23807 domain have been inaccessible for so long that they have passed their retry
23808 cutoff times.
23809
23810 In the default state, if the next retry time has not been reached for any of
23811 them, the address is bounced without trying any deliveries. In other words,
23812 Exim delays retrying an IP address after the final cutoff time until a new
23813 retry time is reached, and can therefore bounce an address without ever trying
23814 a delivery, when machines have been down for a long time. Some people are
23815 unhappy at this prospect, so...
23816
23817 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23818 addresses are past their final cutoff time, Exim tries to deliver to those
23819 IP addresses that have not been tried since the message arrived. If there are
23820 none, of if they all fail, the address is bounced. In other words, it does not
23821 delay when a new message arrives, but immediately tries those expired IP
23822 addresses that haven't been tried since the message arrived. If there is a
23823 continuous stream of messages for the dead hosts, unsetting
23824 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23825 to them.
23826
23827
23828 .option dns_qualify_single smtp boolean true
23829 If the &%hosts%& or &%fallback_hosts%& option is being used,
23830 and the &%gethostbyname%& option is false,
23831 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23832 in chapter &<<CHAPdnslookup>>& for more details.
23833
23834
23835 .option dns_search_parents smtp boolean false
23836 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23837 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23838 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23839 details.
23840
23841
23842 .option dnssec_request_domains smtp "domain list&!!" unset
23843 .cindex "MX record" "security"
23844 .cindex "DNSSEC" "MX lookup"
23845 .cindex "security" "MX lookup"
23846 .cindex "DNS" "DNSSEC"
23847 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23848 the dnssec request bit set.
23849 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23850
23851
23852
23853 .option dnssec_require_domains smtp "domain list&!!" unset
23854 .cindex "MX record" "security"
23855 .cindex "DNSSEC" "MX lookup"
23856 .cindex "security" "MX lookup"
23857 .cindex "DNS" "DNSSEC"
23858 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
23859 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23860 (AD bit) set will be ignored and logged as a host-lookup failure.
23861 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23862
23863
23864
23865 .option dscp smtp string&!! unset
23866 .cindex "DCSP" "outbound"
23867 This option causes the DSCP value associated with a socket to be set to one
23868 of a number of fixed strings or to numeric value.
23869 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23870 Common values include &`throughput`&, &`mincost`&, and on newer systems
23871 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23872
23873 The outbound packets from Exim will be marked with this value in the header
23874 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23875 that these values will have any effect, not be stripped by networking
23876 equipment, or do much of anything without cooperation with your Network
23877 Engineer and those of all network operators between the source and destination.
23878
23879
23880 .option fallback_hosts smtp "string list" unset
23881 .cindex "fallback" "hosts specified on transport"
23882 String expansion is not applied to this option. The argument must be a
23883 colon-separated list of host names or IP addresses, optionally also including
23884 port numbers, though the separator can be changed, as described in section
23885 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23886 item in a &%route_list%& setting for the &(manualroute)& router, as described
23887 in section &<<SECTformatonehostitem>>&.
23888
23889 Fallback hosts can also be specified on routers, which associate them with the
23890 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23891 &%fallback_hosts%& specified on the transport is used only if the address does
23892 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23893 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23894 However, &%hosts_randomize%& does apply to fallback host lists.
23895
23896 If Exim is unable to deliver to any of the hosts for a particular address, and
23897 the errors are not permanent rejections, the address is put on a separate
23898 transport queue with its host list replaced by the fallback hosts, unless the
23899 address was routed via MX records and the current host was in the original MX
23900 list. In that situation, the fallback host list is not used.
23901
23902 Once normal deliveries are complete, the fallback queue is delivered by
23903 re-running the same transports with the new host lists. If several failing
23904 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23905 copy of the message is sent.
23906
23907 The resolution of the host names on the fallback list is controlled by the
23908 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23909 both to cases when the host list comes with the address and when it is taken
23910 from &%hosts%&. This option provides a &"use a smart host only if delivery
23911 fails"& facility.
23912
23913
23914 .option final_timeout smtp time 10m
23915 This is the timeout that applies while waiting for the response to the final
23916 line containing just &"."& that terminates a message. Its value must not be
23917 zero.
23918
23919 .option gethostbyname smtp boolean false
23920 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23921 being used, names are looked up using &[gethostbyname()]&
23922 (or &[getipnodebyname()]& when available)
23923 instead of using the DNS. Of course, that function may in fact use the DNS, but
23924 it may also consult other sources of information such as &_/etc/hosts_&.
23925
23926 .option gnutls_compat_mode smtp boolean unset
23927 This option controls whether GnuTLS is used in compatibility mode in an Exim
23928 server. This reduces security slightly, but improves interworking with older
23929 implementations of TLS.
23930
23931 .option helo_data smtp string&!! "see below"
23932 .cindex "HELO" "argument, setting"
23933 .cindex "EHLO" "argument, setting"
23934 .cindex "LHLO argument setting"
23935 The value of this option is expanded after a connection to a another host has
23936 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23937 command that starts the outgoing SMTP or LMTP session. The default value of the
23938 option is:
23939 .code
23940 $primary_hostname
23941 .endd
23942 During the expansion, the variables &$host$& and &$host_address$& are set to
23943 the identity of the remote host, and the variables &$sending_ip_address$& and
23944 &$sending_port$& are set to the local IP address and port number that are being
23945 used. These variables can be used to generate different values for different
23946 servers or different local IP addresses. For example, if you want the string
23947 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23948 interface address, you could use this:
23949 .code
23950 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23951   {$primary_hostname}}
23952 .endd
23953 The use of &%helo_data%& applies both to sending messages and when doing
23954 callouts.
23955
23956 .option hosts smtp "string list&!!" unset
23957 Hosts are associated with an address by a router such as &(dnslookup)&, which
23958 finds the hosts by looking up the address domain in the DNS, or by
23959 &(manualroute)&, which has lists of hosts in its configuration. However,
23960 email addresses can be passed to the &(smtp)& transport by any router, and not
23961 all of them can provide an associated list of hosts.
23962
23963 The &%hosts%& option specifies a list of hosts to be used if the address being
23964 processed does not have any hosts associated with it. The hosts specified by
23965 &%hosts%& are also used, whether or not the address has its own hosts, if
23966 &%hosts_override%& is set.
23967
23968 The string is first expanded, before being interpreted as a colon-separated
23969 list of host names or IP addresses, possibly including port numbers. The
23970 separator may be changed to something other than colon, as described in section
23971 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23972 item in a &%route_list%& setting for the &(manualroute)& router, as described
23973 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23974 of the &(manualroute)& router is not available here.
23975
23976 If the expansion fails, delivery is deferred. Unless the failure was caused by
23977 the inability to complete a lookup, the error is logged to the panic log as
23978 well as the main log. Host names are looked up either by searching directly for
23979 address records in the DNS or by calling &[gethostbyname()]& (or
23980 &[getipnodebyname()]& when available), depending on the setting of the
23981 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23982 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23983 address are used.
23984
23985 During delivery, the hosts are tried in order, subject to their retry status,
23986 unless &%hosts_randomize%& is set.
23987
23988
23989 .option hosts_avoid_esmtp smtp "host list&!!" unset
23990 .cindex "ESMTP, avoiding use of"
23991 .cindex "HELO" "forcing use of"
23992 .cindex "EHLO" "avoiding use of"
23993 .cindex "PIPELINING" "avoiding the use of"
23994 This option is for use with broken hosts that announce ESMTP facilities (for
23995 example, PIPELINING) and then fail to implement them properly. When a host
23996 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23997 start of the SMTP session. This means that it cannot use any of the ESMTP
23998 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23999
24000
24001 .option hosts_avoid_pipelining smtp "host list&!!" unset
24002 .cindex "PIPELINING" "avoiding the use of"
24003 Exim will not use the SMTP PIPELINING extension when delivering to any host
24004 that matches this list, even if the server host advertises PIPELINING support.
24005
24006
24007 .option hosts_avoid_tls smtp "host list&!!" unset
24008 .cindex "TLS" "avoiding for certain hosts"
24009 Exim will not try to start a TLS session when delivering to any host that
24010 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24011
24012 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24013 .cindex "TLS" "avoiding for certain hosts"
24014 Exim will not try to start a TLS session for a verify callout,
24015 or when delivering in cutthrough mode,
24016 to any host that matches this list.
24017
24018
24019 .option hosts_max_try smtp integer 5
24020 .cindex "host" "maximum number to try"
24021 .cindex "limit" "number of hosts tried"
24022 .cindex "limit" "number of MX tried"
24023 .cindex "MX record" "maximum tried"
24024 This option limits the number of IP addresses that are tried for any one
24025 delivery in cases where there are temporary delivery errors. Section
24026 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24027
24028
24029 .option hosts_max_try_hardlimit smtp integer 50
24030 This is an additional check on the maximum number of IP addresses that Exim
24031 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24032 why it exists.
24033
24034
24035
24036 .option hosts_nopass_tls smtp "host list&!!" unset
24037 .cindex "TLS" "passing connection"
24038 .cindex "multiple SMTP deliveries"
24039 .cindex "TLS" "multiple message deliveries"
24040 For any host that matches this list, a connection on which a TLS session has
24041 been started will not be passed to a new delivery process for sending another
24042 message on the same connection. See section &<<SECTmulmessam>>& for an
24043 explanation of when this might be needed.
24044
24045 .new
24046 .option hosts_noproxy_tls smtp "host list&!!" *
24047 .cindex "TLS" "passing connection"
24048 .cindex "multiple SMTP deliveries"
24049 .cindex "TLS" "multiple message deliveries"
24050 For any host that matches this list, a TLS session which has
24051 been started will not be passed to a new delivery process for sending another
24052 message on the same session.
24053
24054 The traditional implementation closes down TLS and re-starts it in the new
24055 process, on the same open TCP connection, for each successive message
24056 sent.  If permitted by this option a pipe to to the new process is set up
24057 instead, and the original process maintains the TLS connection and proxies
24058 the SMTP connection from and to the new process and any subsequents.
24059 The new process has no access to TLS information, so cannot include it in
24060 logging.
24061 .wen
24062
24063
24064
24065 .option hosts_override smtp boolean false
24066 If this option is set and the &%hosts%& option is also set, any hosts that are
24067 attached to the address are ignored, and instead the hosts specified by the
24068 &%hosts%& option are always used. This option does not apply to
24069 &%fallback_hosts%&.
24070
24071
24072 .option hosts_randomize smtp boolean false
24073 .cindex "randomized host list"
24074 .cindex "host" "list of; randomized"
24075 .cindex "fallback" "randomized hosts"
24076 If this option is set, and either the list of hosts is taken from the
24077 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24078 were not obtained from MX records (this includes fallback hosts from the
24079 router), and were not randomized by the router, the order of trying the hosts
24080 is randomized each time the transport runs. Randomizing the order of a host
24081 list can be used to do crude load sharing.
24082
24083 When &%hosts_randomize%& is true, a host list may be split into groups whose
24084 order is separately randomized. This makes it possible to set up MX-like
24085 behaviour. The boundaries between groups are indicated by an item that is just
24086 &`+`& in the host list. For example:
24087 .code
24088 hosts = host1:host2:host3:+:host4:host5
24089 .endd
24090 The order of the first three hosts and the order of the last two hosts is
24091 randomized for each use, but the first three always end up before the last two.
24092 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24093
24094 .option hosts_require_auth smtp "host list&!!" unset
24095 .cindex "authentication" "required by client"
24096 This option provides a list of servers for which authentication must succeed
24097 before Exim will try to transfer a message. If authentication fails for
24098 servers which are not in this list, Exim tries to send unauthenticated. If
24099 authentication fails for one of these servers, delivery is deferred. This
24100 temporary error is detectable in the retry rules, so it can be turned into a
24101 hard failure if required. See also &%hosts_try_auth%&, and chapter
24102 &<<CHAPSMTPAUTH>>& for details of authentication.
24103
24104
24105 .option hosts_request_ocsp smtp "host list&!!" *
24106 .cindex "TLS" "requiring for certain servers"
24107 Exim will request a Certificate Status on a
24108 TLS session for any host that matches this list.
24109 &%tls_verify_certificates%& should also be set for the transport.
24110
24111 .option hosts_require_ocsp smtp "host list&!!" unset
24112 .cindex "TLS" "requiring for certain servers"
24113 Exim will request, and check for a valid Certificate Status being given, on a
24114 TLS session for any host that matches this list.
24115 &%tls_verify_certificates%& should also be set for the transport.
24116
24117 .option hosts_require_tls smtp "host list&!!" unset
24118 .cindex "TLS" "requiring for certain servers"
24119 Exim will insist on using a TLS session when delivering to any host that
24120 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24121 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24122 incoming messages, use an appropriate ACL.
24123
24124 .option hosts_try_auth smtp "host list&!!" unset
24125 .cindex "authentication" "optional in client"
24126 This option provides a list of servers to which, provided they announce
24127 authentication support, Exim will attempt to authenticate as a client when it
24128 connects. If authentication fails, Exim will try to transfer the message
24129 unauthenticated. See also &%hosts_require_auth%&, and chapter
24130 &<<CHAPSMTPAUTH>>& for details of authentication.
24131
24132 .option hosts_try_chunking smtp "host list&!!" *
24133 .cindex CHUNKING "enabling, in client"
24134 .cindex BDAT "SMTP command"
24135 .cindex "RFC 3030" "CHUNKING"
24136 This option provides a list of servers to which, provided they announce
24137 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24138 BDAT will not be used in conjunction with a transport filter.
24139
24140 .option hosts_try_fastopen smtp "host list!!" unset
24141 .cindex "fast open, TCP" "enabling, in client"
24142 .cindex "TCP Fast Open" "enabling, in client"
24143 .cindex "RFC 7413" "TCP Fast Open"
24144 This option provides a list of servers to which, provided
24145 the facility is supported by this system, Exim will attempt to
24146 perform a TCP Fast Open.
24147 No data is sent on the SYN segment but, if the remote server also
24148 supports the facility, it can send its SMTP banner immediately after
24149 the SYN,ACK segment.  This can save up to one round-trip time.
24150
24151 The facility is only active for previously-contacted servers,
24152 as the initiator must present a cookie in the SYN segment.
24153
24154 On (at least some) current Linux distributions the facility must be enabled
24155 in the kernel by the sysadmin before the support is usable.
24156
24157 .option hosts_try_prdr smtp "host list&!!" *
24158 .cindex "PRDR" "enabling, optional in client"
24159 This option provides a list of servers to which, provided they announce
24160 PRDR support, Exim will attempt to negotiate PRDR
24161 for multi-recipient messages.
24162 The option can usually be left as default.
24163
24164 .option interface smtp "string list&!!" unset
24165 .cindex "bind IP address"
24166 .cindex "IP address" "binding"
24167 .vindex "&$host$&"
24168 .vindex "&$host_address$&"
24169 This option specifies which interface to bind to when making an outgoing SMTP
24170 call. The value is an IP address, not an interface name such as
24171 &`eth0`&. Do not confuse this with the interface address that was used when a
24172 message was received, which is in &$received_ip_address$&, formerly known as
24173 &$interface_address$&. The name was changed to minimize confusion with the
24174 outgoing interface address. There is no variable that contains an outgoing
24175 interface address because, unless it is set by this option, its value is
24176 unknown.
24177
24178 During the expansion of the &%interface%& option the variables &$host$& and
24179 &$host_address$& refer to the host to which a connection is about to be made
24180 during the expansion of the string. Forced expansion failure, or an empty
24181 string result causes the option to be ignored. Otherwise, after expansion, the
24182 string must be a list of IP addresses, colon-separated by default, but the
24183 separator can be changed in the usual way. For example:
24184 .code
24185 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24186 .endd
24187 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24188 connection. If none of them are the correct type, the option is ignored. If
24189 &%interface%& is not set, or is ignored, the system's IP functions choose which
24190 interface to use if the host has more than one.
24191
24192
24193 .option keepalive smtp boolean true
24194 .cindex "keepalive" "on outgoing connection"
24195 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24196 connections. When set, it causes the kernel to probe idle connections
24197 periodically, by sending packets with &"old"& sequence numbers. The other end
24198 of the connection should send a acknowledgment if the connection is still okay
24199 or a reset if the connection has been aborted. The reason for doing this is
24200 that it has the beneficial effect of freeing up certain types of connection
24201 that can get stuck when the remote host is disconnected without tidying up the
24202 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24203 unreachable hosts.
24204
24205
24206 .option lmtp_ignore_quota smtp boolean false
24207 .cindex "LMTP" "ignoring quota errors"
24208 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24209 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24210 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24211
24212 .option max_rcpt smtp integer 100
24213 .cindex "RCPT" "maximum number of outgoing"
24214 This option limits the number of RCPT commands that are sent in a single
24215 SMTP message transaction. Each set of addresses is treated independently, and
24216 so can cause parallel connections to the same host if &%remote_max_parallel%&
24217 permits this.
24218
24219
24220 .option multi_domain smtp boolean&!! true
24221 .vindex "&$domain$&"
24222 When this option is set, the &(smtp)& transport can handle a number of
24223 addresses containing a mixture of different domains provided they all resolve
24224 to the same list of hosts. Turning the option off restricts the transport to
24225 handling only one domain at a time. This is useful if you want to use
24226 &$domain$& in an expansion for the transport, because it is set only when there
24227 is a single domain involved in a remote delivery.
24228
24229 It is expanded per-address and can depend on any of
24230 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24231 &$host$&, &$host_address$& and &$host_port$&.
24232
24233 .option port smtp string&!! "see below"
24234 .cindex "port" "sending TCP/IP"
24235 .cindex "TCP/IP" "setting outgoing port"
24236 This option specifies the TCP/IP port on the server to which Exim connects.
24237 &*Note:*& Do not confuse this with the port that was used when a message was
24238 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24239 The name was changed to minimize confusion with the outgoing port. There is no
24240 variable that contains an outgoing port.
24241
24242 If the value of this option begins with a digit it is taken as a port number;
24243 otherwise it is looked up using &[getservbyname()]&. The default value is
24244 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
24245 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
24246 is deferred.
24247
24248
24249
24250 .option protocol smtp string smtp
24251 .cindex "LMTP" "over TCP/IP"
24252 .cindex "ssmtp protocol" "outbound"
24253 .cindex "TLS" "SSL-on-connect outbound"
24254 .vindex "&$port$&"
24255 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24256 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24257 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24258 deliveries into closed message stores. Exim also has support for running LMTP
24259 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24260
24261 If this option is set to &"smtps"&, the default value for the &%port%& option
24262 changes to &"smtps"&, and the transport initiates TLS immediately after
24263 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24264 The Internet standards bodies strongly discourage use of this mode.
24265
24266
24267 .option retry_include_ip_address smtp boolean&!! true
24268 Exim normally includes both the host name and the IP address in the key it
24269 constructs for indexing retry data after a temporary delivery failure. This
24270 means that when one of several IP addresses for a host is failing, it gets
24271 tried periodically (controlled by the retry rules), but use of the other IP
24272 addresses is not affected.
24273
24274 However, in some dialup environments hosts are assigned a different IP address
24275 each time they connect. In this situation the use of the IP address as part of
24276 the retry key leads to undesirable behaviour. Setting this option false causes
24277 Exim to use only the host name.
24278 Since it is expanded it can be made to depend on the host or domain.
24279
24280
24281 .option serialize_hosts smtp "host list&!!" unset
24282 .cindex "serializing connections"
24283 .cindex "host" "serializing connections"
24284 Because Exim operates in a distributed manner, if several messages for the same
24285 host arrive at around the same time, more than one simultaneous connection to
24286 the remote host can occur. This is not usually a problem except when there is a
24287 slow link between the hosts. In that situation it may be helpful to restrict
24288 Exim to one connection at a time. This can be done by setting
24289 &%serialize_hosts%& to match the relevant hosts.
24290
24291 .cindex "hints database" "serializing deliveries to a host"
24292 Exim implements serialization by means of a hints database in which a record is
24293 written whenever a process connects to one of the restricted hosts. The record
24294 is deleted when the connection is completed. Obviously there is scope for
24295 records to get left lying around if there is a system or program crash. To
24296 guard against this, Exim ignores any records that are more than six hours old.
24297
24298 If you set up this kind of serialization, you should also arrange to delete the
24299 relevant hints database whenever your system reboots. The names of the files
24300 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24301 may be one or two files, depending on the type of DBM in use. The same files
24302 are used for ETRN serialization.
24303
24304 See also the &%max_parallel%& generic transport option.
24305
24306
24307 .option size_addition smtp integer 1024
24308 .cindex "SMTP" "SIZE"
24309 .cindex "message" "size issue for transport filter"
24310 .cindex "size" "of message"
24311 .cindex "transport" "filter"
24312 .cindex "filter" "transport filter"
24313 If a remote SMTP server indicates that it supports the SIZE option of the
24314 MAIL command, Exim uses this to pass over the message size at the start of
24315 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24316 sends, to allow for headers and other text that may be added during delivery by
24317 configuration options or in a transport filter. It may be necessary to increase
24318 this if a lot of text is added to messages.
24319
24320 Alternatively, if the value of &%size_addition%& is set negative, it disables
24321 the use of the SIZE option altogether.
24322
24323
24324 .option socks_proxy smtp string&!! unset
24325 .cindex proxy SOCKS
24326 This option enables use of SOCKS proxies for connections made by the
24327 transport.  For details see section &<<SECTproxySOCKS>>&.
24328
24329
24330 .option tls_certificate smtp string&!! unset
24331 .cindex "TLS" "client certificate, location of"
24332 .cindex "certificate" "client, location of"
24333 .vindex "&$host$&"
24334 .vindex "&$host_address$&"
24335 The value of this option must be the absolute path to a file which contains the
24336 client's certificate, for possible use when sending a message over an encrypted
24337 connection. The values of &$host$& and &$host_address$& are set to the name and
24338 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24339 details of TLS.
24340
24341 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24342 certificate when sending messages as a client. The global option of the same
24343 name specifies the certificate for Exim as a server; it is not automatically
24344 assumed that the same certificate should be used when Exim is operating as a
24345 client.
24346
24347
24348 .option tls_crl smtp string&!! unset
24349 .cindex "TLS" "client certificate revocation list"
24350 .cindex "certificate" "revocation list for client"
24351 This option specifies a certificate revocation list. The expanded value must
24352 be the name of a file that contains a CRL in PEM format.
24353
24354
24355 .option tls_dh_min_bits smtp integer 1024
24356 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24357 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24358 key agreement is negotiated, the server will provide a large prime number
24359 for use.  This option establishes the minimum acceptable size of that number.
24360 If the parameter offered by the server is too small, then the TLS handshake
24361 will fail.
24362
24363 Only supported when using GnuTLS.
24364
24365
24366 .option tls_privatekey smtp string&!! unset
24367 .cindex "TLS" "client private key, location of"
24368 .vindex "&$host$&"
24369 .vindex "&$host_address$&"
24370 The value of this option must be the absolute path to a file which contains the
24371 client's private key. This is used when sending a message over an encrypted
24372 connection using a client certificate. The values of &$host$& and
24373 &$host_address$& are set to the name and address of the server during the
24374 expansion. If this option is unset, or the expansion is forced to fail, or the
24375 result is an empty string, the private key is assumed to be in the same file as
24376 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24377
24378
24379 .option tls_require_ciphers smtp string&!! unset
24380 .cindex "TLS" "requiring specific ciphers"
24381 .cindex "cipher" "requiring specific"
24382 .vindex "&$host$&"
24383 .vindex "&$host_address$&"
24384 The value of this option must be a list of permitted cipher suites, for use
24385 when setting up an outgoing encrypted connection. (There is a global option of
24386 the same name for controlling incoming connections.) The values of &$host$& and
24387 &$host_address$& are set to the name and address of the server during the
24388 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24389 is used in different ways by OpenSSL and GnuTLS (see sections
24390 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24391 ciphers is a preference order.
24392
24393
24394
24395 .option tls_sni smtp string&!! unset
24396 .cindex "TLS" "Server Name Indication"
24397 .vindex "&$tls_sni$&"
24398 If this option is set then it sets the $tls_out_sni variable and causes any
24399 TLS session to pass this value as the Server Name Indication extension to
24400 the remote side, which can be used by the remote side to select an appropriate
24401 certificate and private key for the session.
24402
24403 See &<<SECTtlssni>>& for more information.
24404
24405 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24406 TLS extensions.
24407
24408
24409
24410
24411 .option tls_tempfail_tryclear smtp boolean true
24412 .cindex "4&'xx'& responses" "to STARTTLS"
24413 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24414 setting up a TLS session, this option determines whether or not Exim should try
24415 to deliver the message unencrypted. If it is set false, delivery to the
24416 current host is deferred; if there are other hosts, they are tried. If this
24417 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24418 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24419 TLS negotiation fails, Exim closes the current connection (because it is in an
24420 unknown state), opens a new one to the same host, and then tries the delivery
24421 in clear.
24422
24423
24424 .option tls_try_verify_hosts smtp "host list&!!" *
24425 .cindex "TLS" "server certificate verification"
24426 .cindex "certificate" "verification of server"
24427 This option gives a list of hosts for which, on encrypted connections,
24428 certificate verification will be tried but need not succeed.
24429 The &%tls_verify_certificates%& option must also be set.
24430 Note that unless the host is in this list
24431 TLS connections will be denied to hosts using self-signed certificates
24432 when &%tls_verify_certificates%& is matched.
24433 The &$tls_out_certificate_verified$& variable is set when
24434 certificate verification succeeds.
24435
24436
24437 .option tls_verify_cert_hostnames smtp "host list&!!" *
24438 .cindex "TLS" "server certificate hostname verification"
24439 .cindex "certificate" "verification of server"
24440 This option give a list of hosts for which,
24441 while verifying the server certificate,
24442 checks will be included on the host name
24443 (note that this will generally be the result of a DNS MX lookup)
24444 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24445 limited to being the initial component of a 3-or-more component FQDN.
24446
24447 There is no equivalent checking on client certificates.
24448
24449
24450 .option tls_verify_certificates smtp string&!! system
24451 .cindex "TLS" "server certificate verification"
24452 .cindex "certificate" "verification of server"
24453 .vindex "&$host$&"
24454 .vindex "&$host_address$&"
24455 The value of this option must be either the
24456 word "system"
24457 or the absolute path to
24458 a file or directory containing permitted certificates for servers,
24459 for use when setting up an encrypted connection.
24460
24461 The "system" value for the option will use a location compiled into the SSL library.
24462 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24463 is taken as empty and an explicit location
24464 must be specified.
24465
24466 The use of a directory for the option value is not available for GnuTLS versions
24467 preceding 3.3.6 and a single file must be used.
24468
24469 With OpenSSL the certificates specified
24470 explicitly
24471 either by file or directory
24472 are added to those given by the system default location.
24473
24474 The values of &$host$& and
24475 &$host_address$& are set to the name and address of the server during the
24476 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24477
24478 For back-compatibility,
24479 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24480 (a single-colon empty list counts as being set)
24481 and certificate verification fails the TLS connection is closed.
24482
24483
24484 .option tls_verify_hosts smtp "host list&!!" unset
24485 .cindex "TLS" "server certificate verification"
24486 .cindex "certificate" "verification of server"
24487 This option gives a list of hosts for which, on encrypted connections,
24488 certificate verification must succeed.
24489 The &%tls_verify_certificates%& option must also be set.
24490 If both this option and &%tls_try_verify_hosts%& are unset
24491 operation is as if this option selected all hosts.
24492
24493
24494
24495
24496 .section "How the limits for the number of hosts to try are used" &&&
24497          "SECTvalhosmax"
24498 .cindex "host" "maximum number to try"
24499 .cindex "limit" "hosts; maximum number tried"
24500 There are two options that are concerned with the number of hosts that are
24501 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24502 &%hosts_max_try_hardlimit%&.
24503
24504
24505 The &%hosts_max_try%& option limits the number of hosts that are tried
24506 for a single delivery. However, despite the term &"host"& in its name, the
24507 option actually applies to each IP address independently. In other words, a
24508 multihomed host is treated as several independent hosts, just as it is for
24509 retrying.
24510
24511 Many of the larger ISPs have multiple MX records which often point to
24512 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24513 created as a result of routing one of these domains.
24514
24515 Trying every single IP address on such a long list does not seem sensible; if
24516 several at the top of the list fail, it is reasonable to assume there is some
24517 problem that is likely to affect all of them. Roughly speaking, the value of
24518 &%hosts_max_try%& is the maximum number that are tried before deferring the
24519 delivery. However, the logic cannot be quite that simple.
24520
24521 Firstly, IP addresses that are skipped because their retry times have not
24522 arrived do not count, and in addition, addresses that are past their retry
24523 limits are also not counted, even when they are tried. This means that when
24524 some IP addresses are past their retry limits, more than the value of
24525 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24526 that all IP addresses are considered before timing out an email address (but
24527 see below for an exception).
24528
24529 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24530 list to see if there is a subsequent host with a different (higher valued) MX.
24531 If there is, that host is considered next, and the current IP address is used
24532 but not counted. This behaviour helps in the case of a domain with a retry rule
24533 that hardly ever delays any hosts, as is now explained:
24534
24535 Consider the case of a long list of hosts with one MX value, and a few with a
24536 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24537 hosts at the top of the list are tried at first. With the default retry rule,
24538 which specifies increasing retry times, the higher MX hosts are eventually
24539 tried when those at the top of the list are skipped because they have not
24540 reached their retry times.
24541
24542 However, it is common practice to put a fixed short retry time on domains for
24543 large ISPs, on the grounds that their servers are rarely down for very long.
24544 Unfortunately, these are exactly the domains that tend to resolve to long lists
24545 of hosts. The short retry time means that the lowest MX hosts are tried every
24546 time. The attempts may be in a different order because of random sorting, but
24547 without the special MX check, the higher MX hosts would never be tried until
24548 all the lower MX hosts had timed out (which might be several days), because
24549 there are always some lower MX hosts that have reached their retry times. With
24550 the special check, Exim considers at least one IP address from each MX value at
24551 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24552 reached.
24553
24554 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24555 particular, Exim normally eventually tries all the IP addresses before timing
24556 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24557 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24558 been set up with hundreds of IP addresses for some domains. It can
24559 take a very long time indeed for an address to time out in these cases.
24560
24561 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24562 Exim never tries more than this number of IP addresses; if it hits this limit
24563 and they are all timed out, the email address is bounced, even though not all
24564 possible IP addresses have been tried.
24565 .ecindex IIDsmttra1
24566 .ecindex IIDsmttra2
24567
24568
24569
24570
24571
24572 . ////////////////////////////////////////////////////////////////////////////
24573 . ////////////////////////////////////////////////////////////////////////////
24574
24575 .chapter "Address rewriting" "CHAPrewrite"
24576 .scindex IIDaddrew "rewriting" "addresses"
24577 There are some circumstances in which Exim automatically rewrites domains in
24578 addresses. The two most common are when an address is given without a domain
24579 (referred to as an &"unqualified address"&) or when an address contains an
24580 abbreviated domain that is expanded by DNS lookup.
24581
24582 Unqualified envelope addresses are accepted only for locally submitted
24583 messages, or for messages that are received from hosts matching
24584 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24585 appropriate. Unqualified addresses in header lines are qualified if they are in
24586 locally submitted messages, or messages from hosts that are permitted to send
24587 unqualified envelope addresses. Otherwise, unqualified addresses in header
24588 lines are neither qualified nor rewritten.
24589
24590 One situation in which Exim does &'not'& automatically rewrite a domain is
24591 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24592 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24593 do this. The new RFCs do not contain this suggestion.
24594
24595
24596 .section "Explicitly configured address rewriting" "SECID147"
24597 This chapter describes the rewriting rules that can be used in the
24598 main rewrite section of the configuration file, and also in the generic
24599 &%headers_rewrite%& option that can be set on any transport.
24600
24601 Some people believe that configured address rewriting is a Mortal Sin.
24602 Others believe that life is not possible without it. Exim provides the
24603 facility; you do not have to use it.
24604
24605 The main rewriting rules that appear in the &"rewrite"& section of the
24606 configuration file are applied to addresses in incoming messages, both envelope
24607 addresses and addresses in header lines. Each rule specifies the types of
24608 address to which it applies.
24609
24610 Whether or not addresses in header lines are rewritten depends on the origin of
24611 the headers and the type of rewriting. Global rewriting, that is, rewriting
24612 rules from the rewrite section of the configuration file, is applied only to
24613 those headers that were received with the message. Header lines that are added
24614 by ACLs or by a system filter or by individual routers or transports (which
24615 are specific to individual recipient addresses) are not rewritten by the global
24616 rules.
24617
24618 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24619 applies all headers except those added by routers and transports. That is, as
24620 well as the headers that were received with the message, it also applies to
24621 headers that were added by an ACL or a system filter.
24622
24623
24624 In general, rewriting addresses from your own system or domain has some
24625 legitimacy. Rewriting other addresses should be done only with great care and
24626 in special circumstances. The author of Exim believes that rewriting should be
24627 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24628 Although it can sometimes be used as a routing tool, this is very strongly
24629 discouraged.
24630
24631 There are two commonly encountered circumstances where rewriting is used, as
24632 illustrated by these examples:
24633
24634 .ilist
24635 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24636 exchange mail with each other behind a firewall, but there is only a single
24637 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24638 &'hitch.fict.example'& when sending mail off-site.
24639 .next
24640 A host rewrites the local parts of its own users so that, for example,
24641 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24642 .endlist
24643
24644
24645
24646 .section "When does rewriting happen?" "SECID148"
24647 .cindex "rewriting" "timing of"
24648 .cindex "&ACL;" "rewriting addresses in"
24649 Configured address rewriting can take place at several different stages of a
24650 message's processing.
24651
24652 .vindex "&$sender_address$&"
24653 At the start of an ACL for MAIL, the sender address may have been rewritten
24654 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24655 ordinary rewrite rules have yet been applied. If, however, the sender address
24656 is verified in the ACL, it is rewritten before verification, and remains
24657 rewritten thereafter. The subsequent value of &$sender_address$& is the
24658 rewritten address. This also applies if sender verification happens in a
24659 RCPT ACL. Otherwise, when the sender address is not verified, it is
24660 rewritten as soon as a message's header lines have been received.
24661
24662 .vindex "&$domain$&"
24663 .vindex "&$local_part$&"
24664 Similarly, at the start of an ACL for RCPT, the current recipient's address
24665 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24666 rewrite rules have yet been applied to it. However, the behaviour is different
24667 from the sender address when a recipient is verified. The address is rewritten
24668 for the verification, but the rewriting is not remembered at this stage. The
24669 value of &$local_part$& and &$domain$& after verification are always the same
24670 as they were before (that is, they contain the unrewritten &-- except for
24671 SMTP-time rewriting &-- address).
24672
24673 As soon as a message's header lines have been received, all the envelope
24674 recipient addresses are permanently rewritten, and rewriting is also applied to
24675 the addresses in the header lines (if configured). This happens before adding
24676 any header lines that were specified in MAIL or RCPT ACLs, and
24677 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24678 before the DATA ACL and &[local_scan()]& functions are run.
24679
24680 When an address is being routed, either for delivery or for verification,
24681 rewriting is applied immediately to child addresses that are generated by
24682 redirection, unless &%no_rewrite%& is set on the router.
24683
24684 .cindex "envelope sender" "rewriting at transport time"
24685 .cindex "rewriting" "at transport time"
24686 .cindex "header lines" "rewriting at transport time"
24687 At transport time, additional rewriting of addresses in header lines can be
24688 specified by setting the generic &%headers_rewrite%& option on a transport.
24689 This option contains rules that are identical in form to those in the rewrite
24690 section of the configuration file. They are applied to the original message
24691 header lines and any that were added by ACLs or a system filter. They are not
24692 applied to header lines that are added by routers or the transport.
24693
24694 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24695 transport option. However, it is not possible to rewrite envelope recipients at
24696 transport time.
24697
24698
24699
24700
24701 .section "Testing the rewriting rules that apply on input" "SECID149"
24702 .cindex "rewriting" "testing"
24703 .cindex "testing" "rewriting"
24704 Exim's input rewriting configuration appears in a part of the run time
24705 configuration file headed by &"begin rewrite"&. It can be tested by the
24706 &%-brw%& command line option. This takes an address (which can be a full RFC
24707 2822 address) as its argument. The output is a list of how the address would be
24708 transformed by the rewriting rules for each of the different places it might
24709 appear in an incoming message, that is, for each different header and for the
24710 envelope sender and recipient fields. For example,
24711 .code
24712 exim -brw ph10@exim.workshop.example
24713 .endd
24714 might produce the output
24715 .code
24716 sender: Philip.Hazel@exim.workshop.example
24717 from: Philip.Hazel@exim.workshop.example
24718 to: ph10@exim.workshop.example
24719 cc: ph10@exim.workshop.example
24720 bcc: ph10@exim.workshop.example
24721 reply-to: Philip.Hazel@exim.workshop.example
24722 env-from: Philip.Hazel@exim.workshop.example
24723 env-to: ph10@exim.workshop.example
24724 .endd
24725 which shows that rewriting has been set up for that address when used in any of
24726 the source fields, but not when it appears as a recipient address. At the
24727 present time, there is no equivalent way of testing rewriting rules that are
24728 set for a particular transport.
24729
24730
24731 .section "Rewriting rules" "SECID150"
24732 .cindex "rewriting" "rules"
24733 The rewrite section of the configuration file consists of lines of rewriting
24734 rules in the form
24735 .display
24736 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24737 .endd
24738 Rewriting rules that are specified for the &%headers_rewrite%& generic
24739 transport option are given as a colon-separated list. Each item in the list
24740 takes the same form as a line in the main rewriting configuration (except that
24741 any colons must be doubled, of course).
24742
24743 The formats of source patterns and replacement strings are described below.
24744 Each is terminated by white space, unless enclosed in double quotes, in which
24745 case normal quoting conventions apply inside the quotes. The flags are single
24746 characters which may appear in any order. Spaces and tabs between them are
24747 ignored.
24748
24749 For each address that could potentially be rewritten, the rules are scanned in
24750 order, and replacements for the address from earlier rules can themselves be
24751 replaced by later rules (but see the &"q"& and &"R"& flags).
24752
24753 The order in which addresses are rewritten is undefined, may change between
24754 releases, and must not be relied on, with one exception: when a message is
24755 received, the envelope sender is always rewritten first, before any header
24756 lines are rewritten. For example, the replacement string for a rewrite of an
24757 address in &'To:'& must not assume that the message's address in &'From:'& has
24758 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24759 that the envelope sender has already been rewritten.
24760
24761 .vindex "&$domain$&"
24762 .vindex "&$local_part$&"
24763 The variables &$local_part$& and &$domain$& can be used in the replacement
24764 string to refer to the address that is being rewritten. Note that lookup-driven
24765 rewriting can be done by a rule of the form
24766 .code
24767 *@*   ${lookup ...
24768 .endd
24769 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24770 refer to the address that is being rewritten.
24771
24772
24773 .section "Rewriting patterns" "SECID151"
24774 .cindex "rewriting" "patterns"
24775 .cindex "address list" "in a rewriting pattern"
24776 The source pattern in a rewriting rule is any item which may appear in an
24777 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24778 single-item address list, which means that it is expanded before being tested
24779 against the address. As always, if you use a regular expression as a pattern,
24780 you must take care to escape dollar and backslash characters, or use the &`\N`&
24781 facility to suppress string expansion within the regular expression.
24782
24783 Domains in patterns should be given in lower case. Local parts in patterns are
24784 case-sensitive. If you want to do case-insensitive matching of local parts, you
24785 can use a regular expression that starts with &`^(?i)`&.
24786
24787 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24788 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24789 depending on the type of match which occurred. These can be used in the
24790 replacement string to insert portions of the incoming address. &$0$& always
24791 refers to the complete incoming address. When a regular expression is used, the
24792 numerical variables are set from its capturing subexpressions. For other types
24793 of pattern they are set as follows:
24794
24795 .ilist
24796 If a local part or domain starts with an asterisk, the numerical variables
24797 refer to the character strings matched by asterisks, with &$1$& associated with
24798 the first asterisk, and &$2$& with the second, if present. For example, if the
24799 pattern
24800 .code
24801 *queen@*.fict.example
24802 .endd
24803 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24804 .code
24805 $0 = hearts-queen@wonderland.fict.example
24806 $1 = hearts-
24807 $2 = wonderland
24808 .endd
24809 Note that if the local part does not start with an asterisk, but the domain
24810 does, it is &$1$& that contains the wild part of the domain.
24811
24812 .next
24813 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24814 of the domain are placed in the next available numerical variables. Suppose,
24815 for example, that the address &'foo@bar.baz.example'& is processed by a
24816 rewriting rule of the form
24817 .display
24818 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24819 .endd
24820 and the key in the file that matches the domain is &`*.baz.example`&. Then
24821 .code
24822 $1 = foo
24823 $2 = bar
24824 $3 = baz.example
24825 .endd
24826 If the address &'foo@baz.example'& is looked up, this matches the same
24827 wildcard file entry, and in this case &$2$& is set to the empty string, but
24828 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24829 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24830 whole domain. For non-partial domain lookups, no numerical variables are set.
24831 .endlist
24832
24833
24834 .section "Rewriting replacements" "SECID152"
24835 .cindex "rewriting" "replacements"
24836 If the replacement string for a rule is a single asterisk, addresses that
24837 match the pattern and the flags are &'not'& rewritten, and no subsequent
24838 rewriting rules are scanned. For example,
24839 .code
24840 hatta@lookingglass.fict.example  *  f
24841 .endd
24842 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24843 &'From:'& headers.
24844
24845 .vindex "&$domain$&"
24846 .vindex "&$local_part$&"
24847 If the replacement string is not a single asterisk, it is expanded, and must
24848 yield a fully qualified address. Within the expansion, the variables
24849 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24850 Any letters they contain retain their original case &-- they are not lower
24851 cased. The numerical variables are set up according to the type of pattern that
24852 matched the address, as described above. If the expansion is forced to fail by
24853 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24854 current rule is abandoned, but subsequent rules may take effect. Any other
24855 expansion failure causes the entire rewriting operation to be abandoned, and an
24856 entry written to the panic log.
24857
24858
24859
24860 .section "Rewriting flags" "SECID153"
24861 There are three different kinds of flag that may appear on rewriting rules:
24862
24863 .ilist
24864 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24865 c, f, h, r, s, t.
24866 .next
24867 A flag that specifies rewriting at SMTP time: S.
24868 .next
24869 Flags that control the rewriting process: Q, q, R, w.
24870 .endlist
24871
24872 For rules that are part of the &%headers_rewrite%& generic transport option,
24873 E, F, T, and S are not permitted.
24874
24875
24876
24877 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24878          "SECID154"
24879 .cindex "rewriting" "flags"
24880 If none of the following flag letters, nor the &"S"& flag (see section
24881 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24882 and to both the sender and recipient fields of the envelope, whereas a
24883 transport-time rewriting rule just applies to all headers. Otherwise, the
24884 rewriting rule is skipped unless the relevant addresses are being processed.
24885 .display
24886 &`E`&       rewrite all envelope fields
24887 &`F`&       rewrite the envelope From field
24888 &`T`&       rewrite the envelope To field
24889 &`b`&       rewrite the &'Bcc:'& header
24890 &`c`&       rewrite the &'Cc:'& header
24891 &`f`&       rewrite the &'From:'& header
24892 &`h`&       rewrite all headers
24893 &`r`&       rewrite the &'Reply-To:'& header
24894 &`s`&       rewrite the &'Sender:'& header
24895 &`t`&       rewrite the &'To:'& header
24896 .endd
24897 "All headers" means all of the headers listed above that can be selected
24898 individually, plus their &'Resent-'& versions. It does not include
24899 other headers such as &'Subject:'& etc.
24900
24901 You should be particularly careful about rewriting &'Sender:'& headers, and
24902 restrict this to special known cases in your own domains.
24903
24904
24905 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24906 .cindex "SMTP" "rewriting malformed addresses"
24907 .cindex "RCPT" "rewriting argument of"
24908 .cindex "MAIL" "rewriting argument of"
24909 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24910 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24911 before any other processing; even before syntax checking. The pattern is
24912 required to be a regular expression, and it is matched against the whole of the
24913 data for the command, including any surrounding angle brackets.
24914
24915 .vindex "&$domain$&"
24916 .vindex "&$local_part$&"
24917 This form of rewrite rule allows for the handling of addresses that are not
24918 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24919 input). Because the input is not required to be a syntactically valid address,
24920 the variables &$local_part$& and &$domain$& are not available during the
24921 expansion of the replacement string. The result of rewriting replaces the
24922 original address in the MAIL or RCPT command.
24923
24924
24925 .section "Flags controlling the rewriting process" "SECID155"
24926 There are four flags which control the way the rewriting process works. These
24927 take effect only when a rule is invoked, that is, when the address is of the
24928 correct type (matches the flags) and matches the pattern:
24929
24930 .ilist
24931 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24932 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24933 absence of &"Q"& the rewritten address must always include a domain.
24934 .next
24935 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24936 even if no rewriting actually takes place because of a &"fail"& in the
24937 expansion. The &"q"& flag is not effective if the address is of the wrong type
24938 (does not match the flags) or does not match the pattern.
24939 .next
24940 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24941 address, up to ten times. It can be combined with the &"q"& flag, to stop
24942 rewriting once it fails to match (after at least one successful rewrite).
24943 .next
24944 .cindex "rewriting" "whole addresses"
24945 When an address in a header is rewritten, the rewriting normally applies only
24946 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24947 left unchanged. For example, rewriting might change
24948 .code
24949 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24950 .endd
24951 into
24952 .code
24953 From: Ford Prefect <prefectf@hitch.fict.example>
24954 .endd
24955 .cindex "RFC 2047"
24956 Sometimes there is a need to replace the whole address item, and this can be
24957 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24958 causes an address in a header line to be rewritten, the entire address is
24959 replaced, not just the working part. The replacement must be a complete RFC
24960 2822 address, including the angle brackets if necessary. If text outside angle
24961 brackets contains a character whose value is greater than 126 or less than 32
24962 (except for tab), the text is encoded according to RFC 2047. The character set
24963 is taken from &%headers_charset%&, which gets its default at build time.
24964
24965 When the &"w"& flag is set on a rule that causes an envelope address to be
24966 rewritten, all but the working part of the replacement address is discarded.
24967 .endlist
24968
24969
24970 .section "Rewriting examples" "SECID156"
24971 Here is an example of the two common rewriting paradigms:
24972 .code
24973 *@*.hitch.fict.example  $1@hitch.fict.example
24974 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24975                      {$value}fail}@hitch.fict.example bctfrF
24976 .endd
24977 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24978 the string expansion to fail if the lookup does not succeed. In this context it
24979 has the effect of leaving the original address unchanged, but Exim goes on to
24980 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24981 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24982 explicitly, which would cause the rewritten address to be the same as before,
24983 at the cost of a small bit of processing. Not supplying either of these is an
24984 error, since the rewritten address would then contain no local part.
24985
24986 The first example above replaces the domain with a superior, more general
24987 domain. This may not be desirable for certain local parts. If the rule
24988 .code
24989 root@*.hitch.fict.example  *
24990 .endd
24991 were inserted before the first rule, rewriting would be suppressed for the
24992 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24993
24994 Rewriting can be made conditional on a number of tests, by making use of
24995 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24996 messages that originate outside the local host:
24997 .code
24998 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24999                          {$1@hitch.fict.example}fail}"
25000 .endd
25001 The replacement string is quoted in this example because it contains white
25002 space.
25003
25004 .cindex "rewriting" "bang paths"
25005 .cindex "bang paths" "rewriting"
25006 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25007 an address it treats it as an unqualified local part which it qualifies with
25008 the local qualification domain (if the source of the message is local or if the
25009 remote host is permitted to send unqualified addresses). Rewriting can
25010 sometimes be used to handle simple bang paths with a fixed number of
25011 components. For example, the rule
25012 .code
25013 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25014 .endd
25015 rewrites a two-component bang path &'host.name!user'& as the domain address
25016 &'user@host.name'&. However, there is a security implication in using this as
25017 a global rewriting rule for envelope addresses. It can provide a backdoor
25018 method for using your system as a relay, because the incoming addresses appear
25019 to be local. If the bang path addresses are received via SMTP, it is safer to
25020 use the &"S"& flag to rewrite them as they are received, so that relay checking
25021 can be done on the rewritten addresses.
25022 .ecindex IIDaddrew
25023
25024
25025
25026
25027
25028 . ////////////////////////////////////////////////////////////////////////////
25029 . ////////////////////////////////////////////////////////////////////////////
25030
25031 .chapter "Retry configuration" "CHAPretry"
25032 .scindex IIDretconf1 "retry" "configuration, description of"
25033 .scindex IIDregconf2 "configuration file" "retry section"
25034 The &"retry"& section of the runtime configuration file contains a list of
25035 retry rules that control how often Exim tries to deliver messages that cannot
25036 be delivered at the first attempt. If there are no retry rules (the section is
25037 empty or not present), there are no retries. In this situation, temporary
25038 errors are treated as permanent. The default configuration contains a single,
25039 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25040 line option can be used to test which retry rule will be used for a given
25041 address, domain and error.
25042
25043 The most common cause of retries is temporary failure to deliver to a remote
25044 host because the host is down, or inaccessible because of a network problem.
25045 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25046 address) basis, not on a per-message basis. Thus, if one message has recently
25047 been delayed, delivery of a new message to the same host is not immediately
25048 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25049 log selector is set, the message
25050 .cindex "retry" "time not reached"
25051 &"retry time not reached"& is written to the main log whenever a delivery is
25052 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25053 the handling of errors during remote deliveries.
25054
25055 Retry processing applies to routing as well as to delivering, except as covered
25056 in the next paragraph. The retry rules do not distinguish between these
25057 actions. It is not possible, for example, to specify different behaviour for
25058 failures to route the domain &'snark.fict.example'& and failures to deliver to
25059 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25060 added complication, so did not implement it. However, although they share the
25061 same retry rule, the actual retry times for routing and transporting a given
25062 domain are maintained independently.
25063
25064 When a delivery is not part of a queue run (typically an immediate delivery on
25065 receipt of a message), the routers are always run, and local deliveries are
25066 always attempted, even if retry times are set for them. This makes for better
25067 behaviour if one particular message is causing problems (for example, causing
25068 quota overflow, or provoking an error in a filter file). If such a delivery
25069 suffers a temporary failure, the retry data is updated as normal, and
25070 subsequent delivery attempts from queue runs occur only when the retry time for
25071 the local address is reached.
25072
25073 .section "Changing retry rules" "SECID157"
25074 If you change the retry rules in your configuration, you should consider
25075 whether or not to delete the retry data that is stored in Exim's spool area in
25076 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25077 always safe; that is why they are called &"hints"&.
25078
25079 The hints retry data contains suggested retry times based on the previous
25080 rules. In the case of a long-running problem with a remote host, it might
25081 record the fact that the host has timed out. If your new rules increase the
25082 timeout time for such a host, you should definitely remove the old retry data
25083 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25084 messages that it should now be retaining.
25085
25086
25087
25088 .section "Format of retry rules" "SECID158"
25089 .cindex "retry" "rules"
25090 Each retry rule occupies one line and consists of three or four parts,
25091 separated by white space: a pattern, an error name, an optional list of sender
25092 addresses, and a list of retry parameters. The pattern and sender lists must be
25093 enclosed in double quotes if they contain white space. The rules are searched
25094 in order until one is found where the pattern, error name, and sender list (if
25095 present) match the failing host or address, the error that occurred, and the
25096 message's sender, respectively.
25097
25098
25099 The pattern is any single item that may appear in an address list (see section
25100 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25101 which means that it is expanded before being tested against the address that
25102 has been delayed. A negated address list item is permitted. Address
25103 list processing treats a plain domain name as if it were preceded by &"*@"&,
25104 which makes it possible for many retry rules to start with just a domain. For
25105 example,
25106 .code
25107 lookingglass.fict.example        *  F,24h,30m;
25108 .endd
25109 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25110 whereas
25111 .code
25112 alice@lookingglass.fict.example  *  F,24h,30m;
25113 .endd
25114 applies only to temporary failures involving the local part &%alice%&.
25115 In practice, almost all rules start with a domain name pattern without a local
25116 part.
25117
25118 .cindex "regular expressions" "in retry rules"
25119 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25120 must match a complete address, not just a domain, because that is how regular
25121 expressions work in address lists.
25122 .display
25123 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25124 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25125 .endd
25126
25127
25128 .section "Choosing which retry rule to use for address errors" "SECID159"
25129 When Exim is looking for a retry rule after a routing attempt has failed (for
25130 example, after a DNS timeout), each line in the retry configuration is tested
25131 against the complete address only if &%retry_use_local_part%& is set for the
25132 router. Otherwise, only the domain is used, except when matching against a
25133 regular expression, when the local part of the address is replaced with &"*"&.
25134 A domain on its own can match a domain pattern, or a pattern that starts with
25135 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25136 &%check_local_user%& is true, and false for other routers.
25137
25138 Similarly, when Exim is looking for a retry rule after a local delivery has
25139 failed (for example, after a mailbox full error), each line in the retry
25140 configuration is tested against the complete address only if
25141 &%retry_use_local_part%& is set for the transport (it defaults true for all
25142 local transports).
25143
25144 .cindex "4&'xx'& responses" "retry rules for"
25145 However, when Exim is looking for a retry rule after a remote delivery attempt
25146 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25147 whole address is always used as the key when searching the retry rules. The
25148 rule that is found is used to create a retry time for the combination of the
25149 failing address and the message's sender. It is the combination of sender and
25150 recipient that is delayed in subsequent queue runs until its retry time is
25151 reached. You can delay the recipient without regard to the sender by setting
25152 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25153 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25154 commands.
25155
25156
25157
25158 .section "Choosing which retry rule to use for host and message errors" &&&
25159          "SECID160"
25160 For a temporary error that is not related to an individual address (for
25161 example, a connection timeout), each line in the retry configuration is checked
25162 twice. First, the name of the remote host is used as a domain name (preceded by
25163 &"*@"& when matching a regular expression). If this does not match the line,
25164 the domain from the email address is tried in a similar fashion. For example,
25165 suppose the MX records for &'a.b.c.example'& are
25166 .code
25167 a.b.c.example  MX  5  x.y.z.example
25168                MX  6  p.q.r.example
25169                MX  7  m.n.o.example
25170 .endd
25171 and the retry rules are
25172 .code
25173 p.q.r.example    *      F,24h,30m;
25174 a.b.c.example    *      F,4d,45m;
25175 .endd
25176 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25177 first rule matches neither the host nor the domain, so Exim looks at the second
25178 rule. This does not match the host, but it does match the domain, so it is used
25179 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25180 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25181 first retry rule is used, because it matches the host.
25182
25183 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25184 first rule to determine retry times, but for all the other hosts for the domain
25185 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25186 routing to &'a.b.c.example'& suffers a temporary failure.
25187
25188 &*Note*&: The host name is used when matching the patterns, not its IP address.
25189 However, if a message is routed directly to an IP address without the use of a
25190 host name, for example, if a &(manualroute)& router contains a setting such as:
25191 .code
25192 route_list = *.a.example  192.168.34.23
25193 .endd
25194 then the &"host name"& that is used when searching for a retry rule is the
25195 textual form of the IP address.
25196
25197 .section "Retry rules for specific errors" "SECID161"
25198 .cindex "retry" "specific errors; specifying"
25199 The second field in a retry rule is the name of a particular error, or an
25200 asterisk, which matches any error. The errors that can be tested for are:
25201
25202 .vlist
25203 .vitem &%auth_failed%&
25204 Authentication failed when trying to send to a host in the
25205 &%hosts_require_auth%& list in an &(smtp)& transport.
25206
25207 .vitem &%data_4xx%&
25208 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25209 after the command, or after sending the message's data.
25210
25211 .vitem &%mail_4xx%&
25212 A 4&'xx'& error was received for an outgoing MAIL command.
25213
25214 .vitem &%rcpt_4xx%&
25215 A 4&'xx'& error was received for an outgoing RCPT command.
25216 .endlist
25217
25218 For the three 4&'xx'& errors, either the first or both of the x's can be given
25219 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25220 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25221 and have retries every ten minutes with a one-hour timeout, you could set up a
25222 retry rule of this form:
25223 .code
25224 the.domain.name  rcpt_452   F,1h,10m
25225 .endd
25226 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25227 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25228
25229 .vlist
25230 .vitem &%lost_connection%&
25231 A server unexpectedly closed the SMTP connection. There may, of course,
25232 legitimate reasons for this (host died, network died), but if it repeats a lot
25233 for the same host, it indicates something odd.
25234
25235 .vitem &%lookup%&
25236 A DNS lookup for a host failed.
25237 Note that a &%dnslookup%& router will need to have matched
25238 its &%fail_defer_domains%& option for this retry type to be usable.
25239 Also note that a &%manualroute%& router will probably need
25240 its &%host_find_failed%& option set to &%defer%&.
25241
25242 .vitem &%refused_MX%&
25243 A connection to a host obtained from an MX record was refused.
25244
25245 .vitem &%refused_A%&
25246 A connection to a host not obtained from an MX record was refused.
25247
25248 .vitem &%refused%&
25249 A connection was refused.
25250
25251 .vitem &%timeout_connect_MX%&
25252 A connection attempt to a host obtained from an MX record timed out.
25253
25254 .vitem &%timeout_connect_A%&
25255 A connection attempt to a host not obtained from an MX record timed out.
25256
25257 .vitem &%timeout_connect%&
25258 A connection attempt timed out.
25259
25260 .vitem &%timeout_MX%&
25261 There was a timeout while connecting or during an SMTP session with a host
25262 obtained from an MX record.
25263
25264 .vitem &%timeout_A%&
25265 There was a timeout while connecting or during an SMTP session with a host not
25266 obtained from an MX record.
25267
25268 .vitem &%timeout%&
25269 There was a timeout while connecting or during an SMTP session.
25270
25271 .vitem &%tls_required%&
25272 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25273 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25274 to STARTTLS, or there was a problem setting up the TLS connection.
25275
25276 .vitem &%quota%&
25277 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25278 transport.
25279
25280 .vitem &%quota_%&<&'time'&>
25281 .cindex "quota" "error testing in retry rule"
25282 .cindex "retry" "quota error testing"
25283 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25284 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25285 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25286 for four days.
25287 .endlist
25288
25289 .cindex "mailbox" "time of last read"
25290 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25291 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25292 it should be based on the last time that the user accessed the mailbox.
25293 However, it is not always possible to determine this. Exim uses the following
25294 heuristic rules:
25295
25296 .ilist
25297 If the mailbox is a single file, the time of last access (the &"atime"&) is
25298 used. As no new messages are being delivered (because the mailbox is over
25299 quota), Exim does not access the file, so this is the time of last user access.
25300 .next
25301 .cindex "maildir format" "time of last read"
25302 For a maildir delivery, the time of last modification of the &_new_&
25303 subdirectory is used. As the mailbox is over quota, no new files are created in
25304 the &_new_& subdirectory, because no new messages are being delivered. Any
25305 change to the &_new_& subdirectory is therefore assumed to be the result of an
25306 MUA moving a new message to the &_cur_& directory when it is first read. The
25307 time that is used is therefore the last time that the user read a new message.
25308 .next
25309 For other kinds of multi-file mailbox, the time of last access cannot be
25310 obtained, so a retry rule that uses this type of error field is never matched.
25311 .endlist
25312
25313 The quota errors apply both to system-enforced quotas and to Exim's own quota
25314 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25315 when a local delivery is deferred because a partition is full (the ENOSPC
25316 error).
25317
25318
25319
25320 .section "Retry rules for specified senders" "SECID162"
25321 .cindex "retry" "rules; sender-specific"
25322 You can specify retry rules that apply only when the failing message has a
25323 specific sender. In particular, this can be used to define retry rules that
25324 apply only to bounce messages. The third item in a retry rule can be of this
25325 form:
25326 .display
25327 &`senders=`&<&'address list'&>
25328 .endd
25329 The retry timings themselves are then the fourth item. For example:
25330 .code
25331 *   rcpt_4xx   senders=:   F,1h,30m
25332 .endd
25333 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25334 host. If the address list contains white space, it must be enclosed in quotes.
25335 For example:
25336 .code
25337 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25338 .endd
25339 &*Warning*&: This facility can be unhelpful if it is used for host errors
25340 (which do not depend on the recipient). The reason is that the sender is used
25341 only to match the retry rule. Once the rule has been found for a host error,
25342 its contents are used to set a retry time for the host, and this will apply to
25343 all messages, not just those with specific senders.
25344
25345 When testing retry rules using &%-brt%&, you can supply a sender using the
25346 &%-f%& command line option, like this:
25347 .code
25348 exim -f "" -brt user@dom.ain
25349 .endd
25350 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25351 list is never matched.
25352
25353
25354
25355
25356
25357 .section "Retry parameters" "SECID163"
25358 .cindex "retry" "parameters in rules"
25359 The third (or fourth, if a senders list is present) field in a retry rule is a
25360 sequence of retry parameter sets, separated by semicolons. Each set consists of
25361 .display
25362 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25363 .endd
25364 The letter identifies the algorithm for computing a new retry time; the cutoff
25365 time is the time beyond which this algorithm no longer applies, and the
25366 arguments vary the algorithm's action. The cutoff time is measured from the
25367 time that the first failure for the domain (combined with the local part if
25368 relevant) was detected, not from the time the message was received.
25369
25370 .cindex "retry" "algorithms"
25371 .cindex "retry" "fixed intervals"
25372 .cindex "retry" "increasing intervals"
25373 .cindex "retry" "random intervals"
25374 The available algorithms are:
25375
25376 .ilist
25377 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25378 the interval.
25379 .next
25380 &'G'&: retry at geometrically increasing intervals. The first argument
25381 specifies a starting value for the interval, and the second a multiplier, which
25382 is used to increase the size of the interval at each retry.
25383 .next
25384 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25385 retry, the previous interval is multiplied by the factor in order to get a
25386 maximum for the next interval. The minimum interval is the first argument of
25387 the parameter, and an actual interval is chosen randomly between them. Such a
25388 rule has been found to be helpful in cluster configurations when all the
25389 members of the cluster restart at once, and may therefore synchronize their
25390 queue processing times.
25391 .endlist
25392
25393 When computing the next retry time, the algorithm definitions are scanned in
25394 order until one whose cutoff time has not yet passed is reached. This is then
25395 used to compute a new retry time that is later than the current time. In the
25396 case of fixed interval retries, this simply means adding the interval to the
25397 current time. For geometrically increasing intervals, retry intervals are
25398 computed from the rule's parameters until one that is greater than the previous
25399 interval is found. The main configuration variable
25400 .cindex "limit" "retry interval"
25401 .cindex "retry" "interval, maximum"
25402 .oindex "&%retry_interval_max%&"
25403 &%retry_interval_max%& limits the maximum interval between retries. It
25404 cannot be set greater than &`24h`&, which is its default value.
25405
25406 A single remote domain may have a number of hosts associated with it, and each
25407 host may have more than one IP address. Retry algorithms are selected on the
25408 basis of the domain name, but are applied to each IP address independently. If,
25409 for example, a host has two IP addresses and one is unusable, Exim will
25410 generate retry times for it and will not try to use it until its next retry
25411 time comes. Thus the good IP address is likely to be tried first most of the
25412 time.
25413
25414 .cindex "hints database" "use for retrying"
25415 Retry times are hints rather than promises. Exim does not make any attempt to
25416 run deliveries exactly at the computed times. Instead, a queue runner process
25417 starts delivery processes for delayed messages periodically, and these attempt
25418 new deliveries only for those addresses that have passed their next retry time.
25419 If a new message arrives for a deferred address, an immediate delivery attempt
25420 occurs only if the address has passed its retry time. In the absence of new
25421 messages, the minimum time between retries is the interval between queue runner
25422 processes. There is not much point in setting retry times of five minutes if
25423 your queue runners happen only once an hour, unless there are a significant
25424 number of incoming messages (which might be the case on a system that is
25425 sending everything to a smart host, for example).
25426
25427 The data in the retry hints database can be inspected by using the
25428 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25429 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25430 &'exinext'& utility script can be used to find out what the next retry times
25431 are for the hosts associated with a particular mail domain, and also for local
25432 deliveries that have been deferred.
25433
25434
25435 .section "Retry rule examples" "SECID164"
25436 Here are some example retry rules:
25437 .code
25438 alice@wonderland.fict.example quota_5d  F,7d,3h
25439 wonderland.fict.example       quota_5d
25440 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25441 lookingglass.fict.example     *         F,24h,30m;
25442 *                 refused_A   F,2h,20m;
25443 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25444 .endd
25445 The first rule sets up special handling for mail to
25446 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25447 mailbox has not been read for at least 5 days. Retries continue every three
25448 hours for 7 days. The second rule handles over-quota errors for all other local
25449 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25450 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25451 fail are bounced immediately if the mailbox has not been read for at least 5
25452 days.
25453
25454 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25455 happen every 15 minutes for an hour, then with geometrically increasing
25456 intervals until two days have passed since a delivery first failed. After the
25457 first hour there is a delay of one hour, then two hours, then four hours, and
25458 so on (this is a rather extreme example).
25459
25460 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25461 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25462 all other domains, with special action for connection refusal from hosts that
25463 were not obtained from an MX record.
25464
25465 The final rule in a retry configuration should always have asterisks in the
25466 first two fields so as to provide a general catch-all for any addresses that do
25467 not have their own special handling. This example tries every 15 minutes for 2
25468 hours, then with intervals starting at one hour and increasing by a factor of
25469 1.5 up to 16 hours, then every 8 hours up to 5 days.
25470
25471
25472
25473 .section "Timeout of retry data" "SECID165"
25474 .cindex "timeout" "of retry data"
25475 .oindex "&%retry_data_expire%&"
25476 .cindex "hints database" "data expiry"
25477 .cindex "retry" "timeout of data"
25478 Exim timestamps the data that it writes to its retry hints database. When it
25479 consults the data during a delivery it ignores any that is older than the value
25480 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25481 been tried for 7 days, Exim will try to deliver to it immediately a message
25482 arrives, and if that fails, it will calculate a retry time as if it were
25483 failing for the first time.
25484
25485 This improves the behaviour for messages routed to rarely-used hosts such as MX
25486 backups. If such a host was down at one time, and happens to be down again when
25487 Exim tries a month later, using the old retry data would imply that it had been
25488 down all the time, which is not a justified assumption.
25489
25490 If a host really is permanently dead, this behaviour causes a burst of retries
25491 every now and again, but only if messages routed to it are rare. If there is a
25492 message at least once every 7 days the retry data never expires.
25493
25494
25495
25496
25497 .section "Long-term failures" "SECID166"
25498 .cindex "delivery failure, long-term"
25499 .cindex "retry" "after long-term failure"
25500 Special processing happens when an email address has been failing for so long
25501 that the cutoff time for the last algorithm is reached. For example, using the
25502 default retry rule:
25503 .code
25504 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25505 .endd
25506 the cutoff time is four days. Reaching the retry cutoff is independent of how
25507 long any specific message has been failing; it is the length of continuous
25508 failure for the recipient address that counts.
25509
25510 When the cutoff time is reached for a local delivery, or for all the IP
25511 addresses associated with a remote delivery, a subsequent delivery failure
25512 causes Exim to give up on the address, and a bounce message is generated.
25513 In order to cater for new messages that use the failing address, a next retry
25514 time is still computed from the final algorithm, and is used as follows:
25515
25516 For local deliveries, one delivery attempt is always made for any subsequent
25517 messages. If this delivery fails, the address fails immediately. The
25518 post-cutoff retry time is not used.
25519
25520 If the delivery is remote, there are two possibilities, controlled by the
25521 .oindex "&%delay_after_cutoff%&"
25522 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25523 default. Until the post-cutoff retry time for one of the IP addresses is
25524 reached, the failing email address is bounced immediately, without a delivery
25525 attempt taking place. After that time, one new delivery attempt is made to
25526 those IP addresses that are past their retry times, and if that still fails,
25527 the address is bounced and new retry times are computed.
25528
25529 In other words, when all the hosts for a given email address have been failing
25530 for a long time, Exim bounces rather then defers until one of the hosts' retry
25531 times is reached. Then it tries once, and bounces if that attempt fails. This
25532 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25533 to a broken destination, but if the host does recover, Exim will eventually
25534 notice.
25535
25536 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25537 addresses are past their final cutoff time, Exim tries to deliver to those IP
25538 addresses that have not been tried since the message arrived. If there are
25539 no suitable IP addresses, or if they all fail, the address is bounced. In other
25540 words, it does not delay when a new message arrives, but tries the expired
25541 addresses immediately, unless they have been tried since the message arrived.
25542 If there is a continuous stream of messages for the failing domains, setting
25543 &%delay_after_cutoff%& false means that there will be many more attempts to
25544 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25545 true.
25546
25547 .section "Deliveries that work intermittently" "SECID167"
25548 .cindex "retry" "intermittently working deliveries"
25549 Some additional logic is needed to cope with cases where a host is
25550 intermittently available, or when a message has some attribute that prevents
25551 its delivery when others to the same address get through. In this situation,
25552 because some messages are successfully delivered, the &"retry clock"& for the
25553 host or address keeps getting reset by the successful deliveries, and so
25554 failing messages remain on the queue for ever because the cutoff time is never
25555 reached.
25556
25557 Two exceptional actions are applied to prevent this happening. The first
25558 applies to errors that are related to a message rather than a remote host.
25559 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25560 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25561 commands, and quota failures. For this type of error, if a message's arrival
25562 time is earlier than the &"first failed"& time for the error, the earlier time
25563 is used when scanning the retry rules to decide when to try next and when to
25564 time out the address.
25565
25566 The exceptional second action applies in all cases. If a message has been on
25567 the queue for longer than the cutoff time of any applicable retry rule for a
25568 given address, a delivery is attempted for that address, even if it is not yet
25569 time, and if this delivery fails, the address is timed out. A new retry time is
25570 not computed in this case, so that other messages for the same address are
25571 considered immediately.
25572 .ecindex IIDretconf1
25573 .ecindex IIDregconf2
25574
25575
25576
25577
25578
25579
25580 . ////////////////////////////////////////////////////////////////////////////
25581 . ////////////////////////////////////////////////////////////////////////////
25582
25583 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25584 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25585 .scindex IIDauthconf2 "authentication"
25586 The &"authenticators"& section of Exim's run time configuration is concerned
25587 with SMTP authentication. This facility is an extension to the SMTP protocol,
25588 described in RFC 2554, which allows a client SMTP host to authenticate itself
25589 to a server. This is a common way for a server to recognize clients that are
25590 permitted to use it as a relay. SMTP authentication is not of relevance to the
25591 transfer of mail between servers that have no managerial connection with each
25592 other.
25593
25594 .cindex "AUTH" "description of"
25595 Very briefly, the way SMTP authentication works is as follows:
25596
25597 .ilist
25598 The server advertises a number of authentication &'mechanisms'& in response to
25599 the client's EHLO command.
25600 .next
25601 The client issues an AUTH command, naming a specific mechanism. The command
25602 may, optionally, contain some authentication data.
25603 .next
25604 The server may issue one or more &'challenges'&, to which the client must send
25605 appropriate responses. In simple authentication mechanisms, the challenges are
25606 just prompts for user names and passwords. The server does not have to issue
25607 any challenges &-- in some mechanisms the relevant data may all be transmitted
25608 with the AUTH command.
25609 .next
25610 The server either accepts or denies authentication.
25611 .next
25612 If authentication succeeds, the client may optionally make use of the AUTH
25613 option on the MAIL command to pass an authenticated sender in subsequent
25614 mail transactions. Authentication lasts for the remainder of the SMTP
25615 connection.
25616 .next
25617 If authentication fails, the client may give up, or it may try a different
25618 authentication mechanism, or it may try transferring mail over the
25619 unauthenticated connection.
25620 .endlist
25621
25622 If you are setting up a client, and want to know which authentication
25623 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25624 SMTP port) on the server, and issue an EHLO command. The response to this
25625 includes the list of supported mechanisms. For example:
25626 .display
25627 &`$ `&&*&`telnet server.example 25`&*&
25628 &`Trying 192.168.34.25...`&
25629 &`Connected to server.example.`&
25630 &`Escape character is &#x0027;^]&#x0027;.`&
25631 &`220 server.example ESMTP Exim 4.20 ...`&
25632 &*&`ehlo client.example`&*&
25633 &`250-server.example Hello client.example [10.8.4.5]`&
25634 &`250-SIZE 52428800`&
25635 &`250-PIPELINING`&
25636 &`250-AUTH PLAIN`&
25637 &`250 HELP`&
25638 .endd
25639 The second-last line of this example output shows that the server supports
25640 authentication using the PLAIN mechanism. In Exim, the different authentication
25641 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25642 routers and transports, which authenticators are included in the binary is
25643 controlled by build-time definitions. The following are currently available,
25644 included by setting
25645 .code
25646 AUTH_CRAM_MD5=yes
25647 AUTH_CYRUS_SASL=yes
25648 AUTH_DOVECOT=yes
25649 AUTH_GSASL=yes
25650 AUTH_HEIMDAL_GSSAPI=yes
25651 AUTH_PLAINTEXT=yes
25652 AUTH_SPA=yes
25653 AUTH_TLS=yes
25654 .endd
25655 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25656 authentication mechanism (RFC 2195), and the second provides an interface to
25657 the Cyrus SASL authentication library.
25658 The third is an interface to Dovecot's authentication system, delegating the
25659 work via a socket interface.
25660 The fourth provides an interface to the GNU SASL authentication library, which
25661 provides mechanisms but typically not data sources.
25662 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25663 supporting setting a server keytab.
25664 The sixth can be configured to support
25665 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25666 not formally documented, but used by several MUAs. The seventh authenticator
25667 supports Microsoft's &'Secure Password Authentication'& mechanism.
25668 The eighth is an Exim authenticator but not an SMTP one;
25669 instead it can use information from a TLS negotiation.
25670
25671 The authenticators are configured using the same syntax as other drivers (see
25672 section &<<SECTfordricon>>&). If no authenticators are required, no
25673 authentication section need be present in the configuration file. Each
25674 authenticator can in principle have both server and client functions. When Exim
25675 is receiving SMTP mail, it is acting as a server; when it is sending out
25676 messages over SMTP, it is acting as a client. Authenticator configuration
25677 options are provided for use in both these circumstances.
25678
25679 To make it clear which options apply to which situation, the prefixes
25680 &%server_%& and &%client_%& are used on option names that are specific to
25681 either the server or the client function, respectively. Server and client
25682 functions are disabled if none of their options are set. If an authenticator is
25683 to be used for both server and client functions, a single definition, using
25684 both sets of options, is required. For example:
25685 .code
25686 cram:
25687   driver = cram_md5
25688   public_name = CRAM-MD5
25689   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25690   client_name = ph10
25691   client_secret = secret2
25692 .endd
25693 The &%server_%& option is used when Exim is acting as a server, and the
25694 &%client_%& options when it is acting as a client.
25695
25696 Descriptions of the individual authenticators are given in subsequent chapters.
25697 The remainder of this chapter covers the generic options for the
25698 authenticators, followed by general discussion of the way authentication works
25699 in Exim.
25700
25701 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25702 per-mechanism basis.  Please read carefully to determine which variables hold
25703 account labels such as usercodes and which hold passwords or other
25704 authenticating data.
25705
25706 Note that some mechanisms support two different identifiers for accounts: the
25707 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25708 and &'authz'& are commonly encountered.  The American spelling is standard here.
25709 Conceptually, authentication data such as passwords are tied to the identifier
25710 used to authenticate; servers may have rules to permit one user to act as a
25711 second user, so that after login the session is treated as though that second
25712 user had logged in.  That second user is the &'authorization id'&.  A robust
25713 configuration might confirm that the &'authz'& field is empty or matches the
25714 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25715 as verified data, the &'authz'& as an unverified request which the server might
25716 choose to honour.
25717
25718 A &'realm'& is a text string, typically a domain name, presented by a server
25719 to a client to help it select an account and credentials to use.  In some
25720 mechanisms, the client and server provably agree on the realm, but clients
25721 typically can not treat the realm as secure data to be blindly trusted.
25722
25723
25724
25725 .section "Generic options for authenticators" "SECID168"
25726 .cindex "authentication" "generic options"
25727 .cindex "options" "generic; for authenticators"
25728
25729 .option client_condition authenticators string&!! unset
25730 When Exim is authenticating as a client, it skips any authenticator whose
25731 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25732 used, for example, to skip plain text authenticators when the connection is not
25733 encrypted by a setting such as:
25734 .code
25735 client_condition = ${if !eq{$tls_out_cipher}{}}
25736 .endd
25737
25738
25739 .option client_set_id authenticators string&!! unset
25740 When client authentication succeeds, this condition is expanded; the
25741 result is used in the log lines for outbound messages.
25742 Typically it will be the user name used for authentication.
25743
25744
25745 .option driver authenticators string unset
25746 This option must always be set. It specifies which of the available
25747 authenticators is to be used.
25748
25749
25750 .option public_name authenticators string unset
25751 This option specifies the name of the authentication mechanism that the driver
25752 implements, and by which it is known to the outside world. These names should
25753 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25754 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25755 defaults to the driver's instance name.
25756
25757
25758 .option server_advertise_condition authenticators string&!! unset
25759 When a server is about to advertise an authentication mechanism, the condition
25760 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25761 mechanism is not advertised.
25762 If the expansion fails, the mechanism is not advertised. If the failure was not
25763 forced, and was not caused by a lookup defer, the incident is logged.
25764 See section &<<SECTauthexiser>>& below for further discussion.
25765
25766
25767 .option server_condition authenticators string&!! unset
25768 This option must be set for a &%plaintext%& server authenticator, where it
25769 is used directly to control authentication. See section &<<SECTplainserver>>&
25770 for details.
25771
25772 For the &(gsasl)& authenticator, this option is required for various
25773 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25774
25775 For the other authenticators, &%server_condition%& can be used as an additional
25776 authentication or authorization mechanism that is applied after the other
25777 authenticator conditions succeed. If it is set, it is expanded when the
25778 authenticator would otherwise return a success code. If the expansion is forced
25779 to fail, authentication fails. Any other expansion failure causes a temporary
25780 error code to be returned. If the result of a successful expansion is an empty
25781 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25782 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25783 other result, a temporary error code is returned, with the expanded string as
25784 the error text.
25785
25786
25787 .option server_debug_print authenticators string&!! unset
25788 If this option is set and authentication debugging is enabled (see the &%-d%&
25789 command line option), the string is expanded and included in the debugging
25790 output when the authenticator is run as a server. This can help with checking
25791 out the values of variables.
25792 If expansion of the string fails, the error message is written to the debugging
25793 output, and Exim carries on processing.
25794
25795
25796 .option server_set_id authenticators string&!! unset
25797 .vindex "&$authenticated_id$&"
25798 When an Exim server successfully authenticates a client, this string is
25799 expanded using data from the authentication, and preserved for any incoming
25800 messages in the variable &$authenticated_id$&. It is also included in the log
25801 lines for incoming messages. For example, a user/password authenticator
25802 configuration might preserve the user name that was used to authenticate, and
25803 refer to it subsequently during delivery of the message.
25804 If expansion fails, the option is ignored.
25805
25806
25807 .option server_mail_auth_condition authenticators string&!! unset
25808 This option allows a server to discard authenticated sender addresses supplied
25809 as part of MAIL commands in SMTP connections that are authenticated by the
25810 driver on which &%server_mail_auth_condition%& is set. The option is not used
25811 as part of the authentication process; instead its (unexpanded) value is
25812 remembered for later use.
25813 How it is used is described in the following section.
25814
25815
25816
25817
25818
25819 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25820 .cindex "authentication" "sender; authenticated"
25821 .cindex "AUTH" "on MAIL command"
25822 When a client supplied an AUTH= item on a MAIL command, Exim applies
25823 the following checks before accepting it as the authenticated sender of the
25824 message:
25825
25826 .ilist
25827 If the connection is not using extended SMTP (that is, HELO was used rather
25828 than EHLO), the use of AUTH= is a syntax error.
25829 .next
25830 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25831 .next
25832 .vindex "&$authenticated_sender$&"
25833 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25834 running, the value of &$authenticated_sender$& is set to the value obtained
25835 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25836 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25837 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25838 given for the MAIL command.
25839 .next
25840 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25841 is accepted and placed in &$authenticated_sender$& only if the client has
25842 authenticated.
25843 .next
25844 If the AUTH= value was accepted by either of the two previous rules, and
25845 the client has authenticated, and the authenticator has a setting for the
25846 &%server_mail_auth_condition%&, the condition is checked at this point. The
25847 valued that was saved from the authenticator is expanded. If the expansion
25848 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25849 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25850 the value of &$authenticated_sender$& is retained and passed on with the
25851 message.
25852 .endlist
25853
25854
25855 When &$authenticated_sender$& is set for a message, it is passed on to other
25856 hosts to which Exim authenticates as a client. Do not confuse this value with
25857 &$authenticated_id$&, which is a string obtained from the authentication
25858 process, and which is not usually a complete email address.
25859
25860 .vindex "&$sender_address$&"
25861 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25862 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25863 therefore make use of &$authenticated_sender$&. The converse is not true: the
25864 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25865 ACL is run.
25866
25867
25868
25869 .section "Authentication on an Exim server" "SECTauthexiser"
25870 .cindex "authentication" "on an Exim server"
25871 When Exim receives an EHLO command, it advertises the public names of those
25872 authenticators that are configured as servers, subject to the following
25873 conditions:
25874
25875 .ilist
25876 The client host must match &%auth_advertise_hosts%& (default *).
25877 .next
25878 It the &%server_advertise_condition%& option is set, its expansion must not
25879 yield the empty string, &"0"&, &"no"&, or &"false"&.
25880 .endlist
25881
25882 The order in which the authenticators are defined controls the order in which
25883 the mechanisms are advertised.
25884
25885 Some mail clients (for example, some versions of Netscape) require the user to
25886 provide a name and password for authentication whenever AUTH is advertised,
25887 even though authentication may not in fact be needed (for example, Exim may be
25888 set up to allow unconditional relaying from the client by an IP address check).
25889 You can make such clients more friendly by not advertising AUTH to them.
25890 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25891 that runs for RCPT) to relay without authentication, you should set
25892 .code
25893 auth_advertise_hosts = ! 10.9.8.0/24
25894 .endd
25895 so that no authentication mechanisms are advertised to them.
25896
25897 The &%server_advertise_condition%& controls the advertisement of individual
25898 authentication mechanisms. For example, it can be used to restrict the
25899 advertisement of a particular mechanism to encrypted connections, by a setting
25900 such as:
25901 .code
25902 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25903 .endd
25904 .vindex "&$tls_in_cipher$&"
25905 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25906 yields &"yes"&, which allows the advertisement to happen.
25907
25908 When an Exim server receives an AUTH command from a client, it rejects it
25909 immediately if AUTH was not advertised in response to an earlier EHLO
25910 command. This is the case if
25911
25912 .ilist
25913 The client host does not match &%auth_advertise_hosts%&; or
25914 .next
25915 No authenticators are configured with server options; or
25916 .next
25917 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25918 server authenticators.
25919 .endlist
25920
25921
25922 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25923 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25924 AUTH is accepted from any client host.
25925
25926 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25927 server authentication mechanism that was advertised in response to EHLO and
25928 that matches the one named in the AUTH command. If it finds one, it runs
25929 the appropriate authentication protocol, and authentication either succeeds or
25930 fails. If there is no matching advertised mechanism, the AUTH command is
25931 rejected with a 504 error.
25932
25933 .vindex "&$received_protocol$&"
25934 .vindex "&$sender_host_authenticated$&"
25935 When a message is received from an authenticated host, the value of
25936 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25937 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25938 public name) of the authenticator driver that successfully authenticated the
25939 client from which the message was received. This variable is empty if there was
25940 no successful authentication.
25941
25942
25943
25944
25945 .section "Testing server authentication" "SECID169"
25946 .cindex "authentication" "testing a server"
25947 .cindex "AUTH" "testing a server"
25948 .cindex "base64 encoding" "creating authentication test data"
25949 Exim's &%-bh%& option can be useful for testing server authentication
25950 configurations. The data for the AUTH command has to be sent using base64
25951 encoding. A quick way to produce such data for testing is the following Perl
25952 script:
25953 .code
25954 use MIME::Base64;
25955 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25956 .endd
25957 .cindex "binary zero" "in authentication data"
25958 This interprets its argument as a Perl string, and then encodes it. The
25959 interpretation as a Perl string allows binary zeros, which are required for
25960 some kinds of authentication, to be included in the data. For example, a
25961 command line to run this script on such data might be
25962 .code
25963 encode '\0user\0password'
25964 .endd
25965 Note the use of single quotes to prevent the shell interpreting the
25966 backslashes, so that they can be interpreted by Perl to specify characters
25967 whose code value is zero.
25968
25969 &*Warning 1*&: If either of the user or password strings starts with an octal
25970 digit, you must use three zeros instead of one after the leading backslash. If
25971 you do not, the octal digit that starts your string will be incorrectly
25972 interpreted as part of the code for the first character.
25973
25974 &*Warning 2*&: If there are characters in the strings that Perl interprets
25975 specially, you must use a Perl escape to prevent them being misinterpreted. For
25976 example, a command such as
25977 .code
25978 encode '\0user@domain.com\0pas$$word'
25979 .endd
25980 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25981
25982 If you have the &%mimencode%& command installed, another way to do produce
25983 base64-encoded strings is to run the command
25984 .code
25985 echo -e -n `\0user\0password' | mimencode
25986 .endd
25987 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25988 in the argument, and the &%-n%& option specifies no newline at the end of its
25989 output. However, not all versions of &%echo%& recognize these options, so you
25990 should check your version before relying on this suggestion.
25991
25992
25993
25994 .section "Authentication by an Exim client" "SECID170"
25995 .cindex "authentication" "on an Exim client"
25996 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25997 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25998 announces support for authentication, and the host matches an entry in either
25999 of these options, Exim (as a client) tries to authenticate as follows:
26000
26001 .ilist
26002 For each authenticator that is configured as a client, in the order in which
26003 they are defined in the configuration, it searches the authentication
26004 mechanisms announced by the server for one whose name matches the public name
26005 of the authenticator.
26006 .next
26007 .vindex "&$host$&"
26008 .vindex "&$host_address$&"
26009 When it finds one that matches, it runs the authenticator's client code. The
26010 variables &$host$& and &$host_address$& are available for any string expansions
26011 that the client might do. They are set to the server's name and IP address. If
26012 any expansion is forced to fail, the authentication attempt is abandoned, and
26013 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26014 delivery to be deferred.
26015 .next
26016 If the result of the authentication attempt is a temporary error or a timeout,
26017 Exim abandons trying to send the message to the host for the moment. It will
26018 try again later. If there are any backup hosts available, they are tried in the
26019 usual way.
26020 .next
26021 If the response to authentication is a permanent error (5&'xx'& code), Exim
26022 carries on searching the list of authenticators and tries another one if
26023 possible. If all authentication attempts give permanent errors, or if there are
26024 no attempts because no mechanisms match (or option expansions force failure),
26025 what happens depends on whether the host matches &%hosts_require_auth%& or
26026 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26027 delivery is deferred. The error can be detected in the retry rules, and thereby
26028 turned into a permanent error if you wish. In the second case, Exim tries to
26029 deliver the message unauthenticated.
26030 .endlist
26031
26032 Note that the hostlist test for whether to do authentication can be
26033 confused if name-IP lookups change between the time the peer is decided
26034 on and the transport running.  For example, with a manualroute
26035 router given a host name, and DNS "round-robin" use by that name: if
26036 the local resolver cache times out between the router and the transport
26037 running, the transport may get an IP for the name for its authentication
26038 check which does not match the connection peer IP.
26039 No authentication will then be done, despite the names being identical.
26040
26041 For such cases use a separate transport which always authenticates.
26042
26043 .cindex "AUTH" "on MAIL command"
26044 When Exim has authenticated itself to a remote server, it adds the AUTH
26045 parameter to the MAIL commands it sends, if it has an authenticated sender for
26046 the message. If the message came from a remote host, the authenticated sender
26047 is the one that was receiving on an incoming MAIL command, provided that the
26048 incoming connection was authenticated and the &%server_mail_auth%& condition
26049 allowed the authenticated sender to be retained. If a local process calls Exim
26050 to send a message, the sender address that is built from the login name and
26051 &%qualify_domain%& is treated as authenticated. However, if the
26052 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26053 the authenticated sender that was received with the message.
26054 .ecindex IIDauthconf1
26055 .ecindex IIDauthconf2
26056
26057
26058
26059
26060
26061
26062 . ////////////////////////////////////////////////////////////////////////////
26063 . ////////////////////////////////////////////////////////////////////////////
26064
26065 .chapter "The plaintext authenticator" "CHAPplaintext"
26066 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26067 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26068 The &(plaintext)& authenticator can be configured to support the PLAIN and
26069 LOGIN authentication mechanisms, both of which transfer authentication data as
26070 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26071 security risk; you are strongly advised to insist on the use of SMTP encryption
26072 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26073 use unencrypted plain text, you should not use the same passwords for SMTP
26074 connections as you do for login accounts.
26075
26076 .section "Plaintext options" "SECID171"
26077 .cindex "options" "&(plaintext)& authenticator (server)"
26078 When configured as a server, &(plaintext)& uses the following options:
26079
26080 .option server_condition authenticators string&!! unset
26081 This is actually a global authentication option, but it must be set in order to
26082 configure the &(plaintext)& driver as a server. Its use is described below.
26083
26084 .option server_prompts plaintext string&!! unset
26085 The contents of this option, after expansion, must be a colon-separated list of
26086 prompt strings. If expansion fails, a temporary authentication rejection is
26087 given.
26088
26089 .section "Using plaintext in a server" "SECTplainserver"
26090 .cindex "AUTH" "in &(plaintext)& authenticator"
26091 .cindex "binary zero" "in &(plaintext)& authenticator"
26092 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26093         "in &(plaintext)& authenticator"
26094 .vindex "&$auth1$&, &$auth2$&, etc"
26095 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26096
26097 When running as a server, &(plaintext)& performs the authentication test by
26098 expanding a string. The data sent by the client with the AUTH command, or in
26099 response to subsequent prompts, is base64 encoded, and so may contain any byte
26100 values when decoded. If any data is supplied with the command, it is treated as
26101 a list of strings, separated by NULs (binary zeros), the first three of which
26102 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26103 (neither LOGIN nor PLAIN uses more than three strings).
26104
26105 For compatibility with previous releases of Exim, the values are also placed in
26106 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26107 variables for this purpose is now deprecated, as it can lead to confusion in
26108 string expansions that also use them for other things.
26109
26110 If there are more strings in &%server_prompts%& than the number of strings
26111 supplied with the AUTH command, the remaining prompts are used to obtain more
26112 data. Each response from the client may be a list of NUL-separated strings.
26113
26114 .vindex "&$authenticated_id$&"
26115 Once a sufficient number of data strings have been received,
26116 &%server_condition%& is expanded. If the expansion is forced to fail,
26117 authentication fails. Any other expansion failure causes a temporary error code
26118 to be returned. If the result of a successful expansion is an empty string,
26119 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26120 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26121 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26122 For any other result, a temporary error code is returned, with the expanded
26123 string as the error text
26124
26125 &*Warning*&: If you use a lookup in the expansion to find the user's
26126 password, be sure to make the authentication fail if the user is unknown.
26127 There are good and bad examples at the end of the next section.
26128
26129
26130
26131 .section "The PLAIN authentication mechanism" "SECID172"
26132 .cindex "PLAIN authentication mechanism"
26133 .cindex "authentication" "PLAIN mechanism"
26134 .cindex "binary zero" "in &(plaintext)& authenticator"
26135 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26136 sent as one item of data (that is, one combined string containing two NUL
26137 separators). The data is sent either as part of the AUTH command, or
26138 subsequently in response to an empty prompt from the server.
26139
26140 The second and third strings are a user name and a corresponding password.
26141 Using a single fixed user name and password as an example, this could be
26142 configured as follows:
26143 .code
26144 fixed_plain:
26145   driver = plaintext
26146   public_name = PLAIN
26147   server_prompts = :
26148   server_condition = \
26149     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26150   server_set_id = $auth2
26151 .endd
26152 Note that the default result strings from &%if%& (&"true"& or an empty string)
26153 are exactly what we want here, so they need not be specified. Obviously, if the
26154 password contains expansion-significant characters such as dollar, backslash,
26155 or closing brace, they have to be escaped.
26156
26157 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26158 the end of a string list are ignored). If all the data comes as part of the
26159 AUTH command, as is commonly the case, the prompt is not used. This
26160 authenticator is advertised in the response to EHLO as
26161 .code
26162 250-AUTH PLAIN
26163 .endd
26164 and a client host can authenticate itself by sending the command
26165 .code
26166 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26167 .endd
26168 As this contains three strings (more than the number of prompts), no further
26169 data is required from the client. Alternatively, the client may just send
26170 .code
26171 AUTH PLAIN
26172 .endd
26173 to initiate authentication, in which case the server replies with an empty
26174 prompt. The client must respond with the combined data string.
26175
26176 The data string is base64 encoded, as required by the RFC. This example,
26177 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26178 represents a zero byte. This is split up into three strings, the first of which
26179 is empty. The &%server_condition%& option in the authenticator checks that the
26180 second two are &`username`& and &`mysecret`& respectively.
26181
26182 Having just one fixed user name and password, as in this example, is not very
26183 realistic, though for a small organization with only a handful of
26184 authenticating clients it could make sense.
26185
26186 A more sophisticated instance of this authenticator could use the user name in
26187 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26188 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26189 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26190 This is an incorrect example:
26191 .code
26192 server_condition = \
26193   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26194 .endd
26195 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26196 which it then compares to the supplied password (&$auth3$&). Why is this example
26197 incorrect? It works fine for existing users, but consider what happens if a
26198 non-existent user name is given. The lookup fails, but as no success/failure
26199 strings are given for the lookup, it yields an empty string. Thus, to defeat
26200 the authentication, all a client has to do is to supply a non-existent user
26201 name and an empty password. The correct way of writing this test is:
26202 .code
26203 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26204   {${if eq{$value}{$auth3}}} {false}}
26205 .endd
26206 In this case, if the lookup succeeds, the result is checked; if the lookup
26207 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26208 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26209 always fails if its second argument is empty. However, the second way of
26210 writing the test makes the logic clearer.
26211
26212
26213 .section "The LOGIN authentication mechanism" "SECID173"
26214 .cindex "LOGIN authentication mechanism"
26215 .cindex "authentication" "LOGIN mechanism"
26216 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26217 in a number of programs. No data is sent with the AUTH command. Instead, a
26218 user name and password are supplied separately, in response to prompts. The
26219 plaintext authenticator can be configured to support this as in this example:
26220 .code
26221 fixed_login:
26222   driver = plaintext
26223   public_name = LOGIN
26224   server_prompts = User Name : Password
26225   server_condition = \
26226     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26227   server_set_id = $auth1
26228 .endd
26229 Because of the way plaintext operates, this authenticator accepts data supplied
26230 with the AUTH command (in contravention of the specification of LOGIN), but
26231 if the client does not supply it (as is the case for LOGIN clients), the prompt
26232 strings are used to obtain two data items.
26233
26234 Some clients are very particular about the precise text of the prompts. For
26235 example, Outlook Express is reported to recognize only &"Username:"& and
26236 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26237 strings. It uses the &%ldapauth%& expansion condition to check the user
26238 name and password by binding to an LDAP server:
26239 .code
26240 login:
26241   driver = plaintext
26242   public_name = LOGIN
26243   server_prompts = Username:: : Password::
26244   server_condition = ${if and{{ \
26245     !eq{}{$auth1} }{ \
26246     ldapauth{\
26247       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26248       pass=${quote:$auth2} \
26249       ldap://ldap.example.org/} }} }
26250   server_set_id = uid=$auth1,ou=people,o=example.org
26251 .endd
26252 We have to check that the username is not empty before using it, because LDAP
26253 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26254 operator to correctly quote the DN for authentication. However, the basic
26255 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26256 correct one to use for the password, because quoting is needed only to make
26257 the password conform to the Exim syntax. At the LDAP level, the password is an
26258 uninterpreted string.
26259
26260
26261 .section "Support for different kinds of authentication" "SECID174"
26262 A number of string expansion features are provided for the purpose of
26263 interfacing to different ways of user authentication. These include checking
26264 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26265 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26266 &<<SECTexpcond>>&.
26267
26268
26269
26270
26271 .section "Using plaintext in a client" "SECID175"
26272 .cindex "options" "&(plaintext)& authenticator (client)"
26273 The &(plaintext)& authenticator has two client options:
26274
26275 .option client_ignore_invalid_base64 plaintext boolean false
26276 If the client receives a server prompt that is not a valid base64 string,
26277 authentication is abandoned by default. However, if this option is set true,
26278 the error in the challenge is ignored and the client sends the response as
26279 usual.
26280
26281 .option client_send plaintext string&!! unset
26282 The string is a colon-separated list of authentication data strings. Each
26283 string is independently expanded before being sent to the server. The first
26284 string is sent with the AUTH command; any more strings are sent in response
26285 to prompts from the server. Before each string is expanded, the value of the
26286 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26287 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26288 way. Thus, the prompt that is received in response to sending the first string
26289 (with the AUTH command) can be used in the expansion of the second string, and
26290 so on. If an invalid base64 string is received when
26291 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26292 &$auth$&<&'n'&> variable.
26293
26294 &*Note*&: You cannot use expansion to create multiple strings, because
26295 splitting takes priority and happens first.
26296
26297 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26298 the data, further processing is applied to each string before it is sent. If
26299 there are any single circumflex characters in the string, they are converted to
26300 NULs. Should an actual circumflex be required as data, it must be doubled in
26301 the string.
26302
26303 This is an example of a client configuration that implements the PLAIN
26304 authentication mechanism with a fixed user name and password:
26305 .code
26306 fixed_plain:
26307   driver = plaintext
26308   public_name = PLAIN
26309   client_send = ^username^mysecret
26310 .endd
26311 The lack of colons means that the entire text is sent with the AUTH
26312 command, with the circumflex characters converted to NULs. A similar example
26313 that uses the LOGIN mechanism is:
26314 .code
26315 fixed_login:
26316   driver = plaintext
26317   public_name = LOGIN
26318   client_send = : username : mysecret
26319 .endd
26320 The initial colon means that the first string is empty, so no data is sent with
26321 the AUTH command itself. The remaining strings are sent in response to
26322 prompts.
26323 .ecindex IIDplaiauth1
26324 .ecindex IIDplaiauth2
26325
26326
26327
26328
26329 . ////////////////////////////////////////////////////////////////////////////
26330 . ////////////////////////////////////////////////////////////////////////////
26331
26332 .chapter "The cram_md5 authenticator" "CHID9"
26333 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26334 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26335 .cindex "CRAM-MD5 authentication mechanism"
26336 .cindex "authentication" "CRAM-MD5 mechanism"
26337 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26338 sends a challenge string to the client, and the response consists of a user
26339 name and the CRAM-MD5 digest of the challenge string combined with a secret
26340 string (password) which is known to both server and client. Thus, the secret
26341 is not sent over the network as plain text, which makes this authenticator more
26342 secure than &(plaintext)&. However, the downside is that the secret has to be
26343 available in plain text at either end.
26344
26345
26346 .section "Using cram_md5 as a server" "SECID176"
26347 .cindex "options" "&(cram_md5)& authenticator (server)"
26348 This authenticator has one server option, which must be set to configure the
26349 authenticator as a server:
26350
26351 .option server_secret cram_md5 string&!! unset
26352 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26353 When the server receives the client's response, the user name is placed in
26354 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26355 obtain the password for that user. The server then computes the CRAM-MD5 digest
26356 that the client should have sent, and checks that it received the correct
26357 string. If the expansion of &%server_secret%& is forced to fail, authentication
26358 fails. If the expansion fails for some other reason, a temporary error code is
26359 returned to the client.
26360
26361 For compatibility with previous releases of Exim, the user name is also placed
26362 in &$1$&. However, the use of this variables for this purpose is now
26363 deprecated, as it can lead to confusion in string expansions that also use
26364 numeric variables for other things.
26365
26366 For example, the following authenticator checks that the user name given by the
26367 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26368 user name, authentication fails.
26369 .code
26370 fixed_cram:
26371   driver = cram_md5
26372   public_name = CRAM-MD5
26373   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26374   server_set_id = $auth1
26375 .endd
26376 .vindex "&$authenticated_id$&"
26377 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26378 name in &$authenticated_id$&. A more typical configuration might look up the
26379 secret string in a file, using the user name as the key. For example:
26380 .code
26381 lookup_cram:
26382   driver = cram_md5
26383   public_name = CRAM-MD5
26384   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26385                   {$value}fail}
26386   server_set_id = $auth1
26387 .endd
26388 Note that this expansion explicitly forces failure if the lookup fails
26389 because &$auth1$& contains an unknown user name.
26390
26391 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26392 using the relevant libraries, you need to know the realm to specify in the
26393 lookup and then ask for the &"userPassword"& attribute for that user in that
26394 realm, with:
26395 .code
26396 cyrusless_crammd5:
26397   driver = cram_md5
26398   public_name = CRAM-MD5
26399   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26400                   dbmjz{/etc/sasldb2}{$value}fail}
26401   server_set_id = $auth1
26402 .endd
26403
26404 .section "Using cram_md5 as a client" "SECID177"
26405 .cindex "options" "&(cram_md5)& authenticator (client)"
26406 When used as a client, the &(cram_md5)& authenticator has two options:
26407
26408
26409
26410 .option client_name cram_md5 string&!! "the primary host name"
26411 This string is expanded, and the result used as the user name data when
26412 computing the response to the server's challenge.
26413
26414
26415 .option client_secret cram_md5 string&!! unset
26416 This option must be set for the authenticator to work as a client. Its value is
26417 expanded and the result used as the secret string when computing the response.
26418
26419
26420 .vindex "&$host$&"
26421 .vindex "&$host_address$&"
26422 Different user names and secrets can be used for different servers by referring
26423 to &$host$& or &$host_address$& in the options. Forced failure of either
26424 expansion string is treated as an indication that this authenticator is not
26425 prepared to handle this case. Exim moves on to the next configured client
26426 authenticator. Any other expansion failure causes Exim to give up trying to
26427 send the message to the current server.
26428
26429 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26430 strings, is:
26431 .code
26432 fixed_cram:
26433   driver = cram_md5
26434   public_name = CRAM-MD5
26435   client_name = ph10
26436   client_secret = secret
26437 .endd
26438 .ecindex IIDcramauth1
26439 .ecindex IIDcramauth2
26440
26441
26442
26443 . ////////////////////////////////////////////////////////////////////////////
26444 . ////////////////////////////////////////////////////////////////////////////
26445
26446 .chapter "The cyrus_sasl authenticator" "CHID10"
26447 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26448 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26449 .cindex "Cyrus" "SASL library"
26450 .cindex "Kerberos"
26451 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26452 Digital Ltd (&url(http://www.aldigital.co.uk)).
26453
26454 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26455 library implementation of the RFC 2222 (&"Simple Authentication and Security
26456 Layer"&). This library supports a number of authentication mechanisms,
26457 including PLAIN and LOGIN, but also several others that Exim does not support
26458 directly. In particular, there is support for Kerberos authentication.
26459
26460 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26461 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26462 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26463 name of the driver to determine which mechanism to support.
26464
26465 Where access to some kind of secret file is required, for example in GSSAPI
26466 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26467 user, and that the Cyrus SASL library has no way of escalating privileges
26468 by default. You may also find you need to set environment variables,
26469 depending on the driver you are using.
26470
26471 The application name provided by Exim is &"exim"&, so various SASL options may
26472 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26473 Kerberos, note that because of limitations in the GSSAPI interface,
26474 changing the server keytab might need to be communicated down to the Kerberos
26475 layer independently. The mechanism for doing so is dependent upon the Kerberos
26476 implementation.
26477
26478 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26479 may be set to point to an alternative keytab file. Exim will pass this
26480 variable through from its own inherited environment when started as root or the
26481 Exim user. The keytab file needs to be readable by the Exim user.
26482 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26483 environment variable.  In practice, for those releases, the Cyrus authenticator
26484 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26485 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26486
26487
26488 .section "Using cyrus_sasl as a server" "SECID178"
26489 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26490 (on a successful authentication) into &$auth1$&. For compatibility with
26491 previous releases of Exim, the username is also placed in &$1$&. However, the
26492 use of this variable for this purpose is now deprecated, as it can lead to
26493 confusion in string expansions that also use numeric variables for other
26494 things.
26495
26496
26497 .option server_hostname cyrus_sasl string&!! "see below"
26498 This option selects the hostname that is used when communicating with the
26499 library. The default value is &`$primary_hostname`&. It is up to the underlying
26500 SASL plug-in what it does with this data.
26501
26502
26503 .option server_mech cyrus_sasl string "see below"
26504 This option selects the authentication mechanism this driver should use. The
26505 default is the value of the generic &%public_name%& option. This option allows
26506 you to use a different underlying mechanism from the advertised name. For
26507 example:
26508 .code
26509 sasl:
26510   driver = cyrus_sasl
26511   public_name = X-ANYTHING
26512   server_mech = CRAM-MD5
26513   server_set_id = $auth1
26514 .endd
26515
26516 .option server_realm cyrus_sasl string&!! unset
26517 This specifies the SASL realm that the server claims to be in.
26518
26519
26520 .option server_service cyrus_sasl string &`smtp`&
26521 This is the SASL service that the server claims to implement.
26522
26523
26524 For straightforward cases, you do not need to set any of the authenticator's
26525 private options. All you need to do is to specify an appropriate mechanism as
26526 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26527 PLAIN, you could have two authenticators as follows:
26528 .code
26529 sasl_cram_md5:
26530   driver = cyrus_sasl
26531   public_name = CRAM-MD5
26532   server_set_id = $auth1
26533
26534 sasl_plain:
26535   driver = cyrus_sasl
26536   public_name = PLAIN
26537   server_set_id = $auth2
26538 .endd
26539 Cyrus SASL does implement the LOGIN authentication method, even though it is
26540 not a standard method. It is disabled by default in the source distribution,
26541 but it is present in many binary distributions.
26542 .ecindex IIDcyrauth1
26543 .ecindex IIDcyrauth2
26544
26545
26546
26547
26548 . ////////////////////////////////////////////////////////////////////////////
26549 . ////////////////////////////////////////////////////////////////////////////
26550 .chapter "The dovecot authenticator" "CHAPdovecot"
26551 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26552 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26553 This authenticator is an interface to the authentication facility of the
26554 Dovecot POP/IMAP server, which can support a number of authentication methods.
26555 Note that Dovecot must be configured to use auth-client not auth-userdb.
26556 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26557 to use the same mechanisms for SMTP authentication. This is a server
26558 authenticator only. There is only one option:
26559
26560 .option server_socket dovecot string unset
26561
26562 This option must specify the socket that is the interface to Dovecot
26563 authentication. The &%public_name%& option must specify an authentication
26564 mechanism that Dovecot is configured to support. You can have several
26565 authenticators for different mechanisms. For example:
26566 .code
26567 dovecot_plain:
26568   driver = dovecot
26569   public_name = PLAIN
26570   server_socket = /var/run/dovecot/auth-client
26571   server_set_id = $auth1
26572
26573 dovecot_ntlm:
26574   driver = dovecot
26575   public_name = NTLM
26576   server_socket = /var/run/dovecot/auth-client
26577   server_set_id = $auth1
26578 .endd
26579 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26580 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26581 option is passed in the Dovecot authentication command. If, for a TLS
26582 connection, a client certificate has been verified, the &"valid-client-cert"&
26583 option is passed. When authentication succeeds, the identity of the user
26584 who authenticated is placed in &$auth1$&.
26585 .ecindex IIDdcotauth1
26586 .ecindex IIDdcotauth2
26587
26588
26589 . ////////////////////////////////////////////////////////////////////////////
26590 . ////////////////////////////////////////////////////////////////////////////
26591 .chapter "The gsasl authenticator" "CHAPgsasl"
26592 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26593 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26594 .cindex "authentication" "GNU SASL"
26595 .cindex "authentication" "SASL"
26596 .cindex "authentication" "EXTERNAL"
26597 .cindex "authentication" "ANONYMOUS"
26598 .cindex "authentication" "PLAIN"
26599 .cindex "authentication" "LOGIN"
26600 .cindex "authentication" "DIGEST-MD5"
26601 .cindex "authentication" "CRAM-MD5"
26602 .cindex "authentication" "SCRAM-SHA-1"
26603 The &(gsasl)& authenticator provides server integration for the GNU SASL
26604 library and the mechanisms it provides.  This is new as of the 4.80 release
26605 and there are a few areas where the library does not let Exim smoothly
26606 scale to handle future authentication mechanisms, so no guarantee can be
26607 made that any particular new authentication mechanism will be supported
26608 without code changes in Exim.
26609
26610
26611 .option server_channelbinding gsasl boolean false
26612 Some authentication mechanisms are able to use external context at both ends
26613 of the session to bind the authentication to that context, and fail the
26614 authentication process if that context differs.  Specifically, some TLS
26615 ciphersuites can provide identifying information about the cryptographic
26616 context.
26617
26618 This means that certificate identity and verification becomes a non-issue,
26619 as a man-in-the-middle attack will cause the correct client and server to
26620 see different identifiers and authentication will fail.
26621
26622 This is currently only supported when using the GnuTLS library.  This is
26623 only usable by mechanisms which support "channel binding"; at time of
26624 writing, that's the SCRAM family.
26625
26626 This defaults off to ensure smooth upgrade across Exim releases, in case
26627 this option causes some clients to start failing.  Some future release
26628 of Exim may switch the default to be true.
26629
26630
26631 .option server_hostname gsasl string&!! "see below"
26632 This option selects the hostname that is used when communicating with the
26633 library. The default value is &`$primary_hostname`&.
26634 Some mechanisms will use this data.
26635
26636
26637 .option server_mech gsasl string "see below"
26638 This option selects the authentication mechanism this driver should use. The
26639 default is the value of the generic &%public_name%& option. This option allows
26640 you to use a different underlying mechanism from the advertised name. For
26641 example:
26642 .code
26643 sasl:
26644   driver = gsasl
26645   public_name = X-ANYTHING
26646   server_mech = CRAM-MD5
26647   server_set_id = $auth1
26648 .endd
26649
26650
26651 .option server_password gsasl string&!! unset
26652 Various mechanisms need access to the cleartext password on the server, so
26653 that proof-of-possession can be demonstrated on the wire, without sending
26654 the password itself.
26655
26656 The data available for lookup varies per mechanism.
26657 In all cases, &$auth1$& is set to the &'authentication id'&.
26658 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26659 if available, else the empty string.
26660 The &$auth3$& variable will always be the &'realm'& if available,
26661 else the empty string.
26662
26663 A forced failure will cause authentication to defer.
26664
26665 If using this option, it may make sense to set the &%server_condition%&
26666 option to be simply "true".
26667
26668
26669 .option server_realm gsasl string&!! unset
26670 This specifies the SASL realm that the server claims to be in.
26671 Some mechanisms will use this data.
26672
26673
26674 .option server_scram_iter gsasl string&!! unset
26675 This option provides data for the SCRAM family of mechanisms.
26676 &$auth1$& is not available at evaluation time.
26677 (This may change, as we receive feedback on use)
26678
26679
26680 .option server_scram_salt gsasl string&!! unset
26681 This option provides data for the SCRAM family of mechanisms.
26682 &$auth1$& is not available at evaluation time.
26683 (This may change, as we receive feedback on use)
26684
26685
26686 .option server_service gsasl string &`smtp`&
26687 This is the SASL service that the server claims to implement.
26688 Some mechanisms will use this data.
26689
26690
26691 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26692 .vindex "&$auth1$&, &$auth2$&, etc"
26693 These may be set when evaluating specific options, as detailed above.
26694 They will also be set when evaluating &%server_condition%&.
26695
26696 Unless otherwise stated below, the &(gsasl)& integration will use the following
26697 meanings for these variables:
26698
26699 .ilist
26700 .vindex "&$auth1$&"
26701 &$auth1$&: the &'authentication id'&
26702 .next
26703 .vindex "&$auth2$&"
26704 &$auth2$&: the &'authorization id'&
26705 .next
26706 .vindex "&$auth3$&"
26707 &$auth3$&: the &'realm'&
26708 .endlist
26709
26710 On a per-mechanism basis:
26711
26712 .ilist
26713 .cindex "authentication" "EXTERNAL"
26714 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26715 the &%server_condition%& option must be present.
26716 .next
26717 .cindex "authentication" "ANONYMOUS"
26718 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26719 the &%server_condition%& option must be present.
26720 .next
26721 .cindex "authentication" "GSSAPI"
26722 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26723 &$auth2$& will be set to the &'authorization id'&,
26724 the &%server_condition%& option must be present.
26725 .endlist
26726
26727 An &'anonymous token'& is something passed along as an unauthenticated
26728 identifier; this is analogous to FTP anonymous authentication passing an
26729 email address, or software-identifier@, as the "password".
26730
26731
26732 An example showing the password having the realm specified in the callback
26733 and demonstrating a Cyrus SASL to GSASL migration approach is:
26734 .code
26735 gsasl_cyrusless_crammd5:
26736   driver = gsasl
26737   public_name = CRAM-MD5
26738   server_realm = imap.example.org
26739   server_password = ${lookup{$auth1:$auth3:userPassword}\
26740                     dbmjz{/etc/sasldb2}{$value}fail}
26741   server_set_id = ${quote:$auth1}
26742   server_condition = yes
26743 .endd
26744
26745
26746 . ////////////////////////////////////////////////////////////////////////////
26747 . ////////////////////////////////////////////////////////////////////////////
26748
26749 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26750 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26751 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26752 .cindex "authentication" "GSSAPI"
26753 .cindex "authentication" "Kerberos"
26754 The &(heimdal_gssapi)& authenticator provides server integration for the
26755 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26756 reliably.
26757
26758 .option server_hostname heimdal_gssapi string&!! "see below"
26759 This option selects the hostname that is used, with &%server_service%&,
26760 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26761 identifier.  The default value is &`$primary_hostname`&.
26762
26763 .option server_keytab heimdal_gssapi string&!! unset
26764 If set, then Heimdal will not use the system default keytab (typically
26765 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26766 The value should be a pathname, with no &"file:"& prefix.
26767
26768 .option server_service heimdal_gssapi string&!! "smtp"
26769 This option specifies the service identifier used, in conjunction with
26770 &%server_hostname%&, for building the identifier for finding credentials
26771 from the keytab.
26772
26773
26774 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26775 Beware that these variables will typically include a realm, thus will appear
26776 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26777 not verified, so a malicious client can set it to anything.
26778
26779 The &$auth1$& field should be safely trustable as a value from the Key
26780 Distribution Center.  Note that these are not quite email addresses.
26781 Each identifier is for a role, and so the left-hand-side may include a
26782 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26783
26784 .vindex "&$auth1$&, &$auth2$&, etc"
26785 .ilist
26786 .vindex "&$auth1$&"
26787 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26788 .next
26789 .vindex "&$auth2$&"
26790 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26791 authentication.  If that was empty, this will also be set to the
26792 GSS Display Name.
26793 .endlist
26794
26795
26796 . ////////////////////////////////////////////////////////////////////////////
26797 . ////////////////////////////////////////////////////////////////////////////
26798
26799 .chapter "The spa authenticator" "CHAPspa"
26800 .scindex IIDspaauth1 "&(spa)& authenticator"
26801 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26802 .cindex "authentication" "Microsoft Secure Password"
26803 .cindex "authentication" "NTLM"
26804 .cindex "Microsoft Secure Password Authentication"
26805 .cindex "NTLM authentication"
26806 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26807 Password Authentication'& mechanism,
26808 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26809 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26810 taken from the Samba project (&url(http://www.samba.org)). The code for the
26811 server side was subsequently contributed by Tom Kistner. The mechanism works as
26812 follows:
26813
26814 .ilist
26815 After the AUTH command has been accepted, the client sends an SPA
26816 authentication request based on the user name and optional domain.
26817 .next
26818 The server sends back a challenge.
26819 .next
26820 The client builds a challenge response which makes use of the user's password
26821 and sends it to the server, which then accepts or rejects it.
26822 .endlist
26823
26824 Encryption is used to protect the password in transit.
26825
26826
26827
26828 .section "Using spa as a server" "SECID179"
26829 .cindex "options" "&(spa)& authenticator (server)"
26830 The &(spa)& authenticator has just one server option:
26831
26832 .option server_password spa string&!! unset
26833 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26834 This option is expanded, and the result must be the cleartext password for the
26835 authenticating user, whose name is at this point in &$auth1$&. For
26836 compatibility with previous releases of Exim, the user name is also placed in
26837 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26838 it can lead to confusion in string expansions that also use numeric variables
26839 for other things. For example:
26840 .code
26841 spa:
26842   driver = spa
26843   public_name = NTLM
26844   server_password = \
26845     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26846 .endd
26847 If the expansion is forced to fail, authentication fails. Any other expansion
26848 failure causes a temporary error code to be returned.
26849
26850
26851
26852
26853
26854 .section "Using spa as a client" "SECID180"
26855 .cindex "options" "&(spa)& authenticator (client)"
26856 The &(spa)& authenticator has the following client options:
26857
26858
26859
26860 .option client_domain spa string&!! unset
26861 This option specifies an optional domain for the authentication.
26862
26863
26864 .option client_password spa string&!! unset
26865 This option specifies the user's password, and must be set.
26866
26867
26868 .option client_username spa string&!! unset
26869 This option specifies the user name, and must be set. Here is an example of a
26870 configuration of this authenticator for use with the mail servers at
26871 &'msn.com'&:
26872 .code
26873 msn:
26874   driver = spa
26875   public_name = MSN
26876   client_username = msn/msn_username
26877   client_password = msn_plaintext_password
26878   client_domain = DOMAIN_OR_UNSET
26879 .endd
26880 .ecindex IIDspaauth1
26881 .ecindex IIDspaauth2
26882
26883
26884
26885
26886
26887 . ////////////////////////////////////////////////////////////////////////////
26888 . ////////////////////////////////////////////////////////////////////////////
26889
26890 .chapter "The tls authenticator" "CHAPtlsauth"
26891 .scindex IIDtlsauth1 "&(tls)& authenticator"
26892 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26893 .cindex "authentication" "Client Certificate"
26894 .cindex "authentication" "X509"
26895 .cindex "Certificate-based authentication"
26896 The &(tls)& authenticator provides server support for
26897 authentication based on client certificates.
26898
26899 It is not an SMTP authentication mechanism and is not
26900 advertised by the server as part of the SMTP EHLO response.
26901 It is an Exim authenticator in the sense that it affects
26902 the protocol element of the log line, can be tested for
26903 by the &%authenticated%& ACL condition, and can set
26904 the &$authenticated_id$& variable.
26905
26906 The client must present a verifiable certificate,
26907 for which it must have been requested via the
26908 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26909 (see &<<CHAPTLS>>&).
26910
26911 If an authenticator of this type is configured it is
26912 run before any SMTP-level communication is done,
26913 and can authenticate the connection.
26914 If it does, SMTP authentication is not offered.
26915
26916 A maximum of one authenticator of this type may be present.
26917
26918
26919 .cindex "options" "&(tls)& authenticator (server)"
26920 The &(tls)& authenticator has three server options:
26921
26922 .option server_param1 tls string&!! unset
26923 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26924 This option is expanded after the TLS negotiation and
26925 the result is placed in &$auth1$&.
26926 If the expansion is forced to fail, authentication fails. Any other expansion
26927 failure causes a temporary error code to be returned.
26928
26929 .option server_param2 tls string&!! unset
26930 .option server_param3 tls string&!! unset
26931 As above, for &$auth2$& and &$auth3$&.
26932
26933 &%server_param1%& may also be spelled &%server_param%&.
26934
26935
26936 Example:
26937 .code
26938 tls:
26939   driver = tls
26940   server_param1 =     ${certextract {subj_altname,mail,>:} \
26941                                     {$tls_in_peercert}}
26942   server_condition =  ${if forany {$auth1} \
26943                             {!= {0} \
26944                                 {${lookup ldap{ldap:///\
26945                          mailname=${quote_ldap_dn:${lc:$item}},\
26946                          ou=users,LDAP_DC?mailid} {$value}{0} \
26947                        }    }   } }
26948   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26949 .endd
26950 This accepts a client certificate that is verifiable against any
26951 of your configured trust-anchors
26952 (which usually means the full set of public CAs)
26953 and which has a SAN with a good account name.
26954 Note that the client cert is on the wire in-clear, including the SAN,
26955 whereas a plaintext SMTP AUTH done inside TLS is not.
26956
26957 . An alternative might use
26958 . .code
26959 .   server_param1 = ${sha256:$tls_in_peercert}
26960 . .endd
26961 . to require one of a set of specific certs that define a given account
26962 . (the verification is still required, but mostly irrelevant).
26963 . This would help for per-device use.
26964 .
26965 . However, for the future we really need support for checking a
26966 . user cert in LDAP - which probably wants a base-64 DER.
26967
26968 .ecindex IIDtlsauth1
26969 .ecindex IIDtlsauth2
26970
26971
26972 Note that because authentication is traditionally an SMTP operation,
26973 the &%authenticated%& ACL condition cannot be used in
26974 a connect- or helo-ACL.
26975
26976
26977
26978 . ////////////////////////////////////////////////////////////////////////////
26979 . ////////////////////////////////////////////////////////////////////////////
26980
26981 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26982          "Encrypted SMTP connections"
26983 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26984 .scindex IIDencsmtp2 "SMTP" "encryption"
26985 .cindex "TLS" "on SMTP connection"
26986 .cindex "OpenSSL"
26987 .cindex "GnuTLS"
26988 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26989 Sockets Layer), is implemented by making use of the OpenSSL library or the
26990 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26991 cryptographic code in the Exim distribution itself for implementing TLS. In
26992 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26993 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26994 You also need to understand the basic concepts of encryption at a managerial
26995 level, and in particular, the way that public keys, private keys, and
26996 certificates are used.
26997
26998 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26999 connection is established, the client issues a STARTTLS command. If the
27000 server accepts this, the client and the server negotiate an encryption
27001 mechanism. If the negotiation succeeds, the data that subsequently passes
27002 between them is encrypted.
27003
27004 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27005 and if so, what cipher suite is in use, whether the client supplied a
27006 certificate, and whether or not that certificate was verified. This makes it
27007 possible for an Exim server to deny or accept certain commands based on the
27008 encryption state.
27009
27010 &*Warning*&: Certain types of firewall and certain anti-virus products can
27011 disrupt TLS connections. You need to turn off SMTP scanning for these products
27012 in order to get TLS to work.
27013
27014
27015
27016 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
27017          "SECID284"
27018 .cindex "ssmtp protocol"
27019 .cindex "smtps protocol"
27020 .cindex "SMTP" "ssmtp protocol"
27021 .cindex "SMTP" "smtps protocol"
27022 Early implementations of encrypted SMTP used a different TCP port from normal
27023 SMTP, and expected an encryption negotiation to start immediately, instead of
27024 waiting for a STARTTLS command from the client using the standard SMTP
27025 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
27026 allocated for this purpose.
27027
27028 This approach was abandoned when encrypted SMTP was standardized, but there are
27029 still some legacy clients that use it. Exim supports these clients by means of
27030 the &%tls_on_connect_ports%& global option. Its value must be a list of port
27031 numbers; the most common use is expected to be:
27032 .code
27033 tls_on_connect_ports = 465
27034 .endd
27035 The port numbers specified by this option apply to all SMTP connections, both
27036 via the daemon and via &'inetd'&. You still need to specify all the ports that
27037 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
27038 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
27039 an extra port &-- rather, it specifies different behaviour on a port that is
27040 defined elsewhere.
27041
27042 There is also a &%-tls-on-connect%& command line option. This overrides
27043 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
27044
27045
27046
27047
27048
27049
27050 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
27051 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
27052 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
27053 followed later, when the first versions of GnuTLS were released. To build Exim
27054 to use GnuTLS, you need to set
27055 .code
27056 USE_GNUTLS=yes
27057 .endd
27058 in Local/Makefile, in addition to
27059 .code
27060 SUPPORT_TLS=yes
27061 .endd
27062 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
27063 include files and libraries for GnuTLS can be found.
27064
27065 There are some differences in usage when using GnuTLS instead of OpenSSL:
27066
27067 .ilist
27068 The &%tls_verify_certificates%& option
27069 cannot be the path of a directory
27070 for GnuTLS versions before 3.3.6
27071 (for later versions, or OpenSSL, it can be either).
27072 .next
27073 The default value for &%tls_dhparam%& differs for historical reasons.
27074 .next
27075 .vindex "&$tls_in_peerdn$&"
27076 .vindex "&$tls_out_peerdn$&"
27077 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
27078 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
27079 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
27080 .next
27081 OpenSSL identifies cipher suites using hyphens as separators, for example:
27082 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
27083 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
27084 in a cipher list. To make life simpler, Exim changes underscores to hyphens
27085 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
27086 to handle its own older variants) when processing lists of cipher suites in the
27087 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
27088 option).
27089 .next
27090 The &%tls_require_ciphers%& options operate differently, as described in the
27091 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
27092 .next
27093 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
27094 When using OpenSSL, this option is ignored.
27095 (If an API is found to let OpenSSL be configured in this way,
27096 let the Exim Maintainers know and we'll likely use it).
27097 .next
27098 Some other recently added features may only be available in one or the other.
27099 This should be documented with the feature.  If the documentation does not
27100 explicitly state that the feature is infeasible in the other TLS
27101 implementation, then patches are welcome.
27102 .endlist
27103
27104
27105 .section "GnuTLS parameter computation" "SECTgnutlsparam"
27106 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
27107 an explicit path; if the latter, then the text about generation still applies,
27108 but not the chosen filename.
27109 By default, as of Exim 4.80 a hard-coded D-H prime is used.
27110 See the documentation of &%tls_dhparam%& for more information.
27111
27112 GnuTLS uses D-H parameters that may take a substantial amount of time
27113 to compute. It is unreasonable to re-compute them for every TLS session.
27114 Therefore, Exim keeps this data in a file in its spool directory, called
27115 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
27116 of bits requested.
27117 The file is owned by the Exim user and is readable only by
27118 its owner. Every Exim process that start up GnuTLS reads the D-H
27119 parameters from this file. If the file does not exist, the first Exim process
27120 that needs it computes the data and writes it to a temporary file which is
27121 renamed once it is complete. It does not matter if several Exim processes do
27122 this simultaneously (apart from wasting a few resources). Once a file is in
27123 place, new Exim processes immediately start using it.
27124
27125 For maximum security, the parameters that are stored in this file should be
27126 recalculated periodically, the frequency depending on your paranoia level.
27127 If you are avoiding using the fixed D-H primes published in RFCs, then you
27128 are concerned about some advanced attacks and will wish to do this; if you do
27129 not regenerate then you might as well stick to the standard primes.
27130
27131 Arranging this is easy in principle; just delete the file when you want new
27132 values to be computed. However, there may be a problem. The calculation of new
27133 parameters needs random numbers, and these are obtained from &_/dev/random_&.
27134 If the system is not very active, &_/dev/random_& may delay returning data
27135 until enough randomness (entropy) is available. This may cause Exim to hang for
27136 a substantial amount of time, causing timeouts on incoming connections.
27137
27138 The solution is to generate the parameters externally to Exim. They are stored
27139 in &_gnutls-params-N_& in PEM format, which means that they can be
27140 generated externally using the &(certtool)& command that is part of GnuTLS.
27141
27142 To replace the parameters with new ones, instead of deleting the file
27143 and letting Exim re-create it, you can generate new parameters using
27144 &(certtool)& and, when this has been done, replace Exim's cache file by
27145 renaming. The relevant commands are something like this:
27146 .code
27147 # ls
27148 [ look for file; assume gnutls-params-2236 is the most recent ]
27149 # rm -f new-params
27150 # touch new-params
27151 # chown exim:exim new-params
27152 # chmod 0600 new-params
27153 # certtool --generate-dh-params --bits 2236 >>new-params
27154 # openssl dhparam -noout -text -in new-params | head
27155 [ check the first line, make sure it's not more than 2236;
27156   if it is, then go back to the start ("rm") and repeat
27157   until the size generated is at most the size requested ]
27158 # chmod 0400 new-params
27159 # mv new-params gnutls-params-2236
27160 .endd
27161 If Exim never has to generate the parameters itself, the possibility of
27162 stalling is removed.
27163
27164 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27165 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27166 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27167 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27168 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27169 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27170 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27171 which applies to all D-H usage, client or server.  If the value returned by
27172 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27173 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27174 limit, which is still much higher than Exim historically used.
27175
27176 The filename and bits used will change as the GnuTLS maintainers change the
27177 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27178 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27179 2432 bits, while NSS is limited to 2236 bits.
27180
27181 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27182 increase the chance of the generated prime actually being within acceptable
27183 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27184 procedure above.  There is no sane procedure available to Exim to double-check
27185 the size of the generated prime, so it might still be too large.
27186
27187
27188 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27189 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
27190 .oindex "&%tls_require_ciphers%&" "OpenSSL"
27191 There is a function in the OpenSSL library that can be passed a list of cipher
27192 suites before the cipher negotiation takes place. This specifies which ciphers
27193 are acceptable. The list is colon separated and may contain names like
27194 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
27195 directly to this function call.
27196 Many systems will install the OpenSSL manual-pages, so you may have
27197 &'ciphers(1)'& available to you.
27198 The following quotation from the OpenSSL
27199 documentation specifies what forms of item are allowed in the cipher string:
27200
27201 .ilist
27202 It can consist of a single cipher suite such as RC4-SHA.
27203 .next
27204 It can represent a list of cipher suites containing a certain algorithm,
27205 or cipher suites of a certain type. For example SHA1 represents all
27206 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
27207 SSL v3 algorithms.
27208 .next
27209 Lists of cipher suites can be combined in a single cipher string using
27210 the + character. This is used as a logical and operation. For example
27211 SHA1+DES represents all cipher suites containing the SHA1 and the DES
27212 algorithms.
27213 .endlist
27214
27215 Each cipher string can be optionally preceded by one of the characters &`!`&,
27216 &`-`& or &`+`&.
27217 .ilist
27218 If &`!`& is used, the ciphers are permanently deleted from the list. The
27219 ciphers deleted can never reappear in the list even if they are explicitly
27220 stated.
27221 .next
27222 If &`-`& is used, the ciphers are deleted from the list, but some or all
27223 of the ciphers can be added again by later options.
27224 .next
27225 If &`+`& is used, the ciphers are moved to the end of the list. This
27226 option does not add any new ciphers; it just moves matching existing ones.
27227 .endlist
27228
27229 If none of these characters is present, the string is interpreted as
27230 a list of ciphers to be appended to the current preference list. If the list
27231 includes any ciphers already present they will be ignored: that is, they will
27232 not be moved to the end of the list.
27233 .endlist
27234
27235 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27236 string:
27237 .code
27238 # note single-quotes to get ! past any shell history expansion
27239 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27240 .endd
27241
27242 This example will let the library defaults be permitted on the MX port, where
27243 there's probably no identity verification anyway, but ups the ante on the
27244 submission ports where the administrator might have some influence on the
27245 choice of clients used:
27246 .code
27247 # OpenSSL variant; see man ciphers(1)
27248 tls_require_ciphers = ${if =={$received_port}{25}\
27249                            {DEFAULT}\
27250                            {HIGH:!MD5:!SHA1}}
27251 .endd
27252
27253
27254
27255 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27256          "SECTreqciphgnu"
27257 .cindex "GnuTLS" "specifying parameters for"
27258 .cindex "TLS" "specifying ciphers (GnuTLS)"
27259 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27260 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27261 .cindex "TLS" "specifying protocols (GnuTLS)"
27262 .cindex "TLS" "specifying priority string (GnuTLS)"
27263 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27264 The GnuTLS library allows the caller to provide a "priority string", documented
27265 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27266 ciphersuite specification in OpenSSL.
27267
27268 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27269 and controls both protocols and ciphers.
27270
27271 The &%tls_require_ciphers%& option is available both as an global option,
27272 controlling how Exim behaves as a server, and also as an option of the
27273 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27274 the value is string expanded.  The resulting string is not an Exim list and
27275 the string is given to the GnuTLS library, so that Exim does not need to be
27276 aware of future feature enhancements of GnuTLS.
27277
27278 Documentation of the strings accepted may be found in the GnuTLS manual, under
27279 "Priority strings".  This is online as
27280 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
27281 but beware that this relates to GnuTLS 3, which may be newer than the version
27282 installed on your system.  If you are using GnuTLS 3,
27283 then the example code
27284 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27285 on that site can be used to test a given string.
27286
27287 For example:
27288 .code
27289 # Disable older versions of protocols
27290 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27291 .endd
27292
27293 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27294 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27295 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27296
27297 This example will let the library defaults be permitted on the MX port, where
27298 there's probably no identity verification anyway, and lowers security further
27299 by increasing compatibility; but this ups the ante on the submission ports
27300 where the administrator might have some influence on the choice of clients
27301 used:
27302 .code
27303 # GnuTLS variant
27304 tls_require_ciphers = ${if =={$received_port}{25}\
27305                            {NORMAL:%COMPAT}\
27306                            {SECURE128}}
27307 .endd
27308
27309
27310 .section "Configuring an Exim server to use TLS" "SECID182"
27311 .cindex "TLS" "configuring an Exim server"
27312 When Exim has been built with TLS support, it advertises the availability of
27313 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27314 but not to any others. The default value of this option is *, which means
27315 that STARTTLS is alway advertised.  Set it to blank to never advertise;
27316 this is reasonble for systems that want to use TLS only as a client.
27317
27318 If STARTTLS is to be used you
27319 need to set some other options in order to make TLS available.
27320
27321 If a client issues a STARTTLS command and there is some configuration
27322 problem in the server, the command is rejected with a 454 error. If the client
27323 persists in trying to issue SMTP commands, all except QUIT are rejected
27324 with the error
27325 .code
27326 554 Security failure
27327 .endd
27328 If a STARTTLS command is issued within an existing TLS session, it is
27329 rejected with a 554 error code.
27330
27331 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27332 must be set to match some hosts. The default is * which matches all hosts.
27333
27334 If this is all you do, TLS encryption will be enabled but not authentication -
27335 meaning that the peer has no assurance it is actually you he is talking to.
27336 You gain protection from a passive sniffer listening on the wire but not
27337 from someone able to intercept the communication.
27338
27339 Further protection requires some further configuration at the server end.
27340
27341 It is rumoured that all existing clients that support TLS/SSL use RSA
27342 encryption. To make this work you need to set, in the server,
27343 .code
27344 tls_certificate = /some/file/name
27345 tls_privatekey = /some/file/name
27346 .endd
27347 These options are, in fact, expanded strings, so you can make them depend on
27348 the identity of the client that is connected if you wish. The first file
27349 contains the server's X509 certificate, and the second contains the private key
27350 that goes with it. These files need to be
27351 PEM format and readable by the Exim user, and must
27352 always be given as full path names.
27353 The key must not be password-protected.
27354 They can be the same file if both the
27355 certificate and the key are contained within it. If &%tls_privatekey%& is not
27356 set, or if its expansion is forced to fail or results in an empty string, this
27357 is assumed to be the case. The certificate file may also contain intermediate
27358 certificates that need to be sent to the client to enable it to authenticate
27359 the server's certificate.
27360
27361 If you do not understand about certificates and keys, please try to find a
27362 source of this background information, which is not Exim-specific. (There are a
27363 few comments below in section &<<SECTcerandall>>&.)
27364
27365 &*Note*&: These options do not apply when Exim is operating as a client &--
27366 they apply only in the case of a server. If you need to use a certificate in an
27367 Exim client, you must set the options of the same names in an &(smtp)&
27368 transport.
27369
27370 With just these options, an Exim server will be able to use TLS. It does not
27371 require the client to have a certificate (but see below for how to insist on
27372 this). There is one other option that may be needed in other situations. If
27373 .code
27374 tls_dhparam = /some/file/name
27375 .endd
27376 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27377 with the parameters contained in the file.
27378 Set this to &`none`& to disable use of DH entirely, by making no prime
27379 available:
27380 .code
27381 tls_dhparam = none
27382 .endd
27383 This may also be set to a string identifying a standard prime to be used for
27384 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27385 used is &`ike23`&.  There are a few standard primes available, see the
27386 documentation for &%tls_dhparam%& for the complete list.
27387
27388 See the command
27389 .code
27390 openssl dhparam
27391 .endd
27392 for a way of generating file data.
27393
27394 The strings supplied for these three options are expanded every time a client
27395 host connects. It is therefore possible to use different certificates and keys
27396 for different hosts, if you so wish, by making use of the client's IP address
27397 in &$sender_host_address$& to control the expansion. If a string expansion is
27398 forced to fail, Exim behaves as if the option is not set.
27399
27400 .cindex "cipher" "logging"
27401 .cindex "log" "TLS cipher"
27402 .vindex "&$tls_in_cipher$&"
27403 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27404 an incoming TLS connection. It is included in the &'Received:'& header of an
27405 incoming message (by default &-- you can, of course, change this), and it is
27406 also included in the log line that records a message's arrival, keyed by
27407 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27408 condition can be used to test for specific cipher suites in ACLs.
27409
27410 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27411 can check the name of the cipher suite and vary their actions accordingly. The
27412 cipher suite names vary, depending on which TLS library is being used. For
27413 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27414 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27415 documentation for more details.
27416
27417 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27418 (again depending on the &%tls_cipher%& log selector).
27419
27420
27421 .section "Requesting and verifying client certificates" "SECID183"
27422 .cindex "certificate" "verification of client"
27423 .cindex "TLS" "client certificate verification"
27424 If you want an Exim server to request a certificate when negotiating a TLS
27425 session with a client, you must set either &%tls_verify_hosts%& or
27426 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27427 apply to all TLS connections. For any host that matches one of these options,
27428 Exim requests a certificate as part of the setup of the TLS session. The
27429 contents of the certificate are verified by comparing it with a list of
27430 expected certificates.
27431 These may be the system default set (depending on library version),
27432 an explicit file or,
27433 depending on library version, a directory, identified by
27434 &%tls_verify_certificates%&.
27435
27436 A file can contain multiple certificates, concatenated end to end. If a
27437 directory is used
27438 (OpenSSL only),
27439 each certificate must be in a separate file, with a name (or a symbolic link)
27440 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27441 certificate. You can compute the relevant hash by running the command
27442 .code
27443 openssl x509 -hash -noout -in /cert/file
27444 .endd
27445 where &_/cert/file_& contains a single certificate.
27446
27447 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27448 what happens if the client does not supply a certificate, or if the certificate
27449 does not match any of the certificates in the collection named by
27450 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27451 attempt to set up a TLS session is aborted, and the incoming connection is
27452 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27453 session continues. ACLs that run for subsequent SMTP commands can detect the
27454 fact that no certificate was verified, and vary their actions accordingly. For
27455 example, you can insist on a certificate before accepting a message for
27456 relaying, but not when the message is destined for local delivery.
27457
27458 .vindex "&$tls_in_peerdn$&"
27459 When a client supplies a certificate (whether it verifies or not), the value of
27460 the Distinguished Name of the certificate is made available in the variable
27461 &$tls_in_peerdn$& during subsequent processing of the message.
27462
27463 .cindex "log" "distinguished name"
27464 Because it is often a long text string, it is not included in the log line or
27465 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27466 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27467 &%received_header_text%& to change the &'Received:'& header. When no
27468 certificate is supplied, &$tls_in_peerdn$& is empty.
27469
27470
27471 .section "Revoked certificates" "SECID184"
27472 .cindex "TLS" "revoked certificates"
27473 .cindex "revocation list"
27474 .cindex "certificate" "revocation list"
27475 .cindex "OCSP" "stapling"
27476 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27477 certificates are revoked. If you have such a list, you can pass it to an Exim
27478 server using the global option called &%tls_crl%& and to an Exim client using
27479 an identically named option for the &(smtp)& transport. In each case, the value
27480 of the option is expanded and must then be the name of a file that contains a
27481 CRL in PEM format.
27482 The downside is that clients have to periodically re-download a potentially huge
27483 file from every certificate authority they know of.
27484
27485 The way with most moving parts at query time is Online Certificate
27486 Status Protocol (OCSP), where the client verifies the certificate
27487 against an OCSP server run by the CA.  This lets the CA track all
27488 usage of the certs.  It requires running software with access to the
27489 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27490 is based on HTTP and can be proxied accordingly.
27491
27492 The only widespread OCSP server implementation (known to this writer)
27493 comes as part of OpenSSL and aborts on an invalid request, such as
27494 connecting to the port and then disconnecting.  This requires
27495 re-entering the passphrase each time some random client does this.
27496
27497 The third way is OCSP Stapling; in this, the server using a certificate
27498 issued by the CA periodically requests an OCSP proof of validity from
27499 the OCSP server, then serves it up inline as part of the TLS
27500 negotiation.   This approach adds no extra round trips, does not let the
27501 CA track users, scales well with number of certs issued by the CA and is
27502 resilient to temporary OCSP server failures, as long as the server
27503 starts retrying to fetch an OCSP proof some time before its current
27504 proof expires.  The downside is that it requires server support.
27505
27506 Unless Exim is built with the support disabled,
27507 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27508 support for OCSP stapling is included.
27509
27510 There is a global option called &%tls_ocsp_file%&.
27511 The file specified therein is expected to be in DER format, and contain
27512 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27513 option will be re-expanded for SNI, if the &%tls_certificate%& option
27514 contains &`tls_in_sni`&, as per other TLS options.
27515
27516 Exim does not at this time implement any support for fetching a new OCSP
27517 proof.  The burden is on the administrator to handle this, outside of
27518 Exim.  The file specified should be replaced atomically, so that the
27519 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27520 on each connection, so a new file will be handled transparently on the
27521 next connection.
27522
27523 When built with OpenSSL Exim will check for a valid next update timestamp
27524 in the OCSP proof; if not present, or if the proof has expired, it will be
27525 ignored.
27526
27527 For the client to be able to verify the stapled OCSP the server must
27528 also supply, in its stapled information, any intermediate
27529 certificates for the chain leading to the OCSP proof from the signer
27530 of the server certificate.  There may be zero or one such. These
27531 intermediate certificates should be added to the server OCSP stapling
27532 file named by &%tls_ocsp_file%&.
27533
27534 Note that the proof only covers the terminal server certificate,
27535 not any of the chain from CA to it.
27536
27537 There is no current way to staple a proof for a client certificate.
27538
27539 .code
27540   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27541   OCSP server is supplied.  The server URL may be included in the
27542   server certificate, if the CA is helpful.
27543
27544   One failure mode seen was the OCSP Signer cert expiring before the end
27545   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27546   noted this as invalid overall, but the re-fetch script did not.
27547 .endd
27548
27549
27550
27551
27552 .section "Configuring an Exim client to use TLS" "SECID185"
27553 .cindex "cipher" "logging"
27554 .cindex "log" "TLS cipher"
27555 .cindex "log" "distinguished name"
27556 .cindex "TLS" "configuring an Exim client"
27557 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27558 deliveries as well as to incoming, the latter one causing logging of the
27559 server certificate's DN. The remaining client configuration for TLS is all
27560 within the &(smtp)& transport.
27561
27562 It is not necessary to set any options to have TLS work in the &(smtp)&
27563 transport. If Exim is built with TLS support, and TLS is advertised by a
27564 server, the &(smtp)& transport always tries to start a TLS session. However,
27565 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27566 transport) to a list of server hosts for which TLS should not be used.
27567
27568 If you do not want Exim to attempt to send messages unencrypted when an attempt
27569 to set up an encrypted connection fails in any way, you can set
27570 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27571 those hosts, delivery is always deferred if an encrypted connection cannot be
27572 set up. If there are any other hosts for the address, they are tried in the
27573 usual way.
27574
27575 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27576 the message unencrypted. It always does this if the response to STARTTLS is
27577 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27578 session after a success response code, what happens is controlled by the
27579 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27580 delivery to this host is deferred, and other hosts (if available) are tried. If
27581 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27582 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27583 negotiation fails, Exim closes the current connection (because it is in an
27584 unknown state), opens a new one to the same host, and then tries the delivery
27585 unencrypted.
27586
27587 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27588 transport provide the client with a certificate, which is passed to the server
27589 if it requests it. If the server is Exim, it will request a certificate only if
27590 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27591
27592 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27593 specifies a collection of expected server certificates.
27594 These may be the system default set (depending on library version),
27595 a file or,
27596 depending on library version, a directory,
27597 must name a file or,
27598 for OpenSSL only (not GnuTLS), a directory.
27599 The client verifies the server's certificate
27600 against this collection, taking into account any revoked certificates that are
27601 in the list defined by &%tls_crl%&.
27602 Failure to verify fails the TLS connection unless either of the
27603 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27604
27605 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27606 certificate verification to the listed servers.  Verification either must
27607 or need not succeed respectively.
27608
27609 The &(smtp)& transport has two OCSP-related options:
27610 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27611 is requested and required for the connection to proceed.  The default
27612 value is empty.
27613 &%hosts_request_ocsp%&; a host-list for which (additionally)
27614 a Certificate Status is requested (but not necessarily verified).  The default
27615 value is "*" meaning that requests are made unless configured
27616 otherwise.
27617
27618 The host(s) should also be in &%hosts_require_tls%&, and
27619 &%tls_verify_certificates%& configured for the transport,
27620 for OCSP to be relevant.
27621
27622 If
27623 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27624 list of permitted cipher suites. If either of these checks fails, delivery to
27625 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27626 alternative hosts, if any.
27627
27628  &*Note*&:
27629 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27630 is operating as a client. Exim does not assume that a server certificate (set
27631 by the global options of the same name) should also be used when operating as a
27632 client.
27633
27634 .vindex "&$host$&"
27635 .vindex "&$host_address$&"
27636 All the TLS options in the &(smtp)& transport are expanded before use, with
27637 &$host$& and &$host_address$& containing the name and address of the server to
27638 which the client is connected. Forced failure of an expansion causes Exim to
27639 behave as if the relevant option were unset.
27640
27641 .vindex &$tls_out_bits$&
27642 .vindex &$tls_out_cipher$&
27643 .vindex &$tls_out_peerdn$&
27644 .vindex &$tls_out_sni$&
27645 Before an SMTP connection is established, the
27646 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27647 variables are emptied. (Until the first connection, they contain the values
27648 that were set when the message was received.) If STARTTLS is subsequently
27649 successfully obeyed, these variables are set to the relevant values for the
27650 outgoing connection.
27651
27652
27653
27654 .section "Use of TLS Server Name Indication" "SECTtlssni"
27655 .cindex "TLS" "Server Name Indication"
27656 .vindex "&$tls_in_sni$&"
27657 .oindex "&%tls_in_sni%&"
27658 With TLS1.0 or above, there is an extension mechanism by which extra
27659 information can be included at various points in the protocol.  One of these
27660 extensions, documented in RFC 6066 (and before that RFC 4366) is
27661 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27662 client in the initial handshake, so that the server can examine the servername
27663 within and possibly choose to use different certificates and keys (and more)
27664 for this session.
27665
27666 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27667 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27668 address.
27669
27670 With SMTP to MX, there are the same problems here as in choosing the identity
27671 against which to validate a certificate: you can't rely on insecure DNS to
27672 provide the identity which you then cryptographically verify.  So this will
27673 be of limited use in that environment.
27674
27675 With SMTP to Submission, there is a well-defined hostname which clients are
27676 connecting to and can validate certificates against.  Thus clients &*can*&
27677 choose to include this information in the TLS negotiation.  If this becomes
27678 wide-spread, then hosters can choose to present different certificates to
27679 different clients.  Or even negotiate different cipher suites.
27680
27681 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27682 if not empty, will be sent on a TLS session as part of the handshake.  There's
27683 nothing more to it.  Choosing a sensible value not derived insecurely is the
27684 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27685 for the lifetime of the client connection (including during authentication).
27686
27687 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27688 received from a client.
27689 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27690
27691 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27692 option (prior to expansion) then the following options will be re-expanded
27693 during TLS session handshake, to permit alternative values to be chosen:
27694
27695 .ilist
27696 .vindex "&%tls_certificate%&"
27697 &%tls_certificate%&
27698 .next
27699 .vindex "&%tls_crl%&"
27700 &%tls_crl%&
27701 .next
27702 .vindex "&%tls_privatekey%&"
27703 &%tls_privatekey%&
27704 .next
27705 .vindex "&%tls_verify_certificates%&"
27706 &%tls_verify_certificates%&
27707 .next
27708 .vindex "&%tls_ocsp_file%&"
27709 &%tls_ocsp_file%&
27710 .endlist
27711
27712 Great care should be taken to deal with matters of case, various injection
27713 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27714 can always be referenced; it is important to remember that &$tls_in_sni$& is
27715 arbitrary unverified data provided prior to authentication.
27716 Further, the initial certificate is loaded before SNI is arrived, so
27717 an expansion for &%tls_certificate%& must have a default which is used
27718 when &$tls_in_sni$& is empty.
27719
27720 The Exim developers are proceeding cautiously and so far no other TLS options
27721 are re-expanded.
27722
27723 When Exim is built against OpenSSL, OpenSSL must have been built with support
27724 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27725 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27726 see &`-servername`& in the output, then OpenSSL has support.
27727
27728 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27729 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27730 built, then you have SNI support).
27731
27732
27733
27734 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27735          "SECTmulmessam"
27736 .cindex "multiple SMTP deliveries with TLS"
27737 .cindex "TLS" "multiple message deliveries"
27738 .new
27739 Exim sends multiple messages down the same TCP/IP connection by starting up
27740 an entirely new delivery process for each message, passing the socket from
27741 one process to the next. This implementation does not fit well with the use
27742 of TLS, because there is quite a lot of state information associated with a TLS
27743 connection, not just a socket identification. Passing all the state information
27744 to a new process is not feasible. Consequently, for sending using TLS Exim
27745 starts an additional proxy process for handling the encryption, piping the
27746 unencrypted data stream from and to the delivery processes.
27747
27748 An older mode of operation can be enabled on a per-host basis by the
27749 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
27750 this list the proxy process descibed above is not used; instead Exim
27751 .wen
27752 shuts down an existing TLS session being run by the delivery process
27753 before passing the socket to a new process. The new process may then
27754 try to start a new TLS session, and if successful, may try to re-authenticate
27755 if AUTH is in use, before sending the next message.
27756
27757 The RFC is not clear as to whether or not an SMTP session continues in clear
27758 after TLS has been shut down, or whether TLS may be restarted again later, as
27759 just described. However, if the server is Exim, this shutdown and
27760 reinitialization works. It is not known which (if any) other servers operate
27761 successfully if the client closes a TLS session and continues with unencrypted
27762 SMTP, but there are certainly some that do not work. For such servers, Exim
27763 should not pass the socket to another process, because the failure of the
27764 subsequent attempt to use it would cause Exim to record a temporary host error,
27765 and delay other deliveries to that host.
27766
27767 To test for this case, Exim sends an EHLO command to the server after
27768 closing down the TLS session. If this fails in any way, the connection is
27769 closed instead of being passed to a new delivery process, but no retry
27770 information is recorded.
27771
27772 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27773 &(smtp)& transport to match those hosts for which Exim should not pass
27774 connections to new processes if TLS has been used.
27775
27776
27777
27778
27779 .section "Certificates and all that" "SECTcerandall"
27780 .cindex "certificate" "references to discussion"
27781 In order to understand fully how TLS works, you need to know about
27782 certificates, certificate signing, and certificate authorities. This is not the
27783 place to give a tutorial, especially as I do not know very much about it
27784 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27785 to Apache, currently at
27786 .display
27787 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27788 .endd
27789 Other parts of the &'modssl'& documentation are also helpful, and have
27790 links to further files.
27791 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27792 0-201-61598-3), contains both introductory and more in-depth descriptions.
27793 Some sample programs taken from the book are available from
27794 .display
27795 &url(http://www.rtfm.com/openssl-examples/)
27796 .endd
27797
27798
27799 .section "Certificate chains" "SECID186"
27800 The file named by &%tls_certificate%& may contain more than one
27801 certificate. This is useful in the case where the certificate that is being
27802 sent is validated by an intermediate certificate which the other end does
27803 not have. Multiple certificates must be in the correct order in the file.
27804 First the host's certificate itself, then the first intermediate
27805 certificate to validate the issuer of the host certificate, then the next
27806 intermediate certificate to validate the issuer of the first intermediate
27807 certificate, and so on, until finally (optionally) the root certificate.
27808 The root certificate must already be trusted by the recipient for
27809 validation to succeed, of course, but if it's not preinstalled, sending the
27810 root certificate along with the rest makes it available for the user to
27811 install if the receiving end is a client MUA that can interact with a user.
27812
27813 Note that certificates using MD5 are unlikely to work on today's Internet;
27814 even if your libraries allow loading them for use in Exim when acting as a
27815 server, increasingly clients will not accept such certificates.  The error
27816 diagnostics in such a case can be frustratingly vague.
27817
27818
27819
27820 .section "Self-signed certificates" "SECID187"
27821 .cindex "certificate" "self-signed"
27822 You can create a self-signed certificate using the &'req'& command provided
27823 with OpenSSL, like this:
27824 . ==== Do not shorten the duration here without reading and considering
27825 . ==== the text below.  Please leave it at 9999 days.
27826 .code
27827 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27828             -days 9999 -nodes
27829 .endd
27830 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27831 delimited and so can be identified independently. The &%-days%& option
27832 specifies a period for which the certificate is valid. The &%-nodes%& option is
27833 important: if you do not set it, the key is encrypted with a passphrase
27834 that you are prompted for, and any use that is made of the key causes more
27835 prompting for the passphrase. This is not helpful if you are going to use
27836 this certificate and key in an MTA, where prompting is not possible.
27837
27838 . ==== I expect to still be working 26 years from now.  The less technical
27839 . ==== debt I create, in terms of storing up trouble for my later years, the
27840 . ==== happier I will be then.  We really have reached the point where we
27841 . ==== should start, at the very least, provoking thought and making folks
27842 . ==== pause before proceeding, instead of leaving all the fixes until two
27843 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27844 . ==== -pdp, 2012
27845 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27846 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27847 the above command might produce a date in the past.  Think carefully about
27848 the lifetime of the systems you're deploying, and either reduce the duration
27849 of the certificate or reconsider your platform deployment.  (At time of
27850 writing, reducing the duration is the most likely choice, but the inexorable
27851 progression of time takes us steadily towards an era where this will not
27852 be a sensible resolution).
27853
27854 A self-signed certificate made in this way is sufficient for testing, and
27855 may be adequate for all your requirements if you are mainly interested in
27856 encrypting transfers, and not in secure identification.
27857
27858 However, many clients require that the certificate presented by the server be a
27859 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27860 certificate. In this situation, the self-signed certificate described above
27861 must be installed on the client host as a trusted root &'certification
27862 authority'& (CA), and the certificate used by Exim must be a user certificate
27863 signed with that self-signed certificate.
27864
27865 For information on creating self-signed CA certificates and using them to sign
27866 user certificates, see the &'General implementation overview'& chapter of the
27867 Open-source PKI book, available online at
27868 &url(http://ospkibook.sourceforge.net/).
27869 .ecindex IIDencsmtp1
27870 .ecindex IIDencsmtp2
27871
27872
27873
27874 . ////////////////////////////////////////////////////////////////////////////
27875 . ////////////////////////////////////////////////////////////////////////////
27876
27877 .chapter "Access control lists" "CHAPACL"
27878 .scindex IIDacl "&ACL;" "description"
27879 .cindex "control of incoming mail"
27880 .cindex "message" "controlling incoming"
27881 .cindex "policy control" "access control lists"
27882 Access Control Lists (ACLs) are defined in a separate section of the run time
27883 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27884 name, terminated by a colon. Here is a complete ACL section that contains just
27885 one very small ACL:
27886 .code
27887 begin acl
27888 small_acl:
27889   accept   hosts = one.host.only
27890 .endd
27891 You can have as many lists as you like in the ACL section, and the order in
27892 which they appear does not matter. The lists are self-terminating.
27893
27894 The majority of ACLs are used to control Exim's behaviour when it receives
27895 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27896 when a local process submits a message using SMTP by specifying the &%-bs%&
27897 option. The most common use is for controlling which recipients are accepted
27898 in incoming messages. In addition, you can define an ACL that is used to check
27899 local non-SMTP messages. The default configuration file contains an example of
27900 a realistic ACL for checking RCPT commands. This is discussed in chapter
27901 &<<CHAPdefconfil>>&.
27902
27903
27904 .section "Testing ACLs" "SECID188"
27905 The &%-bh%& command line option provides a way of testing your ACL
27906 configuration locally by running a fake SMTP session with which you interact.
27907
27908
27909 .section "Specifying when ACLs are used" "SECID189"
27910 .cindex "&ACL;" "options for specifying"
27911 In order to cause an ACL to be used, you have to name it in one of the relevant
27912 options in the main part of the configuration. These options are:
27913 .cindex "AUTH" "ACL for"
27914 .cindex "DATA" "ACLs for"
27915 .cindex "ETRN" "ACL for"
27916 .cindex "EXPN" "ACL for"
27917 .cindex "HELO" "ACL for"
27918 .cindex "EHLO" "ACL for"
27919 .cindex "DKIM" "ACL for"
27920 .cindex "MAIL" "ACL for"
27921 .cindex "QUIT, ACL for"
27922 .cindex "RCPT" "ACL for"
27923 .cindex "STARTTLS, ACL for"
27924 .cindex "VRFY" "ACL for"
27925 .cindex "SMTP" "connection, ACL for"
27926 .cindex "non-SMTP messages" "ACLs for"
27927 .cindex "MIME content scanning" "ACL for"
27928 .cindex "PRDR" "ACL for"
27929
27930 .table2 140pt
27931 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27932 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27933 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27934 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27935 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27936 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27937 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27938 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27939 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27940 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27941 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27942 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27943 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27944 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27945 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27946 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27947 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27948 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27949 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27950 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27951 .endtable
27952
27953 For example, if you set
27954 .code
27955 acl_smtp_rcpt = small_acl
27956 .endd
27957 the little ACL defined above is used whenever Exim receives a RCPT command
27958 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27959 done when RCPT commands arrive. A rejection of RCPT should cause the
27960 sending MTA to give up on the recipient address contained in the RCPT
27961 command, whereas rejection at other times may cause the client MTA to keep on
27962 trying to deliver the message. It is therefore recommended that you do as much
27963 testing as possible at RCPT time.
27964
27965
27966 .section "The non-SMTP ACLs" "SECID190"
27967 .cindex "non-SMTP messages" "ACLs for"
27968 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27969 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27970 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27971 the state of the SMTP connection such as encryption and authentication) are not
27972 relevant and are forbidden in these ACLs. However, the sender and recipients
27973 are known, so the &%senders%& and &%sender_domains%& conditions and the
27974 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27975 &$authenticated_sender$& are also available. You can specify added header lines
27976 in any of these ACLs.
27977
27978 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27979 non-SMTP message, before any of the message has been read. (This is the
27980 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27981 batched SMTP input, it runs after the DATA command has been reached. The
27982 result of this ACL is ignored; it cannot be used to reject a message. If you
27983 really need to, you could set a value in an ACL variable here and reject based
27984 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27985 controls, and in particular, it can be used to set
27986 .code
27987 control = suppress_local_fixups
27988 .endd
27989 This cannot be used in the other non-SMTP ACLs because by the time they are
27990 run, it is too late.
27991
27992 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27993 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27994
27995 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27996 kind of rejection is treated as permanent, because there is no way of sending a
27997 temporary error for these kinds of message.
27998
27999
28000 .section "The SMTP connect ACL" "SECID191"
28001 .cindex "SMTP" "connection, ACL for"
28002 .oindex &%smtp_banner%&
28003 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
28004 session, after the test specified by &%host_reject_connection%& (which is now
28005 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
28006 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
28007 the message override the banner message that is otherwise specified by the
28008 &%smtp_banner%& option.
28009
28010
28011 .section "The EHLO/HELO ACL" "SECID192"
28012 .cindex "EHLO" "ACL for"
28013 .cindex "HELO" "ACL for"
28014 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
28015 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
28016 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
28017 Note that a client may issue more than one EHLO or HELO command in an SMTP
28018 session, and indeed is required to issue a new EHLO or HELO after successfully
28019 setting up encryption following a STARTTLS command.
28020
28021 Note also that a deny neither forces the client to go away nor means that
28022 mail will be refused on the connection.  Consider checking for
28023 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
28024
28025 If the command is accepted by an &%accept%& verb that has a &%message%&
28026 modifier, the message may not contain more than one line (it will be truncated
28027 at the first newline and a panic logged if it does). Such a message cannot
28028 affect the EHLO options that are listed on the second and subsequent lines of
28029 an EHLO response.
28030
28031
28032 .section "The DATA ACLs" "SECID193"
28033 .cindex "DATA" "ACLs for"
28034 Two ACLs are associated with the DATA command, because it is two-stage
28035 command, with two responses being sent to the client.
28036 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
28037 is obeyed. This gives you control after all the RCPT commands, but before
28038 the message itself is received. It offers the opportunity to give a negative
28039 response to the DATA command before the data is transmitted. Header lines
28040 added by MAIL or RCPT ACLs are not visible at this time, but any that
28041 are defined here are visible when the &%acl_smtp_data%& ACL is run.
28042
28043 You cannot test the contents of the message, for example, to verify addresses
28044 in the headers, at RCPT time or when the DATA command is received. Such
28045 tests have to appear in the ACL that is run after the message itself has been
28046 received, before the final response to the DATA command is sent. This is
28047 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
28048 associated with the DATA command.
28049
28050 .cindex CHUNKING "BDAT command"
28051 .cindex BDAT "SMTP command"
28052 .cindex "RFC 3030" CHUNKING
28053 If CHUNKING was advertised and a BDAT command sequence is received,
28054 the &%acl_smtp_predata%& ACL is not run.
28055 . XXX why not?  It should be possible, for the first BDAT.
28056 The &%acl_smtp_data%& is run after the last BDAT command and all of
28057 the data specified is received.
28058
28059 For both of these ACLs, it is not possible to reject individual recipients. An
28060 error response rejects the entire message. Unfortunately, it is known that some
28061 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
28062 before or after the data) correctly &-- they keep the message on their queues
28063 and try again later, but that is their problem, though it does waste some of
28064 your resources.
28065
28066 The &%acl_smtp_data%& ACL is run after
28067 the &%acl_smtp_data_prdr%&,
28068 the &%acl_smtp_dkim%&
28069 and the &%acl_smtp_mime%& ACLs.
28070
28071 .section "The SMTP DKIM ACL" "SECTDKIMACL"
28072 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
28073 enabled (which is the default).
28074
28075 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
28076 received, and is executed for each DKIM signature found in a message.  If not
28077 otherwise specified, the default action is to accept.
28078
28079 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
28080
28081 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
28082
28083
28084 .section "The SMTP MIME ACL" "SECID194"
28085 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
28086 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28087
28088 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28089
28090
28091 .section "The SMTP PRDR ACL" "SECTPRDRACL"
28092 .cindex "PRDR" "ACL for"
28093 .oindex "&%prdr_enable%&"
28094 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
28095 with PRDR support enabled (which is the default).
28096 It becomes active only when the PRDR feature is negotiated between
28097 client and server for a message, and more than one recipient
28098 has been accepted.
28099
28100 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
28101 has been received, and is executed once for each recipient of the message
28102 with &$local_part$& and &$domain$& valid.
28103 The test may accept, defer or deny for individual recipients.
28104 The &%acl_smtp_data%& will still be called after this ACL and
28105 can reject the message overall, even if this ACL has accepted it
28106 for some or all recipients.
28107
28108 PRDR may be used to support per-user content filtering.  Without it
28109 one must defer any recipient after the first that has a different
28110 content-filter configuration.  With PRDR, the RCPT-time check
28111 .cindex "PRDR" "variable for"
28112 for this can be disabled when the variable &$prdr_requested$&
28113 is &"yes"&.
28114 Any required difference in behaviour of the main DATA-time
28115 ACL should however depend on the PRDR-time ACL having run, as Exim
28116 will avoid doing so in some situations (e.g.  single-recipient mails).
28117
28118 See also the &%prdr_enable%& global option
28119 and the &%hosts_try_prdr%& smtp transport option.
28120
28121 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28122 If the ACL is not defined, processing completes as if
28123 the feature was not requested by the client.
28124
28125 .section "The QUIT ACL" "SECTQUITACL"
28126 .cindex "QUIT, ACL for"
28127 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
28128 does not affect the response code to QUIT, which is always 221. Thus, the ACL
28129 does not in fact control any access.
28130 For this reason, it may only accept
28131 or warn as its final result.
28132
28133 This ACL can be used for tasks such as custom logging at the end of an SMTP
28134 session. For example, you can use ACL variables in other ACLs to count
28135 messages, recipients, etc., and log the totals at QUIT time using one or
28136 more &%logwrite%& modifiers on a &%warn%& verb.
28137
28138 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
28139 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
28140
28141 You do not need to have a final &%accept%&, but if you do, you can use a
28142 &%message%& modifier to specify custom text that is sent as part of the 221
28143 response to QUIT.
28144
28145 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
28146 failure (for example, failure to open a log file, or when Exim is bombing out
28147 because it has detected an unrecoverable error), all SMTP commands from the
28148 client are given temporary error responses until QUIT is received or the
28149 connection is closed. In these special cases, the QUIT ACL does not run.
28150
28151
28152 .section "The not-QUIT ACL" "SECTNOTQUITACL"
28153 .vindex &$acl_smtp_notquit$&
28154 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
28155 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
28156 trouble, such as being unable to write to its log files, this ACL is not run,
28157 because it might try to do things (such as write to log files) that make the
28158 situation even worse.
28159
28160 Like the QUIT ACL, this ACL is provided to make it possible to do customized
28161 logging or to gather statistics, and its outcome is ignored. The &%delay%&
28162 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
28163 and &%warn%&.
28164
28165 .vindex &$smtp_notquit_reason$&
28166 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
28167 to a string that indicates the reason for the termination of the SMTP
28168 connection. The possible values are:
28169 .table2
28170 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
28171 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
28172 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
28173 .irow &`connection-lost`&          "The SMTP connection has been lost"
28174 .irow &`data-timeout`&             "Timeout while reading message data"
28175 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
28176 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
28177 .irow &`signal-exit`&              "SIGTERM or SIGINT"
28178 .irow &`synchronization-error`&    "SMTP synchronization error"
28179 .irow &`tls-failed`&               "TLS failed to start"
28180 .endtable
28181 In most cases when an SMTP connection is closed without having received QUIT,
28182 Exim sends an SMTP response message before actually closing the connection.
28183 With the exception of the &`acl-drop`& case, the default message can be
28184 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
28185 &%drop%& verb in another ACL, it is the message from the other ACL that is
28186 used.
28187
28188
28189 .section "Finding an ACL to use" "SECID195"
28190 .cindex "&ACL;" "finding which to use"
28191 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
28192 you can use different ACLs in different circumstances. For example,
28193 .code
28194 acl_smtp_rcpt = ${if ={25}{$interface_port} \
28195                      {acl_check_rcpt} {acl_check_rcpt_submit} }
28196 .endd
28197 In the default configuration file there are some example settings for
28198 providing an RFC 4409 message submission service on port 587 and a
28199 non-standard &"smtps"& service on port 465. You can use a string
28200 expansion like this to choose an ACL for MUAs on these ports which is
28201 more appropriate for this purpose than the default ACL on port 25.
28202
28203 The expanded string does not have to be the name of an ACL in the
28204 configuration file; there are other possibilities. Having expanded the
28205 string, Exim searches for an ACL as follows:
28206
28207 .ilist
28208 If the string begins with a slash, Exim uses it as a file name, and reads its
28209 contents as an ACL. The lines are processed in the same way as lines in the
28210 Exim configuration file. In particular, continuation lines are supported, blank
28211 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
28212 If the file does not exist or cannot be read, an error occurs (typically
28213 causing a temporary failure of whatever caused the ACL to be run). For example:
28214 .code
28215 acl_smtp_data = /etc/acls/\
28216   ${lookup{$sender_host_address}lsearch\
28217   {/etc/acllist}{$value}{default}}
28218 .endd
28219 This looks up an ACL file to use on the basis of the host's IP address, falling
28220 back to a default if the lookup fails. If an ACL is successfully read from a
28221 file, it is retained in memory for the duration of the Exim process, so that it
28222 can be re-used without having to re-read the file.
28223 .next
28224 If the string does not start with a slash, and does not contain any spaces,
28225 Exim searches the ACL section of the configuration for an ACL whose name
28226 matches the string.
28227 .next
28228 If no named ACL is found, or if the string contains spaces, Exim parses
28229 the string as an inline ACL. This can save typing in cases where you just
28230 want to have something like
28231 .code
28232 acl_smtp_vrfy = accept
28233 .endd
28234 in order to allow free use of the VRFY command. Such a string may contain
28235 newlines; it is processed in the same way as an ACL that is read from a file.
28236 .endlist
28237
28238
28239
28240
28241 .section "ACL return codes" "SECID196"
28242 .cindex "&ACL;" "return codes"
28243 Except for the QUIT ACL, which does not affect the SMTP return code (see
28244 section &<<SECTQUITACL>>& above), the result of running an ACL is either
28245 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
28246 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
28247 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
28248 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28249 This also causes a 4&'xx'& return code.
28250
28251 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28252 &"deny"&, because there is no mechanism for passing temporary errors to the
28253 submitters of non-SMTP messages.
28254
28255
28256 ACLs that are relevant to message reception may also return &"discard"&. This
28257 has the effect of &"accept"&, but causes either the entire message or an
28258 individual recipient address to be discarded. In other words, it is a
28259 blackholing facility. Use it with care.
28260
28261 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
28262 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
28263 RCPT ACL is to discard just the one recipient address. If there are no
28264 recipients left when the message's data is received, the DATA ACL is not
28265 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
28266 remaining recipients. The &"discard"& return is not permitted for the
28267 &%acl_smtp_predata%& ACL.
28268
28269 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
28270 is done on the address and the result determines the SMTP response.
28271
28272
28273 .cindex "&[local_scan()]& function" "when all recipients discarded"
28274 The &[local_scan()]& function is always run, even if there are no remaining
28275 recipients; it may create new recipients.
28276
28277
28278
28279 .section "Unset ACL options" "SECID197"
28280 .cindex "&ACL;" "unset options"
28281 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
28282 all the same. &*Note*&: These defaults apply only when the relevant ACL is
28283 not defined at all. For any defined ACL, the default action when control
28284 reaches the end of the ACL statements is &"deny"&.
28285
28286 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
28287 these two are ACLs that are used only for their side effects. They cannot be
28288 used to accept or reject anything.
28289
28290 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
28291 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
28292 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
28293 when the ACL is not defined is &"accept"&.
28294
28295 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
28296 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
28297 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28298 messages over an SMTP connection. For an example, see the ACL in the default
28299 configuration file.
28300
28301
28302
28303
28304 .section "Data for message ACLs" "SECID198"
28305 .cindex "&ACL;" "data for message ACL"
28306 .vindex &$domain$&
28307 .vindex &$local_part$&
28308 .vindex &$sender_address$&
28309 .vindex &$sender_host_address$&
28310 .vindex &$smtp_command$&
28311 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28312 that contain information about the host and the message's sender (for example,
28313 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28314 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28315 &$local_part$& are set from the argument address. The entire SMTP command
28316 is available in &$smtp_command$&.
28317
28318 When an ACL for the AUTH parameter of MAIL is running, the variables that
28319 contain information about the host are set, but &$sender_address$& is not yet
28320 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28321 how it is used.
28322
28323 .vindex "&$message_size$&"
28324 The &$message_size$& variable is set to the value of the SIZE parameter on
28325 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28326 that parameter is not given. The value is updated to the true message size by
28327 the time the final DATA ACL is run (after the message data has been
28328 received).
28329
28330 .vindex "&$rcpt_count$&"
28331 .vindex "&$recipients_count$&"
28332 The &$rcpt_count$& variable increases by one for each RCPT command received.
28333 The &$recipients_count$& variable increases by one each time a RCPT command is
28334 accepted, so while an ACL for RCPT is being processed, it contains the number
28335 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28336 &$rcpt_count$& contains the total number of RCPT commands, and
28337 &$recipients_count$& contains the total number of accepted recipients.
28338
28339
28340
28341
28342
28343 .section "Data for non-message ACLs" "SECTdatfornon"
28344 .cindex "&ACL;" "data for non-message ACL"
28345 .vindex &$smtp_command_argument$&
28346 .vindex &$smtp_command$&
28347 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28348 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28349 and the entire SMTP command is available in &$smtp_command$&.
28350 These variables can be tested using a &%condition%& condition. For example,
28351 here is an ACL for use with AUTH, which insists that either the session is
28352 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28353 does not permit authentication methods that use cleartext passwords on
28354 unencrypted connections.
28355 .code
28356 acl_check_auth:
28357   accept encrypted = *
28358   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28359                      {CRAM-MD5}}
28360   deny   message   = TLS encryption or CRAM-MD5 required
28361 .endd
28362 (Another way of applying this restriction is to arrange for the authenticators
28363 that use cleartext passwords not to be advertised when the connection is not
28364 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28365 option to do this.)
28366
28367
28368
28369 .section "Format of an ACL" "SECID199"
28370 .cindex "&ACL;" "format of"
28371 .cindex "&ACL;" "verbs, definition of"
28372 An individual ACL consists of a number of statements. Each statement starts
28373 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28374 Modifiers can change the way the verb operates, define error and log messages,
28375 set variables, insert delays, and vary the processing of accepted messages.
28376
28377 If all the conditions are met, the verb is obeyed. The same condition may be
28378 used (with different arguments) more than once in the same statement. This
28379 provides a means of specifying an &"and"& conjunction between conditions. For
28380 example:
28381 .code
28382 deny  dnslists = list1.example
28383       dnslists = list2.example
28384 .endd
28385 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28386 the conditions and modifiers when it reaches a condition that fails. What
28387 happens then depends on the verb (and in one case, on a special modifier). Not
28388 all the conditions make sense at every testing point. For example, you cannot
28389 test a sender address in the ACL that is run for a VRFY command.
28390
28391
28392 .section "ACL verbs" "SECID200"
28393 The ACL verbs are as follows:
28394
28395 .ilist
28396 .cindex "&%accept%& ACL verb"
28397 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28398 of the conditions are not met, what happens depends on whether &%endpass%&
28399 appears among the conditions (for syntax see below). If the failing condition
28400 is before &%endpass%&, control is passed to the next ACL statement; if it is
28401 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28402 check a RCPT command:
28403 .code
28404 accept domains = +local_domains
28405        endpass
28406        verify = recipient
28407 .endd
28408 If the recipient domain does not match the &%domains%& condition, control
28409 passes to the next statement. If it does match, the recipient is verified, and
28410 the command is accepted if verification succeeds. However, if verification
28411 fails, the ACL yields &"deny"&, because the failing condition is after
28412 &%endpass%&.
28413
28414 The &%endpass%& feature has turned out to be confusing to many people, so its
28415 use is not recommended nowadays. It is always possible to rewrite an ACL so
28416 that &%endpass%& is not needed, and it is no longer used in the default
28417 configuration.
28418
28419 .cindex "&%message%& ACL modifier" "with &%accept%&"
28420 If a &%message%& modifier appears on an &%accept%& statement, its action
28421 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28422 (when an &%accept%& verb either accepts or passes control to the next
28423 statement), &%message%& can be used to vary the message that is sent when an
28424 SMTP command is accepted. For example, in a RCPT ACL you could have:
28425 .display
28426 &`accept  `&<&'some conditions'&>
28427 &`        message = OK, I will allow you through today`&
28428 .endd
28429 You can specify an SMTP response code, optionally followed by an &"extended
28430 response code"& at the start of the message, but the first digit must be the
28431 same as would be sent by default, which is 2 for an &%accept%& verb.
28432
28433 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28434 an error message that is used when access is denied. This behaviour is retained
28435 for backward compatibility, but current &"best practice"& is to avoid the use
28436 of &%endpass%&.
28437
28438
28439 .next
28440 .cindex "&%defer%& ACL verb"
28441 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28442 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28443 &%defer%& is the same as &%deny%&, because there is no way of sending a
28444 temporary error. For a RCPT command, &%defer%& is much the same as using a
28445 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28446 be used in any ACL, and even for a recipient it might be a simpler approach.
28447
28448
28449 .next
28450 .cindex "&%deny%& ACL verb"
28451 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28452 the conditions are not met, control is passed to the next ACL statement. For
28453 example,
28454 .code
28455 deny dnslists = blackholes.mail-abuse.org
28456 .endd
28457 rejects commands from hosts that are on a DNS black list.
28458
28459
28460 .next
28461 .cindex "&%discard%& ACL verb"
28462 &%discard%&: This verb behaves like &%accept%&, except that it returns
28463 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28464 that are concerned with receiving messages. When all the conditions are true,
28465 the sending entity receives a &"success"& response. However, &%discard%& causes
28466 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28467 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28468 message's recipients are discarded. Recipients that are discarded before DATA
28469 do not appear in the log line when the &%received_recipients%& log selector is set.
28470
28471 If the &%log_message%& modifier is set when &%discard%& operates,
28472 its contents are added to the line that is automatically written to the log.
28473 The &%message%& modifier operates exactly as it does for &%accept%&.
28474
28475
28476 .next
28477 .cindex "&%drop%& ACL verb"
28478 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28479 forcibly closed after the 5&'xx'& error message has been sent. For example:
28480 .code
28481 drop   message   = I don't take more than 20 RCPTs
28482        condition = ${if > {$rcpt_count}{20}}
28483 .endd
28484 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28485 The connection is always dropped after sending a 550 response.
28486
28487 .next
28488 .cindex "&%require%& ACL verb"
28489 &%require%&: If all the conditions are met, control is passed to the next ACL
28490 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28491 example, when checking a RCPT command,
28492 .code
28493 require message = Sender did not verify
28494         verify  = sender
28495 .endd
28496 passes control to subsequent statements only if the message's sender can be
28497 verified. Otherwise, it rejects the command. Note the positioning of the
28498 &%message%& modifier, before the &%verify%& condition. The reason for this is
28499 discussed in section &<<SECTcondmodproc>>&.
28500
28501 .next
28502 .cindex "&%warn%& ACL verb"
28503 &%warn%&: If all the conditions are true, a line specified by the
28504 &%log_message%& modifier is written to Exim's main log. Control always passes
28505 to the next ACL statement. If any condition is false, the log line is not
28506 written. If an identical log line is requested several times in the same
28507 message, only one copy is actually written to the log. If you want to force
28508 duplicates to be written, use the &%logwrite%& modifier instead.
28509
28510 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28511 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28512 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28513 first failing condition. There is more about adding header lines in section
28514 &<<SECTaddheadacl>>&.
28515
28516 If any condition on a &%warn%& statement cannot be completed (that is, there is
28517 some sort of defer), the log line specified by &%log_message%& is not written.
28518 This does not include the case of a forced failure from a lookup, which
28519 is considered to be a successful completion. After a defer, no further
28520 conditions or modifiers in the &%warn%& statement are processed. The incident
28521 is logged, and the ACL continues to be processed, from the next statement
28522 onwards.
28523
28524
28525 .vindex "&$acl_verify_message$&"
28526 When one of the &%warn%& conditions is an address verification that fails, the
28527 text of the verification failure message is in &$acl_verify_message$&. If you
28528 want this logged, you must set it up explicitly. For example:
28529 .code
28530 warn   !verify = sender
28531        log_message = sender verify failed: $acl_verify_message
28532 .endd
28533 .endlist
28534
28535 At the end of each ACL there is an implicit unconditional &%deny%&.
28536
28537 As you can see from the examples above, the conditions and modifiers are
28538 written one to a line, with the first one on the same line as the verb, and
28539 subsequent ones on following lines. If you have a very long condition, you can
28540 continue it onto several physical lines by the usual backslash continuation
28541 mechanism. It is conventional to align the conditions vertically.
28542
28543
28544
28545 .section "ACL variables" "SECTaclvariables"
28546 .cindex "&ACL;" "variables"
28547 There are some special variables that can be set during ACL processing. They
28548 can be used to pass information between different ACLs, different invocations
28549 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28550 transports, and filters that are used to deliver a message. The names of these
28551 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28552 an underscore, but the remainder of the name can be any sequence of
28553 alphanumeric characters and underscores that you choose. There is no limit on
28554 the number of ACL variables. The two sets act as follows:
28555 .ilist
28556 The values of those variables whose names begin with &$acl_c$& persist
28557 throughout an SMTP connection. They are never reset. Thus, a value that is set
28558 while receiving one message is still available when receiving the next message
28559 on the same SMTP connection.
28560 .next
28561 The values of those variables whose names begin with &$acl_m$& persist only
28562 while a message is being received. They are reset afterwards. They are also
28563 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28564 .endlist
28565
28566 When a message is accepted, the current values of all the ACL variables are
28567 preserved with the message and are subsequently made available at delivery
28568 time. The ACL variables are set by a modifier called &%set%&. For example:
28569 .code
28570 accept hosts = whatever
28571        set acl_m4 = some value
28572 accept authenticated = *
28573        set acl_c_auth = yes
28574 .endd
28575 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28576 be set. If you want to set a variable without taking any action, you can use a
28577 &%warn%& verb without any other modifiers or conditions.
28578
28579 .oindex &%strict_acl_vars%&
28580 What happens if a syntactically valid but undefined ACL variable is
28581 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28582 false (the default), an empty string is substituted; if it is true, an
28583 error is generated.
28584
28585 Versions of Exim before 4.64 have a limited set of numbered variables, but
28586 their names are compatible, so there is no problem with upgrading.
28587
28588
28589 .section "Condition and modifier processing" "SECTcondmodproc"
28590 .cindex "&ACL;" "conditions; processing"
28591 .cindex "&ACL;" "modifiers; processing"
28592 An exclamation mark preceding a condition negates its result. For example:
28593 .code
28594 deny   domains = *.dom.example
28595       !verify  = recipient
28596 .endd
28597 causes the ACL to return &"deny"& if the recipient domain ends in
28598 &'dom.example'& and the recipient address cannot be verified. Sometimes
28599 negation can be used on the right-hand side of a condition. For example, these
28600 two statements are equivalent:
28601 .code
28602 deny  hosts = !192.168.3.4
28603 deny !hosts =  192.168.3.4
28604 .endd
28605 However, for many conditions (&%verify%& being a good example), only left-hand
28606 side negation of the whole condition is possible.
28607
28608 The arguments of conditions and modifiers are expanded. A forced failure
28609 of an expansion causes a condition to be ignored, that is, it behaves as if the
28610 condition is true. Consider these two statements:
28611 .code
28612 accept  senders = ${lookup{$host_name}lsearch\
28613                   {/some/file}{$value}fail}
28614 accept  senders = ${lookup{$host_name}lsearch\
28615                   {/some/file}{$value}{}}
28616 .endd
28617 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28618 the returned list is searched, but if the lookup fails the behaviour is
28619 different in the two cases. The &%fail%& in the first statement causes the
28620 condition to be ignored, leaving no further conditions. The &%accept%& verb
28621 therefore succeeds. The second statement, however, generates an empty list when
28622 the lookup fails. No sender can match an empty list, so the condition fails,
28623 and therefore the &%accept%& also fails.
28624
28625 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28626 specify actions that are taken as the conditions for a statement are checked;
28627 others specify text for messages that are used when access is denied or a
28628 warning is generated. The &%control%& modifier affects the way an incoming
28629 message is handled.
28630
28631 The positioning of the modifiers in an ACL statement is important, because the
28632 processing of a verb ceases as soon as its outcome is known. Only those
28633 modifiers that have already been encountered will take effect. For example,
28634 consider this use of the &%message%& modifier:
28635 .code
28636 require message = Can't verify sender
28637         verify  = sender
28638         message = Can't verify recipient
28639         verify  = recipient
28640         message = This message cannot be used
28641 .endd
28642 If sender verification fails, Exim knows that the result of the statement is
28643 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28644 so its text is used as the error message. If sender verification succeeds, but
28645 recipient verification fails, the second message is used. If recipient
28646 verification succeeds, the third message becomes &"current"&, but is never used
28647 because there are no more conditions to cause failure.
28648
28649 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28650 modifier that is used, because all the conditions must be true for rejection to
28651 happen. Specifying more than one &%message%& modifier does not make sense, and
28652 the message can even be specified after all the conditions. For example:
28653 .code
28654 deny   hosts = ...
28655       !senders = *@my.domain.example
28656        message = Invalid sender from client host
28657 .endd
28658 The &"deny"& result does not happen until the end of the statement is reached,
28659 by which time Exim has set up the message.
28660
28661
28662
28663 .section "ACL modifiers" "SECTACLmodi"
28664 .cindex "&ACL;" "modifiers; list of"
28665 The ACL modifiers are as follows:
28666
28667 .vlist
28668 .vitem &*add_header*&&~=&~<&'text'&>
28669 This modifier specifies one or more header lines that are to be added to an
28670 incoming message, assuming, of course, that the message is ultimately
28671 accepted. For details, see section &<<SECTaddheadacl>>&.
28672
28673 .vitem &*continue*&&~=&~<&'text'&>
28674 .cindex "&%continue%& ACL modifier"
28675 .cindex "database" "updating in ACL"
28676 This modifier does nothing of itself, and processing of the ACL always
28677 continues with the next condition or modifier. The value of &%continue%& is in
28678 the side effects of expanding its argument. Typically this could be used to
28679 update a database. It is really just a syntactic tidiness, to avoid having to
28680 write rather ugly lines like this:
28681 .display
28682 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28683 .endd
28684 Instead, all you need is
28685 .display
28686 &`continue = `&<&'some expansion'&>
28687 .endd
28688
28689 .vitem &*control*&&~=&~<&'text'&>
28690 .cindex "&%control%& ACL modifier"
28691 This modifier affects the subsequent processing of the SMTP connection or of an
28692 incoming message that is accepted. The effect of the first type of control
28693 lasts for the duration of the connection, whereas the effect of the second type
28694 lasts only until the current message has been received. The message-specific
28695 controls always apply to the whole message, not to individual recipients,
28696 even if the &%control%& modifier appears in a RCPT ACL.
28697
28698 As there are now quite a few controls that can be applied, they are described
28699 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28700 in several different ways. For example:
28701
28702 . ==== As this is a nested list, any displays it contains must be indented
28703 . ==== as otherwise they are too far to the left. That comment applies only
28704 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28705 . ==== way.
28706
28707 .ilist
28708 It can be at the end of an &%accept%& statement:
28709 .code
28710     accept  ...some conditions
28711             control = queue_only
28712 .endd
28713 In this case, the control is applied when this statement yields &"accept"&, in
28714 other words, when the conditions are all true.
28715
28716 .next
28717 It can be in the middle of an &%accept%& statement:
28718 .code
28719     accept  ...some conditions...
28720             control = queue_only
28721             ...some more conditions...
28722 .endd
28723 If the first set of conditions are true, the control is applied, even if the
28724 statement does not accept because one of the second set of conditions is false.
28725 In this case, some subsequent statement must yield &"accept"& for the control
28726 to be relevant.
28727
28728 .next
28729 It can be used with &%warn%& to apply the control, leaving the
28730 decision about accepting or denying to a subsequent verb. For
28731 example:
28732 .code
28733     warn    ...some conditions...
28734             control = freeze
28735     accept  ...
28736 .endd
28737 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28738 &%logwrite%&, so it does not add anything to the message and does not write a
28739 log entry.
28740
28741 .next
28742 If you want to apply a control unconditionally, you can use it with a
28743 &%require%& verb. For example:
28744 .code
28745     require  control = no_multiline_responses
28746 .endd
28747 .endlist
28748
28749 .vitem &*delay*&&~=&~<&'time'&>
28750 .cindex "&%delay%& ACL modifier"
28751 .oindex "&%-bh%&"
28752 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28753 the time interval before proceeding. However, when testing Exim using the
28754 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28755 output instead). The time is given in the usual Exim notation, and the delay
28756 happens as soon as the modifier is processed. In an SMTP session, pending
28757 output is flushed before the delay is imposed.
28758
28759 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28760 example:
28761 .code
28762 deny    ...some conditions...
28763         delay = 30s
28764 .endd
28765 The delay happens if all the conditions are true, before the statement returns
28766 &"deny"&. Compare this with:
28767 .code
28768 deny    delay = 30s
28769         ...some conditions...
28770 .endd
28771 which waits for 30s before processing the conditions. The &%delay%& modifier
28772 can also be used with &%warn%& and together with &%control%&:
28773 .code
28774 warn    ...some conditions...
28775         delay = 2m
28776         control = freeze
28777 accept  ...
28778 .endd
28779
28780 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28781 responses to several commands are no longer buffered and sent in one packet (as
28782 they would normally be) because all output is flushed before imposing the
28783 delay. This optimization is disabled so that a number of small delays do not
28784 appear to the client as one large aggregated delay that might provoke an
28785 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28786 using a &%control%& modifier to set &%no_delay_flush%&.
28787
28788
28789 .vitem &*endpass*&
28790 .cindex "&%endpass%& ACL modifier"
28791 This modifier, which has no argument, is recognized only in &%accept%& and
28792 &%discard%& statements. It marks the boundary between the conditions whose
28793 failure causes control to pass to the next statement, and the conditions whose
28794 failure causes the ACL to return &"deny"&. This concept has proved to be
28795 confusing to some people, so the use of &%endpass%& is no longer recommended as
28796 &"best practice"&. See the description of &%accept%& above for more details.
28797
28798
28799 .vitem &*log_message*&&~=&~<&'text'&>
28800 .cindex "&%log_message%& ACL modifier"
28801 This modifier sets up a message that is used as part of the log message if the
28802 ACL denies access or a &%warn%& statement's conditions are true. For example:
28803 .code
28804 require log_message = wrong cipher suite $tls_in_cipher
28805         encrypted   = DES-CBC3-SHA
28806 .endd
28807 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28808 example:
28809 .display
28810 &`discard `&<&'some conditions'&>
28811 &`        log_message = Discarded $local_part@$domain because...`&
28812 .endd
28813 When access is denied, &%log_message%& adds to any underlying error message
28814 that may exist because of a condition failure. For example, while verifying a
28815 recipient address, a &':fail:'& redirection might have already set up a
28816 message.
28817
28818 The message may be defined before the conditions to which it applies, because
28819 the string expansion does not happen until Exim decides that access is to be
28820 denied. This means that any variables that are set by the condition are
28821 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28822 variables are set after a DNS black list lookup succeeds. If the expansion of
28823 &%log_message%& fails, or if the result is an empty string, the modifier is
28824 ignored.
28825
28826 .vindex "&$acl_verify_message$&"
28827 If you want to use a &%warn%& statement to log the result of an address
28828 verification, you can use &$acl_verify_message$& to include the verification
28829 error message.
28830
28831 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28832 the start of the logged message. If the same warning log message is requested
28833 more than once while receiving  a single email message, only one copy is
28834 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28835 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28836 is logged for a successful &%warn%& statement.
28837
28838 If &%log_message%& is not present and there is no underlying error message (for
28839 example, from the failure of address verification), but &%message%& is present,
28840 the &%message%& text is used for logging rejections. However, if any text for
28841 logging contains newlines, only the first line is logged. In the absence of
28842 both &%log_message%& and &%message%&, a default built-in message is used for
28843 logging rejections.
28844
28845
28846 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28847 .cindex "&%log_reject_target%& ACL modifier"
28848 .cindex "logging in ACL" "specifying which log"
28849 This modifier makes it possible to specify which logs are used for messages
28850 about ACL rejections. Its argument is a colon-separated list of words that can
28851 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28852 may be empty, in which case a rejection is not logged at all. For example, this
28853 ACL fragment writes no logging information when access is denied:
28854 .display
28855 &`deny `&<&'some conditions'&>
28856 &`     log_reject_target =`&
28857 .endd
28858 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28859 permanent and temporary rejections. Its effect lasts for the rest of the
28860 current ACL.
28861
28862
28863 .vitem &*logwrite*&&~=&~<&'text'&>
28864 .cindex "&%logwrite%& ACL modifier"
28865 .cindex "logging in ACL" "immediate"
28866 This modifier writes a message to a log file as soon as it is encountered when
28867 processing an ACL. (Compare &%log_message%&, which, except in the case of
28868 &%warn%& and &%discard%&, is used only if the ACL statement denies
28869 access.) The &%logwrite%& modifier can be used to log special incidents in
28870 ACLs. For example:
28871 .display
28872 &`accept `&<&'some special conditions'&>
28873 &`       control  = freeze`&
28874 &`       logwrite = froze message because ...`&
28875 .endd
28876 By default, the message is written to the main log. However, it may begin
28877 with a colon, followed by a comma-separated list of log names, and then
28878 another colon, to specify exactly which logs are to be written. For
28879 example:
28880 .code
28881 logwrite = :main,reject: text for main and reject logs
28882 logwrite = :panic: text for panic log only
28883 .endd
28884
28885
28886 .vitem &*message*&&~=&~<&'text'&>
28887 .cindex "&%message%& ACL modifier"
28888 This modifier sets up a text string that is expanded and used as a response
28889 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28890 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28891 there is some complication if &%endpass%& is involved; see the description of
28892 &%accept%& for details.)
28893
28894 The expansion of the message happens at the time Exim decides that the ACL is
28895 to end, not at the time it processes &%message%&. If the expansion fails, or
28896 generates an empty string, the modifier is ignored. Here is an example where
28897 &%message%& must be specified first, because the ACL ends with a rejection if
28898 the &%hosts%& condition fails:
28899 .code
28900 require  message = Host not recognized
28901          hosts = 10.0.0.0/8
28902 .endd
28903 (Once a condition has failed, no further conditions or modifiers are
28904 processed.)
28905
28906 .cindex "SMTP" "error codes"
28907 .oindex "&%smtp_banner%&
28908 For ACLs that are triggered by SMTP commands, the message is returned as part
28909 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28910 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28911 is accepted. In the case of the connect ACL, accepting with a message modifier
28912 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28913 accept message may not contain more than one line (otherwise it will be
28914 truncated at the first newline and a panic logged), and it cannot affect the
28915 EHLO options.
28916
28917 When SMTP is involved, the message may begin with an overriding response code,
28918 consisting of three digits optionally followed by an &"extended response code"&
28919 of the form &'n.n.n'&, each code being followed by a space. For example:
28920 .code
28921 deny  message = 599 1.2.3 Host not welcome
28922       hosts = 192.168.34.0/24
28923 .endd
28924 The first digit of the supplied response code must be the same as would be sent
28925 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28926 access, but for the predata ACL, note that the default success code is 354, not
28927 2&'xx'&.
28928
28929 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28930 the message modifier cannot override the 221 response code.
28931
28932 The text in a &%message%& modifier is literal; any quotes are taken as
28933 literals, but because the string is expanded, backslash escapes are processed
28934 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28935 response.
28936
28937 .vindex "&$acl_verify_message$&"
28938 For ACLs that are called by an &%acl =%& ACL condition, the message is
28939 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28940
28941 If &%message%& is used on a statement that verifies an address, the message
28942 specified overrides any message that is generated by the verification process.
28943 However, the original message is available in the variable
28944 &$acl_verify_message$&, so you can incorporate it into your message if you
28945 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28946 routers to be passed back as part of the SMTP response, you should either not
28947 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28948
28949 For compatibility with previous releases of Exim, a &%message%& modifier that
28950 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28951 modifier, but this usage is now deprecated. However, &%message%& acts only when
28952 all the conditions are true, wherever it appears in an ACL command, whereas
28953 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28954 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28955 effect.
28956
28957
28958 .vitem &*queue*&&~=&~<&'text'&>
28959 This modifier specifies the use of a named queue for spool files
28960 for the message.
28961 It can only be used before the message is received (i.e. not in
28962 the DATA ACL).
28963 This could be used, for example, for known high-volume burst sources
28964 of traffic, or for quarantine of messages.
28965 Separate queue-runner processes will be needed for named queues.
28966 If the text after expansion is empty, the default queue is used.
28967
28968
28969 .vitem &*remove_header*&&~=&~<&'text'&>
28970 This modifier specifies one or more header names in a colon-separated list
28971  that are to be removed from an incoming message, assuming, of course, that
28972 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28973
28974
28975 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28976 .cindex "&%set%& ACL modifier"
28977 This modifier puts a value into one of the ACL variables (see section
28978 &<<SECTaclvariables>>&).
28979
28980
28981 .vitem &*udpsend*&&~=&~<&'parameters'&>
28982 This modifier sends a UDP packet, for purposes such as statistics
28983 collection or behaviour monitoring. The parameters are expanded, and
28984 the result of the expansion must be a colon-separated list consisting
28985 of a destination server, port number, and the packet contents. The
28986 server can be specified as a host name or IPv4 or IPv6 address. The
28987 separator can be changed with the usual angle bracket syntax. For
28988 example, you might want to collect information on which hosts connect
28989 when:
28990 .code
28991 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28992              $tod_zulu $sender_host_address
28993 .endd
28994 .endlist
28995
28996
28997
28998
28999 .section "Use of the control modifier" "SECTcontrols"
29000 .cindex "&%control%& ACL modifier"
29001 The &%control%& modifier supports the following settings:
29002
29003 .vlist
29004 .vitem &*control&~=&~allow_auth_unadvertised*&
29005 This modifier allows a client host to use the SMTP AUTH command even when it
29006 has not been advertised in response to EHLO. Furthermore, because there are
29007 apparently some really broken clients that do this, Exim will accept AUTH after
29008 HELO (rather than EHLO) when this control is set. It should be used only if you
29009 really need it, and you should limit its use to those broken clients that do
29010 not work without it. For example:
29011 .code
29012 warn hosts   = 192.168.34.25
29013      control = allow_auth_unadvertised
29014 .endd
29015 Normally, when an Exim server receives an AUTH command, it checks the name of
29016 the authentication mechanism that is given in the command to ensure that it
29017 matches an advertised mechanism. When this control is set, the check that a
29018 mechanism has been advertised is bypassed. Any configured mechanism can be used
29019 by the client. This control is permitted only in the connection and HELO ACLs.
29020
29021
29022 .vitem &*control&~=&~caseful_local_part*& &&&
29023        &*control&~=&~caselower_local_part*&
29024 .cindex "&ACL;" "case of local part in"
29025 .cindex "case of local parts"
29026 .vindex "&$local_part$&"
29027 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
29028 (that is, during RCPT processing). By default, the contents of &$local_part$&
29029 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
29030 any uppercase letters in the original local part are restored in &$local_part$&
29031 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
29032 is encountered.
29033
29034 These controls affect only the current recipient. Moreover, they apply only to
29035 local part handling that takes place directly in the ACL (for example, as a key
29036 in lookups). If a test to verify the recipient is obeyed, the case-related
29037 handling of the local part during the verification is controlled by the router
29038 configuration (see the &%caseful_local_part%& generic router option).
29039
29040 This facility could be used, for example, to add a spam score to local parts
29041 containing upper case letters. For example, using &$acl_m4$& to accumulate the
29042 spam score:
29043 .code
29044 warn  control = caseful_local_part
29045       set acl_m4 = ${eval:\
29046                      $acl_m4 + \
29047                      ${if match{$local_part}{[A-Z]}{1}{0}}\
29048                     }
29049       control = caselower_local_part
29050 .endd
29051 Notice that we put back the lower cased version afterwards, assuming that
29052 is what is wanted for subsequent tests.
29053
29054
29055 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
29056 .cindex "&ACL;" "cutthrough routing"
29057 .cindex "cutthrough" "requesting"
29058 This option requests delivery be attempted while the item is being received.
29059
29060 The option is usable in the RCPT ACL.
29061 If enabled for a message received via smtp and routed to an smtp transport,
29062 and only one transport, interface, destination host and port combination
29063 is used for all recipients of the message,
29064 then the delivery connection is made while the receiving connection is open
29065 and data is copied from one to the other.
29066
29067 An attempt to set this option for any recipient but the first
29068 for a mail will be quietly ignored.
29069 If a recipient-verify callout
29070 (with use_sender)
29071 connection is subsequently
29072 requested in the same ACL it is held open and used for
29073 any subsequent recipients and the data,
29074 otherwise one is made after the initial RCPT ACL completes.
29075
29076 Note that routers are used in verify mode,
29077 and cannot depend on content of received headers.
29078 Note also that headers cannot be
29079 modified by any of the post-data ACLs (DATA, MIME and DKIM).
29080 Headers may be modified by routers (subject to the above) and transports.
29081 .new
29082 The Received-By: header is generated as soon as the body reception starts,
29083 rather than the traditional time after the full message is received;
29084 this will affect the timestamp.
29085 .wen
29086
29087 All the usual ACLs are called; if one results in the message being
29088 rejected, all effort spent in delivery (including the costs on
29089 the ultimate destination) will be wasted.
29090 Note that in the case of data-time ACLs this includes the entire
29091 message body.
29092
29093 Cutthrough delivery is not supported via transport-filters or when DKIM signing
29094 of outgoing messages is done, because it sends data to the ultimate destination
29095 before the entire message has been received from the source.
29096 It is not supported for messages received with the SMTP PRDR
29097 or CHUNKING
29098 options in use.
29099
29100 Should the ultimate destination system positively accept or reject the mail,
29101 a corresponding indication is given to the source system and nothing is queued.
29102 If the item is successfully delivered in cutthrough mode
29103 the delivery log lines are tagged with ">>" rather than "=>" and appear
29104 before the acceptance "<=" line.
29105
29106 If there is a temporary error the item is queued for later delivery in the
29107 usual fashion.
29108 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
29109 to the control; the default value is &"spool"& and the alternate value
29110 &"pass"& copies an SMTP defer response from the target back to the initiator
29111 and does not queue the message.
29112 Note that this is independent of any recipient verify conditions in the ACL.
29113
29114 Delivery in this mode avoids the generation of a bounce mail to a
29115 (possibly faked)
29116 sender when the destination system is doing content-scan based rejection.
29117
29118
29119 .vitem &*control&~=&~debug/*&<&'options'&>
29120 .cindex "&ACL;" "enabling debug logging"
29121 .cindex "debugging" "enabling from an ACL"
29122 This control turns on debug logging, almost as though Exim had been invoked
29123 with &`-d`&, with the output going to a new logfile in the usual logs directory,
29124 by default called &'debuglog'&.
29125 The filename can be adjusted with the &'tag'& option, which
29126 may access any variables already defined.  The logging may be adjusted with
29127 the &'opts'& option, which takes the same values as the &`-d`& command-line
29128 option.
29129 Logging started this way may be stopped, and the file removed,
29130 with the &'kill'& option.
29131 Some examples (which depend on variables that don't exist in all
29132 contexts):
29133 .code
29134       control = debug
29135       control = debug/tag=.$sender_host_address
29136       control = debug/opts=+expand+acl
29137       control = debug/tag=.$message_exim_id/opts=+expand
29138       control = debug/kill
29139 .endd
29140
29141
29142 .vitem &*control&~=&~dkim_disable_verify*&
29143 .cindex "disable DKIM verify"
29144 .cindex "DKIM" "disable verify"
29145 This control turns off DKIM verification processing entirely.  For details on
29146 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
29147
29148
29149 .vitem &*control&~=&~dscp/*&<&'value'&>
29150 .cindex "&ACL;" "setting DSCP value"
29151 .cindex "DSCP" "inbound"
29152 This option causes the DSCP value associated with the socket for the inbound
29153 connection to be adjusted to a given value, given as one of a number of fixed
29154 strings or to numeric value.
29155 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
29156 Common values include &`throughput`&, &`mincost`&, and on newer systems
29157 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
29158
29159 The outbound packets from Exim will be marked with this value in the header
29160 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
29161 that these values will have any effect, not be stripped by networking
29162 equipment, or do much of anything without cooperation with your Network
29163 Engineer and those of all network operators between the source and destination.
29164
29165
29166 .vitem &*control&~=&~enforce_sync*& &&&
29167        &*control&~=&~no_enforce_sync*&
29168 .cindex "SMTP" "synchronization checking"
29169 .cindex "synchronization checking in SMTP"
29170 These controls make it possible to be selective about when SMTP synchronization
29171 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
29172 state of the switch (it is true by default). See the description of this option
29173 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
29174
29175 The effect of these two controls lasts for the remainder of the SMTP
29176 connection. They can appear in any ACL except the one for the non-SMTP
29177 messages. The most straightforward place to put them is in the ACL defined by
29178 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
29179 before the first synchronization check. The expected use is to turn off the
29180 synchronization checks for badly-behaved hosts that you nevertheless need to
29181 work with.
29182
29183
29184 .vitem &*control&~=&~fakedefer/*&<&'message'&>
29185 .cindex "fake defer"
29186 .cindex "defer, fake"
29187 This control works in exactly the same way as &%fakereject%& (described below)
29188 except that it causes an SMTP 450 response after the message data instead of a
29189 550 response. You must take care when using &%fakedefer%& because it causes the
29190 messages to be duplicated when the sender retries. Therefore, you should not
29191 use &%fakedefer%& if the message is to be delivered normally.
29192
29193 .vitem &*control&~=&~fakereject/*&<&'message'&>
29194 .cindex "fake rejection"
29195 .cindex "rejection, fake"
29196 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
29197 words, only when an SMTP message is being received. If Exim accepts the
29198 message, instead the final 250 response, a 550 rejection message is sent.
29199 However, Exim proceeds to deliver the message as normal. The control applies
29200 only to the current message, not to any subsequent ones that may be received in
29201 the same SMTP connection.
29202
29203 The text for the 550 response is taken from the &%control%& modifier. If no
29204 message is supplied, the following is used:
29205 .code
29206 550-Your message has been rejected but is being
29207 550-kept for evaluation.
29208 550-If it was a legitimate message, it may still be
29209 550 delivered to the target recipient(s).
29210 .endd
29211 This facility should be used with extreme caution.
29212
29213 .vitem &*control&~=&~freeze*&
29214 .cindex "frozen messages" "forcing in ACL"
29215 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29216 other words, only when a message is being received. If the message is accepted,
29217 it is placed on Exim's queue and frozen. The control applies only to the
29218 current message, not to any subsequent ones that may be received in the same
29219 SMTP connection.
29220
29221 This modifier can optionally be followed by &`/no_tell`&. If the global option
29222 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
29223 is told about the freezing), provided all the &*control=freeze*& modifiers that
29224 are obeyed for the current message have the &`/no_tell`& option.
29225
29226 .vitem &*control&~=&~no_delay_flush*&
29227 .cindex "SMTP" "output flushing, disabling for delay"
29228 Exim normally flushes SMTP output before implementing a delay in an ACL, to
29229 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29230 use. This control, as long as it is encountered before the &%delay%& modifier,
29231 disables such output flushing.
29232
29233 .vitem &*control&~=&~no_callout_flush*&
29234 .cindex "SMTP" "output flushing, disabling for callout"
29235 Exim normally flushes SMTP output before performing a callout in an ACL, to
29236 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29237 use. This control, as long as it is encountered before the &%verify%& condition
29238 that causes the callout, disables such output flushing.
29239
29240 .vitem &*control&~=&~no_mbox_unspool*&
29241 This control is available when Exim is compiled with the content scanning
29242 extension. Content scanning may require a copy of the current message, or parts
29243 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
29244 or spam scanner. Normally, such copies are deleted when they are no longer
29245 needed. If this control is set, the copies are not deleted. The control applies
29246 only to the current message, not to any subsequent ones that may be received in
29247 the same SMTP connection. It is provided for debugging purposes and is unlikely
29248 to be useful in production.
29249
29250 .vitem &*control&~=&~no_multiline_responses*&
29251 .cindex "multiline responses, suppressing"
29252 This control is permitted for any ACL except the one for non-SMTP messages.
29253 It seems that there are broken clients in use that cannot handle multiline
29254 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
29255
29256 If this control is set, multiline SMTP responses from ACL rejections are
29257 suppressed. One way of doing this would have been to put out these responses as
29258 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
29259 (&"use multiline responses for more"& it says &-- ha!), and some of the
29260 responses might get close to that. So this facility, which is after all only a
29261 sop to broken clients, is implemented by doing two very easy things:
29262
29263 .ilist
29264 Extra information that is normally output as part of a rejection caused by
29265 sender verification failure is omitted. Only the final line (typically &"sender
29266 verification failed"&) is sent.
29267 .next
29268 If a &%message%& modifier supplies a multiline response, only the first
29269 line is output.
29270 .endlist
29271
29272 The setting of the switch can, of course, be made conditional on the
29273 calling host. Its effect lasts until the end of the SMTP connection.
29274
29275 .vitem &*control&~=&~no_pipelining*&
29276 .cindex "PIPELINING" "suppressing advertising"
29277 This control turns off the advertising of the PIPELINING extension to SMTP in
29278 the current session. To be useful, it must be obeyed before Exim sends its
29279 response to an EHLO command. Therefore, it should normally appear in an ACL
29280 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
29281 &%pipelining_advertise_hosts%&.
29282
29283 .vitem &*control&~=&~queue_only*&
29284 .oindex "&%queue_only%&"
29285 .cindex "queueing incoming messages"
29286 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29287 other words, only when a message is being received. If the message is accepted,
29288 it is placed on Exim's queue and left there for delivery by a subsequent queue
29289 runner. No immediate delivery process is started. In other words, it has the
29290 effect as the &%queue_only%& global option. However, the control applies only
29291 to the current message, not to any subsequent ones that may be received in the
29292 same SMTP connection.
29293
29294 .vitem &*control&~=&~submission/*&<&'options'&>
29295 .cindex "message" "submission"
29296 .cindex "submission mode"
29297 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
29298 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
29299 the current message is a submission from a local MUA. In this case, Exim
29300 operates in &"submission mode"&, and applies certain fixups to the message if
29301 necessary. For example, it adds a &'Date:'& header line if one is not present.
29302 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
29303 late (the message has already been created).
29304
29305 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
29306 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
29307 submission mode; the available options for this control are described there.
29308 The control applies only to the current message, not to any subsequent ones
29309 that may be received in the same SMTP connection.
29310
29311 .vitem &*control&~=&~suppress_local_fixups*&
29312 .cindex "submission fixups, suppressing"
29313 This control applies to locally submitted (non TCP/IP) messages, and is the
29314 complement of &`control = submission`&. It disables the fixups that are
29315 normally applied to locally-submitted messages. Specifically:
29316
29317 .ilist
29318 Any &'Sender:'& header line is left alone (in this respect, it is a
29319 dynamic version of &%local_sender_retain%&).
29320 .next
29321 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29322 .next
29323 There is no check that &'From:'& corresponds to the actual sender.
29324 .endlist ilist
29325
29326 This control may be useful when a remotely-originated message is accepted,
29327 passed to some scanning program, and then re-submitted for delivery. It can be
29328 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29329 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29330 data is read.
29331
29332 &*Note:*& This control applies only to the current message, not to any others
29333 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29334
29335 .vitem &*control&~=&~utf8_downconvert*&
29336 This control enables conversion of UTF-8 in message addresses
29337 to a-label form.
29338 For details see section &<<SECTi18nMTA>>&.
29339 .endlist vlist
29340
29341
29342 .section "Summary of message fixup control" "SECTsummesfix"
29343 All four possibilities for message fixups can be specified:
29344
29345 .ilist
29346 Locally submitted, fixups applied: the default.
29347 .next
29348 Locally submitted, no fixups applied: use
29349 &`control = suppress_local_fixups`&.
29350 .next
29351 Remotely submitted, no fixups applied: the default.
29352 .next
29353 Remotely submitted, fixups applied: use &`control = submission`&.
29354 .endlist
29355
29356
29357
29358 .section "Adding header lines in ACLs" "SECTaddheadacl"
29359 .cindex "header lines" "adding in an ACL"
29360 .cindex "header lines" "position of added lines"
29361 .cindex "&%add_header%& ACL modifier"
29362 The &%add_header%& modifier can be used to add one or more extra header lines
29363 to an incoming message, as in this example:
29364 .code
29365 warn dnslists = sbl.spamhaus.org : \
29366                 dialup.mail-abuse.org
29367      add_header = X-blacklisted-at: $dnslist_domain
29368 .endd
29369 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29370 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29371 receiving a message). The message must ultimately be accepted for
29372 &%add_header%& to have any significant effect. You can use &%add_header%& with
29373 any ACL verb, including &%deny%& (though this is potentially useful only in a
29374 RCPT ACL).
29375
29376 Headers will not be added to the message if the modifier is used in
29377 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29378
29379 Leading and trailing newlines are removed from
29380 the data for the &%add_header%& modifier; if it then
29381 contains one or more newlines that
29382 are not followed by a space or a tab, it is assumed to contain multiple header
29383 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29384 front of any line that is not a valid header line.
29385
29386 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29387 They are added to the message before processing the DATA and MIME ACLs.
29388 However, if an identical header line is requested more than once, only one copy
29389 is actually added to the message. Further header lines may be accumulated
29390 during the DATA and MIME ACLs, after which they are added to the message, again
29391 with duplicates suppressed. Thus, it is possible to add two identical header
29392 lines to an SMTP message, but only if one is added before DATA and one after.
29393 In the case of non-SMTP messages, new headers are accumulated during the
29394 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29395 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29396 are included in the entry that is written to the reject log.
29397
29398 .cindex "header lines" "added; visibility of"
29399 Header lines are not visible in string expansions
29400 of message headers
29401 until they are added to the
29402 message. It follows that header lines defined in the MAIL, RCPT, and predata
29403 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29404 header lines that are added by the DATA or MIME ACLs are not visible in those
29405 ACLs. Because of this restriction, you cannot use header lines as a way of
29406 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29407 this, you can use ACL variables, as described in section
29408 &<<SECTaclvariables>>&.
29409
29410 The list of headers yet to be added is given by the &%$headers_added%& variable.
29411
29412 The &%add_header%& modifier acts immediately as it is encountered during the
29413 processing of an ACL. Notice the difference between these two cases:
29414 .display
29415 &`accept add_header = ADDED: some text`&
29416 &`       `&<&'some condition'&>
29417
29418 &`accept `&<&'some condition'&>
29419 &`       add_header = ADDED: some text`&
29420 .endd
29421 In the first case, the header line is always added, whether or not the
29422 condition is true. In the second case, the header line is added only if the
29423 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29424 ACL statement. All those that are encountered before a condition fails are
29425 honoured.
29426
29427 .cindex "&%warn%& ACL verb"
29428 For compatibility with previous versions of Exim, a &%message%& modifier for a
29429 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29430 effect only if all the conditions are true, even if it appears before some of
29431 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29432 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29433 are present on a &%warn%& verb, both are processed according to their
29434 specifications.
29435
29436 By default, new header lines are added to a message at the end of the existing
29437 header lines. However, you can specify that any particular header line should
29438 be added right at the start (before all the &'Received:'& lines), immediately
29439 after the first block of &'Received:'& lines, or immediately before any line
29440 that is not a &'Received:'& or &'Resent-something:'& header.
29441
29442 This is done by specifying &":at_start:"&, &":after_received:"&, or
29443 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29444 header line, respectively. (Header text cannot start with a colon, as there has
29445 to be a header name first.) For example:
29446 .code
29447 warn add_header = \
29448        :after_received:X-My-Header: something or other...
29449 .endd
29450 If more than one header line is supplied in a single &%add_header%& modifier,
29451 each one is treated independently and can therefore be placed differently. If
29452 you add more than one line at the start, or after the Received: block, they end
29453 up in reverse order.
29454
29455 &*Warning*&: This facility currently applies only to header lines that are
29456 added in an ACL. It does NOT work for header lines that are added in a
29457 system filter or in a router or transport.
29458
29459
29460
29461 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29462 .cindex "header lines" "removing in an ACL"
29463 .cindex "header lines" "position of removed lines"
29464 .cindex "&%remove_header%& ACL modifier"
29465 The &%remove_header%& modifier can be used to remove one or more header lines
29466 from an incoming message, as in this example:
29467 .code
29468 warn   message        = Remove internal headers
29469        remove_header  = x-route-mail1 : x-route-mail2
29470 .endd
29471 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29472 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29473 receiving a message). The message must ultimately be accepted for
29474 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29475 with any ACL verb, including &%deny%&, though this is really not useful for
29476 any verb that doesn't result in a delivered message.
29477
29478 Headers will not be removed from the message if the modifier is used in
29479 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29480
29481 More than one header can be removed at the same time by using a colon separated
29482 list of header names. The header matching is case insensitive. Wildcards are
29483 not permitted, nor is list expansion performed, so you cannot use hostlists to
29484 create a list of headers, however both connection and message variable expansion
29485 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29486 .code
29487 warn   hosts           = +internal_hosts
29488        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29489 warn   message         = Remove internal headers
29490        remove_header   = $acl_c_ihdrs
29491 .endd
29492 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29493 They are removed from the message before processing the DATA and MIME ACLs.
29494 There is no harm in attempting to remove the same header twice nor is removing
29495 a non-existent header. Further header lines to be removed may be accumulated
29496 during the DATA and MIME ACLs, after which they are removed from the message,
29497 if present. In the case of non-SMTP messages, headers to be removed are
29498 accumulated during the non-SMTP ACLs, and are removed from the message after
29499 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29500 ACL, there really is no effect because there is no logging of what headers
29501 would have been removed.
29502
29503 .cindex "header lines" "removed; visibility of"
29504 Header lines are not visible in string expansions until the DATA phase when it
29505 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29506 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29507 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29508 this restriction, you cannot use header lines as a way of controlling data
29509 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29510 you should instead use ACL variables, as described in section
29511 &<<SECTaclvariables>>&.
29512
29513 The &%remove_header%& modifier acts immediately as it is encountered during the
29514 processing of an ACL. Notice the difference between these two cases:
29515 .display
29516 &`accept remove_header = X-Internal`&
29517 &`       `&<&'some condition'&>
29518
29519 &`accept `&<&'some condition'&>
29520 &`       remove_header = X-Internal`&
29521 .endd
29522 In the first case, the header line is always removed, whether or not the
29523 condition is true. In the second case, the header line is removed only if the
29524 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29525 same ACL statement. All those that are encountered before a condition fails
29526 are honoured.
29527
29528 &*Warning*&: This facility currently applies only to header lines that are
29529 present during ACL processing. It does NOT remove header lines that are added
29530 in a system filter or in a router or transport.
29531
29532
29533
29534
29535 .section "ACL conditions" "SECTaclconditions"
29536 .cindex "&ACL;" "conditions; list of"
29537 Some of the conditions listed in this section are available only when Exim is
29538 compiled with the content-scanning extension. They are included here briefly
29539 for completeness. More detailed descriptions can be found in the discussion on
29540 content scanning in chapter &<<CHAPexiscan>>&.
29541
29542 Not all conditions are relevant in all circumstances. For example, testing
29543 senders and recipients does not make sense in an ACL that is being run as the
29544 result of the arrival of an ETRN command, and checks on message headers can be
29545 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29546 can use the same condition (with different parameters) more than once in the
29547 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29548 The conditions are as follows:
29549
29550
29551 .vlist
29552 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29553 .cindex "&ACL;" "nested"
29554 .cindex "&ACL;" "indirect"
29555 .cindex "&ACL;" "arguments"
29556 .cindex "&%acl%& ACL condition"
29557 The possible values of the argument are the same as for the
29558 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29559 &"accept"& the condition is true; if it returns &"deny"& the condition is
29560 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29561 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29562 condition false. This means that further processing of the &%warn%& verb
29563 ceases, but processing of the ACL continues.
29564
29565 If the argument is a named ACL, up to nine space-separated optional values
29566 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29567 and $acl_narg is set to the count of values.
29568 Previous values of these variables are restored after the call returns.
29569 The name and values are expanded separately.
29570 Note that spaces in complex expansions which are used as arguments
29571 will act as argument separators.
29572
29573 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29574 the connection is dropped. If it returns &"discard"&, the verb must be
29575 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29576 conditions are tested.
29577
29578 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29579 loops. This condition allows you to use different ACLs in different
29580 circumstances. For example, different ACLs can be used to handle RCPT commands
29581 for different local users or different local domains.
29582
29583 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29584 .cindex "&%authenticated%& ACL condition"
29585 .cindex "authentication" "ACL checking"
29586 .cindex "&ACL;" "testing for authentication"
29587 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29588 the name of the authenticator is tested against the list. To test for
29589 authentication by any authenticator, you can set
29590 .code
29591 authenticated = *
29592 .endd
29593
29594 .vitem &*condition&~=&~*&<&'string'&>
29595 .cindex "&%condition%& ACL condition"
29596 .cindex "customizing" "ACL condition"
29597 .cindex "&ACL;" "customized test"
29598 .cindex "&ACL;" "testing, customized"
29599 This feature allows you to make up custom conditions. If the result of
29600 expanding the string is an empty string, the number zero, or one of the strings
29601 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29602 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29603 any other value, some error is assumed to have occurred, and the ACL returns
29604 &"defer"&. However, if the expansion is forced to fail, the condition is
29605 ignored. The effect is to treat it as true, whether it is positive or
29606 negative.
29607
29608 .vitem &*decode&~=&~*&<&'location'&>
29609 .cindex "&%decode%& ACL condition"
29610 This condition is available only when Exim is compiled with the
29611 content-scanning extension, and it is allowed only in the ACL defined by
29612 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29613 If all goes well, the condition is true. It is false only if there are
29614 problems such as a syntax error or a memory shortage. For more details, see
29615 chapter &<<CHAPexiscan>>&.
29616
29617 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29618 .cindex "&%dnslists%& ACL condition"
29619 .cindex "DNS list" "in ACL"
29620 .cindex "black list (DNS)"
29621 .cindex "&ACL;" "testing a DNS list"
29622 This condition checks for entries in DNS black lists. These are also known as
29623 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29624 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29625 different variants of this condition to describe briefly here. See sections
29626 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29627
29628 .vitem &*domains&~=&~*&<&'domain&~list'&>
29629 .cindex "&%domains%& ACL condition"
29630 .cindex "domain" "ACL checking"
29631 .cindex "&ACL;" "testing a recipient domain"
29632 .vindex "&$domain_data$&"
29633 This condition is relevant only after a RCPT command. It checks that the domain
29634 of the recipient address is in the domain list. If percent-hack processing is
29635 enabled, it is done before this test is done. If the check succeeds with a
29636 lookup, the result of the lookup is placed in &$domain_data$& until the next
29637 &%domains%& test.
29638
29639 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29640 use &%domains%& in a DATA ACL.
29641
29642
29643 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29644 .cindex "&%encrypted%& ACL condition"
29645 .cindex "encryption" "checking in an ACL"
29646 .cindex "&ACL;" "testing for encryption"
29647 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29648 name of the cipher suite in use is tested against the list. To test for
29649 encryption without testing for any specific cipher suite(s), set
29650 .code
29651 encrypted = *
29652 .endd
29653
29654
29655 .vitem &*hosts&~=&~*&<&'host&~list'&>
29656 .cindex "&%hosts%& ACL condition"
29657 .cindex "host" "ACL checking"
29658 .cindex "&ACL;" "testing the client host"
29659 This condition tests that the calling host matches the host list. If you have
29660 name lookups or wildcarded host names and IP addresses in the same host list,
29661 you should normally put the IP addresses first. For example, you could have:
29662 .code
29663 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29664 .endd
29665 The lookup in this example uses the host name for its key. This is implied by
29666 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29667 and it wouldn't matter which way round you had these two items.)
29668
29669 The reason for the problem with host names lies in the left-to-right way that
29670 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29671 but when it reaches an item that requires a host name, it fails if it cannot
29672 find a host name to compare with the pattern. If the above list is given in the
29673 opposite order, the &%accept%& statement fails for a host whose name cannot be
29674 found, even if its IP address is 10.9.8.7.
29675
29676 If you really do want to do the name check first, and still recognize the IP
29677 address even if the name lookup fails, you can rewrite the ACL like this:
29678 .code
29679 accept hosts = dbm;/etc/friendly/hosts
29680 accept hosts = 10.9.8.7
29681 .endd
29682 The default action on failing to find the host name is to assume that the host
29683 is not in the list, so the first &%accept%& statement fails. The second
29684 statement can then check the IP address.
29685
29686 .vindex "&$host_data$&"
29687 If a &%hosts%& condition is satisfied by means of a lookup, the result
29688 of the lookup is made available in the &$host_data$& variable. This
29689 allows you, for example, to set up a statement like this:
29690 .code
29691 deny  hosts = net-lsearch;/some/file
29692 message = $host_data
29693 .endd
29694 which gives a custom error message for each denied host.
29695
29696 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29697 .cindex "&%local_parts%& ACL condition"
29698 .cindex "local part" "ACL checking"
29699 .cindex "&ACL;" "testing a local part"
29700 .vindex "&$local_part_data$&"
29701 This condition is relevant only after a RCPT command. It checks that the local
29702 part of the recipient address is in the list. If percent-hack processing is
29703 enabled, it is done before this test. If the check succeeds with a lookup, the
29704 result of the lookup is placed in &$local_part_data$&, which remains set until
29705 the next &%local_parts%& test.
29706
29707 .vitem &*malware&~=&~*&<&'option'&>
29708 .cindex "&%malware%& ACL condition"
29709 .cindex "&ACL;" "virus scanning"
29710 .cindex "&ACL;" "scanning for viruses"
29711 This condition is available only when Exim is compiled with the
29712 content-scanning extension. It causes the incoming message to be scanned for
29713 viruses. For details, see chapter &<<CHAPexiscan>>&.
29714
29715 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29716 .cindex "&%mime_regex%& ACL condition"
29717 .cindex "&ACL;" "testing by regex matching"
29718 This condition is available only when Exim is compiled with the
29719 content-scanning extension, and it is allowed only in the ACL defined by
29720 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29721 with any of the regular expressions. For details, see chapter
29722 &<<CHAPexiscan>>&.
29723
29724 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29725 .cindex "rate limiting"
29726 This condition can be used to limit the rate at which a user or host submits
29727 messages. Details are given in section &<<SECTratelimiting>>&.
29728
29729 .vitem &*recipients&~=&~*&<&'address&~list'&>
29730 .cindex "&%recipients%& ACL condition"
29731 .cindex "recipient" "ACL checking"
29732 .cindex "&ACL;" "testing a recipient"
29733 This condition is relevant only after a RCPT command. It checks the entire
29734 recipient address against a list of recipients.
29735
29736 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29737 .cindex "&%regex%& ACL condition"
29738 .cindex "&ACL;" "testing by regex matching"
29739 This condition is available only when Exim is compiled with the
29740 content-scanning extension, and is available only in the DATA, MIME, and
29741 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29742 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29743
29744 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29745 .cindex "&%sender_domains%& ACL condition"
29746 .cindex "sender" "ACL checking"
29747 .cindex "&ACL;" "testing a sender domain"
29748 .vindex "&$domain$&"
29749 .vindex "&$sender_address_domain$&"
29750 This condition tests the domain of the sender of the message against the given
29751 domain list. &*Note*&: The domain of the sender address is in
29752 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29753 of this condition. This is an exception to the general rule for testing domain
29754 lists. It is done this way so that, if this condition is used in an ACL for a
29755 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29756 influence the sender checking.
29757
29758 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29759 relaying, because sender addresses are easily, and commonly, forged.
29760
29761 .vitem &*senders&~=&~*&<&'address&~list'&>
29762 .cindex "&%senders%& ACL condition"
29763 .cindex "sender" "ACL checking"
29764 .cindex "&ACL;" "testing a sender"
29765 This condition tests the sender of the message against the given list. To test
29766 for a bounce message, which has an empty sender, set
29767 .code
29768 senders = :
29769 .endd
29770 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29771 relaying, because sender addresses are easily, and commonly, forged.
29772
29773 .vitem &*spam&~=&~*&<&'username'&>
29774 .cindex "&%spam%& ACL condition"
29775 .cindex "&ACL;" "scanning for spam"
29776 This condition is available only when Exim is compiled with the
29777 content-scanning extension. It causes the incoming message to be scanned by
29778 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29779
29780 .vitem &*verify&~=&~certificate*&
29781 .cindex "&%verify%& ACL condition"
29782 .cindex "TLS" "client certificate verification"
29783 .cindex "certificate" "verification of client"
29784 .cindex "&ACL;" "certificate verification"
29785 .cindex "&ACL;" "testing a TLS certificate"
29786 This condition is true in an SMTP session if the session is encrypted, and a
29787 certificate was received from the client, and the certificate was verified. The
29788 server requests a certificate only if the client matches &%tls_verify_hosts%&
29789 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29790
29791 .vitem &*verify&~=&~csa*&
29792 .cindex "CSA verification"
29793 This condition checks whether the sending host (the client) is authorized to
29794 send email. Details of how this works are given in section
29795 &<<SECTverifyCSA>>&.
29796
29797 .vitem &*verify&~=&~header_names_ascii*&
29798 .cindex "&%verify%& ACL condition"
29799 .cindex "&ACL;" "verifying header names only ASCII"
29800 .cindex "header lines" "verifying header names only ASCII"
29801 .cindex "verifying" "header names only ASCII"
29802 This condition is relevant only in an ACL that is run after a message has been
29803 received, that is, in an ACL specified by &%acl_smtp_data%& or
29804 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29805 there are no non-ASCII characters, also excluding control characters.  The
29806 allowable characters are decimal ASCII values 33 through 126.
29807
29808 Exim itself will handle headers with non-ASCII characters, but it can cause
29809 problems for downstream applications, so this option will allow their
29810 detection and rejection in the DATA ACL's.
29811
29812 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29813 .cindex "&%verify%& ACL condition"
29814 .cindex "&ACL;" "verifying sender in the header"
29815 .cindex "header lines" "verifying the sender in"
29816 .cindex "sender" "verifying in header"
29817 .cindex "verifying" "sender in header"
29818 This condition is relevant only in an ACL that is run after a message has been
29819 received, that is, in an ACL specified by &%acl_smtp_data%& or
29820 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29821 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29822 is loosely thought of as a &"sender"& address (hence the name of the test).
29823 However, an address that appears in one of these headers need not be an address
29824 that accepts bounce messages; only sender addresses in envelopes are required
29825 to accept bounces. Therefore, if you use the callout option on this check, you
29826 might want to arrange for a non-empty address in the MAIL command.
29827
29828 Details of address verification and the options are given later, starting at
29829 section &<<SECTaddressverification>>& (callouts are described in section
29830 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29831 condition to restrict it to bounce messages only:
29832 .code
29833 deny    senders = :
29834         message = A valid sender header is required for bounces
29835        !verify  = header_sender
29836 .endd
29837
29838 .vitem &*verify&~=&~header_syntax*&
29839 .cindex "&%verify%& ACL condition"
29840 .cindex "&ACL;" "verifying header syntax"
29841 .cindex "header lines" "verifying syntax"
29842 .cindex "verifying" "header syntax"
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 the syntax of all header lines that can contain
29846 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29847 and &'Bcc:'&), returning true if there are no problems.
29848 Unqualified addresses (local parts without domains) are
29849 permitted only in locally generated messages and from hosts that match
29850 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29851 appropriate.
29852
29853 Note that this condition is a syntax check only. However, a common spamming
29854 ploy used to be to send syntactically invalid headers such as
29855 .code
29856 To: @
29857 .endd
29858 and this condition can be used to reject such messages, though they are not as
29859 common as they used to be.
29860
29861 .vitem &*verify&~=&~helo*&
29862 .cindex "&%verify%& ACL condition"
29863 .cindex "&ACL;" "verifying HELO/EHLO"
29864 .cindex "HELO" "verifying"
29865 .cindex "EHLO" "verifying"
29866 .cindex "verifying" "EHLO"
29867 .cindex "verifying" "HELO"
29868 This condition is true if a HELO or EHLO command has been received from the
29869 client host, and its contents have been verified. If there has been no previous
29870 attempt to verify the HELO/EHLO contents, it is carried out when this
29871 condition is encountered. See the description of the &%helo_verify_hosts%& and
29872 &%helo_try_verify_hosts%& options for details of how to request verification
29873 independently of this condition.
29874
29875 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29876 option), this condition is always true.
29877
29878
29879 .vitem &*verify&~=&~not_blind*&
29880 .cindex "verifying" "not blind"
29881 .cindex "bcc recipients, verifying none"
29882 This condition checks that there are no blind (bcc) recipients in the message.
29883 Every envelope recipient must appear either in a &'To:'& header line or in a
29884 &'Cc:'& header line for this condition to be true. Local parts are checked
29885 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29886 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29887 used only in a DATA or non-SMTP ACL.
29888
29889 There are, of course, many legitimate messages that make use of blind (bcc)
29890 recipients. This check should not be used on its own for blocking messages.
29891
29892
29893 .vitem &*verify&~=&~recipient/*&<&'options'&>
29894 .cindex "&%verify%& ACL condition"
29895 .cindex "&ACL;" "verifying recipient"
29896 .cindex "recipient" "verifying"
29897 .cindex "verifying" "recipient"
29898 .vindex "&$address_data$&"
29899 This condition is relevant only after a RCPT command. It verifies the current
29900 recipient. Details of address verification are given later, starting at section
29901 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29902 of &$address_data$& is the last value that was set while routing the address.
29903 This applies even if the verification fails. When an address that is being
29904 verified is redirected to a single address, verification continues with the new
29905 address, and in that case, the subsequent value of &$address_data$& is the
29906 value for the child address.
29907
29908 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29909 .cindex "&%verify%& ACL condition"
29910 .cindex "&ACL;" "verifying host reverse lookup"
29911 .cindex "host" "verifying reverse lookup"
29912 This condition ensures that a verified host name has been looked up from the IP
29913 address of the client host. (This may have happened already if the host name
29914 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29915 Verification ensures that the host name obtained from a reverse DNS lookup, or
29916 one of its aliases, does, when it is itself looked up in the DNS, yield the
29917 original IP address.
29918
29919 There is one possible option, &`defer_ok`&.  If this is present and a
29920 DNS operation returns a temporary error, the verify condition succeeds.
29921
29922 If this condition is used for a locally generated message (that is, when there
29923 is no client host involved), it always succeeds.
29924
29925 .vitem &*verify&~=&~sender/*&<&'options'&>
29926 .cindex "&%verify%& ACL condition"
29927 .cindex "&ACL;" "verifying sender"
29928 .cindex "sender" "verifying"
29929 .cindex "verifying" "sender"
29930 This condition is relevant only after a MAIL or RCPT command, or after a
29931 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29932 the message's sender is empty (that is, this is a bounce message), the
29933 condition is true. Otherwise, the sender address is verified.
29934
29935 .vindex "&$address_data$&"
29936 .vindex "&$sender_address_data$&"
29937 If there is data in the &$address_data$& variable at the end of routing, its
29938 value is placed in &$sender_address_data$& at the end of verification. This
29939 value can be used in subsequent conditions and modifiers in the same ACL
29940 statement. It does not persist after the end of the current statement. If you
29941 want to preserve the value for longer, you can save it in an ACL variable.
29942
29943 Details of verification are given later, starting at section
29944 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29945 to avoid doing it more than once per message.
29946
29947 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29948 .cindex "&%verify%& ACL condition"
29949 This is a variation of the previous option, in which a modified address is
29950 verified as a sender.
29951
29952 Note that '/' is legal in local-parts; if the address may have such
29953 (eg. is generated from the received message)
29954 they must be protected from the options parsing by doubling:
29955 .code
29956 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
29957 .endd
29958 .endlist
29959
29960
29961
29962 .section "Using DNS lists" "SECTmorednslists"
29963 .cindex "DNS list" "in ACL"
29964 .cindex "black list (DNS)"
29965 .cindex "&ACL;" "testing a DNS list"
29966 In its simplest form, the &%dnslists%& condition tests whether the calling host
29967 is on at least one of a number of DNS lists by looking up the inverted IP
29968 address in one or more DNS domains. (Note that DNS list domains are not mail
29969 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29970 special options instead.) For example, if the calling host's IP
29971 address is 192.168.62.43, and the ACL statement is
29972 .code
29973 deny dnslists = blackholes.mail-abuse.org : \
29974                 dialups.mail-abuse.org
29975 .endd
29976 the following records are looked up:
29977 .code
29978 43.62.168.192.blackholes.mail-abuse.org
29979 43.62.168.192.dialups.mail-abuse.org
29980 .endd
29981 As soon as Exim finds an existing DNS record, processing of the list stops.
29982 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29983 to test that a host is on more than one list (an &"and"& conjunction), you can
29984 use two separate conditions:
29985 .code
29986 deny dnslists = blackholes.mail-abuse.org
29987      dnslists = dialups.mail-abuse.org
29988 .endd
29989 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29990 behaves as if the host does not match the list item, that is, as if the DNS
29991 record does not exist. If there are further items in the DNS list, they are
29992 processed.
29993
29994 This is usually the required action when &%dnslists%& is used with &%deny%&
29995 (which is the most common usage), because it prevents a DNS failure from
29996 blocking mail. However, you can change this behaviour by putting one of the
29997 following special items in the list:
29998 .display
29999 &`+include_unknown `&   behave as if the item is on the list
30000 &`+exclude_unknown `&   behave as if the item is not on the list (default)
30001 &`+defer_unknown   `&   give a temporary error
30002 .endd
30003 .cindex "&`+include_unknown`&"
30004 .cindex "&`+exclude_unknown`&"
30005 .cindex "&`+defer_unknown`&"
30006 Each of these applies to any subsequent items on the list. For example:
30007 .code
30008 deny dnslists = +defer_unknown : foo.bar.example
30009 .endd
30010 Testing the list of domains stops as soon as a match is found. If you want to
30011 warn for one list and block for another, you can use two different statements:
30012 .code
30013 deny  dnslists = blackholes.mail-abuse.org
30014 warn  message  = X-Warn: sending host is on dialups list
30015       dnslists = dialups.mail-abuse.org
30016 .endd
30017 .cindex caching "of dns lookup"
30018 .cindex DNS TTL
30019 DNS list lookups are cached by Exim for the duration of the SMTP session
30020 (but limited by the DNS return TTL value),
30021 so a lookup based on the IP address is done at most once for any incoming
30022 connection (assuming long-enough TTL).
30023 Exim does not share information between multiple incoming
30024 connections (but your local name server cache should be active).
30025
30026
30027
30028 .section "Specifying the IP address for a DNS list lookup" "SECID201"
30029 .cindex "DNS list" "keyed by explicit IP address"
30030 By default, the IP address that is used in a DNS list lookup is the IP address
30031 of the calling host. However, you can specify another IP address by listing it
30032 after the domain name, introduced by a slash. For example:
30033 .code
30034 deny dnslists = black.list.tld/192.168.1.2
30035 .endd
30036 This feature is not very helpful with explicit IP addresses; it is intended for
30037 use with IP addresses that are looked up, for example, the IP addresses of the
30038 MX hosts or nameservers of an email sender address. For an example, see section
30039 &<<SECTmulkeyfor>>& below.
30040
30041
30042
30043
30044 .section "DNS lists keyed on domain names" "SECID202"
30045 .cindex "DNS list" "keyed by domain name"
30046 There are some lists that are keyed on domain names rather than inverted IP
30047 addresses (see for example the &'domain based zones'& link at
30048 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
30049 with these lists. You can change the name that is looked up in a DNS list by
30050 listing it after the domain name, introduced by a slash. For example,
30051 .code
30052 deny  message  = Sender's domain is listed at $dnslist_domain
30053       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
30054 .endd
30055 This particular example is useful only in ACLs that are obeyed after the
30056 RCPT or DATA commands, when a sender address is available. If (for
30057 example) the message's sender is &'user@tld.example'& the name that is looked
30058 up by this example is
30059 .code
30060 tld.example.dsn.rfc-ignorant.org
30061 .endd
30062 A single &%dnslists%& condition can contain entries for both names and IP
30063 addresses. For example:
30064 .code
30065 deny dnslists = sbl.spamhaus.org : \
30066                 dsn.rfc-ignorant.org/$sender_address_domain
30067 .endd
30068 The first item checks the sending host's IP address; the second checks a domain
30069 name. The whole condition is true if either of the DNS lookups succeeds.
30070
30071
30072
30073
30074 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
30075 .cindex "DNS list" "multiple keys for"
30076 The syntax described above for looking up explicitly-defined values (either
30077 names or IP addresses) in a DNS blacklist is a simplification. After the domain
30078 name for the DNS list, what follows the slash can in fact be a list of items.
30079 As with all lists in Exim, the default separator is a colon. However, because
30080 this is a sublist within the list of DNS blacklist domains, it is necessary
30081 either to double the separators like this:
30082 .code
30083 dnslists = black.list.tld/name.1::name.2
30084 .endd
30085 or to change the separator character, like this:
30086 .code
30087 dnslists = black.list.tld/<;name.1;name.2
30088 .endd
30089 If an item in the list is an IP address, it is inverted before the DNS
30090 blacklist domain is appended. If it is not an IP address, no inversion
30091 occurs. Consider this condition:
30092 .code
30093 dnslists = black.list.tld/<;192.168.1.2;a.domain
30094 .endd
30095 The DNS lookups that occur are:
30096 .code
30097 2.1.168.192.black.list.tld
30098 a.domain.black.list.tld
30099 .endd
30100 Once a DNS record has been found (that matches a specific IP return
30101 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
30102 are done. If there is a temporary DNS error, the rest of the sublist of domains
30103 or IP addresses is tried. A temporary error for the whole dnslists item occurs
30104 only if no other DNS lookup in this sublist succeeds. In other words, a
30105 successful lookup for any of the items in the sublist overrides a temporary
30106 error for a previous item.
30107
30108 The ability to supply a list of items after the slash is in some sense just a
30109 syntactic convenience. These two examples have the same effect:
30110 .code
30111 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
30112 dnslists = black.list.tld/a.domain::b.domain
30113 .endd
30114 However, when the data for the list is obtained from a lookup, the second form
30115 is usually much more convenient. Consider this example:
30116 .code
30117 deny message  = The mail servers for the domain \
30118                 $sender_address_domain \
30119                 are listed at $dnslist_domain ($dnslist_value); \
30120                 see $dnslist_text.
30121      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
30122                                    ${lookup dnsdb {>|mxh=\
30123                                    $sender_address_domain} }} }
30124 .endd
30125 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
30126 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
30127 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
30128 of expanding the condition might be something like this:
30129 .code
30130 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
30131 .endd
30132 Thus, this example checks whether or not the IP addresses of the sender
30133 domain's mail servers are on the Spamhaus black list.
30134
30135 The key that was used for a successful DNS list lookup is put into the variable
30136 &$dnslist_matched$& (see section &<<SECID204>>&).
30137
30138
30139
30140
30141 .section "Data returned by DNS lists" "SECID203"
30142 .cindex "DNS list" "data returned from"
30143 DNS lists are constructed using address records in the DNS. The original RBL
30144 just used the address 127.0.0.1 on the right hand side of each record, but the
30145 RBL+ list and some other lists use a number of values with different meanings.
30146 The values used on the RBL+ list are:
30147 .display
30148 127.1.0.1  RBL
30149 127.1.0.2  DUL
30150 127.1.0.3  DUL and RBL
30151 127.1.0.4  RSS
30152 127.1.0.5  RSS and RBL
30153 127.1.0.6  RSS and DUL
30154 127.1.0.7  RSS and DUL and RBL
30155 .endd
30156 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
30157 different values. Some DNS lists may return more than one address record;
30158 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
30159
30160
30161 .section "Variables set from DNS lists" "SECID204"
30162 .cindex "expansion" "variables, set from DNS list"
30163 .cindex "DNS list" "variables set from"
30164 .vindex "&$dnslist_domain$&"
30165 .vindex "&$dnslist_matched$&"
30166 .vindex "&$dnslist_text$&"
30167 .vindex "&$dnslist_value$&"
30168 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
30169 the name of the overall domain that matched (for example,
30170 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
30171 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
30172 the DNS record. When the key is an IP address, it is not reversed in
30173 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
30174 cases, for example:
30175 .code
30176 deny dnslists = spamhaus.example
30177 .endd
30178 the key is also available in another variable (in this case,
30179 &$sender_host_address$&). In more complicated cases, however, this is not true.
30180 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
30181 might generate a dnslists lookup like this:
30182 .code
30183 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
30184 .endd
30185 If this condition succeeds, the value in &$dnslist_matched$& might be
30186 &`192.168.6.7`& (for example).
30187
30188 If more than one address record is returned by the DNS lookup, all the IP
30189 addresses are included in &$dnslist_value$&, separated by commas and spaces.
30190 The variable &$dnslist_text$& contains the contents of any associated TXT
30191 record. For lists such as RBL+ the TXT record for a merged entry is often not
30192 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
30193 information.
30194
30195 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
30196 &-- although these appear before the condition in the ACL, they are not
30197 expanded until after it has failed. For example:
30198 .code
30199 deny    hosts = !+local_networks
30200         message = $sender_host_address is listed \
30201                   at $dnslist_domain
30202         dnslists = rbl-plus.mail-abuse.example
30203 .endd
30204
30205
30206
30207 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
30208 .cindex "DNS list" "matching specific returned data"
30209 You can add an equals sign and an IP address after a &%dnslists%& domain name
30210 in order to restrict its action to DNS records with a matching right hand side.
30211 For example,
30212 .code
30213 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
30214 .endd
30215 rejects only those hosts that yield 127.0.0.2. Without this additional data,
30216 any address record is considered to be a match. For the moment, we assume
30217 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
30218 describes how multiple records are handled.
30219
30220 More than one IP address may be given for checking, using a comma as a
30221 separator. These are alternatives &-- if any one of them matches, the
30222 &%dnslists%& condition is true. For example:
30223 .code
30224 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30225 .endd
30226 If you want to specify a constraining address list and also specify names or IP
30227 addresses to be looked up, the constraining address list must be specified
30228 first. For example:
30229 .code
30230 deny dnslists = dsn.rfc-ignorant.org\
30231                 =127.0.0.2/$sender_address_domain
30232 .endd
30233
30234 If the character &`&&`& is used instead of &`=`&, the comparison for each
30235 listed IP address is done by a bitwise &"and"& instead of by an equality test.
30236 In other words, the listed addresses are used as bit masks. The comparison is
30237 true if all the bits in the mask are present in the address that is being
30238 tested. For example:
30239 .code
30240 dnslists = a.b.c&0.0.0.3
30241 .endd
30242 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
30243 want to test whether one bit or another bit is present (as opposed to both
30244 being present), you must use multiple values. For example:
30245 .code
30246 dnslists = a.b.c&0.0.0.1,0.0.0.2
30247 .endd
30248 matches if the final component of the address is an odd number or two times
30249 an odd number.
30250
30251
30252
30253 .section "Negated DNS matching conditions" "SECID205"
30254 You can supply a negative list of IP addresses as part of a &%dnslists%&
30255 condition. Whereas
30256 .code
30257 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30258 .endd
30259 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30260 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
30261 .code
30262 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
30263 .endd
30264 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30265 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
30266 words, the result of the test is inverted if an exclamation mark appears before
30267 the &`=`& (or the &`&&`&) sign.
30268
30269 &*Note*&: This kind of negation is not the same as negation in a domain,
30270 host, or address list (which is why the syntax is different).
30271
30272 If you are using just one list, the negation syntax does not gain you much. The
30273 previous example is precisely equivalent to
30274 .code
30275 deny  dnslists = a.b.c
30276      !dnslists = a.b.c=127.0.0.2,127.0.0.3
30277 .endd
30278 However, if you are using multiple lists, the negation syntax is clearer.
30279 Consider this example:
30280 .code
30281 deny  dnslists = sbl.spamhaus.org : \
30282                  list.dsbl.org : \
30283                  dnsbl.njabl.org!=127.0.0.3 : \
30284                  relays.ordb.org
30285 .endd
30286 Using only positive lists, this would have to be:
30287 .code
30288 deny  dnslists = sbl.spamhaus.org : \
30289                  list.dsbl.org
30290 deny  dnslists = dnsbl.njabl.org
30291      !dnslists = dnsbl.njabl.org=127.0.0.3
30292 deny  dnslists = relays.ordb.org
30293 .endd
30294 which is less clear, and harder to maintain.
30295
30296
30297
30298
30299 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
30300 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
30301 thereby providing more than one IP address. When an item in a &%dnslists%& list
30302 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
30303 the match to specific results from the DNS lookup, there are two ways in which
30304 the checking can be handled. For example, consider the condition:
30305 .code
30306 dnslists = a.b.c=127.0.0.1
30307 .endd
30308 What happens if the DNS lookup for the incoming IP address yields both
30309 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
30310 condition true because at least one given value was found, or is it false
30311 because at least one of the found values was not listed? And how does this
30312 affect negated conditions? Both possibilities are provided for with the help of
30313 additional separators &`==`& and &`=&&`&.
30314
30315 .ilist
30316 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30317 IP addresses matches one of the listed addresses. For the example above, the
30318 condition is true because 127.0.0.1 matches.
30319 .next
30320 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30321 looked up IP addresses matches one of the listed addresses. If the condition is
30322 changed to:
30323 .code
30324 dnslists = a.b.c==127.0.0.1
30325 .endd
30326 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30327 false because 127.0.0.2 is not listed. You would need to have:
30328 .code
30329 dnslists = a.b.c==127.0.0.1,127.0.0.2
30330 .endd
30331 for the condition to be true.
30332 .endlist
30333
30334 When &`!`& is used to negate IP address matching, it inverts the result, giving
30335 the precise opposite of the behaviour above. Thus:
30336 .ilist
30337 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30338 addresses matches one of the listed addresses. Consider:
30339 .code
30340 dnslists = a.b.c!&0.0.0.1
30341 .endd
30342 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30343 false because 127.0.0.1 matches.
30344 .next
30345 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30346 looked up IP address that does not match. Consider:
30347 .code
30348 dnslists = a.b.c!=&0.0.0.1
30349 .endd
30350 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30351 true, because 127.0.0.2 does not match. You would need to have:
30352 .code
30353 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30354 .endd
30355 for the condition to be false.
30356 .endlist
30357 When the DNS lookup yields only a single IP address, there is no difference
30358 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30359
30360
30361
30362
30363 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30364 .cindex "DNS list" "information from merged"
30365 When the facility for restricting the matching IP values in a DNS list is used,
30366 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30367 the true reason for rejection. This happens when lists are merged and the IP
30368 address in the A record is used to distinguish them; unfortunately there is
30369 only one TXT record. One way round this is not to use merged lists, but that
30370 can be inefficient because it requires multiple DNS lookups where one would do
30371 in the vast majority of cases when the host of interest is not on any of the
30372 lists.
30373
30374 A less inefficient way of solving this problem is available. If
30375 two domain names, comma-separated, are given, the second is used first to
30376 do an initial check, making use of any IP value restrictions that are set.
30377 If there is a match, the first domain is used, without any IP value
30378 restrictions, to get the TXT record. As a byproduct of this, there is also
30379 a check that the IP being tested is indeed on the first list. The first
30380 domain is the one that is put in &$dnslist_domain$&. For example:
30381 .code
30382 reject message  = \
30383          rejected because $sender_host_address is blacklisted \
30384          at $dnslist_domain\n$dnslist_text
30385        dnslists = \
30386          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30387          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30388 .endd
30389 For the first blacklist item, this starts by doing a lookup in
30390 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30391 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30392 value, and as long as something is found, it looks for the corresponding TXT
30393 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30394 The second blacklist item is processed similarly.
30395
30396 If you are interested in more than one merged list, the same list must be
30397 given several times, but because the results of the DNS lookups are cached,
30398 the DNS calls themselves are not repeated. For example:
30399 .code
30400 reject dnslists = \
30401          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30402          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30403          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30404          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30405 .endd
30406 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30407 values matches (or if no record is found), this is the only lookup that is
30408 done. Only if there is a match is one of the more specific lists consulted.
30409
30410
30411
30412 .section "DNS lists and IPv6" "SECTmorednslistslast"
30413 .cindex "IPv6" "DNS black lists"
30414 .cindex "DNS list" "IPv6 usage"
30415 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30416 nibble by nibble. For example, if the calling host's IP address is
30417 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30418 .code
30419 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30420   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30421 .endd
30422 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30423 lists contain wildcard records, intended for IPv4, that interact badly with
30424 IPv6. For example, the DNS entry
30425 .code
30426 *.3.some.list.example.    A    127.0.0.1
30427 .endd
30428 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30429 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30430
30431 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30432 &%condition%& condition, as in this example:
30433 .code
30434 deny   condition = ${if isip4{$sender_host_address}}
30435        dnslists  = some.list.example
30436 .endd
30437
30438 If an explicit key is being used for a DNS lookup and it may be an IPv6
30439 address you should specify alternate list separators for both the outer
30440 (DNS list name) list and inner (lookup keys) list:
30441 .code
30442        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30443 .endd
30444
30445 .section "Rate limiting incoming messages" "SECTratelimiting"
30446 .cindex "rate limiting" "client sending"
30447 .cindex "limiting client sending rates"
30448 .oindex "&%smtp_ratelimit_*%&"
30449 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30450 which clients can send email. This is more powerful than the
30451 &%smtp_ratelimit_*%& options, because those options control the rate of
30452 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30453 works across all connections (concurrent and sequential) from the same client
30454 host. The syntax of the &%ratelimit%& condition is:
30455 .display
30456 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30457 .endd
30458 If the average client sending rate is less than &'m'& messages per time
30459 period &'p'& then the condition is false; otherwise it is true.
30460
30461 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30462 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30463 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30464 of &'p'&.
30465
30466 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30467 time interval, for example, &`8h`& for eight hours. A larger time constant
30468 means that it takes Exim longer to forget a client's past behaviour. The
30469 parameter &'m'& is the maximum number of messages that a client is permitted to
30470 send in each time interval. It also specifies the number of messages permitted
30471 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30472 constant, you can allow a client to send more messages in a burst without
30473 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30474 both small, messages must be sent at an even rate.
30475
30476 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30477 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30478 when deploying the &%ratelimit%& ACL condition. The script prints usage
30479 instructions when it is run with no arguments.
30480
30481 The key is used to look up the data for calculating the client's average
30482 sending rate. This data is stored in Exim's spool directory, alongside the
30483 retry and other hints databases. The default key is &$sender_host_address$&,
30484 which means Exim computes the sending rate of each client host IP address.
30485 By changing the key you can change how Exim identifies clients for the purpose
30486 of ratelimiting. For example, to limit the sending rate of each authenticated
30487 user, independent of the computer they are sending from, set the key to
30488 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30489 example, &$authenticated_id$& is only meaningful if the client has
30490 authenticated (which you can check with the &%authenticated%& ACL condition).
30491
30492 The lookup key does not have to identify clients: If you want to limit the
30493 rate at which a recipient receives messages, you can use the key
30494 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30495 ACL.
30496
30497 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30498 specifies what Exim measures the rate of, for example messages or recipients
30499 or bytes. You can adjust the measurement using the &%unique=%& and/or
30500 &%count=%& options. You can also control when Exim updates the recorded rate
30501 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30502 separated by a slash, like the other parameters. They may appear in any order.
30503
30504 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30505 any options that alter the meaning of the stored data. The limit &'m'& is not
30506 stored, so you can alter the configured maximum rate and Exim will still
30507 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30508 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30509 behaviour. The lookup key is not affected by changes to the update mode and
30510 the &%count=%& option.
30511
30512
30513 .section "Ratelimit options for what is being measured" "ratoptmea"
30514 .cindex "rate limiting" "per_* options"
30515 The &%per_conn%& option limits the client's connection rate. It is not
30516 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30517 &%acl_not_smtp_start%& ACLs.
30518
30519 The &%per_mail%& option limits the client's rate of sending messages. This is
30520 the default if none of the &%per_*%& options is specified. It can be used in
30521 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30522 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30523
30524 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30525 the same ACLs as the &%per_mail%& option, though it is best to use this option
30526 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30527 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30528 in its MAIL command, which may be inaccurate or completely missing. You can
30529 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30530 in kilobytes, megabytes, or gigabytes, respectively.
30531
30532 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30533 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30534 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30535 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30536 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30537 in either case the rate limiting engine will see a message with many
30538 recipients as a large high-speed burst.
30539
30540 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30541 number of different recipients that the client has sent messages to in the
30542 last time period. That is, if the client repeatedly sends messages to the same
30543 recipient, its measured rate is not increased. This option can only be used in
30544 &%acl_smtp_rcpt%&.
30545
30546 The &%per_cmd%& option causes Exim to recompute the rate every time the
30547 condition is processed. This can be used to limit the rate of any SMTP
30548 command. If it is used in multiple ACLs it can limit the aggregate rate of
30549 multiple different commands.
30550
30551 The &%count=%& option can be used to alter how much Exim adds to the client's
30552 measured rate. For example, the &%per_byte%& option is equivalent to
30553 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30554 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30555 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30556
30557 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30558
30559
30560 .section "Ratelimit update modes" "ratoptupd"
30561 .cindex "rate limiting" "reading data without updating"
30562 You can specify one of three options with the &%ratelimit%& condition to
30563 control when its database is updated. This section describes the &%readonly%&
30564 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30565
30566 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30567 previously-computed rate to check against the limit.
30568
30569 For example, you can test the client's sending rate and deny it access (when
30570 it is too fast) in the connect ACL. If the client passes this check then it
30571 can go on to send a message, in which case its recorded rate will be updated
30572 in the MAIL ACL. Subsequent connections from the same client will check this
30573 new rate.
30574 .code
30575 acl_check_connect:
30576  deny ratelimit = 100 / 5m / readonly
30577     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30578                   (max $sender_rate_limit)
30579 # ...
30580 acl_check_mail:
30581  warn ratelimit = 100 / 5m / strict
30582     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30583                   (max $sender_rate_limit)
30584 .endd
30585
30586 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30587 processing a message then it may increase the client's measured rate more than
30588 it should. For example, this will happen if you check the &%per_rcpt%& option
30589 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30590 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30591 multiple update problems by using the &%readonly%& option on later ratelimit
30592 checks.
30593
30594 The &%per_*%& options described above do not make sense in some ACLs. If you
30595 use a &%per_*%& option in an ACL where it is not normally permitted then the
30596 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30597 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30598 next section) so you must specify the &%readonly%& option explicitly.
30599
30600
30601 .section "Ratelimit options for handling fast clients" "ratoptfast"
30602 .cindex "rate limiting" "strict and leaky modes"
30603 If a client's average rate is greater than the maximum, the rate limiting
30604 engine can react in two possible ways, depending on the presence of the
30605 &%strict%& or &%leaky%& update modes. This is independent of the other
30606 counter-measures (such as rejecting the message) that may be specified by the
30607 rest of the ACL.
30608
30609 The &%leaky%& (default) option means that the client's recorded rate is not
30610 updated if it is above the limit. The effect of this is that Exim measures the
30611 client's average rate of successfully sent email, which cannot be greater than
30612 the maximum allowed. If the client is over the limit it may suffer some
30613 counter-measures (as specified in the ACL), but it will still be able to send
30614 email at the configured maximum rate, whatever the rate of its attempts. This
30615 is generally the better choice if you have clients that retry automatically.
30616 For example, it does not prevent a sender with an over-aggressive retry rate
30617 from getting any email through.
30618
30619 The &%strict%& option means that the client's recorded rate is always
30620 updated. The effect of this is that Exim measures the client's average rate
30621 of attempts to send email, which can be much higher than the maximum it is
30622 actually allowed. If the client is over the limit it may be subjected to
30623 counter-measures by the ACL. It must slow down and allow sufficient time to
30624 pass that its computed rate falls below the maximum before it can send email
30625 again. The time (the number of smoothing periods) it must wait and not
30626 attempt to send mail can be calculated with this formula:
30627 .code
30628         ln(peakrate/maxrate)
30629 .endd
30630
30631
30632 .section "Limiting the rate of different events" "ratoptuniq"
30633 .cindex "rate limiting" "counting unique events"
30634 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30635 rate of different events. For example, the &%per_addr%& option uses this
30636 mechanism to count the number of different recipients that the client has
30637 sent messages to in the last time period; it is equivalent to
30638 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30639 measure the rate that a client uses different sender addresses with the
30640 options &`per_mail/unique=$sender_address`&.
30641
30642 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30643 has seen for that key. The whole set is thrown away when it is older than the
30644 rate smoothing period &'p'&, so each different event is counted at most once
30645 per period. In the &%leaky%& update mode, an event that causes the client to
30646 go over the limit is not added to the set, in the same way that the client's
30647 recorded rate is not updated in the same situation.
30648
30649 When you combine the &%unique=%& and &%readonly%& options, the specific
30650 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30651 rate.
30652
30653 The &%unique=%& mechanism needs more space in the ratelimit database than the
30654 other &%ratelimit%& options in order to store the event set. The number of
30655 unique values is potentially as large as the rate limit, so the extra space
30656 required increases with larger limits.
30657
30658 The uniqueification is not perfect: there is a small probability that Exim
30659 will think a new event has happened before. If the sender's rate is less than
30660 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30661 the measured rate can go above the limit, in which case Exim may under-count
30662 events by a significant margin. Fortunately, if the rate is high enough (2.7
30663 times the limit) that the false positive rate goes above 9%, then Exim will
30664 throw away the over-full event set before the measured rate falls below the
30665 limit. Therefore the only harm should be that exceptionally high sending rates
30666 are logged incorrectly; any countermeasures you configure will be as effective
30667 as intended.
30668
30669
30670 .section "Using rate limiting" "useratlim"
30671 Exim's other ACL facilities are used to define what counter-measures are taken
30672 when the rate limit is exceeded. This might be anything from logging a warning
30673 (for example, while measuring existing sending rates in order to define
30674 policy), through time delays to slow down fast senders, up to rejecting the
30675 message. For example:
30676 .code
30677 # Log all senders' rates
30678 warn ratelimit = 0 / 1h / strict
30679      log_message = Sender rate $sender_rate / $sender_rate_period
30680
30681 # Slow down fast senders; note the need to truncate $sender_rate
30682 # at the decimal point.
30683 warn ratelimit = 100 / 1h / per_rcpt / strict
30684      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30685                    $sender_rate_limit }s
30686
30687 # Keep authenticated users under control
30688 deny authenticated = *
30689      ratelimit = 100 / 1d / strict / $authenticated_id
30690
30691 # System-wide rate limit
30692 defer message = Sorry, too busy. Try again later.
30693      ratelimit = 10 / 1s / $primary_hostname
30694
30695 # Restrict incoming rate from each host, with a default
30696 # set using a macro and special cases looked up in a table.
30697 defer message = Sender rate exceeds $sender_rate_limit \
30698                messages per $sender_rate_period
30699      ratelimit = ${lookup {$sender_host_address} \
30700                    cdb {DB/ratelimits.cdb} \
30701                    {$value} {RATELIMIT} }
30702 .endd
30703 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30704 especially with the &%per_rcpt%& option, you may suffer from a performance
30705 bottleneck caused by locking on the ratelimit hints database. Apart from
30706 making your ACLs less complicated, you can reduce the problem by using a
30707 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30708 this means that Exim will lose its hints data after a reboot (including retry
30709 hints, the callout cache, and ratelimit data).
30710
30711
30712
30713 .section "Address verification" "SECTaddressverification"
30714 .cindex "verifying address" "options for"
30715 .cindex "policy control" "address verification"
30716 Several of the &%verify%& conditions described in section
30717 &<<SECTaclconditions>>& cause addresses to be verified. Section
30718 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30719 The verification conditions can be followed by options that modify the
30720 verification process. The options are separated from the keyword and from each
30721 other by slashes, and some of them contain parameters. For example:
30722 .code
30723 verify = sender/callout
30724 verify = recipient/defer_ok/callout=10s,defer_ok
30725 .endd
30726 The first stage of address verification, which always happens, is to run the
30727 address through the routers, in &"verify mode"&. Routers can detect the
30728 difference between verification and routing for delivery, and their actions can
30729 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30730 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30731 The available options are as follows:
30732
30733 .ilist
30734 If the &%callout%& option is specified, successful routing to one or more
30735 remote hosts is followed by a &"callout"& to those hosts as an additional
30736 check. Callouts and their sub-options are discussed in the next section.
30737 .next
30738 If there is a defer error while doing verification routing, the ACL
30739 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30740 options, the condition is forced to be true instead. Note that this is a main
30741 verification option as well as a suboption for callouts.
30742 .next
30743 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30744 discusses the reporting of sender address verification failures.
30745 .next
30746 The &%success_on_redirect%& option causes verification always to succeed
30747 immediately after a successful redirection. By default, if a redirection
30748 generates just one address, that address is also verified. See further
30749 discussion in section &<<SECTredirwhilveri>>&.
30750 .endlist
30751
30752 .cindex "verifying address" "differentiating failures"
30753 .vindex "&$recipient_verify_failure$&"
30754 .vindex "&$sender_verify_failure$&"
30755 .vindex "&$acl_verify_message$&"
30756 After an address verification failure, &$acl_verify_message$& contains the
30757 error message that is associated with the failure. It can be preserved by
30758 coding like this:
30759 .code
30760 warn  !verify = sender
30761        set acl_m0 = $acl_verify_message
30762 .endd
30763 If you are writing your own custom rejection message or log message when
30764 denying access, you can use this variable to include information about the
30765 verification failure.
30766
30767 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30768 appropriate) contains one of the following words:
30769
30770 .ilist
30771 &%qualify%&: The address was unqualified (no domain), and the message
30772 was neither local nor came from an exempted host.
30773 .next
30774 &%route%&: Routing failed.
30775 .next
30776 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30777 occurred at or before the MAIL command (that is, on initial
30778 connection, HELO, or MAIL).
30779 .next
30780 &%recipient%&: The RCPT command in a callout was rejected.
30781 .next
30782 &%postmaster%&: The postmaster check in a callout was rejected.
30783 .endlist
30784
30785 The main use of these variables is expected to be to distinguish between
30786 rejections of MAIL and rejections of RCPT in callouts.
30787
30788
30789
30790
30791 .section "Callout verification" "SECTcallver"
30792 .cindex "verifying address" "by callout"
30793 .cindex "callout" "verification"
30794 .cindex "SMTP" "callout verification"
30795 For non-local addresses, routing verifies the domain, but is unable to do any
30796 checking of the local part. There are situations where some means of verifying
30797 the local part is desirable. One way this can be done is to make an SMTP
30798 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30799 a subsequent host for a recipient address, to see if the host accepts the
30800 address. We use the term &'callout'& to cover both cases. Note that for a
30801 sender address, the callback is not to the client host that is trying to
30802 deliver the message, but to one of the hosts that accepts incoming mail for the
30803 sender's domain.
30804
30805 Exim does not do callouts by default. If you want them to happen, you must
30806 request them by setting appropriate options on the &%verify%& condition, as
30807 described below. This facility should be used with care, because it can add a
30808 lot of resource usage to the cost of verifying an address. However, Exim does
30809 cache the results of callouts, which helps to reduce the cost. Details of
30810 caching are in section &<<SECTcallvercache>>&.
30811
30812 Recipient callouts are usually used only between hosts that are controlled by
30813 the same administration. For example, a corporate gateway host could use
30814 callouts to check for valid recipients on an internal mailserver. A successful
30815 callout does not guarantee that a real delivery to the address would succeed;
30816 on the other hand, a failing callout does guarantee that a delivery would fail.
30817
30818 If the &%callout%& option is present on a condition that verifies an address, a
30819 second stage of verification occurs if the address is successfully routed to
30820 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30821 &(manualroute)& router, where the router specifies the hosts. However, if a
30822 router that does not set up hosts routes to an &(smtp)& transport with a
30823 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30824 &%hosts_override%& set, its hosts are always used, whether or not the router
30825 supplies a host list.
30826 Callouts are only supported on &(smtp)& transports.
30827
30828 The port that is used is taken from the transport, if it is specified and is a
30829 remote transport. (For routers that do verification only, no transport need be
30830 specified.) Otherwise, the default SMTP port is used. If a remote transport
30831 specifies an outgoing interface, this is used; otherwise the interface is not
30832 specified. Likewise, the text that is used for the HELO command is taken from
30833 the transport's &%helo_data%& option; if there is no transport, the value of
30834 &$smtp_active_hostname$& is used.
30835
30836 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30837 test whether a bounce message could be delivered to the sender address. The
30838 following SMTP commands are sent:
30839 .display
30840 &`HELO `&<&'local host name'&>
30841 &`MAIL FROM:<>`&
30842 &`RCPT TO:`&<&'the address to be tested'&>
30843 &`QUIT`&
30844 .endd
30845 LHLO is used instead of HELO if the transport's &%protocol%& option is
30846 set to &"lmtp"&.
30847
30848 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30849 settings.
30850
30851 A recipient callout check is similar. By default, it also uses an empty address
30852 for the sender. This default is chosen because most hosts do not make use of
30853 the sender address when verifying a recipient. Using the same address means
30854 that a single cache entry can be used for each recipient. Some sites, however,
30855 do make use of the sender address when verifying. These are catered for by the
30856 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30857
30858 If the response to the RCPT command is a 2&'xx'& code, the verification
30859 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30860 Exim tries the next host, if any. If there is a problem with all the remote
30861 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30862 &%callout%& option is given, in which case the condition is forced to succeed.
30863
30864 .cindex "SMTP" "output flushing, disabling for callout"
30865 A callout may take a little time. For this reason, Exim normally flushes SMTP
30866 output before performing a callout in an ACL, to avoid unexpected timeouts in
30867 clients when the SMTP PIPELINING extension is in use. The flushing can be
30868 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30869
30870
30871
30872
30873 .section "Additional parameters for callouts" "CALLaddparcall"
30874 .cindex "callout" "additional parameters for"
30875 The &%callout%& option can be followed by an equals sign and a number of
30876 optional parameters, separated by commas. For example:
30877 .code
30878 verify = recipient/callout=10s,defer_ok
30879 .endd
30880 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30881 separate verify options, is retained for backwards compatibility, but is now
30882 deprecated. The additional parameters for &%callout%& are as follows:
30883
30884
30885 .vlist
30886 .vitem <&'a&~time&~interval'&>
30887 .cindex "callout" "timeout, specifying"
30888 This specifies the timeout that applies for the callout attempt to each host.
30889 For example:
30890 .code
30891 verify = sender/callout=5s
30892 .endd
30893 The default is 30 seconds. The timeout is used for each response from the
30894 remote host. It is also used for the initial connection, unless overridden by
30895 the &%connect%& parameter.
30896
30897
30898 .vitem &*connect&~=&~*&<&'time&~interval'&>
30899 .cindex "callout" "connection timeout, specifying"
30900 This parameter makes it possible to set a different (usually smaller) timeout
30901 for making the SMTP connection. For example:
30902 .code
30903 verify = sender/callout=5s,connect=1s
30904 .endd
30905 If not specified, this timeout defaults to the general timeout value.
30906
30907 .vitem &*defer_ok*&
30908 .cindex "callout" "defer, action on"
30909 When this parameter is present, failure to contact any host, or any other kind
30910 of temporary error, is treated as success by the ACL. However, the cache is not
30911 updated in this circumstance.
30912
30913 .vitem &*fullpostmaster*&
30914 .cindex "callout" "full postmaster check"
30915 This operates like the &%postmaster%& option (see below), but if the check for
30916 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30917 accordance with the specification in RFC 2821. The RFC states that the
30918 unqualified address &'postmaster'& should be accepted.
30919
30920
30921 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30922 .cindex "callout" "sender when verifying header"
30923 When verifying addresses in header lines using the &%header_sender%&
30924 verification option, Exim behaves by default as if the addresses are envelope
30925 sender addresses from a message. Callout verification therefore tests to see
30926 whether a bounce message could be delivered, by using an empty address in the
30927 MAIL command. However, it is arguable that these addresses might never be used
30928 as envelope senders, and could therefore justifiably reject bounce messages
30929 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30930 address to use in the MAIL command. For example:
30931 .code
30932 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30933 .endd
30934 This parameter is available only for the &%header_sender%& verification option.
30935
30936
30937 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30938 .cindex "callout" "overall timeout, specifying"
30939 This parameter sets an overall timeout for performing a callout verification.
30940 For example:
30941 .code
30942 verify = sender/callout=5s,maxwait=30s
30943 .endd
30944 This timeout defaults to four times the callout timeout for individual SMTP
30945 commands. The overall timeout applies when there is more than one host that can
30946 be tried. The timeout is checked before trying the next host. This prevents
30947 very long delays if there are a large number of hosts and all are timing out
30948 (for example, when network connections are timing out).
30949
30950
30951 .vitem &*no_cache*&
30952 .cindex "callout" "cache, suppressing"
30953 .cindex "caching callout, suppressing"
30954 When this parameter is given, the callout cache is neither read nor updated.
30955
30956 .vitem &*postmaster*&
30957 .cindex "callout" "postmaster; checking"
30958 When this parameter is set, a successful callout check is followed by a similar
30959 check for the local part &'postmaster'& at the same domain. If this address is
30960 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30961 the postmaster check is recorded in a cache record; if it is a failure, this is
30962 used to fail subsequent callouts for the domain without a connection being
30963 made, until the cache record expires.
30964
30965 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30966 The postmaster check uses an empty sender in the MAIL command by default.
30967 You can use this parameter to do a postmaster check using a different address.
30968 For example:
30969 .code
30970 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30971 .endd
30972 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30973 one overrides. The &%postmaster%& parameter is equivalent to this example:
30974 .code
30975 require  verify = sender/callout=postmaster_mailfrom=
30976 .endd
30977 &*Warning*&: The caching arrangements for postmaster checking do not take
30978 account of the sender address. It is assumed that either the empty address or
30979 a fixed non-empty address will be used. All that Exim remembers is that the
30980 postmaster check for the domain succeeded or failed.
30981
30982
30983 .vitem &*random*&
30984 .cindex "callout" "&""random""& check"
30985 When this parameter is set, before doing the normal callout check, Exim does a
30986 check for a &"random"& local part at the same domain. The local part is not
30987 really random &-- it is defined by the expansion of the option
30988 &%callout_random_local_part%&, which defaults to
30989 .code
30990 $primary_hostname-$tod_epoch-testing
30991 .endd
30992 The idea here is to try to determine whether the remote host accepts all local
30993 parts without checking. If it does, there is no point in doing callouts for
30994 specific local parts. If the &"random"& check succeeds, the result is saved in
30995 a cache record, and used to force the current and subsequent callout checks to
30996 succeed without a connection being made, until the cache record expires.
30997
30998 .vitem &*use_postmaster*&
30999 .cindex "callout" "sender for recipient check"
31000 This parameter applies to recipient callouts only. For example:
31001 .code
31002 deny  !verify = recipient/callout=use_postmaster
31003 .endd
31004 .vindex "&$qualify_domain$&"
31005 It causes a non-empty postmaster address to be used in the MAIL command when
31006 performing the callout for the recipient, and also for a &"random"& check if
31007 that is configured. The local part of the address is &`postmaster`& and the
31008 domain is the contents of &$qualify_domain$&.
31009
31010 .vitem &*use_sender*&
31011 This option applies to recipient callouts only. For example:
31012 .code
31013 require  verify = recipient/callout=use_sender
31014 .endd
31015 It causes the message's actual sender address to be used in the MAIL
31016 command when performing the callout, instead of an empty address. There is no
31017 need to use this option unless you know that the called hosts make use of the
31018 sender when checking recipients. If used indiscriminately, it reduces the
31019 usefulness of callout caching.
31020
31021 .new
31022 .vitem &*hold*&
31023 This option applies to recipient callouts only. For example:
31024 .code
31025 require  verify = recipient/callout=use_sender,hold
31026 .endd
31027 It causes the connection to be helod open and used for any further recipients
31028 and for eventual delivery (should that be done quickly).
31029 Doing this saves on TCP and SMTP startup costs, and TLS costs also
31030 when that is used for the connections.
31031 The advantage is only gained if there are no callout cache hits
31032 (which could be enforced by the no_cache option),
31033 if the use_sender option is used,
31034 if neither the random nor the use_postmaster option is used,
31035 and if no other callouts intervene.
31036 .wen
31037 .endlist
31038
31039 If you use any of the parameters that set a non-empty sender for the MAIL
31040 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
31041 &%use_sender%&), you should think about possible loops. Recipient checking is
31042 usually done between two hosts that are under the same management, and the host
31043 that receives the callouts is not normally configured to do callouts itself.
31044 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
31045 these circumstances.
31046
31047 However, if you use a non-empty sender address for a callout to an arbitrary
31048 host, there is the likelihood that the remote host will itself initiate a
31049 callout check back to your host. As it is checking what appears to be a message
31050 sender, it is likely to use an empty address in MAIL, thus avoiding a
31051 callout loop. However, to be on the safe side it would be best to set up your
31052 own ACLs so that they do not do sender verification checks when the recipient
31053 is the address you use for header sender or postmaster callout checking.
31054
31055 Another issue to think about when using non-empty senders for callouts is
31056 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
31057 by the sender/recipient combination; thus, for any given recipient, many more
31058 actual callouts are performed than when an empty sender or postmaster is used.
31059
31060
31061
31062
31063 .section "Callout caching" "SECTcallvercache"
31064 .cindex "hints database" "callout cache"
31065 .cindex "callout" "cache, description of"
31066 .cindex "caching" "callout"
31067 Exim caches the results of callouts in order to reduce the amount of resources
31068 used, unless you specify the &%no_cache%& parameter with the &%callout%&
31069 option. A hints database called &"callout"& is used for the cache. Two
31070 different record types are used: one records the result of a callout check for
31071 a specific address, and the other records information that applies to the
31072 entire domain (for example, that it accepts the local part &'postmaster'&).
31073
31074 When an original callout fails, a detailed SMTP error message is given about
31075 the failure. However, for subsequent failures use the cache data, this message
31076 is not available.
31077
31078 The expiry times for negative and positive address cache records are
31079 independent, and can be set by the global options &%callout_negative_expire%&
31080 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
31081
31082 If a host gives a negative response to an SMTP connection, or rejects any
31083 commands up to and including
31084 .code
31085 MAIL FROM:<>
31086 .endd
31087 (but not including the MAIL command with a non-empty address),
31088 any callout attempt is bound to fail. Exim remembers such failures in a
31089 domain cache record, which it uses to fail callouts for the domain without
31090 making new connections, until the domain record times out. There are two
31091 separate expiry times for domain cache records:
31092 &%callout_domain_negative_expire%& (default 3h) and
31093 &%callout_domain_positive_expire%& (default 7d).
31094
31095 Domain records expire when the negative expiry time is reached if callouts
31096 cannot be made for the domain, or if the postmaster check failed.
31097 Otherwise, they expire when the positive expiry time is reached. This
31098 ensures that, for example, a host that stops accepting &"random"& local parts
31099 will eventually be noticed.
31100
31101 The callout caching mechanism is based on the domain of the address that is
31102 being tested. If the domain routes to several hosts, it is assumed that their
31103 behaviour will be the same.
31104
31105
31106
31107 .section "Sender address verification reporting" "SECTsenaddver"
31108 .cindex "verifying" "suppressing error details"
31109 See section &<<SECTaddressverification>>& for a general discussion of
31110 verification. When sender verification fails in an ACL, the details of the
31111 failure are given as additional output lines before the 550 response to the
31112 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
31113 you might see:
31114 .code
31115 MAIL FROM:<xyz@abc.example>
31116 250 OK
31117 RCPT TO:<pqr@def.example>
31118 550-Verification failed for <xyz@abc.example>
31119 550-Called:   192.168.34.43
31120 550-Sent:     RCPT TO:<xyz@abc.example>
31121 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
31122 550 Sender verification failed
31123 .endd
31124 If more than one RCPT command fails in the same way, the details are given
31125 only for the first of them. However, some administrators do not want to send
31126 out this much information. You can suppress the details by adding
31127 &`/no_details`& to the ACL statement that requests sender verification. For
31128 example:
31129 .code
31130 verify = sender/no_details
31131 .endd
31132
31133 .section "Redirection while verifying" "SECTredirwhilveri"
31134 .cindex "verifying" "redirection while"
31135 .cindex "address redirection" "while verifying"
31136 A dilemma arises when a local address is redirected by aliasing or forwarding
31137 during verification: should the generated addresses themselves be verified,
31138 or should the successful expansion of the original address be enough to verify
31139 it? By default, Exim takes the following pragmatic approach:
31140
31141 .ilist
31142 When an incoming address is redirected to just one child address, verification
31143 continues with the child address, and if that fails to verify, the original
31144 verification also fails.
31145 .next
31146 When an incoming address is redirected to more than one child address,
31147 verification does not continue. A success result is returned.
31148 .endlist
31149
31150 This seems the most reasonable behaviour for the common use of aliasing as a
31151 way of redirecting different local parts to the same mailbox. It means, for
31152 example, that a pair of alias entries of the form
31153 .code
31154 A.Wol:   aw123
31155 aw123:   :fail: Gone away, no forwarding address
31156 .endd
31157 work as expected, with both local parts causing verification failure. When a
31158 redirection generates more than one address, the behaviour is more like a
31159 mailing list, where the existence of the alias itself is sufficient for
31160 verification to succeed.
31161
31162 It is possible, however, to change the default behaviour so that all successful
31163 redirections count as successful verifications, however many new addresses are
31164 generated. This is specified by the &%success_on_redirect%& verification
31165 option. For example:
31166 .code
31167 require verify = recipient/success_on_redirect/callout=10s
31168 .endd
31169 In this example, verification succeeds if a router generates a new address, and
31170 the callout does not occur, because no address was routed to a remote host.
31171
31172 When verification is being tested via the &%-bv%& option, the treatment of
31173 redirections is as just described, unless the &%-v%& or any debugging option is
31174 also specified. In that case, full verification is done for every generated
31175 address and a report is output for each of them.
31176
31177
31178
31179 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
31180 .cindex "CSA" "verifying"
31181 Client SMTP Authorization is a system that allows a site to advertise
31182 which machines are and are not permitted to send email. This is done by placing
31183 special SRV records in the DNS; these are looked up using the client's HELO
31184 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
31185 Authorization checks in Exim are performed by the ACL condition:
31186 .code
31187 verify = csa
31188 .endd
31189 This fails if the client is not authorized. If there is a DNS problem, or if no
31190 valid CSA SRV record is found, or if the client is authorized, the condition
31191 succeeds. These three cases can be distinguished using the expansion variable
31192 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
31193 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
31194 be likely to cause problems for legitimate email.
31195
31196 The error messages produced by the CSA code include slightly more
31197 detail. If &$csa_status$& is &"defer"&, this may be because of problems
31198 looking up the CSA SRV record, or problems looking up the CSA target
31199 address record. There are four reasons for &$csa_status$& being &"fail"&:
31200
31201 .ilist
31202 The client's host name is explicitly not authorized.
31203 .next
31204 The client's IP address does not match any of the CSA target IP addresses.
31205 .next
31206 The client's host name is authorized but it has no valid target IP addresses
31207 (for example, the target's addresses are IPv6 and the client is using IPv4).
31208 .next
31209 The client's host name has no CSA SRV record but a parent domain has asserted
31210 that all subdomains must be explicitly authorized.
31211 .endlist
31212
31213 The &%csa%& verification condition can take an argument which is the domain to
31214 use for the DNS query. The default is:
31215 .code
31216 verify = csa/$sender_helo_name
31217 .endd
31218 This implementation includes an extension to CSA. If the query domain
31219 is an address literal such as [192.0.2.95], or if it is a bare IP
31220 address, Exim searches for CSA SRV records in the reverse DNS as if
31221 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
31222 meaningful to say:
31223 .code
31224 verify = csa/$sender_host_address
31225 .endd
31226 In fact, this is the check that Exim performs if the client does not say HELO.
31227 This extension can be turned off by setting the main configuration option
31228 &%dns_csa_use_reverse%& to be false.
31229
31230 If a CSA SRV record is not found for the domain itself, a search
31231 is performed through its parent domains for a record which might be
31232 making assertions about subdomains. The maximum depth of this search is limited
31233 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
31234 default. Exim does not look for CSA SRV records in a top level domain, so the
31235 default settings handle HELO domains as long as seven
31236 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
31237 of legitimate HELO domains.
31238
31239 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
31240 direct SRV lookups, this is not sufficient because of the extra parent domain
31241 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
31242 addresses into lookups in the reverse DNS space. The result of a successful
31243 lookup such as:
31244 .code
31245 ${lookup dnsdb {csa=$sender_helo_name}}
31246 .endd
31247 has two space-separated fields: an authorization code and a target host name.
31248 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
31249 authorization required but absent, or &"?"& for unknown.
31250
31251
31252
31253
31254 .section "Bounce address tag validation" "SECTverifyPRVS"
31255 .cindex "BATV, verifying"
31256 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
31257 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
31258 Genuine incoming bounce messages should therefore always be addressed to
31259 recipients that have a valid tag. This scheme is a way of detecting unwanted
31260 bounce messages caused by sender address forgeries (often called &"collateral
31261 spam"&), because the recipients of such messages do not include valid tags.
31262
31263 There are two expansion items to help with the implementation of the BATV
31264 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
31265 the original envelope sender address by using a simple key to add a hash of the
31266 address and some time-based randomizing information. The &%prvs%& expansion
31267 item creates a signed address, and the &%prvscheck%& expansion item checks one.
31268 The syntax of these expansion items is described in section
31269 &<<SECTexpansionitems>>&.
31270
31271 As an example, suppose the secret per-address keys are stored in an MySQL
31272 database. A query to look up the key for an address could be defined as a macro
31273 like this:
31274 .code
31275 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
31276                 WHERE sender='${quote_mysql:$prvscheck_address}'\
31277                 }{$value}}
31278 .endd
31279 Suppose also that the senders who make use of BATV are defined by an address
31280 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
31281 use this:
31282 .code
31283 # Bounces: drop unsigned addresses for BATV senders
31284 deny message = This address does not send an unsigned reverse path
31285      senders = :
31286      recipients = +batv_senders
31287
31288 # Bounces: In case of prvs-signed address, check signature.
31289 deny message = Invalid reverse path signature.
31290      senders = :
31291      condition  = ${prvscheck {$local_part@$domain}\
31292                   {PRVSCHECK_SQL}{1}}
31293      !condition = $prvscheck_result
31294 .endd
31295 The first statement rejects recipients for bounce messages that are addressed
31296 to plain BATV sender addresses, because it is known that BATV senders do not
31297 send out messages with plain sender addresses. The second statement rejects
31298 recipients that are prvs-signed, but with invalid signatures (either because
31299 the key is wrong, or the signature has timed out).
31300
31301 A non-prvs-signed address is not rejected by the second statement, because the
31302 &%prvscheck%& expansion yields an empty string if its first argument is not a
31303 prvs-signed address, thus causing the &%condition%& condition to be false. If
31304 the first argument is a syntactically valid prvs-signed address, the yield is
31305 the third string (in this case &"1"&), whether or not the cryptographic and
31306 timeout checks succeed. The &$prvscheck_result$& variable contains the result
31307 of the checks (empty for failure, &"1"& for success).
31308
31309 There is one more issue you must consider when implementing prvs-signing:
31310 you have to ensure that the routers accept prvs-signed addresses and
31311 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
31312 router to remove the signature with a configuration along these lines:
31313 .code
31314 batv_redirect:
31315   driver = redirect
31316   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
31317 .endd
31318 This works because, if the third argument of &%prvscheck%& is empty, the result
31319 of the expansion of a prvs-signed address is the decoded value of the original
31320 address. This router should probably be the first of your routers that handles
31321 local addresses.
31322
31323 To create BATV-signed addresses in the first place, a transport of this form
31324 can be used:
31325 .code
31326 external_smtp_batv:
31327   driver = smtp
31328   return_path = ${prvs {$return_path} \
31329                        {${lookup mysql{SELECT \
31330                        secret FROM batv_prvs WHERE \
31331                        sender='${quote_mysql:$sender_address}'} \
31332                        {$value}fail}}}
31333 .endd
31334 If no key can be found for the existing return path, no signing takes place.
31335
31336
31337
31338 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31339 .cindex "&ACL;" "relay control"
31340 .cindex "relaying" "control by ACL"
31341 .cindex "policy control" "relay control"
31342 An MTA is said to &'relay'& a message if it receives it from some host and
31343 delivers it directly to another host as a result of a remote address contained
31344 within it. Redirecting a local address via an alias or forward file and then
31345 passing the message on to another host is not relaying,
31346 .cindex "&""percent hack""&"
31347 but a redirection as a result of the &"percent hack"& is.
31348
31349 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31350 A host which is acting as a gateway or an MX backup is concerned with incoming
31351 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31352 a host which is acting as a smart host for a number of clients is concerned
31353 with outgoing relaying from those clients to the Internet at large. Often the
31354 same host is fulfilling both functions,
31355 . ///
31356 . as illustrated in the diagram below,
31357 . ///
31358 but in principle these two kinds of relaying are entirely independent. What is
31359 not wanted is the transmission of mail from arbitrary remote hosts through your
31360 system to arbitrary domains.
31361
31362
31363 You can implement relay control by means of suitable statements in the ACL that
31364 runs for each RCPT command. For convenience, it is often easiest to use
31365 Exim's named list facility to define the domains and hosts involved. For
31366 example, suppose you want to do the following:
31367
31368 .ilist
31369 Deliver a number of domains to mailboxes on the local host (or process them
31370 locally in some other way). Let's say these are &'my.dom1.example'& and
31371 &'my.dom2.example'&.
31372 .next
31373 Relay mail for a number of other domains for which you are the secondary MX.
31374 These might be &'friend1.example'& and &'friend2.example'&.
31375 .next
31376 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31377 Suppose your LAN is 192.168.45.0/24.
31378 .endlist
31379
31380
31381 In the main part of the configuration, you put the following definitions:
31382 .code
31383 domainlist local_domains    = my.dom1.example : my.dom2.example
31384 domainlist relay_to_domains = friend1.example : friend2.example
31385 hostlist   relay_from_hosts = 192.168.45.0/24
31386 .endd
31387 Now you can use these definitions in the ACL that is run for every RCPT
31388 command:
31389 .code
31390 acl_check_rcpt:
31391   accept domains = +local_domains : +relay_to_domains
31392   accept hosts   = +relay_from_hosts
31393 .endd
31394 The first statement accepts any RCPT command that contains an address in
31395 the local or relay domains. For any other domain, control passes to the second
31396 statement, which accepts the command only if it comes from one of the relay
31397 hosts. In practice, you will probably want to make your ACL more sophisticated
31398 than this, for example, by including sender and recipient verification. The
31399 default configuration includes a more comprehensive example, which is described
31400 in chapter &<<CHAPdefconfil>>&.
31401
31402
31403
31404 .section "Checking a relay configuration" "SECTcheralcon"
31405 .cindex "relaying" "checking control of"
31406 You can check the relay characteristics of your configuration in the same way
31407 that you can test any ACL behaviour for an incoming SMTP connection, by using
31408 the &%-bh%& option to run a fake SMTP session with which you interact.
31409 .ecindex IIDacl
31410
31411
31412
31413 . ////////////////////////////////////////////////////////////////////////////
31414 . ////////////////////////////////////////////////////////////////////////////
31415
31416 .chapter "Content scanning at ACL time" "CHAPexiscan"
31417 .scindex IIDcosca "content scanning" "at ACL time"
31418 The extension of Exim to include content scanning at ACL time, formerly known
31419 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31420 was integrated into the main source for Exim release 4.50, and Tom continues to
31421 maintain it. Most of the wording of this chapter is taken from Tom's
31422 specification.
31423
31424 It is also possible to scan the content of messages at other times. The
31425 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31426 scanning after all the ACLs have run. A transport filter can be used to scan
31427 messages at delivery time (see the &%transport_filter%& option, described in
31428 chapter &<<CHAPtransportgeneric>>&).
31429
31430 If you want to include the ACL-time content-scanning features when you compile
31431 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31432 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31433
31434 .ilist
31435 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31436 for all MIME parts for SMTP and non-SMTP messages, respectively.
31437 .next
31438 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31439 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31440 run at the end of message reception (the &%acl_smtp_data%& ACL).
31441 .next
31442 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31443 of messages, or parts of messages, for debugging purposes.
31444 .next
31445 Additional expansion variables that are set in the new ACL and by the new
31446 conditions.
31447 .next
31448 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31449 .endlist
31450
31451 Content-scanning is continually evolving, and new features are still being
31452 added. While such features are still unstable and liable to incompatible
31453 changes, they are made available in Exim by setting options whose names begin
31454 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31455 this manual. You can find out about them by reading the file called
31456 &_doc/experimental.txt_&.
31457
31458 All the content-scanning facilities work on a MBOX copy of the message that is
31459 temporarily created in a file called:
31460 .display
31461 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31462 .endd
31463 The &_.eml_& extension is a friendly hint to virus scanners that they can
31464 expect an MBOX-like structure inside that file. The file is created when the
31465 first content scanning facility is called. Subsequent calls to content
31466 scanning conditions open the same file again. The directory is recursively
31467 removed when the &%acl_smtp_data%& ACL has finished running, unless
31468 .code
31469 control = no_mbox_unspool
31470 .endd
31471 has been encountered. When the MIME ACL decodes files, they are put into the
31472 same directory by default.
31473
31474
31475
31476 .section "Scanning for viruses" "SECTscanvirus"
31477 .cindex "virus scanning"
31478 .cindex "content scanning" "for viruses"
31479 .cindex "content scanning" "the &%malware%& condition"
31480 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31481 It supports a &"generic"& interface to scanners called via the shell, and
31482 specialized interfaces for &"daemon"& type virus scanners, which are resident
31483 in memory and thus are much faster.
31484
31485 A timeout of 2 minutes is applied to a scanner call (by default);
31486 if it expires then a defer action is taken.
31487
31488 .oindex "&%av_scanner%&"
31489 You can set the &%av_scanner%& option in the main part of the configuration
31490 to specify which scanner to use, together with any additional options that
31491 are needed. The basic syntax is as follows:
31492 .display
31493 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31494 .endd
31495 If you do not set &%av_scanner%&, it defaults to
31496 .code
31497 av_scanner = sophie:/var/run/sophie
31498 .endd
31499 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31500 before use.
31501 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31502 The following scanner types are supported in this release:
31503
31504 .vlist
31505 .vitem &%avast%&
31506 .cindex "virus scanners" "avast"
31507 This is the scanner daemon of Avast. It has been tested with Avast Core
31508 Security (currently at version 1.1.7).
31509 You can get a trial version at &url(http://www.avast.com) or for Linux
31510 at &url(http://www.avast.com/linux-server-antivirus).
31511 This scanner type takes one option,
31512 which can be either a full path to a UNIX socket,
31513 or host and port specifiers separated by white space.
31514 The host may be a name or an IP address; the port is either a
31515 single number or a pair of numbers with a dash between.
31516 Any further options are given, on separate lines,
31517 to the daemon as options before the main scan command.
31518 For example:
31519 .code
31520 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31521 av_scanner = avast:192.168.2.22 5036
31522 .endd
31523 If you omit the argument, the default path
31524 &_/var/run/avast/scan.sock_&
31525 is used.
31526 If you use a remote host,
31527 you need to make Exim's spool directory available to it,
31528 as the scanner is passed a file path, not file contents.
31529 For information about available commands and their options you may use
31530 .code
31531 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31532     FLAGS
31533     SENSITIVITY
31534     PACK
31535 .endd
31536
31537
31538 .vitem &%aveserver%&
31539 .cindex "virus scanners" "Kaspersky"
31540 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31541 at &url(http://www.kaspersky.com). This scanner type takes one option,
31542 which is the path to the daemon's UNIX socket. The default is shown in this
31543 example:
31544 .code
31545 av_scanner = aveserver:/var/run/aveserver
31546 .endd
31547
31548
31549 .vitem &%clamd%&
31550 .cindex "virus scanners" "clamd"
31551 This daemon-type scanner is GPL and free. You can get it at
31552 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31553 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31554 in the MIME ACL. This is no longer believed to be necessary.
31555
31556 The options are a list of server specifiers, which may be
31557 a UNIX socket specification,
31558 a TCP socket specification,
31559 or a (global) option.
31560
31561 A socket specification consists of a space-separated list.
31562 For a Unix socket the first element is a full path for the socket,
31563 for a TCP socket the first element is the IP address
31564 and the second a port number,
31565 Any further elements are per-server (non-global) options.
31566 These per-server options are supported:
31567 .code
31568 retry=<timespec>        Retry on connect fail
31569 .endd
31570
31571 The &`retry`& option specifies a time after which a single retry for
31572 a failed connect is made.  The default is to not retry.
31573
31574 If a Unix socket file is specified, only one server is supported.
31575
31576 Examples:
31577 .code
31578 av_scanner = clamd:/opt/clamd/socket
31579 av_scanner = clamd:192.0.2.3 1234
31580 av_scanner = clamd:192.0.2.3 1234:local
31581 av_scanner = clamd:192.0.2.3 1234 retry=10s
31582 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31583 .endd
31584 If the value of av_scanner points to a UNIX socket file or contains the
31585 &`local`&
31586 option, then the ClamAV interface will pass a filename containing the data
31587 to be scanned, which will should normally result in less I/O happening and be
31588 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31589 Exim does not assume that there is a common filesystem with the remote host.
31590 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31591 you be running a version of ClamAV prior to 0.95.
31592
31593 The final example shows that multiple TCP targets can be specified.  Exim will
31594 randomly use one for each incoming email (i.e. it load balances them).  Note
31595 that only TCP targets may be used if specifying a list of scanners; a UNIX
31596 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31597 unavailable, Exim will try the remaining one(s) until it finds one that works.
31598 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31599 not keep track of scanner state between multiple messages, and the scanner
31600 selection is random, so the message will get logged in the mainlog for each
31601 email that the down scanner gets chosen first (message wrapped to be readable):
31602 .code
31603 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31604    clamd: connection to localhost, port 3310 failed
31605    (Connection refused)
31606 .endd
31607
31608 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31609 contributing the code for this scanner.
31610
31611 .vitem &%cmdline%&
31612 .cindex "virus scanners" "command line interface"
31613 This is the keyword for the generic command line scanner interface. It can be
31614 used to attach virus scanners that are invoked from the shell. This scanner
31615 type takes 3 mandatory options:
31616
31617 .olist
31618 The full path and name of the scanner binary, with all command line options,
31619 and a placeholder (&`%s`&) for the directory to scan.
31620
31621 .next
31622 A regular expression to match against the STDOUT and STDERR output of the
31623 virus scanner. If the expression matches, a virus was found. You must make
31624 absolutely sure that this expression matches on &"virus found"&. This is called
31625 the &"trigger"& expression.
31626
31627 .next
31628 Another regular expression, containing exactly one pair of parentheses, to
31629 match the name of the virus found in the scanners output. This is called the
31630 &"name"& expression.
31631 .endlist olist
31632
31633 For example, Sophos Sweep reports a virus on a line like this:
31634 .code
31635 Virus 'W32/Magistr-B' found in file ./those.bat
31636 .endd
31637 For the trigger expression, we can match the phrase &"found in file"&. For the
31638 name expression, we want to extract the W32/Magistr-B string, so we can match
31639 for the single quotes left and right of it. Altogether, this makes the
31640 configuration setting:
31641 .code
31642 av_scanner = cmdline:\
31643              /path/to/sweep -ss -all -rec -archive %s:\
31644              found in file:'(.+)'
31645 .endd
31646 .vitem &%drweb%&
31647 .cindex "virus scanners" "DrWeb"
31648 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31649 takes one option,
31650 either a full path to a UNIX socket,
31651 or host and port specifiers separated by white space.
31652 The host may be a name or an IP address; the port is either a
31653 single number or a pair of numbers with a dash between.
31654 For example:
31655 .code
31656 av_scanner = drweb:/var/run/drwebd.sock
31657 av_scanner = drweb:192.168.2.20 31337
31658 .endd
31659 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31660 is used. Thanks to Alex Miller for contributing the code for this scanner.
31661
31662 .vitem &%f-protd%&
31663 .cindex "virus scanners" "f-protd"
31664 The f-protd scanner is accessed via HTTP over TCP.
31665 One argument is taken, being a space-separated hostname and port number
31666 (or port-range).
31667 For example:
31668 .code
31669 av_scanner = f-protd:localhost 10200-10204
31670 .endd
31671 If you omit the argument, the default values show above are used.
31672
31673 .new
31674 .vitem &%f-prot6d%&
31675 .cindex "virus scanners" "f-prot6d"
31676 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
31677 One argument is taken, being a space-separated hostname and port number.
31678 For example:
31679 .code
31680 av_scanner = f-prot6d:localhost 10200
31681 .endd
31682 If you omit the argument, the default values show above are used.
31683 .wen
31684
31685 .vitem &%fsecure%&
31686 .cindex "virus scanners" "F-Secure"
31687 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31688 argument which is the path to a UNIX socket. For example:
31689 .code
31690 av_scanner = fsecure:/path/to/.fsav
31691 .endd
31692 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31693 Thelmen for contributing the code for this scanner.
31694
31695 .vitem &%kavdaemon%&
31696 .cindex "virus scanners" "Kaspersky"
31697 This is the scanner daemon of Kaspersky Version 4. This version of the
31698 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31699 scanner type takes one option, which is the path to the daemon's UNIX socket.
31700 For example:
31701 .code
31702 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31703 .endd
31704 The default path is &_/var/run/AvpCtl_&.
31705
31706 .vitem &%mksd%&
31707 .cindex "virus scanners" "mksd"
31708 This is a daemon type scanner that is aimed mainly at Polish users, though some
31709 parts of documentation are now available in English. You can get it at
31710 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31711 the maximum number of processes used simultaneously to scan the attachments,
31712 provided that mksd has
31713 been run with at least the same number of child processes. For example:
31714 .code
31715 av_scanner = mksd:2
31716 .endd
31717 You can safely omit this option (the default value is 1).
31718
31719 .vitem &%sock%&
31720 .cindex "virus scanners" "simple socket-connected"
31721 This is a general-purpose way of talking to simple scanner daemons
31722 running on the local machine.
31723 There are four options:
31724 an address (which may be an IP address and port, or the path of a Unix socket),
31725 a commandline to send (may include a single %s which will be replaced with
31726 the path to the mail file to be scanned),
31727 an RE to trigger on from the returned data,
31728 and an RE to extract malware_name from the returned data.
31729 For example:
31730 .code
31731 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
31732 .endd
31733 .new
31734 Note that surrounding whitespace is stripped from each option, meaning
31735 there is no way to specify a trailing newline.
31736 The socket specifier and both regular-expressions are required.
31737 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
31738 specify an empty element to get this.
31739 .wen
31740
31741 .vitem &%sophie%&
31742 .cindex "virus scanners" "Sophos and Sophie"
31743 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31744 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31745 for this scanner type is the path to the UNIX socket that Sophie uses for
31746 client communication. For example:
31747 .code
31748 av_scanner = sophie:/tmp/sophie
31749 .endd
31750 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31751 the option.
31752 .endlist
31753
31754 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31755 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31756 ACL.
31757
31758 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31759 makes it possible to use different scanners. See further below for an example.
31760 The &%malware%& condition caches its results, so when you use it multiple times
31761 for the same message, the actual scanning process is only carried out once.
31762 However, using expandable items in &%av_scanner%& disables this caching, in
31763 which case each use of the &%malware%& condition causes a new scan of the
31764 message.
31765
31766 The &%malware%& condition takes a right-hand argument that is expanded before
31767 use and taken as a list, slash-separated by default.
31768 The first element can then be one of
31769
31770 .ilist
31771 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31772 The condition succeeds if a virus was found, and fail otherwise. This is the
31773 recommended usage.
31774 .next
31775 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31776 the condition fails immediately.
31777 .next
31778 A regular expression, in which case the message is scanned for viruses. The
31779 condition succeeds if a virus is found and its name matches the regular
31780 expression. This allows you to take special actions on certain types of virus.
31781 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31782 unless the separator is changed (in the usual way).
31783 .endlist
31784
31785 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31786 messages even if there is a problem with the virus scanner.
31787 Otherwise, such a problem causes the ACL to defer.
31788
31789 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31790 specify a non-default timeout.  The default is two minutes.
31791 For example:
31792 .code
31793 malware = * / defer_ok / tmo=10s
31794 .endd
31795 A timeout causes the ACL to defer.
31796
31797 .vindex "&$callout_address$&"
31798 When a connection is made to the scanner the expansion variable &$callout_address$&
31799 is set to record the actual address used.
31800
31801 .vindex "&$malware_name$&"
31802 When a virus is found, the condition sets up an expansion variable called
31803 &$malware_name$& that contains the name of the virus. You can use it in a
31804 &%message%& modifier that specifies the error returned to the sender, and/or in
31805 logging data.
31806
31807 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31808 imposed by your anti-virus scanner.
31809
31810 Here is a very simple scanning example:
31811 .code
31812 deny message = This message contains malware ($malware_name)
31813      malware = *
31814 .endd
31815 The next example accepts messages when there is a problem with the scanner:
31816 .code
31817 deny message = This message contains malware ($malware_name)
31818      malware = */defer_ok
31819 .endd
31820 The next example shows how to use an ACL variable to scan with both sophie and
31821 aveserver. It assumes you have set:
31822 .code
31823 av_scanner = $acl_m0
31824 .endd
31825 in the main Exim configuration.
31826 .code
31827 deny message = This message contains malware ($malware_name)
31828      set acl_m0 = sophie
31829      malware = *
31830
31831 deny message = This message contains malware ($malware_name)
31832      set acl_m0 = aveserver
31833      malware = *
31834 .endd
31835
31836
31837 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31838 .cindex "content scanning" "for spam"
31839 .cindex "spam scanning"
31840 .cindex "SpamAssassin"
31841 .cindex "Rspamd"
31842 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31843 score and a report for the message.
31844 Support is also provided for Rspamd.
31845
31846 For more information about installation and configuration of SpamAssassin or
31847 Rspamd refer to their respective websites at
31848 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31849
31850 SpamAssassin can be installed with CPAN by running:
31851 .code
31852 perl -MCPAN -e 'install Mail::SpamAssassin'
31853 .endd
31854 SpamAssassin has its own set of configuration files. Please review its
31855 documentation to see how you can tweak it. The default installation should work
31856 nicely, however.
31857
31858 .oindex "&%spamd_address%&"
31859 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31860 intend to use an instance running on the local host you do not need to set
31861 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31862 you must set the &%spamd_address%& option in the global part of the Exim
31863 configuration as follows (example):
31864 .code
31865 spamd_address = 192.168.99.45 387
31866 .endd
31867 The SpamAssassin protocol relies on a TCP half-close from the client.
31868 If your SpamAssassin client side is running a Linux system with an
31869 iptables firewall, consider setting
31870 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
31871 timeout, Exim uses when waiting for a response from the SpamAssassin
31872 server (currently defaulting to 120s).  With a lower value the Linux
31873 connection tracking may consider your half-closed connection as dead too
31874 soon.
31875
31876
31877 To use Rspamd (which by default listens on all local addresses
31878 on TCP port 11333)
31879 you should add &%variant=rspamd%& after the address/port pair, for example:
31880 .code
31881 spamd_address = 127.0.0.1 11333 variant=rspamd
31882 .endd
31883
31884 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31885 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31886 file name instead of an address/port pair:
31887 .code
31888 spamd_address = /var/run/spamd_socket
31889 .endd
31890 You can have multiple &%spamd%& servers to improve scalability. These can
31891 reside on other hardware reachable over the network. To specify multiple
31892 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31893 option, separated with colons (the separator can be changed in the usual way):
31894 .code
31895 spamd_address = 192.168.2.10 783 : \
31896                 192.168.2.11 783 : \
31897                 192.168.2.12 783
31898 .endd
31899 Up to 32 &%spamd%& servers are supported.
31900 When a server fails to respond to the connection attempt, all other
31901 servers are tried until one succeeds. If no server responds, the &%spam%&
31902 condition defers.
31903
31904 Unix and TCP socket specifications may be mixed in any order.
31905 Each element of the list is a list itself, space-separated by default
31906 and changeable in the usual way; take care to not double the separator.
31907
31908 For TCP socket specifications a host name or IP (v4 or v6, but
31909 subject to list-separator quoting rules) address can be used,
31910 and the port can be one or a dash-separated pair.
31911 In the latter case, the range is tried in strict order.
31912
31913 Elements after the first for Unix sockets, or second for TCP socket,
31914 are options.
31915 The supported options are:
31916 .code
31917 pri=<priority>      Selection priority
31918 weight=<value>      Selection bias
31919 time=<start>-<end>  Use only between these times of day
31920 retry=<timespec>    Retry on connect fail
31921 tmo=<timespec>      Connection time limit
31922 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31923 .endd
31924
31925 The &`pri`& option specifies a priority for the server within the list,
31926 higher values being tried first.
31927 The default priority is 1.
31928
31929 The &`weight`& option specifies a selection bias.
31930 Within a priority set
31931 servers are queried in a random fashion, weighted by this value.
31932 The default value for selection bias is 1.
31933
31934 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31935 in the local time zone; each element being one or more digits.
31936 Either the seconds or both minutes and seconds, plus the leading &`.`&
31937 characters, may be omitted and will be taken as zero.
31938
31939 Timeout specifications for the &`retry`& and &`tmo`& options
31940 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31941
31942 The &`tmo`& option specifies an overall timeout for communication.
31943 The default value is two minutes.
31944
31945 The &`retry`& option specifies a time after which a single retry for
31946 a failed connect is made.
31947 The default is to not retry.
31948
31949 The &%spamd_address%& variable is expanded before use if it starts with
31950 a dollar sign. In this case, the expansion may return a string that is
31951 used as the list so that multiple spamd servers can be the result of an
31952 expansion.
31953
31954 .vindex "&$callout_address$&"
31955 When a connection is made to the server the expansion variable &$callout_address$&
31956 is set to record the actual address used.
31957
31958 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31959 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31960 .code
31961 deny message = This message was classified as SPAM
31962      spam = joe
31963 .endd
31964 The right-hand side of the &%spam%& condition specifies a name. This is
31965 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31966 to scan using a specific profile, but rather use the SpamAssassin system-wide
31967 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31968 Rspamd does not use this setting. However, you must put something on the
31969 right-hand side.
31970
31971 The name allows you to use per-domain or per-user antispam profiles in
31972 principle, but this is not straightforward in practice, because a message may
31973 have multiple recipients, not necessarily all in the same domain. Because the
31974 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31975 read the contents of the message, the variables &$local_part$& and &$domain$&
31976 are not set.
31977 Careful enforcement of single-recipient messages
31978 (e.g. by responding with defer in the recipient ACL for all recipients
31979 after the first),
31980 or the use of PRDR,
31981 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31982 are needed to use this feature.
31983
31984 The right-hand side of the &%spam%& condition is expanded before being used, so
31985 you can put lookups or conditions there. When the right-hand side evaluates to
31986 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31987
31988
31989 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31990 large ones may cause significant performance degradation. As most spam messages
31991 are quite small, it is recommended that you do not scan the big ones. For
31992 example:
31993 .code
31994 deny message = This message was classified as SPAM
31995      condition = ${if < {$message_size}{10K}}
31996      spam = nobody
31997 .endd
31998
31999 The &%spam%& condition returns true if the threshold specified in the user's
32000 SpamAssassin profile has been matched or exceeded. If you want to use the
32001 &%spam%& condition for its side effects (see the variables below), you can make
32002 it always return &"true"& by appending &`:true`& to the username.
32003
32004 .cindex "spam scanning" "returned variables"
32005 When the &%spam%& condition is run, it sets up a number of expansion
32006 variables.
32007 Except for &$spam_report$&,
32008 these variables are saved with the received message so are
32009 available for use at delivery time.
32010
32011 .vlist
32012 .vitem &$spam_score$&
32013 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
32014 for inclusion in log or reject messages.
32015
32016 .vitem &$spam_score_int$&
32017 The spam score of the message, multiplied by ten, as an integer value. For
32018 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
32019 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
32020 The integer value is useful for numeric comparisons in conditions.
32021
32022 .vitem &$spam_bar$&
32023 A string consisting of a number of &"+"& or &"-"& characters, representing the
32024 integer part of the spam score value. A spam score of 4.4 would have a
32025 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
32026 headers, since MUAs can match on such strings. The maximum length of the
32027 spam bar is 50 characters.
32028
32029 .vitem &$spam_report$&
32030 A multiline text table, containing the full SpamAssassin report for the
32031 message. Useful for inclusion in headers or reject messages.
32032 This variable is only usable in a DATA-time ACL.
32033 Beware that SpamAssassin may return non-ASCII characters, especially
32034 when running in country-specific locales, which are not legal
32035 unencoded in headers.
32036
32037 .vitem &$spam_action$&
32038 For SpamAssassin either 'reject' or 'no action' depending on the
32039 spam score versus threshold.
32040 For Rspamd, the recommended action.
32041
32042 .endlist
32043
32044 The &%spam%& condition caches its results unless expansion in
32045 spamd_address was used. If you call it again with the same user name, it
32046 does not scan again, but rather returns the same values as before.
32047
32048 The &%spam%& condition returns DEFER if there is any error while running
32049 the message through SpamAssassin or if the expansion of spamd_address
32050 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
32051 statement block), append &`/defer_ok`& to the right-hand side of the
32052 spam condition, like this:
32053 .code
32054 deny message = This message was classified as SPAM
32055      spam    = joe/defer_ok
32056 .endd
32057 This causes messages to be accepted even if there is a problem with &%spamd%&.
32058
32059 Here is a longer, commented example of the use of the &%spam%&
32060 condition:
32061 .code
32062 # put headers in all messages (no matter if spam or not)
32063 warn  spam = nobody:true
32064       add_header = X-Spam-Score: $spam_score ($spam_bar)
32065       add_header = X-Spam-Report: $spam_report
32066
32067 # add second subject line with *SPAM* marker when message
32068 # is over threshold
32069 warn  spam = nobody
32070       add_header = Subject: *SPAM* $h_Subject:
32071
32072 # reject spam at high scores (> 12)
32073 deny  message = This message scored $spam_score spam points.
32074       spam = nobody:true
32075       condition = ${if >{$spam_score_int}{120}{1}{0}}
32076 .endd
32077
32078
32079
32080 .section "Scanning MIME parts" "SECTscanmimepart"
32081 .cindex "content scanning" "MIME parts"
32082 .cindex "MIME content scanning"
32083 .oindex "&%acl_smtp_mime%&"
32084 .oindex "&%acl_not_smtp_mime%&"
32085 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
32086 each MIME part of an SMTP message, including multipart types, in the sequence
32087 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
32088 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
32089 options may both refer to the same ACL if you want the same processing in both
32090 cases.
32091
32092 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
32093 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
32094 the case of a non-SMTP message. However, a MIME ACL is called only if the
32095 message contains a &'Content-Type:'& header line. When a call to a MIME
32096 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
32097 result code is sent to the client. In the case of an SMTP message, the
32098 &%acl_smtp_data%& ACL is not called when this happens.
32099
32100 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
32101 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
32102 condition to match against the raw MIME part. You can also use the
32103 &%mime_regex%& condition to match against the decoded MIME part (see section
32104 &<<SECTscanregex>>&).
32105
32106 At the start of a MIME ACL, a number of variables are set from the header
32107 information for the relevant MIME part. These are described below. The contents
32108 of the MIME part are not by default decoded into a disk file except for MIME
32109 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
32110 part into a disk file, you can use the &%decode%& condition. The general
32111 syntax is:
32112 .display
32113 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
32114 .endd
32115 The right hand side is expanded before use. After expansion,
32116 the value can be:
32117
32118 .olist
32119 &"0"& or &"false"&, in which case no decoding is done.
32120 .next
32121 The string &"default"&. In that case, the file is put in the temporary
32122 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
32123 a sequential file name consisting of the message id and a sequence number. The
32124 full path and name is available in &$mime_decoded_filename$& after decoding.
32125 .next
32126 A full path name starting with a slash. If the full name is an existing
32127 directory, it is used as a replacement for the default directory. The filename
32128 is then sequentially assigned. If the path does not exist, it is used as
32129 the full path and file name.
32130 .next
32131 If the string does not start with a slash, it is used as the
32132 filename, and the default path is then used.
32133 .endlist
32134 The &%decode%& condition normally succeeds. It is only false for syntax
32135 errors or unusual circumstances such as memory shortages. You can easily decode
32136 a file with its original, proposed filename using
32137 .code
32138 decode = $mime_filename
32139 .endd
32140 However, you should keep in mind that &$mime_filename$& might contain
32141 anything. If you place files outside of the default path, they are not
32142 automatically unlinked.
32143
32144 For RFC822 attachments (these are messages attached to messages, with a
32145 content-type of &"message/rfc822"&), the ACL is called again in the same manner
32146 as for the primary message, only that the &$mime_is_rfc822$& expansion
32147 variable is set (see below). Attached messages are always decoded to disk
32148 before being checked, and the files are unlinked once the check is done.
32149
32150 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
32151 used to match regular expressions against raw and decoded MIME parts,
32152 respectively. They are described in section &<<SECTscanregex>>&.
32153
32154 .cindex "MIME content scanning" "returned variables"
32155 The following list describes all expansion variables that are
32156 available in the MIME ACL:
32157
32158 .vlist
32159 .vitem &$mime_boundary$&
32160 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
32161 have a boundary string, which is stored in this variable. If the current part
32162 has no boundary parameter in the &'Content-Type:'& header, this variable
32163 contains the empty string.
32164
32165 .vitem &$mime_charset$&
32166 This variable contains the character set identifier, if one was found in the
32167 &'Content-Type:'& header. Examples for charset identifiers are:
32168 .code
32169 us-ascii
32170 gb2312 (Chinese)
32171 iso-8859-1
32172 .endd
32173 Please note that this value is not normalized, so you should do matches
32174 case-insensitively.
32175
32176 .vitem &$mime_content_description$&
32177 This variable contains the normalized content of the &'Content-Description:'&
32178 header. It can contain a human-readable description of the parts content. Some
32179 implementations repeat the filename for attachments here, but they are usually
32180 only used for display purposes.
32181
32182 .vitem &$mime_content_disposition$&
32183 This variable contains the normalized content of the &'Content-Disposition:'&
32184 header. You can expect strings like &"attachment"& or &"inline"& here.
32185
32186 .vitem &$mime_content_id$&
32187 This variable contains the normalized content of the &'Content-ID:'& header.
32188 This is a unique ID that can be used to reference a part from another part.
32189
32190 .vitem &$mime_content_size$&
32191 This variable is set only after the &%decode%& modifier (see above) has been
32192 successfully run. It contains the size of the decoded part in kilobytes. The
32193 size is always rounded up to full kilobytes, so only a completely empty part
32194 has a &$mime_content_size$& of zero.
32195
32196 .vitem &$mime_content_transfer_encoding$&
32197 This variable contains the normalized content of the
32198 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
32199 type. Typical values are &"base64"& and &"quoted-printable"&.
32200
32201 .vitem &$mime_content_type$&
32202 If the MIME part has a &'Content-Type:'& header, this variable contains its
32203 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
32204 are some examples of popular MIME types, as they may appear in this variable:
32205 .code
32206 text/plain
32207 text/html
32208 application/octet-stream
32209 image/jpeg
32210 audio/midi
32211 .endd
32212 If the MIME part has no &'Content-Type:'& header, this variable contains the
32213 empty string.
32214
32215 .vitem &$mime_decoded_filename$&
32216 This variable is set only after the &%decode%& modifier (see above) has been
32217 successfully run. It contains the full path and file name of the file
32218 containing the decoded data.
32219 .endlist
32220
32221 .cindex "RFC 2047"
32222 .vlist
32223 .vitem &$mime_filename$&
32224 This is perhaps the most important of the MIME variables. It contains a
32225 proposed filename for an attachment, if one was found in either the
32226 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
32227 RFC2047
32228 or RFC2231
32229 decoded, but no additional sanity checks are done.
32230  If no filename was
32231 found, this variable contains the empty string.
32232
32233 .vitem &$mime_is_coverletter$&
32234 This variable attempts to differentiate the &"cover letter"& of an e-mail from
32235 attached data. It can be used to clamp down on flashy or unnecessarily encoded
32236 content in the cover letter, while not restricting attachments at all.
32237
32238 The variable contains 1 (true) for a MIME part believed to be part of the
32239 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
32240 follows:
32241
32242 .olist
32243 The outermost MIME part of a message is always a cover letter.
32244
32245 .next
32246 If a multipart/alternative or multipart/related MIME part is a cover letter,
32247 so are all MIME subparts within that multipart.
32248
32249 .next
32250 If any other multipart is a cover letter, the first subpart is a cover letter,
32251 and the rest are attachments.
32252
32253 .next
32254 All parts contained within an attachment multipart are attachments.
32255 .endlist olist
32256
32257 As an example, the following will ban &"HTML mail"& (including that sent with
32258 alternative plain text), while allowing HTML files to be attached. HTML
32259 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
32260 .code
32261 deny message = HTML mail is not accepted here
32262 !condition = $mime_is_rfc822
32263 condition = $mime_is_coverletter
32264 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
32265 .endd
32266 .vitem &$mime_is_multipart$&
32267 This variable has the value 1 (true) when the current part has the main type
32268 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
32269 Since multipart entities only serve as containers for other parts, you may not
32270 want to carry out specific actions on them.
32271
32272 .vitem &$mime_is_rfc822$&
32273 This variable has the value 1 (true) if the current part is not a part of the
32274 checked message itself, but part of an attached message. Attached message
32275 decoding is fully recursive.
32276
32277 .vitem &$mime_part_count$&
32278 This variable is a counter that is raised for each processed MIME part. It
32279 starts at zero for the very first part (which is usually a multipart). The
32280 counter is per-message, so it is reset when processing RFC822 attachments (see
32281 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
32282 complete, so you can use it in the DATA ACL to determine the number of MIME
32283 parts of a message. For non-MIME messages, this variable contains the value -1.
32284 .endlist
32285
32286
32287
32288 .section "Scanning with regular expressions" "SECTscanregex"
32289 .cindex "content scanning" "with regular expressions"
32290 .cindex "regular expressions" "content scanning with"
32291 You can specify your own custom regular expression matches on the full body of
32292 the message, or on individual MIME parts.
32293
32294 The &%regex%& condition takes one or more regular expressions as arguments and
32295 matches them against the full message (when called in the DATA ACL) or a raw
32296 MIME part (when called in the MIME ACL). The &%regex%& condition matches
32297 linewise, with a maximum line length of 32K characters. That means you cannot
32298 have multiline matches with the &%regex%& condition.
32299
32300 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
32301 to 32K of decoded content (the whole content at once, not linewise). If the
32302 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
32303 is decoded automatically when &%mime_regex%& is executed (using default path
32304 and filename values). If the decoded data is larger than  32K, only the first
32305 32K characters are checked.
32306
32307 The regular expressions are passed as a colon-separated list. To include a
32308 literal colon, you must double it. Since the whole right-hand side string is
32309 expanded before being used, you must also escape dollar signs and backslashes
32310 with more backslashes, or use the &`\N`& facility to disable expansion.
32311 Here is a simple example that contains two regular expressions:
32312 .code
32313 deny message = contains blacklisted regex ($regex_match_string)
32314      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
32315 .endd
32316 The conditions returns true if any one of the regular expressions matches. The
32317 &$regex_match_string$& expansion variable is then set up and contains the
32318 matching regular expression.
32319 The expansion variables &$regex1$& &$regex2$& etc
32320 are set to any substrings captured by the regular expression.
32321
32322 &*Warning*&: With large messages, these conditions can be fairly
32323 CPU-intensive.
32324
32325 .ecindex IIDcosca
32326
32327
32328
32329
32330 . ////////////////////////////////////////////////////////////////////////////
32331 . ////////////////////////////////////////////////////////////////////////////
32332
32333 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32334          "Local scan function"
32335 .scindex IIDlosca "&[local_scan()]& function" "description of"
32336 .cindex "customizing" "input scan using C function"
32337 .cindex "policy control" "by local scan function"
32338 In these days of email worms, viruses, and ever-increasing spam, some sites
32339 want to apply a lot of checking to messages before accepting them.
32340
32341 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32342 passing messages to external virus and spam scanning software. You can also do
32343 a certain amount in Exim itself through string expansions and the &%condition%&
32344 condition in the ACL that runs after the SMTP DATA command or the ACL for
32345 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32346
32347 To allow for further customization to a site's own requirements, there is the
32348 possibility of linking Exim with a private message scanning function, written
32349 in C. If you want to run code that is written in something other than C, you
32350 can of course use a little C stub to call it.
32351
32352 The local scan function is run once for every incoming message, at the point
32353 when Exim is just about to accept the message.
32354 It can therefore be used to control non-SMTP messages from local processes as
32355 well as messages arriving via SMTP.
32356
32357 Exim applies a timeout to calls of the local scan function, and there is an
32358 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32359 Zero means &"no timeout"&.
32360 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32361 before calling the local scan function, so that the most common types of crash
32362 are caught. If the timeout is exceeded or one of those signals is caught, the
32363 incoming message is rejected with a temporary error if it is an SMTP message.
32364 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32365 code. The incident is logged on the main and reject logs.
32366
32367
32368
32369 .section "Building Exim to use a local scan function" "SECID207"
32370 .cindex "&[local_scan()]& function" "building Exim to use"
32371 To make use of the local scan function feature, you must tell Exim where your
32372 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32373 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32374 directory, so you might set
32375 .code
32376 LOCAL_SCAN_SOURCE=Local/local_scan.c
32377 .endd
32378 for example. The function must be called &[local_scan()]&. It is called by
32379 Exim after it has received a message, when the success return code is about to
32380 be sent. This is after all the ACLs have been run. The return code from your
32381 function controls whether the message is actually accepted or not. There is a
32382 commented template function (that just accepts the message) in the file
32383 _src/local_scan.c_.
32384
32385 If you want to make use of Exim's run time configuration file to set options
32386 for your &[local_scan()]& function, you must also set
32387 .code
32388 LOCAL_SCAN_HAS_OPTIONS=yes
32389 .endd
32390 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32391
32392
32393
32394
32395 .section "API for local_scan()" "SECTapiforloc"
32396 .cindex "&[local_scan()]& function" "API description"
32397 You must include this line near the start of your code:
32398 .code
32399 #include "local_scan.h"
32400 .endd
32401 This header file defines a number of variables and other values, and the
32402 prototype for the function itself. Exim is coded to use unsigned char values
32403 almost exclusively, and one of the things this header defines is a shorthand
32404 for &`unsigned char`& called &`uschar`&.
32405 It also contains the following macro definitions, to simplify casting character
32406 strings and pointers to character strings:
32407 .code
32408 #define CS   (char *)
32409 #define CCS  (const char *)
32410 #define CSS  (char **)
32411 #define US   (unsigned char *)
32412 #define CUS  (const unsigned char *)
32413 #define USS  (unsigned char **)
32414 .endd
32415 The function prototype for &[local_scan()]& is:
32416 .code
32417 extern int local_scan(int fd, uschar **return_text);
32418 .endd
32419 The arguments are as follows:
32420
32421 .ilist
32422 &%fd%& is a file descriptor for the file that contains the body of the message
32423 (the -D file). The file is open for reading and writing, but updating it is not
32424 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32425
32426 The descriptor is positioned at character 19 of the file, which is the first
32427 character of the body itself, because the first 19 characters are the message
32428 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32429 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32430 case this changes in some future version.
32431 .next
32432 &%return_text%& is an address which you can use to return a pointer to a text
32433 string at the end of the function. The value it points to on entry is NULL.
32434 .endlist
32435
32436 The function must return an &%int%& value which is one of the following macros:
32437
32438 .vlist
32439 .vitem &`LOCAL_SCAN_ACCEPT`&
32440 .vindex "&$local_scan_data$&"
32441 The message is accepted. If you pass back a string of text, it is saved with
32442 the message, and made available in the variable &$local_scan_data$&. No
32443 newlines are permitted (if there are any, they are turned into spaces) and the
32444 maximum length of text is 1000 characters.
32445
32446 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32447 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32448 queued without immediate delivery, and is frozen.
32449
32450 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32451 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32452 queued without immediate delivery.
32453
32454 .vitem &`LOCAL_SCAN_REJECT`&
32455 The message is rejected; the returned text is used as an error message which is
32456 passed back to the sender and which is also logged. Newlines are permitted &--
32457 they cause a multiline response for SMTP rejections, but are converted to
32458 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32459 used.
32460
32461 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32462 The message is temporarily rejected; the returned text is used as an error
32463 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32464 problem"& is used.
32465
32466 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32467 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32468 message is not written to the reject log. It has the effect of unsetting the
32469 &%rejected_header%& log selector for just this rejection. If
32470 &%rejected_header%& is already unset (see the discussion of the
32471 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32472 same as LOCAL_SCAN_REJECT.
32473
32474 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32475 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32476 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32477 .endlist
32478
32479 If the message is not being received by interactive SMTP, rejections are
32480 reported by writing to &%stderr%& or by sending an email, as configured by the
32481 &%-oe%& command line options.
32482
32483
32484
32485 .section "Configuration options for local_scan()" "SECTconoptloc"
32486 .cindex "&[local_scan()]& function" "configuration options"
32487 It is possible to have option settings in the main configuration file
32488 that set values in static variables in the &[local_scan()]& module. If you
32489 want to do this, you must have the line
32490 .code
32491 LOCAL_SCAN_HAS_OPTIONS=yes
32492 .endd
32493 in your &_Local/Makefile_& when you build Exim. (This line is in
32494 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32495 file, you must define static variables to hold the option values, and a table
32496 to define them.
32497
32498 The table must be a vector called &%local_scan_options%&, of type
32499 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32500 and a pointer to the variable that holds the value. The entries must appear in
32501 alphabetical order. Following &%local_scan_options%& you must also define a
32502 variable called &%local_scan_options_count%& that contains the number of
32503 entries in the table. Here is a short example, showing two kinds of option:
32504 .code
32505 static int my_integer_option = 42;
32506 static uschar *my_string_option = US"a default string";
32507
32508 optionlist local_scan_options[] = {
32509   { "my_integer", opt_int,       &my_integer_option },
32510   { "my_string",  opt_stringptr, &my_string_option }
32511 };
32512
32513 int local_scan_options_count =
32514   sizeof(local_scan_options)/sizeof(optionlist);
32515 .endd
32516 The values of the variables can now be changed from Exim's runtime
32517 configuration file by including a local scan section as in this example:
32518 .code
32519 begin local_scan
32520 my_integer = 99
32521 my_string = some string of text...
32522 .endd
32523 The available types of option data are as follows:
32524
32525 .vlist
32526 .vitem &*opt_bool*&
32527 This specifies a boolean (true/false) option. The address should point to a
32528 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32529 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32530 whether such a variable has been set at all, you can initialize it to
32531 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32532 values.)
32533
32534 .vitem &*opt_fixed*&
32535 This specifies a fixed point number, such as is used for load averages.
32536 The address should point to a variable of type &`int`&. The value is stored
32537 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32538
32539 .vitem &*opt_int*&
32540 This specifies an integer; the address should point to a variable of type
32541 &`int`&. The value may be specified in any of the integer formats accepted by
32542 Exim.
32543
32544 .vitem &*opt_mkint*&
32545 This is the same as &%opt_int%&, except that when such a value is output in a
32546 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32547 printed with the suffix K or M.
32548
32549 .vitem &*opt_octint*&
32550 This also specifies an integer, but the value is always interpreted as an
32551 octal integer, whether or not it starts with the digit zero, and it is
32552 always output in octal.
32553
32554 .vitem &*opt_stringptr*&
32555 This specifies a string value; the address must be a pointer to a
32556 variable that points to a string (for example, of type &`uschar *`&).
32557
32558 .vitem &*opt_time*&
32559 This specifies a time interval value. The address must point to a variable of
32560 type &`int`&. The value that is placed there is a number of seconds.
32561 .endlist
32562
32563 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32564 out the values of all the &[local_scan()]& options.
32565
32566
32567
32568 .section "Available Exim variables" "SECID208"
32569 .cindex "&[local_scan()]& function" "available Exim variables"
32570 The header &_local_scan.h_& gives you access to a number of C variables. These
32571 are the only ones that are guaranteed to be maintained from release to release.
32572 Note, however, that you can obtain the value of any Exim expansion variable,
32573 including &$recipients$&, by calling &'expand_string()'&. The exported
32574 C variables are as follows:
32575
32576 .vlist
32577 .vitem &*int&~body_linecount*&
32578 This variable contains the number of lines in the message's body.
32579 .new
32580 It is not valid if the &%spool_files_wireformat%& option is used.
32581 .wen
32582
32583 .vitem &*int&~body_zerocount*&
32584 This variable contains the number of binary zero bytes in the message's body.
32585 .new
32586 It is not valid if the &%spool_files_wireformat%& option is used.
32587 .wen
32588
32589 .vitem &*unsigned&~int&~debug_selector*&
32590 This variable is set to zero when no debugging is taking place. Otherwise, it
32591 is a bitmap of debugging selectors. Two bits are identified for use in
32592 &[local_scan()]&; they are defined as macros:
32593
32594 .ilist
32595 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32596 testing option that is not privileged &-- any caller may set it. All the
32597 other selector bits can be set only by admin users.
32598
32599 .next
32600 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32601 by the &`+local_scan`& debug selector. It is not included in the default set
32602 of debugging bits.
32603 .endlist ilist
32604
32605 Thus, to write to the debugging output only when &`+local_scan`& has been
32606 selected, you should use code like this:
32607 .code
32608 if ((debug_selector & D_local_scan) != 0)
32609   debug_printf("xxx", ...);
32610 .endd
32611 .vitem &*uschar&~*expand_string_message*&
32612 After a failing call to &'expand_string()'& (returned value NULL), the
32613 variable &%expand_string_message%& contains the error message, zero-terminated.
32614
32615 .vitem &*header_line&~*header_list*&
32616 A pointer to a chain of header lines. The &%header_line%& structure is
32617 discussed below.
32618
32619 .vitem &*header_line&~*header_last*&
32620 A pointer to the last of the header lines.
32621
32622 .vitem &*uschar&~*headers_charset*&
32623 The value of the &%headers_charset%& configuration option.
32624
32625 .vitem &*BOOL&~host_checking*&
32626 This variable is TRUE during a host checking session that is initiated by the
32627 &%-bh%& command line option.
32628
32629 .vitem &*uschar&~*interface_address*&
32630 The IP address of the interface that received the message, as a string. This
32631 is NULL for locally submitted messages.
32632
32633 .vitem &*int&~interface_port*&
32634 The port on which this message was received. When testing with the &%-bh%&
32635 command line option, the value of this variable is -1 unless a port has been
32636 specified via the &%-oMi%& option.
32637
32638 .vitem &*uschar&~*message_id*&
32639 This variable contains Exim's message id for the incoming message (the value of
32640 &$message_exim_id$&) as a zero-terminated string.
32641
32642 .vitem &*uschar&~*received_protocol*&
32643 The name of the protocol by which the message was received.
32644
32645 .vitem &*int&~recipients_count*&
32646 The number of accepted recipients.
32647
32648 .vitem &*recipient_item&~*recipients_list*&
32649 .cindex "recipient" "adding in local scan"
32650 .cindex "recipient" "removing in local scan"
32651 The list of accepted recipients, held in a vector of length
32652 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32653 can add additional recipients by calling &'receive_add_recipient()'& (see
32654 below). You can delete recipients by removing them from the vector and
32655 adjusting the value in &%recipients_count%&. In particular, by setting
32656 &%recipients_count%& to zero you remove all recipients. If you then return the
32657 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32658 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32659 and then call &'receive_add_recipient()'& as often as needed.
32660
32661 .vitem &*uschar&~*sender_address*&
32662 The envelope sender address. For bounce messages this is the empty string.
32663
32664 .vitem &*uschar&~*sender_host_address*&
32665 The IP address of the sending host, as a string. This is NULL for
32666 locally-submitted messages.
32667
32668 .vitem &*uschar&~*sender_host_authenticated*&
32669 The name of the authentication mechanism that was used, or NULL if the message
32670 was not received over an authenticated SMTP connection.
32671
32672 .vitem &*uschar&~*sender_host_name*&
32673 The name of the sending host, if known.
32674
32675 .vitem &*int&~sender_host_port*&
32676 The port on the sending host.
32677
32678 .vitem &*BOOL&~smtp_input*&
32679 This variable is TRUE for all SMTP input, including BSMTP.
32680
32681 .vitem &*BOOL&~smtp_batched_input*&
32682 This variable is TRUE for BSMTP input.
32683
32684 .vitem &*int&~store_pool*&
32685 The contents of this variable control which pool of memory is used for new
32686 requests. See section &<<SECTmemhanloc>>& for details.
32687 .endlist
32688
32689
32690 .section "Structure of header lines" "SECID209"
32691 The &%header_line%& structure contains the members listed below.
32692 You can add additional header lines by calling the &'header_add()'& function
32693 (see below). You can cause header lines to be ignored (deleted) by setting
32694 their type to *.
32695
32696
32697 .vlist
32698 .vitem &*struct&~header_line&~*next*&
32699 A pointer to the next header line, or NULL for the last line.
32700
32701 .vitem &*int&~type*&
32702 A code identifying certain headers that Exim recognizes. The codes are printing
32703 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32704 Notice in particular that any header line whose type is * is not transmitted
32705 with the message. This flagging is used for header lines that have been
32706 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32707 lines.) Effectively, * means &"deleted"&.
32708
32709 .vitem &*int&~slen*&
32710 The number of characters in the header line, including the terminating and any
32711 internal newlines.
32712
32713 .vitem &*uschar&~*text*&
32714 A pointer to the text of the header. It always ends with a newline, followed by
32715 a zero byte. Internal newlines are preserved.
32716 .endlist
32717
32718
32719
32720 .section "Structure of recipient items" "SECID210"
32721 The &%recipient_item%& structure contains these members:
32722
32723 .vlist
32724 .vitem &*uschar&~*address*&
32725 This is a pointer to the recipient address as it was received.
32726
32727 .vitem &*int&~pno*&
32728 This is used in later Exim processing when top level addresses are created by
32729 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32730 and must always contain -1 at this stage.
32731
32732 .vitem &*uschar&~*errors_to*&
32733 If this value is not NULL, bounce messages caused by failing to deliver to the
32734 recipient are sent to the address it contains. In other words, it overrides the
32735 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32736 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32737 an unqualified address, Exim qualifies it using the domain from
32738 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32739 is NULL for all recipients.
32740 .endlist
32741
32742
32743
32744 .section "Available Exim functions" "SECID211"
32745 .cindex "&[local_scan()]& function" "available Exim functions"
32746 The header &_local_scan.h_& gives you access to a number of Exim functions.
32747 These are the only ones that are guaranteed to be maintained from release to
32748 release:
32749
32750 .vlist
32751 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32752        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32753
32754 This function creates a child process that runs the command specified by
32755 &%argv%&. The environment for the process is specified by &%envp%&, which can
32756 be NULL if no environment variables are to be passed. A new umask is supplied
32757 for the process in &%newumask%&.
32758
32759 Pipes to the standard input and output of the new process are set up
32760 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32761 standard error is cloned to the standard output. If there are any file
32762 descriptors &"in the way"& in the new process, they are closed. If the final
32763 argument is TRUE, the new process is made into a process group leader.
32764
32765 The function returns the pid of the new process, or -1 if things go wrong.
32766
32767 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32768 This function waits for a child process to terminate, or for a timeout (in
32769 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32770 return value is as follows:
32771
32772 .ilist
32773 >= 0
32774
32775 The process terminated by a normal exit and the value is the process
32776 ending status.
32777
32778 .next
32779 < 0 and > &--256
32780
32781 The process was terminated by a signal and the value is the negation of the
32782 signal number.
32783
32784 .next
32785 &--256
32786
32787 The process timed out.
32788 .next
32789 &--257
32790
32791 The was some other error in wait(); &%errno%& is still set.
32792 .endlist
32793
32794 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32795 This function provide you with a means of submitting a new message to
32796 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32797 want, but this packages it all up for you.) The function creates a pipe,
32798 forks a subprocess that is running
32799 .code
32800 exim -t -oem -oi -f <>
32801 .endd
32802 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32803 that is connected to the standard input. The yield of the function is the PID
32804 of the subprocess. You can then write a message to the file descriptor, with
32805 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32806
32807 When you have finished, call &'child_close()'& to wait for the process to
32808 finish and to collect its ending status. A timeout value of zero is usually
32809 fine in this circumstance. Unless you have made a mistake with the recipient
32810 addresses, you should get a return code of zero.
32811
32812
32813 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32814        *sender_authentication)*&
32815 This function is a more sophisticated version of &'child_open()'&. The command
32816 that it runs is:
32817 .display
32818 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32819 .endd
32820 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32821
32822
32823 .vitem &*void&~debug_printf(char&~*,&~...)*&
32824 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32825 output is written to the standard error stream. If no debugging is selected,
32826 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32827 conditional on the &`local_scan`& debug selector by coding like this:
32828 .code
32829 if ((debug_selector & D_local_scan) != 0)
32830   debug_printf("xxx", ...);
32831 .endd
32832
32833 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32834 This is an interface to Exim's string expansion code. The return value is the
32835 expanded string, or NULL if there was an expansion failure.
32836 The C variable &%expand_string_message%& contains an error message after an
32837 expansion failure. If expansion does not change the string, the return value is
32838 the pointer to the input string. Otherwise, the return value points to a new
32839 block of memory that was obtained by a call to &'store_get()'&. See section
32840 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32841
32842 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32843 This function allows you to an add additional header line at the end of the
32844 existing ones. The first argument is the type, and should normally be a space
32845 character. The second argument is a format string and any number of
32846 substitution arguments as for &[sprintf()]&. You may include internal newlines
32847 if you want, and you must ensure that the string ends with a newline.
32848
32849 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32850         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32851 This function adds a new header line at a specified point in the header
32852 chain. The header itself is specified as for &'header_add()'&.
32853
32854 If &%name%& is NULL, the new header is added at the end of the chain if
32855 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32856 NULL, the header lines are searched for the first non-deleted header that
32857 matches the name. If one is found, the new header is added before it if
32858 &%after%& is false. If &%after%& is true, the new header is added after the
32859 found header and any adjacent subsequent ones with the same name (even if
32860 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32861 option controls where the header is added. If it is true, addition is at the
32862 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32863 headers, or at the top if there are no &'Received:'& headers, you could use
32864 .code
32865 header_add_at_position(TRUE, US"Received", TRUE,
32866   ' ', "X-xxx: ...");
32867 .endd
32868 Normally, there is always at least one non-deleted &'Received:'& header, but
32869 there may not be if &%received_header_text%& expands to an empty string.
32870
32871
32872 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32873 This function removes header lines. If &%occurrence%& is zero or negative, all
32874 occurrences of the header are removed. If occurrence is greater than zero, that
32875 particular instance of the header is removed. If no header(s) can be found that
32876 match the specification, the function does nothing.
32877
32878
32879 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32880         int&~length,&~BOOL&~notdel)*&"
32881 This function tests whether the given header has the given name. It is not just
32882 a string comparison, because white space is permitted between the name and the
32883 colon. If the &%notdel%& argument is true, a false return is forced for all
32884 &"deleted"& headers; otherwise they are not treated specially. For example:
32885 .code
32886 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32887 .endd
32888 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32889 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32890 This function base64-encodes a string, which is passed by address and length.
32891 The text may contain bytes of any value, including zero. The result is passed
32892 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32893 zero-terminated.
32894
32895 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32896 This function decodes a base64-encoded string. Its arguments are a
32897 zero-terminated base64-encoded string and the address of a variable that is set
32898 to point to the result, which is in dynamic memory. The length of the decoded
32899 string is the yield of the function. If the input is invalid base64 data, the
32900 yield is -1. A zero byte is added to the end of the output string to make it
32901 easy to interpret as a C string (assuming it contains no zeros of its own). The
32902 added zero byte is not included in the returned count.
32903
32904 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32905 This function checks for a match in a domain list. Domains are always
32906 matched caselessly. The return value is one of the following:
32907 .display
32908 &`OK     `& match succeeded
32909 &`FAIL   `& match failed
32910 &`DEFER  `& match deferred
32911 .endd
32912 DEFER is usually caused by some kind of lookup defer, such as the
32913 inability to contact a database.
32914
32915 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32916         BOOL&~caseless)*&"
32917 This function checks for a match in a local part list. The third argument
32918 controls case-sensitivity. The return values are as for
32919 &'lss_match_domain()'&.
32920
32921 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32922         BOOL&~caseless)*&"
32923 This function checks for a match in an address list. The third argument
32924 controls the case-sensitivity of the local part match. The domain is always
32925 matched caselessly. The return values are as for &'lss_match_domain()'&.
32926
32927 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32928         uschar&~*list)*&"
32929 This function checks for a match in a host list. The most common usage is
32930 expected to be
32931 .code
32932 lss_match_host(sender_host_name, sender_host_address, ...)
32933 .endd
32934 .vindex "&$sender_host_address$&"
32935 An empty address field matches an empty item in the host list. If the host name
32936 is NULL, the name corresponding to &$sender_host_address$& is automatically
32937 looked up if a host name is required to match an item in the list. The return
32938 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32939 returns ERROR in the case when it had to look up a host name, but the lookup
32940 failed.
32941
32942 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32943         *format,&~...)*&"
32944 This function writes to Exim's log files. The first argument should be zero (it
32945 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32946 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32947 them. It specifies to which log or logs the message is written. The remaining
32948 arguments are a format and relevant insertion arguments. The string should not
32949 contain any newlines, not even at the end.
32950
32951
32952 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32953 This function adds an additional recipient to the message. The first argument
32954 is the recipient address. If it is unqualified (has no domain), it is qualified
32955 with the &%qualify_recipient%& domain. The second argument must always be -1.
32956
32957 This function does not allow you to specify a private &%errors_to%& address (as
32958 described with the structure of &%recipient_item%& above), because it pre-dates
32959 the addition of that field to the structure. However, it is easy to add such a
32960 value afterwards. For example:
32961 .code
32962  receive_add_recipient(US"monitor@mydom.example", -1);
32963  recipients_list[recipients_count-1].errors_to =
32964    US"postmaster@mydom.example";
32965 .endd
32966
32967 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32968 This is a convenience function to remove a named recipient from the list of
32969 recipients. It returns true if a recipient was removed, and false if no
32970 matching recipient could be found. The argument must be a complete email
32971 address.
32972 .endlist
32973
32974
32975 .cindex "RFC 2047"
32976 .vlist
32977 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32978   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32979 This function decodes strings that are encoded according to RFC 2047. Typically
32980 these are the contents of header lines. First, each &"encoded word"& is decoded
32981 from the Q or B encoding into a byte-string. Then, if provided with the name of
32982 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32983 made  to translate the result to the named character set. If this fails, the
32984 binary string is returned with an error message.
32985
32986 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32987 maximum MIME word length is enforced. The third argument is the target
32988 encoding, or NULL if no translation is wanted.
32989
32990 .cindex "binary zero" "in RFC 2047 decoding"
32991 .cindex "RFC 2047" "binary zero in"
32992 If a binary zero is encountered in the decoded string, it is replaced by the
32993 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32994 not be 0 because header lines are handled as zero-terminated strings.
32995
32996 The function returns the result of processing the string, zero-terminated; if
32997 &%lenptr%& is not NULL, the length of the result is set in the variable to
32998 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32999
33000 If an error is encountered, the function returns NULL and uses the &%error%&
33001 argument to return an error message. The variable pointed to by &%error%& is
33002 set to NULL if there is no error; it may be set non-NULL even when the function
33003 returns a non-NULL value if decoding was successful, but there was a problem
33004 with translation.
33005
33006
33007 .vitem &*int&~smtp_fflush(void)*&
33008 This function is used in conjunction with &'smtp_printf()'&, as described
33009 below.
33010
33011 .vitem &*void&~smtp_printf(char&~*,&~...)*&
33012 The arguments of this function are like &[printf()]&; it writes to the SMTP
33013 output stream. You should use this function only when there is an SMTP output
33014 stream, that is, when the incoming message is being received via interactive
33015 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
33016 is FALSE. If you want to test for an incoming message from another host (as
33017 opposed to a local process that used the &%-bs%& command line option), you can
33018 test the value of &%sender_host_address%&, which is non-NULL when a remote host
33019 is involved.
33020
33021 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
33022 output function, so it can be used for all forms of SMTP connection.
33023
33024 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
33025 must start with an appropriate response code: 550 if you are going to return
33026 LOCAL_SCAN_REJECT, 451 if you are going to return
33027 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
33028 initial lines of a multi-line response, the code must be followed by a hyphen
33029 to indicate that the line is not the final response line. You must also ensure
33030 that the lines you write terminate with CRLF. For example:
33031 .code
33032 smtp_printf("550-this is some extra info\r\n");
33033 return LOCAL_SCAN_REJECT;
33034 .endd
33035 Note that you can also create multi-line responses by including newlines in
33036 the data returned via the &%return_text%& argument. The added value of using
33037 &'smtp_printf()'& is that, for instance, you could introduce delays between
33038 multiple output lines.
33039
33040 The &'smtp_printf()'& function does not return any error indication, because it
33041 does not automatically flush pending output, and therefore does not test
33042 the state of the stream. (In the main code of Exim, flushing and error
33043 detection is done when Exim is ready for the next SMTP input command.) If
33044 you want to flush the output and check for an error (for example, the
33045 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
33046 arguments. It flushes the output stream, and returns a non-zero value if there
33047 is an error.
33048
33049 .vitem &*void&~*store_get(int)*&
33050 This function accesses Exim's internal store (memory) manager. It gets a new
33051 chunk of memory whose size is given by the argument. Exim bombs out if it ever
33052 runs out of memory. See the next section for a discussion of memory handling.
33053
33054 .vitem &*void&~*store_get_perm(int)*&
33055 This function is like &'store_get()'&, but it always gets memory from the
33056 permanent pool. See the next section for a discussion of memory handling.
33057
33058 .vitem &*uschar&~*string_copy(uschar&~*string)*&
33059 See below.
33060
33061 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
33062 See below.
33063
33064 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
33065 These three functions create strings using Exim's dynamic memory facilities.
33066 The first makes a copy of an entire string. The second copies up to a maximum
33067 number of characters, indicated by the second argument. The third uses a format
33068 and insertion arguments to create a new string. In each case, the result is a
33069 pointer to a new string in the current memory pool. See the next section for
33070 more discussion.
33071 .endlist
33072
33073
33074
33075 .section "More about Exim's memory handling" "SECTmemhanloc"
33076 .cindex "&[local_scan()]& function" "memory handling"
33077 No function is provided for freeing memory, because that is never needed.
33078 The dynamic memory that Exim uses when receiving a message is automatically
33079 recycled if another message is received by the same process (this applies only
33080 to incoming SMTP connections &-- other input methods can supply only one
33081 message at a time). After receiving the last message, a reception process
33082 terminates.
33083
33084 Because it is recycled, the normal dynamic memory cannot be used for holding
33085 data that must be preserved over a number of incoming messages on the same SMTP
33086 connection. However, Exim in fact uses two pools of dynamic memory; the second
33087 one is not recycled, and can be used for this purpose.
33088
33089 If you want to allocate memory that remains available for subsequent messages
33090 in the same SMTP connection, you should set
33091 .code
33092 store_pool = POOL_PERM
33093 .endd
33094 before calling the function that does the allocation. There is no need to
33095 restore the value if you do not need to; however, if you do want to revert to
33096 the normal pool, you can either restore the previous value of &%store_pool%& or
33097 set it explicitly to POOL_MAIN.
33098
33099 The pool setting applies to all functions that get dynamic memory, including
33100 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
33101 There is also a convenience function called &'store_get_perm()'& that gets a
33102 block of memory from the permanent pool while preserving the value of
33103 &%store_pool%&.
33104 .ecindex IIDlosca
33105
33106
33107
33108
33109 . ////////////////////////////////////////////////////////////////////////////
33110 . ////////////////////////////////////////////////////////////////////////////
33111
33112 .chapter "System-wide message filtering" "CHAPsystemfilter"
33113 .scindex IIDsysfil1 "filter" "system filter"
33114 .scindex IIDsysfil2 "filtering all mail"
33115 .scindex IIDsysfil3 "system filter"
33116 The previous chapters (on ACLs and the local scan function) describe checks
33117 that can be applied to messages before they are accepted by a host. There is
33118 also a mechanism for checking messages once they have been received, but before
33119 they are delivered. This is called the &'system filter'&.
33120
33121 The system filter operates in a similar manner to users' filter files, but it
33122 is run just once per message (however many recipients the message has).
33123 It should not normally be used as a substitute for routing, because &%deliver%&
33124 commands in a system router provide new envelope recipient addresses.
33125 The system filter must be an Exim filter. It cannot be a Sieve filter.
33126
33127 The system filter is run at the start of a delivery attempt, before any routing
33128 is done. If a message fails to be completely delivered at the first attempt,
33129 the system filter is run again at the start of every retry.
33130 If you want your filter to do something only once per message, you can make use
33131 of the &%first_delivery%& condition in an &%if%& command in the filter to
33132 prevent it happening on retries.
33133
33134 .vindex "&$domain$&"
33135 .vindex "&$local_part$&"
33136 &*Warning*&: Because the system filter runs just once, variables that are
33137 specific to individual recipient addresses, such as &$local_part$& and
33138 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
33139 you want to run a centrally-specified filter for each recipient address
33140 independently, you can do so by setting up a suitable &(redirect)& router, as
33141 described in section &<<SECTperaddfil>>& below.
33142
33143
33144 .section "Specifying a system filter" "SECID212"
33145 .cindex "uid (user id)" "system filter"
33146 .cindex "gid (group id)" "system filter"
33147 The name of the file that contains the system filter must be specified by
33148 setting &%system_filter%&. If you want the filter to run under a uid and gid
33149 other than root, you must also set &%system_filter_user%& and
33150 &%system_filter_group%& as appropriate. For example:
33151 .code
33152 system_filter = /etc/mail/exim.filter
33153 system_filter_user = exim
33154 .endd
33155 If a system filter generates any deliveries directly to files or pipes (via the
33156 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
33157 specified by setting &%system_filter_file_transport%& and
33158 &%system_filter_pipe_transport%&, respectively. Similarly,
33159 &%system_filter_reply_transport%& must be set to handle any messages generated
33160 by the &%reply%& command.
33161
33162
33163 .section "Testing a system filter" "SECID213"
33164 You can run simple tests of a system filter in the same way as for a user
33165 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
33166 are permitted only in system filters are recognized.
33167
33168 If you want to test the combined effect of a system filter and a user filter,
33169 you can use both &%-bF%& and &%-bf%& on the same command line.
33170
33171
33172
33173 .section "Contents of a system filter" "SECID214"
33174 The language used to specify system filters is the same as for users' filter
33175 files. It is described in the separate end-user document &'Exim's interface to
33176 mail filtering'&. However, there are some additional features that are
33177 available only in system filters; these are described in subsequent sections.
33178 If they are encountered in a user's filter file or when testing with &%-bf%&,
33179 they cause errors.
33180
33181 .cindex "frozen messages" "manual thaw; testing in filter"
33182 There are two special conditions which, though available in users' filter
33183 files, are designed for use in system filters. The condition &%first_delivery%&
33184 is true only for the first attempt at delivering a message, and
33185 &%manually_thawed%& is true only if the message has been frozen, and
33186 subsequently thawed by an admin user. An explicit forced delivery counts as a
33187 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
33188
33189 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
33190 specify an &"unseen"& (non-significant) delivery, and that delivery does not
33191 succeed, it will not be tried again.
33192 If you want Exim to retry an unseen delivery until it succeeds, you should
33193 arrange to set it up every time the filter runs.
33194
33195 When a system filter finishes running, the values of the variables &$n0$& &--
33196 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
33197 users' filter files. Thus a system filter can, for example, set up &"scores"&
33198 to which users' filter files can refer.
33199
33200
33201
33202 .section "Additional variable for system filters" "SECID215"
33203 .vindex "&$recipients$&"
33204 The expansion variable &$recipients$&, containing a list of all the recipients
33205 of the message (separated by commas and white space), is available in system
33206 filters. It is not available in users' filters for privacy reasons.
33207
33208
33209
33210 .section "Defer, freeze, and fail commands for system filters" "SECID216"
33211 .cindex "freezing messages"
33212 .cindex "message" "freezing"
33213 .cindex "message" "forced failure"
33214 .cindex "&%fail%&" "in system filter"
33215 .cindex "&%freeze%& in system filter"
33216 .cindex "&%defer%& in system filter"
33217 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
33218 always available in system filters, but are not normally enabled in users'
33219 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
33220 for the &(redirect)& router.) These commands can optionally be followed by the
33221 word &%text%& and a string containing an error message, for example:
33222 .code
33223 fail text "this message looks like spam to me"
33224 .endd
33225 The keyword &%text%& is optional if the next character is a double quote.
33226
33227 The &%defer%& command defers delivery of the original recipients of the
33228 message. The &%fail%& command causes all the original recipients to be failed,
33229 and a bounce message to be created. The &%freeze%& command suspends all
33230 delivery attempts for the original recipients. In all cases, any new deliveries
33231 that are specified by the filter are attempted as normal after the filter has
33232 run.
33233
33234 The &%freeze%& command is ignored if the message has been manually unfrozen and
33235 not manually frozen since. This means that automatic freezing by a system
33236 filter can be used as a way of checking out suspicious messages. If a message
33237 is found to be all right, manually unfreezing it allows it to be delivered.
33238
33239 .cindex "log" "&%fail%& command log line"
33240 .cindex "&%fail%&" "log line; reducing"
33241 The text given with a fail command is used as part of the bounce message as
33242 well as being written to the log. If the message is quite long, this can fill
33243 up a lot of log space when such failures are common. To reduce the size of the
33244 log message, Exim interprets the text in a special way if it starts with the
33245 two characters &`<<`& and contains &`>>`& later. The text between these two
33246 strings is written to the log, and the rest of the text is used in the bounce
33247 message. For example:
33248 .code
33249 fail "<<filter test 1>>Your message is rejected \
33250      because it contains attachments that we are \
33251      not prepared to receive."
33252 .endd
33253
33254 .cindex "loop" "caused by &%fail%&"
33255 Take great care with the &%fail%& command when basing the decision to fail on
33256 the contents of the message, because the bounce message will of course include
33257 the contents of the original message and will therefore trigger the &%fail%&
33258 command again (causing a mail loop) unless steps are taken to prevent this.
33259 Testing the &%error_message%& condition is one way to prevent this. You could
33260 use, for example
33261 .code
33262 if $message_body contains "this is spam" and not error_message
33263 then fail text "spam is not wanted here" endif
33264 .endd
33265 though of course that might let through unwanted bounce messages. The
33266 alternative is clever checking of the body and/or headers to detect bounces
33267 generated by the filter.
33268
33269 The interpretation of a system filter file ceases after a
33270 &%defer%&,
33271 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
33272 set up earlier in the filter file are honoured, so you can use a sequence such
33273 as
33274 .code
33275 mail ...
33276 freeze
33277 .endd
33278 to send a specified message when the system filter is freezing (or deferring or
33279 failing) a message. The normal deliveries for the message do not, of course,
33280 take place.
33281
33282
33283
33284 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
33285 .cindex "header lines" "adding; in system filter"
33286 .cindex "header lines" "removing; in system filter"
33287 .cindex "filter" "header lines; adding/removing"
33288 Two filter commands that are available only in system filters are:
33289 .code
33290 headers add <string>
33291 headers remove <string>
33292 .endd
33293 The argument for the &%headers add%& is a string that is expanded and then
33294 added to the end of the message's headers. It is the responsibility of the
33295 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
33296 space is ignored, and if the string is otherwise empty, or if the expansion is
33297 forced to fail, the command has no effect.
33298
33299 You can use &"\n"& within the string, followed by white space, to specify
33300 continued header lines. More than one header may be added in one command by
33301 including &"\n"& within the string without any following white space. For
33302 example:
33303 .code
33304 headers add "X-header-1: ....\n  \
33305              continuation of X-header-1 ...\n\
33306              X-header-2: ...."
33307 .endd
33308 Note that the header line continuation white space after the first newline must
33309 be placed before the backslash that continues the input string, because white
33310 space after input continuations is ignored.
33311
33312 The argument for &%headers remove%& is a colon-separated list of header names.
33313 This command applies only to those headers that are stored with the message;
33314 those that are added at delivery time (such as &'Envelope-To:'& and
33315 &'Return-Path:'&) cannot be removed by this means. If there is more than one
33316 header with the same name, they are all removed.
33317
33318 The &%headers%& command in a system filter makes an immediate change to the set
33319 of header lines that was received with the message (with possible additions
33320 from ACL processing). Subsequent commands in the system filter operate on the
33321 modified set, which also forms the basis for subsequent message delivery.
33322 Unless further modified during routing or transporting, this set of headers is
33323 used for all recipients of the message.
33324
33325 During routing and transporting, the variables that refer to the contents of
33326 header lines refer only to those lines that are in this set. Thus, header lines
33327 that are added by a system filter are visible to users' filter files and to all
33328 routers and transports. This contrasts with the manipulation of header lines by
33329 routers and transports, which is not immediate, but which instead is saved up
33330 until the message is actually being written (see section
33331 &<<SECTheadersaddrem>>&).
33332
33333 If the message is not delivered at the first attempt, header lines that were
33334 added by the system filter are stored with the message, and so are still
33335 present at the next delivery attempt. Header lines that were removed are still
33336 present, but marked &"deleted"& so that they are not transported with the
33337 message. For this reason, it is usual to make the &%headers%& command
33338 conditional on &%first_delivery%& so that the set of header lines is not
33339 modified more than once.
33340
33341 Because header modification in a system filter acts immediately, you have to
33342 use an indirect approach if you want to modify the contents of a header line.
33343 For example:
33344 .code
33345 headers add "Old-Subject: $h_subject:"
33346 headers remove "Subject"
33347 headers add "Subject: new subject (was: $h_old-subject:)"
33348 headers remove "Old-Subject"
33349 .endd
33350
33351
33352
33353 .section "Setting an errors address in a system filter" "SECID217"
33354 .cindex "envelope sender"
33355 In a system filter, if a &%deliver%& command is followed by
33356 .code
33357 errors_to <some address>
33358 .endd
33359 in order to change the envelope sender (and hence the error reporting) for that
33360 delivery, any address may be specified. (In a user filter, only the current
33361 user's address can be set.) For example, if some mail is being monitored, you
33362 might use
33363 .code
33364 unseen deliver monitor@spying.example errors_to root@local.example
33365 .endd
33366 to take a copy which would not be sent back to the normal error reporting
33367 address if its delivery failed.
33368
33369
33370
33371 .section "Per-address filtering" "SECTperaddfil"
33372 .vindex "&$domain$&"
33373 .vindex "&$local_part$&"
33374 In contrast to the system filter, which is run just once per message for each
33375 delivery attempt, it is also possible to set up a system-wide filtering
33376 operation that runs once for each recipient address. In this case, variables
33377 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33378 filter file could be made dependent on them. This is an example of a router
33379 which implements such a filter:
33380 .code
33381 central_filter:
33382   check_local_user
33383   driver = redirect
33384   domains = +local_domains
33385   file = /central/filters/$local_part
33386   no_verify
33387   allow_filter
33388   allow_freeze
33389 .endd
33390 The filter is run in a separate process under its own uid. Therefore, either
33391 &%check_local_user%& must be set (as above), in which case the filter is run as
33392 the local user, or the &%user%& option must be used to specify which user to
33393 use. If both are set, &%user%& overrides.
33394
33395 Care should be taken to ensure that none of the commands in the filter file
33396 specify a significant delivery if the message is to go on to be delivered to
33397 its intended recipient. The router will not then claim to have dealt with the
33398 address, so it will be passed on to subsequent routers to be delivered in the
33399 normal way.
33400 .ecindex IIDsysfil1
33401 .ecindex IIDsysfil2
33402 .ecindex IIDsysfil3
33403
33404
33405
33406
33407
33408
33409 . ////////////////////////////////////////////////////////////////////////////
33410 . ////////////////////////////////////////////////////////////////////////////
33411
33412 .chapter "Message processing" "CHAPmsgproc"
33413 .scindex IIDmesproc "message" "general processing"
33414 Exim performs various transformations on the sender and recipient addresses of
33415 all messages that it handles, and also on the messages' header lines. Some of
33416 these are optional and configurable, while others always take place. All of
33417 this processing, except rewriting as a result of routing, and the addition or
33418 removal of header lines while delivering, happens when a message is received,
33419 before it is placed on Exim's queue.
33420
33421 Some of the automatic processing takes place by default only for
33422 &"locally-originated"& messages. This adjective is used to describe messages
33423 that are not received over TCP/IP, but instead are passed to an Exim process on
33424 its standard input. This includes the interactive &"local SMTP"& case that is
33425 set up by the &%-bs%& command line option.
33426
33427 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33428 or ::1) are not considered to be locally-originated. Exim does not treat the
33429 loopback interface specially in any way.
33430
33431 If you want the loopback interface to be treated specially, you must ensure
33432 that there are appropriate entries in your ACLs.
33433
33434
33435
33436
33437 .section "Submission mode for non-local messages" "SECTsubmodnon"
33438 .cindex "message" "submission"
33439 .cindex "submission mode"
33440 Processing that happens automatically for locally-originated messages (unless
33441 &%suppress_local_fixups%& is set) can also be requested for messages that are
33442 received over TCP/IP. The term &"submission mode"& is used to describe this
33443 state. Submission mode is set by the modifier
33444 .code
33445 control = submission
33446 .endd
33447 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33448 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33449 a local submission, and is normally used when the source of the message is
33450 known to be an MUA running on a client host (as opposed to an MTA). For
33451 example, to set submission mode for messages originating on the IPv4 loopback
33452 interface, you could include the following in the MAIL ACL:
33453 .code
33454 warn  hosts = 127.0.0.1
33455       control = submission
33456 .endd
33457 .cindex "&%sender_retain%& submission option"
33458 There are some options that can be used when setting submission mode. A slash
33459 is used to separate options. For example:
33460 .code
33461 control = submission/sender_retain
33462 .endd
33463 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33464 true and &%local_from_check%& false for the current incoming message. The first
33465 of these allows an existing &'Sender:'& header in the message to remain, and
33466 the second suppresses the check to ensure that &'From:'& matches the
33467 authenticated sender. With this setting, Exim still fixes up messages by adding
33468 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33469 attempt to check sender authenticity in header lines.
33470
33471 When &%sender_retain%& is not set, a submission mode setting may specify a
33472 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33473 example:
33474 .code
33475 control = submission/domain=some.domain
33476 .endd
33477 The domain may be empty. How this value is used is described in sections
33478 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33479 that allows you to specify the user's full name for inclusion in a created
33480 &'Sender:'& or &'From:'& header line. For example:
33481 .code
33482 accept authenticated = *
33483        control = submission/domain=wonderland.example/\
33484                             name=${lookup {$authenticated_id} \
33485                                    lsearch {/etc/exim/namelist}}
33486 .endd
33487 Because the name may contain any characters, including slashes, the &%name%&
33488 option must be given last. The remainder of the string is used as the name. For
33489 the example above, if &_/etc/exim/namelist_& contains:
33490 .code
33491 bigegg:  Humpty Dumpty
33492 .endd
33493 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33494 line would be:
33495 .code
33496 Sender: Humpty Dumpty <bigegg@wonderland.example>
33497 .endd
33498 .cindex "return path" "in submission mode"
33499 By default, submission mode forces the return path to the same address as is
33500 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33501 specified, the return path is also left unchanged.
33502
33503 &*Note*&: The changes caused by submission mode take effect after the predata
33504 ACL. This means that any sender checks performed before the fix-ups use the
33505 untrusted sender address specified by the user, not the trusted sender address
33506 specified by submission mode. Although this might be slightly unexpected, it
33507 does mean that you can configure ACL checks to spot that a user is trying to
33508 spoof another's address.
33509
33510 .section "Line endings" "SECTlineendings"
33511 .cindex "line endings"
33512 .cindex "carriage return"
33513 .cindex "linefeed"
33514 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33515 linefeed) is the line ending for messages transmitted over the Internet using
33516 SMTP over TCP/IP. However, within individual operating systems, different
33517 conventions are used. For example, Unix-like systems use just LF, but others
33518 use CRLF or just CR.
33519
33520 Exim was designed for Unix-like systems, and internally, it stores messages
33521 using the system's convention of a single LF as a line terminator. When
33522 receiving a message, all line endings are translated to this standard format.
33523 Originally, it was thought that programs that passed messages directly to an
33524 MTA within an operating system would use that system's convention. Experience
33525 has shown that this is not the case; for example, there are Unix applications
33526 that use CRLF in this circumstance. For this reason, and for compatibility with
33527 other MTAs, the way Exim handles line endings for all messages is now as
33528 follows:
33529
33530 .ilist
33531 LF not preceded by CR is treated as a line ending.
33532 .next
33533 CR is treated as a line ending; if it is immediately followed by LF, the LF
33534 is ignored.
33535 .next
33536 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33537 nor a local message in the state where a line containing only a dot is a
33538 terminator.
33539 .next
33540 If a bare CR is encountered within a header line, an extra space is added after
33541 the line terminator so as not to end the header line. The reasoning behind this
33542 is that bare CRs in header lines are most likely either to be mistakes, or
33543 people trying to play silly games.
33544 .next
33545 If the first header line received in a message ends with CRLF, a subsequent
33546 bare LF in a header line is treated in the same way as a bare CR in a header
33547 line.
33548 .endlist
33549
33550
33551
33552
33553
33554 .section "Unqualified addresses" "SECID218"
33555 .cindex "unqualified addresses"
33556 .cindex "address" "qualification"
33557 By default, Exim expects every envelope address it receives from an external
33558 host to be fully qualified. Unqualified addresses cause negative responses to
33559 SMTP commands. However, because SMTP is used as a means of transporting
33560 messages from MUAs running on personal workstations, there is sometimes a
33561 requirement to accept unqualified addresses from specific hosts or IP networks.
33562
33563 Exim has two options that separately control which hosts may send unqualified
33564 sender or recipient addresses in SMTP commands, namely
33565 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33566 cases, if an unqualified address is accepted, it is qualified by adding the
33567 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33568
33569 .oindex "&%qualify_domain%&"
33570 .oindex "&%qualify_recipient%&"
33571 Unqualified addresses in header lines are automatically qualified for messages
33572 that are locally originated, unless the &%-bnq%& option is given on the command
33573 line. For messages received over SMTP, unqualified addresses in header lines
33574 are qualified only if unqualified addresses are permitted in SMTP commands. In
33575 other words, such qualification is also controlled by
33576 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33577
33578
33579
33580
33581 .section "The UUCP From line" "SECID219"
33582 .cindex "&""From""& line"
33583 .cindex "UUCP" "&""From""& line"
33584 .cindex "sender" "address"
33585 .oindex "&%uucp_from_pattern%&"
33586 .oindex "&%uucp_from_sender%&"
33587 .cindex "envelope sender"
33588 .cindex "Sendmail compatibility" "&""From""& line"
33589 Messages that have come from UUCP (and some other applications) often begin
33590 with a line containing the envelope sender and a timestamp, following the word
33591 &"From"&. Examples of two common formats are:
33592 .code
33593 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33594 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33595 .endd
33596 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33597 Exim recognizes such lines at the start of messages that are submitted to it
33598 via the command line (that is, on the standard input). It does not recognize
33599 such lines in incoming SMTP messages, unless the sending host matches
33600 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33601 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33602 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33603 default value matches the two common cases shown above and puts the address
33604 that follows &"From"& into &$1$&.
33605
33606 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33607 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33608 a trusted user, the message's sender address is constructed by expanding the
33609 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33610 then parsed as an RFC 2822 address. If there is no domain, the local part is
33611 qualified with &%qualify_domain%& unless it is the empty string. However, if
33612 the command line &%-f%& option is used, it overrides the &"From"& line.
33613
33614 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33615 sender address is not changed. This is also the case for incoming SMTP messages
33616 that are permitted to contain &"From"& lines.
33617
33618 Only one &"From"& line is recognized. If there is more than one, the second is
33619 treated as a data line that starts the body of the message, as it is not valid
33620 as a header line. This also happens if a &"From"& line is present in an
33621 incoming SMTP message from a source that is not permitted to send them.
33622
33623
33624
33625 .section "Resent- header lines" "SECID220"
33626 .cindex "&%Resent-%& header lines"
33627 .cindex "header lines" "Resent-"
33628 RFC 2822 makes provision for sets of header lines starting with the string
33629 &`Resent-`& to be added to a message when it is resent by the original
33630 recipient to somebody else. These headers are &'Resent-Date:'&,
33631 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33632 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33633
33634 .blockquote
33635 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33636 processing of replies or other such automatic actions on messages.'&
33637 .endblockquote
33638
33639 This leaves things a bit vague as far as other processing actions such as
33640 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33641 follows:
33642
33643 .ilist
33644 A &'Resent-From:'& line that just contains the login id of the submitting user
33645 is automatically rewritten in the same way as &'From:'& (see below).
33646 .next
33647 If there's a rewriting rule for a particular header line, it is also applied to
33648 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33649 &'From:'& also rewrites &'Resent-From:'&.
33650 .next
33651 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33652 also removed.
33653 .next
33654 For a locally-submitted message,
33655 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33656 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33657 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33658 included in log lines in this case.
33659 .next
33660 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33661 &%Resent-%& header lines are present.
33662 .endlist
33663
33664
33665
33666
33667 .section "The Auto-Submitted: header line" "SECID221"
33668 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33669 includes the header line:
33670 .code
33671 Auto-Submitted: auto-replied
33672 .endd
33673
33674 .section "The Bcc: header line" "SECID222"
33675 .cindex "&'Bcc:'& header line"
33676 If Exim is called with the &%-t%& option, to take recipient addresses from a
33677 message's header, it removes any &'Bcc:'& header line that may exist (after
33678 extracting its addresses). If &%-t%& is not present on the command line, any
33679 existing &'Bcc:'& is not removed.
33680
33681
33682 .section "The Date: header line" "SECID223"
33683 .cindex "&'Date:'& header line"
33684 .cindex "header lines" "Date:"
33685 If a locally-generated or submission-mode message has no &'Date:'& header line,
33686 Exim adds one, using the current date and time, unless the
33687 &%suppress_local_fixups%& control has been specified.
33688
33689 .section "The Delivery-date: header line" "SECID224"
33690 .cindex "&'Delivery-date:'& header line"
33691 .oindex "&%delivery_date_remove%&"
33692 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33693 set. Exim can be configured to add them to the final delivery of messages. (See
33694 the generic &%delivery_date_add%& transport option.) They should not be present
33695 in messages in transit. If the &%delivery_date_remove%& configuration option is
33696 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33697 messages.
33698
33699
33700 .section "The Envelope-to: header line" "SECID225"
33701 .cindex "&'Envelope-to:'& header line"
33702 .cindex "header lines" "Envelope-to:"
33703 .oindex "&%envelope_to_remove%&"
33704 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33705 Exim can be configured to add them to the final delivery of messages. (See the
33706 generic &%envelope_to_add%& transport option.) They should not be present in
33707 messages in transit. If the &%envelope_to_remove%& configuration option is set
33708 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33709 messages.
33710
33711
33712 .section "The From: header line" "SECTthefrohea"
33713 .cindex "&'From:'& header line"
33714 .cindex "header lines" "From:"
33715 .cindex "Sendmail compatibility" "&""From""& line"
33716 .cindex "message" "submission"
33717 .cindex "submission mode"
33718 If a submission-mode message does not contain a &'From:'& header line, Exim
33719 adds one if either of the following conditions is true:
33720
33721 .ilist
33722 The envelope sender address is not empty (that is, this is not a bounce
33723 message). The added header line copies the envelope sender address.
33724 .next
33725 .vindex "&$authenticated_id$&"
33726 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33727 .olist
33728 .vindex "&$qualify_domain$&"
33729 If no domain is specified by the submission control, the local part is
33730 &$authenticated_id$& and the domain is &$qualify_domain$&.
33731 .next
33732 If a non-empty domain is specified by the submission control, the local
33733 part is &$authenticated_id$&, and the domain is the specified domain.
33734 .next
33735 If an empty domain is specified by the submission control,
33736 &$authenticated_id$& is assumed to be the complete address.
33737 .endlist
33738 .endlist
33739
33740 A non-empty envelope sender takes precedence.
33741
33742 If a locally-generated incoming message does not contain a &'From:'& header
33743 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33744 containing the sender's address. The calling user's login name and full name
33745 are used to construct the address, as described in section &<<SECTconstr>>&.
33746 They are obtained from the password data by calling &[getpwuid()]& (but see the
33747 &%unknown_login%& configuration option). The address is qualified with
33748 &%qualify_domain%&.
33749
33750 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33751 &'From:'& header line containing just the unqualified login name of the calling
33752 user, this is replaced by an address containing the user's login name and full
33753 name as described in section &<<SECTconstr>>&.
33754
33755
33756 .section "The Message-ID: header line" "SECID226"
33757 .cindex "&'Message-ID:'& header line"
33758 .cindex "header lines" "Message-ID:"
33759 .cindex "message" "submission"
33760 .oindex "&%message_id_header_text%&"
33761 If a locally-generated or submission-mode incoming message does not contain a
33762 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33763 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33764 to the message. If there are any &'Resent-:'& headers in the message, it
33765 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33766 message id, preceded by the letter E to ensure it starts with a letter, and
33767 followed by @ and the primary host name. Additional information can be included
33768 in this header line by setting the &%message_id_header_text%& and/or
33769 &%message_id_header_domain%& options.
33770
33771
33772 .section "The Received: header line" "SECID227"
33773 .cindex "&'Received:'& header line"
33774 .cindex "header lines" "Received:"
33775 A &'Received:'& header line is added at the start of every message. The
33776 contents are defined by the &%received_header_text%& configuration option, and
33777 Exim automatically adds a semicolon and a timestamp to the configured string.
33778
33779 The &'Received:'& header is generated as soon as the message's header lines
33780 have been received. At this stage, the timestamp in the &'Received:'& header
33781 line is the time that the message started to be received. This is the value
33782 that is seen by the DATA ACL and by the &[local_scan()]& function.
33783
33784 Once a message is accepted, the timestamp in the &'Received:'& header line is
33785 changed to the time of acceptance, which is (apart from a small delay while the
33786 -H spool file is written) the earliest time at which delivery could start.
33787
33788
33789 .section "The References: header line" "SECID228"
33790 .cindex "&'References:'& header line"
33791 .cindex "header lines" "References:"
33792 Messages created by the &(autoreply)& transport include a &'References:'&
33793 header line. This is constructed according to the rules that are described in
33794 section 3.64 of RFC 2822 (which states that replies should contain such a
33795 header line), and section 3.14 of RFC 3834 (which states that automatic
33796 responses are not different in this respect). However, because some mail
33797 processing software does not cope well with very long header lines, no more
33798 than 12 message IDs are copied from the &'References:'& header line in the
33799 incoming message. If there are more than 12, the first one and then the final
33800 11 are copied, before adding the message ID of the incoming message.
33801
33802
33803
33804 .section "The Return-path: header line" "SECID229"
33805 .cindex "&'Return-path:'& header line"
33806 .cindex "header lines" "Return-path:"
33807 .oindex "&%return_path_remove%&"
33808 &'Return-path:'& header lines are defined as something an MTA may insert when
33809 it does the final delivery of messages. (See the generic &%return_path_add%&
33810 transport option.) Therefore, they should not be present in messages in
33811 transit. If the &%return_path_remove%& configuration option is set (the
33812 default), Exim removes &'Return-path:'& header lines from incoming messages.
33813
33814
33815
33816 .section "The Sender: header line" "SECTthesenhea"
33817 .cindex "&'Sender:'& header line"
33818 .cindex "message" "submission"
33819 .cindex "header lines" "Sender:"
33820 For a locally-originated message from an untrusted user, Exim may remove an
33821 existing &'Sender:'& header line, and it may add a new one. You can modify
33822 these actions by setting the &%local_sender_retain%& option true, the
33823 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33824 control setting.
33825
33826 When a local message is received from an untrusted user and
33827 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33828 control has not been set, a check is made to see if the address given in the
33829 &'From:'& header line is the correct (local) sender of the message. The address
33830 that is expected has the login name as the local part and the value of
33831 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33832 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33833 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33834 line is added to the message.
33835
33836 If you set &%local_from_check%& false, this checking does not occur. However,
33837 the removal of an existing &'Sender:'& line still happens, unless you also set
33838 &%local_sender_retain%& to be true. It is not possible to set both of these
33839 options true at the same time.
33840
33841 .cindex "submission mode"
33842 By default, no processing of &'Sender:'& header lines is done for messages
33843 received over TCP/IP or for messages submitted by trusted users. However, when
33844 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33845 not specified on the submission control, the following processing takes place:
33846
33847 .vindex "&$authenticated_id$&"
33848 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33849 authenticated, and &$authenticated_id$& is not empty, a sender address is
33850 created as follows:
33851
33852 .ilist
33853 .vindex "&$qualify_domain$&"
33854 If no domain is specified by the submission control, the local part is
33855 &$authenticated_id$& and the domain is &$qualify_domain$&.
33856 .next
33857 If a non-empty domain is specified by the submission control, the local part
33858 is &$authenticated_id$&, and the domain is the specified domain.
33859 .next
33860 If an empty domain is specified by the submission control,
33861 &$authenticated_id$& is assumed to be the complete address.
33862 .endlist
33863
33864 This address is compared with the address in the &'From:'& header line. If they
33865 are different, a &'Sender:'& header line containing the created address is
33866 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33867 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33868
33869 .cindex "return path" "created from &'Sender:'&"
33870 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33871 the message (the envelope sender address) is changed to be the same address,
33872 except in the case of submission mode when &%sender_retain%& is specified.
33873
33874
33875
33876 .section "Adding and removing header lines in routers and transports" &&&
33877          "SECTheadersaddrem"
33878 .cindex "header lines" "adding; in router or transport"
33879 .cindex "header lines" "removing; in router or transport"
33880 When a message is delivered, the addition and removal of header lines can be
33881 specified in a system filter, or on any of the routers and transports that
33882 process the message. Section &<<SECTaddremheasys>>& contains details about
33883 modifying headers in a system filter. Header lines can also be added in an ACL
33884 as a message is received (see section &<<SECTaddheadacl>>&).
33885
33886 In contrast to what happens in a system filter, header modifications that are
33887 specified on routers and transports apply only to the particular recipient
33888 addresses that are being processed by those routers and transports. These
33889 changes do not actually take place until a copy of the message is being
33890 transported. Therefore, they do not affect the basic set of header lines, and
33891 they do not affect the values of the variables that refer to header lines.
33892
33893 &*Note*&: In particular, this means that any expansions in the configuration of
33894 the transport cannot refer to the modified header lines, because such
33895 expansions all occur before the message is actually transported.
33896
33897 For both routers and transports, the argument of a &%headers_add%&
33898 option must be in the form of one or more RFC 2822 header lines, separated by
33899 newlines (coded as &"\n"&). For example:
33900 .code
33901 headers_add = X-added-header: added by $primary_hostname\n\
33902               X-added-second: another added header line
33903 .endd
33904 Exim does not check the syntax of these added header lines.
33905
33906 Multiple &%headers_add%& options for a single router or transport can be
33907 specified; the values will append to a single list of header lines.
33908 Each header-line is separately expanded.
33909
33910 The argument of a &%headers_remove%& option must consist of a colon-separated
33911 list of header names. This is confusing, because header names themselves are
33912 often terminated by colons. In this case, the colons are the list separators,
33913 not part of the names. For example:
33914 .code
33915 headers_remove = return-receipt-to:acknowledge-to
33916 .endd
33917
33918 Multiple &%headers_remove%& options for a single router or transport can be
33919 specified; the arguments will append to a single header-names list.
33920 Each item is separately expanded.
33921 Note that colons in complex expansions which are used to
33922 form all or part of a &%headers_remove%& list
33923 will act as list separators.
33924
33925 When &%headers_add%& or &%headers_remove%& is specified on a router,
33926 items are expanded at routing time,
33927 and then associated with all addresses that are
33928 accepted by that router, and also with any new addresses that it generates. If
33929 an address passes through several routers as a result of aliasing or
33930 forwarding, the changes are cumulative.
33931
33932 .oindex "&%unseen%&"
33933 However, this does not apply to multiple routers that result from the use of
33934 the &%unseen%& option. Any header modifications that were specified by the
33935 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33936
33937 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33938 settings cannot be delivered together in a batch, so a transport is always
33939 dealing with a set of addresses that have the same header-processing
33940 requirements.
33941
33942 The transport starts by writing the original set of header lines that arrived
33943 with the message, possibly modified by the system filter. As it writes out
33944 these lines, it consults the list of header names that were attached to the
33945 recipient address(es) by &%headers_remove%& options in routers, and it also
33946 consults the transport's own &%headers_remove%& option. Header lines whose
33947 names are on either of these lists are not written out. If there are multiple
33948 instances of any listed header, they are all skipped.
33949
33950 After the remaining original header lines have been written, new header
33951 lines that were specified by routers' &%headers_add%& options are written, in
33952 the order in which they were attached to the address. These are followed by any
33953 header lines specified by the transport's &%headers_add%& option.
33954
33955 This way of handling header line modifications in routers and transports has
33956 the following consequences:
33957
33958 .ilist
33959 The original set of header lines, possibly modified by the system filter,
33960 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33961 to it, at all times.
33962 .next
33963 Header lines that are added by a router's
33964 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33965 expansion syntax in subsequent routers or the transport.
33966 .next
33967 Conversely, header lines that are specified for removal by &%headers_remove%&
33968 in a router remain visible to subsequent routers and the transport.
33969 .next
33970 Headers added to an address by &%headers_add%& in a router cannot be removed by
33971 a later router or by a transport.
33972 .next
33973 An added header can refer to the contents of an original header that is to be
33974 removed, even it has the same name as the added header. For example:
33975 .code
33976 headers_remove = subject
33977 headers_add = Subject: new subject (was: $h_subject:)
33978 .endd
33979 .endlist
33980
33981 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33982 for a &(redirect)& router that has the &%one_time%& option set.
33983
33984
33985
33986
33987
33988 .section "Constructed addresses" "SECTconstr"
33989 .cindex "address" "constructed"
33990 .cindex "constructed address"
33991 When Exim constructs a sender address for a locally-generated message, it uses
33992 the form
33993 .display
33994 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33995 .endd
33996 For example:
33997 .code
33998 Zaphod Beeblebrox <zaphod@end.univ.example>
33999 .endd
34000 The user name is obtained from the &%-F%& command line option if set, or
34001 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
34002 &"gecos"& field from the password entry. If the &"gecos"& field contains an
34003 ampersand character, this is replaced by the login name with the first letter
34004 upper cased, as is conventional in a number of operating systems. See the
34005 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
34006 The &%unknown_username%& option can be used to specify user names in cases when
34007 there is no password file entry.
34008
34009 .cindex "RFC 2047"
34010 In all cases, the user name is made to conform to RFC 2822 by quoting all or
34011 parts of it if necessary. In addition, if it contains any non-printing
34012 characters, it is encoded as described in RFC 2047, which defines a way of
34013 including non-ASCII characters in header lines. The value of the
34014 &%headers_charset%& option specifies the name of the encoding that is used (the
34015 characters are assumed to be in this encoding). The setting of
34016 &%print_topbitchars%& controls whether characters with the top bit set (that
34017 is, with codes greater than 127) count as printing characters or not.
34018
34019
34020
34021 .section "Case of local parts" "SECID230"
34022 .cindex "case of local parts"
34023 .cindex "local part" "case of"
34024 RFC 2822 states that the case of letters in the local parts of addresses cannot
34025 be assumed to be non-significant. Exim preserves the case of local parts of
34026 addresses, but by default it uses a lower-cased form when it is routing,
34027 because on most Unix systems, usernames are in lower case and case-insensitive
34028 routing is required. However, any particular router can be made to use the
34029 original case for local parts by setting the &%caseful_local_part%& generic
34030 router option.
34031
34032 .cindex "mixed-case login names"
34033 If you must have mixed-case user names on your system, the best way to proceed,
34034 assuming you want case-independent handling of incoming email, is to set up
34035 your first router to convert incoming local parts in your domains to the
34036 correct case by means of a file lookup. For example:
34037 .code
34038 correct_case:
34039   driver = redirect
34040   domains = +local_domains
34041   data = ${lookup{$local_part}cdb\
34042               {/etc/usercased.cdb}{$value}fail}\
34043               @$domain
34044 .endd
34045 For this router, the local part is forced to lower case by the default action
34046 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
34047 up a new local part in the correct case. If you then set &%caseful_local_part%&
34048 on any subsequent routers which process your domains, they will operate on
34049 local parts with the correct case in a case-sensitive manner.
34050
34051
34052
34053 .section "Dots in local parts" "SECID231"
34054 .cindex "dot" "in local part"
34055 .cindex "local part" "dots in"
34056 RFC 2822 forbids empty components in local parts. That is, an unquoted local
34057 part may not begin or end with a dot, nor have two consecutive dots in the
34058 middle. However, it seems that many MTAs do not enforce this, so Exim permits
34059 empty components for compatibility.
34060
34061
34062
34063 .section "Rewriting addresses" "SECID232"
34064 .cindex "rewriting" "addresses"
34065 Rewriting of sender and recipient addresses, and addresses in headers, can
34066 happen automatically, or as the result of configuration options, as described
34067 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
34068 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
34069
34070 Automatic rewriting includes qualification, as mentioned above. The other case
34071 in which it can happen is when an incomplete non-local domain is given. The
34072 routing process may cause this to be expanded into the full domain name. For
34073 example, a header such as
34074 .code
34075 To: hare@teaparty
34076 .endd
34077 might get rewritten as
34078 .code
34079 To: hare@teaparty.wonderland.fict.example
34080 .endd
34081 Rewriting as a result of routing is the one kind of message processing that
34082 does not happen at input time, as it cannot be done until the address has
34083 been routed.
34084
34085 Strictly, one should not do &'any'& deliveries of a message until all its
34086 addresses have been routed, in case any of the headers get changed as a
34087 result of routing. However, doing this in practice would hold up many
34088 deliveries for unreasonable amounts of time, just because one address could not
34089 immediately be routed. Exim therefore does not delay other deliveries when
34090 routing of one or more addresses is deferred.
34091 .ecindex IIDmesproc
34092
34093
34094
34095 . ////////////////////////////////////////////////////////////////////////////
34096 . ////////////////////////////////////////////////////////////////////////////
34097
34098 .chapter "SMTP processing" "CHAPSMTP"
34099 .scindex IIDsmtpproc1 "SMTP" "processing details"
34100 .scindex IIDsmtpproc2 "LMTP" "processing details"
34101 Exim supports a number of different ways of using the SMTP protocol, and its
34102 LMTP variant, which is an interactive protocol for transferring messages into a
34103 closed mail store application. This chapter contains details of how SMTP is
34104 processed. For incoming mail, the following are available:
34105
34106 .ilist
34107 SMTP over TCP/IP (Exim daemon or &'inetd'&);
34108 .next
34109 SMTP over the standard input and output (the &%-bs%& option);
34110 .next
34111 Batched SMTP on the standard input (the &%-bS%& option).
34112 .endlist
34113
34114 For mail delivery, the following are available:
34115
34116 .ilist
34117 SMTP over TCP/IP (the &(smtp)& transport);
34118 .next
34119 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
34120 &"lmtp"&);
34121 .next
34122 LMTP over a pipe to a process running in the local host (the &(lmtp)&
34123 transport);
34124 .next
34125 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
34126 the &%use_bsmtp%& option set).
34127 .endlist
34128
34129 &'Batched SMTP'& is the name for a process in which batches of messages are
34130 stored in or read from files (or pipes), in a format in which SMTP commands are
34131 used to contain the envelope information.
34132
34133
34134
34135 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
34136 .cindex "SMTP" "outgoing over TCP/IP"
34137 .cindex "outgoing SMTP over TCP/IP"
34138 .cindex "LMTP" "over TCP/IP"
34139 .cindex "outgoing LMTP over TCP/IP"
34140 .cindex "EHLO"
34141 .cindex "HELO"
34142 .cindex "SIZE option on MAIL command"
34143 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
34144 The &%protocol%& option selects which protocol is to be used, but the actual
34145 processing is the same in both cases.
34146
34147 If, in response to its EHLO command, Exim is told that the SIZE
34148 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
34149 command. The value of <&'n'&> is the message size plus the value of the
34150 &%size_addition%& option (default 1024) to allow for additions to the message
34151 such as per-transport header lines, or changes made in a
34152 .cindex "transport" "filter"
34153 .cindex "filter" "transport filter"
34154 transport filter. If &%size_addition%& is set negative, the use of SIZE is
34155 suppressed.
34156
34157 If the remote server advertises support for PIPELINING, Exim uses the
34158 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
34159 required for the transaction.
34160
34161 If the remote server advertises support for the STARTTLS command, and Exim
34162 was built to support TLS encryption, it tries to start a TLS session unless the
34163 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
34164 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
34165 is called for verification.
34166
34167 If the remote server advertises support for the AUTH command, Exim scans
34168 the authenticators configuration for any suitable client settings, as described
34169 in chapter &<<CHAPSMTPAUTH>>&.
34170
34171 .cindex "carriage return"
34172 .cindex "linefeed"
34173 Responses from the remote host are supposed to be terminated by CR followed by
34174 LF. However, there are known to be hosts that do not send CR characters, so in
34175 order to be able to interwork with such hosts, Exim treats LF on its own as a
34176 line terminator.
34177
34178 If a message contains a number of different addresses, all those with the same
34179 characteristics (for example, the same envelope sender) that resolve to the
34180 same set of hosts, in the same order, are sent in a single SMTP transaction,
34181 even if they are for different domains, unless there are more than the setting
34182 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
34183 they are split into groups containing no more than &%max_rcpt%&s addresses
34184 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
34185 in parallel sessions. The order of hosts with identical MX values is not
34186 significant when checking whether addresses can be batched in this way.
34187
34188 When the &(smtp)& transport suffers a temporary failure that is not
34189 message-related, Exim updates its transport-specific database, which contains
34190 records indexed by host name that remember which messages are waiting for each
34191 particular host. It also updates the retry database with new retry times.
34192
34193 .cindex "hints database" "retry keys"
34194 Exim's retry hints are based on host name plus IP address, so if one address of
34195 a multi-homed host is broken, it will soon be skipped most of the time.
34196 See the next section for more detail about error handling.
34197
34198 .cindex "SMTP" "passed connection"
34199 .cindex "SMTP" "batching over TCP/IP"
34200 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
34201 looks in the hints database for the transport to see if there are any queued
34202 messages waiting for the host to which it is connected. If it finds one, it
34203 creates a new Exim process using the &%-MC%& option (which can only be used by
34204 a process running as root or the Exim user) and passes the TCP/IP socket to it
34205 so that it can deliver another message using the same socket. The new process
34206 does only those deliveries that are routed to the connected host, and may in
34207 turn pass the socket on to a third process, and so on.
34208
34209 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
34210 limit the number of messages sent down a single TCP/IP connection.
34211
34212 .cindex "asterisk" "after IP address"
34213 The second and subsequent messages delivered down an existing connection are
34214 identified in the main log by the addition of an asterisk after the closing
34215 square bracket of the IP address.
34216
34217
34218
34219
34220 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
34221 .cindex "error" "in outgoing SMTP"
34222 .cindex "SMTP" "errors in outgoing"
34223 .cindex "host" "error"
34224 Three different kinds of error are recognized for outgoing SMTP: host errors,
34225 message errors, and recipient errors.
34226
34227 .vlist
34228 .vitem "&*Host errors*&"
34229 A host error is not associated with a particular message or with a
34230 particular recipient of a message. The host errors are:
34231
34232 .ilist
34233 Connection refused or timed out,
34234 .next
34235 Any error response code on connection,
34236 .next
34237 Any error response code to EHLO or HELO,
34238 .next
34239 Loss of connection at any time, except after &"."&,
34240 .next
34241 I/O errors at any time,
34242 .next
34243 Timeouts during the session, other than in response to MAIL, RCPT or
34244 the &"."& at the end of the data.
34245 .endlist ilist
34246
34247 For a host error, a permanent error response on connection, or in response to
34248 EHLO, causes all addresses routed to the host to be failed. Any other host
34249 error causes all addresses to be deferred, and retry data to be created for the
34250 host. It is not tried again, for any message, until its retry time arrives. If
34251 the current set of addresses are not all delivered in this run (to some
34252 alternative host), the message is added to the list of those waiting for this
34253 host, so if it is still undelivered when a subsequent successful delivery is
34254 made to the host, it will be sent down the same SMTP connection.
34255
34256 .vitem "&*Message errors*&"
34257 .cindex "message" "error"
34258 A message error is associated with a particular message when sent to a
34259 particular host, but not with a particular recipient of the message. The
34260 message errors are:
34261
34262 .ilist
34263 Any error response code to MAIL, DATA, or the &"."& that terminates
34264 the data,
34265 .next
34266 Timeout after MAIL,
34267 .next
34268 Timeout or loss of connection after the &"."& that terminates the data. A
34269 timeout after the DATA command itself is treated as a host error, as is loss of
34270 connection at any other time.
34271 .endlist ilist
34272
34273 For a message error, a permanent error response (5&'xx'&) causes all addresses
34274 to be failed, and a delivery error report to be returned to the sender. A
34275 temporary error response (4&'xx'&), or one of the timeouts, causes all
34276 addresses to be deferred. Retry data is not created for the host, but instead,
34277 a retry record for the combination of host plus message id is created. The
34278 message is not added to the list of those waiting for this host. This ensures
34279 that the failing message will not be sent to this host again until the retry
34280 time arrives. However, other messages that are routed to the host are not
34281 affected, so if it is some property of the message that is causing the error,
34282 it will not stop the delivery of other mail.
34283
34284 If the remote host specified support for the SIZE parameter in its response
34285 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
34286 over-large message will cause a message error because the error arrives as a
34287 response to MAIL.
34288
34289 .vitem "&*Recipient errors*&"
34290 .cindex "recipient" "error"
34291 A recipient error is associated with a particular recipient of a message. The
34292 recipient errors are:
34293
34294 .ilist
34295 Any error response to RCPT,
34296 .next
34297 Timeout after RCPT.
34298 .endlist
34299
34300 For a recipient error, a permanent error response (5&'xx'&) causes the
34301 recipient address to be failed, and a bounce message to be returned to the
34302 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
34303 address to be deferred, and routing retry data to be created for it. This is
34304 used to delay processing of the address in subsequent queue runs, until its
34305 routing retry time arrives. This applies to all messages, but because it
34306 operates only in queue runs, one attempt will be made to deliver a new message
34307 to the failing address before the delay starts to operate. This ensures that,
34308 if the failure is really related to the message rather than the recipient
34309 (&"message too big for this recipient"& is a possible example), other messages
34310 have a chance of getting delivered. If a delivery to the address does succeed,
34311 the retry information gets cleared, so all stuck messages get tried again, and
34312 the retry clock is reset.
34313
34314 The message is not added to the list of those waiting for this host. Use of the
34315 host for other messages is unaffected, and except in the case of a timeout,
34316 other recipients are processed independently, and may be successfully delivered
34317 in the current SMTP session. After a timeout it is of course impossible to
34318 proceed with the session, so all addresses get deferred. However, those other
34319 than the one that failed do not suffer any subsequent retry delays. Therefore,
34320 if one recipient is causing trouble, the others have a chance of getting
34321 through when a subsequent delivery attempt occurs before the failing
34322 recipient's retry time.
34323 .endlist
34324
34325 In all cases, if there are other hosts (or IP addresses) available for the
34326 current set of addresses (for example, from multiple MX records), they are
34327 tried in this run for any undelivered addresses, subject of course to their
34328 own retry data. In other words, recipient error retry data does not take effect
34329 until the next delivery attempt.
34330
34331 Some hosts have been observed to give temporary error responses to every
34332 MAIL command at certain times (&"insufficient space"& has been seen). It
34333 would be nice if such circumstances could be recognized, and defer data for the
34334 host itself created, but this is not possible within the current Exim design.
34335 What actually happens is that retry data for every (host, message) combination
34336 is created.
34337
34338 The reason that timeouts after MAIL and RCPT are treated specially is that
34339 these can sometimes arise as a result of the remote host's verification
34340 procedures. Exim makes this assumption, and treats them as if a temporary error
34341 response had been received. A timeout after &"."& is treated specially because
34342 it is known that some broken implementations fail to recognize the end of the
34343 message if the last character of the last line is a binary zero. Thus, it is
34344 helpful to treat this case as a message error.
34345
34346 Timeouts at other times are treated as host errors, assuming a problem with the
34347 host, or the connection to it. If a timeout after MAIL, RCPT,
34348 or &"."& is really a connection problem, the assumption is that at the next try
34349 the timeout is likely to occur at some other point in the dialogue, causing it
34350 then to be treated as a host error.
34351
34352 There is experimental evidence that some MTAs drop the connection after the
34353 terminating &"."& if they do not like the contents of the message for some
34354 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34355 should be given. That is why Exim treats this case as a message rather than a
34356 host error, in order not to delay other messages to the same host.
34357
34358
34359
34360
34361 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34362 .cindex "SMTP" "incoming over TCP/IP"
34363 .cindex "incoming SMTP over TCP/IP"
34364 .cindex "inetd"
34365 .cindex "daemon"
34366 Incoming SMTP messages can be accepted in one of two ways: by running a
34367 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34368 &_/etc/inetd.conf_& should be like this:
34369 .code
34370 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34371 .endd
34372 Exim distinguishes between this case and the case of a locally running user
34373 agent using the &%-bs%& option by checking whether or not the standard input is
34374 a socket. When it is, either the port must be privileged (less than 1024), or
34375 the caller must be root or the Exim user. If any other user passes a socket
34376 with an unprivileged port number, Exim prints a message on the standard error
34377 stream and exits with an error code.
34378
34379 By default, Exim does not make a log entry when a remote host connects or
34380 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34381 unexpected. It can be made to write such log entries by setting the
34382 &%smtp_connection%& log selector.
34383
34384 .cindex "carriage return"
34385 .cindex "linefeed"
34386 Commands from the remote host are supposed to be terminated by CR followed by
34387 LF. However, there are known to be hosts that do not send CR characters. In
34388 order to be able to interwork with such hosts, Exim treats LF on its own as a
34389 line terminator.
34390 Furthermore, because common code is used for receiving messages from all
34391 sources, a CR on its own is also interpreted as a line terminator. However, the
34392 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34393
34394 .cindex "EHLO" "invalid data"
34395 .cindex "HELO" "invalid data"
34396 One area that sometimes gives rise to problems concerns the EHLO or
34397 HELO commands. Some clients send syntactically invalid versions of these
34398 commands, which Exim rejects by default. (This is nothing to do with verifying
34399 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34400 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34401 match the broken hosts that send invalid commands.
34402
34403 .cindex "SIZE option on MAIL command"
34404 .cindex "MAIL" "SIZE option"
34405 The amount of disk space available is checked whenever SIZE is received on
34406 a MAIL command, independently of whether &%message_size_limit%& or
34407 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34408 false. A temporary error is given if there is not enough space. If
34409 &%check_spool_space%& is set, the check is for that amount of space plus the
34410 value given with SIZE, that is, it checks that the addition of the incoming
34411 message will not reduce the space below the threshold.
34412
34413 When a message is successfully received, Exim includes the local message id in
34414 its response to the final &"."& that terminates the data. If the remote host
34415 logs this text it can help with tracing what has happened to a message.
34416
34417 The Exim daemon can limit the number of simultaneous incoming connections it is
34418 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34419 number of simultaneous incoming connections from a single remote host (see the
34420 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34421 rejected using the SMTP temporary error code 421.
34422
34423 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34424 subprocess has finished, as this can get lost at busy times. Instead, it looks
34425 for completed subprocesses every time it wakes up. Provided there are other
34426 things happening (new incoming calls, starts of queue runs), completed
34427 processes will be noticed and tidied away. On very quiet systems you may
34428 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34429 it will be noticed when the daemon next wakes up.
34430
34431 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34432 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34433 high system load &-- for details see the &%smtp_accept_reserve%&,
34434 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34435 applies in both the daemon and &'inetd'& cases.
34436
34437 Exim normally starts a delivery process for each message received, though this
34438 can be varied by means of the &%-odq%& command line option and the
34439 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34440 number of simultaneously running delivery processes started in this way from
34441 SMTP input can be limited by the &%smtp_accept_queue%& and
34442 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34443 subsequently received messages are just put on the input queue without starting
34444 a delivery process.
34445
34446 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34447 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34448 started up from the &'inetd'& daemon, because in that case each connection is
34449 handled by an entirely independent Exim process. Control by load average is,
34450 however, available with &'inetd'&.
34451
34452 Exim can be configured to verify addresses in incoming SMTP commands as they
34453 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34454 to rewrite addresses at this time &-- before any syntax checking is done. See
34455 section &<<SECTrewriteS>>&.
34456
34457 Exim can also be configured to limit the rate at which a client host submits
34458 MAIL and RCPT commands in a single SMTP session. See the
34459 &%smtp_ratelimit_hosts%& option.
34460
34461
34462
34463 .section "Unrecognized SMTP commands" "SECID234"
34464 .cindex "SMTP" "unrecognized commands"
34465 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34466 commands during a single SMTP connection, it drops the connection after sending
34467 the error response to the last command. The default value for
34468 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34469 abuse that subvert web servers into making connections to SMTP ports; in these
34470 circumstances, a number of non-SMTP lines are sent first.
34471
34472
34473 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34474 .cindex "SMTP" "syntax errors"
34475 .cindex "SMTP" "protocol errors"
34476 A syntax error is detected if an SMTP command is recognized, but there is
34477 something syntactically wrong with its data, for example, a malformed email
34478 address in a RCPT command. Protocol errors include invalid command
34479 sequencing such as RCPT before MAIL. If Exim receives more than
34480 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34481 drops the connection after sending the error response to the last command. The
34482 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34483 broken clients that loop sending bad commands (yes, it has been seen).
34484
34485
34486
34487 .section "Use of non-mail SMTP commands" "SECID236"
34488 .cindex "SMTP" "non-mail commands"
34489 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34490 DATA. Exim counts such commands, and drops the connection if there are too
34491 many of them in a single SMTP session. This action catches some
34492 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34493 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34494 defines what &"too many"& means. Its default value is 10.
34495
34496 When a new message is expected, one occurrence of RSET is not counted. This
34497 allows a client to send one RSET between messages (this is not necessary,
34498 but some clients do it). Exim also allows one uncounted occurrence of HELO
34499 or EHLO, and one occurrence of STARTTLS between messages. After
34500 starting up a TLS session, another EHLO is expected, and so it too is not
34501 counted.
34502
34503 The first occurrence of AUTH in a connection, or immediately following
34504 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34505 RCPT, DATA, and QUIT are counted.
34506
34507 You can control which hosts are subject to the limit set by
34508 &%smtp_accept_max_nonmail%& by setting
34509 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34510 the limit apply to all hosts. This option means that you can exclude any
34511 specific badly-behaved hosts that you have to live with.
34512
34513
34514
34515
34516 .section "The VRFY and EXPN commands" "SECID237"
34517 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34518 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34519 appropriate) in order to decide whether the command should be accepted or not.
34520
34521 .cindex "VRFY" "processing"
34522 When no ACL is defined for VRFY, or if it rejects without
34523 setting an explicit response code, the command is accepted
34524 (with a 252 SMTP response code)
34525 in order to support awkward clients that do a VRFY before every RCPT.
34526 When VRFY is accepted, it runs exactly the same code as when Exim is
34527 called with the &%-bv%& option, and returns 250/451/550
34528 SMTP response codes.
34529
34530 .cindex "EXPN" "processing"
34531 If no ACL for EXPN is defined, the command is rejected.
34532 When EXPN is accepted, a single-level expansion of the address is done.
34533 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34534 than a verification (the &%-bv%& option). If an unqualified local part is given
34535 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34536 of VRFY and EXPN commands are logged on the main and reject logs, and
34537 VRFY verification failures are logged on the main log for consistency with
34538 RCPT failures.
34539
34540
34541
34542 .section "The ETRN command" "SECTETRN"
34543 .cindex "ETRN" "processing"
34544 RFC 1985 describes an SMTP command called ETRN that is designed to
34545 overcome the security problems of the TURN command (which has fallen into
34546 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34547 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34548 should be accepted or not. If no ACL is defined, the command is rejected.
34549
34550 The ETRN command is concerned with &"releasing"& messages that are awaiting
34551 delivery to certain hosts. As Exim does not organize its message queue by host,
34552 the only form of ETRN that is supported by default is the one where the
34553 text starts with the &"#"& prefix, in which case the remainder of the text is
34554 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34555 the &%-R%& option to happen, with the remainder of the ETRN text as its
34556 argument. For example,
34557 .code
34558 ETRN #brigadoon
34559 .endd
34560 runs the command
34561 .code
34562 exim -R brigadoon
34563 .endd
34564 which causes a delivery attempt on all messages with undelivered addresses
34565 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34566 default), Exim prevents the simultaneous execution of more than one queue run
34567 for the same argument string as a result of an ETRN command. This stops
34568 a misbehaving client from starting more than one queue runner at once.
34569
34570 .cindex "hints database" "ETRN serialization"
34571 Exim implements the serialization by means of a hints database in which a
34572 record is written whenever a process is started by ETRN, and deleted when
34573 the process completes. However, Exim does not keep the SMTP session waiting for
34574 the ETRN process to complete. Once ETRN is accepted, the client is sent
34575 a &"success"& return code. Obviously there is scope for hints records to get
34576 left lying around if there is a system or program crash. To guard against this,
34577 Exim ignores any records that are more than six hours old.
34578
34579 .oindex "&%smtp_etrn_command%&"
34580 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34581 used. This specifies a command that is run whenever ETRN is received,
34582 whatever the form of its argument. For
34583 example:
34584 .code
34585 smtp_etrn_command = /etc/etrn_command $domain \
34586                     $sender_host_address
34587 .endd
34588 .vindex "&$domain$&"
34589 The string is split up into arguments which are independently expanded. The
34590 expansion variable &$domain$& is set to the argument of the ETRN command,
34591 and no syntax checking is done on the contents of this argument. Exim does not
34592 wait for the command to complete, so its status code is not checked. Exim runs
34593 under its own uid and gid when receiving incoming SMTP, so it is not possible
34594 for it to change them before running the command.
34595
34596
34597
34598 .section "Incoming local SMTP" "SECID238"
34599 .cindex "SMTP" "local incoming"
34600 Some user agents use SMTP to pass messages to their local MTA using the
34601 standard input and output, as opposed to passing the envelope on the command
34602 line and writing the message to the standard input. This is supported by the
34603 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34604 messages over TCP/IP (including the use of ACLs), except that the envelope
34605 sender given in a MAIL command is ignored unless the caller is trusted. In
34606 an ACL you can detect this form of SMTP input by testing for an empty host
34607 identification. It is common to have this as the first line in the ACL that
34608 runs for RCPT commands:
34609 .code
34610 accept hosts = :
34611 .endd
34612 This accepts SMTP messages from local processes without doing any other tests.
34613
34614
34615
34616 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34617 .cindex "SMTP" "batched outgoing"
34618 .cindex "batched SMTP output"
34619 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34620 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34621 be output in BSMTP format. No SMTP responses are possible for this form of
34622 delivery. All it is doing is using SMTP commands as a way of transmitting the
34623 envelope along with the message.
34624
34625 The message is written to the file or pipe preceded by the SMTP commands
34626 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34627 the message that start with a dot have an extra dot added. The SMTP command
34628 HELO is not normally used. If it is required, the &%message_prefix%& option
34629 can be used to specify it.
34630
34631 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34632 one recipient address at a time by default. However, you can arrange for them
34633 to handle several addresses at once by setting the &%batch_max%& option. When
34634 this is done for BSMTP, messages may contain multiple RCPT commands. See
34635 chapter &<<CHAPbatching>>& for more details.
34636
34637 .vindex "&$host$&"
34638 When one or more addresses are routed to a BSMTP transport by a router that
34639 sets up a host list, the name of the first host on the list is available to the
34640 transport in the variable &$host$&. Here is an example of such a transport and
34641 router:
34642 .code
34643 begin routers
34644 route_append:
34645   driver = manualroute
34646   transport = smtp_appendfile
34647   route_list = domain.example  batch.host.example
34648
34649 begin transports
34650 smtp_appendfile:
34651   driver = appendfile
34652   directory = /var/bsmtp/$host
34653   batch_max = 1000
34654   use_bsmtp
34655   user = exim
34656 .endd
34657 This causes messages addressed to &'domain.example'& to be written in BSMTP
34658 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34659 message (unless there are more than 1000 recipients).
34660
34661
34662
34663 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34664 .cindex "SMTP" "batched incoming"
34665 .cindex "batched SMTP input"
34666 The &%-bS%& command line option causes Exim to accept one or more messages by
34667 reading SMTP on the standard input, but to generate no responses. If the caller
34668 is trusted, the senders in the MAIL commands are believed; otherwise the
34669 sender is always the caller of Exim. Unqualified senders and receivers are not
34670 rejected (there seems little point) but instead just get qualified. HELO
34671 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34672 as NOOP; QUIT quits.
34673
34674 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34675 ACL is run in the same way as for non-SMTP local input.
34676
34677 If an error is detected while reading a message, including a missing &"."& at
34678 the end, Exim gives up immediately. It writes details of the error to the
34679 standard output in a stylized way that the calling program should be able to
34680 make some use of automatically, for example:
34681 .code
34682 554 Unexpected end of file
34683 Transaction started in line 10
34684 Error detected in line 14
34685 .endd
34686 It writes a more verbose version, for human consumption, to the standard error
34687 file, for example:
34688 .code
34689 An error was detected while processing a file of BSMTP input.
34690 The error message was:
34691
34692 501 '>' missing at end of address
34693
34694 The SMTP transaction started in line 10.
34695 The error was detected in line 12.
34696 The SMTP command at fault was:
34697
34698 rcpt to:<malformed@in.com.plete
34699
34700 1 previous message was successfully processed.
34701 The rest of the batch was abandoned.
34702 .endd
34703 The return code from Exim is zero only if there were no errors. It is 1 if some
34704 messages were accepted before an error was detected, and 2 if no messages were
34705 accepted.
34706 .ecindex IIDsmtpproc1
34707 .ecindex IIDsmtpproc2
34708
34709
34710
34711 . ////////////////////////////////////////////////////////////////////////////
34712 . ////////////////////////////////////////////////////////////////////////////
34713
34714 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34715          "Customizing messages"
34716 When a message fails to be delivered, or remains on the queue for more than a
34717 configured amount of time, Exim sends a message to the original sender, or
34718 to an alternative configured address. The text of these messages is built into
34719 the code of Exim, but it is possible to change it, either by adding a single
34720 string, or by replacing each of the paragraphs by text supplied in a file.
34721
34722 The &'From:'& and &'To:'& header lines are automatically generated; you can
34723 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34724 option. Exim also adds the line
34725 .code
34726 Auto-Submitted: auto-generated
34727 .endd
34728 to all warning and bounce messages,
34729
34730
34731 .section "Customizing bounce messages" "SECID239"
34732 .cindex "customizing" "bounce message"
34733 .cindex "bounce message" "customizing"
34734 If &%bounce_message_text%& is set, its contents are included in the default
34735 message immediately after &"This message was created automatically by mail
34736 delivery software."& The string is not expanded. It is not used if
34737 &%bounce_message_file%& is set.
34738
34739 When &%bounce_message_file%& is set, it must point to a template file for
34740 constructing error messages. The file consists of a series of text items,
34741 separated by lines consisting of exactly four asterisks. If the file cannot be
34742 opened, default text is used and a message is written to the main and panic
34743 logs. If any text item in the file is empty, default text is used for that
34744 item.
34745
34746 .vindex "&$bounce_recipient$&"
34747 .vindex "&$bounce_return_size_limit$&"
34748 Each item of text that is read from the file is expanded, and there are two
34749 expansion variables which can be of use here: &$bounce_recipient$& is set to
34750 the recipient of an error message while it is being created, and
34751 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34752 option, rounded to a whole number.
34753
34754 The items must appear in the file in the following order:
34755
34756 .ilist
34757 The first item is included in the headers, and should include at least a
34758 &'Subject:'& header. Exim does not check the syntax of these headers.
34759 .next
34760 The second item forms the start of the error message. After it, Exim lists the
34761 failing addresses with their error messages.
34762 .next
34763 The third item is used to introduce any text from pipe transports that is to be
34764 returned to the sender. It is omitted if there is no such text.
34765 .next
34766 The fourth, fifth and sixth items will be ignored and may be empty.
34767 The fields exist for back-compatibility
34768 .endlist
34769
34770 The default state (&%bounce_message_file%& unset) is equivalent to the
34771 following file, in which the sixth item is empty. The &'Subject:'& and some
34772 other lines have been split in order to fit them on the page:
34773 .code
34774 Subject: Mail delivery failed
34775   ${if eq{$sender_address}{$bounce_recipient}
34776   {: returning message to sender}}
34777 ****
34778 This message was created automatically by mail delivery software.
34779
34780 A message ${if eq{$sender_address}{$bounce_recipient}
34781   {that you sent }{sent by
34782
34783 <$sender_address>
34784
34785 }}could not be delivered to all of its recipients.
34786 This is a permanent error. The following address(es) failed:
34787 ****
34788 The following text was generated during the delivery attempt(s):
34789 ****
34790 ------ This is a copy of the message, including all the headers.
34791   ------
34792 ****
34793 ------ The body of the message is $message_size characters long;
34794   only the first
34795 ------ $bounce_return_size_limit or so are included here.
34796 ****
34797 .endd
34798 .section "Customizing warning messages" "SECTcustwarn"
34799 .cindex "customizing" "warning message"
34800 .cindex "warning of delay" "customizing the message"
34801 The option &%warn_message_file%& can be pointed at a template file for use when
34802 warnings about message delays are created. In this case there are only three
34803 text sections:
34804
34805 .ilist
34806 The first item is included in the headers, and should include at least a
34807 &'Subject:'& header. Exim does not check the syntax of these headers.
34808 .next
34809 The second item forms the start of the warning message. After it, Exim lists
34810 the delayed addresses.
34811 .next
34812 The third item then ends the message.
34813 .endlist
34814
34815 The default state is equivalent to the following file, except that some lines
34816 have been split here, in order to fit them on the page:
34817 .code
34818 Subject: Warning: message $message_exim_id delayed
34819   $warn_message_delay
34820 ****
34821 This message was created automatically by mail delivery software.
34822
34823 A message ${if eq{$sender_address}{$warn_message_recipients}
34824 {that you sent }{sent by
34825
34826 <$sender_address>
34827
34828 }}has not been delivered to all of its recipients after
34829 more than $warn_message_delay on the queue on $primary_hostname.
34830
34831 The message identifier is:     $message_exim_id
34832 The subject of the message is: $h_subject
34833 The date of the message is:    $h_date
34834
34835 The following address(es) have not yet been delivered:
34836 ****
34837 No action is required on your part. Delivery attempts will
34838 continue for some time, and this warning may be repeated at
34839 intervals if the message remains undelivered. Eventually the
34840 mail delivery software will give up, and when that happens,
34841 the message will be returned to you.
34842 .endd
34843 .vindex "&$warn_message_delay$&"
34844 .vindex "&$warn_message_recipients$&"
34845 However, in the default state the subject and date lines are omitted if no
34846 appropriate headers exist. During the expansion of this file,
34847 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34848 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34849 of recipients for the warning message. There may be more than one if there are
34850 multiple addresses with different &%errors_to%& settings on the routers that
34851 handled them.
34852
34853
34854
34855
34856 . ////////////////////////////////////////////////////////////////////////////
34857 . ////////////////////////////////////////////////////////////////////////////
34858
34859 .chapter "Some common configuration settings" "CHAPcomconreq"
34860 This chapter discusses some configuration settings that seem to be fairly
34861 common. More examples and discussion can be found in the Exim book.
34862
34863
34864
34865 .section "Sending mail to a smart host" "SECID240"
34866 .cindex "smart host" "example router"
34867 If you want to send all mail for non-local domains to a &"smart host"&, you
34868 should replace the default &(dnslookup)& router with a router which does the
34869 routing explicitly:
34870 .code
34871 send_to_smart_host:
34872   driver = manualroute
34873   route_list = !+local_domains smart.host.name
34874   transport = remote_smtp
34875 .endd
34876 You can use the smart host's IP address instead of the name if you wish.
34877 If you are using Exim only to submit messages to a smart host, and not for
34878 receiving incoming messages, you can arrange for it to do the submission
34879 synchronously by setting the &%mua_wrapper%& option (see chapter
34880 &<<CHAPnonqueueing>>&).
34881
34882
34883
34884
34885 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34886 .cindex "mailing lists"
34887 Exim can be used to run simple mailing lists, but for large and/or complicated
34888 requirements, the use of additional specialized mailing list software such as
34889 Majordomo or Mailman is recommended.
34890
34891 The &(redirect)& router can be used to handle mailing lists where each list
34892 is maintained in a separate file, which can therefore be managed by an
34893 independent manager. The &%domains%& router option can be used to run these
34894 lists in a separate domain from normal mail. For example:
34895 .code
34896 lists:
34897   driver = redirect
34898   domains = lists.example
34899   file = /usr/lists/$local_part
34900   forbid_pipe
34901   forbid_file
34902   errors_to = $local_part-request@lists.example
34903   no_more
34904 .endd
34905 This router is skipped for domains other than &'lists.example'&. For addresses
34906 in that domain, it looks for a file that matches the local part. If there is no
34907 such file, the router declines, but because &%no_more%& is set, no subsequent
34908 routers are tried, and so the whole delivery fails.
34909
34910 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34911 expanded into a file name or a pipe delivery, which is usually inappropriate in
34912 a mailing list.
34913
34914 .oindex "&%errors_to%&"
34915 The &%errors_to%& option specifies that any delivery errors caused by addresses
34916 taken from a mailing list are to be sent to the given address rather than the
34917 original sender of the message. However, before acting on this, Exim verifies
34918 the error address, and ignores it if verification fails.
34919
34920 For example, using the configuration above, mail sent to
34921 &'dicts@lists.example'& is passed on to those addresses contained in
34922 &_/usr/lists/dicts_&, with error reports directed to
34923 &'dicts-request@lists.example'&, provided that this address can be verified.
34924 There could be a file called &_/usr/lists/dicts-request_& containing
34925 the address(es) of this particular list's manager(s), but other approaches,
34926 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34927 or &%local_part_suffix%& options) to handle addresses of the form
34928 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34929
34930
34931
34932 .section "Syntax errors in mailing lists" "SECID241"
34933 .cindex "mailing lists" "syntax errors in"
34934 If an entry in redirection data contains a syntax error, Exim normally defers
34935 delivery of the original address. That means that a syntax error in a mailing
34936 list holds up all deliveries to the list. This may not be appropriate when a
34937 list is being maintained automatically from data supplied by users, and the
34938 addresses are not rigorously checked.
34939
34940 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34941 entries that fail to parse, noting the incident in the log. If in addition
34942 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34943 whenever a broken address is skipped. It is usually appropriate to set
34944 &%syntax_errors_to%& to the same address as &%errors_to%&.
34945
34946
34947
34948 .section "Re-expansion of mailing lists" "SECID242"
34949 .cindex "mailing lists" "re-expansion of"
34950 Exim remembers every individual address to which a message has been delivered,
34951 in order to avoid duplication, but it normally stores only the original
34952 recipient addresses with a message. If all the deliveries to a mailing list
34953 cannot be done at the first attempt, the mailing list is re-expanded when the
34954 delivery is next tried. This means that alterations to the list are taken into
34955 account at each delivery attempt, so addresses that have been added to
34956 the list since the message arrived will therefore receive a copy of the
34957 message, even though it pre-dates their subscription.
34958
34959 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34960 on the &(redirect)& router. If this is done, any addresses generated by the
34961 router that fail to deliver at the first attempt are added to the message as
34962 &"top level"& addresses, and the parent address that generated them is marked
34963 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34964 subsequent delivery attempts. The disadvantage of this is that if any of the
34965 failing addresses are incorrect, correcting them in the file has no effect on
34966 pre-existing messages.
34967
34968 The original top-level address is remembered with each of the generated
34969 addresses, and is output in any log messages. However, any intermediate parent
34970 addresses are not recorded. This makes a difference to the log only if the
34971 &%all_parents%& selector is set, but for mailing lists there is normally only
34972 one level of expansion anyway.
34973
34974
34975
34976 .section "Closed mailing lists" "SECID243"
34977 .cindex "mailing lists" "closed"
34978 The examples so far have assumed open mailing lists, to which anybody may
34979 send mail. It is also possible to set up closed lists, where mail is accepted
34980 from specified senders only. This is done by making use of the generic
34981 &%senders%& option to restrict the router that handles the list.
34982
34983 The following example uses the same file as a list of recipients and as a list
34984 of permitted senders. It requires three routers:
34985 .code
34986 lists_request:
34987   driver = redirect
34988   domains = lists.example
34989   local_part_suffix = -request
34990   file = /usr/lists/$local_part$local_part_suffix
34991   no_more
34992
34993 lists_post:
34994   driver = redirect
34995   domains = lists.example
34996   senders = ${if exists {/usr/lists/$local_part}\
34997              {lsearch;/usr/lists/$local_part}{*}}
34998   file = /usr/lists/$local_part
34999   forbid_pipe
35000   forbid_file
35001   errors_to = $local_part-request@lists.example
35002   no_more
35003
35004 lists_closed:
35005   driver = redirect
35006   domains = lists.example
35007   allow_fail
35008   data = :fail: $local_part@lists.example is a closed mailing list
35009 .endd
35010 All three routers have the same &%domains%& setting, so for any other domains,
35011 they are all skipped. The first router runs only if the local part ends in
35012 &%-request%&. It handles messages to the list manager(s) by means of an open
35013 mailing list.
35014
35015 The second router runs only if the &%senders%& precondition is satisfied. It
35016 checks for the existence of a list that corresponds to the local part, and then
35017 checks that the sender is on the list by means of a linear search. It is
35018 necessary to check for the existence of the file before trying to search it,
35019 because otherwise Exim thinks there is a configuration error. If the file does
35020 not exist, the expansion of &%senders%& is *, which matches all senders. This
35021 means that the router runs, but because there is no list, declines, and
35022 &%no_more%& ensures that no further routers are run. The address fails with an
35023 &"unrouteable address"& error.
35024
35025 The third router runs only if the second router is skipped, which happens when
35026 a mailing list exists, but the sender is not on it. This router forcibly fails
35027 the address, giving a suitable error message.
35028
35029
35030
35031
35032 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
35033 .cindex "VERP"
35034 .cindex "Variable Envelope Return Paths"
35035 .cindex "envelope sender"
35036 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
35037 are a way of helping mailing list administrators discover which subscription
35038 address is the cause of a particular delivery failure. The idea is to encode
35039 the original recipient address in the outgoing envelope sender address, so that
35040 if the message is forwarded by another host and then subsequently bounces, the
35041 original recipient can be extracted from the recipient address of the bounce.
35042
35043 .oindex &%errors_to%&
35044 .oindex &%return_path%&
35045 Envelope sender addresses can be modified by Exim using two different
35046 facilities: the &%errors_to%& option on a router (as shown in previous mailing
35047 list examples), or the &%return_path%& option on a transport. The second of
35048 these is effective only if the message is successfully delivered to another
35049 host; it is not used for errors detected on the local host (see the description
35050 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
35051 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
35052 .code
35053 verp_smtp:
35054   driver = smtp
35055   max_rcpt = 1
35056   return_path = \
35057     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35058       {$1-request+$local_part=$domain@your.dom.example}fail}
35059 .endd
35060 This has the effect of rewriting the return path (envelope sender) on outgoing
35061 SMTP messages, if the local part of the original return path ends in
35062 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
35063 local part and domain of the recipient into the return path. Suppose, for
35064 example, that a message whose return path has been set to
35065 &'somelist-request@your.dom.example'& is sent to
35066 &'subscriber@other.dom.example'&. In the transport, the return path is
35067 rewritten as
35068 .code
35069 somelist-request+subscriber=other.dom.example@your.dom.example
35070 .endd
35071 .vindex "&$local_part$&"
35072 For this to work, you must tell Exim to send multiple copies of messages that
35073 have more than one recipient, so that each copy has just one recipient. This is
35074 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
35075 might be sent to several different recipients in the same domain, in which case
35076 &$local_part$& is not available in the transport, because it is not unique.
35077
35078 Unless your host is doing nothing but mailing list deliveries, you should
35079 probably use a separate transport for the VERP deliveries, so as not to use
35080 extra resources in making one-per-recipient copies for other deliveries. This
35081 can easily be done by expanding the &%transport%& option in the router:
35082 .code
35083 dnslookup:
35084   driver = dnslookup
35085   domains = ! +local_domains
35086   transport = \
35087     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35088       {verp_smtp}{remote_smtp}}
35089   no_more
35090 .endd
35091 If you want to change the return path using &%errors_to%& in a router instead
35092 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
35093 routers that handle mailing list addresses. This will ensure that all delivery
35094 errors, including those detected on the local host, are sent to the VERP
35095 address.
35096
35097 On a host that does no local deliveries and has no manual routing, only the
35098 &(dnslookup)& router needs to be changed. A special transport is not needed for
35099 SMTP deliveries. Every mailing list recipient has its own return path value,
35100 and so Exim must hand them to the transport one at a time. Here is an example
35101 of a &(dnslookup)& router that implements VERP:
35102 .code
35103 verp_dnslookup:
35104   driver = dnslookup
35105   domains = ! +local_domains
35106   transport = remote_smtp
35107   errors_to = \
35108     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
35109      {$1-request+$local_part=$domain@your.dom.example}fail}
35110   no_more
35111 .endd
35112 Before you start sending out messages with VERPed return paths, you must also
35113 configure Exim to accept the bounce messages that come back to those paths.
35114 Typically this is done by setting a &%local_part_suffix%& option for a
35115 router, and using this to route the messages to wherever you want to handle
35116 them.
35117
35118 The overhead incurred in using VERP depends very much on the size of the
35119 message, the number of recipient addresses that resolve to the same remote
35120 host, and the speed of the connection over which the message is being sent. If
35121 a lot of addresses resolve to the same host and the connection is slow, sending
35122 a separate copy of the message for each address may take substantially longer
35123 than sending a single copy with many recipients (for which VERP cannot be
35124 used).
35125
35126
35127
35128
35129
35130
35131 .section "Virtual domains" "SECTvirtualdomains"
35132 .cindex "virtual domains"
35133 .cindex "domain" "virtual"
35134 The phrase &'virtual domain'& is unfortunately used with two rather different
35135 meanings:
35136
35137 .ilist
35138 A domain for which there are no real mailboxes; all valid local parts are
35139 aliases for other email addresses. Common examples are organizational
35140 top-level domains and &"vanity"& domains.
35141 .next
35142 One of a number of independent domains that are all handled by the same host,
35143 with mailboxes on that host, but where the mailbox owners do not necessarily
35144 have login accounts on that host.
35145 .endlist
35146
35147 The first usage is probably more common, and does seem more &"virtual"& than
35148 the second. This kind of domain can be handled in Exim with a straightforward
35149 aliasing router. One approach is to create a separate alias file for each
35150 virtual domain. Exim can test for the existence of the alias file to determine
35151 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
35152 to a router of this form:
35153 .code
35154 virtual:
35155   driver = redirect
35156   domains = dsearch;/etc/mail/virtual
35157   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
35158   no_more
35159 .endd
35160 The &%domains%& option specifies that the router is to be skipped, unless there
35161 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
35162 domain that is being processed. When the router runs, it looks up the local
35163 part in the file to find a new address (or list of addresses). The &%no_more%&
35164 setting ensures that if the lookup fails (leading to &%data%& being an empty
35165 string), Exim gives up on the address without trying any subsequent routers.
35166
35167 This one router can handle all the virtual domains because the alias file names
35168 follow a fixed pattern. Permissions can be arranged so that appropriate people
35169 can edit the different alias files. A successful aliasing operation results in
35170 a new envelope recipient address, which is then routed from scratch.
35171
35172 The other kind of &"virtual"& domain can also be handled in a straightforward
35173 way. One approach is to create a file for each domain containing a list of
35174 valid local parts, and use it in a router like this:
35175 .code
35176 my_domains:
35177   driver = accept
35178   domains = dsearch;/etc/mail/domains
35179   local_parts = lsearch;/etc/mail/domains/$domain
35180   transport = my_mailboxes
35181 .endd
35182 The address is accepted if there is a file for the domain, and the local part
35183 can be found in the file. The &%domains%& option is used to check for the
35184 file's existence because &%domains%& is tested before the &%local_parts%&
35185 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
35186 because that option is tested after &%local_parts%&. The transport is as
35187 follows:
35188 .code
35189 my_mailboxes:
35190   driver = appendfile
35191   file = /var/mail/$domain/$local_part
35192   user = mail
35193 .endd
35194 This uses a directory of mailboxes for each domain. The &%user%& setting is
35195 required, to specify which uid is to be used for writing to the mailboxes.
35196
35197 The configuration shown here is just one example of how you might support this
35198 requirement. There are many other ways this kind of configuration can be set
35199 up, for example, by using a database instead of separate files to hold all the
35200 information about the domains.
35201
35202
35203
35204 .section "Multiple user mailboxes" "SECTmulbox"
35205 .cindex "multiple mailboxes"
35206 .cindex "mailbox" "multiple"
35207 .cindex "local part" "prefix"
35208 .cindex "local part" "suffix"
35209 Heavy email users often want to operate with multiple mailboxes, into which
35210 incoming mail is automatically sorted. A popular way of handling this is to
35211 allow users to use multiple sender addresses, so that replies can easily be
35212 identified. Users are permitted to add prefixes or suffixes to their local
35213 parts for this purpose. The wildcard facility of the generic router options
35214 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
35215 example, consider this router:
35216 .code
35217 userforward:
35218   driver = redirect
35219   check_local_user
35220   file = $home/.forward
35221   local_part_suffix = -*
35222   local_part_suffix_optional
35223   allow_filter
35224 .endd
35225 .vindex "&$local_part_suffix$&"
35226 It runs a user's &_.forward_& file for all local parts of the form
35227 &'username-*'&. Within the filter file the user can distinguish different
35228 cases by testing the variable &$local_part_suffix$&. For example:
35229 .code
35230 if $local_part_suffix contains -special then
35231 save /home/$local_part/Mail/special
35232 endif
35233 .endd
35234 If the filter file does not exist, or does not deal with such addresses, they
35235 fall through to subsequent routers, and, assuming no subsequent use of the
35236 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
35237 control over which suffixes are valid.
35238
35239 Alternatively, a suffix can be used to trigger the use of a different
35240 &_.forward_& file &-- which is the way a similar facility is implemented in
35241 another MTA:
35242 .code
35243 userforward:
35244   driver = redirect
35245   check_local_user
35246   file = $home/.forward$local_part_suffix
35247   local_part_suffix = -*
35248   local_part_suffix_optional
35249   allow_filter
35250 .endd
35251 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
35252 example, &_.forward-special_& is used. Once again, if the appropriate file
35253 does not exist, or does not deal with the address, it is passed on to
35254 subsequent routers, which could, if required, look for an unqualified
35255 &_.forward_& file to use as a default.
35256
35257
35258
35259 .section "Simplified vacation processing" "SECID244"
35260 .cindex "vacation processing"
35261 The traditional way of running the &'vacation'& program is for a user to set up
35262 a pipe command in a &_.forward_& file
35263 (see section &<<SECTspecitredli>>& for syntax details).
35264 This is prone to error by inexperienced users. There are two features of Exim
35265 that can be used to make this process simpler for users:
35266
35267 .ilist
35268 A local part prefix such as &"vacation-"& can be specified on a router which
35269 can cause the message to be delivered directly to the &'vacation'& program, or
35270 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
35271 &_.forward_& file are then much simpler. For example:
35272 .code
35273 spqr, vacation-spqr
35274 .endd
35275 .next
35276 The &%require_files%& generic router option can be used to trigger a
35277 vacation delivery by checking for the existence of a certain file in the
35278 user's home directory. The &%unseen%& generic option should also be used, to
35279 ensure that the original delivery also proceeds. In this case, all the user has
35280 to do is to create a file called, say, &_.vacation_&, containing a vacation
35281 message.
35282 .endlist
35283
35284 Another advantage of both these methods is that they both work even when the
35285 use of arbitrary pipes by users is locked out.
35286
35287
35288
35289 .section "Taking copies of mail" "SECID245"
35290 .cindex "message" "copying every"
35291 Some installations have policies that require archive copies of all messages to
35292 be made. A single copy of each message can easily be taken by an appropriate
35293 command in a system filter, which could, for example, use a different file for
35294 each day's messages.
35295
35296 There is also a shadow transport mechanism that can be used to take copies of
35297 messages that are successfully delivered by local transports, one copy per
35298 delivery. This could be used, &'inter alia'&, to implement automatic
35299 notification of delivery by sites that insist on doing such things.
35300
35301
35302
35303 .section "Intermittently connected hosts" "SECID246"
35304 .cindex "intermittently connected hosts"
35305 It has become quite common (because it is cheaper) for hosts to connect to the
35306 Internet periodically rather than remain connected all the time. The normal
35307 arrangement is that mail for such hosts accumulates on a system that is
35308 permanently connected.
35309
35310 Exim was designed for use on permanently connected hosts, and so it is not
35311 particularly well-suited to use in an intermittently connected environment.
35312 Nevertheless there are some features that can be used.
35313
35314
35315 .section "Exim on the upstream server host" "SECID247"
35316 It is tempting to arrange for incoming mail for the intermittently connected
35317 host to remain on Exim's queue until the client connects. However, this
35318 approach does not scale very well. Two different kinds of waiting message are
35319 being mixed up in the same queue &-- those that cannot be delivered because of
35320 some temporary problem, and those that are waiting for their destination host
35321 to connect. This makes it hard to manage the queue, as well as wasting
35322 resources, because each queue runner scans the entire queue.
35323
35324 A better approach is to separate off those messages that are waiting for an
35325 intermittently connected host. This can be done by delivering these messages
35326 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
35327 format, from where they are transmitted by other software when their
35328 destination connects. This makes it easy to collect all the mail for one host
35329 in a single directory, and to apply local timeout rules on a per-message basis
35330 if required.
35331
35332 On a very small scale, leaving the mail on Exim's queue can be made to work. If
35333 you are doing this, you should configure Exim with a long retry period for the
35334 intermittent host. For example:
35335 .code
35336 cheshire.wonderland.fict.example    *   F,5d,24h
35337 .endd
35338 This stops a lot of failed delivery attempts from occurring, but Exim remembers
35339 which messages it has queued up for that host. Once the intermittent host comes
35340 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
35341 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
35342 causes all the queued up messages to be delivered, often down a single SMTP
35343 connection. While the host remains connected, any new messages get delivered
35344 immediately.
35345
35346 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35347 issued with a different IP address each time it connects, Exim's retry
35348 mechanisms on the holding host get confused, because the IP address is normally
35349 used as part of the key string for holding retry information. This can be
35350 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35351 Since this has disadvantages for permanently connected hosts, it is best to
35352 arrange a separate transport for the intermittently connected ones.
35353
35354
35355
35356 .section "Exim on the intermittently connected client host" "SECID248"
35357 The value of &%smtp_accept_queue_per_connection%& should probably be
35358 increased, or even set to zero (that is, disabled) on the intermittently
35359 connected host, so that all incoming messages down a single connection get
35360 delivered immediately.
35361
35362 .cindex "SMTP" "passed connection"
35363 .cindex "SMTP" "multiple deliveries"
35364 .cindex "multiple SMTP deliveries"
35365 Mail waiting to be sent from an intermittently connected host will probably
35366 not have been routed, because without a connection DNS lookups are not
35367 possible. This means that if a normal queue run is done at connection time,
35368 each message is likely to be sent in a separate SMTP session. This can be
35369 avoided by starting the queue run with a command line option beginning with
35370 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35371 first pass, routing is done but no deliveries take place. The second pass is a
35372 normal queue run; since all the messages have been previously routed, those
35373 destined for the same host are likely to get sent as multiple deliveries in a
35374 single SMTP connection.
35375
35376
35377
35378 . ////////////////////////////////////////////////////////////////////////////
35379 . ////////////////////////////////////////////////////////////////////////////
35380
35381 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35382          "Exim as a non-queueing client"
35383 .cindex "client, non-queueing"
35384 .cindex "smart host" "suppressing queueing"
35385 On a personal computer, it is a common requirement for all
35386 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35387 configured to operate that way, for all the popular operating systems.
35388 However, there are some MUAs for Unix-like systems that cannot be so
35389 configured: they submit messages using the command line interface of
35390 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35391 messages this way.
35392
35393 If the personal computer runs continuously, there is no problem, because it can
35394 run a conventional MTA that handles delivery to the smart host, and deal with
35395 any delays via its queueing mechanism. However, if the computer does not run
35396 continuously or runs different operating systems at different times, queueing
35397 email is not desirable.
35398
35399 There is therefore a requirement for something that can provide the
35400 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35401 any queueing or retrying facilities. Furthermore, the delivery to the smart
35402 host should be synchronous, so that if it fails, the sending MUA is immediately
35403 informed. In other words, we want something that extends an MUA that submits
35404 to a local MTA via the command line so that it behaves like one that submits
35405 to a remote smart host using TCP/SMTP.
35406
35407 There are a number of applications (for example, there is one called &'ssmtp'&)
35408 that do this job. However, people have found them to be lacking in various
35409 ways. For instance, you might want to allow aliasing and forwarding to be done
35410 before sending a message to the smart host.
35411
35412 Exim already had the necessary infrastructure for doing this job. Just a few
35413 tweaks were needed to make it behave as required, though it is somewhat of an
35414 overkill to use a fully-featured MTA for this purpose.
35415
35416 .oindex "&%mua_wrapper%&"
35417 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35418 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35419 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35420 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35421 compatible router and transport configuration. Typically there will be just one
35422 router and one transport, sending everything to a smart host.
35423
35424 When run in MUA wrapping mode, the behaviour of Exim changes in the
35425 following ways:
35426
35427 .ilist
35428 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35429 In other words, the only way to submit messages is via the command line.
35430 .next
35431 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35432 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35433 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35434 does not finish until the delivery attempt is complete. If the delivery is
35435 successful, a zero return code is given.
35436 .next
35437 Address redirection is permitted, but the final routing for all addresses must
35438 be to the same remote transport, and to the same list of hosts. Furthermore,
35439 the return address (envelope sender) must be the same for all recipients, as
35440 must any added or deleted header lines. In other words, it must be possible to
35441 deliver the message in a single SMTP transaction, however many recipients there
35442 are.
35443 .next
35444 If these conditions are not met, or if routing any address results in a
35445 failure or defer status, or if Exim is unable to deliver all the recipients
35446 successfully to one of the smart hosts, delivery of the entire message fails.
35447 .next
35448 Because no queueing is allowed, all failures are treated as permanent; there
35449 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35450 smart host. Furthermore, because only a single yes/no response can be given to
35451 the caller, it is not possible to deliver to some recipients and not others. If
35452 there is an error (temporary or permanent) for any recipient, all are failed.
35453 .next
35454 If more than one smart host is listed, Exim will try another host after a
35455 connection failure or a timeout, in the normal way. However, if this kind of
35456 failure happens for all the hosts, the delivery fails.
35457 .next
35458 When delivery fails, an error message is written to the standard error stream
35459 (as well as to Exim's log), and Exim exits to the caller with a return code
35460 value 1. The message is expunged from Exim's spool files. No bounce messages
35461 are ever generated.
35462 .next
35463 No retry data is maintained, and any retry rules are ignored.
35464 .next
35465 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35466 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35467 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35468 .endlist
35469
35470 The overall effect is that Exim makes a single synchronous attempt to deliver
35471 the message, failing if there is any kind of problem. Because no local
35472 deliveries are done and no daemon can be run, Exim does not need root
35473 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35474 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35475 the advantages and disadvantages of running without root privilege.
35476
35477
35478
35479
35480 . ////////////////////////////////////////////////////////////////////////////
35481 . ////////////////////////////////////////////////////////////////////////////
35482
35483 .chapter "Log files" "CHAPlog"
35484 .scindex IIDloggen "log" "general description"
35485 .cindex "log" "types of"
35486 Exim writes three different logs, referred to as the main log, the reject log,
35487 and the panic log:
35488
35489 .ilist
35490 .cindex "main log"
35491 The main log records the arrival of each message and each delivery in a single
35492 line in each case. The format is as compact as possible, in an attempt to keep
35493 down the size of log files. Two-character flag sequences make it easy to pick
35494 out these lines. A number of other events are recorded in the main log. Some of
35495 them are optional, in which case the &%log_selector%& option controls whether
35496 they are included or not. A Perl script called &'eximstats'&, which does simple
35497 analysis of main log files, is provided in the Exim distribution (see section
35498 &<<SECTmailstat>>&).
35499 .next
35500 .cindex "reject log"
35501 The reject log records information from messages that are rejected as a result
35502 of a configuration option (that is, for policy reasons).
35503 The first line of each rejection is a copy of the line that is also written to
35504 the main log. Then, if the message's header has been read at the time the log
35505 is written, its contents are written to this log. Only the original header
35506 lines are available; header lines added by ACLs are not logged. You can use the
35507 reject log to check that your policy controls are working correctly; on a busy
35508 host this may be easier than scanning the main log for rejection messages. You
35509 can suppress the writing of the reject log by setting &%write_rejectlog%&
35510 false.
35511 .next
35512 .cindex "panic log"
35513 .cindex "system log"
35514 When certain serious errors occur, Exim writes entries to its panic log. If the
35515 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35516 are usually written to the main log as well, but can get lost amid the mass of
35517 other entries. The panic log should be empty under normal circumstances. It is
35518 therefore a good idea to check it (or to have a &'cron'& script check it)
35519 regularly, in order to become aware of any problems. When Exim cannot open its
35520 panic log, it tries as a last resort to write to the system log (syslog). This
35521 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35522 message itself is written at priority LOG_CRIT.
35523 .endlist
35524
35525 Every log line starts with a timestamp, in the format shown in the following
35526 example. Note that many of the examples shown in this chapter are line-wrapped.
35527 In the log file, this would be all on one line:
35528 .code
35529 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35530   by QUIT
35531 .endd
35532 By default, the timestamps are in the local timezone. There are two
35533 ways of changing this:
35534
35535 .ilist
35536 You can set the &%timezone%& option to a different time zone; in particular, if
35537 you set
35538 .code
35539 timezone = UTC
35540 .endd
35541 the timestamps will be in UTC (aka GMT).
35542 .next
35543 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35544 example:
35545 .code
35546 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35547 .endd
35548 .endlist
35549
35550 .cindex "log" "process ids in"
35551 .cindex "pid (process id)" "in log lines"
35552 Exim does not include its process id in log lines by default, but you can
35553 request that it does so by specifying the &`pid`& log selector (see section
35554 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35555 brackets, immediately after the time and date.
35556
35557
35558
35559
35560 .section "Where the logs are written" "SECTwhelogwri"
35561 .cindex "log" "destination"
35562 .cindex "log" "to file"
35563 .cindex "log" "to syslog"
35564 .cindex "syslog"
35565 The logs may be written to local files, or to syslog, or both. However, it
35566 should be noted that many syslog implementations use UDP as a transport, and
35567 are therefore unreliable in the sense that messages are not guaranteed to
35568 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35569 It has also been reported that on large log files (tens of megabytes) you may
35570 need to tweak syslog to prevent it syncing the file with each write &-- on
35571 Linux this has been seen to make syslog take 90% plus of CPU time.
35572
35573 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35574 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35575 configuration. This latter string is expanded, so it can contain, for example,
35576 references to the host name:
35577 .code
35578 log_file_path = /var/log/$primary_hostname/exim_%slog
35579 .endd
35580 It is generally advisable, however, to set the string in &_Local/Makefile_&
35581 rather than at run time, because then the setting is available right from the
35582 start of Exim's execution. Otherwise, if there's something it wants to log
35583 before it has read the configuration file (for example, an error in the
35584 configuration file) it will not use the path you want, and may not be able to
35585 log at all.
35586
35587 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35588 list, currently limited to at most two items. This is one option where the
35589 facility for changing a list separator may not be used. The list must always be
35590 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35591 otherwise the item must either be an absolute path, containing &`%s`& at the
35592 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35593 implying the use of a default path.
35594
35595 When Exim encounters an empty item in the list, it searches the list defined by
35596 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35597 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35598 mean &"use the path specified at build time"&. It no such item exists, log
35599 files are written in the &_log_& subdirectory of the spool directory. This is
35600 equivalent to the setting:
35601 .code
35602 log_file_path = $spool_directory/log/%slog
35603 .endd
35604 If you do not specify anything at build time or run time,
35605 or if you unset the option at run time (i.e. &`log_file_path = `&),
35606 that is where the logs are written.
35607
35608 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35609 are in use &-- see section &<<SECTdatlogfil>>& below.
35610
35611 Here are some examples of possible settings:
35612 .display
35613 &`LOG_FILE_PATH=syslog                    `& syslog only
35614 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35615 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35616 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35617 .endd
35618 If there are more than two paths in the list, the first is used and a panic
35619 error is logged.
35620
35621
35622
35623 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35624 .cindex "log" "cycling local files"
35625 .cindex "cycling logs"
35626 .cindex "&'exicyclog'&"
35627 .cindex "log" "local files; writing to"
35628 Some operating systems provide centralized and standardized methods for cycling
35629 log files. For those that do not, a utility script called &'exicyclog'& is
35630 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35631 main and reject logs each time it is called. The maximum number of old logs to
35632 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35633
35634 An Exim delivery process opens the main log when it first needs to write to it,
35635 and it keeps the file open in case subsequent entries are required &-- for
35636 example, if a number of different deliveries are being done for the same
35637 message. However, remote SMTP deliveries can take a long time, and this means
35638 that the file may be kept open long after it is renamed if &'exicyclog'& or
35639 something similar is being used to rename log files on a regular basis. To
35640 ensure that a switch of log files is noticed as soon as possible, Exim calls
35641 &[stat()]& on the main log's name before reusing an open file, and if the file
35642 does not exist, or its inode has changed, the old file is closed and Exim
35643 tries to open the main log from scratch. Thus, an old log file may remain open
35644 for quite some time, but no Exim processes should write to it once it has been
35645 renamed.
35646
35647
35648
35649 .section "Datestamped log files" "SECTdatlogfil"
35650 .cindex "log" "datestamped files"
35651 Instead of cycling the main and reject log files by renaming them
35652 periodically, some sites like to use files whose names contain a datestamp,
35653 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35654 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35655 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35656 point where the datestamp is required. For example:
35657 .code
35658 log_file_path = /var/spool/exim/log/%slog-%D
35659 log_file_path = /var/log/exim-%s-%D.log
35660 log_file_path = /var/spool/exim/log/%D-%slog
35661 log_file_path = /var/log/exim/%s.%M
35662 .endd
35663 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35664 examples of names generated by the above examples:
35665 .code
35666 /var/spool/exim/log/mainlog-20021225
35667 /var/log/exim-reject-20021225.log
35668 /var/spool/exim/log/20021225-mainlog
35669 /var/log/exim/main.200212
35670 .endd
35671 When this form of log file is specified, Exim automatically switches to new
35672 files at midnight. It does not make any attempt to compress old logs; you
35673 will need to write your own script if you require this. You should not
35674 run &'exicyclog'& with this form of logging.
35675
35676 The location of the panic log is also determined by &%log_file_path%&, but it
35677 is not datestamped, because rotation of the panic log does not make sense.
35678 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35679 the string. In addition, if it immediately follows a slash, a following
35680 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35681 character is removed. Thus, the four examples above would give these panic
35682 log names:
35683 .code
35684 /var/spool/exim/log/paniclog
35685 /var/log/exim-panic.log
35686 /var/spool/exim/log/paniclog
35687 /var/log/exim/panic
35688 .endd
35689
35690
35691 .section "Logging to syslog" "SECID249"
35692 .cindex "log" "syslog; writing to"
35693 The use of syslog does not change what Exim logs or the format of its messages,
35694 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35695 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35696 that, the same strings are written to syslog as to log files. The syslog
35697 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35698 by default, but you can change these by setting the &%syslog_facility%& and
35699 &%syslog_processname%& options, respectively. If Exim was compiled with
35700 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35701 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35702 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35703 the time and host name to each line.
35704 The three log streams are mapped onto syslog priorities as follows:
35705
35706 .ilist
35707 &'mainlog'& is mapped to LOG_INFO
35708 .next
35709 &'rejectlog'& is mapped to LOG_NOTICE
35710 .next
35711 &'paniclog'& is mapped to LOG_ALERT
35712 .endlist
35713
35714 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35715 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35716 these are routed by syslog to the same place. You can suppress this duplication
35717 by setting &%syslog_duplication%& false.
35718
35719 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35720 entries contain multiple lines when headers are included. To cope with both
35721 these cases, entries written to syslog are split into separate &[syslog()]&
35722 calls at each internal newline, and also after a maximum of
35723 870 data characters. (This allows for a total syslog line length of 1024, when
35724 additions such as timestamps are added.) If you are running a syslog
35725 replacement that can handle lines longer than the 1024 characters allowed by
35726 RFC 3164, you should set
35727 .code
35728 SYSLOG_LONG_LINES=yes
35729 .endd
35730 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35731 lines, but it still splits at internal newlines in &'reject'& log entries.
35732
35733 To make it easy to re-assemble split lines later, each component of a split
35734 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35735 where <&'n'&> is the component number and <&'m'&> is the total number of
35736 components in the entry. The / delimiter is used when the line was split
35737 because it was too long; if it was split because of an internal newline, the \
35738 delimiter is used. For example, supposing the length limit to be 50 instead of
35739 870, the following would be the result of a typical rejection message to
35740 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35741 name, and pid as added by syslog:
35742 .code
35743 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35744 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35745 [3/5]  when scanning for sender: missing or malformed lo
35746 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35747 [5/5] mple>)
35748 .endd
35749 The same error might cause the following lines to be written to &"rejectlog"&
35750 (LOG_NOTICE):
35751 .code
35752 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35753 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35754 [3/18] er when scanning for sender: missing or malformed
35755 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35756 [5\18] .example>)
35757 [6\18] Recipients: ph10@some.domain.cam.example
35758 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35759 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35760 [9\18]        id 16RdAL-0006pc-00
35761 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35762 [11\18] 09:43 +0100
35763 [12\18] F From: <>
35764 [13\18]   Subject: this is a test header
35765 [18\18]   X-something: this is another header
35766 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35767 [16\18] le>
35768 [17\18] B Bcc:
35769 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35770 .endd
35771 Log lines that are neither too long nor contain newlines are written to syslog
35772 without modification.
35773
35774 If only syslog is being used, the Exim monitor is unable to provide a log tail
35775 display, unless syslog is routing &'mainlog'& to a file on the local host and
35776 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35777 where it is.
35778
35779
35780
35781 .section "Log line flags" "SECID250"
35782 One line is written to the main log for each message received, and for each
35783 successful, unsuccessful, and delayed delivery. These lines can readily be
35784 picked out by the distinctive two-character flags that immediately follow the
35785 timestamp. The flags are:
35786 .display
35787 &`<=`&     message arrival
35788 &`(=`&     message fakereject
35789 &`=>`&     normal message delivery
35790 &`->`&     additional address in same delivery
35791 &`>>`&     cutthrough message delivery
35792 &`*>`&     delivery suppressed by &%-N%&
35793 &`**`&     delivery failed; address bounced
35794 &`==`&     delivery deferred; temporary problem
35795 .endd
35796
35797
35798 .section "Logging message reception" "SECID251"
35799 .cindex "log" "reception line"
35800 The format of the single-line entry in the main log that is written for every
35801 message received is shown in the basic example below, which is split over
35802 several lines in order to fit it on the page:
35803 .code
35804 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35805   H=mailer.fict.example [192.168.123.123] U=exim
35806   P=smtp S=5678 id=<incoming message id>
35807 .endd
35808 The address immediately following &"<="& is the envelope sender address. A
35809 bounce message is shown with the sender address &"<>"&, and if it is locally
35810 generated, this is followed by an item of the form
35811 .code
35812 R=<message id>
35813 .endd
35814 which is a reference to the message that caused the bounce to be sent.
35815
35816 .cindex "HELO"
35817 .cindex "EHLO"
35818 For messages from other hosts, the H and U fields identify the remote host and
35819 record the RFC 1413 identity of the user that sent the message, if one was
35820 received. The number given in square brackets is the IP address of the sending
35821 host. If there is a single, unparenthesized  host name in the H field, as
35822 above, it has been verified to correspond to the IP address (see the
35823 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35824 by the remote host in the SMTP HELO or EHLO command, and has not been
35825 verified. If verification yields a different name to that given for HELO or
35826 EHLO, the verified name appears first, followed by the HELO or EHLO
35827 name in parentheses.
35828
35829 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35830 without brackets, in the HELO or EHLO command, leading to entries in
35831 the log containing text like these examples:
35832 .code
35833 H=(10.21.32.43) [192.168.8.34]
35834 H=([10.21.32.43]) [192.168.8.34]
35835 .endd
35836 This can be confusing. Only the final address in square brackets can be relied
35837 on.
35838
35839 For locally generated messages (that is, messages not received over TCP/IP),
35840 the H field is omitted, and the U field contains the login name of the caller
35841 of Exim.
35842
35843 .cindex "authentication" "logging"
35844 .cindex "AUTH" "logging"
35845 For all messages, the P field specifies the protocol used to receive the
35846 message. This is the value that is stored in &$received_protocol$&. In the case
35847 of incoming SMTP messages, the value indicates whether or not any SMTP
35848 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35849 session was encrypted, there is an additional X field that records the cipher
35850 suite that was used.
35851
35852 .cindex log protocol
35853 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35854 hosts that have authenticated themselves using the SMTP AUTH command. The first
35855 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35856 there is an additional item A= followed by the name of the authenticator that
35857 was used. If an authenticated identification was set up by the authenticator's
35858 &%server_set_id%& option, this is logged too, separated by a colon from the
35859 authenticator name.
35860
35861 .cindex "size" "of message"
35862 The id field records the existing message id, if present. The size of the
35863 received message is given by the S field. When the message is delivered,
35864 headers may be removed or added, so that the size of delivered copies of the
35865 message may not correspond with this value (and indeed may be different to each
35866 other).
35867
35868 The &%log_selector%& option can be used to request the logging of additional
35869 data when a message is received. See section &<<SECTlogselector>>& below.
35870
35871
35872
35873 .section "Logging deliveries" "SECID252"
35874 .cindex "log" "delivery line"
35875 The format of the single-line entry in the main log that is written for every
35876 delivery is shown in one of the examples below, for local and remote
35877 deliveries, respectively. Each example has been split into multiple lines in order
35878 to fit it on the page:
35879 .code
35880 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35881   <marv@hitch.fict.example> R=localuser T=local_delivery
35882 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35883   monk@holistic.fict.example R=dnslookup T=remote_smtp
35884   H=holistic.fict.example [192.168.234.234]
35885 .endd
35886 For ordinary local deliveries, the original address is given in angle brackets
35887 after the final delivery address, which might be a pipe or a file. If
35888 intermediate address(es) exist between the original and the final address, the
35889 last of these is given in parentheses after the final address. The R and T
35890 fields record the router and transport that were used to process the address.
35891
35892 If SMTP AUTH was used for the delivery there is an additional item A=
35893 followed by the name of the authenticator that was used.
35894 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35895 option, this is logged too, separated by a colon from the authenticator name.
35896
35897 If a shadow transport was run after a successful local delivery, the log line
35898 for the successful delivery has an item added on the end, of the form
35899 .display
35900 &`ST=<`&&'shadow transport name'&&`>`&
35901 .endd
35902 If the shadow transport did not succeed, the error message is put in
35903 parentheses afterwards.
35904
35905 .cindex "asterisk" "after IP address"
35906 When more than one address is included in a single delivery (for example, two
35907 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35908 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35909 down a single SMTP connection, an asterisk follows the IP address in the log
35910 lines for the second and subsequent messages.
35911 .new
35912 When two or more messages are delivered down a single TLS connection, the
35913 DNS and some TLS-related information logged for the first message delivered
35914 will not be present in the log lines for the second and subsequent messages.
35915 TLS cipher information is still available.
35916 .wen
35917
35918 .cindex "delivery" "cutthrough; logging"
35919 .cindex "cutthrough" "logging"
35920 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35921 line precedes the reception line, since cutthrough waits for a possible
35922 rejection from the destination in case it can reject the sourced item.
35923
35924 The generation of a reply message by a filter file gets logged as a
35925 &"delivery"& to the addressee, preceded by &">"&.
35926
35927 The &%log_selector%& option can be used to request the logging of additional
35928 data when a message is delivered. See section &<<SECTlogselector>>& below.
35929
35930
35931 .section "Discarded deliveries" "SECID253"
35932 .cindex "discarded messages"
35933 .cindex "message" "discarded"
35934 .cindex "delivery" "discarded; logging"
35935 When a message is discarded as a result of the command &"seen finish"& being
35936 obeyed in a filter file which generates no deliveries, a log entry of the form
35937 .code
35938 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35939   <low.club@bridge.example> R=userforward
35940 .endd
35941 is written, to record why no deliveries are logged. When a message is discarded
35942 because it is aliased to &":blackhole:"& the log line is like this:
35943 .code
35944 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35945   <hole@nowhere.example> R=blackhole_router
35946 .endd
35947
35948
35949 .section "Deferred deliveries" "SECID254"
35950 When a delivery is deferred, a line of the following form is logged:
35951 .code
35952 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35953   R=dnslookup T=smtp defer (146): Connection refused
35954 .endd
35955 In the case of remote deliveries, the error is the one that was given for the
35956 last IP address that was tried. Details of individual SMTP failures are also
35957 written to the log, so the above line would be preceded by something like
35958 .code
35959 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35960   mail1.endrest.example [192.168.239.239]: Connection refused
35961 .endd
35962 When a deferred address is skipped because its retry time has not been reached,
35963 a message is written to the log, but this can be suppressed by setting an
35964 appropriate value in &%log_selector%&.
35965
35966
35967
35968 .section "Delivery failures" "SECID255"
35969 .cindex "delivery" "failure; logging"
35970 If a delivery fails because an address cannot be routed, a line of the
35971 following form is logged:
35972 .code
35973 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35974   <jim@trek99.example>: unknown mail domain
35975 .endd
35976 If a delivery fails at transport time, the router and transport are shown, and
35977 the response from the remote host is included, as in this example:
35978 .code
35979 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35980   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35981   after pipelined RCPT TO:<ace400@pb.example>: host
35982   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35983   <ace400@pb.example>...Addressee unknown
35984 .endd
35985 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35986 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35987 disabling PIPELINING. The log lines for all forms of delivery failure are
35988 flagged with &`**`&.
35989
35990
35991
35992 .section "Fake deliveries" "SECID256"
35993 .cindex "delivery" "fake; logging"
35994 If a delivery does not actually take place because the &%-N%& option has been
35995 used to suppress it, a normal delivery line is written to the log, except that
35996 &"=>"& is replaced by &"*>"&.
35997
35998
35999
36000 .section "Completion" "SECID257"
36001 A line of the form
36002 .code
36003 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
36004 .endd
36005 is written to the main log when a message is about to be removed from the spool
36006 at the end of its processing.
36007
36008
36009
36010
36011 .section "Summary of Fields in Log Lines" "SECID258"
36012 .cindex "log" "summary of fields"
36013 A summary of the field identifiers that are used in log lines is shown in
36014 the following table:
36015 .display
36016 &`A   `&        authenticator name (and optional id and sender)
36017 &`C   `&        SMTP confirmation on delivery
36018 &`    `&        command list for &"no mail in SMTP session"&
36019 &`CV  `&        certificate verification status
36020 &`D   `&        duration of &"no mail in SMTP session"&
36021 &`DN  `&        distinguished name from peer certificate
36022 &`DS  `&        DNSSEC secured lookups
36023 &`DT  `&        on &`=>`& lines: time taken for a delivery
36024 &`F   `&        sender address (on delivery lines)
36025 &`H   `&        host name and IP address
36026 &`I   `&        local interface used
36027 &`K   `&        CHUNKING extension used
36028 &`id  `&        message id for incoming message
36029 &`M8S `&        8BITMIME status for incoming message
36030 &`P   `&        on &`<=`& lines: protocol used
36031 &`    `&        on &`=>`& and &`**`& lines: return path
36032 &`PRDR`&        PRDR extension used
36033 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
36034 &`Q   `&        alternate queue name
36035 &`QT  `&        on &`=>`& lines: time spent on queue so far
36036 &`    `&        on &"Completed"& lines: time spent on queue
36037 &`R   `&        on &`<=`& lines: reference for local bounce
36038 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
36039 &`S   `&        size of message in bytes
36040 &`SNI `&        server name indication from TLS client hello
36041 &`ST  `&        shadow transport name
36042 &`T   `&        on &`<=`& lines: message subject (topic)
36043 &`TFO `&        connection took advantage of TCP Fast Open
36044 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
36045 &`U   `&        local user or RFC 1413 identity
36046 &`X   `&        TLS cipher suite
36047 .endd
36048
36049
36050 .section "Other log entries" "SECID259"
36051 Various other types of log entry are written from time to time. Most should be
36052 self-explanatory. Among the more common are:
36053
36054 .ilist
36055 .cindex "retry" "time not reached"
36056 &'retry time not reached'&&~&~An address previously suffered a temporary error
36057 during routing or local delivery, and the time to retry has not yet arrived.
36058 This message is not written to an individual message log file unless it happens
36059 during the first delivery attempt.
36060 .next
36061 &'retry time not reached for any host'&&~&~An address previously suffered
36062 temporary errors during remote delivery, and the retry time has not yet arrived
36063 for any of the hosts to which it is routed.
36064 .next
36065 .cindex "spool directory" "file locked"
36066 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
36067 some other Exim process is already working on the message. This can be quite
36068 common if queue running processes are started at frequent intervals. The
36069 &'exiwhat'& utility script can be used to find out what Exim processes are
36070 doing.
36071 .next
36072 .cindex "error" "ignored"
36073 &'error ignored'&&~&~There are several circumstances that give rise to this
36074 message:
36075 .olist
36076 Exim failed to deliver a bounce message whose age was greater than
36077 &%ignore_bounce_errors_after%&. The bounce was discarded.
36078 .next
36079 A filter file set up a delivery using the &"noerror"& option, and the delivery
36080 failed. The delivery was discarded.
36081 .next
36082 A delivery set up by a router configured with
36083 . ==== As this is a nested list, any displays it contains must be indented
36084 . ==== as otherwise they are too far to the left.
36085 .code
36086     errors_to = <>
36087 .endd
36088 failed. The delivery was discarded.
36089 .endlist olist
36090 .endlist ilist
36091
36092
36093
36094
36095
36096 .section "Reducing or increasing what is logged" "SECTlogselector"
36097 .cindex "log" "selectors"
36098 By setting the &%log_selector%& global option, you can disable some of Exim's
36099 default logging, or you can request additional logging. The value of
36100 &%log_selector%& is made up of names preceded by plus or minus characters. For
36101 example:
36102 .code
36103 log_selector = +arguments -retry_defer
36104 .endd
36105 The list of optional log items is in the following table, with the default
36106 selection marked by asterisks:
36107 .display
36108 &` 8bitmime                   `&  received 8BITMIME status
36109 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
36110 &` address_rewrite            `&  address rewriting
36111 &` all_parents                `&  all parents in => lines
36112 &` arguments                  `&  command line arguments
36113 &`*connection_reject          `&  connection rejections
36114 &`*delay_delivery             `&  immediate delivery delayed
36115 &` deliver_time               `&  time taken to perform delivery
36116 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
36117 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
36118 &` dnssec                     `&  DNSSEC secured lookups
36119 &`*etrn                       `&  ETRN commands
36120 &`*host_lookup_failed         `&  as it says
36121 &` ident_timeout              `&  timeout for ident connection
36122 &` incoming_interface         `&  local interface on <= and => lines
36123 &` incoming_port              `&  remote port on <= lines
36124 &`*lost_incoming_connection   `&  as it says (includes timeouts)
36125 &` millisec                   `&  millisecond timestamps and QT,DT,D times
36126 &` outgoing_interface         `&  local interface on => lines
36127 &` outgoing_port              `&  add remote port to => lines
36128 &`*queue_run                  `&  start and end queue runs
36129 &` queue_time                 `&  time on queue for one recipient
36130 &` queue_time_overall         `&  time on queue for whole message
36131 &` pid                        `&  Exim process id
36132 &` proxy                      `&  proxy address on <= and => lines
36133 &` received_recipients        `&  recipients on <= lines
36134 &` received_sender            `&  sender on <= lines
36135 &`*rejected_header            `&  header contents on reject log
36136 &`*retry_defer                `&  &"retry time not reached"&
36137 &` return_path_on_delivery    `&  put return path on => and ** lines
36138 &` sender_on_delivery         `&  add sender to => lines
36139 &`*sender_verify_fail         `&  sender verification failures
36140 &`*size_reject                `&  rejection because too big
36141 &`*skip_delivery              `&  delivery skipped in a queue run
36142 &`*smtp_confirmation          `&  SMTP confirmation on => lines
36143 &` smtp_connection            `&  incoming SMTP connections
36144 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
36145 &` smtp_mailauth              `&  AUTH argument to MAIL commands
36146 &` smtp_no_mail               `&  session with no MAIL commands
36147 &` smtp_protocol_error        `&  SMTP protocol errors
36148 &` smtp_syntax_error          `&  SMTP syntax errors
36149 &` subject                    `&  contents of &'Subject:'& on <= lines
36150 &`*tls_certificate_verified   `&  certificate verification status
36151 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
36152 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
36153 &` tls_sni                    `&  TLS SNI on <= lines
36154 &` unknown_in_list            `&  DNS lookup failed in list match
36155
36156 &` all                        `&  all of the above
36157 .endd
36158 See also the &%slow_lookup_log%& main configuration option,
36159 section &<<SECID99>>&
36160
36161 More details on each of these items follows:
36162
36163 .ilist
36164 .cindex "8BITMIME"
36165 .cindex "log" "8BITMIME"
36166 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
36167 which may help in tracking down interoperability issues with ancient MTAs
36168 that are not 8bit clean.  This is added to the &"<="& line, tagged with
36169 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
36170 &`7BIT`& and &`8BITMIME`& respectively.
36171 .next
36172 .cindex "&%warn%& ACL verb" "log when skipping"
36173 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
36174 its conditions cannot be evaluated, a log line to this effect is written if
36175 this log selector is set.
36176 .next
36177 .cindex "log" "rewriting"
36178 .cindex "rewriting" "logging"
36179 &%address_rewrite%&: This applies both to global rewrites and per-transport
36180 rewrites, but not to rewrites in filters run as an unprivileged user (because
36181 such users cannot access the log).
36182 .next
36183 .cindex "log" "full parentage"
36184 &%all_parents%&: Normally only the original and final addresses are logged on
36185 delivery lines; with this selector, intermediate parents are given in
36186 parentheses between them.
36187 .next
36188 .cindex "log" "Exim arguments"
36189 .cindex "Exim arguments, logging"
36190 &%arguments%&: This causes Exim to write the arguments with which it was called
36191 to the main log, preceded by the current working directory. This is a debugging
36192 feature, added to make it easier to find out how certain MUAs call
36193 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
36194 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
36195 that are empty or that contain white space are quoted. Non-printing characters
36196 are shown as escape sequences. This facility cannot log unrecognized arguments,
36197 because the arguments are checked before the configuration file is read. The
36198 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
36199 between the caller and Exim.
36200 .next
36201 .cindex "log" "connection rejections"
36202 &%connection_reject%&: A log entry is written whenever an incoming SMTP
36203 connection is rejected, for whatever reason.
36204 .next
36205 .cindex "log" "delayed delivery"
36206 .cindex "delayed delivery, logging"
36207 &%delay_delivery%&: A log entry is written whenever a delivery process is not
36208 started for an incoming message because the load is too high or too many
36209 messages were received on one connection. Logging does not occur if no delivery
36210 process is started because &%queue_only%& is set or &%-odq%& was used.
36211 .next
36212 .cindex "log" "delivery duration"
36213 &%deliver_time%&: For each delivery, the amount of real time it has taken to
36214 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
36215 If millisecond logging is enabled, short times will be shown with greater
36216 precision, eg. &`DT=0.304`&.
36217 .next
36218 .cindex "log" "message size on delivery"
36219 .cindex "size" "of message"
36220 &%delivery_size%&: For each delivery, the size of message delivered is added to
36221 the &"=>"& line, tagged with S=.
36222 .next
36223 .cindex "log" "dnslist defer"
36224 .cindex "DNS list" "logging defer"
36225 .cindex "black list (DNS)"
36226 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
36227 DNS black list suffers a temporary error.
36228 .next
36229 .cindex log dnssec
36230 .cindex dnssec logging
36231 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
36232 dns lookups gave secure results a tag of DS is added.
36233 For acceptance this covers the reverse and forward lookups for host name verification.
36234 It does not cover helo-name verification.
36235 For delivery this covers the SRV, MX, A and/or AAAA lookups.
36236 .next
36237 .cindex "log" "ETRN commands"
36238 .cindex "ETRN" "logging"
36239 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
36240 is run to determine whether or not it is actually accepted. An invalid ETRN
36241 command, or one received within a message transaction is not logged by this
36242 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
36243 .next
36244 .cindex "log" "host lookup failure"
36245 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
36246 any addresses, or when a lookup of an IP address fails to find a host name, a
36247 log line is written. This logging does not apply to direct DNS lookups when
36248 routing email addresses, but it does apply to &"byname"& lookups.
36249 .next
36250 .cindex "log" "ident timeout"
36251 .cindex "RFC 1413" "logging timeout"
36252 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
36253 client's ident port times out.
36254 .next
36255 .cindex "log" "incoming interface"
36256 .cindex "log" "local interface"
36257 .cindex "log" "local address and port"
36258 .cindex "TCP/IP" "logging local address and port"
36259 .cindex "interface" "logging"
36260 &%incoming_interface%&: The interface on which a message was received is added
36261 to the &"<="& line as an IP address in square brackets, tagged by I= and
36262 followed by a colon and the port number. The local interface and port are also
36263 added to other SMTP log lines, for example &"SMTP connection from"&, to
36264 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
36265 The latter can be disabled by turning off the &%outgoing_interface%& option.
36266 .next
36267 .cindex log "incoming proxy address"
36268 .cindex proxy "logging proxy address"
36269 .cindex "TCP/IP" "logging proxy address"
36270 &%proxy%&: The internal (closest to the system running Exim) IP address
36271 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
36272 on a proxied connection
36273 or the &"=>"& line for a message delivered on a proxied connection.
36274 See &<<SECTproxyInbound>>& for more information.
36275 .next
36276 .cindex "log" "incoming remote port"
36277 .cindex "port" "logging remote"
36278 .cindex "TCP/IP" "logging incoming remote port"
36279 .vindex "&$sender_fullhost$&"
36280 .vindex "&$sender_rcvhost$&"
36281 &%incoming_port%&: The remote port number from which a message was received is
36282 added to log entries and &'Received:'& header lines, following the IP address
36283 in square brackets, and separated from it by a colon. This is implemented by
36284 changing the value that is put in the &$sender_fullhost$& and
36285 &$sender_rcvhost$& variables. Recording the remote port number has become more
36286 important with the widening use of NAT (see RFC 2505).
36287 .next
36288 .cindex "log" "dropped connection"
36289 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
36290 connection is unexpectedly dropped.
36291 .next
36292 .new
36293 .cindex "log" "millisecond timestamps"
36294 .cindex millisecond logging
36295 .cindex timstamps "millisecond, in logs"
36296 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
36297 appended to the seconds value.
36298 .wen
36299 .next
36300 .cindex "log" "outgoing interface"
36301 .cindex "log" "local interface"
36302 .cindex "log" "local address and port"
36303 .cindex "TCP/IP" "logging local address and port"
36304 .cindex "interface" "logging"
36305 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
36306 interface on which a message was sent is added to delivery lines as an I= tag
36307 followed by IP address in square brackets. You can disable this by turning
36308 off the &%outgoing_interface%& option.
36309 .next
36310 .cindex "log" "outgoing remote port"
36311 .cindex "port" "logging outgoint remote"
36312 .cindex "TCP/IP" "logging outgoing remote port"
36313 &%outgoing_port%&: The remote port number is added to delivery log lines (those
36314 containing => tags) following the IP address.
36315 The local port is also added if &%incoming_interface%& and
36316 &%outgoing_interface%& are both enabled.
36317 This option is not included in the default setting, because for most ordinary
36318 configurations, the remote port number is always 25 (the SMTP port), and the
36319 local port is a random ephemeral port.
36320 .next
36321 .cindex "log" "process ids in"
36322 .cindex "pid (process id)" "in log lines"
36323 &%pid%&: The current process id is added to every log line, in square brackets,
36324 immediately after the time and date.
36325 .next
36326 .cindex "log" "queue run"
36327 .cindex "queue runner" "logging"
36328 &%queue_run%&: The start and end of every queue run are logged.
36329 .next
36330 .cindex "log" "queue time"
36331 &%queue_time%&: The amount of time the message has been in the queue on the
36332 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
36333 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
36334 includes reception time as well as the delivery time for the current address.
36335 This means that it may be longer than the difference between the arrival and
36336 delivery log line times, because the arrival log line is not written until the
36337 message has been successfully received.
36338 If millisecond logging is enabled, short times will be shown with greater
36339 precision, eg. &`QT=1.578s`&.
36340 .next
36341 &%queue_time_overall%&: The amount of time the message has been in the queue on
36342 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
36343 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
36344 message, so it includes reception time as well as the total delivery time.
36345 .next
36346 .cindex "log" "recipients"
36347 &%received_recipients%&: The recipients of a message are listed in the main log
36348 as soon as the message is received. The list appears at the end of the log line
36349 that is written when a message is received, preceded by the word &"for"&. The
36350 addresses are listed after they have been qualified, but before any rewriting
36351 has taken place.
36352 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
36353 in the list.
36354 .next
36355 .cindex "log" "sender reception"
36356 &%received_sender%&: The unrewritten original sender of a message is added to
36357 the end of the log line that records the message's arrival, after the word
36358 &"from"& (before the recipients if &%received_recipients%& is also set).
36359 .next
36360 .cindex "log" "header lines for rejection"
36361 &%rejected_header%&: If a message's header has been received at the time a
36362 rejection is written to the reject log, the complete header is added to the
36363 log. Header logging can be turned off individually for messages that are
36364 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
36365 .next
36366 .cindex "log" "retry defer"
36367 &%retry_defer%&: A log line is written if a delivery is deferred because a
36368 retry time has not yet been reached. However, this &"retry time not reached"&
36369 message is always omitted from individual message logs after the first delivery
36370 attempt.
36371 .next
36372 .cindex "log" "return path"
36373 &%return_path_on_delivery%&: The return path that is being transmitted with
36374 the message is included in delivery and bounce lines, using the tag P=.
36375 This is omitted if no delivery actually happens, for example, if routing fails,
36376 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36377 .next
36378 .cindex "log" "sender on delivery"
36379 &%sender_on_delivery%&: The message's sender address is added to every delivery
36380 and bounce line, tagged by F= (for &"from"&).
36381 This is the original sender that was received with the message; it is not
36382 necessarily the same as the outgoing return path.
36383 .next
36384 .cindex "log" "sender verify failure"
36385 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36386 gives details of a sender verification failure is not written. Log lines for
36387 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36388 detail is lost.
36389 .next
36390 .cindex "log" "size rejection"
36391 &%size_reject%&: A log line is written whenever a message is rejected because
36392 it is too big.
36393 .next
36394 .cindex "log" "frozen messages; skipped"
36395 .cindex "frozen messages" "logging skipping"
36396 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36397 queue run because it is frozen or because another process is already delivering
36398 it.
36399 .cindex "&""spool file is locked""&"
36400 The message that is written is &"spool file is locked"&.
36401 .next
36402 .cindex "log" "smtp confirmation"
36403 .cindex "SMTP" "logging confirmation"
36404 .cindex "LMTP" "logging confirmation"
36405 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36406 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36407 A number of MTAs (including Exim) return an identifying string in this
36408 response.
36409 .next
36410 .cindex "log" "SMTP connections"
36411 .cindex "SMTP" "logging connections"
36412 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36413 established or closed, unless the connection is from a host that matches
36414 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36415 only when the closure is unexpected.) This applies to connections from local
36416 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36417 dropped in the middle of a message, a log line is always written, whether or
36418 not this selector is set, but otherwise nothing is written at the start and end
36419 of connections unless this selector is enabled.
36420
36421 For TCP/IP connections to an Exim daemon, the current number of connections is
36422 included in the log message for each new connection, but note that the count is
36423 reset if the daemon is restarted.
36424 Also, because connections are closed (and the closure is logged) in
36425 subprocesses, the count may not include connections that have been closed but
36426 whose termination the daemon has not yet noticed. Thus, while it is possible to
36427 match up the opening and closing of connections in the log, the value of the
36428 logged counts may not be entirely accurate.
36429 .next
36430 .cindex "log" "SMTP transaction; incomplete"
36431 .cindex "SMTP" "logging incomplete transactions"
36432 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36433 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36434 and the message sender plus any accepted recipients are included in the log
36435 line. This can provide evidence of dictionary attacks.
36436 .next
36437 .cindex "log" "non-MAIL SMTP sessions"
36438 .cindex "MAIL" "logging session without"
36439 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36440 connection terminates without having issued a MAIL command. This includes both
36441 the case when the connection is dropped, and the case when QUIT is used. It
36442 does not include cases where the connection is rejected right at the start (by
36443 an ACL, or because there are too many connections, or whatever). These cases
36444 already have their own log lines.
36445
36446 The log line that is written contains the identity of the client in the usual
36447 way, followed by D= and a time, which records the duration of the connection.
36448 If the connection was authenticated, this fact is logged exactly as it is for
36449 an incoming message, with an A= item. If the connection was encrypted, CV=,
36450 DN=, and X= items may appear as they do for an incoming message, controlled by
36451 the same logging options.
36452
36453 Finally, if any SMTP commands were issued during the connection, a C= item
36454 is added to the line, listing the commands that were used. For example,
36455 .code
36456 C=EHLO,QUIT
36457 .endd
36458 shows that the client issued QUIT straight after EHLO. If there were fewer
36459 than 20 commands, they are all listed. If there were more than 20 commands,
36460 the last 20 are listed, preceded by &"..."&. However, with the default
36461 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36462 have been aborted before 20 non-mail commands are processed.
36463 .next
36464 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36465 colon-separated, is appended to the A= item for a message arrival or delivery
36466 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36467 was accepted or used.
36468 .next
36469 .cindex "log" "SMTP protocol error"
36470 .cindex "SMTP" "logging protocol error"
36471 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36472 encountered. Exim does not have perfect detection of all protocol errors
36473 because of transmission delays and the use of pipelining. If PIPELINING has
36474 been advertised to a client, an Exim server assumes that the client will use
36475 it, and therefore it does not count &"expected"& errors (for example, RCPT
36476 received after rejecting MAIL) as protocol errors.
36477 .next
36478 .cindex "SMTP" "logging syntax errors"
36479 .cindex "SMTP" "syntax errors; logging"
36480 .cindex "SMTP" "unknown command; logging"
36481 .cindex "log" "unknown SMTP command"
36482 .cindex "log" "SMTP syntax error"
36483 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36484 encountered. An unrecognized command is treated as a syntax error. For an
36485 external connection, the host identity is given; for an internal connection
36486 using &%-bs%& the sender identification (normally the calling user) is given.
36487 .next
36488 .cindex "log" "subject"
36489 .cindex "subject, logging"
36490 &%subject%&: The subject of the message is added to the arrival log line,
36491 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36492 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36493 specifies whether characters with values greater than 127 should be logged
36494 unchanged, or whether they should be rendered as escape sequences.
36495 .next
36496 .cindex "log" "certificate verification"
36497 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36498 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36499 verified, and &`CV=no`& if not.
36500 .next
36501 .cindex "log" "TLS cipher"
36502 .cindex "TLS" "logging cipher"
36503 &%tls_cipher%&: When a message is sent or received over an encrypted
36504 connection, the cipher suite used is added to the log line, preceded by X=.
36505 .next
36506 .cindex "log" "TLS peer DN"
36507 .cindex "TLS" "logging peer DN"
36508 &%tls_peerdn%&: When a message is sent or received over an encrypted
36509 connection, and a certificate is supplied by the remote host, the peer DN is
36510 added to the log line, preceded by DN=.
36511 .next
36512 .cindex "log" "TLS SNI"
36513 .cindex "TLS" "logging SNI"
36514 &%tls_sni%&: When a message is received over an encrypted connection, and
36515 the remote host provided the Server Name Indication extension, the SNI is
36516 added to the log line, preceded by SNI=.
36517 .next
36518 .cindex "log" "DNS failure in list"
36519 &%unknown_in_list%&: This setting causes a log entry to be written when the
36520 result of a list match is failure because a DNS lookup failed.
36521 .endlist
36522
36523
36524 .section "Message log" "SECID260"
36525 .cindex "message" "log file for"
36526 .cindex "log" "message log; description of"
36527 .cindex "&_msglog_& directory"
36528 .oindex "&%preserve_message_logs%&"
36529 In addition to the general log files, Exim writes a log file for each message
36530 that it handles. The names of these per-message logs are the message ids, and
36531 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36532 message log contains copies of the log lines that apply to the message. This
36533 makes it easier to inspect the status of an individual message without having
36534 to search the main log. A message log is deleted when processing of the message
36535 is complete, unless &%preserve_message_logs%& is set, but this should be used
36536 only with great care because they can fill up your disk very quickly.
36537
36538 On a heavily loaded system, it may be desirable to disable the use of
36539 per-message logs, in order to reduce disk I/O. This can be done by setting the
36540 &%message_logs%& option false.
36541 .ecindex IIDloggen
36542
36543
36544
36545
36546 . ////////////////////////////////////////////////////////////////////////////
36547 . ////////////////////////////////////////////////////////////////////////////
36548
36549 .chapter "Exim utilities" "CHAPutils"
36550 .scindex IIDutils "utilities"
36551 A number of utility scripts and programs are supplied with Exim and are
36552 described in this chapter. There is also the Exim Monitor, which is covered in
36553 the next chapter. The utilities described here are:
36554
36555 .itable none 0 0 3  7* left  15* left  40* left
36556 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36557   "list what Exim processes are doing"
36558 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36559 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36560 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36561 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36562                                                 various criteria"
36563 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36564 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36565   "extract statistics from the log"
36566 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36567   "check address acceptance from given IP"
36568 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36569 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36570 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36571 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36572 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36573 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36574 .endtable
36575
36576 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36577 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36578 &url(http://duncanthrax.net/exilog/) for details.
36579
36580
36581
36582
36583 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36584 .cindex "&'exiwhat'&"
36585 .cindex "process, querying"
36586 .cindex "SIGUSR1"
36587 On operating systems that can restart a system call after receiving a signal
36588 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36589 a line describing what it is doing to the file &_exim-process.info_& in the
36590 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36591 processes it can find, having first emptied the file. It then waits for one
36592 second to allow the Exim processes to react before displaying the results. In
36593 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36594 send the signal to the Exim processes, so it is normally run as root.
36595
36596 &*Warning*&: This is not an efficient process. It is intended for occasional
36597 use by system administrators. It is not sensible, for example, to set up a
36598 script that sends SIGUSR1 signals to Exim processes at short intervals.
36599
36600
36601 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36602 varies in different operating systems. Not only are different options used,
36603 but the format of the output is different. For this reason, there are some
36604 system configuration options that configure exactly how &'exiwhat'& works. If
36605 it doesn't seem to be working for you, check the following compile-time
36606 options:
36607 .display
36608 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36609 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36610 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36611 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36612 .endd
36613 An example of typical output from &'exiwhat'& is
36614 .code
36615 164 daemon: -q1h, listening on port 25
36616 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36617 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36618   [10.19.42.42] (editor@ref.example)
36619 10592 handling incoming call from [192.168.243.242]
36620 10628 accepting a local non-SMTP message
36621 .endd
36622 The first number in the output line is the process number. The third line has
36623 been split here, in order to fit it on the page.
36624
36625
36626
36627 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36628 .cindex "&'exiqgrep'&"
36629 .cindex "queue" "grepping"
36630 This utility is a Perl script contributed by Matt Hubbard. It runs
36631 .code
36632 exim -bpu
36633 .endd
36634 or (in case &*-a*& switch is specified)
36635 .code
36636 exim -bp
36637 .endd
36638 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36639 contain alternate exim configuration the queue management might be using.
36640
36641 to obtain a queue listing, and then greps the output to select messages
36642 that match given criteria. The following selection options are available:
36643
36644 .vlist
36645 .vitem &*-f*&&~<&'regex'&>
36646 Match the sender address using a case-insensitive search. The field that is
36647 tested is enclosed in angle brackets, so you can test for bounce messages with
36648 .code
36649 exiqgrep -f '^<>$'
36650 .endd
36651 .vitem &*-r*&&~<&'regex'&>
36652 Match a recipient address using a case-insensitive search. The field that is
36653 tested is not enclosed in angle brackets.
36654
36655 .vitem &*-s*&&~<&'regex'&>
36656 Match against the size field.
36657
36658 .vitem &*-y*&&~<&'seconds'&>
36659 Match messages that are younger than the given time.
36660
36661 .vitem &*-o*&&~<&'seconds'&>
36662 Match messages that are older than the given time.
36663
36664 .vitem &*-z*&
36665 Match only frozen messages.
36666
36667 .vitem &*-x*&
36668 Match only non-frozen messages.
36669 .endlist
36670
36671 The following options control the format of the output:
36672
36673 .vlist
36674 .vitem &*-c*&
36675 Display only the count of matching messages.
36676
36677 .vitem &*-l*&
36678 Long format &-- display the full message information as output by Exim. This is
36679 the default.
36680
36681 .vitem &*-i*&
36682 Display message ids only.
36683
36684 .vitem &*-b*&
36685 Brief format &-- one line per message.
36686
36687 .vitem &*-R*&
36688 Display messages in reverse order.
36689
36690 .vitem &*-a*&
36691 Include delivered recipients in queue listing.
36692 .endlist
36693
36694 There is one more option, &%-h%&, which outputs a list of options.
36695
36696
36697
36698 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36699 .cindex "&'exiqsumm'&"
36700 .cindex "queue" "summary"
36701 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36702 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36703 running a command such as
36704 .code
36705 exim -bp | exiqsumm
36706 .endd
36707 The output consists of one line for each domain that has messages waiting for
36708 it, as in the following example:
36709 .code
36710 3   2322   74m   66m  msn.com.example
36711 .endd
36712 Each line lists the number of pending deliveries for a domain, their total
36713 volume, and the length of time that the oldest and the newest messages have
36714 been waiting. Note that the number of pending deliveries is greater than the
36715 number of messages when messages have more than one recipient.
36716
36717 A summary line is output at the end. By default the output is sorted on the
36718 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36719 the output to be sorted by oldest message and by count of messages,
36720 respectively. There are also three options that split the messages for each
36721 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36722 separates frozen messages, and &%-s%& separates messages according to their
36723 sender.
36724
36725 The output of &'exim -bp'& contains the original addresses in the message, so
36726 this also applies to the output from &'exiqsumm'&. No domains from addresses
36727 generated by aliasing or forwarding are included (unless the &%one_time%&
36728 option of the &(redirect)& router has been used to convert them into &"top
36729 level"& addresses).
36730
36731
36732
36733
36734 .section "Extracting specific information from the log (exigrep)" &&&
36735          "SECTextspeinf"
36736 .cindex "&'exigrep'&"
36737 .cindex "log" "extracts; grepping for"
36738 The &'exigrep'& utility is a Perl script that searches one or more main log
36739 files for entries that match a given pattern. When it finds a match, it
36740 extracts all the log entries for the relevant message, not just those that
36741 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36742 given message, or all mail for a given user, or for a given host, for example.
36743 The input files can be in Exim log format or syslog format.
36744 If a matching log line is not associated with a specific message, it is
36745 included in &'exigrep'&'s output without any additional lines. The usage is:
36746 .display
36747 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36748 .endd
36749 If no log file names are given on the command line, the standard input is read.
36750
36751 The &%-t%& argument specifies a number of seconds. It adds an additional
36752 condition for message selection. Messages that are complete are shown only if
36753 they spent more than <&'n'&> seconds on the queue.
36754
36755 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36756 makes it case-sensitive. This may give a performance improvement when searching
36757 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36758 option; with &%-I%& they do not. In both cases it is possible to change the
36759 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36760
36761 The &%-l%& option means &"literal"&, that is, treat all characters in the
36762 pattern as standing for themselves. Otherwise the pattern must be a Perl
36763 regular expression.
36764
36765 The &%-v%& option inverts the matching condition. That is, a line is selected
36766 if it does &'not'& match the pattern.
36767
36768 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36769 that are generated as a result/response to a message that &'exigrep'& matched
36770 normally.
36771
36772 Example of &%-M%&:
36773 user_a sends a message to user_b, which generates a bounce back to user_b. If
36774 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36775 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36776 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36777 when searching for &"user_a"& will show both messages since the bounce is
36778 &"related"& to or a &"result"& of the first message that was found by the
36779 search term.
36780
36781 If the location of a &'zcat'& command is known from the definition of
36782 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36783 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36784 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36785 autodetection of some well known compression extensions.
36786
36787
36788 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36789 .cindex "&'exipick'&"
36790 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36791 lists messages from the queue according to a variety of criteria. For details
36792 of &'exipick'&'s facilities, run &'exipick'& with
36793 the &%--help%& option.
36794
36795
36796 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36797 .cindex "log" "cycling local files"
36798 .cindex "cycling logs"
36799 .cindex "&'exicyclog'&"
36800 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36801 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36802 you are using log files with datestamps in their names (see section
36803 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36804 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36805 There are two command line options for &'exicyclog'&:
36806 .ilist
36807 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36808 default that is set when Exim is built. The default default is 10.
36809 .next
36810 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36811 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36812 overriding the script's default, which is to find the setting from Exim's
36813 configuration.
36814 .endlist
36815
36816 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36817 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36818 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36819 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36820 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36821 logs are handled similarly.
36822
36823 If the limit is greater than 99, the script uses 3-digit numbers such as
36824 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36825 to one that is greater, or &'vice versa'&, you will have to fix the names of
36826 any existing log files.
36827
36828 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36829 the end are deleted. All files with numbers greater than 01 are compressed,
36830 using a compression command which is configured by the COMPRESS_COMMAND
36831 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36832 root &%crontab%& entry of the form
36833 .code
36834 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36835 .endd
36836 assuming you have used the name &"exim"& for the Exim user. You can run
36837 &'exicyclog'& as root if you wish, but there is no need.
36838
36839
36840
36841 .section "Mail statistics (eximstats)" "SECTmailstat"
36842 .cindex "statistics"
36843 .cindex "&'eximstats'&"
36844 A Perl script called &'eximstats'& is provided for extracting statistical
36845 information from log files. The output is either plain text, or HTML.
36846 Exim log files are also supported by the &'Lire'& system produced by the
36847 LogReport Foundation &url(http://www.logreport.org).
36848
36849 The &'eximstats'& script has been hacked about quite a bit over time. The
36850 latest version is the result of some extensive revision by Steve Campbell. A
36851 lot of information is given by default, but there are options for suppressing
36852 various parts of it. Following any options, the arguments to the script are a
36853 list of files, which should be main log files. For example:
36854 .code
36855 eximstats -nr /var/spool/exim/log/mainlog.01
36856 .endd
36857 By default, &'eximstats'& extracts information about the number and volume of
36858 messages received from or delivered to various hosts. The information is sorted
36859 both by message count and by volume, and the top fifty hosts in each category
36860 are listed on the standard output. Similar information, based on email
36861 addresses or domains instead of hosts can be requested by means of various
36862 options. For messages delivered and received locally, similar statistics are
36863 also produced per user.
36864
36865 The output also includes total counts and statistics about delivery errors, and
36866 histograms showing the number of messages received and deliveries made in each
36867 hour of the day. A delivery with more than one address in its envelope (for
36868 example, an SMTP transaction with more than one RCPT command) is counted
36869 as a single delivery by &'eximstats'&.
36870
36871 Though normally more deliveries than receipts are reported (as messages may
36872 have multiple recipients), it is possible for &'eximstats'& to report more
36873 messages received than delivered, even though the queue is empty at the start
36874 and end of the period in question. If an incoming message contains no valid
36875 recipients, no deliveries are recorded for it. A bounce message is handled as
36876 an entirely separate message.
36877
36878 &'eximstats'& always outputs a grand total summary giving the volume and number
36879 of messages received and deliveries made, and the number of hosts involved in
36880 each case. It also outputs the number of messages that were delayed (that is,
36881 not completely delivered at the first attempt), and the number that had at
36882 least one address that failed.
36883
36884 The remainder of the output is in sections that can be independently disabled
36885 or modified by various options. It consists of a summary of deliveries by
36886 transport, histograms of messages received and delivered per time interval
36887 (default per hour), information about the time messages spent on the queue,
36888 a list of relayed messages, lists of the top fifty sending hosts, local
36889 senders, destination hosts, and destination local users by count and by volume,
36890 and a list of delivery errors that occurred.
36891
36892 The relay information lists messages that were actually relayed, that is, they
36893 came from a remote host and were directly delivered to some other remote host,
36894 without being processed (for example, for aliasing or forwarding) locally.
36895
36896 There are quite a few options for &'eximstats'& to control exactly what it
36897 outputs. These are documented in the Perl script itself, and can be extracted
36898 by running the command &(perldoc)& on the script. For example:
36899 .code
36900 perldoc /usr/exim/bin/eximstats
36901 .endd
36902
36903 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36904 .cindex "&'exim_checkaccess'&"
36905 .cindex "policy control" "checking access"
36906 .cindex "checking access"
36907 The &%-bh%& command line argument allows you to run a fake SMTP session with
36908 debugging output, in order to check what Exim is doing when it is applying
36909 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36910 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36911 sometimes you just want to answer the question &"Does this address have
36912 access?"& without bothering with any further details.
36913
36914 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36915 two arguments, an IP address and an email address:
36916 .code
36917 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36918 .endd
36919 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36920 given email address would be accepted in a RCPT command in a TCP/IP
36921 connection from the host with the given IP address. The output of the utility
36922 is either the word &"accepted"&, or the SMTP error response, for example:
36923 .code
36924 Rejected:
36925 550 Relay not permitted
36926 .endd
36927 When running this test, the utility uses &`<>`& as the envelope sender address
36928 for the MAIL command, but you can change this by providing additional
36929 options. These are passed directly to the Exim command. For example, to specify
36930 that the test is to be run with the sender address &'himself@there.example'&
36931 you can use:
36932 .code
36933 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36934                  -f himself@there.example
36935 .endd
36936 Note that these additional Exim command line items must be given after the two
36937 mandatory arguments.
36938
36939 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36940 while running its checks. You can run checks that include callouts by using
36941 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36942
36943
36944
36945 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36946 .cindex "DBM" "building dbm files"
36947 .cindex "building DBM files"
36948 .cindex "&'exim_dbmbuild'&"
36949 .cindex "lower casing"
36950 .cindex "binary zero" "in lookup key"
36951 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36952 the format used by the &(lsearch)& lookup (see section
36953 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36954 names as keys and the remainder of the information as data. The lower-casing
36955 can be prevented by calling the program with the &%-nolc%& option.
36956
36957 A terminating zero is included as part of the key string. This is expected by
36958 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36959 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36960 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36961 files.
36962
36963 The program requires two arguments: the name of the input file (which can be a
36964 single hyphen to indicate the standard input), and the name of the output file.
36965 It creates the output under a temporary name, and then renames it if all went
36966 well.
36967
36968 .cindex "USE_DB"
36969 If the native DB interface is in use (USE_DB is set in a compile-time
36970 configuration file &-- this is common in free versions of Unix) the two file
36971 names must be different, because in this mode the Berkeley DB functions create
36972 a single output file using exactly the name given. For example,
36973 .code
36974 exim_dbmbuild /etc/aliases /etc/aliases.db
36975 .endd
36976 reads the system alias file and creates a DBM version of it in
36977 &_/etc/aliases.db_&.
36978
36979 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36980 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36981 environment, the suffixes are added to the second argument of
36982 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36983 when the Berkeley functions are used in compatibility mode (though this is not
36984 recommended), because in that case it adds a &_.db_& suffix to the file name.
36985
36986 If a duplicate key is encountered, the program outputs a warning, and when it
36987 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36988 option is used. By default, only the first of a set of duplicates is used &--
36989 this makes it compatible with &(lsearch)& lookups. There is an option
36990 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36991 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36992 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36993 return code is 2.
36994
36995
36996
36997
36998 .section "Finding individual retry times (exinext)" "SECTfinindret"
36999 .cindex "retry" "times"
37000 .cindex "&'exinext'&"
37001 A utility called &'exinext'& (mostly a Perl script) provides the ability to
37002 fish specific information out of the retry database. Given a mail domain (or a
37003 complete address), it looks up the hosts for that domain, and outputs any retry
37004 information for the hosts or for the domain. At present, the retry information
37005 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
37006 output. For example:
37007 .code
37008 $ exinext piglet@milne.fict.example
37009 kanga.milne.example:192.168.8.1 error 146: Connection refused
37010   first failed: 21-Feb-1996 14:57:34
37011   last tried:   21-Feb-1996 14:57:34
37012   next try at:  21-Feb-1996 15:02:34
37013 roo.milne.example:192.168.8.3 error 146: Connection refused
37014   first failed: 20-Jan-1996 13:12:08
37015   last tried:   21-Feb-1996 11:42:03
37016   next try at:  21-Feb-1996 19:42:03
37017   past final cutoff time
37018 .endd
37019 You can also give &'exinext'& a local part, without a domain, and it
37020 will give any retry information for that local part in your default domain.
37021 A message id can be used to obtain retry information pertaining to a specific
37022 message. This exists only when an attempt to deliver a message to a remote host
37023 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
37024 &'exinext'& is not particularly efficient, but then it is not expected to be
37025 run very often.
37026
37027 The &'exinext'& utility calls Exim to find out information such as the location
37028 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
37029 passed on to the &'exim'& commands. The first specifies an alternate Exim
37030 configuration file, and the second sets macros for use within the configuration
37031 file. These features are mainly to help in testing, but might also be useful in
37032 environments where more than one configuration file is in use.
37033
37034
37035
37036 .section "Hints database maintenance" "SECThindatmai"
37037 .cindex "hints database" "maintenance"
37038 .cindex "maintaining Exim's hints database"
37039 Three utility programs are provided for maintaining the DBM files that Exim
37040 uses to contain its delivery hint information. Each program requires two
37041 arguments. The first specifies the name of Exim's spool directory, and the
37042 second is the name of the database it is to operate on. These are as follows:
37043
37044 .ilist
37045 &'retry'&: the database of retry information
37046 .next
37047 &'wait-'&<&'transport name'&>: databases of information about messages waiting
37048 for remote hosts
37049 .next
37050 &'callout'&: the callout cache
37051 .next
37052 &'ratelimit'&: the data for implementing the ratelimit ACL condition
37053 .next
37054 &'misc'&: other hints data
37055 .endlist
37056
37057 The &'misc'& database is used for
37058
37059 .ilist
37060 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
37061 .next
37062 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
37063 &(smtp)& transport)
37064 .next
37065 Limiting the concurrency of specific transports (when &%max_parallel%& is set
37066 in a transport)
37067 .endlist
37068
37069
37070
37071 .section "exim_dumpdb" "SECID261"
37072 .cindex "&'exim_dumpdb'&"
37073 The entire contents of a database are written to the standard output by the
37074 &'exim_dumpdb'& program, which has no options or arguments other than the
37075 spool and database names. For example, to dump the retry database:
37076 .code
37077 exim_dumpdb /var/spool/exim retry
37078 .endd
37079 Two lines of output are produced for each entry:
37080 .code
37081 T:mail.ref.example:192.168.242.242 146 77 Connection refused
37082 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
37083 .endd
37084 The first item on the first line is the key of the record. It starts with one
37085 of the letters R, or T, depending on whether it refers to a routing or
37086 transport retry. For a local delivery, the next part is the local address; for
37087 a remote delivery it is the name of the remote host, followed by its failing IP
37088 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
37089 transport). If the remote port is not the standard one (port 25), it is added
37090 to the IP address. Then there follows an error code, an additional error code,
37091 and a textual description of the error.
37092
37093 The three times on the second line are the time of first failure, the time of
37094 the last delivery attempt, and the computed time for the next attempt. The line
37095 ends with an asterisk if the cutoff time for the last retry rule has been
37096 exceeded.
37097
37098 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
37099 consists of a host name followed by a list of ids for messages that are or were
37100 waiting to be delivered to that host. If there are a very large number for any
37101 one host, continuation records, with a sequence number added to the host name,
37102 may be seen. The data in these records is often out of date, because a message
37103 may be routed to several alternative hosts, and Exim makes no effort to keep
37104 cross-references.
37105
37106
37107
37108 .section "exim_tidydb" "SECID262"
37109 .cindex "&'exim_tidydb'&"
37110 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
37111 database. If run with no options, it removes all records that are more than 30
37112 days old. The age is calculated from the date and time that the record was last
37113 updated. Note that, in the case of the retry database, it is &'not'& the time
37114 since the first delivery failure. Information about a host that has been down
37115 for more than 30 days will remain in the database, provided that the record is
37116 updated sufficiently often.
37117
37118 The cutoff date can be altered by means of the &%-t%& option, which must be
37119 followed by a time. For example, to remove all records older than a week from
37120 the retry database:
37121 .code
37122 exim_tidydb -t 7d /var/spool/exim retry
37123 .endd
37124 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
37125 message ids. In the former these appear as data in records keyed by host &--
37126 they were messages that were waiting for that host &-- and in the latter they
37127 are the keys for retry information for messages that have suffered certain
37128 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
37129 message ids in database records are those of messages that are still on the
37130 queue. Message ids for messages that no longer exist are removed from
37131 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
37132 For the &'retry'& database, records whose keys are non-existent message ids are
37133 removed. The &'exim_tidydb'& utility outputs comments on the standard output
37134 whenever it removes information from the database.
37135
37136 Certain records are automatically removed by Exim when they are no longer
37137 needed, but others are not. For example, if all the MX hosts for a domain are
37138 down, a retry record is created for each one. If the primary MX host comes back
37139 first, its record is removed when Exim successfully delivers to it, but the
37140 records for the others remain because Exim has not tried to use those hosts.
37141
37142 It is important, therefore, to run &'exim_tidydb'& periodically on all the
37143 hints databases. You should do this at a quiet time of day, because it requires
37144 a database to be locked (and therefore inaccessible to Exim) while it does its
37145 work. Removing records from a DBM file does not normally make the file smaller,
37146 but all the common DBM libraries are able to re-use the space that is released.
37147 After an initial phase of increasing in size, the databases normally reach a
37148 point at which they no longer get any bigger, as long as they are regularly
37149 tidied.
37150
37151 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
37152 databases is likely to keep on increasing.
37153
37154
37155
37156
37157 .section "exim_fixdb" "SECID263"
37158 .cindex "&'exim_fixdb'&"
37159 The &'exim_fixdb'& program is a utility for interactively modifying databases.
37160 Its main use is for testing Exim, but it might also be occasionally useful for
37161 getting round problems in a live system. It has no options, and its interface
37162 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
37163 key of a database record can then be entered, and the data for that record is
37164 displayed.
37165
37166 If &"d"& is typed at the next prompt, the entire record is deleted. For all
37167 except the &'retry'& database, that is the only operation that can be carried
37168 out. For the &'retry'& database, each field is output preceded by a number, and
37169 data for individual fields can be changed by typing the field number followed
37170 by new data, for example:
37171 .code
37172 > 4 951102:1000
37173 .endd
37174 resets the time of the next delivery attempt. Time values are given as a
37175 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
37176 used as optional separators.
37177
37178
37179
37180
37181 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
37182 .cindex "mailbox" "maintenance"
37183 .cindex "&'exim_lock'&"
37184 .cindex "locking mailboxes"
37185 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
37186 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
37187 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
37188 a user agent while investigating a problem. The utility requires the name of
37189 the file as its first argument. If the locking is successful, the second
37190 argument is run as a command (using C's &[system()]& function); if there is no
37191 second argument, the value of the SHELL environment variable is used; if this
37192 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
37193 is unlocked and the utility ends. The following options are available:
37194
37195 .vlist
37196 .vitem &%-fcntl%&
37197 Use &[fcntl()]& locking on the open mailbox.
37198
37199 .vitem &%-flock%&
37200 Use &[flock()]& locking on the open mailbox, provided the operating system
37201 supports it.
37202
37203 .vitem &%-interval%&
37204 This must be followed by a number, which is a number of seconds; it sets the
37205 interval to sleep between retries (default 3).
37206
37207 .vitem &%-lockfile%&
37208 Create a lock file before opening the mailbox.
37209
37210 .vitem &%-mbx%&
37211 Lock the mailbox using MBX rules.
37212
37213 .vitem &%-q%&
37214 Suppress verification output.
37215
37216 .vitem &%-retries%&
37217 This must be followed by a number; it sets the number of times to try to get
37218 the lock (default 10).
37219
37220 .vitem &%-restore_time%&
37221 This option causes &%exim_lock%& to restore the modified and read times to the
37222 locked file before exiting. This allows you to access a locked mailbox (for
37223 example, to take a backup copy) without disturbing the times that the user
37224 subsequently sees.
37225
37226 .vitem &%-timeout%&
37227 This must be followed by a number, which is a number of seconds; it sets a
37228 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
37229 default), a non-blocking call is used.
37230
37231 .vitem &%-v%&
37232 Generate verbose output.
37233 .endlist
37234
37235 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
37236 default is to create a lock file and also to use &[fcntl()]& locking on the
37237 mailbox, which is the same as Exim's default. The use of &%-flock%& or
37238 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
37239 requires that the directory containing the file be writeable. Locking by lock
37240 file does not last for ever; Exim assumes that a lock file is expired if it is
37241 more than 30 minutes old.
37242
37243 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
37244 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
37245 to be taken out on the open mailbox, and an exclusive lock on the file
37246 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
37247 number of the mailbox file. When the locking is released, if an exclusive lock
37248 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
37249
37250 The default output contains verification of the locking that takes place. The
37251 &%-v%& option causes some additional information to be given. The &%-q%& option
37252 suppresses all output except error messages.
37253
37254 A command such as
37255 .code
37256 exim_lock /var/spool/mail/spqr
37257 .endd
37258 runs an interactive shell while the file is locked, whereas
37259 .display
37260 &`exim_lock -q /var/spool/mail/spqr <<End`&
37261 <&'some commands'&>
37262 &`End`&
37263 .endd
37264 runs a specific non-interactive sequence of commands while the file is locked,
37265 suppressing all verification output. A single command can be run by a command
37266 such as
37267 .code
37268 exim_lock -q /var/spool/mail/spqr \
37269   "cp /var/spool/mail/spqr /some/where"
37270 .endd
37271 Note that if a command is supplied, it must be entirely contained within the
37272 second argument &-- hence the quotes.
37273 .ecindex IIDutils
37274
37275
37276 . ////////////////////////////////////////////////////////////////////////////
37277 . ////////////////////////////////////////////////////////////////////////////
37278
37279 .chapter "The Exim monitor" "CHAPeximon"
37280 .scindex IIDeximon "Exim monitor" "description"
37281 .cindex "X-windows"
37282 .cindex "&'eximon'&"
37283 .cindex "Local/eximon.conf"
37284 .cindex "&_exim_monitor/EDITME_&"
37285 The Exim monitor is an application which displays in an X window information
37286 about the state of Exim's queue and what Exim is doing. An admin user can
37287 perform certain operations on messages from this GUI interface; however all
37288 such facilities are also available from the command line, and indeed, the
37289 monitor itself makes use of the command line to perform any actions requested.
37290
37291
37292
37293 .section "Running the monitor" "SECID264"
37294 The monitor is started by running the script called &'eximon'&. This is a shell
37295 script that sets up a number of environment variables, and then runs the
37296 binary called &_eximon.bin_&. The default appearance of the monitor window can
37297 be changed by editing the &_Local/eximon.conf_& file created by editing
37298 &_exim_monitor/EDITME_&. Comments in that file describe what the various
37299 parameters are for.
37300
37301 The parameters that get built into the &'eximon'& script can be overridden for
37302 a particular invocation by setting up environment variables of the same names,
37303 preceded by &`EXIMON_`&. For example, a shell command such as
37304 .code
37305 EXIMON_LOG_DEPTH=400 eximon
37306 .endd
37307 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
37308 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
37309 overrides the Exim log file configuration. This makes it possible to have
37310 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
37311 syslog messages are routed to a file on the local host.
37312
37313 X resources can be used to change the appearance of the window in the normal
37314 way. For example, a resource setting of the form
37315 .code
37316 Eximon*background: gray94
37317 .endd
37318 changes the colour of the background to light grey rather than white. The
37319 stripcharts are drawn with both the data lines and the reference lines in
37320 black. This means that the reference lines are not visible when on top of the
37321 data. However, their colour can be changed by setting a resource called
37322 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
37323 For example, if your X server is running Unix, you could set up lighter
37324 reference lines in the stripcharts by obeying
37325 .code
37326 xrdb -merge <<End
37327 Eximon*highlight: gray
37328 End
37329 .endd
37330 .cindex "admin user"
37331 In order to see the contents of messages on the queue, and to operate on them,
37332 &'eximon'& must either be run as root or by an admin user.
37333
37334 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
37335 contain X11 resource parameters interpreted by the X11 library.  In addition,
37336 if the first parameter starts with the string "gdb" then it is removed and the
37337 binary is invoked under gdb (the parameter is used as the gdb command-name, so
37338 versioned variants of gdb can be invoked).
37339
37340 The monitor's window is divided into three parts. The first contains one or
37341 more stripcharts and two action buttons, the second contains a &"tail"& of the
37342 main log file, and the third is a display of the queue of messages awaiting
37343 delivery, with two more action buttons. The following sections describe these
37344 different parts of the display.
37345
37346
37347
37348
37349 .section "The stripcharts" "SECID265"
37350 .cindex "stripchart"
37351 The first stripchart is always a count of messages on the queue. Its name can
37352 be configured by setting QUEUE_STRIPCHART_NAME in the
37353 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
37354 configuration script by regular expression matches on log file entries, making
37355 it possible to display, for example, counts of messages delivered to certain
37356 hosts or using certain transports. The supplied defaults display counts of
37357 received and delivered messages, and of local and SMTP deliveries. The default
37358 period between stripchart updates is one minute; this can be adjusted by a
37359 parameter in the &_Local/eximon.conf_& file.
37360
37361 The stripchart displays rescale themselves automatically as the value they are
37362 displaying changes. There are always 10 horizontal lines in each chart; the
37363 title string indicates the value of each division when it is greater than one.
37364 For example, &"x2"& means that each division represents a value of 2.
37365
37366 It is also possible to have a stripchart which shows the percentage fullness of
37367 a particular disk partition, which is useful when local deliveries are confined
37368 to a single partition.
37369
37370 .cindex "&%statvfs%& function"
37371 This relies on the availability of the &[statvfs()]& function or equivalent in
37372 the operating system. Most, but not all versions of Unix that support Exim have
37373 this. For this particular stripchart, the top of the chart always represents
37374 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37375 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37376 &_Local/eximon.conf_& file.
37377
37378
37379
37380
37381 .section "Main action buttons" "SECID266"
37382 .cindex "size" "of monitor window"
37383 .cindex "Exim monitor" "window size"
37384 .cindex "window size"
37385 Below the stripcharts there is an action button for quitting the monitor. Next
37386 to this is another button marked &"Size"&. They are placed here so that
37387 shrinking the window to its default minimum size leaves just the queue count
37388 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37389 the window to expand to its maximum size, unless it is already at the maximum,
37390 in which case it is reduced to its minimum.
37391
37392 When expanding to the maximum, if the window cannot be fully seen where it
37393 currently is, it is moved back to where it was the last time it was at full
37394 size. When it is expanding from its minimum size, the old position is
37395 remembered, and next time it is reduced to the minimum it is moved back there.
37396
37397 The idea is that you can keep a reduced window just showing one or two
37398 stripcharts at a convenient place on your screen, easily expand it to show
37399 the full window when required, and just as easily put it back to what it was.
37400 The idea is copied from what the &'twm'& window manager does for its
37401 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37402 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37403
37404 Normally, the monitor starts up with the window at its full size, but it can be
37405 built so that it starts up with the window at its smallest size, by setting
37406 START_SMALL=yes in &_Local/eximon.conf_&.
37407
37408
37409
37410 .section "The log display" "SECID267"
37411 .cindex "log" "tail of; in monitor"
37412 The second section of the window is an area in which a display of the tail of
37413 the main log is maintained.
37414 To save space on the screen, the timestamp on each log line is shortened by
37415 removing the date and, if &%log_timezone%& is set, the timezone.
37416 The log tail is not available when the only destination for logging data is
37417 syslog, unless the syslog lines are routed to a local file whose name is passed
37418 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37419
37420 The log sub-window has a scroll bar at its lefthand side which can be used to
37421 move back to look at earlier text, and the up and down arrow keys also have a
37422 scrolling effect. The amount of log that is kept depends on the setting of
37423 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37424 to use. When this is full, the earlier 50% of data is discarded &-- this is
37425 much more efficient than throwing it away line by line. The sub-window also has
37426 a horizontal scroll bar for accessing the ends of long log lines. This is the
37427 only means of horizontal scrolling; the right and left arrow keys are not
37428 available. Text can be cut from this part of the window using the mouse in the
37429 normal way. The size of this subwindow is controlled by parameters in the
37430 configuration file &_Local/eximon.conf_&.
37431
37432 Searches of the text in the log window can be carried out by means of the ^R
37433 and ^S keystrokes, which default to a reverse and a forward search,
37434 respectively. The search covers only the text that is displayed in the window.
37435 It cannot go further back up the log.
37436
37437 The point from which the search starts is indicated by a caret marker. This is
37438 normally at the end of the text in the window, but can be positioned explicitly
37439 by pointing and clicking with the left mouse button, and is moved automatically
37440 by a successful search. If new text arrives in the window when it is scrolled
37441 back, the caret remains where it is, but if the window is not scrolled back,
37442 the caret is moved to the end of the new text.
37443
37444 Pressing ^R or ^S pops up a window into which the search text can be typed.
37445 There are buttons for selecting forward or reverse searching, for carrying out
37446 the search, and for cancelling. If the &"Search"& button is pressed, the search
37447 happens and the window remains so that further searches can be done. If the
37448 &"Return"& key is pressed, a single search is done and the window is closed. If
37449 ^C is typed the search is cancelled.
37450
37451 The searching facility is implemented using the facilities of the Athena text
37452 widget. By default this pops up a window containing both &"search"& and
37453 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37454 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37455 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37456 provided version of &%TextPop%& when the remaining parts of the text widget
37457 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37458 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37459 on these systems, at the expense of having unwanted items in the search popup
37460 window.
37461
37462
37463
37464 .section "The queue display" "SECID268"
37465 .cindex "queue" "display in monitor"
37466 The bottom section of the monitor window contains a list of all messages that
37467 are on the queue, which includes those currently being received or delivered,
37468 as well as those awaiting delivery. The size of this subwindow is controlled by
37469 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37470 at which it is updated is controlled by another parameter in the same file &--
37471 the default is 5 minutes, since queue scans can be quite expensive. However,
37472 there is an &"Update"& action button just above the display which can be used
37473 to force an update of the queue display at any time.
37474
37475 When a host is down for some time, a lot of pending mail can build up for it,
37476 and this can make it hard to deal with other messages on the queue. To help
37477 with this situation there is a button next to &"Update"& called &"Hide"&. If
37478 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37479 type anything in here and press &"Return"&, the text is added to a chain of
37480 such texts, and if every undelivered address in a message matches at least one
37481 of the texts, the message is not displayed.
37482
37483 If there is an address that does not match any of the texts, all the addresses
37484 are displayed as normal. The matching happens on the ends of addresses so, for
37485 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37486 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37487 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37488 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37489 a hide request is automatically cancelled after one hour.
37490
37491 While the dialogue box is displayed, you can't press any buttons or do anything
37492 else to the monitor window. For this reason, if you want to cut text from the
37493 queue display to use in the dialogue box, you have to do the cutting before
37494 pressing the &"Hide"& button.
37495
37496 The queue display contains, for each unhidden queued message, the length of
37497 time it has been on the queue, the size of the message, the message id, the
37498 message sender, and the first undelivered recipient, all on one line. If it is
37499 a bounce message, the sender is shown as &"<>"&. If there is more than one
37500 recipient to which the message has not yet been delivered, subsequent ones are
37501 listed on additional lines, up to a maximum configured number, following which
37502 an ellipsis is displayed. Recipients that have already received the message are
37503 not shown.
37504
37505 .cindex "frozen messages" "display"
37506 If a message is frozen, an asterisk is displayed at the left-hand side.
37507
37508 The queue display has a vertical scroll bar, and can also be scrolled by means
37509 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37510 The text searching facilities, as described above for the log window, are also
37511 available, but the caret is always moved to the end of the text when the queue
37512 display is updated.
37513
37514
37515
37516 .section "The queue menu" "SECID269"
37517 .cindex "queue" "menu in monitor"
37518 If the &%shift%& key is held down and the left button is clicked when the mouse
37519 pointer is over the text for any message, an action menu pops up, and the first
37520 line of the queue display for the message is highlighted. This does not affect
37521 any selected text.
37522
37523 If you want to use some other event for popping up the menu, you can set the
37524 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37525 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37526 value set in this parameter is a standard X event description. For example, to
37527 run eximon using &%ctrl%& rather than &%shift%& you could use
37528 .code
37529 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37530 .endd
37531 The title of the menu is the message id, and it contains entries which act as
37532 follows:
37533
37534 .ilist
37535 &'message log'&: The contents of the message log for the message are displayed
37536 in a new text window.
37537 .next
37538 &'headers'&: Information from the spool file that contains the envelope
37539 information and headers is displayed in a new text window. See chapter
37540 &<<CHAPspool>>& for a description of the format of spool files.
37541 .next
37542 &'body'&: The contents of the spool file containing the body of the message are
37543 displayed in a new text window. There is a default limit of 20,000 bytes to the
37544 amount of data displayed. This can be changed by setting the BODY_MAX
37545 option at compile time, or the EXIMON_BODY_MAX option at run time.
37546 .next
37547 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37548 delivery of the message. This causes an automatic thaw if the message is
37549 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37550 a new text window. The delivery is run in a separate process, to avoid holding
37551 up the monitor while the delivery proceeds.
37552 .next
37553 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37554 that the message be frozen.
37555 .next
37556 .cindex "thawing messages"
37557 .cindex "unfreezing messages"
37558 .cindex "frozen messages" "thawing"
37559 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37560 that the message be thawed.
37561 .next
37562 .cindex "delivery" "forcing failure"
37563 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37564 that Exim gives up trying to deliver the message. A bounce message is generated
37565 for any remaining undelivered addresses.
37566 .next
37567 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37568 that the message be deleted from the system without generating a bounce
37569 message.
37570 .next
37571 &'add recipient'&: A dialog box is displayed into which a recipient address can
37572 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37573 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37574 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37575 causes a call to Exim to be made using the &%-Mar%& option to request that an
37576 additional recipient be added to the message, unless the entry box is empty, in
37577 which case no action is taken.
37578 .next
37579 &'mark delivered'&: A dialog box is displayed into which a recipient address
37580 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37581 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37582 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37583 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37584 recipient address as already delivered, unless the entry box is empty, in which
37585 case no action is taken.
37586 .next
37587 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37588 mark all recipient addresses as already delivered.
37589 .next
37590 &'edit sender'&: A dialog box is displayed initialized with the current
37591 sender's address. Pressing RETURN causes a call to Exim to be made using the
37592 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37593 in which case no action is taken. If you want to set an empty sender (as in
37594 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37595 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37596 the address is qualified with that domain.
37597 .endlist
37598
37599 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37600 other cases when a call to Exim is made, if there is any output from Exim (in
37601 particular, if the command fails) a window containing the command and the
37602 output is displayed. Otherwise, the results of the action are normally apparent
37603 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37604 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37605 if no output is generated.
37606
37607 The queue display is automatically updated for actions such as freezing and
37608 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37609 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37610 force an update of the display after one of these actions.
37611
37612 In any text window that is displayed as result of a menu action, the normal
37613 cut-and-paste facility is available, and searching can be carried out using ^R
37614 and ^S, as described above for the log tail window.
37615 .ecindex IIDeximon
37616
37617
37618
37619
37620
37621 . ////////////////////////////////////////////////////////////////////////////
37622 . ////////////////////////////////////////////////////////////////////////////
37623
37624 .chapter "Security considerations" "CHAPsecurity"
37625 .scindex IIDsecurcon "security" "discussion of"
37626 This chapter discusses a number of issues concerned with security, some of
37627 which are also covered in other parts of this manual.
37628
37629 For reasons that this author does not understand, some people have promoted
37630 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37631 existence of this chapter in the documentation. However, the intent of the
37632 chapter is simply to describe the way Exim works in relation to certain
37633 security concerns, not to make any specific claims about the effectiveness of
37634 its security as compared with other MTAs.
37635
37636 What follows is a description of the way Exim is supposed to be. Best efforts
37637 have been made to try to ensure that the code agrees with the theory, but an
37638 absence of bugs can never be guaranteed. Any that are reported will get fixed
37639 as soon as possible.
37640
37641
37642 .section "Building a more &""hardened""& Exim" "SECID286"
37643 .cindex "security" "build-time features"
37644 There are a number of build-time options that can be set in &_Local/Makefile_&
37645 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37646 Exim administrator who does not have the root password, or by someone who has
37647 penetrated the Exim (but not the root) account. These options are as follows:
37648
37649 .ilist
37650 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37651 start of any file names used with the &%-C%& option. When it is set, these file
37652 names are also not allowed to contain the sequence &"/../"&. (However, if the
37653 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37654 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37655 default setting for &%ALT_CONFIG_PREFIX%&.
37656
37657 If the permitted configuration files are confined to a directory to
37658 which only root has access, this guards against someone who has broken
37659 into the Exim account from running a privileged Exim with an arbitrary
37660 configuration file, and using it to break into other accounts.
37661 .next
37662
37663 If a non-trusted configuration file (i.e. not the default configuration file
37664 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37665 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37666 the next item), then root privilege is retained only if the caller of Exim is
37667 root. This locks out the possibility of testing a configuration using &%-C%&
37668 right through message reception and delivery, even if the caller is root. The
37669 reception works, but by that time, Exim is running as the Exim user, so when
37670 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37671 privilege to be lost. However, root can test reception and delivery using two
37672 separate commands.
37673
37674 .next
37675 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37676 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37677 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37678 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37679 the restrictive side.  Requiring build-time selection of safe macros is onerous
37680 but this option is intended solely as a transition mechanism to permit
37681 previously-working configurations to continue to work after release 4.73.
37682 .next
37683 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37684 is disabled.
37685 .next
37686 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37687 never to be used for any deliveries. This is like the &%never_users%& runtime
37688 option, but it cannot be overridden; the runtime option adds additional users
37689 to the list. The default setting is &"root"&; this prevents a non-root user who
37690 is permitted to modify the runtime file from using Exim as a way to get root.
37691 .endlist
37692
37693
37694
37695 .section "Root privilege" "SECID270"
37696 .cindex "setuid"
37697 .cindex "root privilege"
37698 The Exim binary is normally setuid to root, which means that it gains root
37699 privilege (runs as root) when it starts execution. In some special cases (for
37700 example, when the daemon is not in use and there are no local deliveries), it
37701 may be possible to run Exim setuid to some user other than root. This is
37702 discussed in the next section. However, in most installations, root privilege
37703 is required for two things:
37704
37705 .ilist
37706 To set up a socket connected to the standard SMTP port (25) when initialising
37707 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37708 not required.
37709 .next
37710 To be able to change uid and gid in order to read users' &_.forward_& files and
37711 perform local deliveries as the receiving user or as specified in the
37712 configuration.
37713 .endlist
37714
37715 It is not necessary to be root to do any of the other things Exim does, such as
37716 receiving messages and delivering them externally over SMTP, and it is
37717 obviously more secure if Exim does not run as root except when necessary.
37718 For this reason, a user and group for Exim to use must be defined in
37719 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37720 group"&. Their values can be changed by the run time configuration, though this
37721 is not recommended. Often a user called &'exim'& is used, but some sites use
37722 &'mail'& or another user name altogether.
37723
37724 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37725 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37726 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37727
37728 After a new Exim process has interpreted its command line options, it changes
37729 uid and gid in the following cases:
37730
37731 .ilist
37732 .oindex "&%-C%&"
37733 .oindex "&%-D%&"
37734 If the &%-C%& option is used to specify an alternate configuration file, or if
37735 the &%-D%& option is used to define macro values for the configuration, and the
37736 calling process is not running as root, the uid and gid are changed to those of
37737 the calling process.
37738 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37739 option may not be used at all.
37740 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37741 can be supplied if the calling process is running as root, the Exim run-time
37742 user or CONFIGURE_OWNER, if defined.
37743 .next
37744 .oindex "&%-be%&"
37745 .oindex "&%-bf%&"
37746 .oindex "&%-bF%&"
37747 If the expansion test option (&%-be%&) or one of the filter testing options
37748 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37749 calling process.
37750 .next
37751 If the process is not a daemon process or a queue runner process or a delivery
37752 process or a process for testing address routing (started with &%-bt%&), the
37753 uid and gid are changed to the Exim user and group. This means that Exim always
37754 runs under its own uid and gid when receiving messages. This also applies when
37755 testing address verification
37756 .oindex "&%-bv%&"
37757 .oindex "&%-bh%&"
37758 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37759 option).
37760 .next
37761 For a daemon, queue runner, delivery, or address testing process, the uid
37762 remains as root at this stage, but the gid is changed to the Exim group.
37763 .endlist
37764
37765 The processes that initially retain root privilege behave as follows:
37766
37767 .ilist
37768 A daemon process changes the gid to the Exim group and the uid to the Exim
37769 user after setting up one or more listening sockets. The &[initgroups()]&
37770 function is called, so that if the Exim user is in any additional groups, they
37771 will be used during message reception.
37772 .next
37773 A queue runner process retains root privilege throughout its execution. Its
37774 job is to fork a controlled sequence of delivery processes.
37775 .next
37776 A delivery process retains root privilege throughout most of its execution,
37777 but any actual deliveries (that is, the transports themselves) are run in
37778 subprocesses which always change to a non-root uid and gid. For local
37779 deliveries this is typically the uid and gid of the owner of the mailbox; for
37780 remote deliveries, the Exim uid and gid are used. Once all the delivery
37781 subprocesses have been run, a delivery process changes to the Exim uid and gid
37782 while doing post-delivery tidying up such as updating the retry database and
37783 generating bounce and warning messages.
37784
37785 While the recipient addresses in a message are being routed, the delivery
37786 process runs as root. However, if a user's filter file has to be processed,
37787 this is done in a subprocess that runs under the individual user's uid and
37788 gid. A system filter is run as root unless &%system_filter_user%& is set.
37789 .next
37790 A process that is testing addresses (the &%-bt%& option) runs as root so that
37791 the routing is done in the same environment as a message delivery.
37792 .endlist
37793
37794
37795
37796
37797 .section "Running Exim without privilege" "SECTrunexiwitpri"
37798 .cindex "privilege, running without"
37799 .cindex "unprivileged running"
37800 .cindex "root privilege" "running without"
37801 Some installations like to run Exim in an unprivileged state for more of its
37802 operation, for added security. Support for this mode of operation is provided
37803 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37804 gid are changed to the Exim user and group at the start of a delivery process
37805 (and also queue runner and address testing processes). This means that address
37806 routing is no longer run as root, and the deliveries themselves cannot change
37807 to any other uid.
37808
37809 .cindex SIGHUP
37810 .cindex "daemon" "restarting"
37811 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37812 that the daemon can still be started in the usual way, and it can respond
37813 correctly to SIGHUP because the re-invocation regains root privilege.
37814
37815 An alternative approach is to make Exim setuid to the Exim user and also setgid
37816 to the Exim group. If you do this, the daemon must be started from a root
37817 process. (Calling Exim from a root process makes it behave in the way it does
37818 when it is setuid root.) However, the daemon cannot restart itself after a
37819 SIGHUP signal because it cannot regain privilege.
37820
37821 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37822 stops Exim from trying to re-invoke itself to do a delivery after a message has
37823 been received. Such a re-invocation is a waste of resources because it has no
37824 effect.
37825
37826 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37827 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37828 to the Exim user seems a clean approach, but there is one complication:
37829
37830 In this style of operation, Exim is running with the real uid and gid set to
37831 those of the calling process, and the effective uid/gid set to Exim's values.
37832 Ideally, any association with the calling process' uid/gid should be dropped,
37833 that is, the real uid/gid should be reset to the effective values so as to
37834 discard any privileges that the caller may have. While some operating systems
37835 have a function that permits this action for a non-root effective uid, quite a
37836 number of them do not. Because of this lack of standardization, Exim does not
37837 address this problem at this time.
37838
37839 For this reason, the recommended approach for &"mostly unprivileged"& running
37840 is to keep the Exim binary setuid to root, and to set
37841 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37842 be used in the most straightforward way.
37843
37844 If you configure Exim not to run delivery processes as root, there are a
37845 number of restrictions on what you can do:
37846
37847 .ilist
37848 You can deliver only as the Exim user/group. You should  explicitly use the
37849 &%user%& and &%group%& options to override routers or local transports that
37850 normally deliver as the recipient. This makes sure that configurations that
37851 work in this mode function the same way in normal mode. Any implicit or
37852 explicit specification of another user causes an error.
37853 .next
37854 Use of &_.forward_& files is severely restricted, such that it is usually
37855 not worthwhile to include them in the configuration.
37856 .next
37857 Users who wish to use &_.forward_& would have to make their home directory and
37858 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37859 and their equivalents in Exim filters, cannot be used. While they could be
37860 enabled in the Exim user's name, that would be insecure and not very useful.
37861 .next
37862 Unless the local user mailboxes are all owned by the Exim user (possible in
37863 some POP3 or IMAP-only environments):
37864
37865 .olist
37866 They must be owned by the Exim group and be writeable by that group. This
37867 implies you must set &%mode%& in the appendfile configuration, as well as the
37868 mode of the mailbox files themselves.
37869 .next
37870 You must set &%no_check_owner%&, since most or all of the files will not be
37871 owned by the Exim user.
37872 .next
37873 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37874 on a newly created mailbox when unprivileged. This also implies that new
37875 mailboxes need to be created manually.
37876 .endlist olist
37877 .endlist ilist
37878
37879
37880 These restrictions severely restrict what can be done in local deliveries.
37881 However, there are no restrictions on remote deliveries. If you are running a
37882 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37883 gives more security at essentially no cost.
37884
37885 If you are using the &%mua_wrapper%& facility (see chapter
37886 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37887
37888
37889
37890
37891 .section "Delivering to local files" "SECID271"
37892 Full details of the checks applied by &(appendfile)& before it writes to a file
37893 are given in chapter &<<CHAPappendfile>>&.
37894
37895
37896
37897 .section "Running local commands" "SECTsecconslocalcmds"
37898 .cindex "security" "local commands"
37899 .cindex "security" "command injection attacks"
37900 There are a number of ways in which an administrator can configure Exim to run
37901 commands based upon received, untrustworthy, data. Further, in some
37902 configurations a user who can control a &_.forward_& file can also arrange to
37903 run commands. Configuration to check includes, but is not limited to:
37904
37905 .ilist
37906 Use of &%use_shell%& in the pipe transport: various forms of shell command
37907 injection may be possible with this option present. It is dangerous and should
37908 be used only with considerable caution. Consider constraints which whitelist
37909 allowed characters in a variable which is to be used in a pipe transport that
37910 has &%use_shell%& enabled.
37911 .next
37912 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37913 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37914 &_.forward_& files in a redirect router. If Exim is running on a central mail
37915 hub to which ordinary users do not have shell access, but home directories are
37916 NFS mounted (for instance) then administrators should review the list of these
37917 forbid options available, and should bear in mind that the options that may
37918 need forbidding can change as new features are added between releases.
37919 .next
37920 The &%${run...}%& expansion item does not use a shell by default, but
37921 administrators can configure use of &_/bin/sh_& as part of the command.
37922 Such invocations should be viewed with prejudicial suspicion.
37923 .next
37924 Administrators who use embedded Perl are advised to explore how Perl's
37925 taint checking might apply to their usage.
37926 .next
37927 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37928 administrators are well advised to view its use with suspicion, in case (for
37929 instance) it allows a local-part to contain embedded Exim directives.
37930 .next
37931 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37932 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37933 each can reference arbitrary lists and files, rather than just being a list
37934 of opaque strings.
37935 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37936 real-world security vulnerabilities caused by its use with untrustworthy data
37937 injected in, for SQL injection attacks.
37938 Consider the use of the &%inlisti%& expansion condition instead.
37939 .endlist
37940
37941
37942
37943
37944 .section "Trust in configuration data" "SECTsecconfdata"
37945 .cindex "security" "data sources"
37946 .cindex "security" "regular expressions"
37947 .cindex "regular expressions" "security"
37948 .cindex "PCRE" "security"
37949 If configuration data for Exim can come from untrustworthy sources, there
37950 are some issues to be aware of:
37951
37952 .ilist
37953 Use of &%${expand...}%& may provide a path for shell injection attacks.
37954 .next
37955 Letting untrusted data provide a regular expression is unwise.
37956 .next
37957 Using &%${match...}%& to apply a fixed regular expression against untrusted
37958 data may result in pathological behaviour within PCRE.  Be aware of what
37959 "backtracking" means and consider options for being more strict with a regular
37960 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37961 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37962 possessive quantifiers or just not using regular expressions against untrusted
37963 data.
37964 .next
37965 It can be important to correctly use &%${quote:...}%&,
37966 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37967 items to ensure that data is correctly constructed.
37968 .next
37969 Some lookups might return multiple results, even though normal usage is only
37970 expected to yield one result.
37971 .endlist
37972
37973
37974
37975
37976 .section "IPv4 source routing" "SECID272"
37977 .cindex "source routing" "in IP packets"
37978 .cindex "IP source routing"
37979 Many operating systems suppress IP source-routed packets in the kernel, but
37980 some cannot be made to do this, so Exim does its own check. It logs incoming
37981 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37982 IPv6. No special checking is currently done.
37983
37984
37985
37986 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37987 Support for these SMTP commands is disabled by default. If required, they can
37988 be enabled by defining suitable ACLs.
37989
37990
37991
37992
37993 .section "Privileged users" "SECID274"
37994 .cindex "trusted users"
37995 .cindex "admin user"
37996 .cindex "privileged user"
37997 .cindex "user" "trusted"
37998 .cindex "user" "admin"
37999 Exim recognizes two sets of users with special privileges. Trusted users are
38000 able to submit new messages to Exim locally, but supply their own sender
38001 addresses and information about a sending host. For other users submitting
38002 local messages, Exim sets up the sender address from the uid, and doesn't
38003 permit a remote host to be specified.
38004
38005 .oindex "&%-f%&"
38006 However, an untrusted user is permitted to use the &%-f%& command line option
38007 in the special form &%-f <>%& to indicate that a delivery failure for the
38008 message should not cause an error report. This affects the message's envelope,
38009 but it does not affect the &'Sender:'& header. Untrusted users may also be
38010 permitted to use specific forms of address with the &%-f%& option by setting
38011 the &%untrusted_set_sender%& option.
38012
38013 Trusted users are used to run processes that receive mail messages from some
38014 other mail domain and pass them on to Exim for delivery either locally, or over
38015 the Internet. Exim trusts a caller that is running as root, as the Exim user,
38016 as any user listed in the &%trusted_users%& configuration option, or under any
38017 group listed in the &%trusted_groups%& option.
38018
38019 Admin users are permitted to do things to the messages on Exim's queue. They
38020 can freeze or thaw messages, cause them to be returned to their senders, remove
38021 them entirely, or modify them in various ways. In addition, admin users can run
38022 the Exim monitor and see all the information it is capable of providing, which
38023 includes the contents of files on the spool.
38024
38025 .oindex "&%-M%&"
38026 .oindex "&%-q%&"
38027 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
38028 delivery of messages on its queue is restricted to admin users. This
38029 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
38030 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
38031 queue is also restricted to admin users. This restriction can be relaxed by
38032 setting &%no_queue_list_requires_admin%&.
38033
38034 Exim recognizes an admin user if the calling process is running as root or as
38035 the Exim user or if any of the groups associated with the calling process is
38036 the Exim group. It is not necessary actually to be running under the Exim
38037 group. However, if admin users who are not root or the Exim user are to access
38038 the contents of files on the spool via the Exim monitor (which runs
38039 unprivileged), Exim must be built to allow group read access to its spool
38040 files.
38041
38042 .new
38043 By default, regular users are trusted to perform basic testing and
38044 introspection commands, as themselves.  This setting can be tightened by
38045 setting the &%commandline_checks_require_admin%& option.
38046 This affects most of the checking options,
38047 such as &%-be%& and anything else &%-b*%&.
38048 .wen
38049
38050
38051 .section "Spool files" "SECID275"
38052 .cindex "spool directory" "files"
38053 Exim's spool directory and everything it contains is owned by the Exim user and
38054 set to the Exim group. The mode for spool files is defined in the
38055 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
38056 any user who is a member of the Exim group can access these files.
38057
38058
38059
38060 .section "Use of argv[0]" "SECID276"
38061 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
38062 of specific strings, Exim assumes certain options. For example, calling Exim
38063 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
38064 to calling it with the option &%-bS%&. There are no security implications in
38065 this.
38066
38067
38068
38069 .section "Use of %f formatting" "SECID277"
38070 The only use made of &"%f"& by Exim is in formatting load average values. These
38071 are actually stored in integer variables as 1000 times the load average.
38072 Consequently, their range is limited and so therefore is the length of the
38073 converted output.
38074
38075
38076
38077 .section "Embedded Exim path" "SECID278"
38078 Exim uses its own path name, which is embedded in the code, only when it needs
38079 to re-exec in order to regain root privilege. Therefore, it is not root when it
38080 does so. If some bug allowed the path to get overwritten, it would lead to an
38081 arbitrary program's being run as exim, not as root.
38082
38083
38084
38085 .section "Dynamic module directory" "SECTdynmoddir"
38086 Any dynamically loadable modules must be installed into the directory
38087 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
38088 loading it.
38089
38090
38091 .section "Use of sprintf()" "SECID279"
38092 .cindex "&[sprintf()]&"
38093 A large number of occurrences of &"sprintf"& in the code are actually calls to
38094 &'string_sprintf()'&, a function that returns the result in malloc'd store.
38095 The intermediate formatting is done into a large fixed buffer by a function
38096 that runs through the format string itself, and checks the length of each
38097 conversion before performing it, thus preventing buffer overruns.
38098
38099 The remaining uses of &[sprintf()]& happen in controlled circumstances where
38100 the output buffer is known to be sufficiently long to contain the converted
38101 string.
38102
38103
38104
38105 .section "Use of debug_printf() and log_write()" "SECID280"
38106 Arbitrary strings are passed to both these functions, but they do their
38107 formatting by calling the function &'string_vformat()'&, which runs through
38108 the format string itself, and checks the length of each conversion.
38109
38110
38111
38112 .section "Use of strcat() and strcpy()" "SECID281"
38113 These are used only in cases where the output buffer is known to be large
38114 enough to hold the result.
38115 .ecindex IIDsecurcon
38116
38117
38118
38119
38120 . ////////////////////////////////////////////////////////////////////////////
38121 . ////////////////////////////////////////////////////////////////////////////
38122
38123 .chapter "Format of spool files" "CHAPspool"
38124 .scindex IIDforspo1 "format" "spool files"
38125 .scindex IIDforspo2 "spool directory" "format of files"
38126 .scindex IIDforspo3 "spool files" "format of"
38127 .cindex "spool files" "editing"
38128 A message on Exim's queue consists of two files, whose names are the message id
38129 followed by -D and -H, respectively. The data portion of the message is kept in
38130 the -D file on its own. The message's envelope, status, and headers are all
38131 kept in the -H file, whose format is described in this chapter. Each of these
38132 two files contains the final component of its own name as its first line. This
38133 is insurance against disk crashes where the directory is lost but the files
38134 themselves are recoverable.
38135
38136 Some people are tempted into editing -D files in order to modify messages. You
38137 need to be extremely careful if you do this; it is not recommended and you are
38138 on your own if you do it. Here are some of the pitfalls:
38139
38140 .ilist
38141 You must ensure that Exim does not try to deliver the message while you are
38142 fiddling with it. The safest way is to take out a write lock on the -D file,
38143 which is what Exim itself does, using &[fcntl()]&. If you update the file in
38144 place, the lock will be retained. If you write a new file and rename it, the
38145 lock will be lost at the instant of rename.
38146 .next
38147 .vindex "&$body_linecount$&"
38148 If you change the number of lines in the file, the value of
38149 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
38150 cause incomplete transmission of messages or undeliverable messages.
38151 .next
38152 If the message is in MIME format, you must take care not to break it.
38153 .next
38154 If the message is cryptographically signed, any change will invalidate the
38155 signature.
38156 .endlist
38157 All in all, modifying -D files is fraught with danger.
38158
38159 Files whose names end with -J may also be seen in the &_input_& directory (or
38160 its subdirectories when &%split_spool_directory%& is set). These are journal
38161 files, used to record addresses to which the message has been delivered during
38162 the course of a delivery attempt. If there are still undelivered recipients at
38163 the end, the -H file is updated, and the -J file is deleted. If, however, there
38164 is some kind of crash (for example, a power outage) before this happens, the -J
38165 file remains in existence. When Exim next processes the message, it notices the
38166 -J file and uses it to update the -H file before starting the next delivery
38167 attempt.
38168
38169 .new
38170 Files whose names end with -K or .eml may also be seen in the spool.
38171 These are temporaries used for DKIM or malware processing, when that is used.
38172 They should be tidied up by normal operations; any old ones are probably
38173 relics of crashes and can be removed.
38174 .wen
38175
38176 .section "Format of the -H file" "SECID282"
38177 .cindex "uid (user id)" "in spool file"
38178 .cindex "gid (group id)" "in spool file"
38179 The second line of the -H file contains the login name for the uid of the
38180 process that called Exim to read the message, followed by the numerical uid and
38181 gid. For a locally generated message, this is normally the user who sent the
38182 message. For a message received over TCP/IP via the daemon, it is
38183 normally the Exim user.
38184
38185 The third line of the file contains the address of the message's sender as
38186 transmitted in the envelope, contained in angle brackets. The sender address is
38187 empty for bounce messages. For incoming SMTP mail, the sender address is given
38188 in the MAIL command. For locally generated mail, the sender address is
38189 created by Exim from the login name of the current user and the configured
38190 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
38191 leading &"From&~"& line if the caller is trusted, or if the supplied address is
38192 &"<>"& or an address that matches &%untrusted_set_senders%&.
38193
38194 The fourth line contains two numbers. The first is the time that the message
38195 was received, in the conventional Unix form &-- the number of seconds since the
38196 start of the epoch. The second number is a count of the number of messages
38197 warning of delayed delivery that have been sent to the sender.
38198
38199 There follow a number of lines starting with a hyphen. These can appear in any
38200 order, and are omitted when not relevant:
38201
38202 .vlist
38203 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
38204 This item is obsolete, and is not generated from Exim release 4.61 onwards;
38205 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
38206 recognized, to provide backward compatibility. In the old format, a line of
38207 this form is present for every ACL variable that is not empty. The number
38208 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
38209 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
38210 the data string for the variable. The string itself starts at the beginning of
38211 the next line, and is followed by a newline character. It may contain internal
38212 newlines.
38213
38214 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
38215 A line of this form is present for every ACL connection variable that is
38216 defined. Note that there is a space between &%-aclc%& and the rest of the name.
38217 The length is the length of the data string for the variable. The string itself
38218 starts at the beginning of the next line, and is followed by a newline
38219 character. It may contain internal newlines.
38220
38221 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
38222 A line of this form is present for every ACL message variable that is defined.
38223 Note that there is a space between &%-aclm%& and the rest of the name. The
38224 length is the length of the data string for the variable. The string itself
38225 starts at the beginning of the next line, and is followed by a newline
38226 character. It may contain internal newlines.
38227
38228 .vitem "&%-active_hostname%&&~<&'hostname'&>"
38229 This is present if, when the message was received over SMTP, the value of
38230 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
38231
38232 .vitem &%-allow_unqualified_recipient%&
38233 This is present if unqualified recipient addresses are permitted in header
38234 lines (to stop such addresses from being qualified if rewriting occurs at
38235 transport time). Local messages that were input using &%-bnq%& and remote
38236 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
38237
38238 .vitem &%-allow_unqualified_sender%&
38239 This is present if unqualified sender addresses are permitted in header lines
38240 (to stop such addresses from being qualified if rewriting occurs at transport
38241 time). Local messages that were input using &%-bnq%& and remote messages from
38242 hosts that match &%sender_unqualified_hosts%& set this flag.
38243
38244 .vitem "&%-auth_id%&&~<&'text'&>"
38245 The id information for a message received on an authenticated SMTP connection
38246 &-- the value of the &$authenticated_id$& variable.
38247
38248 .vitem "&%-auth_sender%&&~<&'address'&>"
38249 The address of an authenticated sender &-- the value of the
38250 &$authenticated_sender$& variable.
38251
38252 .vitem "&%-body_linecount%&&~<&'number'&>"
38253 This records the number of lines in the body of the message, and is
38254 present unless &%-spool_file_wireformat%& is.
38255
38256 .vitem "&%-body_zerocount%&&~<&'number'&>"
38257 This records the number of binary zero bytes in the body of the message, and is
38258 present if the number is greater than zero.
38259
38260 .vitem &%-deliver_firsttime%&
38261 This is written when a new message is first added to the spool. When the spool
38262 file is updated after a deferral, it is omitted.
38263
38264 .vitem "&%-frozen%&&~<&'time'&>"
38265 .cindex "frozen messages" "spool data"
38266 The message is frozen, and the freezing happened at <&'time'&>.
38267
38268 .vitem "&%-helo_name%&&~<&'text'&>"
38269 This records the host name as specified by a remote host in a HELO or EHLO
38270 command.
38271
38272 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
38273 This records the IP address of the host from which the message was received and
38274 the remote port number that was used. It is omitted for locally generated
38275 messages.
38276
38277 .vitem "&%-host_auth%&&~<&'text'&>"
38278 If the message was received on an authenticated SMTP connection, this records
38279 the name of the authenticator &-- the value of the
38280 &$sender_host_authenticated$& variable.
38281
38282 .vitem &%-host_lookup_failed%&
38283 This is present if an attempt to look up the sending host's name from its IP
38284 address failed. It corresponds to the &$host_lookup_failed$& variable.
38285
38286 .vitem "&%-host_name%&&~<&'text'&>"
38287 .cindex "reverse DNS lookup"
38288 .cindex "DNS" "reverse lookup"
38289 This records the name of the remote host from which the message was received,
38290 if the host name was looked up from the IP address when the message was being
38291 received. It is not present if no reverse lookup was done.
38292
38293 .vitem "&%-ident%&&~<&'text'&>"
38294 For locally submitted messages, this records the login of the originating user,
38295 unless it was a trusted user and the &%-oMt%& option was used to specify an
38296 ident value. For messages received over TCP/IP, this records the ident string
38297 supplied by the remote host, if any.
38298
38299 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
38300 This records the IP address of the local interface and the port number through
38301 which a message was received from a remote host. It is omitted for locally
38302 generated messages.
38303
38304 .vitem &%-local%&
38305 The message is from a local sender.
38306
38307 .vitem &%-localerror%&
38308 The message is a locally-generated bounce message.
38309
38310 .vitem "&%-local_scan%&&~<&'string'&>"
38311 This records the data string that was returned by the &[local_scan()]& function
38312 when the message was received &-- the value of the &$local_scan_data$&
38313 variable. It is omitted if no data was returned.
38314
38315 .vitem &%-manual_thaw%&
38316 The message was frozen but has been thawed manually, that is, by an explicit
38317 Exim command rather than via the auto-thaw process.
38318
38319 .vitem &%-N%&
38320 A testing delivery process was started using the &%-N%& option to suppress any
38321 actual deliveries, but delivery was deferred. At any further delivery attempts,
38322 &%-N%& is assumed.
38323
38324 .vitem &%-received_protocol%&
38325 This records the value of the &$received_protocol$& variable, which contains
38326 the name of the protocol by which the message was received.
38327
38328 .vitem &%-sender_set_untrusted%&
38329 The envelope sender of this message was set by an untrusted local caller (used
38330 to ensure that the caller is displayed in queue listings).
38331
38332 .vitem "&%-spam_score_int%&&~<&'number'&>"
38333 If a message was scanned by SpamAssassin, this is present. It records the value
38334 of &$spam_score_int$&.
38335
38336 .new
38337 .vitem &%-spool_file_wireformat%&
38338 The -D file for this message is in wire-format (for ESMTP CHUNKING)
38339 rather than Unix-format.
38340 The line-ending is CRLF rather than newline.
38341 There is still, however, no leading-dot-stuffing.
38342 .wen
38343
38344 .vitem &%-tls_certificate_verified%&
38345 A TLS certificate was received from the client that sent this message, and the
38346 certificate was verified by the server.
38347
38348 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
38349 When the message was received over an encrypted connection, this records the
38350 name of the cipher suite that was used.
38351
38352 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
38353 When the message was received over an encrypted connection, and a certificate
38354 was received from the client, this records the Distinguished Name from that
38355 certificate.
38356 .endlist
38357
38358 Following the options there is a list of those addresses to which the message
38359 is not to be delivered. This set of addresses is initialized from the command
38360 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
38361 is set; otherwise it starts out empty. Whenever a successful delivery is made,
38362 the address is added to this set. The addresses are kept internally as a
38363 balanced binary tree, and it is a representation of that tree which is written
38364 to the spool file. If an address is expanded via an alias or forward file, the
38365 original address is added to the tree when deliveries to all its child
38366 addresses are complete.
38367
38368 If the tree is empty, there is a single line in the spool file containing just
38369 the text &"XX"&. Otherwise, each line consists of two letters, which are either
38370 Y or N, followed by an address. The address is the value for the node of the
38371 tree, and the letters indicate whether the node has a left branch and/or a
38372 right branch attached to it, respectively. If branches exist, they immediately
38373 follow. Here is an example of a three-node tree:
38374 .code
38375 YY darcy@austen.fict.example
38376 NN alice@wonderland.fict.example
38377 NN editor@thesaurus.ref.example
38378 .endd
38379 After the non-recipients tree, there is a list of the message's recipients.
38380 This is a simple list, preceded by a count. It includes all the original
38381 recipients of the message, including those to whom the message has already been
38382 delivered. In the simplest case, the list contains one address per line. For
38383 example:
38384 .code
38385 4
38386 editor@thesaurus.ref.example
38387 darcy@austen.fict.example
38388 rdo@foundation
38389 alice@wonderland.fict.example
38390 .endd
38391 However, when a child address has been added to the top-level addresses as a
38392 result of the use of the &%one_time%& option on a &(redirect)& router, each
38393 line is of the following form:
38394 .display
38395 <&'top-level address'&> <&'errors_to address'&> &&&
38396   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38397 .endd
38398 The 01 flag bit indicates the presence of the three other fields that follow
38399 the top-level address. Other bits may be used in future to support additional
38400 fields. The <&'parent number'&> is the offset in the recipients list of the
38401 original parent of the &"one time"& address. The first two fields are the
38402 envelope sender that is associated with this address and its length. If the
38403 length is zero, there is no special envelope sender (there are then two space
38404 characters in the line). A non-empty field can arise from a &(redirect)& router
38405 that has an &%errors_to%& setting.
38406
38407
38408 A blank line separates the envelope and status information from the headers
38409 which follow. A header may occupy several lines of the file, and to save effort
38410 when reading it in, each header is preceded by a number and an identifying
38411 character. The number is the number of characters in the header, including any
38412 embedded newlines and the terminating newline. The character is one of the
38413 following:
38414
38415 .table2 50pt
38416 .row <&'blank'&>         "header in which Exim has no special interest"
38417 .row &`B`&               "&'Bcc:'& header"
38418 .row &`C`&               "&'Cc:'& header"
38419 .row &`F`&               "&'From:'& header"
38420 .row &`I`&               "&'Message-id:'& header"
38421 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38422 .row &`R`&               "&'Reply-To:'& header"
38423 .row &`S`&               "&'Sender:'& header"
38424 .row &`T`&               "&'To:'& header"
38425 .row &`*`&               "replaced or deleted header"
38426 .endtable
38427
38428 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38429 purposes. They are not transmitted when the message is delivered. Here is a
38430 typical set of headers:
38431 .code
38432 111P Received: by hobbit.fict.example with local (Exim 4.00)
38433 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38434 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38435 038* X-rewrote-sender: bb@hobbit.fict.example
38436 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38437 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38438 099* To: alice@wonderland.fict.example, rdo@foundation,
38439 darcy@austen.fict.example, editor@thesaurus.ref.example
38440 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38441 darcy@austen.fict.example, editor@thesaurus.ref.example
38442 038  Date: Fri, 11 May 2001 10:28:59 +0100
38443 .endd
38444 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38445 &'To:'& header have been rewritten, the last one because routing expanded the
38446 unqualified domain &'foundation'&.
38447 .ecindex IIDforspo1
38448 .ecindex IIDforspo2
38449 .ecindex IIDforspo3
38450
38451 .new
38452 .section "Format of the -D file" "SECID282a"
38453 The data file is traditionally in Unix-standard format: lines are ended with
38454 an ASCII newline character.
38455 However, when the &%spool_wireformat%& main option is used some -D files
38456 can have an alternate format.
38457 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
38458 The -D file lines (not including the first name-component line) are
38459 suitable for direct copying to the wire when transmitting using the
38460 ESMTP CHUNKING option, meaning lower processing overhead.
38461 Lines are terminated with an ASCII CRLF pair.
38462 There is no dot-stuffing (and no dot-termination).
38463 .wen
38464
38465 . ////////////////////////////////////////////////////////////////////////////
38466 . ////////////////////////////////////////////////////////////////////////////
38467
38468 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38469          "DKIM Support"
38470 .cindex "DKIM"
38471
38472 DKIM is a mechanism by which messages sent by some entity can be provably
38473 linked to a domain which that entity controls.  It permits reputation to
38474 be tracked on a per-domain basis, rather than merely upon source IP address.
38475 DKIM is documented in RFC 4871.
38476
38477 DKIM support is compiled into Exim by default if TLS support is present.
38478 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38479
38480 Exim's DKIM implementation allows for
38481 .olist
38482 Signing outgoing messages: This function is implemented in the SMTP transport.
38483 It can co-exist with all other Exim features
38484 (including transport filters)
38485 except cutthrough delivery.
38486 .next
38487 Verifying signatures in incoming messages: This is implemented by an additional
38488 ACL (acl_smtp_dkim), which can be called several times per message, with
38489 different signature contexts.
38490 .endlist
38491
38492 In typical Exim style, the verification implementation does not include any
38493 default "policy". Instead it enables you to build your own policy using
38494 Exim's standard controls.
38495
38496 Please note that verification of DKIM signatures in incoming mail is turned
38497 on by default for logging purposes. For each signature in incoming email,
38498 exim will log a line displaying the most important signature details, and the
38499 signature status. Here is an example (with line-breaks added for clarity):
38500 .code
38501 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38502     d=facebookmail.com s=q1-2009b
38503     c=relaxed/relaxed a=rsa-sha1
38504     i=@facebookmail.com t=1252484542 [verification succeeded]
38505 .endd
38506 You might want to turn off DKIM verification processing entirely for internal
38507 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38508 control modifier. This should typically be done in the RCPT ACL, at points
38509 where you accept mail from relay sources (internal hosts or authenticated
38510 senders).
38511
38512
38513 .section "Signing outgoing messages" "SECDKIMSIGN"
38514 .cindex "DKIM" "signing"
38515
38516 Signing is enabled by setting private options on the SMTP transport.
38517 These options take (expandable) strings as arguments.
38518
38519 .option dkim_domain smtp string list&!! unset
38520 The domain(s) you want to sign with.
38521 .new
38522 After expansion, this can be a list.
38523 Each element in turn is put into the &%$dkim_domain%& expansion variable
38524 while expanding the remaining signing options.
38525 .wen
38526 If it is empty after expansion, DKIM signing is not done.
38527
38528 .option dkim_selector smtp string&!! unset
38529 This sets the key selector string.
38530 You can use the &%$dkim_domain%& expansion variable to look up a matching selector.
38531 The result is put in the expansion
38532 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38533 option along with &%$dkim_domain%&.
38534 If the option is empty after expansion, DKIM signing is not done.
38535
38536 .option dkim_private_key smtp string&!! unset
38537 This sets the private key to use.
38538 You can use the &%$dkim_domain%& and
38539 &%$dkim_selector%& expansion variables to determine the private key to use.
38540 The result can either
38541 .ilist
38542 be a valid RSA private key in ASCII armor, including line breaks.
38543 .next
38544 start with a slash, in which case it is treated as a file that contains
38545 the private key.
38546 .next
38547 be "0", "false" or the empty string, in which case the message will not
38548 be signed. This case will not result in an error, even if &%dkim_strict%&
38549 is set.
38550 .endlist
38551 If the option is empty after expansion, DKIM signing is not done.
38552
38553 .option dkim_canon smtp string&!! unset
38554 This option sets the canonicalization method used when signing a message.
38555 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38556 The option defaults to "relaxed" when unset. Note: the current implementation
38557 only supports using the same canonicalization method for both headers and body.
38558
38559 .option dkim_strict smtp string&!! unset
38560 This  option  defines  how  Exim  behaves  when  signing a message that
38561 should be signed fails for some reason.  When the expansion evaluates to
38562 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38563 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38564 variables here.
38565
38566 .option dkim_sign_headers smtp string&!! unset
38567 If set, this option must expand to (or be specified as) a colon-separated
38568 list of header names. Headers with these names will be included in the message
38569 signature.
38570 When unspecified, the header names recommended in RFC4871 will be used.
38571
38572
38573 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38574 .cindex "DKIM" "verification"
38575
38576 Verification of DKIM signatures in SMTP incoming email is implemented via the
38577 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38578 syntactically(!) correct signature in the incoming message.
38579 A missing ACL definition defaults to accept.
38580 If any ACL call does not accept, the message is not accepted.
38581 If a cutthrough delivery was in progress for the message it is
38582 summarily dropped (having wasted the transmission effort).
38583
38584 To evaluate the signature in the ACL a large number of expansion variables
38585 containing the signature status and its details are set up during the
38586 runtime of the ACL.
38587
38588 Calling the ACL only for existing signatures is not sufficient to build
38589 more advanced policies. For that reason, the global option
38590 &%dkim_verify_signers%&, and a global expansion variable
38591 &%$dkim_signers%& exist.
38592
38593 The global option &%dkim_verify_signers%& can be set to a colon-separated
38594 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38595 called. It is expanded when the message has been received. At this point,
38596 the expansion variable &%$dkim_signers%& already contains a colon-separated
38597 list of signer domains and identities for the message. When
38598 &%dkim_verify_signers%& is not specified in the main configuration,
38599 it defaults as:
38600 .code
38601 dkim_verify_signers = $dkim_signers
38602 .endd
38603 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38604 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38605 call the ACL for known domains or identities. This would be achieved as follows:
38606 .code
38607 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38608 .endd
38609 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38610 and "ebay.com", plus all domains and identities that have signatures in the message.
38611 You can also be more creative in constructing your policy. For example:
38612 .code
38613 dkim_verify_signers = $sender_address_domain:$dkim_signers
38614 .endd
38615
38616 If a domain or identity is listed several times in the (expanded) value of
38617 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38618
38619
38620 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38621 available (from most to least important):
38622
38623
38624 .vlist
38625 .vitem &%$dkim_cur_signer%&
38626 The signer that is being evaluated in this ACL run. This can be a domain or
38627 an identity. This is one of the list items from the expanded main option
38628 &%dkim_verify_signers%& (see above).
38629
38630 .vitem &%$dkim_verify_status%&
38631 A string describing the general status of the signature. One of
38632 .ilist
38633 &%none%&: There is no signature in the message for the current domain or
38634 identity (as reflected by &%$dkim_cur_signer%&).
38635 .next
38636 &%invalid%&: The signature could not be verified due to a processing error.
38637 More detail is available in &%$dkim_verify_reason%&.
38638 .next
38639 &%fail%&: Verification of the signature failed.  More detail is
38640 available in &%$dkim_verify_reason%&.
38641 .next
38642 &%pass%&: The signature passed verification. It is valid.
38643 .endlist
38644
38645 .vitem &%$dkim_verify_reason%&
38646 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38647 "fail" or "invalid". One of
38648 .ilist
38649 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38650 key for the domain could not be retrieved. This may be a temporary problem.
38651 .next
38652 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38653 record for the domain is syntactically invalid.
38654 .next
38655 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38656 body hash does not match the one specified in the signature header. This
38657 means that the message body was modified in transit.
38658 .next
38659 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38660 could not be verified. This may mean that headers were modified,
38661 re-written or otherwise changed in a way which is incompatible with
38662 DKIM verification. It may of course also mean that the signature is forged.
38663 .endlist
38664
38665 .vitem &%$dkim_domain%&
38666 The signing domain. IMPORTANT: This variable is only populated if there is
38667 an actual signature in the message for the current domain or identity (as
38668 reflected by &%$dkim_cur_signer%&).
38669
38670 .vitem &%$dkim_identity%&
38671 The signing identity, if present. IMPORTANT: This variable is only populated
38672 if there is an actual signature in the message for the current domain or
38673 identity (as reflected by &%$dkim_cur_signer%&).
38674
38675 .vitem &%$dkim_selector%&
38676 The key record selector string.
38677
38678 .vitem &%$dkim_algo%&
38679 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38680
38681 .vitem &%$dkim_canon_body%&
38682 The body canonicalization method. One of 'relaxed' or 'simple'.
38683
38684 .vitem &%$dkim_canon_headers%&
38685 The header canonicalization method. One of 'relaxed' or 'simple'.
38686
38687 .vitem &%$dkim_copiedheaders%&
38688 A transcript of headers and their values which are included in the signature
38689 (copied from the 'z=' tag of the signature).
38690 Note that RFC6376 requires that verification fail if the From: header is
38691 not included in the signature.  Exim does not enforce this; sites wishing
38692 strict enforcement should code the check explicitly.
38693
38694 .vitem &%$dkim_bodylength%&
38695 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38696 limit was set by the signer, "9999999999999" is returned. This makes sure
38697 that this variable always expands to an integer value.
38698
38699 .vitem &%$dkim_created%&
38700 UNIX timestamp reflecting the date and time when the signature was created.
38701 When this was not specified by the signer, "0" is returned.
38702
38703 .vitem &%$dkim_expires%&
38704 UNIX timestamp reflecting the date and time when the signer wants the
38705 signature to be treated as "expired". When this was not specified by the
38706 signer, "9999999999999" is returned. This makes it possible to do useful
38707 integer size comparisons against this value.
38708
38709 .vitem &%$dkim_headernames%&
38710 A colon-separated list of names of headers included in the signature.
38711
38712 .vitem &%$dkim_key_testing%&
38713 "1" if the key record has the "testing" flag set, "0" if not.
38714
38715 .vitem &%$dkim_key_nosubdomains%&
38716 "1" if the key record forbids subdomaining, "0" otherwise.
38717
38718 .vitem &%$dkim_key_srvtype%&
38719 Service type (tag s=) from the key record. Defaults to "*" if not specified
38720 in the key record.
38721
38722 .vitem &%$dkim_key_granularity%&
38723 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38724 in the key record.
38725
38726 .vitem &%$dkim_key_notes%&
38727 Notes from the key record (tag n=).
38728
38729 .vitem &%$dkim_key_length%&
38730 Number of bits in the key.
38731 .endlist
38732
38733 In addition, two ACL conditions are provided:
38734
38735 .vlist
38736 .vitem &%dkim_signers%&
38737 ACL condition that checks a colon-separated list of domains or identities
38738 for a match against the domain or identity that the ACL is currently verifying
38739 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38740 verb to a group of domains or identities. For example:
38741
38742 .code
38743 # Warn when Mail purportedly from GMail has no gmail signature
38744 warn log_message = GMail sender without gmail.com DKIM signature
38745      sender_domains = gmail.com
38746      dkim_signers = gmail.com
38747      dkim_status = none
38748 .endd
38749
38750 Note that the above does not check for a total lack of DKIM signing;
38751 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
38752
38753 .vitem &%dkim_status%&
38754 ACL condition that checks a colon-separated list of possible DKIM verification
38755 results against the actual result of verification. This is typically used
38756 to restrict an ACL verb to a list of verification outcomes, for example:
38757
38758 .code
38759 deny message = Mail from Paypal with invalid/missing signature
38760      sender_domains = paypal.com:paypal.de
38761      dkim_signers = paypal.com:paypal.de
38762      dkim_status = none:invalid:fail
38763 .endd
38764
38765 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38766 see the documentation of the &%$dkim_verify_status%& expansion variable above
38767 for more information of what they mean.
38768 .endlist
38769
38770 . ////////////////////////////////////////////////////////////////////////////
38771 . ////////////////////////////////////////////////////////////////////////////
38772
38773 .chapter "Proxies" "CHAPproxies" &&&
38774          "Proxy support"
38775 .cindex "proxy support"
38776 .cindex "proxy" "access via"
38777
38778 A proxy is an intermediate system through which communication is passed.
38779 Proxies may provide a security, availability or load-distribution function.
38780
38781
38782 .section "Inbound proxies" SECTproxyInbound
38783 .cindex proxy inbound
38784 .cindex proxy "server side"
38785 .cindex proxy "Proxy protocol"
38786 .cindex "Proxy protocol" proxy
38787
38788 Exim has support for receiving inbound SMTP connections via a proxy
38789 that uses &"Proxy Protocol"& to speak to it.
38790 To include this support, include &"SUPPORT_PROXY=yes"&
38791 in Local/Makefile.
38792
38793 It was built on specifications from:
38794 (&url(http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt)).
38795 That URL was revised in May 2014 to version 2 spec:
38796 (&url(http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e)).
38797
38798 The purpose of this facility is so that an application load balancer,
38799 such as HAProxy, can sit in front of several Exim servers
38800 to distribute load.
38801 Exim uses the local protocol communication with the proxy to obtain
38802 the remote SMTP system IP address and port information.
38803 There is no logging if a host passes or
38804 fails Proxy Protocol negotiation, but it can easily be determined and
38805 recorded in an ACL (example is below).
38806
38807 Use of a proxy is enabled by setting the &%hosts_proxy%&
38808 main configuration option to a hostlist; connections from these
38809 hosts will use Proxy Protocol.
38810 Exim supports both version 1 and version 2 of the Proxy Protocol and
38811 automatically determines which version is in use.
38812
38813 The Proxy Protocol header is the first data received on a TCP connection
38814 and is inserted before any TLS-on-connect handshake from the client; Exim
38815 negotiates TLS between Exim-as-server and the remote client, not between
38816 Exim and the proxy server.
38817
38818 The following expansion variables are usable
38819 (&"internal"& and &"external"& here refer to the interfaces
38820 of the proxy):
38821 .display
38822 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38823 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38824 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
38825 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
38826 &'proxy_session            '& boolean: SMTP connection via proxy
38827 .endd
38828 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38829 there was a protocol error.
38830
38831 Since the real connections are all coming from the proxy, and the
38832 per host connection tracking is done before Proxy Protocol is
38833 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38834 handle all of the parallel volume you expect per inbound proxy.
38835 With the option set so high, you lose the ability
38836 to protect your server from many connections from one IP.
38837 In order to prevent your server from overload, you
38838 need to add a per connection ratelimit to your connect ACL.
38839 A possible solution is:
38840 .display
38841   # Set max number of connections per host
38842   LIMIT   = 5
38843   # Or do some kind of IP lookup in a flat file or database
38844   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38845
38846   defer   message        = Too many connections from this IP right now
38847           ratelimit      = LIMIT / 5s / per_conn / strict
38848 .endd
38849
38850
38851
38852 .section "Outbound proxies" SECTproxySOCKS
38853 .cindex proxy outbound
38854 .cindex proxy "client side"
38855 .cindex proxy SOCKS
38856 .cindex SOCKS proxy
38857 Exim has support for sending outbound SMTP via a proxy
38858 using a protocol called SOCKS5 (defined by RFC1928).
38859 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38860 Local/Makefile.
38861
38862 Use of a proxy is enabled by setting the &%socks_proxy%& option
38863 on an smtp transport.
38864 The option value is expanded and should then be a list
38865 (colon-separated by default) of proxy specifiers.
38866 Each proxy specifier is a list
38867 (space-separated by default) where the initial element
38868 is an IP address and any subsequent elements are options.
38869
38870 Options are a string <name>=<value>.
38871 The list of options is in the following table:
38872 .display
38873 &'auth   '& authentication method
38874 &'name   '& authentication username
38875 &'pass   '& authentication password
38876 &'port   '& tcp port
38877 &'tmo    '& connection timeout
38878 &'pri    '& priority
38879 &'weight '& selection bias
38880 .endd
38881
38882 More details on each of these options follows:
38883
38884 .ilist
38885 .cindex authentication "to proxy"
38886 .cindex proxy authentication
38887 &%auth%&: Either &"none"& (default) or &"name"&.
38888 Using &"name"& selects username/password authentication per RFC 1929
38889 for access to the proxy.
38890 Default is &"none"&.
38891 .next
38892 &%name%&: sets the username for the &"name"& authentication method.
38893 Default is empty.
38894 .next
38895 &%pass%&: sets the password for the &"name"& authentication method.
38896 Default is empty.
38897 .next
38898 &%port%&: the TCP port number to use for the connection to the proxy.
38899 Default is 1080.
38900 .next
38901 &%tmo%&: sets a connection timeout in seconds for this proxy.
38902 Default is 5.
38903 .next
38904 &%pri%&: specifies a priority for the proxy within the list,
38905 higher values being tried first.
38906 The default priority is 1.
38907 .next
38908 &%weight%&: specifies a selection bias.
38909 Within a priority set servers are queried in a random fashion,
38910 weighted by this value.
38911 The default value for selection bias is 1.
38912 .endlist
38913
38914 Proxies from the list are tried according to their priority
38915 and weight settings until one responds.  The timeout for the
38916 overall connection applies to the set of proxied attempts.
38917
38918 .section Logging SECTproxyLog
38919 To log the (local) IP of a proxy in the incoming or delivery logline,
38920 add &"+proxy"& to the &%log_selector%& option.
38921 This will add a component tagged with &"PRX="& to the line.
38922
38923 . ////////////////////////////////////////////////////////////////////////////
38924 . ////////////////////////////////////////////////////////////////////////////
38925
38926 .chapter "Internationalisation" "CHAPi18n" &&&
38927          "Internationalisation""
38928 .cindex internationalisation "email address"
38929 .cindex EAI
38930 .cindex i18n
38931 .cindex UTF-8 "mail name handling"
38932
38933 Exim has support for Internationalised mail names.
38934 To include this it must be built with SUPPORT_I18N and the libidn library.
38935 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38936
38937 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
38938 instead of it) then IDNA2008 is supported; this adds an extra library
38939 requirement, upon libidn2.
38940
38941 .section "MTA operations" SECTi18nMTA
38942 .cindex SMTPUTF8 "ESMTP option"
38943 The main configuration option &%smtputf8_advertise_hosts%& specifies
38944 a host list.  If this matches the sending host and
38945 accept_8bitmime is true (the default) then the ESMTP option
38946 SMTPUTF8 will be advertised.
38947
38948 If the sender specifies the SMTPUTF8 option on a MAIL command
38949 international handling for the message is enabled and
38950 the expansion variable &$message_smtputf8$& will have value TRUE.
38951
38952 The option &%allow_utf8_domains%& is set to true for this
38953 message. All DNS lookups are converted to a-label form
38954 whatever the setting of &%allow_utf8_domains%&
38955 when Exim is built with SUPPORT_I18N.
38956
38957 Both localparts and domain are maintained as the original
38958 UTF-8 form internally; any comparison or regular-expression use will
38959 require appropriate care.  Filenames created, eg. by
38960 the appendfile transport, will have UTF-8 names.
38961
38962 HELO names sent by the smtp transport will have any UTF-8
38963 components expanded to a-label form,
38964 and any certificate name checks will be done using the a-label
38965 form of the name.
38966
38967 .cindex log protocol
38968 .cindex SMTPUTF8 logging
38969 Log lines and Received-by: header lines will acquire a "utf8"
38970 prefix on the protocol element, eg. utf8esmtp.
38971
38972 The following expansion operators can be used:
38973 .code
38974 ${utf8_domain_to_alabel:str}
38975 ${utf8_domain_from_alabel:str}
38976 ${utf8_localpart_to_alabel:str}
38977 ${utf8_localpart_from_alabel:str}
38978 .endd
38979
38980 ACLs may use the following modifier:
38981 .display
38982 control = utf8_downconvert
38983 control = utf8_downconvert/<value>
38984 .endd
38985 This sets a flag requiring that addresses are converted to
38986 a-label form before smtp delivery, for use in a
38987 Message Submission Agent context.
38988 If a value is appended it may be:
38989 .display
38990 &`1  `& (default) mandatory downconversion
38991 &`0  `& no downconversion
38992 &`-1 `& if SMTPUTF8 not supported by destination host
38993 .endd
38994
38995 If mua_wrapper is set, the utf8_downconvert control
38996 is initially set to -1.
38997
38998
38999 There is no explicit support for VRFY and EXPN.
39000 Configurations supporting these should inspect
39001 &$smtp_command_argument$& for an SMTPUTF8 argument.
39002
39003 There is no support for LMTP on Unix sockets.
39004 Using the "lmtp" protocol option on an smtp transport,
39005 for LMTP over TCP, should work as expected.
39006
39007 There is no support for DSN unitext handling,
39008 and no provision for converting logging from or to UTF-8.
39009
39010
39011
39012 .section "MDA operations" SECTi18nMDA
39013 To aid in constructing names suitable for IMAP folders
39014 the following expansion operator can be used:
39015 .code
39016 ${imapfolder {<string>} {<sep>} {<specials>}}
39017 .endd
39018
39019 The string is converted from the charset specified by
39020 the "headers charset" command (in a filter file)
39021 or &%headers_charset%& main configuration option (otherwise),
39022 to the
39023 modified UTF-7 encoding specified by RFC 2060,
39024 with the following exception: All occurences of <sep>
39025 (which has to be a single character)
39026 are replaced with periods ("."), and all periods and slashes that are not
39027 <sep> and are not in the <specials> string are BASE64 encoded.
39028
39029 The third argument can be omitted, defaulting to an empty string.
39030 The second argument can be omitted, defaulting to "/".
39031
39032 This is the encoding used by Courier for Maildir names on disk, and followed
39033 by many other IMAP servers.
39034
39035 Examples:
39036 .display
39037 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
39038 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
39039 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
39040 .endd
39041
39042 Note that the source charset setting is vital, and also that characters
39043 must be representable in UTF-16.
39044
39045
39046 . ////////////////////////////////////////////////////////////////////////////
39047 . ////////////////////////////////////////////////////////////////////////////
39048
39049 .chapter "Events" "CHAPevents" &&&
39050          "Events"
39051 .cindex events
39052
39053 The events mechanism in Exim can be used to intercept processing at a number
39054 of points.  It was originally invented to give a way to do customised logging
39055 actions (for example, to a database) but can also be used to modify some
39056 processing actions.
39057
39058 Most installations will never need to use Events.
39059 The support can be left out of a build by defining DISABLE_EVENT=yes
39060 in &_Local/Makefile_&.
39061
39062 There are two major classes of events: main and transport.
39063 The main configuration option &%event_action%& controls reception events;
39064 a transport option &%event_action%& controls delivery events.
39065
39066 Both options are a string which is expanded when the event fires.
39067 An example might look like:
39068 .cindex logging custom
39069 .code
39070 event_action = ${if eq {msg:delivery}{$event_name} \
39071 {${lookup pgsql {SELECT * FROM record_Delivery( \
39072     '${quote_pgsql:$sender_address_domain}',\
39073     '${quote_pgsql:${lc:$sender_address_local_part}}', \
39074     '${quote_pgsql:$domain}', \
39075     '${quote_pgsql:${lc:$local_part}}', \
39076     '${quote_pgsql:$host_address}', \
39077     '${quote_pgsql:${lc:$host}}', \
39078     '${quote_pgsql:$message_exim_id}')}} \
39079 } {}}
39080 .endd
39081
39082 Events have names which correspond to the point in process at which they fire.
39083 The name is placed in the variable &$event_name$& and the event action
39084 expansion must check this, as it will be called for every possible event type.
39085
39086 The current list of events is:
39087 .display
39088 &`msg:complete           after    main       `& per message
39089 &`msg:delivery           after    transport  `& per recipient
39090 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
39091 &`msg:rcpt:defer         after    transport  `& per recipient
39092 &`msg:host:defer         after    transport  `& per attempt
39093 &`msg:fail:delivery      after    transport  `& per recipient
39094 &`msg:fail:internal      after    main       `& per recipient
39095 &`tcp:connect            before   transport  `& per connection
39096 &`tcp:close              after    transport  `& per connection
39097 &`tls:cert               before   both       `& per certificate in verification chain
39098 &`smtp:connect           after    transport  `& per connection
39099 .endd
39100 New event types may be added in future.
39101
39102 The event name is a colon-separated list, defining the type of
39103 event in a tree of possibilities.  It may be used as a list
39104 or just matched on as a whole.  There will be no spaces in the name.
39105
39106 The second column in the table above describes whether the event fires
39107 before or after the action is associates with.  Those which fire before
39108 can be used to affect that action (more on this below).
39109
39110 .new
39111 The third column in the table above says what section of the configumration
39112 should define the event action.
39113 .wen
39114
39115 An additional variable, &$event_data$&, is filled with information varying
39116 with the event type:
39117 .display
39118 &`msg:delivery         `& smtp confirmation message
39119 &`msg:rcpt:host:defer  `& error string
39120 &`msg:rcpt:defer       `& error string
39121 &`msg:host:defer       `& error string
39122 &`tls:cert             `& verification chain depth
39123 &`smtp:connect         `& smtp banner
39124 .endd
39125
39126 The :defer events populate one extra variable: &$event_defer_errno$&.
39127
39128 For complex operations an ACL expansion can be used in &%event_action%&
39129 however due to the multiple contexts that Exim operates in during
39130 the course of its processing:
39131 .ilist
39132 variables set in transport events will not be visible outside that
39133 transport call
39134 .next
39135 acl_m variables in a server context are lost on a new connection,
39136 and after smtp helo/ehlo/mail/starttls/rset commands
39137 .endlist
39138 Using an ACL expansion with the logwrite modifier can be
39139 a useful way of writing to the main log.
39140
39141 The expansion of the event_action option should normally
39142 return an empty string.  Should it return anything else the
39143 following will be forced:
39144 .display
39145 &`msg:delivery     `&  (ignored)
39146 &`msg:host:defer   `&  (ignored)
39147 &`msg:fail:delivery`&  (ignored)
39148 &`tcp:connect      `&  do not connect
39149 &`tcp:close        `&  (ignored)
39150 &`tls:cert         `&  refuse verification
39151 &`smtp:connect     `&  close connection
39152 .endd
39153 No other use is made of the result string.
39154
39155 For a tcp:connect event, if the connection is being made to a proxy
39156 then the address and port variables will be that of the proxy and not
39157 the target system.
39158
39159 For tls:cert events, if GnuTLS is in use this will trigger only per
39160 chain element received on the connection.
39161 For OpenSSL it will trigger for every chain element including those
39162 loaded locally.
39163
39164 . ////////////////////////////////////////////////////////////////////////////
39165 . ////////////////////////////////////////////////////////////////////////////
39166
39167 .chapter "Adding new drivers or lookup types" "CHID13" &&&
39168          "Adding drivers or lookups"
39169 .cindex "adding drivers"
39170 .cindex "new drivers, adding"
39171 .cindex "drivers" "adding new"
39172 The following actions have to be taken in order to add a new router, transport,
39173 authenticator, or lookup type to Exim:
39174
39175 .olist
39176 Choose a name for the driver or lookup type that does not conflict with any
39177 existing name; I will use &"newdriver"& in what follows.
39178 .next
39179 Add to &_src/EDITME_& the line:
39180 .display
39181 <&'type'&>&`_NEWDRIVER=yes`&
39182 .endd
39183 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
39184 code is not to be included in the binary by default, comment this line out. You
39185 should also add any relevant comments about the driver or lookup type.
39186 .next
39187 Add to &_src/config.h.defaults_& the line:
39188 .code
39189 #define <type>_NEWDRIVER
39190 .endd
39191 .next
39192 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
39193 and create a table entry as is done for all the other drivers and lookup types.
39194 .next
39195 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
39196 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
39197 Add your &`NEWDRIVER`& to that list.
39198 As long as the dynamic module would be named &_newdriver.so_&, you can use the
39199 simple form that most lookups have.
39200 .next
39201 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
39202 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
39203 driver or lookup type and add it to the definition of OBJ.
39204 .next
39205 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
39206 &_src_&.
39207 .next
39208 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
39209 as for other drivers and lookups.
39210 .endlist
39211
39212 Then all you need to do is write the code! A good way to start is to make a
39213 proforma by copying an existing module of the same type, globally changing all
39214 occurrences of the name, and cutting out most of the code. Note that any
39215 options you create must be listed in alphabetical order, because the tables are
39216 searched using a binary chop procedure.
39217
39218 There is a &_README_& file in each of the sub-directories of &_src_& describing
39219 the interface that is expected.
39220
39221
39222
39223
39224 . ////////////////////////////////////////////////////////////////////////////
39225 . ////////////////////////////////////////////////////////////////////////////
39226
39227 . /////////////////////////////////////////////////////////////////////////////
39228 . These lines are processing instructions for the Simple DocBook Processor that
39229 . Philip Hazel has developed as a less cumbersome way of making PostScript and
39230 . PDFs than using xmlto and fop. They will be ignored by all other XML
39231 . processors.
39232 . /////////////////////////////////////////////////////////////////////////////
39233
39234 .literal xml
39235 <?sdop
39236   format="newpage"
39237   foot_right_recto="&chaptertitle;"
39238   foot_right_verso="&chaptertitle;"
39239 ?>
39240 .literal off
39241
39242 .makeindex "Options index"   "option"
39243 .makeindex "Variables index" "variable"
39244 .makeindex "Concept index"   "concept"
39245
39246
39247 . /////////////////////////////////////////////////////////////////////////////
39248 . /////////////////////////////////////////////////////////////////////////////