925b96324bd4d8c373376523e91f7fe683fa71d4
[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(http://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 "Exim training" "SECID4"
497 .cindex "training courses"
498 Training courses in Cambridge (UK) used to be run annually by the author of
499 Exim, before he retired. At the time of writing, there are no plans to run
500 further Exim courses in Cambridge. However, if that changes, relevant
501 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
502
503 .section "Bug reports" "SECID5"
504 .cindex "bug reports"
505 .cindex "reporting bugs"
506 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
507 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
508 whether some behaviour is a bug or not, the best thing to do is to post a
509 message to the &'exim-dev'& mailing list and have it discussed.
510
511
512
513 .section "Where to find the Exim distribution" "SECTavail"
514 .cindex "FTP site"
515 .cindex "distribution" "ftp site"
516 The master ftp site for the Exim distribution is
517 .display
518 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
519 .endd
520 This is mirrored by
521 .display
522 &*ftp://ftp.exim.org/pub/exim*&
523 .endd
524 The file references that follow are relative to the &_exim_& directories at
525 these sites. There are now quite a number of independent mirror sites around
526 the world. Those that I know about are listed in the file called &_Mirrors_&.
527
528 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
529 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
530 distributions), and &_Testing_& for testing versions. In the &_exim4_&
531 subdirectory, the current release can always be found in files called
532 .display
533 &_exim-n.nn.tar.gz_&
534 &_exim-n.nn.tar.bz2_&
535 .endd
536 where &'n.nn'& is the highest such version number in the directory. The two
537 files contain identical data; the only difference is the type of compression.
538 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
539
540 .cindex "distribution" "signing details"
541 .cindex "distribution" "public key"
542 .cindex "public key for signed distribution"
543 The distributions will be PGP signed by an individual key of the Release
544 Coordinator.  This key will have a uid containing an email address in the
545 &'exim.org'& domain and will have signatures from other people, including
546 other Exim maintainers.  We expect that the key will be in the "strong set" of
547 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
548 PGP key, a version of which can be found in the release directory in the file
549 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
550 such as &'pool.sks-keyservers.net'&.
551
552 At time of last update, releases were being made by Phil Pennock and signed with
553 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
554 A trust path from Nigel's key to Phil's can be observed at
555 &url(https://www.security.spodhuis.org/exim-trustpath).
556
557 Releases have also been authorized to be performed by Todd Lyons who signs with
558 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
559 Pennock and Todd Lyons through a common associate.
560
561 The signatures for the tar bundles are in:
562 .display
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made separately available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Run time configuration" "SECID7"
625 Exim's run time configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages on the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message, and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery,
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages on its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific licence requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk, and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct file names, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is so-called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender address
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1078 (either over TCP/IP, or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients, or the entire message, can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example, when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to any frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator, and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or the program crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Run time options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the run time configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specially by the local host. These
1237 are typically addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program, unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport, or generates one or more &"child"& addresses. Processing the
1295 original address ceases,
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports, and discards any duplicates that it finds. During this
1353 check, local parts are treated as case-sensitive. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1368 the local parts handled by the router may or must have certain prefixes and/or
1369 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1370 skipped. These conditions are tested first. When an affix is present, it is
1371 removed from the local part before further processing, including the evaluation
1372 of any other conditions.
1373 .next
1374 Routers can be designated for use only when not verifying an address, that is,
1375 only when routing it for delivery (or testing its delivery routing). If the
1376 &%verify%& option is set false, the router is skipped when Exim is verifying an
1377 address.
1378 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1379 &%verify_recipient%&, which independently control the use of the router for
1380 sender and recipient verification. You can set these options directly if
1381 you want a router to be used for only one type of verification.
1382 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1383 .next
1384 If the &%address_test%& option is set false, the router is skipped when Exim is
1385 run with the &%-bt%& option to test an address routing. This can be helpful
1386 when the first router sends all new messages to a scanner of some sort; it
1387 makes it possible to use &%-bt%& to test subsequent delivery routing without
1388 having to simulate the effect of the scanner.
1389 .next
1390 Routers can be designated for use only when verifying an address, as
1391 opposed to routing it for delivery. The &%verify_only%& option controls this.
1392 Again, cutthrough delivery counts as a verification.
1393 .next
1394 Individual routers can be explicitly skipped when running the routers to
1395 check an address given in the SMTP EXPN command (see the &%expn%& option).
1396 .next
1397 If the &%domains%& option is set, the domain of the address must be in the set
1398 of domains that it defines.
1399 .next
1400 .vindex "&$local_part_prefix$&"
1401 .vindex "&$local_part$&"
1402 .vindex "&$local_part_suffix$&"
1403 If the &%local_parts%& option is set, the local part of the address must be in
1404 the set of local parts that it defines. If &%local_part_prefix%& or
1405 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1406 part before this check. If you want to do precondition tests on local parts
1407 that include affixes, you can do so by using a &%condition%& option (see below)
1408 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1409 &$local_part_suffix$& as necessary.
1410 .next
1411 .vindex "&$local_user_uid$&"
1412 .vindex "&$local_user_gid$&"
1413 .vindex "&$home$&"
1414 If the &%check_local_user%& option is set, the local part must be the name of
1415 an account on the local host. If this check succeeds, the uid and gid of the
1416 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1417 user's home directory is placed in &$home$&; these values can be used in the
1418 remaining preconditions.
1419 .next
1420 If the &%router_home_directory%& option is set, it is expanded at this point,
1421 because it overrides the value of &$home$&. If this expansion were left till
1422 later, the value of &$home$& as set by &%check_local_user%& would be used in
1423 subsequent tests. Having two different values of &$home$& in the same router
1424 could lead to confusion.
1425 .next
1426 If the &%senders%& option is set, the envelope sender address must be in the
1427 set of addresses that it defines.
1428 .next
1429 If the &%require_files%& option is set, the existence or non-existence of
1430 specified files is tested.
1431 .next
1432 .cindex "customizing" "precondition"
1433 If the &%condition%& option is set, it is evaluated and tested. This option
1434 uses an expanded string to allow you to set up your own custom preconditions.
1435 Expanded strings are described in chapter &<<CHAPexpand>>&.
1436 .endlist
1437
1438
1439 Note that &%require_files%& comes near the end of the list, so you cannot use
1440 it to check for the existence of a file in which to lookup up a domain, local
1441 part, or sender. However, as these options are all expanded, you can use the
1442 &%exists%& expansion condition to make such tests within each condition. The
1443 &%require_files%& option is intended for checking files that the router may be
1444 going to use internally, or which are needed by a specific transport (for
1445 example, &_.procmailrc_&).
1446
1447
1448
1449 .section "Delivery in detail" "SECID18"
1450 .cindex "delivery" "in detail"
1451 When a message is to be delivered, the sequence of events is as follows:
1452
1453 .ilist
1454 If a system-wide filter file is specified, the message is passed to it. The
1455 filter may add recipients to the message, replace the recipients, discard the
1456 message, cause a new message to be generated, or cause the message delivery to
1457 fail. The format of the system filter file is the same as for Exim user filter
1458 files, described in the separate document entitled &'Exim's interfaces to mail
1459 filtering'&.
1460 .cindex "Sieve filter" "not available for system filter"
1461 (&*Note*&: Sieve cannot be used for system filter files.)
1462
1463 Some additional features are available in system filters &-- see chapter
1464 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1465 filter only once per delivery attempt, however many recipients it has. However,
1466 if there are several delivery attempts because one or more addresses could not
1467 be immediately delivered, the system filter is run each time. The filter
1468 condition &%first_delivery%& can be used to detect the first run of the system
1469 filter.
1470 .next
1471 Each recipient address is offered to each configured router in turn, subject to
1472 its preconditions, until one is able to handle it. If no router can handle the
1473 address, that is, if they all decline, the address is failed. Because routers
1474 can be targeted at particular domains, several locally handled domains can be
1475 processed entirely independently of each other.
1476 .next
1477 .cindex "routing" "loops in"
1478 .cindex "loop" "while routing"
1479 A router that accepts an address may assign it to a local or a remote
1480 transport. However, the transport is not run at this time. Instead, the address
1481 is placed on a list for the particular transport, which will be run later.
1482 Alternatively, the router may generate one or more new addresses (typically
1483 from alias, forward, or filter files). New addresses are fed back into this
1484 process from the top, but in order to avoid loops, a router ignores any address
1485 which has an identically-named ancestor that was processed by itself.
1486 .next
1487 When all the routing has been done, addresses that have been successfully
1488 handled are passed to their assigned transports. When local transports are
1489 doing real local deliveries, they handle only one address at a time, but if a
1490 local transport is being used as a pseudo-remote transport (for example, to
1491 collect batched SMTP messages for transmission by some other means) multiple
1492 addresses can be handled. Remote transports can always handle more than one
1493 address at a time, but can be configured not to do so, or to restrict multiple
1494 addresses to the same domain.
1495 .next
1496 Each local delivery to a file or a pipe runs in a separate process under a
1497 non-privileged uid, and these deliveries are run one at a time. Remote
1498 deliveries also run in separate processes, normally under a uid that is private
1499 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1500 run in parallel. The maximum number of simultaneous remote deliveries for any
1501 one message is set by the &%remote_max_parallel%& option.
1502 The order in which deliveries are done is not defined, except that all local
1503 deliveries happen before any remote deliveries.
1504 .next
1505 .cindex "queue runner"
1506 When it encounters a local delivery during a queue run, Exim checks its retry
1507 database to see if there has been a previous temporary delivery failure for the
1508 address before running the local transport. If there was a previous failure,
1509 Exim does not attempt a new delivery until the retry time for the address is
1510 reached. However, this happens only for delivery attempts that are part of a
1511 queue run. Local deliveries are always attempted when delivery immediately
1512 follows message reception, even if retry times are set for them. This makes for
1513 better behaviour if one particular message is causing problems (for example,
1514 causing quota overflow, or provoking an error in a filter file).
1515 .next
1516 .cindex "delivery" "retry in remote transports"
1517 Remote transports do their own retry handling, since an address may be
1518 deliverable to one of a number of hosts, each of which may have a different
1519 retry time. If there have been previous temporary failures and no host has
1520 reached its retry time, no delivery is attempted, whether in a queue run or
1521 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1522 .next
1523 If there were any permanent errors, a bounce message is returned to an
1524 appropriate address (the sender in the common case), with details of the error
1525 for each failing address. Exim can be configured to send copies of bounce
1526 messages to other addresses.
1527 .next
1528 .cindex "delivery" "deferral"
1529 If one or more addresses suffered a temporary failure, the message is left on
1530 the queue, to be tried again later. Delivery of these addresses is said to be
1531 &'deferred'&.
1532 .next
1533 When all the recipient addresses have either been delivered or bounced,
1534 handling of the message is complete. The spool files and message log are
1535 deleted, though the message log can optionally be preserved if required.
1536 .endlist
1537
1538
1539
1540
1541 .section "Retry mechanism" "SECID19"
1542 .cindex "delivery" "retry mechanism"
1543 .cindex "retry" "description of mechanism"
1544 .cindex "queue runner"
1545 Exim's mechanism for retrying messages that fail to get delivered at the first
1546 attempt is the queue runner process. You must either run an Exim daemon that
1547 uses the &%-q%& option with a time interval to start queue runners at regular
1548 intervals, or use some other means (such as &'cron'&) to start them. If you do
1549 not arrange for queue runners to be run, messages that fail temporarily at the
1550 first attempt will remain on your queue for ever. A queue runner process works
1551 its way through the queue, one message at a time, trying each delivery that has
1552 passed its retry time.
1553 You can run several queue runners at once.
1554
1555 Exim uses a set of configured rules to determine when next to retry the failing
1556 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1557 should give up trying to deliver to the address, at which point it generates a
1558 bounce message. If no retry rules are set for a particular host, address, and
1559 error combination, no retries are attempted, and temporary errors are treated
1560 as permanent.
1561
1562
1563
1564 .section "Temporary delivery failure" "SECID20"
1565 .cindex "delivery" "temporary failure"
1566 There are many reasons why a message may not be immediately deliverable to a
1567 particular address. Failure to connect to a remote machine (because it, or the
1568 connection to it, is down) is one of the most common. Temporary failures may be
1569 detected during routing as well as during the transport stage of delivery.
1570 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1571 is on a file system where the user is over quota. Exim can be configured to
1572 impose its own quotas on local mailboxes; where system quotas are set they will
1573 also apply.
1574
1575 If a host is unreachable for a period of time, a number of messages may be
1576 waiting for it by the time it recovers, and sending them in a single SMTP
1577 connection is clearly beneficial. Whenever a delivery to a remote host is
1578 deferred,
1579 .cindex "hints database" "deferred deliveries"
1580 Exim makes a note in its hints database, and whenever a successful
1581 SMTP delivery has happened, it looks to see if any other messages are waiting
1582 for the same host. If any are found, they are sent over the same SMTP
1583 connection, subject to a configuration limit as to the maximum number in any
1584 one connection.
1585
1586
1587
1588 .section "Permanent delivery failure" "SECID21"
1589 .cindex "delivery" "permanent failure"
1590 .cindex "bounce message" "when generated"
1591 When a message cannot be delivered to some or all of its intended recipients, a
1592 bounce message is generated. Temporary delivery failures turn into permanent
1593 errors when their timeout expires. All the addresses that fail in a given
1594 delivery attempt are listed in a single message. If the original message has
1595 many recipients, it is possible for some addresses to fail in one delivery
1596 attempt and others to fail subsequently, giving rise to more than one bounce
1597 message. The wording of bounce messages can be customized by the administrator.
1598 See chapter &<<CHAPemsgcust>>& for details.
1599
1600 .cindex "&'X-Failed-Recipients:'& header line"
1601 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1602 failed addresses, for the benefit of programs that try to analyse such messages
1603 automatically.
1604
1605 .cindex "bounce message" "recipient of"
1606 A bounce message is normally sent to the sender of the original message, as
1607 obtained from the message's envelope. For incoming SMTP messages, this is the
1608 address given in the MAIL command. However, when an address is expanded via a
1609 forward or alias file, an alternative address can be specified for delivery
1610 failures of the generated addresses. For a mailing list expansion (see section
1611 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1612 of the list.
1613
1614
1615
1616 .section "Failures to deliver bounce messages" "SECID22"
1617 .cindex "bounce message" "failure to deliver"
1618 If a bounce message (either locally generated or received from a remote host)
1619 itself suffers a permanent delivery failure, the message is left on the queue,
1620 but it is frozen, awaiting the attention of an administrator. There are options
1621 that can be used to make Exim discard such failed messages, or to keep them
1622 for only a short time (see &%timeout_frozen_after%& and
1623 &%ignore_bounce_errors_after%&).
1624
1625
1626
1627
1628
1629 . ////////////////////////////////////////////////////////////////////////////
1630 . ////////////////////////////////////////////////////////////////////////////
1631
1632 .chapter "Building and installing Exim" "CHID3"
1633 .scindex IIDbuex "building Exim"
1634
1635 .section "Unpacking" "SECID23"
1636 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1637 creates a directory with the name of the current release (for example,
1638 &_exim-&version()_&) into which the following files are placed:
1639
1640 .table2 140pt
1641 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1642 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1643   documented"
1644 .irow &_LICENCE_&         "the GNU General Public Licence"
1645 .irow &_Makefile_&        "top-level make file"
1646 .irow &_NOTICE_&          "conditions for the use of Exim"
1647 .irow &_README_&          "list of files, directories and simple build &&&
1648   instructions"
1649 .endtable
1650
1651 Other files whose names begin with &_README_& may also be present. The
1652 following subdirectories are created:
1653
1654 .table2 140pt
1655 .irow &_Local_&           "an empty directory for local configuration files"
1656 .irow &_OS_&              "OS-specific files"
1657 .irow &_doc_&             "documentation files"
1658 .irow &_exim_monitor_&    "source files for the Exim monitor"
1659 .irow &_scripts_&         "scripts used in the build process"
1660 .irow &_src_&             "remaining source files"
1661 .irow &_util_&            "independent utilities"
1662 .endtable
1663
1664 The main utility programs are contained in the &_src_& directory, and are built
1665 with the Exim binary. The &_util_& directory contains a few optional scripts
1666 that may be useful to some sites.
1667
1668
1669 .section "Multiple machine architectures and operating systems" "SECID24"
1670 .cindex "building Exim" "multiple OS/architectures"
1671 The building process for Exim is arranged to make it easy to build binaries for
1672 a number of different architectures and operating systems from the same set of
1673 source files. Compilation does not take place in the &_src_& directory.
1674 Instead, a &'build directory'& is created for each architecture and operating
1675 system.
1676 .cindex "symbolic link" "to build directory"
1677 Symbolic links to the sources are installed in this directory, which is where
1678 the actual building takes place. In most cases, Exim can discover the machine
1679 architecture and operating system for itself, but the defaults can be
1680 overridden if necessary.
1681
1682
1683 .section "PCRE library" "SECTpcre"
1684 .cindex "PCRE library"
1685 Exim no longer has an embedded PCRE library as the vast majority of
1686 modern systems include PCRE as a system library, although you may need
1687 to install the PCRE or PCRE development package for your operating
1688 system. If your system has a normal PCRE installation the Exim build
1689 process will need no further configuration. If the library or the
1690 headers are in an unusual location you will need to either set the PCRE_LIBS
1691 and INCLUDE directives appropriately,
1692 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1693 If your operating system has no
1694 PCRE support then you will need to obtain and build the current PCRE
1695 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1696 More information on PCRE is available at &url(http://www.pcre.org/).
1697
1698 .section "DBM libraries" "SECTdb"
1699 .cindex "DBM libraries" "discussion of"
1700 .cindex "hints database" "DBM files used for"
1701 Even if you do not use any DBM files in your configuration, Exim still needs a
1702 DBM library in order to operate, because it uses indexed files for its hints
1703 databases. Unfortunately, there are a number of DBM libraries in existence, and
1704 different operating systems often have different ones installed.
1705
1706 .cindex "Solaris" "DBM library for"
1707 .cindex "IRIX, DBM library for"
1708 .cindex "BSD, DBM library for"
1709 .cindex "Linux, DBM library for"
1710 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1711 Linux distribution, the DBM configuration should happen automatically, and you
1712 may be able to ignore this section. Otherwise, you may have to learn more than
1713 you would like about DBM libraries from what follows.
1714
1715 .cindex "&'ndbm'& DBM library"
1716 Licensed versions of Unix normally contain a library of DBM functions operating
1717 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1718 versions of Unix seem to vary in what they contain as standard. In particular,
1719 some early versions of Linux have no default DBM library, and different
1720 distributors have chosen to bundle different libraries with their packaged
1721 versions. However, the more recent releases seem to have standardized on the
1722 Berkeley DB library.
1723
1724 Different DBM libraries have different conventions for naming the files they
1725 use. When a program opens a file called &_dbmfile_&, there are several
1726 possibilities:
1727
1728 .olist
1729 A traditional &'ndbm'& implementation, such as that supplied as part of
1730 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1731 .next
1732 .cindex "&'gdbm'& DBM library"
1733 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1734 compatibility interface it makes two different hard links to it with names
1735 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1736 file name is used unmodified.
1737 .next
1738 .cindex "Berkeley DB library"
1739 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1740 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1741 programmer exactly the same as the traditional &'ndbm'& implementation.
1742 .next
1743 If the Berkeley package is used in its native mode, it operates on a single
1744 file called &_dbmfile_&; the programmer's interface is somewhat different to
1745 the traditional &'ndbm'& interface.
1746 .next
1747 To complicate things further, there are several very different versions of the
1748 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1749 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1750 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1751 versions of Berkeley DB can be obtained from
1752 &url(http://www.sleepycat.com/).
1753 .next
1754 .cindex "&'tdb'& DBM library"
1755 Yet another DBM library, called &'tdb'&, is available from
1756 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1757 operates on a single file.
1758 .endlist
1759
1760 .cindex "USE_DB"
1761 .cindex "DBM libraries" "configuration for building"
1762 Exim and its utilities can be compiled to use any of these interfaces. In order
1763 to use any version of the Berkeley DB package in native mode, you must set
1764 USE_DB in an appropriate configuration file (typically
1765 &_Local/Makefile_&). For example:
1766 .code
1767 USE_DB=yes
1768 .endd
1769 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1770 error is diagnosed if you set more than one of these.
1771
1772 At the lowest level, the build-time configuration sets none of these options,
1773 thereby assuming an interface of type (1). However, some operating system
1774 configuration files (for example, those for the BSD operating systems and
1775 Linux) assume type (4) by setting USE_DB as their default, and the
1776 configuration files for Cygwin set USE_GDBM. Anything you set in
1777 &_Local/Makefile_&, however, overrides these system defaults.
1778
1779 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1780 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1781 in one of these lines:
1782 .code
1783 DBMLIB = -ldb
1784 DBMLIB = -ltdb
1785 .endd
1786 Settings like that will work if the DBM library is installed in the standard
1787 place. Sometimes it is not, and the library's header file may also not be in
1788 the default path. You may need to set INCLUDE to specify where the header
1789 file is, and to specify the path to the library more fully in DBMLIB, as in
1790 this example:
1791 .code
1792 INCLUDE=-I/usr/local/include/db-4.1
1793 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1794 .endd
1795 There is further detailed discussion about the various DBM libraries in the
1796 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1797
1798
1799
1800 .section "Pre-building configuration" "SECID25"
1801 .cindex "building Exim" "pre-building configuration"
1802 .cindex "configuration for building Exim"
1803 .cindex "&_Local/Makefile_&"
1804 .cindex "&_src/EDITME_&"
1805 Before building Exim, a local configuration file that specifies options
1806 independent of any operating system has to be created with the name
1807 &_Local/Makefile_&. A template for this file is supplied as the file
1808 &_src/EDITME_&, and it contains full descriptions of all the option settings
1809 therein. These descriptions are therefore not repeated here. If you are
1810 building Exim for the first time, the simplest thing to do is to copy
1811 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1812
1813 There are three settings that you must supply, because Exim will not build
1814 without them. They are the location of the run time configuration file
1815 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1816 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1817 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1818 a colon-separated list of file names; Exim uses the first of them that exists.
1819
1820 There are a few other parameters that can be specified either at build time or
1821 at run time, to enable the same binary to be used on a number of different
1822 machines. However, if the locations of Exim's spool directory and log file
1823 directory (if not within the spool directory) are fixed, it is recommended that
1824 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1825 detected early in Exim's execution (such as a malformed configuration file) can
1826 be logged.
1827
1828 .cindex "content scanning" "specifying at build time"
1829 Exim's interfaces for calling virus and spam scanning software directly from
1830 access control lists are not compiled by default. If you want to include these
1831 facilities, you need to set
1832 .code
1833 WITH_CONTENT_SCAN=yes
1834 .endd
1835 in your &_Local/Makefile_&. For details of the facilities themselves, see
1836 chapter &<<CHAPexiscan>>&.
1837
1838
1839 .cindex "&_Local/eximon.conf_&"
1840 .cindex "&_exim_monitor/EDITME_&"
1841 If you are going to build the Exim monitor, a similar configuration process is
1842 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1843 your installation and saved under the name &_Local/eximon.conf_&. If you are
1844 happy with the default settings described in &_exim_monitor/EDITME_&,
1845 &_Local/eximon.conf_& can be empty, but it must exist.
1846
1847 This is all the configuration that is needed in straightforward cases for known
1848 operating systems. However, the building process is set up so that it is easy
1849 to override options that are set by default or by operating-system-specific
1850 configuration files, for example to change the name of the C compiler, which
1851 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1852 do this.
1853
1854
1855
1856 .section "Support for iconv()" "SECID26"
1857 .cindex "&[iconv()]& support"
1858 .cindex "RFC 2047"
1859 The contents of header lines in messages may be encoded according to the rules
1860 described RFC 2047. This makes it possible to transmit characters that are not
1861 in the ASCII character set, and to label them as being in a particular
1862 character set. When Exim is inspecting header lines by means of the &%$h_%&
1863 mechanism, it decodes them, and translates them into a specified character set
1864 (default is set at build time). The translation is possible only if the operating system
1865 supports the &[iconv()]& function.
1866
1867 However, some of the operating systems that supply &[iconv()]& do not support
1868 very many conversions. The GNU &%libiconv%& library (available from
1869 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1870 systems to remedy this deficiency, as well as on systems that do not supply
1871 &[iconv()]& at all. After installing &%libiconv%&, you should add
1872 .code
1873 HAVE_ICONV=yes
1874 .endd
1875 to your &_Local/Makefile_& and rebuild Exim.
1876
1877
1878
1879 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1880 .cindex "TLS" "including support for TLS"
1881 .cindex "encryption" "including support for"
1882 .cindex "SUPPORT_TLS"
1883 .cindex "OpenSSL" "building Exim with"
1884 .cindex "GnuTLS" "building Exim with"
1885 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1886 command as per RFC 2487. It can also support legacy clients that expect to
1887 start a TLS session immediately on connection to a non-standard port (see the
1888 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1889 line option).
1890
1891 If you want to build Exim with TLS support, you must first install either the
1892 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1893 implementing SSL.
1894
1895 If OpenSSL is installed, you should set
1896 .code
1897 SUPPORT_TLS=yes
1898 TLS_LIBS=-lssl -lcrypto
1899 .endd
1900 in &_Local/Makefile_&. You may also need to specify the locations of the
1901 OpenSSL library and include files. For example:
1902 .code
1903 SUPPORT_TLS=yes
1904 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1905 TLS_INCLUDE=-I/usr/local/openssl/include/
1906 .endd
1907 .cindex "pkg-config" "OpenSSL"
1908 If you have &'pkg-config'& available, then instead you can just use:
1909 .code
1910 SUPPORT_TLS=yes
1911 USE_OPENSSL_PC=openssl
1912 .endd
1913 .cindex "USE_GNUTLS"
1914 If GnuTLS is installed, you should set
1915 .code
1916 SUPPORT_TLS=yes
1917 USE_GNUTLS=yes
1918 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1919 .endd
1920 in &_Local/Makefile_&, and again you may need to specify the locations of the
1921 library and include files. For example:
1922 .code
1923 SUPPORT_TLS=yes
1924 USE_GNUTLS=yes
1925 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1926 TLS_INCLUDE=-I/usr/gnu/include
1927 .endd
1928 .cindex "pkg-config" "GnuTLS"
1929 If you have &'pkg-config'& available, then instead you can just use:
1930 .code
1931 SUPPORT_TLS=yes
1932 USE_GNUTLS=yes
1933 USE_GNUTLS_PC=gnutls
1934 .endd
1935
1936 You do not need to set TLS_INCLUDE if the relevant directory is already
1937 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1938 given in chapter &<<CHAPTLS>>&.
1939
1940
1941
1942
1943 .section "Use of tcpwrappers" "SECID27"
1944
1945 .cindex "tcpwrappers, building Exim to support"
1946 .cindex "USE_TCP_WRAPPERS"
1947 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1948 .cindex "tcp_wrappers_daemon_name"
1949 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1950 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1951 alternative to Exim's own checking facilities for installations that are
1952 already making use of &'tcpwrappers'& for other purposes. To do this, you
1953 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1954 &_tcpd.h_& to be available at compile time, and also ensure that the library
1955 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1956 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1957 you might have
1958 .code
1959 USE_TCP_WRAPPERS=yes
1960 CFLAGS=-O -I/usr/local/include
1961 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1962 .endd
1963 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1964 files is &"exim"&. For example, the line
1965 .code
1966 exim : LOCAL  192.168.1.  .friendly.domain.example
1967 .endd
1968 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1969 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1970 All other connections are denied. The daemon name used by &'tcpwrappers'&
1971 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1972 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1973 configure file. Consult the &'tcpwrappers'& documentation for
1974 further details.
1975
1976
1977 .section "Including support for IPv6" "SECID28"
1978 .cindex "IPv6" "including support for"
1979 Exim contains code for use on systems that have IPv6 support. Setting
1980 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1981 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1982 where the IPv6 support is not fully integrated into the normal include and
1983 library files.
1984
1985 Two different types of DNS record for handling IPv6 addresses have been
1986 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1987 currently seen as the mainstream. Another record type called A6 was proposed
1988 as better than AAAA because it had more flexibility. However, it was felt to be
1989 over-complex, and its status was reduced to &"experimental"&.
1990 Exim used to
1991 have a compile option for including A6 record support but this has now been
1992 withdrawn.
1993
1994
1995
1996 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1997 .cindex "lookup modules"
1998 .cindex "dynamic modules"
1999 .cindex ".so building"
2000 On some platforms, Exim supports not compiling all lookup types directly into
2001 the main binary, instead putting some into external modules which can be loaded
2002 on demand.
2003 This permits packagers to build Exim with support for lookups with extensive
2004 library dependencies without requiring all users to install all of those
2005 dependencies.
2006 Most, but not all, lookup types can be built this way.
2007
2008 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2009 installed; Exim will only load modules from that directory, as a security
2010 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2011 for your OS; see &_OS/Makefile-Linux_& for an example.
2012 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2013 see &_src/EDITME_& for details.
2014
2015 Then, for each module to be loaded dynamically, define the relevant
2016 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2017 For example, this will build in lsearch but load sqlite and mysql support
2018 on demand:
2019 .code
2020 LOOKUP_LSEARCH=yes
2021 LOOKUP_SQLITE=2
2022 LOOKUP_MYSQL=2
2023 .endd
2024
2025
2026 .section "The building process" "SECID29"
2027 .cindex "build directory"
2028 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2029 created, run &'make'& at the top level. It determines the architecture and
2030 operating system types, and creates a build directory if one does not exist.
2031 For example, on a Sun system running Solaris 8, the directory
2032 &_build-SunOS5-5.8-sparc_& is created.
2033 .cindex "symbolic link" "to source files"
2034 Symbolic links to relevant source files are installed in the build directory.
2035
2036 If this is the first time &'make'& has been run, it calls a script that builds
2037 a make file inside the build directory, using the configuration files from the
2038 &_Local_& directory. The new make file is then passed to another instance of
2039 &'make'&. This does the real work, building a number of utility scripts, and
2040 then compiling and linking the binaries for the Exim monitor (if configured), a
2041 number of utility programs, and finally Exim itself. The command &`make
2042 makefile`& can be used to force a rebuild of the make file in the build
2043 directory, should this ever be necessary.
2044
2045 If you have problems building Exim, check for any comments there may be in the
2046 &_README_& file concerning your operating system, and also take a look at the
2047 FAQ, where some common problems are covered.
2048
2049
2050
2051 .section 'Output from &"make"&' "SECID283"
2052 The output produced by the &'make'& process for compile lines is often very
2053 unreadable, because these lines can be very long. For this reason, the normal
2054 output is suppressed by default, and instead output similar to that which
2055 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2056 each module that is being compiled or linked. However, it is still possible to
2057 get the full output, by calling &'make'& like this:
2058 .code
2059 FULLECHO='' make -e
2060 .endd
2061 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2062 command reflection in &'make'&. When you ask for the full output, it is
2063 given in addition to the short output.
2064
2065
2066
2067 .section "Overriding build-time options for Exim" "SECToverride"
2068 .cindex "build-time options, overriding"
2069 The main make file that is created at the beginning of the building process
2070 consists of the concatenation of a number of files which set configuration
2071 values, followed by a fixed set of &'make'& instructions. If a value is set
2072 more than once, the last setting overrides any previous ones. This provides a
2073 convenient way of overriding defaults. The files that are concatenated are, in
2074 order:
2075 .display
2076 &_OS/Makefile-Default_&
2077 &_OS/Makefile-_&<&'ostype'&>
2078 &_Local/Makefile_&
2079 &_Local/Makefile-_&<&'ostype'&>
2080 &_Local/Makefile-_&<&'archtype'&>
2081 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2082 &_OS/Makefile-Base_&
2083 .endd
2084 .cindex "&_Local/Makefile_&"
2085 .cindex "building Exim" "operating system type"
2086 .cindex "building Exim" "architecture type"
2087 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2088 architecture type. &_Local/Makefile_& is required to exist, and the building
2089 process fails if it is absent. The other three &_Local_& files are optional,
2090 and are often not needed.
2091
2092 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2093 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2094 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2095 values are used, thereby providing a means of forcing particular settings.
2096 Otherwise, the scripts try to get values from the &%uname%& command. If this
2097 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2098 of &'ad hoc'& transformations are then applied, to produce the standard names
2099 that Exim expects. You can run these scripts directly from the shell in order
2100 to find out what values are being used on your system.
2101
2102
2103 &_OS/Makefile-Default_& contains comments about the variables that are set
2104 therein. Some (but not all) are mentioned below. If there is something that
2105 needs changing, review the contents of this file and the contents of the make
2106 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2107 default values are.
2108
2109
2110 .cindex "building Exim" "overriding default settings"
2111 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2112 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2113 need to change the original files. Instead, you should make the changes by
2114 putting the new values in an appropriate &_Local_& file. For example,
2115 .cindex "Tru64-Unix build-time settings"
2116 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2117 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2118 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2119 called with the option &%-std1%&, to make it recognize some of the features of
2120 Standard C that Exim uses. (Most other compilers recognize Standard C by
2121 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2122 containing the lines
2123 .code
2124 CC=cc
2125 CFLAGS=-std1
2126 .endd
2127 If you are compiling for just one operating system, it may be easier to put
2128 these lines directly into &_Local/Makefile_&.
2129
2130 Keeping all your local configuration settings separate from the distributed
2131 files makes it easy to transfer them to new versions of Exim simply by copying
2132 the contents of the &_Local_& directory.
2133
2134
2135 .cindex "NIS lookup type" "including support for"
2136 .cindex "NIS+ lookup type" "including support for"
2137 .cindex "LDAP" "including support for"
2138 .cindex "lookup" "inclusion in binary"
2139 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2140 lookup, but not all systems have these components installed, so the default is
2141 not to include the relevant code in the binary. All the different kinds of file
2142 and database lookup that Exim supports are implemented as separate code modules
2143 which are included only if the relevant compile-time options are set. In the
2144 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2145 .code
2146 LOOKUP_LDAP=yes
2147 LOOKUP_NIS=yes
2148 LOOKUP_NISPLUS=yes
2149 .endd
2150 and similar settings apply to the other lookup types. They are all listed in
2151 &_src/EDITME_&. In many cases the relevant include files and interface
2152 libraries need to be installed before compiling Exim.
2153 .cindex "cdb" "including support for"
2154 However, there are some optional lookup types (such as cdb) for which
2155 the code is entirely contained within Exim, and no external include
2156 files or libraries are required. When a lookup type is not included in the
2157 binary, attempts to configure Exim to use it cause run time configuration
2158 errors.
2159
2160 .cindex "pkg-config" "lookups"
2161 .cindex "pkg-config" "authenticators"
2162 Many systems now use a tool called &'pkg-config'& to encapsulate information
2163 about how to compile against a library; Exim has some initial support for
2164 being able to use pkg-config for lookups and authenticators.  For any given
2165 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2166 variable with the &`_PC`& suffix in the name and assign as the value the
2167 name of the package to be queried.  The results of querying via the
2168 &'pkg-config'& command will be added to the appropriate Makefile variables
2169 with &`+=`& directives, so your version of &'make'& will need to support that
2170 syntax.  For instance:
2171 .code
2172 LOOKUP_SQLITE=yes
2173 LOOKUP_SQLITE_PC=sqlite3
2174 AUTH_GSASL=yes
2175 AUTH_GSASL_PC=libgsasl
2176 AUTH_HEIMDAL_GSSAPI=yes
2177 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2178 .endd
2179
2180 .cindex "Perl" "including support for"
2181 Exim can be linked with an embedded Perl interpreter, allowing Perl
2182 subroutines to be called during string expansion. To enable this facility,
2183 .code
2184 EXIM_PERL=perl.o
2185 .endd
2186 must be defined in &_Local/Makefile_&. Details of this facility are given in
2187 chapter &<<CHAPperl>>&.
2188
2189 .cindex "X11 libraries, location of"
2190 The location of the X11 libraries is something that varies a lot between
2191 operating systems, and there may be different versions of X11 to cope
2192 with. Exim itself makes no use of X11, but if you are compiling the Exim
2193 monitor, the X11 libraries must be available.
2194 The following three variables are set in &_OS/Makefile-Default_&:
2195 .code
2196 X11=/usr/X11R6
2197 XINCLUDE=-I$(X11)/include
2198 XLFLAGS=-L$(X11)/lib
2199 .endd
2200 These are overridden in some of the operating-system configuration files. For
2201 example, in &_OS/Makefile-SunOS5_& there is
2202 .code
2203 X11=/usr/openwin
2204 XINCLUDE=-I$(X11)/include
2205 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2206 .endd
2207 If you need to override the default setting for your operating system, place a
2208 definition of all three of these variables into your
2209 &_Local/Makefile-<ostype>_& file.
2210
2211 .cindex "EXTRALIBS"
2212 If you need to add any extra libraries to the link steps, these can be put in a
2213 variable called EXTRALIBS, which appears in all the link commands, but by
2214 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2215 command for linking the main Exim binary, and not for any associated utilities.
2216
2217 .cindex "DBM libraries" "configuration for building"
2218 There is also DBMLIB, which appears in the link commands for binaries that
2219 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2220 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2221 binary, and which can be used, for example, to include additional X11
2222 libraries.
2223
2224 .cindex "configuration file" "editing"
2225 The make file copes with rebuilding Exim correctly if any of the configuration
2226 files are edited. However, if an optional configuration file is deleted, it is
2227 necessary to touch the associated non-optional file (that is,
2228 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2229
2230
2231 .section "OS-specific header files" "SECID30"
2232 .cindex "&_os.h_&"
2233 .cindex "building Exim" "OS-specific C header files"
2234 The &_OS_& directory contains a number of files with names of the form
2235 &_os.h-<ostype>_&. These are system-specific C header files that should not
2236 normally need to be changed. There is a list of macro settings that are
2237 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2238 are porting Exim to a new operating system.
2239
2240
2241
2242 .section "Overriding build-time options for the monitor" "SECID31"
2243 .cindex "building Eximon"
2244 A similar process is used for overriding things when building the Exim monitor,
2245 where the files that are involved are
2246 .display
2247 &_OS/eximon.conf-Default_&
2248 &_OS/eximon.conf-_&<&'ostype'&>
2249 &_Local/eximon.conf_&
2250 &_Local/eximon.conf-_&<&'ostype'&>
2251 &_Local/eximon.conf-_&<&'archtype'&>
2252 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2253 .endd
2254 .cindex "&_Local/eximon.conf_&"
2255 As with Exim itself, the final three files need not exist, and in this case the
2256 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2257 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2258 variables of the same name, preceded by EXIMON_. For example, setting
2259 EXIMON_LOG_DEPTH in the environment overrides the value of
2260 LOG_DEPTH at run time.
2261 .ecindex IIDbuex
2262
2263
2264 .section "Installing Exim binaries and scripts" "SECID32"
2265 .cindex "installing Exim"
2266 .cindex "BIN_DIRECTORY"
2267 The command &`make install`& runs the &(exim_install)& script with no
2268 arguments. The script copies binaries and utility scripts into the directory
2269 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2270 .cindex "setuid" "installing Exim with"
2271 The install script copies files only if they are newer than the files they are
2272 going to replace. The Exim binary is required to be owned by root and have the
2273 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2274 install`& as root so that it can set up the Exim binary in this way. However, in
2275 some special situations (for example, if a host is doing no local deliveries)
2276 it may be possible to run Exim without making the binary setuid root (see
2277 chapter &<<CHAPsecurity>>& for details).
2278
2279 .cindex "CONFIGURE_FILE"
2280 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2281 in &_Local/Makefile_&. If this names a single file, and the file does not
2282 exist, the default configuration file &_src/configure.default_& is copied there
2283 by the installation script. If a run time configuration file already exists, it
2284 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2285 alternative files, no default is installed.
2286
2287 .cindex "system aliases file"
2288 .cindex "&_/etc/aliases_&"
2289 One change is made to the default configuration file when it is installed: the
2290 default configuration contains a router that references a system aliases file.
2291 The path to this file is set to the value specified by
2292 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2293 If the system aliases file does not exist, the installation script creates it,
2294 and outputs a comment to the user.
2295
2296 The created file contains no aliases, but it does contain comments about the
2297 aliases a site should normally have. Mail aliases have traditionally been
2298 kept in &_/etc/aliases_&. However, some operating systems are now using
2299 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2300 Exim's configuration if necessary.
2301
2302 The default configuration uses the local host's name as the only local domain,
2303 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2304 running as the local user. System aliases and &_.forward_& files in users' home
2305 directories are supported, but no NIS or NIS+ support is configured. Domains
2306 other than the name of the local host are routed using the DNS, with delivery
2307 over SMTP.
2308
2309 It is possible to install Exim for special purposes (such as building a binary
2310 distribution) in a private part of the file system. You can do this by a
2311 command such as
2312 .code
2313 make DESTDIR=/some/directory/ install
2314 .endd
2315 This has the effect of pre-pending the specified directory to all the file
2316 paths, except the name of the system aliases file that appears in the default
2317 configuration. (If a default alias file is created, its name &'is'& modified.)
2318 For backwards compatibility, ROOT is used if DESTDIR is not set,
2319 but this usage is deprecated.
2320
2321 .cindex "installing Exim" "what is not installed"
2322 Running &'make install'& does not copy the Exim 4 conversion script
2323 &'convert4r4'&. You will probably run this only once if you are
2324 upgrading from Exim 3. None of the documentation files in the &_doc_&
2325 directory are copied, except for the info files when you have set
2326 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2327
2328 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2329 to their names. The Exim binary itself, however, is handled differently. It is
2330 installed under a name that includes the version number and the compile number,
2331 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2332 called &_exim_& to point to the binary. If you are updating a previous version
2333 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2334 from the directory (as seen by other processes).
2335
2336 .cindex "installing Exim" "testing the script"
2337 If you want to see what the &'make install'& will do before running it for
2338 real, you can pass the &%-n%& option to the installation script by this
2339 command:
2340 .code
2341 make INSTALL_ARG=-n install
2342 .endd
2343 The contents of the variable INSTALL_ARG are passed to the installation
2344 script. You do not need to be root to run this test. Alternatively, you can run
2345 the installation script directly, but this must be from within the build
2346 directory. For example, from the top-level Exim directory you could use this
2347 command:
2348 .code
2349 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2350 .endd
2351 .cindex "installing Exim" "install script options"
2352 There are two other options that can be supplied to the installation script.
2353
2354 .ilist
2355 &%-no_chown%& bypasses the call to change the owner of the installed binary
2356 to root, and the call to make it a setuid binary.
2357 .next
2358 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2359 installed binary.
2360 .endlist
2361
2362 INSTALL_ARG can be used to pass these options to the script. For example:
2363 .code
2364 make INSTALL_ARG=-no_symlink install
2365 .endd
2366 The installation script can also be given arguments specifying which files are
2367 to be copied. For example, to install just the Exim binary, and nothing else,
2368 without creating the symbolic link, you could use:
2369 .code
2370 make INSTALL_ARG='-no_symlink exim' install
2371 .endd
2372
2373
2374
2375 .section "Installing info documentation" "SECTinsinfdoc"
2376 .cindex "installing Exim" "&'info'& documentation"
2377 Not all systems use the GNU &'info'& system for documentation, and for this
2378 reason, the Texinfo source of Exim's documentation is not included in the main
2379 distribution. Instead it is available separately from the ftp site (see section
2380 &<<SECTavail>>&).
2381
2382 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2383 source of the documentation is found in the source tree, running &`make
2384 install`& automatically builds the info files and installs them.
2385
2386
2387
2388 .section "Setting up the spool directory" "SECID33"
2389 .cindex "spool directory" "creating"
2390 When it starts up, Exim tries to create its spool directory if it does not
2391 exist. The Exim uid and gid are used for the owner and group of the spool
2392 directory. Sub-directories are automatically created in the spool directory as
2393 necessary.
2394
2395
2396
2397
2398 .section "Testing" "SECID34"
2399 .cindex "testing" "installation"
2400 Having installed Exim, you can check that the run time configuration file is
2401 syntactically valid by running the following command, which assumes that the
2402 Exim binary directory is within your PATH environment variable:
2403 .code
2404 exim -bV
2405 .endd
2406 If there are any errors in the configuration file, Exim outputs error messages.
2407 Otherwise it outputs the version number and build date,
2408 the DBM library that is being used, and information about which drivers and
2409 other optional code modules are included in the binary.
2410 Some simple routing tests can be done by using the address testing option. For
2411 example,
2412 .display
2413 &`exim -bt`& <&'local username'&>
2414 .endd
2415 should verify that it recognizes a local mailbox, and
2416 .display
2417 &`exim -bt`& <&'remote address'&>
2418 .endd
2419 a remote one. Then try getting it to deliver mail, both locally and remotely.
2420 This can be done by passing messages directly to Exim, without going through a
2421 user agent. For example:
2422 .code
2423 exim -v postmaster@your.domain.example
2424 From: user@your.domain.example
2425 To: postmaster@your.domain.example
2426 Subject: Testing Exim
2427
2428 This is a test message.
2429 ^D
2430 .endd
2431 The &%-v%& option causes Exim to output some verification of what it is doing.
2432 In this case you should see copies of three log lines, one for the message's
2433 arrival, one for its delivery, and one containing &"Completed"&.
2434
2435 .cindex "delivery" "problems with"
2436 If you encounter problems, look at Exim's log files (&'mainlog'& and
2437 &'paniclog'&) to see if there is any relevant information there. Another source
2438 of information is running Exim with debugging turned on, by specifying the
2439 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2440 with debugging turned on by a command of the form
2441 .display
2442 &`exim -d -M`& <&'exim-message-id'&>
2443 .endd
2444 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2445 produces rather a lot of output, but you can cut this down to specific areas.
2446 For example, if you use &%-d-all+route%& only the debugging information
2447 relevant to routing is included. (See the &%-d%& option in chapter
2448 &<<CHAPcommandline>>& for more details.)
2449
2450 .cindex '&"sticky"& bit'
2451 .cindex "lock files"
2452 One specific problem that has shown up on some sites is the inability to do
2453 local deliveries into a shared mailbox directory, because it does not have the
2454 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2455 writing to a mailbox file, and if it cannot create the lock file, the delivery
2456 is deferred. You can get round this either by setting the &"sticky bit"& on the
2457 directory, or by setting a specific group for local deliveries and allowing
2458 that group to create files in the directory (see the comments above the
2459 &(local_delivery)& transport in the default configuration file). Another
2460 approach is to configure Exim not to use lock files, but just to rely on
2461 &[fcntl()]& locking instead. However, you should do this only if all user
2462 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2463 see chapter &<<CHAPappendfile>>&.
2464
2465 One thing that cannot be tested on a system that is already running an MTA is
2466 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2467 &%-oX%& option can be used to run an Exim daemon that listens on some other
2468 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2469 &'exim_checkaccess'& utility can be used to check out policy controls on
2470 incoming SMTP mail.
2471
2472 Testing a new version on a system that is already running Exim can most easily
2473 be done by building a binary with a different CONFIGURE_FILE setting. From
2474 within the run time configuration, all other file and directory names
2475 that Exim uses can be altered, in order to keep it entirely clear of the
2476 production version.
2477
2478
2479 .section "Replacing another MTA with Exim" "SECID35"
2480 .cindex "replacing another MTA"
2481 Building and installing Exim for the first time does not of itself put it in
2482 general use. The name by which the system's MTA is called by mail user agents
2483 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2484 operating system), and it is necessary to make this name point to the &'exim'&
2485 binary in order to get the user agents to pass messages to Exim. This is
2486 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2487 or &_/usr/lib/sendmail_&
2488 .cindex "symbolic link" "to &'exim'& binary"
2489 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2490 privilege and executable status from the old MTA. It is then necessary to stop
2491 and restart the mailer daemon, if one is running.
2492
2493 .cindex "FreeBSD, MTA indirection"
2494 .cindex "&_/etc/mail/mailer.conf_&"
2495 Some operating systems have introduced alternative ways of switching MTAs. For
2496 example, if you are running FreeBSD, you need to edit the file
2497 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2498 described. A typical example of the contents of this file for running Exim is
2499 as follows:
2500 .code
2501 sendmail            /usr/exim/bin/exim
2502 send-mail           /usr/exim/bin/exim
2503 mailq               /usr/exim/bin/exim -bp
2504 newaliases          /usr/bin/true
2505 .endd
2506 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2507 your Exim installation is &"live"&. Check it by sending a message from your
2508 favourite user agent.
2509
2510 You should consider what to tell your users about the change of MTA. Exim may
2511 have different capabilities to what was previously running, and there are
2512 various operational differences such as the text of messages produced by
2513 command line options and in bounce messages. If you allow your users to make
2514 use of Exim's filtering capabilities, you should make the document entitled
2515 &'Exim's interface to mail filtering'& available to them.
2516
2517
2518
2519 .section "Upgrading Exim" "SECID36"
2520 .cindex "upgrading Exim"
2521 If you are already running Exim on your host, building and installing a new
2522 version automatically makes it available to MUAs, or any other programs that
2523 call the MTA directly. However, if you are running an Exim daemon, you do need
2524 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2525 new binary. You do not need to stop processing mail in order to install a new
2526 version of Exim. The install script does not modify an existing runtime
2527 configuration file.
2528
2529
2530
2531
2532 .section "Stopping the Exim daemon on Solaris" "SECID37"
2533 .cindex "Solaris" "stopping Exim on"
2534 The standard command for stopping the mailer daemon on Solaris is
2535 .code
2536 /etc/init.d/sendmail stop
2537 .endd
2538 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2539 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2540 for the text &"sendmail"&; this is not present because the actual program name
2541 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2542 solution is to replace the line that finds the process id with something like
2543 .code
2544 pid=`cat /var/spool/exim/exim-daemon.pid`
2545 .endd
2546 to obtain the daemon's pid directly from the file that Exim saves it in.
2547
2548 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2549 still be received from local processes, and if automatic delivery is configured
2550 (the normal case), deliveries will still occur.
2551
2552
2553
2554
2555 . ////////////////////////////////////////////////////////////////////////////
2556 . ////////////////////////////////////////////////////////////////////////////
2557
2558 .chapter "The Exim command line" "CHAPcommandline"
2559 .scindex IIDclo1 "command line" "options"
2560 .scindex IIDclo2 "options" "command line"
2561 Exim's command line takes the standard Unix form of a sequence of options,
2562 each starting with a hyphen character, followed by a number of arguments. The
2563 options are compatible with the main options of Sendmail, and there are also
2564 some additional options, some of which are compatible with Smail 3. Certain
2565 combinations of options do not make sense, and provoke an error if used.
2566 The form of the arguments depends on which options are set.
2567
2568
2569 .section "Setting options by program name" "SECID38"
2570 .cindex "&'mailq'&"
2571 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2572 were present before any other options.
2573 The &%-bp%& option requests a listing of the contents of the mail queue on the
2574 standard output.
2575 This feature is for compatibility with some systems that contain a command of
2576 that name in one of the standard libraries, symbolically linked to
2577 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2578
2579 .cindex "&'rsmtp'&"
2580 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2581 were present before any other options, for compatibility with Smail. The
2582 &%-bS%& option is used for reading in a number of messages in batched SMTP
2583 format.
2584
2585 .cindex "&'rmail'&"
2586 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2587 &%-oee%& options were present before any other options, for compatibility with
2588 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2589
2590 .cindex "&'runq'&"
2591 .cindex "queue runner"
2592 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2593 were present before any other options, for compatibility with Smail. The &%-q%&
2594 option causes a single queue runner process to be started.
2595
2596 .cindex "&'newaliases'&"
2597 .cindex "alias file" "building"
2598 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2599 If Exim is called under the name &'newaliases'& it behaves as if the option
2600 &%-bi%& were present before any other options, for compatibility with Sendmail.
2601 This option is used for rebuilding Sendmail's alias file. Exim does not have
2602 the concept of a single alias file, but can be configured to run a given
2603 command if called with the &%-bi%& option.
2604
2605
2606 .section "Trusted and admin users" "SECTtrustedadmin"
2607 Some Exim options are available only to &'trusted users'& and others are
2608 available only to &'admin users'&. In the description below, the phrases &"Exim
2609 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2610 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2611 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2612
2613 .ilist
2614 .cindex "trusted users" "definition of"
2615 .cindex "user" "trusted definition of"
2616 The trusted users are root, the Exim user, any user listed in the
2617 &%trusted_users%& configuration option, and any user whose current group or any
2618 supplementary group is one of those listed in the &%trusted_groups%&
2619 configuration option. Note that the Exim group is not automatically trusted.
2620
2621 .cindex '&"From"& line'
2622 .cindex "envelope sender"
2623 Trusted users are always permitted to use the &%-f%& option or a leading
2624 &"From&~"& line to specify the envelope sender of a message that is passed to
2625 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2626 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2627 users to set envelope senders.
2628
2629 .cindex "&'From:'& header line"
2630 .cindex "&'Sender:'& header line"
2631 .cindex "header lines" "From:"
2632 .cindex "header lines" "Sender:"
2633 For a trusted user, there is never any check on the contents of the &'From:'&
2634 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2635 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2636
2637 Trusted users may also specify a host name, host address, interface address,
2638 protocol name, ident value, and authentication data when submitting a message
2639 locally. Thus, they are able to insert messages into Exim's queue locally that
2640 have the characteristics of messages received from a remote host. Untrusted
2641 users may in some circumstances use &%-f%&, but can never set the other values
2642 that are available to trusted users.
2643 .next
2644 .cindex "user" "admin definition of"
2645 .cindex "admin user" "definition of"
2646 The admin users are root, the Exim user, and any user that is a member of the
2647 Exim group or of any group listed in the &%admin_groups%& configuration option.
2648 The current group does not have to be one of these groups.
2649
2650 Admin users are permitted to list the queue, and to carry out certain
2651 operations on messages, for example, to force delivery failures. It is also
2652 necessary to be an admin user in order to see the full information provided by
2653 the Exim monitor, and full debugging output.
2654
2655 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2656 Exim to attempt delivery of messages on its queue is restricted to admin users.
2657 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2658 option false (that is, specifying &%no_prod_requires_admin%&).
2659
2660 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2661 is restricted to admin users unless &%queue_list_requires_admin%& is set
2662 false.
2663 .endlist
2664
2665
2666 &*Warning*&: If you configure your system so that admin users are able to
2667 edit Exim's configuration file, you are giving those users an easy way of
2668 getting root. There is further discussion of this issue at the start of chapter
2669 &<<CHAPconf>>&.
2670
2671
2672
2673
2674 .section "Command line options" "SECID39"
2675 Exim's command line options are described in alphabetical order below. If none
2676 of the options that specifies a specific action (such as starting the daemon or
2677 a queue runner, or testing an address, or receiving a message in a specific
2678 format, or listing the queue) are present, and there is at least one argument
2679 on the command line, &%-bm%& (accept a local message on the standard input,
2680 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2681 outputs a brief message about itself and exits.
2682
2683 . ////////////////////////////////////////////////////////////////////////////
2684 . Insert a stylized XML comment here, to identify the start of the command line
2685 . options. This is for the benefit of the Perl script that automatically
2686 . creates a man page for the options.
2687 . ////////////////////////////////////////////////////////////////////////////
2688
2689 .literal xml
2690 <!-- === Start of command line options === -->
2691 .literal off
2692
2693
2694 .vlist
2695 .vitem &%--%&
2696 .oindex "--"
2697 .cindex "options" "command line; terminating"
2698 This is a pseudo-option whose only purpose is to terminate the options and
2699 therefore to cause subsequent command line items to be treated as arguments
2700 rather than options, even if they begin with hyphens.
2701
2702 .vitem &%--help%&
2703 .oindex "&%--help%&"
2704 This option causes Exim to output a few sentences stating what it is.
2705 The same output is generated if the Exim binary is called with no options and
2706 no arguments.
2707
2708 .vitem &%--version%&
2709 .oindex "&%--version%&"
2710 This option is an alias for &%-bV%& and causes version information to be
2711 displayed.
2712
2713 .vitem &%-Ac%& &&&
2714        &%-Am%&
2715 .oindex "&%-Ac%&"
2716 .oindex "&%-Am%&"
2717 These options are used by Sendmail for selecting configuration files and are
2718 ignored by Exim.
2719
2720 .vitem &%-B%&<&'type'&>
2721 .oindex "&%-B%&"
2722 .cindex "8-bit characters"
2723 .cindex "Sendmail compatibility" "8-bit characters"
2724 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2725 clean; it ignores this option.
2726
2727 .vitem &%-bd%&
2728 .oindex "&%-bd%&"
2729 .cindex "daemon"
2730 .cindex "SMTP" "listener"
2731 .cindex "queue runner"
2732 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2733 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2734 that the daemon should also initiate periodic queue runs.
2735
2736 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2737 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2738 disconnect from the controlling terminal. When running this way, it can be
2739 stopped by pressing ctrl-C.
2740
2741 By default, Exim listens for incoming connections to the standard SMTP port on
2742 all the host's running interfaces. However, it is possible to listen on other
2743 ports, on multiple ports, and only on specific interfaces. Chapter
2744 &<<CHAPinterfaces>>& contains a description of the options that control this.
2745
2746 When a listening daemon
2747 .cindex "daemon" "process id (pid)"
2748 .cindex "pid (process id)" "of daemon"
2749 is started without the use of &%-oX%& (that is, without overriding the normal
2750 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2751 in Exim's spool directory. This location can be overridden by setting
2752 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2753 running as root.
2754
2755 When &%-oX%& is used on the command line to start a listening daemon, the
2756 process id is not written to the normal pid file path. However, &%-oP%& can be
2757 used to specify a path on the command line if a pid file is required.
2758
2759 The SIGHUP signal
2760 .cindex "SIGHUP"
2761 .cindex "daemon" "restarting"
2762 can be used to cause the daemon to re-execute itself. This should be done
2763 whenever Exim's configuration file, or any file that is incorporated into it by
2764 means of the &%.include%& facility, is changed, and also whenever a new version
2765 of Exim is installed. It is not necessary to do this when other files that are
2766 referenced from the configuration (for example, alias files) are changed,
2767 because these are reread each time they are used.
2768
2769 .vitem &%-bdf%&
2770 .oindex "&%-bdf%&"
2771 This option has the same effect as &%-bd%& except that it never disconnects
2772 from the controlling terminal, even when no debugging is specified.
2773
2774 .vitem &%-be%&
2775 .oindex "&%-be%&"
2776 .cindex "testing" "string expansion"
2777 .cindex "expansion" "testing"
2778 Run Exim in expansion testing mode. Exim discards its root privilege, to
2779 prevent ordinary users from using this mode to read otherwise inaccessible
2780 files. If no arguments are given, Exim runs interactively, prompting for lines
2781 of data. Otherwise, it processes each argument in turn.
2782
2783 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2784 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2785 used without command line arguments. If successful, it uses the &[readline()]&
2786 function, which provides extensive line-editing facilities, for reading the
2787 test data. A line history is supported.
2788
2789 Long expansion expressions can be split over several lines by using backslash
2790 continuations. As in Exim's run time configuration, white space at the start of
2791 continuation lines is ignored. Each argument or data line is passed through the
2792 string expansion mechanism, and the result is output. Variable values from the
2793 configuration file (for example, &$qualify_domain$&) are available, but no
2794 message-specific values (such as &$message_exim_id$&) are set, because no message
2795 is being processed (but see &%-bem%& and &%-Mset%&).
2796
2797 &*Note*&: If you use this mechanism to test lookups, and you change the data
2798 files or databases you are using, you must exit and restart Exim before trying
2799 the same lookup again. Otherwise, because each Exim process caches the results
2800 of lookups, you will just get the same result as before.
2801
2802 .vitem &%-bem%&&~<&'filename'&>
2803 .oindex "&%-bem%&"
2804 .cindex "testing" "string expansion"
2805 .cindex "expansion" "testing"
2806 This option operates like &%-be%& except that it must be followed by the name
2807 of a file. For example:
2808 .code
2809 exim -bem /tmp/testmessage
2810 .endd
2811 The file is read as a message (as if receiving a locally-submitted non-SMTP
2812 message) before any of the test expansions are done. Thus, message-specific
2813 variables such as &$message_size$& and &$header_from:$& are available. However,
2814 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2815 recipients are read from the headers in the normal way, and are shown in the
2816 &$recipients$& variable. Note that recipients cannot be given on the command
2817 line, because further arguments are taken as strings to expand (just like
2818 &%-be%&).
2819
2820 .vitem &%-bF%&&~<&'filename'&>
2821 .oindex "&%-bF%&"
2822 .cindex "system filter" "testing"
2823 .cindex "testing" "system filter"
2824 This option is the same as &%-bf%& except that it assumes that the filter being
2825 tested is a system filter. The additional commands that are available only in
2826 system filters are recognized.
2827
2828 .vitem &%-bf%&&~<&'filename'&>
2829 .oindex "&%-bf%&"
2830 .cindex "filter" "testing"
2831 .cindex "testing" "filter file"
2832 .cindex "forward file" "testing"
2833 .cindex "testing" "forward file"
2834 .cindex "Sieve filter" "testing"
2835 This option runs Exim in user filter testing mode; the file is the filter file
2836 to be tested, and a test message must be supplied on the standard input. If
2837 there are no message-dependent tests in the filter, an empty file can be
2838 supplied.
2839
2840 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2841 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2842 filter and a user filter in the same run. For example:
2843 .code
2844 exim -bF /system/filter -bf /user/filter </test/message
2845 .endd
2846 This is helpful when the system filter adds header lines or sets filter
2847 variables that are used by the user filter.
2848
2849 If the test filter file does not begin with one of the special lines
2850 .code
2851 # Exim filter
2852 # Sieve filter
2853 .endd
2854 it is taken to be a normal &_.forward_& file, and is tested for validity under
2855 that interpretation. See sections &<<SECTitenonfilred>>& to
2856 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2857 redirection lists.
2858
2859 The result of an Exim command that uses &%-bf%&, provided no errors are
2860 detected, is a list of the actions that Exim would try to take if presented
2861 with the message for real. More details of filter testing are given in the
2862 separate document entitled &'Exim's interfaces to mail filtering'&.
2863
2864 When testing a filter file,
2865 .cindex "&""From""& line"
2866 .cindex "envelope sender"
2867 .oindex "&%-f%&" "for filter testing"
2868 the envelope sender can be set by the &%-f%& option,
2869 or by a &"From&~"& line at the start of the test message. Various parameters
2870 that would normally be taken from the envelope recipient address of the message
2871 can be set by means of additional command line options (see the next four
2872 options).
2873
2874 .vitem &%-bfd%&&~<&'domain'&>
2875 .oindex "&%-bfd%&"
2876 .vindex "&$qualify_domain$&"
2877 This sets the domain of the recipient address when a filter file is being
2878 tested by means of the &%-bf%& option. The default is the value of
2879 &$qualify_domain$&.
2880
2881 .vitem &%-bfl%&&~<&'local&~part'&>
2882 .oindex "&%-bfl%&"
2883 This sets the local part of the recipient address when a filter file is being
2884 tested by means of the &%-bf%& option. The default is the username of the
2885 process that calls Exim. A local part should be specified with any prefix or
2886 suffix stripped, because that is how it appears to the filter when a message is
2887 actually being delivered.
2888
2889 .vitem &%-bfp%&&~<&'prefix'&>
2890 .oindex "&%-bfp%&"
2891 This sets the prefix of the local part of the recipient address when a filter
2892 file is being tested by means of the &%-bf%& option. The default is an empty
2893 prefix.
2894
2895 .vitem &%-bfs%&&~<&'suffix'&>
2896 .oindex "&%-bfs%&"
2897 This sets the suffix of the local part of the recipient address when a filter
2898 file is being tested by means of the &%-bf%& option. The default is an empty
2899 suffix.
2900
2901 .vitem &%-bh%&&~<&'IP&~address'&>
2902 .oindex "&%-bh%&"
2903 .cindex "testing" "incoming SMTP"
2904 .cindex "SMTP" "testing incoming"
2905 .cindex "testing" "relay control"
2906 .cindex "relaying" "testing configuration"
2907 .cindex "policy control" "testing"
2908 .cindex "debugging" "&%-bh%& option"
2909 This option runs a fake SMTP session as if from the given IP address, using the
2910 standard input and output. The IP address may include a port number at the end,
2911 after a full stop. For example:
2912 .code
2913 exim -bh 10.9.8.7.1234
2914 exim -bh fe80::a00:20ff:fe86:a061.5678
2915 .endd
2916 When an IPv6 address is given, it is converted into canonical form. In the case
2917 of the second example above, the value of &$sender_host_address$& after
2918 conversion to the canonical form is
2919 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2920
2921 Comments as to what is going on are written to the standard error file. These
2922 include lines beginning with &"LOG"& for anything that would have been logged.
2923 This facility is provided for testing configuration options for incoming
2924 messages, to make sure they implement the required policy. For example, you can
2925 test your relay controls using &%-bh%&.
2926
2927 &*Warning 1*&:
2928 .cindex "RFC 1413"
2929 You can test features of the configuration that rely on ident (RFC 1413)
2930 information by using the &%-oMt%& option. However, Exim cannot actually perform
2931 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2932 connection.
2933
2934 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2935 are also skipped when testing using &%-bh%&. If you want these callouts to
2936 occur, use &%-bhc%& instead.
2937
2938 Messages supplied during the testing session are discarded, and nothing is
2939 written to any of the real log files. There may be pauses when DNS (and other)
2940 lookups are taking place, and of course these may time out. The &%-oMi%& option
2941 can be used to specify a specific IP interface and port if this is important,
2942 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2943 session were authenticated.
2944
2945 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2946 output just states whether a given recipient address from a given host is
2947 acceptable or not. See section &<<SECTcheckaccess>>&.
2948
2949 Features such as authentication and encryption, where the client input is not
2950 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2951 specialized SMTP test program such as
2952 &url(http://jetmore.org/john/code/#swaks,swaks).
2953
2954 .vitem &%-bhc%&&~<&'IP&~address'&>
2955 .oindex "&%-bhc%&"
2956 This option operates in the same way as &%-bh%&, except that address
2957 verification callouts are performed if required. This includes consulting and
2958 updating the callout cache database.
2959
2960 .vitem &%-bi%&
2961 .oindex "&%-bi%&"
2962 .cindex "alias file" "building"
2963 .cindex "building alias file"
2964 .cindex "Sendmail compatibility" "&%-bi%& option"
2965 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2966 Exim does not have the concept of a single alias file, and so it cannot mimic
2967 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2968 tend to appear in various scripts such as NIS make files, so the option must be
2969 recognized.
2970
2971 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2972 configuration option is run, under the uid and gid of the caller of Exim. If
2973 the &%-oA%& option is used, its value is passed to the command as an argument.
2974 The command set by &%bi_command%& may not contain arguments. The command can
2975 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2976 if this is required. If the &%bi_command%& option is not set, calling Exim with
2977 &%-bi%& is a no-op.
2978
2979 . // Keep :help first, then the rest in alphabetical order
2980 .vitem &%-bI:help%&
2981 .oindex "&%-bI:help%&"
2982 .cindex "querying exim information"
2983 We shall provide various options starting &`-bI:`& for querying Exim for
2984 information.  The output of many of these will be intended for machine
2985 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2986 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2987 options shall cause Exim to exit after producing the requested output.
2988
2989 .vitem &%-bI:dscp%&
2990 .oindex "&%-bI:dscp%&"
2991 .cindex "DSCP" "values"
2992 This option causes Exim to emit an alphabetically sorted list of all
2993 recognised DSCP names.
2994
2995 .vitem &%-bI:sieve%&
2996 .oindex "&%-bI:sieve%&"
2997 .cindex "Sieve filter" "capabilities"
2998 This option causes Exim to emit an alphabetically sorted list of all supported
2999 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3000 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3001 &`SIEVE`& capability response line.  As the precise list may depend upon
3002 compile-time build options, which this option will adapt to, this is the only
3003 way to guarantee a correct response.
3004
3005 .vitem &%-bm%&
3006 .oindex "&%-bm%&"
3007 .cindex "local message reception"
3008 This option runs an Exim receiving process that accepts an incoming,
3009 locally-generated message on the standard input. The recipients are given as the
3010 command arguments (except when &%-t%& is also present &-- see below). Each
3011 argument can be a comma-separated list of RFC 2822 addresses. This is the
3012 default option for selecting the overall action of an Exim call; it is assumed
3013 if no other conflicting option is present.
3014
3015 If any addresses in the message are unqualified (have no domain), they are
3016 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3017 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3018 suppressing this for special cases.
3019
3020 Policy checks on the contents of local messages can be enforced by means of
3021 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3022
3023 .cindex "return code" "for &%-bm%&"
3024 The return code is zero if the message is successfully accepted. Otherwise, the
3025 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3026
3027 The format
3028 .cindex "message" "format"
3029 .cindex "format" "message"
3030 .cindex "&""From""& line"
3031 .cindex "UUCP" "&""From""& line"
3032 .cindex "Sendmail compatibility" "&""From""& line"
3033 of the message must be as defined in RFC 2822, except that, for
3034 compatibility with Sendmail and Smail, a line in one of the forms
3035 .code
3036 From sender Fri Jan  5 12:55 GMT 1997
3037 From sender Fri, 5 Jan 97 12:55:01
3038 .endd
3039 (with the weekday optional, and possibly with additional text after the date)
3040 is permitted to appear at the start of the message. There appears to be no
3041 authoritative specification of the format of this line. Exim recognizes it by
3042 matching against the regular expression defined by the &%uucp_from_pattern%&
3043 option, which can be changed if necessary.
3044
3045 .oindex "&%-f%&" "overriding &""From""& line"
3046 The specified sender is treated as if it were given as the argument to the
3047 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3048 preference to the address taken from the message. The caller of Exim must be a
3049 trusted user for the sender of a message to be set in this way.
3050
3051 .vitem &%-bmalware%&&~<&'filename'&>
3052 .oindex "&%-bmalware%&"
3053 .cindex "testing", "malware"
3054 .cindex "malware scan test"
3055 This debugging option causes Exim to scan the given file or directory
3056 (depending on the used scanner interface),
3057 using the malware scanning framework.  The option of &%av_scanner%& influences
3058 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3059 the expansion should have defaults which apply to this invocation.  ACLs are
3060 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3061 will never be populated and &%-bmalware%& will fail.
3062
3063 Exim will have changed working directory before resolving the filename, so
3064 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3065 user when it tries to open the file, rather than as the invoking user.
3066 This option requires admin privileges.
3067
3068 The &%-bmalware%& option will not be extended to be more generally useful,
3069 there are better tools for file-scanning.  This option exists to help
3070 administrators verify their Exim and AV scanner configuration.
3071
3072 .vitem &%-bnq%&
3073 .oindex "&%-bnq%&"
3074 .cindex "address qualification, suppressing"
3075 By default, Exim automatically qualifies unqualified addresses (those
3076 without domains) that appear in messages that are submitted locally (that
3077 is, not over TCP/IP). This qualification applies both to addresses in
3078 envelopes, and addresses in header lines. Sender addresses are qualified using
3079 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3080 defaults to the value of &%qualify_domain%&).
3081
3082 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3083 being used to re-submit messages that originally came from remote hosts after
3084 content scanning, you probably do not want to qualify unqualified addresses in
3085 header lines. (Such lines will be present only if you have not enabled a header
3086 syntax check in the appropriate ACL.)
3087
3088 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3089 messages that originate on the local host. When this is used, unqualified
3090 addresses in the envelope provoke errors (causing message rejection) and
3091 unqualified addresses in header lines are left alone.
3092
3093
3094 .vitem &%-bP%&
3095 .oindex "&%-bP%&"
3096 .cindex "configuration options" "extracting"
3097 .cindex "options" "configuration &-- extracting"
3098 If this option is given with no arguments, it causes the values of all Exim's
3099 main configuration options to be written to the standard output. The values
3100 of one or more specific options can be requested by giving their names as
3101 arguments, for example:
3102 .code
3103 exim -bP qualify_domain hold_domains
3104 .endd
3105 .cindex "hiding configuration option values"
3106 .cindex "configuration options" "hiding value of"
3107 .cindex "options" "hiding value of"
3108 However, any option setting that is preceded by the word &"hide"& in the
3109 configuration file is not shown in full, except to an admin user. For other
3110 users, the output is as in this example:
3111 .code
3112 mysql_servers = <value not displayable>
3113 .endd
3114 If &%config%& is given as an argument, the config is
3115 output, as it was parsed, any include file resolved, any comment removed.
3116
3117 If &%config_file%& is given as an argument, the name of the run time
3118 configuration file is output. (&%configure_file%& works too, for
3119 backward compatibility.)
3120 If a list of configuration files was supplied, the value that is output here
3121 is the name of the file that was actually used.
3122
3123 .cindex "options" "hiding name of"
3124 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3125 name will not be output.
3126
3127 .cindex "daemon" "process id (pid)"
3128 .cindex "pid (process id)" "of daemon"
3129 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3130 directories where log files and daemon pid files are written are output,
3131 respectively. If these values are unset, log files are written in a
3132 sub-directory of the spool directory called &%log%&, and the pid file is
3133 written directly into the spool directory.
3134
3135 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3136 .code
3137 exim -bP +local_domains
3138 .endd
3139 it searches for a matching named list of any type (domain, host, address, or
3140 local part) and outputs what it finds.
3141
3142 .cindex "options" "router &-- extracting"
3143 .cindex "options" "transport &-- extracting"
3144 .cindex "options" "authenticator &-- extracting"
3145 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3146 followed by the name of an appropriate driver instance, the option settings for
3147 that driver are output. For example:
3148 .code
3149 exim -bP transport local_delivery
3150 .endd
3151 The generic driver options are output first, followed by the driver's private
3152 options. A list of the names of drivers of a particular type can be obtained by
3153 using one of the words &%router_list%&, &%transport_list%&, or
3154 &%authenticator_list%&, and a complete list of all drivers with their option
3155 settings can be obtained by using &%routers%&, &%transports%&, or
3156 &%authenticators%&.
3157
3158 .cindex "environment"
3159 If &%environment%& is given as an argument, the set of environment
3160 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3161 variables.
3162
3163 .cindex "options" "macro &-- extracting"
3164 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3165 are available, similarly to the drivers.  Because macros are sometimes used
3166 for storing passwords, this option is restricted.
3167 The output format is one item per line.
3168
3169 .vitem &%-bp%&
3170 .oindex "&%-bp%&"
3171 .cindex "queue" "listing messages on"
3172 .cindex "listing" "messages on the queue"
3173 This option requests a listing of the contents of the mail queue on the
3174 standard output. If the &%-bp%& option is followed by a list of message ids,
3175 just those messages are listed. By default, this option can be used only by an
3176 admin user. However, the &%queue_list_requires_admin%& option can be set false
3177 to allow any user to see the queue.
3178
3179 Each message on the queue is displayed as in the following example:
3180 .code
3181 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3182           red.king@looking-glass.fict.example
3183           <other addresses>
3184 .endd
3185 .cindex "message" "size in queue listing"
3186 .cindex "size" "of message"
3187 The first line contains the length of time the message has been on the queue
3188 (in this case 25 minutes), the size of the message (2.9K), the unique local
3189 identifier for the message, and the message sender, as contained in the
3190 envelope. For bounce messages, the sender address is empty, and appears as
3191 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3192 the default sender address, the user's login name is shown in parentheses
3193 before the sender address.
3194
3195 .cindex "frozen messages" "in queue listing"
3196 If the message is frozen (attempts to deliver it are suspended) then the text
3197 &"*** frozen ***"& is displayed at the end of this line.
3198
3199 The recipients of the message (taken from the envelope, not the headers) are
3200 displayed on subsequent lines. Those addresses to which the message has already
3201 been delivered are marked with the letter D. If an original address gets
3202 expanded into several addresses via an alias or forward file, the original is
3203 displayed with a D only when deliveries for all of its child addresses are
3204 complete.
3205
3206
3207 .vitem &%-bpa%&
3208 .oindex "&%-bpa%&"
3209 This option operates like &%-bp%&, but in addition it shows delivered addresses
3210 that were generated from the original top level address(es) in each message by
3211 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3212 of just &"D"&.
3213
3214
3215 .vitem &%-bpc%&
3216 .oindex "&%-bpc%&"
3217 .cindex "queue" "count of messages on"
3218 This option counts the number of messages on the queue, and writes the total
3219 to the standard output. It is restricted to admin users, unless
3220 &%queue_list_requires_admin%& is set false.
3221
3222
3223 .vitem &%-bpr%&
3224 .oindex "&%-bpr%&"
3225 This option operates like &%-bp%&, but the output is not sorted into
3226 chronological order of message arrival. This can speed it up when there are
3227 lots of messages on the queue, and is particularly useful if the output is
3228 going to be post-processed in a way that doesn't need the sorting.
3229
3230 .vitem &%-bpra%&
3231 .oindex "&%-bpra%&"
3232 This option is a combination of &%-bpr%& and &%-bpa%&.
3233
3234 .vitem &%-bpru%&
3235 .oindex "&%-bpru%&"
3236 This option is a combination of &%-bpr%& and &%-bpu%&.
3237
3238
3239 .vitem &%-bpu%&
3240 .oindex "&%-bpu%&"
3241 This option operates like &%-bp%& but shows only undelivered top-level
3242 addresses for each message displayed. Addresses generated by aliasing or
3243 forwarding are not shown, unless the message was deferred after processing by a
3244 router with the &%one_time%& option set.
3245
3246
3247 .vitem &%-brt%&
3248 .oindex "&%-brt%&"
3249 .cindex "testing" "retry configuration"
3250 .cindex "retry" "configuration testing"
3251 This option is for testing retry rules, and it must be followed by up to three
3252 arguments. It causes Exim to look for a retry rule that matches the values
3253 and to write it to the standard output. For example:
3254 .code
3255 exim -brt bach.comp.mus.example
3256 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3257 .endd
3258 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3259 argument, which is required, can be a complete address in the form
3260 &'local_part@domain'&, or it can be just a domain name. If the second argument
3261 contains a dot, it is interpreted as an optional second domain name; if no
3262 retry rule is found for the first argument, the second is tried. This ties in
3263 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3264 rule is found that matches the host, one that matches the mail domain is
3265 sought. Finally, an argument that is the name of a specific delivery error, as
3266 used in setting up retry rules, can be given. For example:
3267 .code
3268 exim -brt haydn.comp.mus.example quota_3d
3269 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3270 .endd
3271
3272 .vitem &%-brw%&
3273 .oindex "&%-brw%&"
3274 .cindex "testing" "rewriting"
3275 .cindex "rewriting" "testing"
3276 This option is for testing address rewriting rules, and it must be followed by
3277 a single argument, consisting of either a local part without a domain, or a
3278 complete address with a fully qualified domain. Exim outputs how this address
3279 would be rewritten for each possible place it might appear. See chapter
3280 &<<CHAPrewrite>>& for further details.
3281
3282 .vitem &%-bS%&
3283 .oindex "&%-bS%&"
3284 .cindex "SMTP" "batched incoming"
3285 .cindex "batched SMTP input"
3286 This option is used for batched SMTP input, which is an alternative interface
3287 for non-interactive local message submission. A number of messages can be
3288 submitted in a single run. However, despite its name, this is not really SMTP
3289 input. Exim reads each message's envelope from SMTP commands on the standard
3290 input, but generates no responses. If the caller is trusted, or
3291 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3292 believed; otherwise the sender is always the caller of Exim.
3293
3294 The message itself is read from the standard input, in SMTP format (leading
3295 dots doubled), terminated by a line containing just a single dot. An error is
3296 provoked if the terminating dot is missing. A further message may then follow.
3297
3298 As for other local message submissions, the contents of incoming batch SMTP
3299 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3300 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3301 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3302
3303 Some other SMTP commands are recognized in the input. HELO and EHLO act
3304 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3305 QUIT quits, ignoring the rest of the standard input.
3306
3307 .cindex "return code" "for &%-bS%&"
3308 If any error is encountered, reports are written to the standard output and
3309 error streams, and Exim gives up immediately. The return code is 0 if no error
3310 was detected; it is 1 if one or more messages were accepted before the error
3311 was detected; otherwise it is 2.
3312
3313 More details of input using batched SMTP are given in section
3314 &<<SECTincomingbatchedSMTP>>&.
3315
3316 .vitem &%-bs%&
3317 .oindex "&%-bs%&"
3318 .cindex "SMTP" "local input"
3319 .cindex "local SMTP input"
3320 This option causes Exim to accept one or more messages by reading SMTP commands
3321 on the standard input, and producing SMTP replies on the standard output. SMTP
3322 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3323 Some user agents use this interface as a way of passing locally-generated
3324 messages to the MTA.
3325
3326 In
3327 .cindex "sender" "source of"
3328 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3329 set, the senders of messages are taken from the SMTP MAIL commands.
3330 Otherwise the content of these commands is ignored and the sender is set up as
3331 the calling user. Unqualified addresses are automatically qualified using
3332 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3333 &%-bnq%& option is used.
3334
3335 .cindex "inetd"
3336 The
3337 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3338 using a listening daemon. Exim can distinguish the two cases by checking
3339 whether the standard input is a TCP/IP socket. When Exim is called from
3340 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3341 above concerning senders and qualification do not apply. In this situation,
3342 Exim behaves in exactly the same way as it does when receiving a message via
3343 the listening daemon.
3344
3345 .vitem &%-bt%&
3346 .oindex "&%-bt%&"
3347 .cindex "testing" "addresses"
3348 .cindex "address" "testing"
3349 This option runs Exim in address testing mode, in which each argument is taken
3350 as a recipient address to be tested for deliverability. The results are
3351 written to the standard output. If a test fails, and the caller is not an admin
3352 user, no details of the failure are output, because these might contain
3353 sensitive information such as usernames and passwords for database lookups.
3354
3355 If no arguments are given, Exim runs in an interactive manner, prompting with a
3356 right angle bracket for addresses to be tested.
3357
3358 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3359 &[readline()]& function, because it is running as &'root'& and there are
3360 security issues.
3361
3362 Each address is handled as if it were the recipient address of a message
3363 (compare the &%-bv%& option). It is passed to the routers and the result is
3364 written to the standard output. However, any router that has
3365 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3366 genuine routing tests if your first router passes everything to a scanner
3367 program.
3368
3369 .cindex "return code" "for &%-bt%&"
3370 The return code is 2 if any address failed outright; it is 1 if no address
3371 failed outright but at least one could not be resolved for some reason. Return
3372 code 0 is given only when all addresses succeed.
3373
3374 .cindex "duplicate addresses"
3375 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3376 addresses after routing is complete, so that only one delivery takes place.
3377 This does not happen when testing with &%-bt%&; the full results of routing are
3378 always shown.
3379
3380 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3381 routers in the configuration makes any tests on the sender address of a
3382 message,
3383 .oindex "&%-f%&" "for address testing"
3384 you can use the &%-f%& option to set an appropriate sender when running
3385 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3386 default qualifying domain. However, if you have set up (for example) routers
3387 whose behaviour depends on the contents of an incoming message, you cannot test
3388 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3389 doing such tests.
3390
3391 .vitem &%-bV%&
3392 .oindex "&%-bV%&"
3393 .cindex "version number of Exim"
3394 This option causes Exim to write the current version number, compilation
3395 number, and compilation date of the &'exim'& binary to the standard output.
3396 It also lists the DBM library that is being used, the optional modules (such as
3397 specific lookup types), the drivers that are included in the binary, and the
3398 name of the run time configuration file that is in use.
3399
3400 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3401 configuration file. However, this is a static check only. It cannot check
3402 values that are to be expanded. For example, although a misspelt ACL verb is
3403 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3404 alone to discover (for example) all the typos in the configuration; some
3405 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3406 dynamic testing facilities.
3407
3408 .vitem &%-bv%&
3409 .oindex "&%-bv%&"
3410 .cindex "verifying address" "using &%-bv%&"
3411 .cindex "address" "verification"
3412 This option runs Exim in address verification mode, in which each argument is
3413 taken as a recipient address to be verified by the routers. (This does
3414 not involve any verification callouts). During normal operation, verification
3415 happens mostly as a consequence processing a &%verify%& condition in an ACL
3416 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3417 including callouts, see the &%-bh%& and &%-bhc%& options.
3418
3419 If verification fails, and the caller is not an admin user, no details of the
3420 failure are output, because these might contain sensitive information such as
3421 usernames and passwords for database lookups.
3422
3423 If no arguments are given, Exim runs in an interactive manner, prompting with a
3424 right angle bracket for addresses to be verified.
3425
3426 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3427 &[readline()]& function, because it is running as &'exim'& and there are
3428 security issues.
3429
3430 Verification differs from address testing (the &%-bt%& option) in that routers
3431 that have &%no_verify%& set are skipped, and if the address is accepted by a
3432 router that has &%fail_verify%& set, verification fails. The address is
3433 verified as a recipient if &%-bv%& is used; to test verification for a sender
3434 address, &%-bvs%& should be used.
3435
3436 If the &%-v%& option is not set, the output consists of a single line for each
3437 address, stating whether it was verified or not, and giving a reason in the
3438 latter case. Without &%-v%&, generating more than one address by redirection
3439 causes verification to end successfully, without considering the generated
3440 addresses. However, if just one address is generated, processing continues,
3441 and the generated address must verify successfully for the overall verification
3442 to succeed.
3443
3444 When &%-v%& is set, more details are given of how the address has been handled,
3445 and in the case of address redirection, all the generated addresses are also
3446 considered. Verification may succeed for some and fail for others.
3447
3448 The
3449 .cindex "return code" "for &%-bv%&"
3450 return code is 2 if any address failed outright; it is 1 if no address
3451 failed outright but at least one could not be resolved for some reason. Return
3452 code 0 is given only when all addresses succeed.
3453
3454 If any of the routers in the configuration makes any tests on the sender
3455 address of a message, you should use the &%-f%& option to set an appropriate
3456 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3457 calling user at the default qualifying domain.
3458
3459 .vitem &%-bvs%&
3460 .oindex "&%-bvs%&"
3461 This option acts like &%-bv%&, but verifies the address as a sender rather
3462 than a recipient address. This affects any rewriting and qualification that
3463 might happen.
3464
3465 .vitem &%-bw%&
3466 .oindex "&%-bw%&"
3467 .cindex "daemon"
3468 .cindex "inetd"
3469 .cindex "inetd" "wait mode"
3470 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3471 similarly to the &%-bd%& option.  All port specifications on the command-line
3472 and in the configuration file are ignored.  Queue-running may not be specified.
3473
3474 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3475 listening for connections.  This permits the system to start up and have
3476 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3477 each port only when the first connection is received.
3478
3479 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3480 which the daemon will exit, which should cause inetd to listen once more.
3481
3482 .vitem &%-C%&&~<&'filelist'&>
3483 .oindex "&%-C%&"
3484 .cindex "configuration file" "alternate"
3485 .cindex "CONFIGURE_FILE"
3486 .cindex "alternate configuration file"
3487 This option causes Exim to find the run time configuration file from the given
3488 list instead of from the list specified by the CONFIGURE_FILE
3489 compile-time setting. Usually, the list will consist of just a single file
3490 name, but it can be a colon-separated list of names. In this case, the first
3491 file that exists is used. Failure to open an existing file stops Exim from
3492 proceeding any further along the list, and an error is generated.
3493
3494 When this option is used by a caller other than root, and the list is different
3495 from the compiled-in list, Exim gives up its root privilege immediately, and
3496 runs with the real and effective uid and gid set to those of the caller.
3497 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3498 file contains a list of full pathnames, one per line, for configuration files
3499 which are trusted. Root privilege is retained for any configuration file so
3500 listed, as long as the caller is the Exim user (or the user specified in the
3501 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3502 not writeable by inappropriate users or groups.
3503
3504 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3505 configuration using &%-C%& right through message reception and delivery,
3506 even if the caller is root. The reception works, but by that time, Exim is
3507 running as the Exim user, so when it re-executes to regain privilege for the
3508 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3509 test reception and delivery using two separate commands (one to put a message
3510 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3511
3512 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3513 prefix string with which any file named in a &%-C%& command line option
3514 must start. In addition, the file name must not contain the sequence &`/../`&.
3515 However, if the value of the &%-C%& option is identical to the value of
3516 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3517 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3518 unset, any file name can be used with &%-C%&.
3519
3520 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3521 to a directory to which only root has access. This prevents someone who has
3522 broken into the Exim account from running a privileged Exim with an arbitrary
3523 configuration file.
3524
3525 The &%-C%& facility is useful for ensuring that configuration files are
3526 syntactically correct, but cannot be used for test deliveries, unless the
3527 caller is privileged, or unless it is an exotic configuration that does not
3528 require privilege. No check is made on the owner or group of the files
3529 specified by this option.
3530
3531
3532 .vitem &%-D%&<&'macro'&>=<&'value'&>
3533 .oindex "&%-D%&"
3534 .cindex "macro" "setting on command line"
3535 This option can be used to override macro definitions in the configuration file
3536 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3537 unprivileged caller, it causes Exim to give up its root privilege.
3538 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3539 completely disabled, and its use causes an immediate error exit.
3540
3541 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3542 colon-separated list of macros which are considered safe and, if &%-D%& only
3543 supplies macros from this list, and the values are acceptable, then Exim will
3544 not give up root privilege if the caller is root, the Exim run-time user, or
3545 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3546 to be removed in the future.  Acceptable values for the macros satisfy the
3547 regexp: &`^[A-Za-z0-9_/.-]*$`&
3548
3549 The entire option (including equals sign if present) must all be within one
3550 command line item. &%-D%& can be used to set the value of a macro to the empty
3551 string, in which case the equals sign is optional. These two commands are
3552 synonymous:
3553 .code
3554 exim -DABC  ...
3555 exim -DABC= ...
3556 .endd
3557 To include spaces in a macro definition item, quotes must be used. If you use
3558 quotes, spaces are permitted around the macro name and the equals sign. For
3559 example:
3560 .code
3561 exim '-D ABC = something' ...
3562 .endd
3563 &%-D%& may be repeated up to 10 times on a command line.
3564 Only macro names up to 22 letters long can be set.
3565
3566
3567 .vitem &%-d%&<&'debug&~options'&>
3568 .oindex "&%-d%&"
3569 .cindex "debugging" "list of selectors"
3570 .cindex "debugging" "&%-d%& option"
3571 This option causes debugging information to be written to the standard
3572 error stream. It is restricted to admin users because debugging output may show
3573 database queries that contain password information. Also, the details of users'
3574 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3575 writes an error message to the standard error stream and exits with a non-zero
3576 return code.
3577
3578 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3579 standard debugging data is output. This can be reduced, or increased to include
3580 some more rarely needed information, by directly following &%-d%& with a string
3581 made up of names preceded by plus or minus characters. These add or remove sets
3582 of debugging data, respectively. For example, &%-d+filter%& adds filter
3583 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3584 no spaces are allowed in the debug setting. The available debugging categories
3585 are:
3586 .display
3587 &`acl            `& ACL interpretation
3588 &`auth           `& authenticators
3589 &`deliver        `& general delivery logic
3590 &`dns            `& DNS lookups (see also resolver)
3591 &`dnsbl          `& DNS black list (aka RBL) code
3592 &`exec           `& arguments for &[execv()]& calls
3593 &`expand         `& detailed debugging for string expansions
3594 &`filter         `& filter handling
3595 &`hints_lookup   `& hints data lookups
3596 &`host_lookup    `& all types of name-to-IP address handling
3597 &`ident          `& ident lookup
3598 &`interface      `& lists of local interfaces
3599 &`lists          `& matching things in lists
3600 &`load           `& system load checks
3601 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3602                     &<<CHAPlocalscan>>&)
3603 &`lookup         `& general lookup code and all lookups
3604 &`memory         `& memory handling
3605 &`pid            `& add pid to debug output lines
3606 &`process_info   `& setting info for the process log
3607 &`queue_run      `& queue runs
3608 &`receive        `& general message reception logic
3609 &`resolver       `& turn on the DNS resolver's debugging output
3610 &`retry          `& retry handling
3611 &`rewrite        `& address rewriting
3612 &`route          `& address routing
3613 &`timestamp      `& add timestamp to debug output lines
3614 &`tls            `& TLS logic
3615 &`transport      `& transports
3616 &`uid            `& changes of uid/gid and looking up uid/gid
3617 &`verify         `& address verification logic
3618 &`all            `& almost all of the above (see below), and also &%-v%&
3619 .endd
3620 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3621 for &`-all`&. The reason for this is that &`+all`& is something that people
3622 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3623 is included, an awful lot of output that is very rarely of interest is
3624 generated, so it now has to be explicitly requested. However, &`-all`& does
3625 turn everything off.
3626
3627 .cindex "resolver, debugging output"
3628 .cindex "DNS resolver, debugging output"
3629 The &`resolver`& option produces output only if the DNS resolver was compiled
3630 with DEBUG enabled. This is not the case in some operating systems. Also,
3631 unfortunately, debugging output from the DNS resolver is written to stdout
3632 rather than stderr.
3633
3634 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3635 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3636 However, the &`pid`& selector is forced when debugging is turned on for a
3637 daemon, which then passes it on to any re-executed Exims. Exim also
3638 automatically adds the pid to debug lines when several remote deliveries are
3639 run in parallel.
3640
3641 The &`timestamp`& selector causes the current time to be inserted at the start
3642 of all debug output lines. This can be useful when trying to track down delays
3643 in processing.
3644
3645 If the &%debug_print%& option is set in any driver, it produces output whenever
3646 any debugging is selected, or if &%-v%& is used.
3647
3648 .vitem &%-dd%&<&'debug&~options'&>
3649 .oindex "&%-dd%&"
3650 This option behaves exactly like &%-d%& except when used on a command that
3651 starts a daemon process. In that case, debugging is turned off for the
3652 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3653 behaviour of the daemon without creating as much output as full debugging does.
3654
3655 .vitem &%-dropcr%&
3656 .oindex "&%-dropcr%&"
3657 This is an obsolete option that is now a no-op. It used to affect the way Exim
3658 handled CR and LF characters in incoming messages. What happens now is
3659 described in section &<<SECTlineendings>>&.
3660
3661 .vitem &%-E%&
3662 .oindex "&%-E%&"
3663 .cindex "bounce message" "generating"
3664 This option specifies that an incoming message is a locally-generated delivery
3665 failure report. It is used internally by Exim when handling delivery failures
3666 and is not intended for external use. Its only effect is to stop Exim
3667 generating certain messages to the postmaster, as otherwise message cascades
3668 could occur in some situations. As part of the same option, a message id may
3669 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3670 new message contains the id, following &"R="&, as a cross-reference.
3671
3672 .vitem &%-e%&&'x'&
3673 .oindex "&%-e%&&'x'&"
3674 There are a number of Sendmail options starting with &%-oe%& which seem to be
3675 called by various programs without the leading &%o%& in the option. For
3676 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3677 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3678
3679 .vitem &%-F%&&~<&'string'&>
3680 .oindex "&%-F%&"
3681 .cindex "sender" "name"
3682 .cindex "name" "of sender"
3683 This option sets the sender's full name for use when a locally-generated
3684 message is being accepted. In the absence of this option, the user's &'gecos'&
3685 entry from the password data is used. As users are generally permitted to alter
3686 their &'gecos'& entries, no security considerations are involved. White space
3687 between &%-F%& and the <&'string'&> is optional.
3688
3689 .vitem &%-f%&&~<&'address'&>
3690 .oindex "&%-f%&"
3691 .cindex "sender" "address"
3692 .cindex "address" "sender"
3693 .cindex "trusted users"
3694 .cindex "envelope sender"
3695 .cindex "user" "trusted"
3696 This option sets the address of the envelope sender of a locally-generated
3697 message (also known as the return path). The option can normally be used only
3698 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3699 users to use it.
3700
3701 Processes running as root or the Exim user are always trusted. Other
3702 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3703 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3704 of a local message is set to the caller's login name at the default qualify
3705 domain.
3706
3707 There is one exception to the restriction on the use of &%-f%&: an empty sender
3708 can be specified by any user, trusted or not, to create a message that can
3709 never provoke a bounce. An empty sender can be specified either as an empty
3710 string, or as a pair of angle brackets with nothing between them, as in these
3711 examples of shell commands:
3712 .code
3713 exim -f '<>' user@domain
3714 exim -f "" user@domain
3715 .endd
3716 In addition, the use of &%-f%& is not restricted when testing a filter file
3717 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3718 &%-bv%& options.
3719
3720 Allowing untrusted users to change the sender address does not of itself make
3721 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3722 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3723 though this can be overridden by setting &%no_local_from_check%&.
3724
3725 White
3726 .cindex "&""From""& line"
3727 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3728 given as two arguments or one combined argument). The sender of a
3729 locally-generated message can also be set (when permitted) by an initial
3730 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3731 if &%-f%& is also present, it overrides &"From&~"&.
3732
3733 .vitem &%-G%&
3734 .oindex "&%-G%&"
3735 .cindex "submission fixups, suppressing (command-line)"
3736 This option is equivalent to an ACL applying:
3737 .code
3738 control = suppress_local_fixups
3739 .endd
3740 for every message received.  Note that Sendmail will complain about such
3741 bad formatting, where Exim silently just does not fix it up.  This may change
3742 in future.
3743
3744 As this affects audit information, the caller must be a trusted user to use
3745 this option.
3746
3747 .vitem &%-h%&&~<&'number'&>
3748 .oindex "&%-h%&"
3749 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3750 This option is accepted for compatibility with Sendmail, but has no effect. (In
3751 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3752 headers.)
3753
3754 .vitem &%-i%&
3755 .oindex "&%-i%&"
3756 .cindex "Solaris" "&'mail'& command"
3757 .cindex "dot" "in incoming non-SMTP message"
3758 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3759 line by itself should not terminate an incoming, non-SMTP message. I can find
3760 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3761 command in Solaris 2.4 uses it. See also &%-ti%&.
3762
3763 .vitem &%-L%&&~<&'tag'&>
3764 .oindex "&%-L%&"
3765 .cindex "syslog" "process name; set with flag"
3766 This option is equivalent to setting &%syslog_processname%& in the config
3767 file and setting &%log_file_path%& to &`syslog`&.
3768 Its use is restricted to administrators.  The configuration file has to be
3769 read and parsed, to determine access rights, before this is set and takes
3770 effect, so early configuration file errors will not honour this flag.
3771
3772 The tag should not be longer than 32 characters.
3773
3774 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3775 .oindex "&%-M%&"
3776 .cindex "forcing delivery"
3777 .cindex "delivery" "forcing attempt"
3778 .cindex "frozen messages" "forcing delivery"
3779 This option requests Exim to run a delivery attempt on each message in turn. If
3780 any of the messages are frozen, they are automatically thawed before the
3781 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3782 and &%hold_domains%& are ignored.
3783
3784 Retry
3785 .cindex "hints database" "overriding retry hints"
3786 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3787 the normal retry time has not yet been reached. This option requires the caller
3788 to be an admin user. However, there is an option called &%prod_requires_admin%&
3789 which can be set false to relax this restriction (and also the same requirement
3790 for the &%-q%&, &%-R%&, and &%-S%& options).
3791
3792 The deliveries happen synchronously, that is, the original Exim process does
3793 not terminate until all the delivery attempts have finished. No output is
3794 produced unless there is a serious error. If you want to see what is happening,
3795 use the &%-v%& option as well, or inspect Exim's main log.
3796
3797 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3798 .oindex "&%-Mar%&"
3799 .cindex "message" "adding recipients"
3800 .cindex "recipient" "adding"
3801 This option requests Exim to add the addresses to the list of recipients of the
3802 message (&"ar"& for &"add recipients"&). The first argument must be a message
3803 id, and the remaining ones must be email addresses. However, if the message is
3804 active (in the middle of a delivery attempt), it is not altered. This option
3805 can be used only by an admin user.
3806
3807 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3808         &~<&'message&~id'&>"
3809 .oindex "&%-MC%&"
3810 .cindex "SMTP" "passed connection"
3811 .cindex "SMTP" "multiple deliveries"
3812 .cindex "multiple SMTP deliveries"
3813 This option is not intended for use by external callers. It is used internally
3814 by Exim to invoke another instance of itself to deliver a waiting message using
3815 an existing SMTP connection, which is passed as the standard input. Details are
3816 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3817 must be root or the Exim user in order to use it.
3818
3819 .vitem &%-MCA%&
3820 .oindex "&%-MCA%&"
3821 This option is not intended for use by external callers. It is used internally
3822 by Exim in conjunction with the &%-MC%& option. It signifies that the
3823 connection to the remote host has been authenticated.
3824
3825 .vitem &%-MCD%&
3826 .oindex "&%-MCD%&"
3827 This option is not intended for use by external callers. It is used internally
3828 by Exim in conjunction with the &%-MC%& option. It signifies that the
3829 remote host supports the ESMTP &_DSN_& extension.
3830
3831 .vitem &%-MCG%&&~<&'queue&~name'&>
3832 .oindex "&%-MCG%&"
3833 This option is not intended for use by external callers. It is used internally
3834 by Exim in conjunction with the &%-MC%& option. It signifies that an
3835 alternate queue is used, named by the following argument.
3836
3837 .vitem &%-MCK%&
3838 .oindex "&%-MCK%&"
3839 This option is not intended for use by external callers. It is used internally
3840 by Exim in conjunction with the &%-MC%& option. It signifies that an
3841 remote host supports the ESMTP &_CHUNKING_& extension.
3842
3843 .vitem &%-MCP%&
3844 .oindex "&%-MCP%&"
3845 This option is not intended for use by external callers. It is used internally
3846 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3847 which Exim is connected supports pipelining.
3848
3849 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3850 .oindex "&%-MCQ%&"
3851 This option is not intended for use by external callers. It is used internally
3852 by Exim in conjunction with the &%-MC%& option when the original delivery was
3853 started by a queue runner. It passes on the process id of the queue runner,
3854 together with the file descriptor number of an open pipe. Closure of the pipe
3855 signals the final completion of the sequence of processes that are passing
3856 messages through the same SMTP connection.
3857
3858 .vitem &%-MCS%&
3859 .oindex "&%-MCS%&"
3860 This option is not intended for use by external callers. It is used internally
3861 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3862 SMTP SIZE option should be used on messages delivered down the existing
3863 connection.
3864
3865 .vitem &%-MCT%&
3866 .oindex "&%-MCT%&"
3867 This option is not intended for use by external callers. It is used internally
3868 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3869 host to which Exim is connected supports TLS encryption.
3870
3871 .new
3872 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3873 .oindex "&%-MCt%&"
3874 This option is not intended for use by external callers. It is used internally
3875 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3876 connection is being proxied by a parent process for handling TLS encryption.
3877 The arguments give the local address and port being proxied, and the TLS cipher.
3878 .wen
3879
3880 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3881 .oindex "&%-Mc%&"
3882 .cindex "hints database" "not overridden by &%-Mc%&"
3883 .cindex "delivery" "manually started &-- not forced"
3884 This option requests Exim to run a delivery attempt on each message in turn,
3885 but unlike the &%-M%& option, it does check for retry hints, and respects any
3886 that are found. This option is not very useful to external callers. It is
3887 provided mainly for internal use by Exim when it needs to re-invoke itself in
3888 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3889 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3890 respects retry times and other options such as &%hold_domains%& that are
3891 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3892 If you want to run a specific delivery as if in a queue run, you should use
3893 &%-q%& with a message id argument. A distinction between queue run deliveries
3894 and other deliveries is made in one or two places.
3895
3896 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3897 .oindex "&%-Mes%&"
3898 .cindex "message" "changing sender"
3899 .cindex "sender" "changing"
3900 This option requests Exim to change the sender address in the message to the
3901 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3902 &"edit sender"&). There must be exactly two arguments. The first argument must
3903 be a message id, and the second one an email address. However, if the message
3904 is active (in the middle of a delivery attempt), its status is not altered.
3905 This option can be used only by an admin user.
3906
3907 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3908 .oindex "&%-Mf%&"
3909 .cindex "freezing messages"
3910 .cindex "message" "manually freezing"
3911 This option requests Exim to mark each listed message as &"frozen"&. This
3912 prevents any delivery attempts taking place until the message is &"thawed"&,
3913 either manually or as a result of the &%auto_thaw%& configuration option.
3914 However, if any of the messages are active (in the middle of a delivery
3915 attempt), their status is not altered. This option can be used only by an admin
3916 user.
3917
3918 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3919 .oindex "&%-Mg%&"
3920 .cindex "giving up on messages"
3921 .cindex "message" "abandoning delivery attempts"
3922 .cindex "delivery" "abandoning further attempts"
3923 This option requests Exim to give up trying to deliver the listed messages,
3924 including any that are frozen. However, if any of the messages are active,
3925 their status is not altered. For non-bounce messages, a delivery error message
3926 is sent to the sender, containing the text &"cancelled by administrator"&.
3927 Bounce messages are just discarded. This option can be used only by an admin
3928 user.
3929
3930 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3931 .oindex "&%-Mmad%&"
3932 .cindex "delivery" "cancelling all"
3933 This option requests Exim to mark all the recipient addresses in the messages
3934 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3935 message is active (in the middle of a delivery attempt), its status is not
3936 altered. This option can be used only by an admin user.
3937
3938 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3939 .oindex "&%-Mmd%&"
3940 .cindex "delivery" "cancelling by address"
3941 .cindex "recipient" "removing"
3942 .cindex "removing recipients"
3943 This option requests Exim to mark the given addresses as already delivered
3944 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3945 the remaining ones must be email addresses. These are matched to recipient
3946 addresses in the message in a case-sensitive manner. If the message is active
3947 (in the middle of a delivery attempt), its status is not altered. This option
3948 can be used only by an admin user.
3949
3950 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3951 .oindex "&%-Mrm%&"
3952 .cindex "removing messages"
3953 .cindex "abandoning mail"
3954 .cindex "message" "manually discarding"
3955 This option requests Exim to remove the given messages from the queue. No
3956 bounce messages are sent; each message is simply forgotten. However, if any of
3957 the messages are active, their status is not altered. This option can be used
3958 only by an admin user or by the user who originally caused the message to be
3959 placed on the queue.
3960
3961 .vitem &%-Mset%&&~<&'message&~id'&>
3962 .oindex "&%-Mset%&
3963 .cindex "testing" "string expansion"
3964 .cindex "expansion" "testing"
3965 This option is useful only in conjunction with &%-be%& (that is, when testing
3966 string expansions). Exim loads the given message from its spool before doing
3967 the test expansions, thus setting message-specific variables such as
3968 &$message_size$& and the header variables. The &$recipients$& variable is made
3969 available. This feature is provided to make it easier to test expansions that
3970 make use of these variables. However, this option can be used only by an admin
3971 user. See also &%-bem%&.
3972
3973 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3974 .oindex "&%-Mt%&"
3975 .cindex "thawing messages"
3976 .cindex "unfreezing messages"
3977 .cindex "frozen messages" "thawing"
3978 .cindex "message" "thawing frozen"
3979 This option requests Exim to &"thaw"& any of the listed messages that are
3980 &"frozen"&, so that delivery attempts can resume. However, if any of the
3981 messages are active, their status is not altered. This option can be used only
3982 by an admin user.
3983
3984 .vitem &%-Mvb%&&~<&'message&~id'&>
3985 .oindex "&%-Mvb%&"
3986 .cindex "listing" "message body"
3987 .cindex "message" "listing body of"
3988 This option causes the contents of the message body (-D) spool file to be
3989 written to the standard output. This option can be used only by an admin user.
3990
3991 .vitem &%-Mvc%&&~<&'message&~id'&>
3992 .oindex "&%-Mvc%&"
3993 .cindex "message" "listing in RFC 2822 format"
3994 .cindex "listing" "message in RFC 2822 format"
3995 This option causes a copy of the complete message (header lines plus body) to
3996 be written to the standard output in RFC 2822 format. This option can be used
3997 only by an admin user.
3998
3999 .vitem &%-Mvh%&&~<&'message&~id'&>
4000 .oindex "&%-Mvh%&"
4001 .cindex "listing" "message headers"
4002 .cindex "header lines" "listing"
4003 .cindex "message" "listing header lines"
4004 This option causes the contents of the message headers (-H) spool file to be
4005 written to the standard output. This option can be used only by an admin user.
4006
4007 .vitem &%-Mvl%&&~<&'message&~id'&>
4008 .oindex "&%-Mvl%&"
4009 .cindex "listing" "message log"
4010 .cindex "message" "listing message log"
4011 This option causes the contents of the message log spool file to be written to
4012 the standard output. This option can be used only by an admin user.
4013
4014 .vitem &%-m%&
4015 .oindex "&%-m%&"
4016 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4017 treats it that way too.
4018
4019 .vitem &%-N%&
4020 .oindex "&%-N%&"
4021 .cindex "debugging" "&%-N%& option"
4022 .cindex "debugging" "suppressing delivery"
4023 This is a debugging option that inhibits delivery of a message at the transport
4024 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4025 it just doesn't actually transport the message, but instead behaves as if it
4026 had successfully done so. However, it does not make any updates to the retry
4027 database, and the log entries for deliveries are flagged with &"*>"& rather
4028 than &"=>"&.
4029
4030 Because &%-N%& discards any message to which it applies, only root or the Exim
4031 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4032 words, an ordinary user can use it only when supplying an incoming message to
4033 which it will apply. Although transportation never fails when &%-N%& is set, an
4034 address may be deferred because of a configuration problem on a transport, or a
4035 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4036 the message, and applies to any subsequent delivery attempts that may happen
4037 for that message.
4038
4039 .vitem &%-n%&
4040 .oindex "&%-n%&"
4041 This option is interpreted by Sendmail to mean &"no aliasing"&.
4042 For normal modes of operation, it is ignored by Exim.
4043 When combined with &%-bP%& it makes the output more terse (suppresses
4044 option names, environment values and config pretty printing).
4045
4046 .vitem &%-O%&&~<&'data'&>
4047 .oindex "&%-O%&"
4048 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4049 Exim.
4050
4051 .vitem &%-oA%&&~<&'file&~name'&>
4052 .oindex "&%-oA%&"
4053 .cindex "Sendmail compatibility" "&%-oA%& option"
4054 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4055 alternative alias file name. Exim handles &%-bi%& differently; see the
4056 description above.
4057
4058 .vitem &%-oB%&&~<&'n'&>
4059 .oindex "&%-oB%&"
4060 .cindex "SMTP" "passed connection"
4061 .cindex "SMTP" "multiple deliveries"
4062 .cindex "multiple SMTP deliveries"
4063 This is a debugging option which limits the maximum number of messages that can
4064 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4065 transport. If <&'n'&> is omitted, the limit is set to 1.
4066
4067 .vitem &%-odb%&
4068 .oindex "&%-odb%&"
4069 .cindex "background delivery"
4070 .cindex "delivery" "in the background"
4071 This option applies to all modes in which Exim accepts incoming messages,
4072 including the listening daemon. It requests &"background"& delivery of such
4073 messages, which means that the accepting process automatically starts a
4074 delivery process for each message received, but does not wait for the delivery
4075 processes to finish.
4076
4077 When all the messages have been received, the reception process exits,
4078 leaving the delivery processes to finish in their own time. The standard output
4079 and error streams are closed at the start of each delivery process.
4080 This is the default action if none of the &%-od%& options are present.
4081
4082 If one of the queueing options in the configuration file
4083 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4084 overrides it if &%queue_only_override%& is set true, which is the default
4085 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4086
4087 .vitem &%-odf%&
4088 .oindex "&%-odf%&"
4089 .cindex "foreground delivery"
4090 .cindex "delivery" "in the foreground"
4091 This option requests &"foreground"& (synchronous) delivery when Exim has
4092 accepted a locally-generated message. (For the daemon it is exactly the same as
4093 &%-odb%&.) A delivery process is automatically started to deliver the message,
4094 and Exim waits for it to complete before proceeding.
4095
4096 The original Exim reception process does not finish until the delivery
4097 process for the final message has ended. The standard error stream is left open
4098 during deliveries.
4099
4100 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4101 false and one of the queueing options in the configuration file is in effect.
4102
4103 If there is a temporary delivery error during foreground delivery, the
4104 message is left on the queue for later delivery, and the original reception
4105 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4106 restricted configuration that never queues messages.
4107
4108
4109 .vitem &%-odi%&
4110 .oindex "&%-odi%&"
4111 This option is synonymous with &%-odf%&. It is provided for compatibility with
4112 Sendmail.
4113
4114 .vitem &%-odq%&
4115 .oindex "&%-odq%&"
4116 .cindex "non-immediate delivery"
4117 .cindex "delivery" "suppressing immediate"
4118 .cindex "queueing incoming messages"
4119 This option applies to all modes in which Exim accepts incoming messages,
4120 including the listening daemon. It specifies that the accepting process should
4121 not automatically start a delivery process for each message received. Messages
4122 are placed on the queue, and remain there until a subsequent queue runner
4123 process encounters them. There are several configuration options (such as
4124 &%queue_only%&) that can be used to queue incoming messages under certain
4125 conditions. This option overrides all of them and also &%-odqs%&. It always
4126 forces queueing.
4127
4128 .vitem &%-odqs%&
4129 .oindex "&%-odqs%&"
4130 .cindex "SMTP" "delaying delivery"
4131 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4132 However, like &%-odb%& and &%-odi%&, this option has no effect if
4133 &%queue_only_override%& is false and one of the queueing options in the
4134 configuration file is in effect.
4135
4136 When &%-odqs%& does operate, a delivery process is started for each incoming
4137 message, in the background by default, but in the foreground if &%-odi%& is
4138 also present. The recipient addresses are routed, and local deliveries are done
4139 in the normal way. However, if any SMTP deliveries are required, they are not
4140 done at this time, so the message remains on the queue until a subsequent queue
4141 runner process encounters it. Because routing was done, Exim knows which
4142 messages are waiting for which hosts, and so a number of messages for the same
4143 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4144 configuration option has the same effect for specific domains. See also the
4145 &%-qq%& option.
4146
4147 .vitem &%-oee%&
4148 .oindex "&%-oee%&"
4149 .cindex "error" "reporting"
4150 If an error is detected while a non-SMTP message is being received (for
4151 example, a malformed address), the error is reported to the sender in a mail
4152 message.
4153
4154 .cindex "return code" "for &%-oee%&"
4155 Provided
4156 this error message is successfully sent, the Exim receiving process
4157 exits with a return code of zero. If not, the return code is 2 if the problem
4158 is that the original message has no recipients, or 1 for any other error.
4159 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4160
4161 .vitem &%-oem%&
4162 .oindex "&%-oem%&"
4163 .cindex "error" "reporting"
4164 .cindex "return code" "for &%-oem%&"
4165 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4166 return code, whether or not the error message was successfully sent.
4167 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4168
4169 .vitem &%-oep%&
4170 .oindex "&%-oep%&"
4171 .cindex "error" "reporting"
4172 If an error is detected while a non-SMTP message is being received, the
4173 error is reported by writing a message to the standard error file (stderr).
4174 .cindex "return code" "for &%-oep%&"
4175 The return code is 1 for all errors.
4176
4177 .vitem &%-oeq%&
4178 .oindex "&%-oeq%&"
4179 .cindex "error" "reporting"
4180 This option is supported for compatibility with Sendmail, but has the same
4181 effect as &%-oep%&.
4182
4183 .vitem &%-oew%&
4184 .oindex "&%-oew%&"
4185 .cindex "error" "reporting"
4186 This option is supported for compatibility with Sendmail, but has the same
4187 effect as &%-oem%&.
4188
4189 .vitem &%-oi%&
4190 .oindex "&%-oi%&"
4191 .cindex "dot" "in incoming non-SMTP message"
4192 This option, which has the same effect as &%-i%&, specifies that a dot on a
4193 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4194 single dot does terminate, though Exim does no special processing for other
4195 lines that start with a dot. This option is set by default if Exim is called as
4196 &'rmail'&. See also &%-ti%&.
4197
4198 .vitem &%-oitrue%&
4199 .oindex "&%-oitrue%&"
4200 This option is treated as synonymous with &%-oi%&.
4201
4202 .vitem &%-oMa%&&~<&'host&~address'&>
4203 .oindex "&%-oMa%&"
4204 .cindex "sender" "host address, specifying for local message"
4205 A number of options starting with &%-oM%& can be used to set values associated
4206 with remote hosts on locally-submitted messages (that is, messages not received
4207 over TCP/IP). These options can be used by any caller in conjunction with the
4208 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4209 other circumstances, they are ignored unless the caller is trusted.
4210
4211 The &%-oMa%& option sets the sender host address. This may include a port
4212 number at the end, after a full stop (period). For example:
4213 .code
4214 exim -bs -oMa 10.9.8.7.1234
4215 .endd
4216 An alternative syntax is to enclose the IP address in square brackets,
4217 followed by a colon and the port number:
4218 .code
4219 exim -bs -oMa [10.9.8.7]:1234
4220 .endd
4221 The IP address is placed in the &$sender_host_address$& variable, and the
4222 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4223 are present on the command line, the sender host IP address is taken from
4224 whichever one is last.
4225
4226 .vitem &%-oMaa%&&~<&'name'&>
4227 .oindex "&%-oMaa%&"
4228 .cindex "authentication" "name, specifying for local message"
4229 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4230 option sets the value of &$sender_host_authenticated$& (the authenticator
4231 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4232 This option can be used with &%-bh%& and &%-bs%& to set up an
4233 authenticated SMTP session without actually using the SMTP AUTH command.
4234
4235 .vitem &%-oMai%&&~<&'string'&>
4236 .oindex "&%-oMai%&"
4237 .cindex "authentication" "id, specifying for local message"
4238 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4239 option sets the value of &$authenticated_id$& (the id that was authenticated).
4240 This overrides the default value (the caller's login id, except with &%-bh%&,
4241 where there is no default) for messages from local sources. See chapter
4242 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4243
4244 .vitem &%-oMas%&&~<&'address'&>
4245 .oindex "&%-oMas%&"
4246 .cindex "authentication" "sender, specifying for local message"
4247 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4248 option sets the authenticated sender value in &$authenticated_sender$&. It
4249 overrides the sender address that is created from the caller's login id for
4250 messages from local sources, except when &%-bh%& is used, when there is no
4251 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4252 specified on a MAIL command overrides this value. See chapter
4253 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4254
4255 .vitem &%-oMi%&&~<&'interface&~address'&>
4256 .oindex "&%-oMi%&"
4257 .cindex "interface" "address, specifying for local message"
4258 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4259 option sets the IP interface address value. A port number may be included,
4260 using the same syntax as for &%-oMa%&. The interface address is placed in
4261 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4262
4263 .vitem &%-oMm%&&~<&'message&~reference'&>
4264 .oindex "&%-oMm%&"
4265 .cindex "message reference" "message reference, specifying for local message"
4266 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4267 option sets the message reference, e.g. message-id, and is logged during
4268 delivery. This is useful when some kind of audit trail is required to tie
4269 messages together. The format of the message reference is checked and will
4270 abort if the format is invalid. The option will only be accepted if exim is
4271 running in trusted mode, not as any regular user.
4272
4273 The best example of a message reference is when Exim sends a bounce message.
4274 The message reference is the message-id of the original message for which Exim
4275 is sending the bounce.
4276
4277 .vitem &%-oMr%&&~<&'protocol&~name'&>
4278 .oindex "&%-oMr%&"
4279 .cindex "protocol, specifying for local message"
4280 .vindex "&$received_protocol$&"
4281 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4282 option sets the received protocol value that is stored in
4283 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4284 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4285 SMTP protocol names (see the description of &$received_protocol$& in section
4286 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4287 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4288 be set by &%-oMr%&.
4289
4290 .vitem &%-oMs%&&~<&'host&~name'&>
4291 .oindex "&%-oMs%&"
4292 .cindex "sender" "host name, specifying for local message"
4293 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4294 option sets the sender host name in &$sender_host_name$&. When this option is
4295 present, Exim does not attempt to look up a host name from an IP address; it
4296 uses the name it is given.
4297
4298 .vitem &%-oMt%&&~<&'ident&~string'&>
4299 .oindex "&%-oMt%&"
4300 .cindex "sender" "ident string, specifying for local message"
4301 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4302 option sets the sender ident value in &$sender_ident$&. The default setting for
4303 local callers is the login id of the calling process, except when &%-bh%& is
4304 used, when there is no default.
4305
4306 .vitem &%-om%&
4307 .oindex "&%-om%&"
4308 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4309 In Sendmail, this option means &"me too"&, indicating that the sender of a
4310 message should receive a copy of the message if the sender appears in an alias
4311 expansion. Exim always does this, so the option does nothing.
4312
4313 .vitem &%-oo%&
4314 .oindex "&%-oo%&"
4315 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4316 This option is ignored. In Sendmail it specifies &"old style headers"&,
4317 whatever that means.
4318
4319 .vitem &%-oP%&&~<&'path'&>
4320 .oindex "&%-oP%&"
4321 .cindex "pid (process id)" "of daemon"
4322 .cindex "daemon" "process id (pid)"
4323 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4324 value. The option specifies the file to which the process id of the daemon is
4325 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4326 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4327 because in those cases, the normal pid file is not used.
4328
4329 .vitem &%-or%&&~<&'time'&>
4330 .oindex "&%-or%&"
4331 .cindex "timeout" "for non-SMTP input"
4332 This option sets a timeout value for incoming non-SMTP messages. If it is not
4333 set, Exim will wait forever for the standard input. The value can also be set
4334 by the &%receive_timeout%& option. The format used for specifying times is
4335 described in section &<<SECTtimeformat>>&.
4336
4337 .vitem &%-os%&&~<&'time'&>
4338 .oindex "&%-os%&"
4339 .cindex "timeout" "for SMTP input"
4340 .cindex "SMTP" "input timeout"
4341 This option sets a timeout value for incoming SMTP messages. The timeout
4342 applies to each SMTP command and block of data. The value can also be set by
4343 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4344 for specifying times is described in section &<<SECTtimeformat>>&.
4345
4346 .vitem &%-ov%&
4347 .oindex "&%-ov%&"
4348 This option has exactly the same effect as &%-v%&.
4349
4350 .vitem &%-oX%&&~<&'number&~or&~string'&>
4351 .oindex "&%-oX%&"
4352 .cindex "TCP/IP" "setting listening ports"
4353 .cindex "TCP/IP" "setting listening interfaces"
4354 .cindex "port" "receiving TCP/IP"
4355 This option is relevant only when the &%-bd%& (start listening daemon) option
4356 is also given. It controls which ports and interfaces the daemon uses. Details
4357 of the syntax, and how it interacts with configuration file options, are given
4358 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4359 file is written unless &%-oP%& is also present to specify a pid file name.
4360
4361 .vitem &%-pd%&
4362 .oindex "&%-pd%&"
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 be delayed until it is
4367 needed.
4368
4369 .vitem &%-ps%&
4370 .oindex "&%-ps%&"
4371 .cindex "Perl" "starting the interpreter"
4372 This option applies when an embedded Perl interpreter is linked with Exim (see
4373 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4374 option, forcing the starting of the interpreter to occur as soon as Exim is
4375 started.
4376
4377 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4378 .oindex "&%-p%&"
4379 For compatibility with Sendmail, this option is equivalent to
4380 .display
4381 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4382 .endd
4383 It sets the incoming protocol and host name (for trusted callers). The
4384 host name and its colon can be omitted when only the protocol is to be set.
4385 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4386 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4387 or &`s`& using this option (but that does not seem a real limitation).
4388
4389 .vitem &%-q%&
4390 .oindex "&%-q%&"
4391 .cindex "queue runner" "starting manually"
4392 This option is normally restricted to admin users. However, there is a
4393 configuration option called &%prod_requires_admin%& which can be set false to
4394 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4395 and &%-S%& options).
4396
4397 .cindex "queue runner" "description of operation"
4398 If other commandline options do not specify an action,
4399 the &%-q%& option starts one queue runner process. This scans the queue of
4400 waiting messages, and runs a delivery process for each one in turn. It waits
4401 for each delivery process to finish before starting the next one. A delivery
4402 process may not actually do any deliveries if the retry times for the addresses
4403 have not been reached. Use &%-qf%& (see below) if you want to override this.
4404
4405 If
4406 .cindex "SMTP" "passed connection"
4407 .cindex "SMTP" "multiple deliveries"
4408 .cindex "multiple SMTP deliveries"
4409 the delivery process spawns other processes to deliver other messages down
4410 passed SMTP connections, the queue runner waits for these to finish before
4411 proceeding.
4412
4413 When all the queued messages have been considered, the original queue runner
4414 process terminates. In other words, a single pass is made over the waiting
4415 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4416 this to be repeated periodically.
4417
4418 Exim processes the waiting messages in an unpredictable order. It isn't very
4419 random, but it is likely to be different each time, which is all that matters.
4420 If one particular message screws up a remote MTA, other messages to the same
4421 MTA have a chance of getting through if they get tried first.
4422
4423 It is possible to cause the messages to be processed in lexical message id
4424 order, which is essentially the order in which they arrived, by setting the
4425 &%queue_run_in_order%& option, but this is not recommended for normal use.
4426
4427 .vitem &%-q%&<&'qflags'&>
4428 The &%-q%& option may be followed by one or more flag letters that change its
4429 behaviour. They are all optional, but if more than one is present, they must
4430 appear in the correct order. Each flag is described in a separate item below.
4431
4432 .vitem &%-qq...%&
4433 .oindex "&%-qq%&"
4434 .cindex "queue" "double scanning"
4435 .cindex "queue" "routing"
4436 .cindex "routing" "whole queue before delivery"
4437 An option starting with &%-qq%& requests a two-stage queue run. In the first
4438 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4439 every domain. Addresses are routed, local deliveries happen, but no remote
4440 transports are run.
4441
4442 .cindex "hints database" "remembering routing"
4443 The hints database that remembers which messages are waiting for specific hosts
4444 is updated, as if delivery to those hosts had been deferred. After this is
4445 complete, a second, normal queue scan happens, with routing and delivery taking
4446 place as normal. Messages that are routed to the same host should mostly be
4447 delivered down a single SMTP
4448 .cindex "SMTP" "passed connection"
4449 .cindex "SMTP" "multiple deliveries"
4450 .cindex "multiple SMTP deliveries"
4451 connection because of the hints that were set up during the first queue scan.
4452 This option may be useful for hosts that are connected to the Internet
4453 intermittently.
4454
4455 .vitem &%-q[q]i...%&
4456 .oindex "&%-qi%&"
4457 .cindex "queue" "initial delivery"
4458 If the &'i'& flag is present, the queue runner runs delivery processes only for
4459 those messages that haven't previously been tried. (&'i'& stands for &"initial
4460 delivery"&.) This can be helpful if you are putting messages on the queue using
4461 &%-odq%& and want a queue runner just to process the new messages.
4462
4463 .vitem &%-q[q][i]f...%&
4464 .oindex "&%-qf%&"
4465 .cindex "queue" "forcing delivery"
4466 .cindex "delivery" "forcing in queue run"
4467 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4468 message, whereas without &'f'& only those non-frozen addresses that have passed
4469 their retry times are tried.
4470
4471 .vitem &%-q[q][i]ff...%&
4472 .oindex "&%-qff%&"
4473 .cindex "frozen messages" "forcing delivery"
4474 If &'ff'& is present, a delivery attempt is forced for every message, whether
4475 frozen or not.
4476
4477 .vitem &%-q[q][i][f[f]]l%&
4478 .oindex "&%-ql%&"
4479 .cindex "queue" "local deliveries only"
4480 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4481 be done. If a message requires any remote deliveries, it remains on the queue
4482 for later delivery.
4483
4484 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4485 .oindex "&%-qG%&"
4486 .cindex queue named
4487 .cindex "named queues"
4488 .cindex "queue" "delivering specific messages"
4489 If the &'G'& flag and a name is present, the queue runner operates on the
4490 queue with the given name rather than the default queue.
4491 The name should not contain a &'/'& character.
4492 For a periodic queue run (see below)
4493 append to the name a slash and a time value.
4494
4495 If other commandline options specify an action, a &'-qG<name>'& option
4496 will specify a queue to operate on.
4497 For example:
4498 .code
4499 exim -bp -qGquarantine
4500 mailq -qGquarantine
4501 exim -qGoffpeak -Rf @special.domain.example
4502 .endd
4503
4504 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4505 When scanning the queue, Exim can be made to skip over messages whose ids are
4506 lexically less than a given value by following the &%-q%& option with a
4507 starting message id. For example:
4508 .code
4509 exim -q 0t5C6f-0000c8-00
4510 .endd
4511 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4512 second message id is given, messages whose ids are lexically greater than it
4513 are also skipped. If the same id is given twice, for example,
4514 .code
4515 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4516 .endd
4517 just one delivery process is started, for that message. This differs from
4518 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4519 that it counts as a delivery from a queue run. Note that the selection
4520 mechanism does not affect the order in which the messages are scanned. There
4521 are also other ways of selecting specific sets of messages for delivery in a
4522 queue run &-- see &%-R%& and &%-S%&.
4523
4524 .vitem &%-q%&<&'qflags'&><&'time'&>
4525 .cindex "queue runner" "starting periodically"
4526 .cindex "periodic queue running"
4527 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4528 starting a queue runner process at intervals specified by the given time value
4529 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4530 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4531 single daemon process handles both functions. A common way of starting up a
4532 combined daemon at system boot time is to use a command such as
4533 .code
4534 /usr/exim/bin/exim -bd -q30m
4535 .endd
4536 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4537 process every 30 minutes.
4538
4539 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4540 pid file is written unless one is explicitly requested by the &%-oP%& option.
4541
4542 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4543 .oindex "&%-qR%&"
4544 This option is synonymous with &%-R%&. It is provided for Sendmail
4545 compatibility.
4546
4547 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4548 .oindex "&%-qS%&"
4549 This option is synonymous with &%-S%&.
4550
4551 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4552 .oindex "&%-R%&"
4553 .cindex "queue runner" "for specific recipients"
4554 .cindex "delivery" "to given domain"
4555 .cindex "domain" "delivery to"
4556 The <&'rsflags'&> may be empty, in which case the white space before the string
4557 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4558 which are the possible values for <&'rsflags'&>. White space is required if
4559 <&'rsflags'&> is not empty.
4560
4561 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4562 perform a single queue run, except that, when scanning the messages on the
4563 queue, Exim processes only those that have at least one undelivered recipient
4564 address containing the given string, which is checked in a case-independent
4565 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4566 regular expression; otherwise it is a literal string.
4567
4568 If you want to do periodic queue runs for messages with specific recipients,
4569 you can combine &%-R%& with &%-q%& and a time value. For example:
4570 .code
4571 exim -q25m -R @special.domain.example
4572 .endd
4573 This example does a queue run for messages with recipients in the given domain
4574 every 25 minutes. Any additional flags that are specified with &%-q%& are
4575 applied to each queue run.
4576
4577 Once a message is selected for delivery by this mechanism, all its addresses
4578 are processed. For the first selected message, Exim overrides any retry
4579 information and forces a delivery attempt for each undelivered address. This
4580 means that if delivery of any address in the first message is successful, any
4581 existing retry information is deleted, and so delivery attempts for that
4582 address in subsequently selected messages (which are processed without forcing)
4583 will run. However, if delivery of any address does not succeed, the retry
4584 information is updated, and in subsequently selected messages, the failing
4585 address will be skipped.
4586
4587 .cindex "frozen messages" "forcing delivery"
4588 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4589 all selected messages, not just the first; frozen messages are included when
4590 &'ff'& is present.
4591
4592 The &%-R%& option makes it straightforward to initiate delivery of all messages
4593 to a given domain after a host has been down for some time. When the SMTP
4594 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4595 effect is to run Exim with the &%-R%& option, but it can be configured to run
4596 an arbitrary command instead.
4597
4598 .vitem &%-r%&
4599 .oindex "&%-r%&"
4600 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4601
4602 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4603 .oindex "&%-S%&"
4604 .cindex "delivery" "from given sender"
4605 .cindex "queue runner" "for specific senders"
4606 This option acts like &%-R%& except that it checks the string against each
4607 message's sender instead of against the recipients. If &%-R%& is also set, both
4608 conditions must be met for a message to be selected. If either of the options
4609 has &'f'& or &'ff'& in its flags, the associated action is taken.
4610
4611 .vitem &%-Tqt%&&~<&'times'&>
4612 .oindex "&%-Tqt%&"
4613 This is an option that is exclusively for use by the Exim testing suite. It is not
4614 recognized when Exim is run normally. It allows for the setting up of explicit
4615 &"queue times"& so that various warning/retry features can be tested.
4616
4617 .vitem &%-t%&
4618 .oindex "&%-t%&"
4619 .cindex "recipient" "extracting from header lines"
4620 .cindex "&'Bcc:'& header line"
4621 .cindex "&'Cc:'& header line"
4622 .cindex "&'To:'& header line"
4623 When Exim is receiving a locally-generated, non-SMTP message on its standard
4624 input, the &%-t%& option causes the recipients of the message to be obtained
4625 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4626 from the command arguments. The addresses are extracted before any rewriting
4627 takes place and the &'Bcc:'& header line, if present, is then removed.
4628
4629 .cindex "Sendmail compatibility" "&%-t%& option"
4630 If the command has any arguments, they specify addresses to which the message
4631 is &'not'& to be delivered. That is, the argument addresses are removed from
4632 the recipients list obtained from the headers. This is compatible with Smail 3
4633 and in accordance with the documented behaviour of several versions of
4634 Sendmail, as described in man pages on a number of operating systems (e.g.
4635 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4636 argument addresses to those obtained from the headers, and the O'Reilly
4637 Sendmail book documents it that way. Exim can be made to add argument addresses
4638 instead of subtracting them by setting the option
4639 &%extract_addresses_remove_arguments%& false.
4640
4641 .cindex "&%Resent-%& header lines" "with &%-t%&"
4642 If there are any &%Resent-%& header lines in the message, Exim extracts
4643 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4644 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4645 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4646 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4647
4648 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4649 message is resent several times). The RFC also specifies that they should be
4650 added at the front of the message, and separated by &'Received:'& lines. It is
4651 not at all clear how &%-t%& should operate in the present of multiple sets,
4652 nor indeed exactly what constitutes a &"set"&.
4653 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4654 are often added at the end of the header, and if a message is resent more than
4655 once, it is common for the original set of &%Resent-%& headers to be renamed as
4656 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4657
4658 .vitem &%-ti%&
4659 .oindex "&%-ti%&"
4660 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4661 compatibility with Sendmail.
4662
4663 .vitem &%-tls-on-connect%&
4664 .oindex "&%-tls-on-connect%&"
4665 .cindex "TLS" "use without STARTTLS"
4666 .cindex "TLS" "automatic start"
4667 This option is available when Exim is compiled with TLS support. It forces all
4668 incoming SMTP connections to behave as if the incoming port is listed in the
4669 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4670 &<<CHAPTLS>>& for further details.
4671
4672
4673 .vitem &%-U%&
4674 .oindex "&%-U%&"
4675 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4676 Sendmail uses this option for &"initial message submission"&, and its
4677 documentation states that in future releases, it may complain about
4678 syntactically invalid messages rather than fixing them when this flag is not
4679 set. Exim ignores this option.
4680
4681 .vitem &%-v%&
4682 .oindex "&%-v%&"
4683 This option causes Exim to write information to the standard error stream,
4684 describing what it is doing. In particular, it shows the log lines for
4685 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4686 dialogue is shown. Some of the log lines shown may not actually be written to
4687 the log if the setting of &%log_selector%& discards them. Any relevant
4688 selectors are shown with each log line. If none are shown, the logging is
4689 unconditional.
4690
4691 .vitem &%-x%&
4692 .oindex "&%-x%&"
4693 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4694 National Language Support extended characters in the body of the mail item"&).
4695 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4696 this option.
4697
4698 .vitem &%-X%&&~<&'logfile'&>
4699 .oindex "&%-X%&"
4700 This option is interpreted by Sendmail to cause debug information to be sent
4701 to the named file.  It is ignored by Exim.
4702
4703 .vitem &%-z%&&~<&'log-line'&>
4704 .oindex "&%-z%&"
4705 This option writes its argument to Exim's logfile.
4706 Use is restricted to administrators; the intent is for operational notes.
4707 Quotes should be used to maintain a multi-word item as a single argument,
4708 under most shells.
4709 .endlist
4710
4711 .ecindex IIDclo1
4712 .ecindex IIDclo2
4713
4714
4715 . ////////////////////////////////////////////////////////////////////////////
4716 . Insert a stylized DocBook comment here, to identify the end of the command
4717 . line options. This is for the benefit of the Perl script that automatically
4718 . creates a man page for the options.
4719 . ////////////////////////////////////////////////////////////////////////////
4720
4721 .literal xml
4722 <!-- === End of command line options === -->
4723 .literal off
4724
4725
4726
4727
4728
4729 . ////////////////////////////////////////////////////////////////////////////
4730 . ////////////////////////////////////////////////////////////////////////////
4731
4732
4733 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4734          "The runtime configuration file"
4735
4736 .cindex "run time configuration"
4737 .cindex "configuration file" "general description"
4738 .cindex "CONFIGURE_FILE"
4739 .cindex "configuration file" "errors in"
4740 .cindex "error" "in configuration file"
4741 .cindex "return code" "for bad configuration"
4742 Exim uses a single run time configuration file that is read whenever an Exim
4743 binary is executed. Note that in normal operation, this happens frequently,
4744 because Exim is designed to operate in a distributed manner, without central
4745 control.
4746
4747 If a syntax error is detected while reading the configuration file, Exim
4748 writes a message on the standard error, and exits with a non-zero return code.
4749 The message is also written to the panic log. &*Note*&: Only simple syntax
4750 errors can be detected at this time. The values of any expanded options are
4751 not checked until the expansion happens, even when the expansion does not
4752 actually alter the string.
4753
4754 The name of the configuration file is compiled into the binary for security
4755 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4756 most configurations, this specifies a single file. However, it is permitted to
4757 give a colon-separated list of file names, in which case Exim uses the first
4758 existing file in the list.
4759
4760 .cindex "EXIM_USER"
4761 .cindex "EXIM_GROUP"
4762 .cindex "CONFIGURE_OWNER"
4763 .cindex "CONFIGURE_GROUP"
4764 .cindex "configuration file" "ownership"
4765 .cindex "ownership" "configuration file"
4766 The run time configuration file must be owned by root or by the user that is
4767 specified at compile time by the CONFIGURE_OWNER option (if set). The
4768 configuration file must not be world-writeable, or group-writeable unless its
4769 group is the root group or the one specified at compile time by the
4770 CONFIGURE_GROUP option.
4771
4772 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4773 to root, anybody who is able to edit the run time configuration file has an
4774 easy way to run commands as root. If you specify a user or group in the
4775 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4776 who are members of that group will trivially be able to obtain root privileges.
4777
4778 Up to Exim version 4.72, the run time configuration file was also permitted to
4779 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4780 since it offered a simple privilege escalation for any attacker who managed to
4781 compromise the Exim user account.
4782
4783 A default configuration file, which will work correctly in simple situations,
4784 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4785 defines just one file name, the installation process copies the default
4786 configuration to a new file of that name if it did not previously exist. If
4787 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4788 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4789 configuration.
4790
4791
4792
4793 .section "Using a different configuration file" "SECID40"
4794 .cindex "configuration file" "alternate"
4795 A one-off alternate configuration can be specified by the &%-C%& command line
4796 option, which may specify a single file or a list of files. However, when
4797 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4798 unless the argument for &%-C%& is identical to the built-in value from
4799 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4800 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4801 is useful mainly for checking the syntax of configuration files before
4802 installing them. No owner or group checks are done on a configuration file
4803 specified by &%-C%&, if root privilege has been dropped.
4804
4805 Even the Exim user is not trusted to specify an arbitrary configuration file
4806 with the &%-C%& option to be used with root privileges, unless that file is
4807 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4808 testing a configuration using &%-C%& right through message reception and
4809 delivery, even if the caller is root. The reception works, but by that time,
4810 Exim is running as the Exim user, so when it re-execs to regain privilege for
4811 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4812 can test reception and delivery using two separate commands (one to put a
4813 message on the queue, using &%-odq%&, and another to do the delivery, using
4814 &%-M%&).
4815
4816 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4817 prefix string with which any file named in a &%-C%& command line option must
4818 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4819 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4820 name can be used with &%-C%&.
4821
4822 One-off changes to a configuration can be specified by the &%-D%& command line
4823 option, which defines and overrides values for macros used inside the
4824 configuration file. However, like &%-C%&, the use of this option by a
4825 non-privileged user causes Exim to discard its root privilege.
4826 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4827 completely disabled, and its use causes an immediate error exit.
4828
4829 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4830 to declare certain macro names trusted, such that root privilege will not
4831 necessarily be discarded.
4832 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4833 considered safe and, if &%-D%& only supplies macros from this list, and the
4834 values are acceptable, then Exim will not give up root privilege if the caller
4835 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4836 transition mechanism and is expected to be removed in the future.  Acceptable
4837 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4838
4839 Some sites may wish to use the same Exim binary on different machines that
4840 share a file system, but to use different configuration files on each machine.
4841 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4842 looks for a file whose name is the configuration file name followed by a dot
4843 and the machine's node name, as obtained from the &[uname()]& function. If this
4844 file does not exist, the standard name is tried. This processing occurs for
4845 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4846
4847 In some esoteric situations different versions of Exim may be run under
4848 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4849 help with this. See the comments in &_src/EDITME_& for details.
4850
4851
4852
4853 .section "Configuration file format" "SECTconffilfor"
4854 .cindex "configuration file" "format of"
4855 .cindex "format" "configuration file"
4856 Exim's configuration file is divided into a number of different parts. General
4857 option settings must always appear at the start of the file. The other parts
4858 are all optional, and may appear in any order. Each part other than the first
4859 is introduced by the word &"begin"& followed by at least one literal
4860 space, and the name of the part. The optional parts are:
4861
4862 .ilist
4863 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4864 &<<CHAPACL>>&).
4865 .next
4866 .cindex "AUTH" "configuration"
4867 &'authenticators'&: Configuration settings for the authenticator drivers. These
4868 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4869 .next
4870 &'routers'&: Configuration settings for the router drivers. Routers process
4871 addresses and determine how the message is to be delivered (see chapters
4872 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4873 .next
4874 &'transports'&: Configuration settings for the transport drivers. Transports
4875 define mechanisms for copying messages to destinations (see chapters
4876 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4877 .next
4878 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4879 If there is no retry section, or if it is empty (that is, no retry rules are
4880 defined), Exim will not retry deliveries. In this situation, temporary errors
4881 are treated the same as permanent errors. Retry rules are discussed in chapter
4882 &<<CHAPretry>>&.
4883 .next
4884 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4885 when new addresses are generated during delivery. Rewriting is discussed in
4886 chapter &<<CHAPrewrite>>&.
4887 .next
4888 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4889 want to use this feature, you must set
4890 .code
4891 LOCAL_SCAN_HAS_OPTIONS=yes
4892 .endd
4893 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4894 facility are given in chapter &<<CHAPlocalscan>>&.
4895 .endlist
4896
4897 .cindex "configuration file" "leading white space in"
4898 .cindex "configuration file" "trailing white space in"
4899 .cindex "white space" "in configuration file"
4900 Leading and trailing white space in configuration lines is always ignored.
4901
4902 Blank lines in the file, and lines starting with a # character (ignoring
4903 leading white space) are treated as comments and are ignored. &*Note*&: A
4904 # character other than at the beginning of a line is not treated specially,
4905 and does not introduce a comment.
4906
4907 Any non-comment line can be continued by ending it with a backslash. Note that
4908 the general rule for white space means that trailing white space after the
4909 backslash and leading white space at the start of continuation
4910 lines is ignored. Comment lines beginning with # (but not empty lines) may
4911 appear in the middle of a sequence of continuation lines.
4912
4913 A convenient way to create a configuration file is to start from the
4914 default, which is supplied in &_src/configure.default_&, and add, delete, or
4915 change settings as required.
4916
4917 The ACLs, retry rules, and rewriting rules have their own syntax which is
4918 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4919 respectively. The other parts of the configuration file have some syntactic
4920 items in common, and these are described below, from section &<<SECTcos>>&
4921 onwards. Before that, the inclusion, macro, and conditional facilities are
4922 described.
4923
4924
4925
4926 .section "File inclusions in the configuration file" "SECID41"
4927 .cindex "inclusions in configuration file"
4928 .cindex "configuration file" "including other files"
4929 .cindex "&`.include`& in configuration file"
4930 .cindex "&`.include_if_exists`& in configuration file"
4931 You can include other files inside Exim's run time configuration file by
4932 using this syntax:
4933 .display
4934 &`.include`& <&'file name'&>
4935 &`.include_if_exists`& <&'file name'&>
4936 .endd
4937 on a line by itself. Double quotes round the file name are optional. If you use
4938 the first form, a configuration error occurs if the file does not exist; the
4939 second form does nothing for non-existent files.
4940 The first form allows a relative name. It is resolved relative to
4941 the directory of the including file. For the second form an absolute file
4942 name is required.
4943
4944 Includes may be nested to any depth, but remember that Exim reads its
4945 configuration file often, so it is a good idea to keep them to a minimum.
4946 If you change the contents of an included file, you must HUP the daemon,
4947 because an included file is read only when the configuration itself is read.
4948
4949 The processing of inclusions happens early, at a physical line level, so, like
4950 comment lines, an inclusion can be used in the middle of an option setting,
4951 for example:
4952 .code
4953 hosts_lookup = a.b.c \
4954                .include /some/file
4955 .endd
4956 Include processing happens after macro processing (see below). Its effect is to
4957 process the lines of the included file as if they occurred inline where the
4958 inclusion appears.
4959
4960
4961
4962 .section "Macros in the configuration file" "SECTmacrodefs"
4963 .cindex "macro" "description of"
4964 .cindex "configuration file" "macros"
4965 If a line in the main part of the configuration (that is, before the first
4966 &"begin"& line) begins with an upper case letter, it is taken as a macro
4967 definition, and must be of the form
4968 .display
4969 <&'name'&> = <&'rest of line'&>
4970 .endd
4971 The name must consist of letters, digits, and underscores, and need not all be
4972 in upper case, though that is recommended. The rest of the line, including any
4973 continuations, is the replacement text, and has leading and trailing white
4974 space removed. Quotes are not removed. The replacement text can never end with
4975 a backslash character, but this doesn't seem to be a serious limitation.
4976
4977 Macros may also be defined between router, transport, authenticator, or ACL
4978 definitions. They may not, however, be defined within an individual driver or
4979 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4980
4981 .section "Macro substitution" "SECID42"
4982 Once a macro is defined, all subsequent lines in the file (and any included
4983 files) are scanned for the macro name; if there are several macros, the line is
4984 scanned for each in turn, in the order in which the macros are defined. The
4985 replacement text is not re-scanned for the current macro, though it is scanned
4986 for subsequently defined macros. For this reason, a macro name may not contain
4987 the name of a previously defined macro as a substring. You could, for example,
4988 define
4989 .display
4990 &`ABCD_XYZ = `&<&'something'&>
4991 &`ABCD = `&<&'something else'&>
4992 .endd
4993 but putting the definitions in the opposite order would provoke a configuration
4994 error. Macro expansion is applied to individual physical lines from the file,
4995 before checking for line continuation or file inclusion (see above). If a line
4996 consists solely of a macro name, and the expansion of the macro is empty, the
4997 line is ignored. A macro at the start of a line may turn the line into a
4998 comment line or a &`.include`& line.
4999
5000
5001 .section "Redefining macros" "SECID43"
5002 Once defined, the value of a macro can be redefined later in the configuration
5003 (or in an included file). Redefinition is specified by using &'=='& instead of
5004 &'='&. For example:
5005 .code
5006 MAC =  initial value
5007 ...
5008 MAC == updated value
5009 .endd
5010 Redefinition does not alter the order in which the macros are applied to the
5011 subsequent lines of the configuration file. It is still the same order in which
5012 the macros were originally defined. All that changes is the macro's value.
5013 Redefinition makes it possible to accumulate values. For example:
5014 .code
5015 MAC =  initial value
5016 ...
5017 MAC == MAC and something added
5018 .endd
5019 This can be helpful in situations where the configuration file is built
5020 from a number of other files.
5021
5022 .section "Overriding macro values" "SECID44"
5023 The values set for macros in the configuration file can be overridden by the
5024 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5025 used, unless called by root or the Exim user. A definition on the command line
5026 using the &%-D%& option causes all definitions and redefinitions within the
5027 file to be ignored.
5028
5029
5030
5031 .section "Example of macro usage" "SECID45"
5032 As an example of macro usage, consider a configuration where aliases are looked
5033 up in a MySQL database. It helps to keep the file less cluttered if long
5034 strings such as SQL statements are defined separately as macros, for example:
5035 .code
5036 ALIAS_QUERY = select mailbox from user where \
5037               login='${quote_mysql:$local_part}';
5038 .endd
5039 This can then be used in a &(redirect)& router setting like this:
5040 .code
5041 data = ${lookup mysql{ALIAS_QUERY}}
5042 .endd
5043 In earlier versions of Exim macros were sometimes used for domain, host, or
5044 address lists. In Exim 4 these are handled better by named lists &-- see
5045 section &<<SECTnamedlists>>&.
5046
5047
5048 .section "Builtin macros" "SECTbuiltinmacros"
5049 Exim defines some macros depending on facilities available, which may
5050 differ due to build-time definitions and from one release to another.
5051 All of these macros start with an underscore.
5052 They can be used to conditionally include parts of a configuration
5053 (see below).
5054
5055 The following classes of macros are defined:
5056 .display
5057 &` _HAVE_*                    `&  build-time defines
5058 &` _DRIVER_ROUTER_*           `&  router drivers
5059 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5060 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5061 &` _OPT_MAIN_*                `&  main config options
5062 &` _OPT_ROUTERS_*             `&  generic router options
5063 &` _OPT_TRANSPORTS_*          `&  generic transport options
5064 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5065 &` _OPT_ROUTER_*_*            `&  private router options
5066 &` _OPT_TRANSPORT_*_*         `&  private transport options
5067 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5068 .endd
5069
5070 Use an &"exim -bP macros"& command to get the list of macros.
5071
5072
5073 .section "Conditional skips in the configuration file" "SECID46"
5074 .cindex "configuration file" "conditional skips"
5075 .cindex "&`.ifdef`&"
5076 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5077 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5078 portions of the configuration file. The processing happens whenever the file is
5079 read (that is, when an Exim binary starts to run).
5080
5081 The implementation is very simple. Instances of the first four directives must
5082 be followed by text that includes the names of one or macros. The condition
5083 that is tested is whether or not any macro substitution has taken place in the
5084 line. Thus:
5085 .code
5086 .ifdef AAA
5087 message_size_limit = 50M
5088 .else
5089 message_size_limit = 100M
5090 .endif
5091 .endd
5092 sets a message size limit of 50M if the macro &`AAA`& is defined
5093 (or &`A`& or &`AA`&), and 100M
5094 otherwise. If there is more than one macro named on the line, the condition
5095 is true if any of them are defined. That is, it is an &"or"& condition. To
5096 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5097
5098 Although you can use a macro expansion to generate one of these directives,
5099 it is not very useful, because the condition &"there was a macro substitution
5100 in this line"& will always be true.
5101
5102 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5103 to clarify complicated nestings.
5104
5105
5106
5107 .section "Common option syntax" "SECTcos"
5108 .cindex "common option syntax"
5109 .cindex "syntax of common options"
5110 .cindex "configuration file" "common option syntax"
5111 For the main set of options, driver options, and &[local_scan()]& options,
5112 each setting is on a line by itself, and starts with a name consisting of
5113 lower-case letters and underscores. Many options require a data value, and in
5114 these cases the name must be followed by an equals sign (with optional white
5115 space) and then the value. For example:
5116 .code
5117 qualify_domain = mydomain.example.com
5118 .endd
5119 .cindex "hiding configuration option values"
5120 .cindex "configuration options" "hiding value of"
5121 .cindex "options" "hiding value of"
5122 Some option settings may contain sensitive data, for example, passwords for
5123 accessing databases. To stop non-admin users from using the &%-bP%& command
5124 line option to read these values, you can precede the option settings with the
5125 word &"hide"&. For example:
5126 .code
5127 hide mysql_servers = localhost/users/admin/secret-password
5128 .endd
5129 For non-admin users, such options are displayed like this:
5130 .code
5131 mysql_servers = <value not displayable>
5132 .endd
5133 If &"hide"& is used on a driver option, it hides the value of that option on
5134 all instances of the same driver.
5135
5136 The following sections describe the syntax used for the different data types
5137 that are found in option settings.
5138
5139
5140 .section "Boolean options" "SECID47"
5141 .cindex "format" "boolean"
5142 .cindex "boolean configuration values"
5143 .oindex "&%no_%&&'xxx'&"
5144 .oindex "&%not_%&&'xxx'&"
5145 Options whose type is given as boolean are on/off switches. There are two
5146 different ways of specifying such options: with and without a data value. If
5147 the option name is specified on its own without data, the switch is turned on;
5148 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5149 boolean options may be followed by an equals sign and one of the words
5150 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5151 the following two settings have exactly the same effect:
5152 .code
5153 queue_only
5154 queue_only = true
5155 .endd
5156 The following two lines also have the same (opposite) effect:
5157 .code
5158 no_queue_only
5159 queue_only = false
5160 .endd
5161 You can use whichever syntax you prefer.
5162
5163
5164
5165
5166 .section "Integer values" "SECID48"
5167 .cindex "integer configuration values"
5168 .cindex "format" "integer"
5169 If an option's type is given as &"integer"&, the value can be given in decimal,
5170 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5171 number is assumed. Otherwise, it is treated as an octal number unless it starts
5172 with the characters &"0x"&, in which case the remainder is interpreted as a
5173 hexadecimal number.
5174
5175 If an integer value is followed by the letter K, it is multiplied by 1024; if
5176 it is followed by the letter M, it is multiplied by 1024x1024;
5177 if by the letter G, 1024x1024x1024.
5178 When the values
5179 of integer option settings are output, values which are an exact multiple of
5180 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5181 and M. The printing style is independent of the actual input format that was
5182 used.
5183
5184
5185 .section "Octal integer values" "SECID49"
5186 .cindex "integer format"
5187 .cindex "format" "octal integer"
5188 If an option's type is given as &"octal integer"&, its value is always
5189 interpreted as an octal number, whether or not it starts with the digit zero.
5190 Such options are always output in octal.
5191
5192
5193 .section "Fixed point numbers" "SECID50"
5194 .cindex "fixed point configuration values"
5195 .cindex "format" "fixed point"
5196 If an option's type is given as &"fixed-point"&, its value must be a decimal
5197 integer, optionally followed by a decimal point and up to three further digits.
5198
5199
5200
5201 .section "Time intervals" "SECTtimeformat"
5202 .cindex "time interval" "specifying in configuration"
5203 .cindex "format" "time interval"
5204 A time interval is specified as a sequence of numbers, each followed by one of
5205 the following letters, with no intervening white space:
5206
5207 .table2 30pt
5208 .irow &%s%& seconds
5209 .irow &%m%& minutes
5210 .irow &%h%& hours
5211 .irow &%d%& days
5212 .irow &%w%& weeks
5213 .endtable
5214
5215 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5216 intervals are output in the same format. Exim does not restrict the values; it
5217 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5218
5219
5220
5221 .section "String values" "SECTstrings"
5222 .cindex "string" "format of configuration values"
5223 .cindex "format" "string"
5224 If an option's type is specified as &"string"&, the value can be specified with
5225 or without double-quotes. If it does not start with a double-quote, the value
5226 consists of the remainder of the line plus any continuation lines, starting at
5227 the first character after any leading white space, with trailing white space
5228 removed, and with no interpretation of the characters in the string. Because
5229 Exim removes comment lines (those beginning with #) at an early stage, they can
5230 appear in the middle of a multi-line string. The following two settings are
5231 therefore equivalent:
5232 .code
5233 trusted_users = uucp:mail
5234 trusted_users = uucp:\
5235                 # This comment line is ignored
5236                 mail
5237 .endd
5238 .cindex "string" "quoted"
5239 .cindex "escape characters in quoted strings"
5240 If a string does start with a double-quote, it must end with a closing
5241 double-quote, and any backslash characters other than those used for line
5242 continuation are interpreted as escape characters, as follows:
5243
5244 .table2 100pt
5245 .irow &`\\`&                     "single backslash"
5246 .irow &`\n`&                     "newline"
5247 .irow &`\r`&                     "carriage return"
5248 .irow &`\t`&                     "tab"
5249 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5250 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5251                                    character"
5252 .endtable
5253
5254 If a backslash is followed by some other character, including a double-quote
5255 character, that character replaces the pair.
5256
5257 Quoting is necessary only if you want to make use of the backslash escapes to
5258 insert special characters, or if you need to specify a value with leading or
5259 trailing spaces. These cases are rare, so quoting is almost never needed in
5260 current versions of Exim. In versions of Exim before 3.14, quoting was required
5261 in order to continue lines, so you may come across older configuration files
5262 and examples that apparently quote unnecessarily.
5263
5264
5265 .section "Expanded strings" "SECID51"
5266 .cindex "expansion" "definition of"
5267 Some strings in the configuration file are subjected to &'string expansion'&,
5268 by which means various parts of the string may be changed according to the
5269 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5270 is as just described; in particular, the handling of backslashes in quoted
5271 strings is done as part of the input process, before expansion takes place.
5272 However, backslash is also an escape character for the expander, so any
5273 backslashes that are required for that reason must be doubled if they are
5274 within a quoted configuration string.
5275
5276
5277 .section "User and group names" "SECID52"
5278 .cindex "user name" "format of"
5279 .cindex "format" "user name"
5280 .cindex "groups" "name format"
5281 .cindex "format" "group name"
5282 User and group names are specified as strings, using the syntax described
5283 above, but the strings are interpreted specially. A user or group name must
5284 either consist entirely of digits, or be a name that can be looked up using the
5285 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5286
5287
5288 .section "List construction" "SECTlistconstruct"
5289 .cindex "list" "syntax of in configuration"
5290 .cindex "format" "list item in configuration"
5291 .cindex "string" "list, definition of"
5292 The data for some configuration options is a list of items, with colon as the
5293 default separator. Many of these options are shown with type &"string list"& in
5294 the descriptions later in this document. Others are listed as &"domain list"&,
5295 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5296 are all the same; however, those other than &"string list"& are subject to
5297 particular kinds of interpretation, as described in chapter
5298 &<<CHAPdomhosaddlists>>&.
5299
5300 In all these cases, the entire list is treated as a single string as far as the
5301 input syntax is concerned. The &%trusted_users%& setting in section
5302 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5303 in a list, it must be entered as two colons. Leading and trailing white space
5304 on each item in a list is ignored. This makes it possible to include items that
5305 start with a colon, and in particular, certain forms of IPv6 address. For
5306 example, the list
5307 .code
5308 local_interfaces = 127.0.0.1 : ::::1
5309 .endd
5310 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5311
5312 &*Note*&: Although leading and trailing white space is ignored in individual
5313 list items, it is not ignored when parsing the list. The space after the first
5314 colon in the example above is necessary. If it were not there, the list would
5315 be interpreted as the two items 127.0.0.1:: and 1.
5316
5317 .section "Changing list separators" "SECTlistsepchange"
5318 .cindex "list separator" "changing"
5319 .cindex "IPv6" "addresses in lists"
5320 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5321 introduced to allow the separator character to be changed. If a list begins
5322 with a left angle bracket, followed by any punctuation character, that
5323 character is used instead of colon as the list separator. For example, the list
5324 above can be rewritten to use a semicolon separator like this:
5325 .code
5326 local_interfaces = <; 127.0.0.1 ; ::1
5327 .endd
5328 This facility applies to all lists, with the exception of the list in
5329 &%log_file_path%&. It is recommended that the use of non-colon separators be
5330 confined to circumstances where they really are needed.
5331
5332 .cindex "list separator" "newline as"
5333 .cindex "newline" "as list separator"
5334 It is also possible to use newline and other control characters (those with
5335 code values less than 32, plus DEL) as separators in lists. Such separators
5336 must be provided literally at the time the list is processed. For options that
5337 are string-expanded, you can write the separator using a normal escape
5338 sequence. This will be processed by the expander before the string is
5339 interpreted as a list. For example, if a newline-separated list of domains is
5340 generated by a lookup, you can process it directly by a line such as this:
5341 .code
5342 domains = <\n ${lookup mysql{.....}}
5343 .endd
5344 This avoids having to change the list separator in such data. You are unlikely
5345 to want to use a control character as a separator in an option that is not
5346 expanded, because the value is literal text. However, it can be done by giving
5347 the value in quotes. For example:
5348 .code
5349 local_interfaces = "<\n 127.0.0.1 \n ::1"
5350 .endd
5351 Unlike printing character separators, which can be included in list items by
5352 doubling, it is not possible to include a control character as data when it is
5353 set as the separator. Two such characters in succession are interpreted as
5354 enclosing an empty list item.
5355
5356
5357
5358 .section "Empty items in lists" "SECTempitelis"
5359 .cindex "list" "empty item in"
5360 An empty item at the end of a list is always ignored. In other words, trailing
5361 separator characters are ignored. Thus, the list in
5362 .code
5363 senders = user@domain :
5364 .endd
5365 contains only a single item. If you want to include an empty string as one item
5366 in a list, it must not be the last item. For example, this list contains three
5367 items, the second of which is empty:
5368 .code
5369 senders = user1@domain : : user2@domain
5370 .endd
5371 &*Note*&: There must be white space between the two colons, as otherwise they
5372 are interpreted as representing a single colon data character (and the list
5373 would then contain just one item). If you want to specify a list that contains
5374 just one, empty item, you can do it as in this example:
5375 .code
5376 senders = :
5377 .endd
5378 In this case, the first item is empty, and the second is discarded because it
5379 is at the end of the list.
5380
5381
5382
5383
5384 .section "Format of driver configurations" "SECTfordricon"
5385 .cindex "drivers" "configuration format"
5386 There are separate parts in the configuration for defining routers, transports,
5387 and authenticators. In each part, you are defining a number of driver
5388 instances, each with its own set of options. Each driver instance is defined by
5389 a sequence of lines like this:
5390 .display
5391 <&'instance name'&>:
5392   <&'option'&>
5393   ...
5394   <&'option'&>
5395 .endd
5396 In the following example, the instance name is &(localuser)&, and it is
5397 followed by three options settings:
5398 .code
5399 localuser:
5400   driver = accept
5401   check_local_user
5402   transport = local_delivery
5403 .endd
5404 For each driver instance, you specify which Exim code module it uses &-- by the
5405 setting of the &%driver%& option &-- and (optionally) some configuration
5406 settings. For example, in the case of transports, if you want a transport to
5407 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5408 a local file you would use the &(appendfile)& driver. Each of the drivers is
5409 described in detail in its own separate chapter later in this manual.
5410
5411 You can have several routers, transports, or authenticators that are based on
5412 the same underlying driver (each must have a different instance name).
5413
5414 The order in which routers are defined is important, because addresses are
5415 passed to individual routers one by one, in order. The order in which
5416 transports are defined does not matter at all. The order in which
5417 authenticators are defined is used only when Exim, as a client, is searching
5418 them to find one that matches an authentication mechanism offered by the
5419 server.
5420
5421 .cindex "generic options"
5422 .cindex "options" "generic &-- definition of"
5423 Within a driver instance definition, there are two kinds of option: &'generic'&
5424 and &'private'&. The generic options are those that apply to all drivers of the
5425 same type (that is, all routers, all transports or all authenticators). The
5426 &%driver%& option is a generic option that must appear in every definition.
5427 .cindex "private options"
5428 The private options are special for each driver, and none need appear, because
5429 they all have default values.
5430
5431 The options may appear in any order, except that the &%driver%& option must
5432 precede any private options, since these depend on the particular driver. For
5433 this reason, it is recommended that &%driver%& always be the first option.
5434
5435 Driver instance names, which are used for reference in log entries and
5436 elsewhere, can be any sequence of letters, digits, and underscores (starting
5437 with a letter) and must be unique among drivers of the same type. A router and
5438 a transport (for example) can each have the same name, but no two router
5439 instances can have the same name. The name of a driver instance should not be
5440 confused with the name of the underlying driver module. For example, the
5441 configuration lines:
5442 .code
5443 remote_smtp:
5444   driver = smtp
5445 .endd
5446 create an instance of the &(smtp)& transport driver whose name is
5447 &(remote_smtp)&. The same driver code can be used more than once, with
5448 different instance names and different option settings each time. A second
5449 instance of the &(smtp)& transport, with different options, might be defined
5450 thus:
5451 .code
5452 special_smtp:
5453   driver = smtp
5454   port = 1234
5455   command_timeout = 10s
5456 .endd
5457 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5458 these transport instances from routers, and these names would appear in log
5459 lines.
5460
5461 Comment lines may be present in the middle of driver specifications. The full
5462 list of option settings for any particular driver instance, including all the
5463 defaulted values, can be extracted by making use of the &%-bP%& command line
5464 option.
5465
5466
5467
5468
5469
5470
5471 . ////////////////////////////////////////////////////////////////////////////
5472 . ////////////////////////////////////////////////////////////////////////////
5473
5474 .chapter "The default configuration file" "CHAPdefconfil"
5475 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5476 .cindex "default" "configuration file &""walk through""&"
5477 The default configuration file supplied with Exim as &_src/configure.default_&
5478 is sufficient for a host with simple mail requirements. As an introduction to
5479 the way Exim is configured, this chapter &"walks through"& the default
5480 configuration, giving brief explanations of the settings. Detailed descriptions
5481 of the options are given in subsequent chapters. The default configuration file
5482 itself contains extensive comments about ways you might want to modify the
5483 initial settings. However, note that there are many options that are not
5484 mentioned at all in the default configuration.
5485
5486
5487
5488 .section "Main configuration settings" "SECTdefconfmain"
5489 The main (global) configuration option settings must always come first in the
5490 file. The first thing you'll see in the file, after some initial comments, is
5491 the line
5492 .code
5493 # primary_hostname =
5494 .endd
5495 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5496 to know the official, fully qualified name of your host, and this is where you
5497 can specify it. However, in most cases you do not need to set this option. When
5498 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5499
5500 The first three non-comment configuration lines are as follows:
5501 .code
5502 domainlist local_domains    = @
5503 domainlist relay_to_domains =
5504 hostlist   relay_from_hosts = 127.0.0.1
5505 .endd
5506 These are not, in fact, option settings. They are definitions of two named
5507 domain lists and one named host list. Exim allows you to give names to lists of
5508 domains, hosts, and email addresses, in order to make it easier to manage the
5509 configuration file (see section &<<SECTnamedlists>>&).
5510
5511 The first line defines a domain list called &'local_domains'&; this is used
5512 later in the configuration to identify domains that are to be delivered
5513 on the local host.
5514
5515 .cindex "@ in a domain list"
5516 There is just one item in this list, the string &"@"&. This is a special form
5517 of entry which means &"the name of the local host"&. Thus, if the local host is
5518 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5519 be delivered locally. Because the local host's name is referenced indirectly,
5520 the same configuration file can be used on different hosts.
5521
5522 The second line defines a domain list called &'relay_to_domains'&, but the
5523 list itself is empty. Later in the configuration we will come to the part that
5524 controls mail relaying through the local host; it allows relaying to any
5525 domains in this list. By default, therefore, no relaying on the basis of a mail
5526 domain is permitted.
5527
5528 The third line defines a host list called &'relay_from_hosts'&. This list is
5529 used later in the configuration to permit relaying from any host or IP address
5530 that matches the list. The default contains just the IP address of the IPv4
5531 loopback interface, which means that processes on the local host are able to
5532 submit mail for relaying by sending it over TCP/IP to that interface. No other
5533 hosts are permitted to submit messages for relaying.
5534
5535 Just to be sure there's no misunderstanding: at this point in the configuration
5536 we aren't actually setting up any controls. We are just defining some domains
5537 and hosts that will be used in the controls that are specified later.
5538
5539 The next two configuration lines are genuine option settings:
5540 .code
5541 acl_smtp_rcpt = acl_check_rcpt
5542 acl_smtp_data = acl_check_data
5543 .endd
5544 These options specify &'Access Control Lists'& (ACLs) that are to be used
5545 during an incoming SMTP session for every recipient of a message (every RCPT
5546 command), and after the contents of the message have been received,
5547 respectively. The names of the lists are &'acl_check_rcpt'& and
5548 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5549 section of the configuration. The RCPT ACL controls which recipients are
5550 accepted for an incoming message &-- if a configuration does not provide an ACL
5551 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5552 contents of a message to be checked.
5553
5554 Two commented-out option settings are next:
5555 .code
5556 # av_scanner = clamd:/tmp/clamd
5557 # spamd_address = 127.0.0.1 783
5558 .endd
5559 These are example settings that can be used when Exim is compiled with the
5560 content-scanning extension. The first specifies the interface to the virus
5561 scanner, and the second specifies the interface to SpamAssassin. Further
5562 details are given in chapter &<<CHAPexiscan>>&.
5563
5564 Three more commented-out option settings follow:
5565 .code
5566 # tls_advertise_hosts = *
5567 # tls_certificate = /etc/ssl/exim.crt
5568 # tls_privatekey = /etc/ssl/exim.pem
5569 .endd
5570 These are example settings that can be used when Exim is compiled with
5571 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5572 first one specifies the list of clients that are allowed to use TLS when
5573 connecting to this server; in this case the wildcard means all clients. The
5574 other options specify where Exim should find its TLS certificate and private
5575 key, which together prove the server's identity to any clients that connect.
5576 More details are given in chapter &<<CHAPTLS>>&.
5577
5578 Another two commented-out option settings follow:
5579 .code
5580 # daemon_smtp_ports = 25 : 465 : 587
5581 # tls_on_connect_ports = 465
5582 .endd
5583 .cindex "port" "465 and 587"
5584 .cindex "port" "for message submission"
5585 .cindex "message" "submission, ports for"
5586 .cindex "ssmtp protocol"
5587 .cindex "smtps protocol"
5588 .cindex "SMTP" "ssmtp protocol"
5589 .cindex "SMTP" "smtps protocol"
5590 These options provide better support for roaming users who wish to use this
5591 server for message submission. They are not much use unless you have turned on
5592 TLS (as described in the previous paragraph) and authentication (about which
5593 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5594 on end-user networks, so RFC 4409 specifies that message submission should use
5595 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5596 configured to use port 587 correctly, so these settings also enable the
5597 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5598 &<<SECTsupobssmt>>&).
5599
5600 Two more commented-out options settings follow:
5601 .code
5602 # qualify_domain =
5603 # qualify_recipient =
5604 .endd
5605 The first of these specifies a domain that Exim uses when it constructs a
5606 complete email address from a local login name. This is often needed when Exim
5607 receives a message from a local process. If you do not set &%qualify_domain%&,
5608 the value of &%primary_hostname%& is used. If you set both of these options,
5609 you can have different qualification domains for sender and recipient
5610 addresses. If you set only the first one, its value is used in both cases.
5611
5612 .cindex "domain literal" "recognizing format"
5613 The following line must be uncommented if you want Exim to recognize
5614 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5615 (an IP address within square brackets) instead of a named domain.
5616 .code
5617 # allow_domain_literals
5618 .endd
5619 The RFCs still require this form, but many people think that in the modern
5620 Internet it makes little sense to permit mail to be sent to specific hosts by
5621 quoting their IP addresses. This ancient format has been used by people who
5622 try to abuse hosts by using them for unwanted relaying. However, some
5623 people believe there are circumstances (for example, messages addressed to
5624 &'postmaster'&) where domain literals are still useful.
5625
5626 The next configuration line is a kind of trigger guard:
5627 .code
5628 never_users = root
5629 .endd
5630 It specifies that no delivery must ever be run as the root user. The normal
5631 convention is to set up &'root'& as an alias for the system administrator. This
5632 setting is a guard against slips in the configuration.
5633 The list of users specified by &%never_users%& is not, however, the complete
5634 list; the build-time configuration in &_Local/Makefile_& has an option called
5635 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5636 contents of &%never_users%& are added to this list. By default
5637 FIXED_NEVER_USERS also specifies root.
5638
5639 When a remote host connects to Exim in order to send mail, the only information
5640 Exim has about the host's identity is its IP address. The next configuration
5641 line,
5642 .code
5643 host_lookup = *
5644 .endd
5645 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5646 in order to get a host name. This improves the quality of the logging
5647 information, but if you feel it is too expensive, you can remove it entirely,
5648 or restrict the lookup to hosts on &"nearby"& networks.
5649 Note that it is not always possible to find a host name from an IP address,
5650 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5651 unreachable.
5652
5653 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5654 1413 (hence their names):
5655 .code
5656 rfc1413_hosts = *
5657 rfc1413_query_timeout = 0s
5658 .endd
5659 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5660 Few hosts offer RFC1413 service these days; calls have to be
5661 terminated by a timeout and this needlessly delays the startup
5662 of an incoming SMTP connection.
5663 If you have hosts for which you trust RFC1413 and need this
5664 information, you can change this.
5665
5666 This line enables an efficiency SMTP option.  It is negotiated by clients
5667 and not expected to cause problems but can be disabled if needed.
5668 .code
5669 prdr_enable = true
5670 .endd
5671
5672 When Exim receives messages over SMTP connections, it expects all addresses to
5673 be fully qualified with a domain, as required by the SMTP definition. However,
5674 if you are running a server to which simple clients submit messages, you may
5675 find that they send unqualified addresses. The two commented-out options:
5676 .code
5677 # sender_unqualified_hosts =
5678 # recipient_unqualified_hosts =
5679 .endd
5680 show how you can specify hosts that are permitted to send unqualified sender
5681 and recipient addresses, respectively.
5682
5683 The &%log_selector%& option is used to increase the detail of logging
5684 over the default:
5685 .code
5686 log_selector = +smtp_protocol_error +smtp_syntax_error \
5687                +tls_certificate_verified
5688 .endd
5689
5690 The &%percent_hack_domains%& option is also commented out:
5691 .code
5692 # percent_hack_domains =
5693 .endd
5694 It provides a list of domains for which the &"percent hack"& is to operate.
5695 This is an almost obsolete form of explicit email routing. If you do not know
5696 anything about it, you can safely ignore this topic.
5697
5698 The next two settings in the main part of the default configuration are
5699 concerned with messages that have been &"frozen"& on Exim's queue. When a
5700 message is frozen, Exim no longer continues to try to deliver it. Freezing
5701 occurs when a bounce message encounters a permanent failure because the sender
5702 address of the original message that caused the bounce is invalid, so the
5703 bounce cannot be delivered. This is probably the most common case, but there
5704 are also other conditions that cause freezing, and frozen messages are not
5705 always bounce messages.
5706 .code
5707 ignore_bounce_errors_after = 2d
5708 timeout_frozen_after = 7d
5709 .endd
5710 The first of these options specifies that failing bounce messages are to be
5711 discarded after 2 days on the queue. The second specifies that any frozen
5712 message (whether a bounce message or not) is to be timed out (and discarded)
5713 after a week. In this configuration, the first setting ensures that no failing
5714 bounce message ever lasts a week.
5715
5716 Exim queues it's messages in a spool directory. If you expect to have
5717 large queues, you may consider using this option. It splits the spool
5718 directory into subdirectories to avoid file system degradation from
5719 many files in a single directory, resulting in better performance.
5720 Manual manipulation of queued messages becomes more complex (though fortunately
5721 not often needed).
5722 .code
5723 # split_spool_directory = true
5724 .endd
5725
5726 In an ideal world everybody follows the standards. For non-ASCII
5727 messages RFC 2047 is a standard, allowing a maximum line length of 76
5728 characters. Exim adheres that standard and won't process messages which
5729 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5730 In particular, the Exim maintainers have had multiple reports of
5731 problems from Russian administrators of issues until they disable this
5732 check, because of some popular, yet buggy, mail composition software.
5733 .code
5734 # check_rfc2047_length = false
5735 .endd
5736
5737 If you need to be strictly RFC compliant you may wish to disable the
5738 8BITMIME advertisement. Use this, if you exchange mails with systems
5739 that are not 8-bit clean.
5740 .code
5741 # accept_8bitmime = false
5742 .endd
5743
5744 Libraries you use may depend on specific environment settings.  This
5745 imposes a security risk (e.g. PATH). There are two lists:
5746 &%keep_environment%& for the variables to import as they are, and
5747 &%add_environment%& for variables we want to set to a fixed value.
5748 Note that TZ is handled separately, by the $%timezone%$ runtime
5749 option and by the TIMEZONE_DEFAULT buildtime option.
5750 .code
5751 # keep_environment = ^LDAP
5752 # add_environment = PATH=/usr/bin::/bin
5753 .endd
5754
5755
5756 .section "ACL configuration" "SECID54"
5757 .cindex "default" "ACLs"
5758 .cindex "&ACL;" "default configuration"
5759 In the default configuration, the ACL section follows the main configuration.
5760 It starts with the line
5761 .code
5762 begin acl
5763 .endd
5764 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5765 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5766 and &%acl_smtp_data%& above.
5767
5768 .cindex "RCPT" "ACL for"
5769 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5770 RCPT command specifies one of the message's recipients. The ACL statements
5771 are considered in order, until the recipient address is either accepted or
5772 rejected. The RCPT command is then accepted or rejected, according to the
5773 result of the ACL processing.
5774 .code
5775 acl_check_rcpt:
5776 .endd
5777 This line, consisting of a name terminated by a colon, marks the start of the
5778 ACL, and names it.
5779 .code
5780 accept  hosts = :
5781 .endd
5782 This ACL statement accepts the recipient if the sending host matches the list.
5783 But what does that strange list mean? It doesn't actually contain any host
5784 names or IP addresses. The presence of the colon puts an empty item in the
5785 list; Exim matches this only if the incoming message did not come from a remote
5786 host, because in that case, the remote hostname is empty. The colon is
5787 important. Without it, the list itself is empty, and can never match anything.
5788
5789 What this statement is doing is to accept unconditionally all recipients in
5790 messages that are submitted by SMTP from local processes using the standard
5791 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5792 manner.
5793 .code
5794 deny    message       = Restricted characters in address
5795         domains       = +local_domains
5796         local_parts   = ^[.] : ^.*[@%!/|]
5797
5798 deny    message       = Restricted characters in address
5799         domains       = !+local_domains
5800         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5801 .endd
5802 These statements are concerned with local parts that contain any of the
5803 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5804 Although these characters are entirely legal in local parts (in the case of
5805 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5806 in Internet mail addresses.
5807
5808 The first three have in the past been associated with explicitly routed
5809 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5810 option). Addresses containing these characters are regularly tried by spammers
5811 in an attempt to bypass relaying restrictions, and also by open relay testing
5812 programs. Unless you really need them it is safest to reject these characters
5813 at this early stage. This configuration is heavy-handed in rejecting these
5814 characters for all messages it accepts from remote hosts. This is a deliberate
5815 policy of being as safe as possible.
5816
5817 The first rule above is stricter, and is applied to messages that are addressed
5818 to one of the local domains handled by this host. This is implemented by the
5819 first condition, which restricts it to domains that are listed in the
5820 &'local_domains'& domain list. The &"+"& character is used to indicate a
5821 reference to a named list. In this configuration, there is just one domain in
5822 &'local_domains'&, but in general there may be many.
5823
5824 The second condition on the first statement uses two regular expressions to
5825 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5826 or &"|"&. If you have local accounts that include these characters, you will
5827 have to modify this rule.
5828
5829 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5830 allows them because they have been encountered in practice. (Consider the
5831 common convention of local parts constructed as
5832 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5833 the author of Exim, who has no second initial.) However, a local part starting
5834 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5835 file name (for example, for a mailing list). This is also true for local parts
5836 that contain slashes. A pipe symbol can also be troublesome if the local part
5837 is incorporated unthinkingly into a shell command line.
5838
5839 The second rule above applies to all other domains, and is less strict. This
5840 allows your own users to send outgoing messages to sites that use slashes
5841 and vertical bars in their local parts. It blocks local parts that begin
5842 with a dot, slash, or vertical bar, but allows these characters within the
5843 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5844 and &"!"& is blocked, as before. The motivation here is to prevent your users
5845 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5846 .code
5847 accept  local_parts   = postmaster
5848         domains       = +local_domains
5849 .endd
5850 This statement, which has two conditions, accepts an incoming address if the
5851 local part is &'postmaster'& and the domain is one of those listed in the
5852 &'local_domains'& domain list. The &"+"& character is used to indicate a
5853 reference to a named list. In this configuration, there is just one domain in
5854 &'local_domains'&, but in general there may be many.
5855
5856 The presence of this statement means that mail to postmaster is never blocked
5857 by any of the subsequent tests. This can be helpful while sorting out problems
5858 in cases where the subsequent tests are incorrectly denying access.
5859 .code
5860 require verify        = sender
5861 .endd
5862 This statement requires the sender address to be verified before any subsequent
5863 ACL statement can be used. If verification fails, the incoming recipient
5864 address is refused. Verification consists of trying to route the address, to
5865 see if a bounce message could be delivered to it. In the case of remote
5866 addresses, basic verification checks only the domain, but &'callouts'& can be
5867 used for more verification if required. Section &<<SECTaddressverification>>&
5868 discusses the details of address verification.
5869 .code
5870 accept  hosts         = +relay_from_hosts
5871         control       = submission
5872 .endd
5873 This statement accepts the address if the message is coming from one of the
5874 hosts that are defined as being allowed to relay through this host. Recipient
5875 verification is omitted here, because in many cases the clients are dumb MUAs
5876 that do not cope well with SMTP error responses. For the same reason, the
5877 second line specifies &"submission mode"& for messages that are accepted. This
5878 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5879 messages that are deficient in some way, for example, because they lack a
5880 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5881 probably add recipient verification here, and disable submission mode.
5882 .code
5883 accept  authenticated = *
5884         control       = submission
5885 .endd
5886 This statement accepts the address if the client host has authenticated itself.
5887 Submission mode is again specified, on the grounds that such messages are most
5888 likely to come from MUAs. The default configuration does not define any
5889 authenticators, though it does include some nearly complete commented-out
5890 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5891 fact authenticate until you complete the authenticator definitions.
5892 .code
5893 require message = relay not permitted
5894         domains = +local_domains : +relay_to_domains
5895 .endd
5896 This statement rejects the address if its domain is neither a local domain nor
5897 one of the domains for which this host is a relay.
5898 .code
5899 require verify = recipient
5900 .endd
5901 This statement requires the recipient address to be verified; if verification
5902 fails, the address is rejected.
5903 .code
5904 # deny    message     = rejected because $sender_host_address \
5905 #                       is in a black list at $dnslist_domain\n\
5906 #                       $dnslist_text
5907 #         dnslists    = black.list.example
5908 #
5909 # warn    dnslists    = black.list.example
5910 #         add_header  = X-Warning: $sender_host_address is in \
5911 #                       a black list at $dnslist_domain
5912 #         log_message = found in $dnslist_domain
5913 .endd
5914 These commented-out lines are examples of how you could configure Exim to check
5915 sending hosts against a DNS black list. The first statement rejects messages
5916 from blacklisted hosts, whereas the second just inserts a warning header
5917 line.
5918 .code
5919 # require verify = csa
5920 .endd
5921 This commented-out line is an example of how you could turn on client SMTP
5922 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5923 records.
5924 .code
5925 accept
5926 .endd
5927 The final statement in the first ACL unconditionally accepts any recipient
5928 address that has successfully passed all the previous tests.
5929 .code
5930 acl_check_data:
5931 .endd
5932 This line marks the start of the second ACL, and names it. Most of the contents
5933 of this ACL are commented out:
5934 .code
5935 # deny    malware   = *
5936 #         message   = This message contains a virus \
5937 #                     ($malware_name).
5938 .endd
5939 These lines are examples of how to arrange for messages to be scanned for
5940 viruses when Exim has been compiled with the content-scanning extension, and a
5941 suitable virus scanner is installed. If the message is found to contain a
5942 virus, it is rejected with the given custom error message.
5943 .code
5944 # warn    spam      = nobody
5945 #         message   = X-Spam_score: $spam_score\n\
5946 #                     X-Spam_score_int: $spam_score_int\n\
5947 #                     X-Spam_bar: $spam_bar\n\
5948 #                     X-Spam_report: $spam_report
5949 .endd
5950 These lines are an example of how to arrange for messages to be scanned by
5951 SpamAssassin when Exim has been compiled with the content-scanning extension,
5952 and SpamAssassin has been installed. The SpamAssassin check is run with
5953 &`nobody`& as its user parameter, and the results are added to the message as a
5954 series of extra header line. In this case, the message is not rejected,
5955 whatever the spam score.
5956 .code
5957 accept
5958 .endd
5959 This final line in the DATA ACL accepts the message unconditionally.
5960
5961
5962 .section "Router configuration" "SECID55"
5963 .cindex "default" "routers"
5964 .cindex "routers" "default"
5965 The router configuration comes next in the default configuration, introduced
5966 by the line
5967 .code
5968 begin routers
5969 .endd
5970 Routers are the modules in Exim that make decisions about where to send
5971 messages. An address is passed to each router in turn, until it is either
5972 accepted, or failed. This means that the order in which you define the routers
5973 matters. Each router is fully described in its own chapter later in this
5974 manual. Here we give only brief overviews.
5975 .code
5976 # domain_literal:
5977 #   driver = ipliteral
5978 #   domains = !+local_domains
5979 #   transport = remote_smtp
5980 .endd
5981 .cindex "domain literal" "default router"
5982 This router is commented out because the majority of sites do not want to
5983 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5984 you uncomment this router, you also need to uncomment the setting of
5985 &%allow_domain_literals%& in the main part of the configuration.
5986 .code
5987 dnslookup:
5988   driver = dnslookup
5989   domains = ! +local_domains
5990   transport = remote_smtp
5991   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5992   no_more
5993 .endd
5994 The first uncommented router handles addresses that do not involve any local
5995 domains. This is specified by the line
5996 .code
5997 domains = ! +local_domains
5998 .endd
5999 The &%domains%& option lists the domains to which this router applies, but the
6000 exclamation mark is a negation sign, so the router is used only for domains
6001 that are not in the domain list called &'local_domains'& (which was defined at
6002 the start of the configuration). The plus sign before &'local_domains'&
6003 indicates that it is referring to a named list. Addresses in other domains are
6004 passed on to the following routers.
6005
6006 The name of the router driver is &(dnslookup)&,
6007 and is specified by the &%driver%& option. Do not be confused by the fact that
6008 the name of this router instance is the same as the name of the driver. The
6009 instance name is arbitrary, but the name set in the &%driver%& option must be
6010 one of the driver modules that is in the Exim binary.
6011
6012 The &(dnslookup)& router routes addresses by looking up their domains in the
6013 DNS in order to obtain a list of hosts to which the address is routed. If the
6014 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6015 specified by the &%transport%& option. If the router does not find the domain
6016 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6017 the address fails and is bounced.
6018
6019 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6020 be entirely ignored. This option is present because a number of cases have been
6021 encountered where MX records in the DNS point to host names
6022 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6023 Completely ignoring these IP addresses causes Exim to fail to route the
6024 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6025 continue to try to deliver the message periodically until the address timed
6026 out.
6027 .code
6028 system_aliases:
6029   driver = redirect
6030   allow_fail
6031   allow_defer
6032   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6033 # user = exim
6034   file_transport = address_file
6035   pipe_transport = address_pipe
6036 .endd
6037 Control reaches this and subsequent routers only for addresses in the local
6038 domains. This router checks to see whether the local part is defined as an
6039 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6040 data that it looks up from that file. If no data is found for the local part,
6041 the value of the &%data%& option is empty, causing the address to be passed to
6042 the next router.
6043
6044 &_/etc/aliases_& is a conventional name for the system aliases file that is
6045 often used. That is why it is referenced by from the default configuration
6046 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6047 &_Local/Makefile_& before building Exim.
6048 .code
6049 userforward:
6050   driver = redirect
6051   check_local_user
6052 # local_part_suffix = +* : -*
6053 # local_part_suffix_optional
6054   file = $home/.forward
6055 # allow_filter
6056   no_verify
6057   no_expn
6058   check_ancestor
6059   file_transport = address_file
6060   pipe_transport = address_pipe
6061   reply_transport = address_reply
6062 .endd
6063 This is the most complicated router in the default configuration. It is another
6064 redirection router, but this time it is looking for forwarding data set up by
6065 individual users. The &%check_local_user%& setting specifies a check that the
6066 local part of the address is the login name of a local user. If it is not, the
6067 router is skipped. The two commented options that follow &%check_local_user%&,
6068 namely:
6069 .code
6070 # local_part_suffix = +* : -*
6071 # local_part_suffix_optional
6072 .endd
6073 .vindex "&$local_part_suffix$&"
6074 show how you can specify the recognition of local part suffixes. If the first
6075 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6076 by any sequence of characters, is removed from the local part and placed in the
6077 variable &$local_part_suffix$&. The second suffix option specifies that the
6078 presence of a suffix in the local part is optional. When a suffix is present,
6079 the check for a local login uses the local part with the suffix removed.
6080
6081 When a local user account is found, the file called &_.forward_& in the user's
6082 home directory is consulted. If it does not exist, or is empty, the router
6083 declines. Otherwise, the contents of &_.forward_& are interpreted as
6084 redirection data (see chapter &<<CHAPredirect>>& for more details).
6085
6086 .cindex "Sieve filter" "enabling in default router"
6087 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6088 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6089 is commented out by default), the contents of the file are interpreted as a set
6090 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6091 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6092 separate document entitled &'Exim's interfaces to mail filtering'&.
6093
6094 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6095 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6096 There are two reasons for doing this:
6097
6098 .olist
6099 Whether or not a local user has a &_.forward_& file is not really relevant when
6100 checking an address for validity; it makes sense not to waste resources doing
6101 unnecessary work.
6102 .next
6103 More importantly, when Exim is verifying addresses or handling an EXPN
6104 command during an SMTP session, it is running as the Exim user, not as root.
6105 The group is the Exim group, and no additional groups are set up.
6106 It may therefore not be possible for Exim to read users' &_.forward_& files at
6107 this time.
6108 .endlist
6109
6110 The setting of &%check_ancestor%& prevents the router from generating a new
6111 address that is the same as any previous address that was redirected. (This
6112 works round a problem concerning a bad interaction between aliasing and
6113 forwarding &-- see section &<<SECTredlocmai>>&).
6114
6115 The final three option settings specify the transports that are to be used when
6116 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6117 auto-reply, respectively. For example, if a &_.forward_& file contains
6118 .code
6119 a.nother@elsewhere.example, /home/spqr/archive
6120 .endd
6121 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6122 transport.
6123 .code
6124 localuser:
6125   driver = accept
6126   check_local_user
6127 # local_part_suffix = +* : -*
6128 # local_part_suffix_optional
6129   transport = local_delivery
6130 .endd
6131 The final router sets up delivery into local mailboxes, provided that the local
6132 part is the name of a local login, by accepting the address and assigning it to
6133 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6134 routers, so the address is bounced. The commented suffix settings fulfil the
6135 same purpose as they do for the &(userforward)& router.
6136
6137
6138 .section "Transport configuration" "SECID56"
6139 .cindex "default" "transports"
6140 .cindex "transports" "default"
6141 Transports define mechanisms for actually delivering messages. They operate
6142 only when referenced from routers, so the order in which they are defined does
6143 not matter. The transports section of the configuration starts with
6144 .code
6145 begin transports
6146 .endd
6147 One remote transport and four local transports are defined.
6148 .code
6149 remote_smtp:
6150   driver = smtp
6151   hosts_try_prdr = *
6152 .endd
6153 This transport is used for delivering messages over SMTP connections.
6154 The list of remote hosts comes from the router.
6155 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6156 It is negotiated between client and server
6157 and not expected to cause problems but can be disabled if needed.
6158 All other options are defaulted.
6159 .code
6160 local_delivery:
6161   driver = appendfile
6162   file = /var/mail/$local_part
6163   delivery_date_add
6164   envelope_to_add
6165   return_path_add
6166 # group = mail
6167 # mode = 0660
6168 .endd
6169 This &(appendfile)& transport is used for local delivery to user mailboxes in
6170 traditional BSD mailbox format. By default it runs under the uid and gid of the
6171 local user, which requires the sticky bit to be set on the &_/var/mail_&
6172 directory. Some systems use the alternative approach of running mail deliveries
6173 under a particular group instead of using the sticky bit. The commented options
6174 show how this can be done.
6175
6176 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6177 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6178 similarly-named options above.
6179 .code
6180 address_pipe:
6181   driver = pipe
6182   return_output
6183 .endd
6184 This transport is used for handling deliveries to pipes that are generated by
6185 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6186 option specifies that any output on stdout or stderr generated by the pipe is to
6187 be returned to the sender.
6188 .code
6189 address_file:
6190   driver = appendfile
6191   delivery_date_add
6192   envelope_to_add
6193   return_path_add
6194 .endd
6195 This transport is used for handling deliveries to files that are generated by
6196 redirection. The name of the file is not specified in this instance of
6197 &(appendfile)&, because it comes from the &(redirect)& router.
6198 .code
6199 address_reply:
6200   driver = autoreply
6201 .endd
6202 This transport is used for handling automatic replies generated by users'
6203 filter files.
6204
6205
6206
6207 .section "Default retry rule" "SECID57"
6208 .cindex "retry" "default rule"
6209 .cindex "default" "retry rule"
6210 The retry section of the configuration file contains rules which affect the way
6211 Exim retries deliveries that cannot be completed at the first attempt. It is
6212 introduced by the line
6213 .code
6214 begin retry
6215 .endd
6216 In the default configuration, there is just one rule, which applies to all
6217 errors:
6218 .code
6219 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6220 .endd
6221 This causes any temporarily failing address to be retried every 15 minutes for
6222 2 hours, then at intervals starting at one hour and increasing by a factor of
6223 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6224 is not delivered after 4 days of temporary failure, it is bounced. The time is
6225 measured from first failure, not from the time the message was received.
6226
6227 If the retry section is removed from the configuration, or is empty (that is,
6228 if no retry rules are defined), Exim will not retry deliveries. This turns
6229 temporary errors into permanent errors.
6230
6231
6232 .section "Rewriting configuration" "SECID58"
6233 The rewriting section of the configuration, introduced by
6234 .code
6235 begin rewrite
6236 .endd
6237 contains rules for rewriting addresses in messages as they arrive. There are no
6238 rewriting rules in the default configuration file.
6239
6240
6241
6242 .section "Authenticators configuration" "SECTdefconfauth"
6243 .cindex "AUTH" "configuration"
6244 The authenticators section of the configuration, introduced by
6245 .code
6246 begin authenticators
6247 .endd
6248 defines mechanisms for the use of the SMTP AUTH command. The default
6249 configuration file contains two commented-out example authenticators
6250 which support plaintext username/password authentication using the
6251 standard PLAIN mechanism and the traditional but non-standard LOGIN
6252 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6253 to support most MUA software.
6254
6255 The example PLAIN authenticator looks like this:
6256 .code
6257 #PLAIN:
6258 #  driver                  = plaintext
6259 #  server_set_id           = $auth2
6260 #  server_prompts          = :
6261 #  server_condition        = Authentication is not yet configured
6262 #  server_advertise_condition = ${if def:tls_in_cipher }
6263 .endd
6264 And the example LOGIN authenticator looks like this:
6265 .code
6266 #LOGIN:
6267 #  driver                  = plaintext
6268 #  server_set_id           = $auth1
6269 #  server_prompts          = <| Username: | Password:
6270 #  server_condition        = Authentication is not yet configured
6271 #  server_advertise_condition = ${if def:tls_in_cipher }
6272 .endd
6273
6274 The &%server_set_id%& option makes Exim remember the authenticated username
6275 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6276 &%server_prompts%& option configures the &(plaintext)& authenticator so
6277 that it implements the details of the specific authentication mechanism,
6278 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6279 when Exim offers authentication to clients; in the examples, this is only
6280 when TLS or SSL has been started, so to enable the authenticators you also
6281 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6282
6283 The &%server_condition%& setting defines how to verify that the username and
6284 password are correct. In the examples it just produces an error message.
6285 To make the authenticators work, you can use a string expansion
6286 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6287
6288 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6289 usercode and password are in different positions.
6290 Chapter &<<CHAPplaintext>>& covers both.
6291
6292 .ecindex IIDconfiwal
6293
6294
6295
6296 . ////////////////////////////////////////////////////////////////////////////
6297 . ////////////////////////////////////////////////////////////////////////////
6298
6299 .chapter "Regular expressions" "CHAPregexp"
6300
6301 .cindex "regular expressions" "library"
6302 .cindex "PCRE"
6303 Exim supports the use of regular expressions in many of its options. It
6304 uses the PCRE regular expression library; this provides regular expression
6305 matching that is compatible with Perl 5. The syntax and semantics of
6306 regular expressions is discussed in
6307 online Perl manpages, in
6308 many Perl reference books, and also in
6309 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6310 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6311
6312 The documentation for the syntax and semantics of the regular expressions that
6313 are supported by PCRE is included in the PCRE distribution, and no further
6314 description is included here. The PCRE functions are called from Exim using
6315 the default option settings (that is, with no PCRE options set), except that
6316 the PCRE_CASELESS option is set when the matching is required to be
6317 case-insensitive.
6318
6319 In most cases, when a regular expression is required in an Exim configuration,
6320 it has to start with a circumflex, in order to distinguish it from plain text
6321 or an &"ends with"& wildcard. In this example of a configuration setting, the
6322 second item in the colon-separated list is a regular expression.
6323 .code
6324 domains = a.b.c : ^\\d{3} : *.y.z : ...
6325 .endd
6326 The doubling of the backslash is required because of string expansion that
6327 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6328 of this issue, and a way of avoiding the need for doubling backslashes. The
6329 regular expression that is eventually used in this example contains just one
6330 backslash. The circumflex is included in the regular expression, and has the
6331 normal effect of &"anchoring"& it to the start of the string that is being
6332 matched.
6333
6334 There are, however, two cases where a circumflex is not required for the
6335 recognition of a regular expression: these are the &%match%& condition in a
6336 string expansion, and the &%matches%& condition in an Exim filter file. In
6337 these cases, the relevant string is always treated as a regular expression; if
6338 it does not start with a circumflex, the expression is not anchored, and can
6339 match anywhere in the subject string.
6340
6341 In all cases, if you want a regular expression to match at the end of a string,
6342 you must code the $ metacharacter to indicate this. For example:
6343 .code
6344 domains = ^\\d{3}\\.example
6345 .endd
6346 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6347 You need to use:
6348 .code
6349 domains = ^\\d{3}\\.example\$
6350 .endd
6351 if you want &'example'& to be the top-level domain. The backslash before the
6352 $ is needed because string expansion also interprets dollar characters.
6353
6354
6355
6356 . ////////////////////////////////////////////////////////////////////////////
6357 . ////////////////////////////////////////////////////////////////////////////
6358
6359 .chapter "File and database lookups" "CHAPfdlookup"
6360 .scindex IIDfidalo1 "file" "lookups"
6361 .scindex IIDfidalo2 "database" "lookups"
6362 .cindex "lookup" "description of"
6363 Exim can be configured to look up data in files or databases as it processes
6364 messages. Two different kinds of syntax are used:
6365
6366 .olist
6367 A string that is to be expanded may contain explicit lookup requests. These
6368 cause parts of the string to be replaced by data that is obtained from the
6369 lookup. Lookups of this type are conditional expansion items. Different results
6370 can be defined for the cases of lookup success and failure. See chapter
6371 &<<CHAPexpand>>&, where string expansions are described in detail.
6372 The key for the lookup is specified as part of the string expansion.
6373 .next
6374 Lists of domains, hosts, and email addresses can contain lookup requests as a
6375 way of avoiding excessively long linear lists. In this case, the data that is
6376 returned by the lookup is often (but not always) discarded; whether the lookup
6377 succeeds or fails is what really counts. These kinds of list are described in
6378 chapter &<<CHAPdomhosaddlists>>&.
6379 The key for the lookup is given by the context in which the list is expanded.
6380 .endlist
6381
6382 String expansions, lists, and lookups interact with each other in such a way
6383 that there is no order in which to describe any one of them that does not
6384 involve references to the others. Each of these three chapters makes more sense
6385 if you have read the other two first. If you are reading this for the first
6386 time, be aware that some of it will make a lot more sense after you have read
6387 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6388
6389 .section "Examples of different lookup syntax" "SECID60"
6390 It is easy to confuse the two different kinds of lookup, especially as the
6391 lists that may contain the second kind are always expanded before being
6392 processed as lists. Therefore, they may also contain lookups of the first kind.
6393 Be careful to distinguish between the following two examples:
6394 .code
6395 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6396 domains = lsearch;/some/file
6397 .endd
6398 The first uses a string expansion, the result of which must be a domain list.
6399 No strings have been specified for a successful or a failing lookup; the
6400 defaults in this case are the looked-up data and an empty string, respectively.
6401 The expansion takes place before the string is processed as a list, and the
6402 file that is searched could contain lines like this:
6403 .code
6404 192.168.3.4: domain1:domain2:...
6405 192.168.1.9: domain3:domain4:...
6406 .endd
6407 When the lookup succeeds, the result of the expansion is a list of domains (and
6408 possibly other types of item that are allowed in domain lists).
6409
6410 In the second example, the lookup is a single item in a domain list. It causes
6411 Exim to use a lookup to see if the domain that is being processed can be found
6412 in the file. The file could contains lines like this:
6413 .code
6414 domain1:
6415 domain2:
6416 .endd
6417 Any data that follows the keys is not relevant when checking that the domain
6418 matches the list item.
6419
6420 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6421 Consider a file containing lines like this:
6422 .code
6423 192.168.5.6: lsearch;/another/file
6424 .endd
6425 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6426 first &%domains%& setting above generates the second setting, which therefore
6427 causes a second lookup to occur.
6428
6429 The rest of this chapter describes the different lookup types that are
6430 available. Any of them can be used in any part of the configuration where a
6431 lookup is permitted.
6432
6433
6434 .section "Lookup types" "SECID61"
6435 .cindex "lookup" "types of"
6436 .cindex "single-key lookup" "definition of"
6437 Two different types of data lookup are implemented:
6438
6439 .ilist
6440 The &'single-key'& type requires the specification of a file in which to look,
6441 and a single key to search for. The key must be a non-empty string for the
6442 lookup to succeed. The lookup type determines how the file is searched.
6443 .next
6444 .cindex "query-style lookup" "definition of"
6445 The &'query-style'& type accepts a generalized database query. No particular
6446 key value is assumed by Exim for query-style lookups. You can use whichever
6447 Exim variables you need to construct the database query.
6448 .endlist
6449
6450 The code for each lookup type is in a separate source file that is included in
6451 the binary of Exim only if the corresponding compile-time option is set. The
6452 default settings in &_src/EDITME_& are:
6453 .code
6454 LOOKUP_DBM=yes
6455 LOOKUP_LSEARCH=yes
6456 .endd
6457 which means that only linear searching and DBM lookups are included by default.
6458 For some types of lookup (e.g. SQL databases), you need to install appropriate
6459 libraries and header files before building Exim.
6460
6461
6462
6463
6464 .section "Single-key lookup types" "SECTsinglekeylookups"
6465 .cindex "lookup" "single-key types"
6466 .cindex "single-key lookup" "list of types"
6467 The following single-key lookup types are implemented:
6468
6469 .ilist
6470 .cindex "cdb" "description of"
6471 .cindex "lookup" "cdb"
6472 .cindex "binary zero" "in lookup key"
6473 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6474 string without a terminating binary zero. The cdb format is designed for
6475 indexed files that are read frequently and never updated, except by total
6476 re-creation. As such, it is particularly suitable for large files containing
6477 aliases or other indexed data referenced by an MTA. Information about cdb can
6478 be found in several places:
6479 .display
6480 &url(http://www.pobox.com/~djb/cdb.html)
6481 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6482 &url(http://packages.debian.org/stable/utils/freecdb.html)
6483 .endd
6484 A cdb distribution is not needed in order to build Exim with cdb support,
6485 because the code for reading cdb files is included directly in Exim itself.
6486 However, no means of building or testing cdb files is provided with Exim, so
6487 you need to obtain a cdb distribution in order to do this.
6488 .next
6489 .cindex "DBM" "lookup type"
6490 .cindex "lookup" "dbm"
6491 .cindex "binary zero" "in lookup key"
6492 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6493 DBM file by looking up the record with the given key. A terminating binary
6494 zero is included in the key that is passed to the DBM library. See section
6495 &<<SECTdb>>& for a discussion of DBM libraries.
6496
6497 .cindex "Berkeley DB library" "file format"
6498 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6499 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6500 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6501 the DB_UNKNOWN option. This enables it to handle any of the types of database
6502 that the library supports, and can be useful for accessing DBM files created by
6503 other applications. (For earlier DB versions, DB_HASH is always used.)
6504 .next
6505 .cindex "lookup" "dbmjz"
6506 .cindex "lookup" "dbm &-- embedded NULs"
6507 .cindex "sasldb2"
6508 .cindex "dbmjz lookup type"
6509 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6510 interpreted as an Exim list; the elements of the list are joined together with
6511 ASCII NUL characters to form the lookup key.  An example usage would be to
6512 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6513 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6514 &(cram_md5)& authenticator.
6515 .next
6516 .cindex "lookup" "dbmnz"
6517 .cindex "lookup" "dbm &-- terminating zero"
6518 .cindex "binary zero" "in lookup key"
6519 .cindex "Courier"
6520 .cindex "&_/etc/userdbshadow.dat_&"
6521 .cindex "dbmnz lookup type"
6522 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6523 is not included in the key that is passed to the DBM library. You may need this
6524 if you want to look up data in files that are created by or shared with some
6525 other application that does not use terminating zeros. For example, you need to
6526 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6527 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6528 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6529 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6530 .next
6531 .cindex "lookup" "dsearch"
6532 .cindex "dsearch lookup type"
6533 &(dsearch)&: The given file must be a directory; this is searched for an entry
6534 whose name is the key by calling the &[lstat()]& function. The key may not
6535 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6536 the lookup is the name of the entry, which may be a file, directory,
6537 symbolic link, or any other kind of directory entry. An example of how this
6538 lookup can be used to support virtual domains is given in section
6539 &<<SECTvirtualdomains>>&.
6540 .next
6541 .cindex "lookup" "iplsearch"
6542 .cindex "iplsearch lookup type"
6543 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6544 terminated by a colon or white space or the end of the line. The keys in the
6545 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6546 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6547 being interpreted as a key terminator. For example:
6548 .code
6549 1.2.3.4:           data for 1.2.3.4
6550 192.168.0.0/16:    data for 192.168.0.0/16
6551 "abcd::cdab":      data for abcd::cdab
6552 "abcd:abcd::/32"   data for abcd:abcd::/32
6553 .endd
6554 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6555 file is searched linearly, using the CIDR masks where present, until a matching
6556 key is found. The first key that matches is used; there is no attempt to find a
6557 &"best"& match. Apart from the way the keys are matched, the processing for
6558 &(iplsearch)& is the same as for &(lsearch)&.
6559
6560 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6561 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6562 lookup types support only literal keys.
6563
6564 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6565 the implicit key is the host's IP address rather than its name (see section
6566 &<<SECThoslispatsikey>>&).
6567 .next
6568 .cindex "linear search"
6569 .cindex "lookup" "lsearch"
6570 .cindex "lsearch lookup type"
6571 .cindex "case sensitivity" "in lsearch lookup"
6572 &(lsearch)&: The given file is a text file that is searched linearly for a
6573 line beginning with the search key, terminated by a colon or white space or the
6574 end of the line. The search is case-insensitive; that is, upper and lower case
6575 letters are treated as the same. The first occurrence of the key that is found
6576 in the file is used.
6577
6578 White space between the key and the colon is permitted. The remainder of the
6579 line, with leading and trailing white space removed, is the data. This can be
6580 continued onto subsequent lines by starting them with any amount of white
6581 space, but only a single space character is included in the data at such a
6582 junction. If the data begins with a colon, the key must be terminated by a
6583 colon, for example:
6584 .code
6585 baduser:  :fail:
6586 .endd
6587 Empty lines and lines beginning with # are ignored, even if they occur in the
6588 middle of an item. This is the traditional textual format of alias files. Note
6589 that the keys in an &(lsearch)& file are literal strings. There is no
6590 wildcarding of any kind.
6591
6592 .cindex "lookup" "lsearch &-- colons in keys"
6593 .cindex "white space" "in lsearch key"
6594 In most &(lsearch)& files, keys are not required to contain colons or #
6595 characters, or white space. However, if you need this feature, it is available.
6596 If a key begins with a doublequote character, it is terminated only by a
6597 matching quote (or end of line), and the normal escaping rules apply to its
6598 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6599 quoted keys (exactly as for unquoted keys). There is no special handling of
6600 quotes for the data part of an &(lsearch)& line.
6601
6602 .next
6603 .cindex "NIS lookup type"
6604 .cindex "lookup" "NIS"
6605 .cindex "binary zero" "in lookup key"
6606 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6607 the given key, without a terminating binary zero. There is a variant called
6608 &(nis0)& which does include the terminating binary zero in the key. This is
6609 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6610 aliases; the full map names must be used.
6611
6612 .next
6613 .cindex "wildlsearch lookup type"
6614 .cindex "lookup" "wildlsearch"
6615 .cindex "nwildlsearch lookup type"
6616 .cindex "lookup" "nwildlsearch"
6617 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6618 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6619 the file may be wildcarded. The difference between these two lookup types is
6620 that for &(wildlsearch)&, each key in the file is string-expanded before being
6621 used, whereas for &(nwildlsearch)&, no expansion takes place.
6622
6623 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6624 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6625 file that are regular expressions can be made case-sensitive by the use of
6626 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6627
6628 . ==== As this is a nested list, any displays it contains must be indented
6629 . ==== as otherwise they are too far to the left.
6630
6631 .olist
6632 The string may begin with an asterisk to mean &"ends with"&. For example:
6633 .code
6634     *.a.b.c       data for anything.a.b.c
6635     *fish         data for anythingfish
6636 .endd
6637 .next
6638 The string may begin with a circumflex to indicate a regular expression. For
6639 example, for &(wildlsearch)&:
6640 .code
6641     ^\N\d+\.a\.b\N    data for <digits>.a.b
6642 .endd
6643 Note the use of &`\N`& to disable expansion of the contents of the regular
6644 expression. If you are using &(nwildlsearch)&, where the keys are not
6645 string-expanded, the equivalent entry is:
6646 .code
6647     ^\d+\.a\.b        data for <digits>.a.b
6648 .endd
6649 The case-insensitive flag is set at the start of compiling the regular
6650 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6651 For example, to make the entire pattern case-sensitive:
6652 .code
6653     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6654 .endd
6655
6656 If the regular expression contains white space or colon characters, you must
6657 either quote it (see &(lsearch)& above), or represent these characters in other
6658 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6659 colon. This may be easier than quoting, because if you quote, you have to
6660 escape all the backslashes inside the quotes.
6661
6662 &*Note*&: It is not possible to capture substrings in a regular expression
6663 match for later use, because the results of all lookups are cached. If a lookup
6664 is repeated, the result is taken from the cache, and no actual pattern matching
6665 takes place. The values of all the numeric variables are unset after a
6666 &((n)wildlsearch)& match.
6667
6668 .next
6669 Although I cannot see it being of much use, the general matching function that
6670 is used to implement &((n)wildlsearch)& means that the string may begin with a
6671 lookup name terminated by a semicolon, and followed by lookup data. For
6672 example:
6673 .code
6674     cdb;/some/file  data for keys that match the file
6675 .endd
6676 The data that is obtained from the nested lookup is discarded.
6677 .endlist olist
6678
6679 Keys that do not match any of these patterns are interpreted literally. The
6680 continuation rules for the data are the same as for &(lsearch)&, and keys may
6681 be followed by optional colons.
6682
6683 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6684 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6685 lookup types support only literal keys.
6686 .endlist ilist
6687
6688
6689 .section "Query-style lookup types" "SECTquerystylelookups"
6690 .cindex "lookup" "query-style types"
6691 .cindex "query-style lookup" "list of types"
6692 The supported query-style lookup types are listed below. Further details about
6693 many of them are given in later sections.
6694
6695 .ilist
6696 .cindex "DNS" "as a lookup type"
6697 .cindex "lookup" "DNS"
6698 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6699 are given in the supplied query. The resulting data is the contents of the
6700 records. See section &<<SECTdnsdb>>&.
6701 .next
6702 .cindex "InterBase lookup type"
6703 .cindex "lookup" "InterBase"
6704 &(ibase)&: This does a lookup in an InterBase database.
6705 .next
6706 .cindex "LDAP" "lookup type"
6707 .cindex "lookup" "LDAP"
6708 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6709 returns attributes from a single entry. There is a variant called &(ldapm)&
6710 that permits values from multiple entries to be returned. A third variant
6711 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6712 any attribute values. See section &<<SECTldap>>&.
6713 .next
6714 .cindex "MySQL" "lookup type"
6715 .cindex "lookup" "MySQL"
6716 &(mysql)&: The format of the query is an SQL statement that is passed to a
6717 MySQL database. See section &<<SECTsql>>&.
6718 .next
6719 .cindex "NIS+ lookup type"
6720 .cindex "lookup" "NIS+"
6721 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6722 the field to be returned. See section &<<SECTnisplus>>&.
6723 .next
6724 .cindex "Oracle" "lookup type"
6725 .cindex "lookup" "Oracle"
6726 &(oracle)&: The format of the query is an SQL statement that is passed to an
6727 Oracle database. See section &<<SECTsql>>&.
6728 .next
6729 .cindex "lookup" "passwd"
6730 .cindex "passwd lookup type"
6731 .cindex "&_/etc/passwd_&"
6732 &(passwd)& is a query-style lookup with queries that are just user names. The
6733 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6734 success, the result string is the same as you would get from an &(lsearch)&
6735 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6736 password value. For example:
6737 .code
6738 *:42:42:King Rat:/home/kr:/bin/bash
6739 .endd
6740 .next
6741 .cindex "PostgreSQL lookup type"
6742 .cindex "lookup" "PostgreSQL"
6743 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6744 PostgreSQL database. See section &<<SECTsql>>&.
6745
6746 .next
6747 .cindex "Redis lookup type"
6748 .cindex lookup Redis
6749 &(redis)&: The format of the query is either a simple get or simple set,
6750 passed to a Redis database. See section &<<SECTsql>>&.
6751
6752 .next
6753 .cindex "sqlite lookup type"
6754 .cindex "lookup" "sqlite"
6755 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6756 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6757
6758 .next
6759 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6760 not likely to be useful in normal operation.
6761 .next
6762 .cindex "whoson lookup type"
6763 .cindex "lookup" "whoson"
6764 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6765 allows a server to check whether a particular (dynamically allocated) IP
6766 address is currently allocated to a known (trusted) user and, optionally, to
6767 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6768 at one time for &"POP before SMTP"& authentication, but that approach has been
6769 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6770 &"POP before SMTP"& checking using ACL statements such as
6771 .code
6772 require condition = \
6773   ${lookup whoson {$sender_host_address}{yes}{no}}
6774 .endd
6775 The query consists of a single IP address. The value returned is the name of
6776 the authenticated user, which is stored in the variable &$value$&. However, in
6777 this example, the data in &$value$& is not used; the result of the lookup is
6778 one of the fixed strings &"yes"& or &"no"&.
6779 .endlist
6780
6781
6782
6783 .section "Temporary errors in lookups" "SECID63"
6784 .cindex "lookup" "temporary error in"
6785 Lookup functions can return temporary error codes if the lookup cannot be
6786 completed. For example, an SQL or LDAP database might be unavailable. For this
6787 reason, it is not advisable to use a lookup that might do this for critical
6788 options such as a list of local domains.
6789
6790 When a lookup cannot be completed in a router or transport, delivery
6791 of the message (to the relevant address) is deferred, as for any other
6792 temporary error. In other circumstances Exim may assume the lookup has failed,
6793 or may give up altogether.
6794
6795
6796
6797 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6798 .cindex "wildcard lookups"
6799 .cindex "lookup" "default values"
6800 .cindex "lookup" "wildcard"
6801 .cindex "lookup" "* added to type"
6802 .cindex "default" "in single-key lookups"
6803 In this context, a &"default value"& is a value specified by the administrator
6804 that is to be used if a lookup fails.
6805
6806 &*Note:*& This section applies only to single-key lookups. For query-style
6807 lookups, the facilities of the query language must be used. An attempt to
6808 specify a default for a query-style lookup provokes an error.
6809
6810 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6811 and the initial lookup fails, the key &"*"& is looked up in the file to
6812 provide a default value. See also the section on partial matching below.
6813
6814 .cindex "*@ with single-key lookup"
6815 .cindex "lookup" "*@ added to type"
6816 .cindex "alias file" "per-domain default"
6817 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6818 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6819 character, a second lookup is done with everything before the last @ replaced
6820 by *. This makes it possible to provide per-domain defaults in alias files
6821 that include the domains in the keys. If the second lookup fails (or doesn't
6822 take place because there is no @ in the key), &"*"& is looked up.
6823 For example, a &(redirect)& router might contain:
6824 .code
6825 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6826 .endd
6827 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6828 looks up these keys, in this order:
6829 .code
6830 jane@eyre.example
6831 *@eyre.example
6832 *
6833 .endd
6834 The data is taken from whichever key it finds first. &*Note*&: In an
6835 &(lsearch)& file, this does not mean the first of these keys in the file. A
6836 complete scan is done for each key, and only if it is not found at all does
6837 Exim move on to try the next key.
6838
6839
6840
6841 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6842 .cindex "partial matching"
6843 .cindex "wildcard lookups"
6844 .cindex "lookup" "partial matching"
6845 .cindex "lookup" "wildcard"
6846 .cindex "asterisk" "in search type"
6847 The normal operation of a single-key lookup is to search the file for an exact
6848 match with the given key. However, in a number of situations where domains are
6849 being looked up, it is useful to be able to do partial matching. In this case,
6850 information in the file that has a key starting with &"*."& is matched by any
6851 domain that ends with the components that follow the full stop. For example, if
6852 a key in a DBM file is
6853 .code
6854 *.dates.fict.example
6855 .endd
6856 then when partial matching is enabled this is matched by (amongst others)
6857 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6858 by &'dates.fict.example'&, if that does not appear as a separate key in the
6859 file.
6860
6861 &*Note*&: Partial matching is not available for query-style lookups. It is
6862 also not available for any lookup items in address lists (see section
6863 &<<SECTaddresslist>>&).
6864
6865 Partial matching is implemented by doing a series of separate lookups using
6866 keys constructed by modifying the original subject key. This means that it can
6867 be used with any of the single-key lookup types, provided that
6868 partial matching keys
6869 beginning with a special prefix (default &"*."&) are included in the data file.
6870 Keys in the file that do not begin with the prefix are matched only by
6871 unmodified subject keys when partial matching is in use.
6872
6873 Partial matching is requested by adding the string &"partial-"& to the front of
6874 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6875 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6876 is added at the start of the subject key, and it is looked up again. If that
6877 fails, further lookups are tried with dot-separated components removed from the
6878 start of the subject key, one-by-one, and &"*."& added on the front of what
6879 remains.
6880
6881 A minimum number of two non-* components are required. This can be adjusted
6882 by including a number before the hyphen in the search type. For example,
6883 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6884 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6885 subject key is &'2250.dates.fict.example'& then the following keys are looked
6886 up when the minimum number of non-* components is two:
6887 .code
6888 2250.dates.fict.example
6889 *.2250.dates.fict.example
6890 *.dates.fict.example
6891 *.fict.example
6892 .endd
6893 As soon as one key in the sequence is successfully looked up, the lookup
6894 finishes.
6895
6896 .cindex "lookup" "partial matching &-- changing prefix"
6897 .cindex "prefix" "for partial matching"
6898 The use of &"*."& as the partial matching prefix is a default that can be
6899 changed. The motivation for this feature is to allow Exim to operate with file
6900 formats that are used by other MTAs. A different prefix can be supplied in
6901 parentheses instead of the hyphen after &"partial"&. For example:
6902 .code
6903 domains = partial(.)lsearch;/some/file
6904 .endd
6905 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6906 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6907 components is unchanged). The prefix may consist of any punctuation characters
6908 other than a closing parenthesis. It may be empty, for example:
6909 .code
6910 domains = partial1()cdb;/some/file
6911 .endd
6912 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6913 &`a.b.c`&, &`b.c`&, and &`c`&.
6914
6915 If &"partial0"& is specified, what happens at the end (when the lookup with
6916 just one non-wild component has failed, and the original key is shortened right
6917 down to the null string) depends on the prefix:
6918
6919 .ilist
6920 If the prefix has zero length, the whole lookup fails.
6921 .next
6922 If the prefix has length 1, a lookup for just the prefix is done. For
6923 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6924 .next
6925 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6926 remainder is looked up. With the default prefix, therefore, the final lookup is
6927 for &"*"& on its own.
6928 .next
6929 Otherwise, the whole prefix is looked up.
6930 .endlist
6931
6932
6933 If the search type ends in &"*"& or &"*@"& (see section
6934 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6935 this implies happens after all partial lookups have failed. If &"partial0"& is
6936 specified, adding &"*"& to the search type has no effect with the default
6937 prefix, because the &"*"& key is already included in the sequence of partial
6938 lookups. However, there might be a use for lookup types such as
6939 &"partial0(.)lsearch*"&.
6940
6941 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6942 in domain lists and the like. Partial matching works only in terms of
6943 dot-separated components; a key such as &`*fict.example`&
6944 in a database file is useless, because the asterisk in a partial matching
6945 subject key is always followed by a dot.
6946
6947
6948
6949
6950 .section "Lookup caching" "SECID64"
6951 .cindex "lookup" "caching"
6952 .cindex "caching" "lookup data"
6953 Exim caches all lookup results in order to avoid needless repetition of
6954 lookups. However, because (apart from the daemon) Exim operates as a collection
6955 of independent, short-lived processes, this caching applies only within a
6956 single Exim process. There is no inter-process lookup caching facility.
6957
6958 For single-key lookups, Exim keeps the relevant files open in case there is
6959 another lookup that needs them. In some types of configuration this can lead to
6960 many files being kept open for messages with many recipients. To avoid hitting
6961 the operating system limit on the number of simultaneously open files, Exim
6962 closes the least recently used file when it needs to open more files than its
6963 own internal limit, which can be changed via the &%lookup_open_max%& option.
6964
6965 The single-key lookup files are closed and the lookup caches are flushed at
6966 strategic points during delivery &-- for example, after all routing is
6967 complete.
6968
6969
6970
6971
6972 .section "Quoting lookup data" "SECID65"
6973 .cindex "lookup" "quoting"
6974 .cindex "quoting" "in lookups"
6975 When data from an incoming message is included in a query-style lookup, there
6976 is the possibility of special characters in the data messing up the syntax of
6977 the query. For example, a NIS+ query that contains
6978 .code
6979 [name=$local_part]
6980 .endd
6981 will be broken if the local part happens to contain a closing square bracket.
6982 For NIS+, data can be enclosed in double quotes like this:
6983 .code
6984 [name="$local_part"]
6985 .endd
6986 but this still leaves the problem of a double quote in the data. The rule for
6987 NIS+ is that double quotes must be doubled. Other lookup types have different
6988 rules, and to cope with the differing requirements, an expansion operator
6989 of the following form is provided:
6990 .code
6991 ${quote_<lookup-type>:<string>}
6992 .endd
6993 For example, the safest way to write the NIS+ query is
6994 .code
6995 [name="${quote_nisplus:$local_part}"]
6996 .endd
6997 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6998 operator can be used for all lookup types, but has no effect for single-key
6999 lookups, since no quoting is ever needed in their key strings.
7000
7001
7002
7003
7004 .section "More about dnsdb" "SECTdnsdb"
7005 .cindex "dnsdb lookup"
7006 .cindex "lookup" "dnsdb"
7007 .cindex "DNS" "as a lookup type"
7008 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7009 of a record type and a domain name, separated by an equals sign. For example,
7010 an expansion string could contain:
7011 .code
7012 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7013 .endd
7014 If the lookup succeeds, the result is placed in &$value$&, which in this case
7015 is used on its own as the result. If the lookup does not succeed, the
7016 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7017 &<<SECTforexpfai>>& for an explanation of what this means.
7018
7019 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7020 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7021 If no type is given, TXT is assumed.
7022
7023 For any record type, if multiple records are found, the data is returned as a
7024 concatenation, with newline as the default separator. The order, of course,
7025 depends on the DNS resolver. You can specify a different separator character
7026 between multiple records by putting a right angle-bracket followed immediately
7027 by the new separator at the start of the query. For example:
7028 .code
7029 ${lookup dnsdb{>: a=host1.example}}
7030 .endd
7031 It is permitted to specify a space as the separator character. Further
7032 white space is ignored.
7033 For lookup types that return multiple fields per record,
7034 an alternate field separator can be specified using a comma after the main
7035 separator character, followed immediately by the field separator.
7036
7037 .cindex "PTR record" "in &(dnsdb)& lookup"
7038 When the type is PTR,
7039 the data can be an IP address, written as normal; inversion and the addition of
7040 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7041 .code
7042 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7043 .endd
7044 If the data for a PTR record is not a syntactically valid IP address, it is not
7045 altered and nothing is added.
7046
7047 .cindex "MX record" "in &(dnsdb)& lookup"
7048 .cindex "SRV record" "in &(dnsdb)& lookup"
7049 For an MX lookup, both the preference value and the host name are returned for
7050 each record, separated by a space. For an SRV lookup, the priority, weight,
7051 port, and host name are returned for each record, separated by spaces.
7052 The field separator can be modified as above.
7053
7054 .cindex "TXT record" "in &(dnsdb)& lookup"
7055 .cindex "SPF record" "in &(dnsdb)& lookup"
7056 For TXT records with multiple items of data, only the first item is returned,
7057 unless a field separator is specified.
7058 To concatenate items without a separator, use a semicolon instead.
7059 For SPF records the
7060 default behaviour is to concatenate multiple items without using a separator.
7061 .code
7062 ${lookup dnsdb{>\n,: txt=a.b.example}}
7063 ${lookup dnsdb{>\n; txt=a.b.example}}
7064 ${lookup dnsdb{spf=example.org}}
7065 .endd
7066 It is permitted to specify a space as the separator character. Further
7067 white space is ignored.
7068
7069 .cindex "SOA record" "in &(dnsdb)& lookup"
7070 For an SOA lookup, while no result is obtained the lookup is redone with
7071 successively more leading components dropped from the given domain.
7072 Only the primary-nameserver field is returned unless a field separator is
7073 specified.
7074 .code
7075 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7076 .endd
7077
7078 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7079 .cindex "dnsdb modifiers"
7080 .cindex "modifiers" "dnsdb"
7081 .cindex "options" "dnsdb"
7082 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7083 each followed by a comma,
7084 that may appear before the record type.
7085
7086 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7087 temporary DNS error for any of them, the behaviour is controlled by
7088 a defer-option modifier.
7089 The possible keywords are
7090 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7091 With &"strict"& behaviour, any temporary DNS error causes the
7092 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7093 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7094 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7095 error causes the whole lookup to defer only if none of the other lookups
7096 succeed. The default is &"lax"&, so the following lookups are equivalent:
7097 .code
7098 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7099 ${lookup dnsdb{a=one.host.com:two.host.com}}
7100 .endd
7101 Thus, in the default case, as long as at least one of the DNS lookups
7102 yields some data, the lookup succeeds.
7103
7104 .cindex "DNSSEC" "dns lookup"
7105 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7106 The possible keywords are
7107 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7108 With &"strict"& or &"lax"& DNSSEC information is requested
7109 with the lookup.
7110 With &"strict"& a response from the DNS resolver that
7111 is not labelled as authenticated data
7112 is treated as equivalent to a temporary DNS error.
7113 The default is &"never"&.
7114
7115 See also the &$lookup_dnssec_authenticated$& variable.
7116
7117 .cindex timeout "dns lookup"
7118 .cindex "DNS" timeout
7119 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7120 The form is &"retrans_VAL"& where VAL is an Exim time specification
7121 (e.g. &"5s"&).
7122 The default value is set by the main configuration option &%dns_retrans%&.
7123
7124 Retries for the dnsdb lookup can be controlled by a retry modifier.
7125 The form if &"retry_VAL"& where VAL is an integer.
7126 The default count is set by the main configuration option &%dns_retry%&.
7127
7128 .cindex caching "of dns lookup"
7129 .cindex TTL "of dns lookup"
7130 .cindex DNS TTL
7131 Dnsdb lookup results are cached within a single process (and its children).
7132 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7133 value of the set of returned DNS records.
7134
7135
7136 .section "Pseudo dnsdb record types" "SECID66"
7137 .cindex "MX record" "in &(dnsdb)& lookup"
7138 By default, both the preference value and the host name are returned for
7139 each MX record, separated by a space. If you want only host names, you can use
7140 the pseudo-type MXH:
7141 .code
7142 ${lookup dnsdb{mxh=a.b.example}}
7143 .endd
7144 In this case, the preference values are omitted, and just the host names are
7145 returned.
7146
7147 .cindex "name server for enclosing domain"
7148 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7149 records on the given domain, but if none are found, it removes the first
7150 component of the domain name, and tries again. This process continues until NS
7151 records are found or there are no more components left (or there is a DNS
7152 error). In other words, it may return the name servers for a top-level domain,
7153 but it never returns the root name servers. If there are no NS records for the
7154 top-level domain, the lookup fails. Consider these examples:
7155 .code
7156 ${lookup dnsdb{zns=xxx.quercite.com}}
7157 ${lookup dnsdb{zns=xxx.edu}}
7158 .endd
7159 Assuming that in each case there are no NS records for the full domain name,
7160 the first returns the name servers for &%quercite.com%&, and the second returns
7161 the name servers for &%edu%&.
7162
7163 You should be careful about how you use this lookup because, unless the
7164 top-level domain does not exist, the lookup always returns some host names. The
7165 sort of use to which this might be put is for seeing if the name servers for a
7166 given domain are on a blacklist. You can probably assume that the name servers
7167 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7168 such a list.
7169
7170 .cindex "CSA" "in &(dnsdb)& lookup"
7171 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7172 records according to the CSA rules, which are described in section
7173 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7174 not sufficient because of the extra parent domain search behaviour of CSA. The
7175 result of a successful lookup such as:
7176 .code
7177 ${lookup dnsdb {csa=$sender_helo_name}}
7178 .endd
7179 has two space-separated fields: an authorization code and a target host name.
7180 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7181 authorization required but absent, or &"?"& for unknown.
7182
7183 .cindex "A+" "in &(dnsdb)& lookup"
7184 The pseudo-type A+ performs an AAAA
7185 and then an A lookup.  All results are returned; defer processing
7186 (see below) is handled separately for each lookup.  Example:
7187 .code
7188 ${lookup dnsdb {>; a+=$sender_helo_name}}
7189 .endd
7190
7191
7192 .section "Multiple dnsdb lookups" "SECID67"
7193 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7194 However, you can specify a list of domains or IP addresses in a single
7195 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7196 the default separator, but with the ability to change this. For example:
7197 .code
7198 ${lookup dnsdb{one.domain.com:two.domain.com}}
7199 ${lookup dnsdb{a=one.host.com:two.host.com}}
7200 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7201 .endd
7202 In order to retain backwards compatibility, there is one special case: if
7203 the lookup type is PTR and no change of separator is specified, Exim looks
7204 to see if the rest of the string is precisely one IPv6 address. In this
7205 case, it does not treat it as a list.
7206
7207 The data from each lookup is concatenated, with newline separators by default,
7208 in the same way that multiple DNS records for a single item are handled. A
7209 different separator can be specified, as described above.
7210
7211
7212
7213
7214 .section "More about LDAP" "SECTldap"
7215 .cindex "LDAP" "lookup, more about"
7216 .cindex "lookup" "LDAP"
7217 .cindex "Solaris" "LDAP"
7218 The original LDAP implementation came from the University of Michigan; this has
7219 become &"Open LDAP"&, and there are now two different releases. Another
7220 implementation comes from Netscape, and Solaris 7 and subsequent releases
7221 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7222 the lookup function level, their error handling is different. For this reason
7223 it is necessary to set a compile-time variable when building Exim with LDAP, to
7224 indicate which LDAP library is in use. One of the following should appear in
7225 your &_Local/Makefile_&:
7226 .code
7227 LDAP_LIB_TYPE=UMICHIGAN
7228 LDAP_LIB_TYPE=OPENLDAP1
7229 LDAP_LIB_TYPE=OPENLDAP2
7230 LDAP_LIB_TYPE=NETSCAPE
7231 LDAP_LIB_TYPE=SOLARIS
7232 .endd
7233 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7234 same interface as the University of Michigan version.
7235
7236 There are three LDAP lookup types in Exim. These behave slightly differently in
7237 the way they handle the results of a query:
7238
7239 .ilist
7240 &(ldap)& requires the result to contain just one entry; if there are more, it
7241 gives an error.
7242 .next
7243 &(ldapdn)& also requires the result to contain just one entry, but it is the
7244 Distinguished Name that is returned rather than any attribute values.
7245 .next
7246 &(ldapm)& permits the result to contain more than one entry; the attributes
7247 from all of them are returned.
7248 .endlist
7249
7250
7251 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7252 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7253 the data returned by a successful lookup is described in the next section.
7254 First we explain how LDAP queries are coded.
7255
7256
7257 .section "Format of LDAP queries" "SECTforldaque"
7258 .cindex "LDAP" "query format"
7259 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7260 the configuration of a &(redirect)& router one might have this setting:
7261 .code
7262 data = ${lookup ldap \
7263   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7264   c=UK?mailbox?base?}}
7265 .endd
7266 .cindex "LDAP" "with TLS"
7267 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7268 secure (encrypted) LDAP connections. The second of these ensures that an
7269 encrypted TLS connection is used.
7270
7271 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7272 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7273 See the &%ldap_start_tls%& option.
7274
7275 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7276 controlled. Every part of the TLS configuration can be configured by settings in
7277 &_exim.conf_&. Depending on the version of the client libraries installed on
7278 your system, some of the initialization may have required setting options in
7279 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7280 certificates. This revealed a nuance where the current UID that exim was
7281 running as could affect which config files it read. With Exim 4.83, these
7282 methods become optional, only taking effect if not specifically set in
7283 &_exim.conf_&.
7284
7285
7286 .section "LDAP quoting" "SECID68"
7287 .cindex "LDAP" "quoting"
7288 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7289 and the second because the LDAP query is represented as a URL. Furthermore,
7290 within an LDAP query, two different kinds of quoting are required. For this
7291 reason, there are two different LDAP-specific quoting operators.
7292
7293 The &%quote_ldap%& operator is designed for use on strings that are part of
7294 filter specifications. Conceptually, it first does the following conversions on
7295 the string:
7296 .code
7297 *   =>   \2A
7298 (   =>   \28
7299 )   =>   \29
7300 \   =>   \5C
7301 .endd
7302 in accordance with RFC 2254. The resulting string is then quoted according
7303 to the rules for URLs, that is, all non-alphanumeric characters except
7304 .code
7305 ! $ ' - . _ ( ) * +
7306 .endd
7307 are converted to their hex values, preceded by a percent sign. For example:
7308 .code
7309 ${quote_ldap: a(bc)*, a<yz>; }
7310 .endd
7311 yields
7312 .code
7313 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7314 .endd
7315 Removing the URL quoting, this is (with a leading and a trailing space):
7316 .code
7317 a\28bc\29\2A, a<yz>;
7318 .endd
7319 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7320 base DN specifications in queries. Conceptually, it first converts the string
7321 by inserting a backslash in front of any of the following characters:
7322 .code
7323 , + " \ < > ;
7324 .endd
7325 It also inserts a backslash before any leading spaces or # characters, and
7326 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7327 is then quoted according to the rules for URLs. For example:
7328 .code
7329 ${quote_ldap_dn: a(bc)*, a<yz>; }
7330 .endd
7331 yields
7332 .code
7333 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7334 .endd
7335 Removing the URL quoting, this is (with a trailing space):
7336 .code
7337 \ a(bc)*\, a\<yz\>\;\
7338 .endd
7339 There are some further comments about quoting in the section on LDAP
7340 authentication below.
7341
7342
7343 .section "LDAP connections" "SECID69"
7344 .cindex "LDAP" "connections"
7345 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7346 is in use, via a Unix domain socket. The example given above does not specify
7347 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7348 by starting it with
7349 .code
7350 ldap://<hostname>:<port>/...
7351 .endd
7352 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7353 used. When no server is specified in a query, a list of default servers is
7354 taken from the &%ldap_default_servers%& configuration option. This supplies a
7355 colon-separated list of servers which are tried in turn until one successfully
7356 handles a query, or there is a serious error. Successful handling either
7357 returns the requested data, or indicates that it does not exist. Serious errors
7358 are syntactical, or multiple values when only a single value is expected.
7359 Errors which cause the next server to be tried are connection failures, bind
7360 failures, and timeouts.
7361
7362 For each server name in the list, a port number can be given. The standard way
7363 of specifying a host and port is to use a colon separator (RFC 1738). Because
7364 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7365 doubled. For example
7366 .code
7367 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7368 .endd
7369 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7370 to the LDAP library with no server name, and the library's default (normally
7371 the local host) is used.
7372
7373 If you are using the OpenLDAP library, you can connect to an LDAP server using
7374 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7375 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7376 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7377 not available.
7378
7379 For this type of connection, instead of a host name for the server, a pathname
7380 for the socket is required, and the port number is not relevant. The pathname
7381 can be specified either as an item in &%ldap_default_servers%&, or inline in
7382 the query. In the former case, you can have settings such as
7383 .code
7384 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7385 .endd
7386 When the pathname is given in the query, you have to escape the slashes as
7387 &`%2F`& to fit in with the LDAP URL syntax. For example:
7388 .code
7389 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7390 .endd
7391 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7392 a pathname, it uses the Unix domain socket code, even if the query actually
7393 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7394 socket connection. This behaviour means that you can use a setting of
7395 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7396 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7397 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7398 backup host.
7399
7400 If an explicit &`ldapi`& type is given in a query when a host name is
7401 specified, an error is diagnosed. However, if there are more items in
7402 &%ldap_default_servers%&, they are tried. In other words:
7403
7404 .ilist
7405 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7406 interface.
7407 .next
7408 Using &`ldapi`& with a host name causes an error.
7409 .endlist
7410
7411
7412 Using &`ldapi`& with no host or path in the query, and no setting of
7413 &%ldap_default_servers%&, does whatever the library does by default.
7414
7415
7416
7417 .section "LDAP authentication and control information" "SECID70"
7418 .cindex "LDAP" "authentication"
7419 The LDAP URL syntax provides no way of passing authentication and other control
7420 information to the server. To make this possible, the URL in an LDAP query may
7421 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7422 spaces. If a value contains spaces it must be enclosed in double quotes, and
7423 when double quotes are used, backslash is interpreted in the usual way inside
7424 them. The following names are recognized:
7425 .display
7426 &`DEREFERENCE`&  set the dereferencing parameter
7427 &`NETTIME    `&  set a timeout for a network operation
7428 &`USER       `&  set the DN, for authenticating the LDAP bind
7429 &`PASS       `&  set the password, likewise
7430 &`REFERRALS  `&  set the referrals parameter
7431 &`SERVERS    `&  set alternate server list for this query only
7432 &`SIZE       `&  set the limit for the number of entries returned
7433 &`TIME       `&  set the maximum waiting time for a query
7434 .endd
7435 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7436 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7437 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7438 library from trying to follow referrals issued by the LDAP server.
7439
7440 .cindex LDAP timeout
7441 .cindex timeout "LDAP lookup"
7442 The name CONNECT is an obsolete name for NETTIME, retained for
7443 backwards compatibility. This timeout (specified as a number of seconds) is
7444 enforced from the client end for operations that can be carried out over a
7445 network. Specifically, it applies to network connections and calls to the
7446 &'ldap_result()'& function. If the value is greater than zero, it is used if
7447 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7448 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7449 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7450 Netscape SDK; for OpenLDAP no action is taken.
7451
7452 The TIME parameter (also a number of seconds) is passed to the server to
7453 set a server-side limit on the time taken to complete a search.
7454
7455 The SERVERS parameter allows you to specify an alternate list of ldap servers
7456 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7457 default list of ldap servers, and a single lookup can specify a single ldap
7458 server to use.  But when you need to do a lookup with a list of servers that is
7459 different than the default list (maybe different order, maybe a completely
7460 different set of servers), the SERVERS parameter allows you to specify this
7461 alternate list (colon-separated).
7462
7463 Here is an example of an LDAP query in an Exim lookup that uses some of these
7464 values. This is a single line, folded to fit on the page:
7465 .code
7466 ${lookup ldap
7467   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7468   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7469   {$value}fail}
7470 .endd
7471 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7472 any of the auxiliary data. Exim configuration settings that include lookups
7473 which contain password information should be preceded by &"hide"& to prevent
7474 non-admin users from using the &%-bP%& option to see their values.
7475
7476 The auxiliary data items may be given in any order. The default is no
7477 connection timeout (the system timeout is used), no user or password, no limit
7478 on the number of entries returned, and no time limit on queries.
7479
7480 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7481 removes any URL quoting that it may contain before passing it LDAP. Apparently
7482 some libraries do this for themselves, but some do not. Removing the URL
7483 quoting has two advantages:
7484
7485 .ilist
7486 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7487 DNs as with DNs inside actual queries.
7488 .next
7489 It permits spaces inside USER= DNs.
7490 .endlist
7491
7492 For example, a setting such as
7493 .code
7494 USER=cn=${quote_ldap_dn:$1}
7495 .endd
7496 should work even if &$1$& contains spaces.
7497
7498 Expanded data for the PASS= value should be quoted using the &%quote%&
7499 expansion operator, rather than the LDAP quote operators. The only reason this
7500 field needs quoting is to ensure that it conforms to the Exim syntax, which
7501 does not allow unquoted spaces. For example:
7502 .code
7503 PASS=${quote:$3}
7504 .endd
7505 The LDAP authentication mechanism can be used to check passwords as part of
7506 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7507 &<<CHAPexpand>>&.
7508
7509
7510
7511 .section "Format of data returned by LDAP" "SECID71"
7512 .cindex "LDAP" "returned data formats"
7513 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7514 as a sequence of values, for example
7515 .code
7516 cn=manager,o=University of Cambridge,c=UK
7517 .endd
7518 The &(ldap)& lookup type generates an error if more than one entry matches the
7519 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7520 the result between the data from different entries. It is possible for multiple
7521 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7522 you know that whatever values are returned all came from a single entry in the
7523 directory.
7524
7525 In the common case where you specify a single attribute in your LDAP query, the
7526 result is not quoted, and does not contain the attribute name. If the attribute
7527 has multiple values, they are separated by commas. Any comma that is
7528 part of an attribute's value is doubled.
7529
7530 If you specify multiple attributes, the result contains space-separated, quoted
7531 strings, each preceded by the attribute name and an equals sign. Within the
7532 quotes, the quote character, backslash, and newline are escaped with
7533 backslashes, and commas are used to separate multiple values for the attribute.
7534 Any commas in attribute values are doubled
7535 (permitting treatment of the values as a comma-separated list).
7536 Apart from the escaping, the string within quotes takes the same form as the
7537 output when a single attribute is requested. Specifying no attributes is the
7538 same as specifying all of an entry's attributes.
7539
7540 Here are some examples of the output format. The first line of each pair is an
7541 LDAP query, and the second is the data that is returned. The attribute called
7542 &%attr1%& has two values, one of them with an embedded comma, whereas
7543 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7544 (they have SUP &%attr%& in their schema definitions).
7545
7546 .code
7547 ldap:///o=base?attr1?sub?(uid=fred)
7548 value1.1,value1,,2
7549
7550 ldap:///o=base?attr2?sub?(uid=fred)
7551 value two
7552
7553 ldap:///o=base?attr?sub?(uid=fred)
7554 value1.1,value1,,2,value two
7555
7556 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7557 attr1="value1.1,value1,,2" attr2="value two"
7558
7559 ldap:///o=base??sub?(uid=fred)
7560 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7561 .endd
7562 You can
7563 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7564 results of LDAP lookups.
7565 The &%extract%& operator in string expansions can be used to pick out
7566 individual fields from data that consists of &'key'&=&'value'& pairs.
7567 The &%listextract%& operator should be used to pick out individual values
7568 of attributes, even when only a single value is expected.
7569 The doubling of embedded commas allows you to use the returned data as a
7570 comma separated list (using the "<," syntax for changing the input list separator).
7571
7572
7573
7574
7575 .section "More about NIS+" "SECTnisplus"
7576 .cindex "NIS+ lookup type"
7577 .cindex "lookup" "NIS+"
7578 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7579 and field name. If this is given, the result of a successful query is the
7580 contents of the named field; otherwise the result consists of a concatenation
7581 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7582 values containing spaces are quoted. For example, the query
7583 .code
7584 [name=mg1456],passwd.org_dir
7585 .endd
7586 might return the string
7587 .code
7588 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7589 home=/home/mg1456 shell=/bin/bash shadow=""
7590 .endd
7591 (split over two lines here to fit on the page), whereas
7592 .code
7593 [name=mg1456],passwd.org_dir:gcos
7594 .endd
7595 would just return
7596 .code
7597 Martin Guerre
7598 .endd
7599 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7600 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7601 operator is to double any quote characters within the text.
7602
7603
7604
7605 .section "SQL lookups" "SECTsql"
7606 .cindex "SQL lookup types"
7607 .cindex "MySQL" "lookup type"
7608 .cindex "PostgreSQL lookup type"
7609 .cindex "lookup" "MySQL"
7610 .cindex "lookup" "PostgreSQL"
7611 .cindex "Oracle" "lookup type"
7612 .cindex "lookup" "Oracle"
7613 .cindex "InterBase lookup type"
7614 .cindex "lookup" "InterBase"
7615 .cindex "Redis lookup type"
7616 .cindex lookup Redis
7617 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7618 and SQLite
7619 databases. Queries for these databases contain SQL statements, so an example
7620 might be
7621 .code
7622 ${lookup mysql{select mailbox from users where id='userx'}\
7623   {$value}fail}
7624 .endd
7625 If the result of the query contains more than one field, the data for each
7626 field in the row is returned, preceded by its name, so the result of
7627 .code
7628 ${lookup pgsql{select home,name from users where id='userx'}\
7629   {$value}}
7630 .endd
7631 might be
7632 .code
7633 home=/home/userx name="Mister X"
7634 .endd
7635 Empty values and values containing spaces are double quoted, with embedded
7636 quotes escaped by a backslash. If the result of the query contains just one
7637 field, the value is passed back verbatim, without a field name, for example:
7638 .code
7639 Mister X
7640 .endd
7641 If the result of the query yields more than one row, it is all concatenated,
7642 with a newline between the data for each row.
7643
7644
7645 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7646 .cindex "MySQL" "lookup type"
7647 .cindex "PostgreSQL lookup type"
7648 .cindex "lookup" "MySQL"
7649 .cindex "lookup" "PostgreSQL"
7650 .cindex "Oracle" "lookup type"
7651 .cindex "lookup" "Oracle"
7652 .cindex "InterBase lookup type"
7653 .cindex "lookup" "InterBase"
7654 .cindex "Redis lookup type"
7655 .cindex lookup Redis
7656 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7657 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7658 or &%redis_servers%&
7659 option (as appropriate) must be set to a colon-separated list of server
7660 information.
7661 (For MySQL and PostgreSQL, the global option need not be set if all
7662 queries contain their own server information &-- see section
7663 &<<SECTspeserque>>&.)
7664 For all but Redis
7665 each item in the list is a slash-separated list of four
7666 items: host name, database name, user name, and password. In the case of
7667 Oracle, the host name field is used for the &"service name"&, and the database
7668 name field is not used and should be empty. For example:
7669 .code
7670 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7671 .endd
7672 Because password data is sensitive, you should always precede the setting with
7673 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7674 option. Here is an example where two MySQL servers are listed:
7675 .code
7676 hide mysql_servers = localhost/users/root/secret:\
7677                      otherhost/users/root/othersecret
7678 .endd
7679 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7680 because this is a colon-separated list, the colon has to be doubled. For each
7681 query, these parameter groups are tried in order until a connection is made and
7682 a query is successfully processed. The result of a query may be that no data is
7683 found, but that is still a successful query. In other words, the list of
7684 servers provides a backup facility, not a list of different places to look.
7685
7686 For Redis the global option need not be specified if all queries contain their
7687 own server information &-- see section &<<SECTspeserque>>&.
7688 If specified, the option must be set to a colon-separated list of server
7689 information.
7690 Each item in the list is a slash-separated list of three items:
7691 host, database number, and password.
7692 .olist
7693 The host is required and may be either an IPv4 address and optional
7694 port number (separated by a colon, which needs doubling due to the
7695 higher-level list), or a Unix socket pathname enclosed in parentheses
7696 .next
7697 The database number is optional; if present that number is selected in the backend
7698 .next
7699 The password is optional; if present it is used to authenticate to the backend
7700 .endlist
7701
7702 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7703 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7704 respectively, and the characters single-quote, double-quote, and backslash
7705 itself are escaped with backslashes.
7706
7707 The &%quote_redis%& expansion operator
7708 escapes whitespace and backslash characters with a backslash.
7709
7710 .section "Specifying the server in the query" "SECTspeserque"
7711 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7712 it is possible to specify a list of servers with an individual query. This is
7713 done by starting the query with
7714 .display
7715 &`servers=`&&'server1:server2:server3:...'&&`;`&
7716 .endd
7717 Each item in the list may take one of two forms:
7718 .olist
7719 If it contains no slashes it is assumed to be just a host name. The appropriate
7720 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7721 of the same name, and the remaining parameters (database, user, password) are
7722 taken from there.
7723 .next
7724 If it contains any slashes, it is taken as a complete parameter set.
7725 .endlist
7726 The list of servers is used in exactly the same way as the global list.
7727 Once a connection to a server has happened and a query has been
7728 successfully executed, processing of the lookup ceases.
7729
7730 This feature is intended for use in master/slave situations where updates
7731 are occurring and you want to update the master rather than a slave. If the
7732 master is in the list as a backup for reading, you might have a global setting
7733 like this:
7734 .code
7735 mysql_servers = slave1/db/name/pw:\
7736                 slave2/db/name/pw:\
7737                 master/db/name/pw
7738 .endd
7739 In an updating lookup, you could then write:
7740 .code
7741 ${lookup mysql{servers=master; UPDATE ...} }
7742 .endd
7743 That query would then be sent only to the master server. If, on the other hand,
7744 the master is not to be used for reading, and so is not present in the global
7745 option, you can still update it by a query of this form:
7746 .code
7747 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7748 .endd
7749
7750
7751 .section "Special MySQL features" "SECID73"
7752 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7753 causes a connection to the server on the local host by means of a Unix domain
7754 socket. An alternate socket can be specified in parentheses.
7755 An option group name for MySQL option files can be specified in square brackets;
7756 the default value is &"exim"&.
7757 The full syntax of each item in &%mysql_servers%& is:
7758 .display
7759 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7760   <&'database'&>/<&'user'&>/<&'password'&>
7761 .endd
7762 Any of the four sub-parts of the first field can be omitted. For normal use on
7763 the local host it can be left blank or set to just &"localhost"&.
7764
7765 No database need be supplied &-- but if it is absent here, it must be given in
7766 the queries.
7767
7768 If a MySQL query is issued that does not request any data (an insert, update,
7769 or delete command), the result of the lookup is the number of rows affected.
7770
7771 &*Warning*&: This can be misleading. If an update does not actually change
7772 anything (for example, setting a field to the value it already has), the result
7773 is zero because no rows are affected.
7774
7775
7776 .section "Special PostgreSQL features" "SECID74"
7777 PostgreSQL lookups can also use Unix domain socket connections to the database.
7778 This is usually faster and costs less CPU time than a TCP/IP connection.
7779 However it can be used only if the mail server runs on the same machine as the
7780 database server. A configuration line for PostgreSQL via Unix domain sockets
7781 looks like this:
7782 .code
7783 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7784 .endd
7785 In other words, instead of supplying a host name, a path to the socket is
7786 given. The path name is enclosed in parentheses so that its slashes aren't
7787 visually confused with the delimiters for the other server parameters.
7788
7789 If a PostgreSQL query is issued that does not request any data (an insert,
7790 update, or delete command), the result of the lookup is the number of rows
7791 affected.
7792
7793 .section "More about SQLite" "SECTsqlite"
7794 .cindex "lookup" "SQLite"
7795 .cindex "sqlite lookup type"
7796 SQLite is different to the other SQL lookups because a file name is required in
7797 addition to the SQL query. An SQLite database is a single file, and there is no
7798 daemon as in the other SQL databases. The interface to Exim requires the name
7799 of the file, as an absolute path, to be given at the start of the query. It is
7800 separated from the query by white space. This means that the path name cannot
7801 contain white space. Here is a lookup expansion example:
7802 .code
7803 ${lookup sqlite {/some/thing/sqlitedb \
7804   select name from aliases where id='userx';}}
7805 .endd
7806 In a list, the syntax is similar. For example:
7807 .code
7808 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7809    select * from relays where ip='$sender_host_address';
7810 .endd
7811 The only character affected by the &%quote_sqlite%& operator is a single
7812 quote, which it doubles.
7813
7814 .cindex timeout SQLite
7815 .cindex sqlite "lookup timeout"
7816 The SQLite library handles multiple simultaneous accesses to the database
7817 internally. Multiple readers are permitted, but only one process can
7818 update at once. Attempts to access the database while it is being updated
7819 are rejected after a timeout period, during which the SQLite library
7820 waits for the lock to be released. In Exim, the default timeout is set
7821 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7822 option.
7823
7824 .section "More about Redis" "SECTredis"
7825 .cindex "lookup" "Redis"
7826 .cindex "redis lookup type"
7827 Redis is a non-SQL database. Commands are simple get and set.
7828 Examples:
7829 .code
7830 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
7831 ${lookup redis{get keyname}}
7832 .endd
7833
7834 .ecindex IIDfidalo1
7835 .ecindex IIDfidalo2
7836
7837
7838 . ////////////////////////////////////////////////////////////////////////////
7839 . ////////////////////////////////////////////////////////////////////////////
7840
7841 .chapter "Domain, host, address, and local part lists" &&&
7842          "CHAPdomhosaddlists" &&&
7843          "Domain, host, and address lists"
7844 .scindex IIDdohoadli "lists of domains; hosts; etc."
7845 A number of Exim configuration options contain lists of domains, hosts,
7846 email addresses, or local parts. For example, the &%hold_domains%& option
7847 contains a list of domains whose delivery is currently suspended. These lists
7848 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7849 arguments to expansion conditions such as &%match_domain%&.
7850
7851 Each item in one of these lists is a pattern to be matched against a domain,
7852 host, email address, or local part, respectively. In the sections below, the
7853 different types of pattern for each case are described, but first we cover some
7854 general facilities that apply to all four kinds of list.
7855
7856 Note that other parts of Exim use a &'string list'& which does not
7857 support all the complexity available in
7858 domain, host, address and local part lists.
7859
7860
7861
7862 .section "Expansion of lists" "SECTlistexpand"
7863 .cindex "expansion" "of lists"
7864 Each list is expanded as a single string before it is used.
7865
7866 &'Exception: the router headers_remove option, where list-item
7867 splitting is done before string-expansion.'&
7868
7869 The result of
7870 expansion must be a list, possibly containing empty items, which is split up
7871 into separate items for matching. By default, colon is the separator character,
7872 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7873 &<<SECTempitelis>>& for details of the list syntax; the second of these
7874 discusses the way to specify empty list items.
7875
7876
7877 If the string expansion is forced to fail, Exim behaves as if the item it is
7878 testing (domain, host, address, or local part) is not in the list. Other
7879 expansion failures cause temporary errors.
7880
7881 If an item in a list is a regular expression, backslashes, dollars and possibly
7882 other special characters in the expression must be protected against
7883 misinterpretation by the string expander. The easiest way to do this is to use
7884 the &`\N`& expansion feature to indicate that the contents of the regular
7885 expression should not be expanded. For example, in an ACL you might have:
7886 .code
7887 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7888                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7889 .endd
7890 The first item is a regular expression that is protected from expansion by
7891 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7892 senders based on the receiving domain.
7893
7894
7895
7896
7897 .section "Negated items in lists" "SECID76"
7898 .cindex "list" "negation"
7899 .cindex "negation" "in lists"
7900 Items in a list may be positive or negative. Negative items are indicated by a
7901 leading exclamation mark, which may be followed by optional white space. A list
7902 defines a set of items (domains, etc). When Exim processes one of these lists,
7903 it is trying to find out whether a domain, host, address, or local part
7904 (respectively) is in the set that is defined by the list. It works like this:
7905
7906 The list is scanned from left to right. If a positive item is matched, the
7907 subject that is being checked is in the set; if a negative item is matched, the
7908 subject is not in the set. If the end of the list is reached without the
7909 subject having matched any of the patterns, it is in the set if the last item
7910 was a negative one, but not if it was a positive one. For example, the list in
7911 .code
7912 domainlist relay_to_domains = !a.b.c : *.b.c
7913 .endd
7914 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7915 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7916 list is positive. However, if the setting were
7917 .code
7918 domainlist relay_to_domains = !a.b.c
7919 .endd
7920 then all domains other than &'a.b.c'& would match because the last item in the
7921 list is negative. In other words, a list that ends with a negative item behaves
7922 as if it had an extra item &`:*`& on the end.
7923
7924 Another way of thinking about positive and negative items in lists is to read
7925 the connector as &"or"& after a positive item and as &"and"& after a negative
7926 item.
7927
7928
7929
7930 .section "File names in lists" "SECTfilnamlis"
7931 .cindex "list" "file name in"
7932 If an item in a domain, host, address, or local part list is an absolute file
7933 name (beginning with a slash character), each line of the file is read and
7934 processed as if it were an independent item in the list, except that further
7935 file names are not allowed,
7936 and no expansion of the data from the file takes place.
7937 Empty lines in the file are ignored, and the file may also contain comment
7938 lines:
7939
7940 .ilist
7941 For domain and host lists, if a # character appears anywhere in a line of the
7942 file, it and all following characters are ignored.
7943 .next
7944 Because local parts may legitimately contain # characters, a comment in an
7945 address list or local part list file is recognized only if # is preceded by
7946 white space or the start of the line. For example:
7947 .code
7948 not#comment@x.y.z   # but this is a comment
7949 .endd
7950 .endlist
7951
7952 Putting a file name in a list has the same effect as inserting each line of the
7953 file as an item in the list (blank lines and comments excepted). However, there
7954 is one important difference: the file is read each time the list is processed,
7955 so if its contents vary over time, Exim's behaviour changes.
7956
7957 If a file name is preceded by an exclamation mark, the sense of any match
7958 within the file is inverted. For example, if
7959 .code
7960 hold_domains = !/etc/nohold-domains
7961 .endd
7962 and the file contains the lines
7963 .code
7964 !a.b.c
7965 *.b.c
7966 .endd
7967 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7968 any domain matching &`*.b.c`& is not.
7969
7970
7971
7972 .section "An lsearch file is not an out-of-line list" "SECID77"
7973 As will be described in the sections that follow, lookups can be used in lists
7974 to provide indexed methods of checking list membership. There has been some
7975 confusion about the way &(lsearch)& lookups work in lists. Because
7976 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7977 sometimes thought that it is allowed to contain wild cards and other kinds of
7978 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7979 always fixed strings, just as for any other single-key lookup type.
7980
7981 If you want to use a file to contain wild-card patterns that form part of a
7982 list, just give the file name on its own, without a search type, as described
7983 in the previous section. You could also use the &(wildlsearch)& or
7984 &(nwildlsearch)&, but there is no advantage in doing this.
7985
7986
7987
7988
7989 .section "Named lists" "SECTnamedlists"
7990 .cindex "named lists"
7991 .cindex "list" "named"
7992 A list of domains, hosts, email addresses, or local parts can be given a name
7993 which is then used to refer to the list elsewhere in the configuration. This is
7994 particularly convenient if the same list is required in several different
7995 places. It also allows lists to be given meaningful names, which can improve
7996 the readability of the configuration. For example, it is conventional to define
7997 a domain list called &'local_domains'& for all the domains that are handled
7998 locally on a host, using a configuration line such as
7999 .code
8000 domainlist local_domains = localhost:my.dom.example
8001 .endd
8002 Named lists are referenced by giving their name preceded by a plus sign, so,
8003 for example, a router that is intended to handle local domains would be
8004 configured with the line
8005 .code
8006 domains = +local_domains
8007 .endd
8008 The first router in a configuration is often one that handles all domains
8009 except the local ones, using a configuration with a negated item like this:
8010 .code
8011 dnslookup:
8012   driver = dnslookup
8013   domains = ! +local_domains
8014   transport = remote_smtp
8015   no_more
8016 .endd
8017 The four kinds of named list are created by configuration lines starting with
8018 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8019 respectively. Then there follows the name that you are defining, followed by an
8020 equals sign and the list itself. For example:
8021 .code
8022 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8023 addresslist bad_senders = cdb;/etc/badsenders
8024 .endd
8025 A named list may refer to other named lists:
8026 .code
8027 domainlist  dom1 = first.example : second.example
8028 domainlist  dom2 = +dom1 : third.example
8029 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8030 .endd
8031 &*Warning*&: If the last item in a referenced list is a negative one, the
8032 effect may not be what you intended, because the negation does not propagate
8033 out to the higher level. For example, consider:
8034 .code
8035 domainlist  dom1 = !a.b
8036 domainlist  dom2 = +dom1 : *.b
8037 .endd
8038 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8039 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8040 means it matches the second list as well. The effect is not the same as
8041 .code
8042 domainlist  dom2 = !a.b : *.b
8043 .endd
8044 where &'x.y'& does not match. It's best to avoid negation altogether in
8045 referenced lists if you can.
8046
8047 Named lists may have a performance advantage. When Exim is routing an
8048 address or checking an incoming message, it caches the result of tests on named
8049 lists. So, if you have a setting such as
8050 .code
8051 domains = +local_domains
8052 .endd
8053 on several of your routers
8054 or in several ACL statements,
8055 the actual test is done only for the first one. However, the caching works only
8056 if there are no expansions within the list itself or any sublists that it
8057 references. In other words, caching happens only for lists that are known to be
8058 the same each time they are referenced.
8059
8060 By default, there may be up to 16 named lists of each type. This limit can be
8061 extended by changing a compile-time variable. The use of domain and host lists
8062 is recommended for concepts such as local domains, relay domains, and relay
8063 hosts. The default configuration is set up like this.
8064
8065
8066
8067 .section "Named lists compared with macros" "SECID78"
8068 .cindex "list" "named compared with macro"
8069 .cindex "macro" "compared with named list"
8070 At first sight, named lists might seem to be no different from macros in the
8071 configuration file. However, macros are just textual substitutions. If you
8072 write
8073 .code
8074 ALIST = host1 : host2
8075 auth_advertise_hosts = !ALIST
8076 .endd
8077 it probably won't do what you want, because that is exactly the same as
8078 .code
8079 auth_advertise_hosts = !host1 : host2
8080 .endd
8081 Notice that the second host name is not negated. However, if you use a host
8082 list, and write
8083 .code
8084 hostlist alist = host1 : host2
8085 auth_advertise_hosts = ! +alist
8086 .endd
8087 the negation applies to the whole list, and so that is equivalent to
8088 .code
8089 auth_advertise_hosts = !host1 : !host2
8090 .endd
8091
8092
8093 .section "Named list caching" "SECID79"
8094 .cindex "list" "caching of named"
8095 .cindex "caching" "named lists"
8096 While processing a message, Exim caches the result of checking a named list if
8097 it is sure that the list is the same each time. In practice, this means that
8098 the cache operates only if the list contains no $ characters, which guarantees
8099 that it will not change when it is expanded. Sometimes, however, you may have
8100 an expanded list that you know will be the same each time within a given
8101 message. For example:
8102 .code
8103 domainlist special_domains = \
8104            ${lookup{$sender_host_address}cdb{/some/file}}
8105 .endd
8106 This provides a list of domains that depends only on the sending host's IP
8107 address. If this domain list is referenced a number of times (for example,
8108 in several ACL lines, or in several routers) the result of the check is not
8109 cached by default, because Exim does not know that it is going to be the
8110 same list each time.
8111
8112 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8113 cache the result anyway. For example:
8114 .code
8115 domainlist_cache special_domains = ${lookup{...
8116 .endd
8117 If you do this, you should be absolutely sure that caching is going to do
8118 the right thing in all cases. When in doubt, leave it out.
8119
8120
8121
8122 .section "Domain lists" "SECTdomainlist"
8123 .cindex "domain list" "patterns for"
8124 .cindex "list" "domain list"
8125 Domain lists contain patterns that are to be matched against a mail domain.
8126 The following types of item may appear in domain lists:
8127
8128 .ilist
8129 .cindex "primary host name"
8130 .cindex "host name" "matched in domain list"
8131 .oindex "&%primary_hostname%&"
8132 .cindex "domain list" "matching primary host name"
8133 .cindex "@ in a domain list"
8134 If a pattern consists of a single @ character, it matches the local host name,
8135 as set by the &%primary_hostname%& option (or defaulted). This makes it
8136 possible to use the same configuration file on several different hosts that
8137 differ only in their names.
8138 .next
8139 .cindex "@[] in a domain list"
8140 .cindex "domain list" "matching local IP interfaces"
8141 .cindex "domain literal"
8142 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8143 in square brackets (as in an email address that contains a domain literal), but
8144 only if that IP address is recognized as local for email routing purposes. The
8145 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8146 control which of a host's several IP addresses are treated as local.
8147 In today's Internet, the use of domain literals is controversial.
8148 .next
8149 .cindex "@mx_any"
8150 .cindex "@mx_primary"
8151 .cindex "@mx_secondary"
8152 .cindex "domain list" "matching MX pointers to local host"
8153 If a pattern consists of the string &`@mx_any`& it matches any domain that
8154 has an MX record pointing to the local host or to any host that is listed in
8155 .oindex "&%hosts_treat_as_local%&"
8156 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8157 are similar, except that the first matches only when a primary MX target is the
8158 local host, and the second only when no primary MX target is the local host,
8159 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8160 preference value &-- there may of course be more than one of them.
8161
8162 The MX lookup that takes place when matching a pattern of this type is
8163 performed with the resolver options for widening names turned off. Thus, for
8164 example, a single-component domain will &'not'& be expanded by adding the
8165 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8166 options of the &(dnslookup)& router for a discussion of domain widening.
8167
8168 Sometimes you may want to ignore certain IP addresses when using one of these
8169 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8170 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8171 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8172 on a router). For example:
8173 .code
8174 domains = @mx_any/ignore=127.0.0.1
8175 .endd
8176 This example matches any domain that has an MX record pointing to one of
8177 the local host's IP addresses other than 127.0.0.1.
8178
8179 The list of IP addresses is in fact processed by the same code that processes
8180 host lists, so it may contain CIDR-coded network specifications and it may also
8181 contain negative items.
8182
8183 Because the list of IP addresses is a sublist within a domain list, you have to
8184 be careful about delimiters if there is more than one address. Like any other
8185 list, the default delimiter can be changed. Thus, you might have:
8186 .code
8187 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8188           an.other.domain : ...
8189 .endd
8190 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8191 involved, it is easiest to change the delimiter for the main list as well:
8192 .code
8193 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8194           an.other.domain ? ...
8195 .endd
8196 .next
8197 .cindex "asterisk" "in domain list"
8198 .cindex "domain list" "asterisk in"
8199 .cindex "domain list" "matching &""ends with""&"
8200 If a pattern starts with an asterisk, the remaining characters of the pattern
8201 are compared with the terminating characters of the domain. The use of &"*"& in
8202 domain lists differs from its use in partial matching lookups. In a domain
8203 list, the character following the asterisk need not be a dot, whereas partial
8204 matching works only in terms of dot-separated components. For example, a domain
8205 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8206 &'cipher.key.ex'&.
8207
8208 .next
8209 .cindex "regular expressions" "in domain list"
8210 .cindex "domain list" "matching regular expression"
8211 If a pattern starts with a circumflex character, it is treated as a regular
8212 expression, and matched against the domain using a regular expression matching
8213 function. The circumflex is treated as part of the regular expression.
8214 Email domains are case-independent, so this regular expression match is by
8215 default case-independent, but you can make it case-dependent by starting it
8216 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8217 are given in chapter &<<CHAPregexp>>&.
8218
8219 &*Warning*&: Because domain lists are expanded before being processed, you
8220 must escape any backslash and dollar characters in the regular expression, or
8221 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8222 it is not to be expanded (unless you really do want to build a regular
8223 expression by expansion, of course).
8224 .next
8225 .cindex "lookup" "in domain list"
8226 .cindex "domain list" "matching by lookup"
8227 If a pattern starts with the name of a single-key lookup type followed by a
8228 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8229 must be a file name in a suitable format for the lookup type. For example, for
8230 &"cdb;"& it must be an absolute path:
8231 .code
8232 domains = cdb;/etc/mail/local_domains.cdb
8233 .endd
8234 The appropriate type of lookup is done on the file using the domain name as the
8235 key. In most cases, the data that is looked up is not used; Exim is interested
8236 only in whether or not the key is present in the file. However, when a lookup
8237 is used for the &%domains%& option on a router
8238 or a &%domains%& condition in an ACL statement, the data is preserved in the
8239 &$domain_data$& variable and can be referred to in other router options or
8240 other statements in the same ACL.
8241
8242 .next
8243 Any of the single-key lookup type names may be preceded by
8244 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8245 .code
8246 domains = partial-dbm;/partial/domains
8247 .endd
8248 This causes partial matching logic to be invoked; a description of how this
8249 works is given in section &<<SECTpartiallookup>>&.
8250
8251 .next
8252 .cindex "asterisk" "in lookup type"
8253 Any of the single-key lookup types may be followed by an asterisk. This causes
8254 a default lookup for a key consisting of a single asterisk to be done if the
8255 original lookup fails. This is not a useful feature when using a domain list to
8256 select particular domains (because any domain would match), but it might have
8257 value if the result of the lookup is being used via the &$domain_data$&
8258 expansion variable.
8259 .next
8260 If the pattern starts with the name of a query-style lookup type followed by a
8261 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8262 pattern must be an appropriate query for the lookup type, as described in
8263 chapter &<<CHAPfdlookup>>&. For example:
8264 .code
8265 hold_domains = mysql;select domain from holdlist \
8266   where domain = '${quote_mysql:$domain}';
8267 .endd
8268 In most cases, the data that is looked up is not used (so for an SQL query, for
8269 example, it doesn't matter what field you select). Exim is interested only in
8270 whether or not the query succeeds. However, when a lookup is used for the
8271 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8272 variable and can be referred to in other options.
8273 .next
8274 .cindex "domain list" "matching literal domain name"
8275 If none of the above cases apply, a caseless textual comparison is made
8276 between the pattern and the domain.
8277 .endlist
8278
8279 Here is an example that uses several different kinds of pattern:
8280 .code
8281 domainlist funny_domains = \
8282   @ : \
8283   lib.unseen.edu : \
8284   *.foundation.fict.example : \
8285   \N^[1-2]\d{3}\.fict\.example$\N : \
8286   partial-dbm;/opt/data/penguin/book : \
8287   nis;domains.byname : \
8288   nisplus;[name=$domain,status=local],domains.org_dir
8289 .endd
8290 There are obvious processing trade-offs among the various matching modes. Using
8291 an asterisk is faster than a regular expression, and listing a few names
8292 explicitly probably is too. The use of a file or database lookup is expensive,
8293 but may be the only option if hundreds of names are required. Because the
8294 patterns are tested in order, it makes sense to put the most commonly matched
8295 patterns earlier.
8296
8297
8298
8299 .section "Host lists" "SECThostlist"
8300 .cindex "host list" "patterns in"
8301 .cindex "list" "host list"
8302 Host lists are used to control what remote hosts are allowed to do. For
8303 example, some hosts may be allowed to use the local host as a relay, and some
8304 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8305 two different ways, by name or by IP address. In a host list, some types of
8306 pattern are matched to a host name, and some are matched to an IP address.
8307 You need to be particularly careful with this when single-key lookups are
8308 involved, to ensure that the right value is being used as the key.
8309
8310
8311 .section "Special host list patterns" "SECID80"
8312 .cindex "empty item in hosts list"
8313 .cindex "host list" "empty string in"
8314 If a host list item is the empty string, it matches only when no remote host is
8315 involved. This is the case when a message is being received from a local
8316 process using SMTP on the standard input, that is, when a TCP/IP connection is
8317 not used.
8318
8319 .cindex "asterisk" "in host list"
8320 The special pattern &"*"& in a host list matches any host or no host. Neither
8321 the IP address nor the name is actually inspected.
8322
8323
8324
8325 .section "Host list patterns that match by IP address" "SECThoslispatip"
8326 .cindex "host list" "matching IP addresses"
8327 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8328 the incoming address actually appears in the IPv6 host as
8329 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8330 list, it is converted into a traditional IPv4 address first. (Not all operating
8331 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8332 concerns.)
8333
8334 The following types of pattern in a host list check the remote host by
8335 inspecting its IP address:
8336
8337 .ilist
8338 If the pattern is a plain domain name (not a regular expression, not starting
8339 with *, not a lookup of any kind), Exim calls the operating system function
8340 to find the associated IP address(es). Exim uses the newer
8341 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8342 This typically causes a forward DNS lookup of the name. The result is compared
8343 with the IP address of the subject host.
8344
8345 If there is a temporary problem (such as a DNS timeout) with the host name
8346 lookup, a temporary error occurs. For example, if the list is being used in an
8347 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8348 temporary SMTP error code. If no IP address can be found for the host name,
8349 what happens is described in section &<<SECTbehipnot>>& below.
8350
8351 .next
8352 .cindex "@ in a host list"
8353 If the pattern is &"@"&, the primary host name is substituted and used as a
8354 domain name, as just described.
8355
8356 .next
8357 If the pattern is an IP address, it is matched against the IP address of the
8358 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8359 IPv6 addresses can be given in colon-separated format, but the colons have to
8360 be doubled so as not to be taken as item separators when the default list
8361 separator is used. IPv6 addresses are recognized even when Exim is compiled
8362 without IPv6 support. This means that if they appear in a host list on an
8363 IPv4-only host, Exim will not treat them as host names. They are just addresses
8364 that can never match a client host.
8365
8366 .next
8367 .cindex "@[] in a host list"
8368 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8369 the local host. For example, if the local host is an IPv4 host with one
8370 interface address 10.45.23.56, these two ACL statements have the same effect:
8371 .code
8372 accept hosts = 127.0.0.1 : 10.45.23.56
8373 accept hosts = @[]
8374 .endd
8375 .next
8376 .cindex "CIDR notation"
8377 If the pattern is an IP address followed by a slash and a mask length (for
8378 example 10.11.42.0/24), it is matched against the IP address of the subject
8379 host under the given mask. This allows, an entire network of hosts to be
8380 included (or excluded) by a single item. The mask uses CIDR notation; it
8381 specifies the number of address bits that must match, starting from the most
8382 significant end of the address.
8383
8384 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8385 of a range of addresses. It is the number of bits in the network portion of the
8386 address. The above example specifies a 24-bit netmask, so it matches all 256
8387 addresses in the 10.11.42.0 network. An item such as
8388 .code
8389 192.168.23.236/31
8390 .endd
8391 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8392 32 for an IPv4 address is the same as no mask at all; just a single address
8393 matches.
8394
8395 Here is another example which shows an IPv4 and an IPv6 network:
8396 .code
8397 recipient_unqualified_hosts = 192.168.0.0/16: \
8398                               3ffe::ffff::836f::::/48
8399 .endd
8400 The doubling of list separator characters applies only when these items
8401 appear inline in a host list. It is not required when indirecting via a file.
8402 For example:
8403 .code
8404 recipient_unqualified_hosts = /opt/exim/unqualnets
8405 .endd
8406 could make use of a file containing
8407 .code
8408 172.16.0.0/12
8409 3ffe:ffff:836f::/48
8410 .endd
8411 to have exactly the same effect as the previous example. When listing IPv6
8412 addresses inline, it is usually more convenient to use the facility for
8413 changing separator characters. This list contains the same two networks:
8414 .code
8415 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8416                                  3ffe:ffff:836f::/48
8417 .endd
8418 The separator is changed to semicolon by the leading &"<;"& at the start of the
8419 list.
8420 .endlist
8421
8422
8423
8424 .section "Host list patterns for single-key lookups by host address" &&&
8425          "SECThoslispatsikey"
8426 .cindex "host list" "lookup of IP address"
8427 When a host is to be identified by a single-key lookup of its complete IP
8428 address, the pattern takes this form:
8429 .display
8430 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8431 .endd
8432 For example:
8433 .code
8434 hosts_lookup = net-cdb;/hosts-by-ip.db
8435 .endd
8436 The text form of the IP address of the subject host is used as the lookup key.
8437 IPv6 addresses are converted to an unabbreviated form, using lower case
8438 letters, with dots as separators because colon is the key terminator in
8439 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8440 quoting the keys, but this is a facility that was added later.] The data
8441 returned by the lookup is not used.
8442
8443 .cindex "IP address" "masking"
8444 .cindex "host list" "masked IP address"
8445 Single-key lookups can also be performed using masked IP addresses, using
8446 patterns of this form:
8447 .display
8448 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8449 .endd
8450 For example:
8451 .code
8452 net24-dbm;/networks.db
8453 .endd
8454 The IP address of the subject host is masked using <&'number'&> as the mask
8455 length. A textual string is constructed from the masked value, followed by the
8456 mask, and this is used as the lookup key. For example, if the host's IP address
8457 is 192.168.34.6, the key that is looked up for the above example is
8458 &"192.168.34.0/24"&.
8459
8460 When an IPv6 address is converted to a string, dots are normally used instead
8461 of colons, so that keys in &(lsearch)& files need not contain colons (which
8462 terminate &(lsearch)& keys). This was implemented some time before the ability
8463 to quote keys was made available in &(lsearch)& files. However, the more
8464 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8465 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8466 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8467 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8468 addresses are always used.
8469
8470 Ideally, it would be nice to tidy up this anomalous situation by changing to
8471 colons in all cases, given that quoting is now available for &(lsearch)&.
8472 However, this would be an incompatible change that might break some existing
8473 configurations.
8474
8475 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8476 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8477 the former case the key strings include the mask value, whereas in the latter
8478 case the IP address is used on its own.
8479
8480
8481
8482 .section "Host list patterns that match by host name" "SECThoslispatnam"
8483 .cindex "host" "lookup failures"
8484 .cindex "unknown host name"
8485 .cindex "host list" "matching host name"
8486 There are several types of pattern that require Exim to know the name of the
8487 remote host. These are either wildcard patterns or lookups by name. (If a
8488 complete hostname is given without any wildcarding, it is used to find an IP
8489 address to match against, as described in section &<<SECThoslispatip>>&
8490 above.)
8491
8492 If the remote host name is not already known when Exim encounters one of these
8493 patterns, it has to be found from the IP address.
8494 Although many sites on the Internet are conscientious about maintaining reverse
8495 DNS data for their hosts, there are also many that do not do this.
8496 Consequently, a name cannot always be found, and this may lead to unwanted
8497 effects. Take care when configuring host lists with wildcarded name patterns.
8498 Consider what will happen if a name cannot be found.
8499
8500 Because of the problems of determining host names from IP addresses, matching
8501 against host names is not as common as matching against IP addresses.
8502
8503 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8504 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8505 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8506 are done can be changed by setting the &%host_lookup_order%& option. For
8507 security, once Exim has found one or more names, it looks up the IP addresses
8508 for these names and compares them with the IP address that it started with.
8509 Only those names whose IP addresses match are accepted. Any other names are
8510 discarded. If no names are left, Exim behaves as if the host name cannot be
8511 found. In the most common case there is only one name and one IP address.
8512
8513 There are some options that control what happens if a host name cannot be
8514 found. These are described in section &<<SECTbehipnot>>& below.
8515
8516 .cindex "host" "alias for"
8517 .cindex "alias for host"
8518 As a result of aliasing, hosts may have more than one name. When processing any
8519 of the following types of pattern, all the host's names are checked:
8520
8521 .ilist
8522 .cindex "asterisk" "in host list"
8523 If a pattern starts with &"*"& the remainder of the item must match the end of
8524 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8525 &'.b.c'&. This special simple form is provided because this is a very common
8526 requirement. Other kinds of wildcarding require the use of a regular
8527 expression.
8528 .next
8529 .cindex "regular expressions" "in host list"
8530 .cindex "host list" "regular expression in"
8531 If the item starts with &"^"& it is taken to be a regular expression which is
8532 matched against the host name. Host names are case-independent, so this regular
8533 expression match is by default case-independent, but you can make it
8534 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8535 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8536 example,
8537 .code
8538 ^(a|b)\.c\.d$
8539 .endd
8540 is a regular expression that matches either of the two hosts &'a.c.d'& or
8541 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8542 that backslash and dollar characters are not misinterpreted as part of the
8543 string expansion. The simplest way to do this is to use &`\N`& to mark that
8544 part of the string as non-expandable. For example:
8545 .code
8546 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8547 .endd
8548 &*Warning*&: If you want to match a complete host name, you must include the
8549 &`$`& terminating metacharacter in the regular expression, as in the above
8550 example. Without it, a match at the start of the host name is all that is
8551 required.
8552 .endlist
8553
8554
8555
8556
8557 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8558 .cindex "host" "lookup failures, permanent"
8559 While processing a host list, Exim may need to look up an IP address from a
8560 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8561 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8562 behaviour when it fails to find the information it is seeking is the same.
8563
8564 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8565 apply to temporary DNS errors, whose handling is described in the next section.
8566
8567 .cindex "&`+include_unknown`&"
8568 .cindex "&`+ignore_unknown`&"
8569 Exim parses a host list from left to right. If it encounters a permanent
8570 lookup failure in any item in the host list before it has found a match,
8571 Exim treats it as a failure and the default behavior is as if the host
8572 does not match the list. This may not always be what you want to happen.
8573 To change Exim's behaviour, the special items &`+include_unknown`& or
8574 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8575 not recognized in an indirected file).
8576
8577 .ilist
8578 If any item that follows &`+include_unknown`& requires information that
8579 cannot found, Exim behaves as if the host does match the list. For example,
8580 .code
8581 host_reject_connection = +include_unknown:*.enemy.ex
8582 .endd
8583 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8584 any hosts whose name it cannot find.
8585
8586 .next
8587 If any item that follows &`+ignore_unknown`& requires information that cannot
8588 be found, Exim ignores that item and proceeds to the rest of the list. For
8589 example:
8590 .code
8591 accept hosts = +ignore_unknown : friend.example : \
8592                192.168.4.5
8593 .endd
8594 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8595 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8596 name can be found for 192.168.4.5, it is rejected.
8597 .endlist
8598
8599 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8600 list. The effect of each one lasts until the next, or until the end of the
8601 list.
8602
8603 .section "Mixing wildcarded host names and addresses in host lists" &&&
8604          "SECTmixwilhos"
8605 .cindex "host list" "mixing names and addresses in"
8606
8607 This section explains the host/ip processing logic with the same concepts
8608 as the previous section, but specifically addresses what happens when a
8609 wildcarded hostname is one of the items in the hostlist.
8610
8611 .ilist
8612 If you have name lookups or wildcarded host names and
8613 IP addresses in the same host list, you should normally put the IP
8614 addresses first. For example, in an ACL you could have:
8615 .code
8616 accept hosts = 10.9.8.7 : *.friend.example
8617 .endd
8618 The reason you normally would order it this way lies in the
8619 left-to-right way that Exim processes lists.  It can test IP addresses
8620 without doing any DNS lookups, but when it reaches an item that requires
8621 a host name, it fails if it cannot find a host name to compare with the
8622 pattern. If the above list is given in the opposite order, the
8623 &%accept%& statement fails for a host whose name cannot be found, even
8624 if its IP address is 10.9.8.7.
8625
8626 .next
8627 If you really do want to do the name check first, and still recognize the IP
8628 address, you can rewrite the ACL like this:
8629 .code
8630 accept hosts = *.friend.example
8631 accept hosts = 10.9.8.7
8632 .endd
8633 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8634 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8635 &`+ignore_unknown`&, which was discussed in depth in the first example in
8636 this section.
8637 .endlist
8638
8639
8640 .section "Temporary DNS errors when looking up host information" &&&
8641          "SECTtemdnserr"
8642 .cindex "host" "lookup failures, temporary"
8643 .cindex "&`+include_defer`&"
8644 .cindex "&`+ignore_defer`&"
8645 A temporary DNS lookup failure normally causes a defer action (except when
8646 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8647 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8648 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8649 section. These options should be used with care, probably only in non-critical
8650 host lists such as whitelists.
8651
8652
8653
8654 .section "Host list patterns for single-key lookups by host name" &&&
8655          "SECThoslispatnamsk"
8656 .cindex "unknown host name"
8657 .cindex "host list" "matching host name"
8658 If a pattern is of the form
8659 .display
8660 <&'single-key-search-type'&>;<&'search-data'&>
8661 .endd
8662 for example
8663 .code
8664 dbm;/host/accept/list
8665 .endd
8666 a single-key lookup is performed, using the host name as its key. If the
8667 lookup succeeds, the host matches the item. The actual data that is looked up
8668 is not used.
8669
8670 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8671 keys in the file, not IP addresses. If you want to do lookups based on IP
8672 addresses, you must precede the search type with &"net-"& (see section
8673 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8674 two items in the same list, one doing an address lookup and one doing a name
8675 lookup, both using the same file.
8676
8677
8678
8679 .section "Host list patterns for query-style lookups" "SECID81"
8680 If a pattern is of the form
8681 .display
8682 <&'query-style-search-type'&>;<&'query'&>
8683 .endd
8684 the query is obeyed, and if it succeeds, the host matches the item. The actual
8685 data that is looked up is not used. The variables &$sender_host_address$& and
8686 &$sender_host_name$& can be used in the query. For example:
8687 .code
8688 hosts_lookup = pgsql;\
8689   select ip from hostlist where ip='$sender_host_address'
8690 .endd
8691 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8692 can use the &%sg%& expansion item to change this if you need to. If you want to
8693 use masked IP addresses in database queries, you can use the &%mask%& expansion
8694 operator.
8695
8696 If the query contains a reference to &$sender_host_name$&, Exim automatically
8697 looks up the host name if it has not already done so. (See section
8698 &<<SECThoslispatnam>>& for comments on finding host names.)
8699
8700 Historical note: prior to release 4.30, Exim would always attempt to find a
8701 host name before running the query, unless the search type was preceded by
8702 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8703 still recognized for query-style lookups, but its presence or absence has no
8704 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8705 See section &<<SECThoslispatsikey>>&.)
8706
8707
8708
8709
8710
8711 .section "Address lists" "SECTaddresslist"
8712 .cindex "list" "address list"
8713 .cindex "address list" "empty item"
8714 .cindex "address list" "patterns"
8715 Address lists contain patterns that are matched against mail addresses. There
8716 is one special case to be considered: the sender address of a bounce message is
8717 always empty. You can test for this by providing an empty item in an address
8718 list. For example, you can set up a router to process bounce messages by
8719 using this option setting:
8720 .code
8721 senders = :
8722 .endd
8723 The presence of the colon creates an empty item. If you do not provide any
8724 data, the list is empty and matches nothing. The empty sender can also be
8725 detected by a regular expression that matches an empty string,
8726 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8727
8728 Non-empty items in an address list can be straightforward email addresses. For
8729 example:
8730 .code
8731 senders = jbc@askone.example : hs@anacreon.example
8732 .endd
8733 A certain amount of wildcarding is permitted. If a pattern contains an @
8734 character, but is not a regular expression and does not begin with a
8735 semicolon-terminated lookup type (described below), the local part of the
8736 subject address is compared with the local part of the pattern, which may start
8737 with an asterisk. If the local parts match, the domain is checked in exactly
8738 the same way as for a pattern in a domain list. For example, the domain can be
8739 wildcarded, refer to a named list, or be a lookup:
8740 .code
8741 deny senders = *@*.spamming.site:\
8742                *@+hostile_domains:\
8743                bozo@partial-lsearch;/list/of/dodgy/sites:\
8744                *@dbm;/bad/domains.db
8745 .endd
8746 .cindex "local part" "starting with !"
8747 .cindex "address list" "local part starting with !"
8748 If a local part that begins with an exclamation mark is required, it has to be
8749 specified using a regular expression, because otherwise the exclamation mark is
8750 treated as a sign of negation, as is standard in lists.
8751
8752 If a non-empty pattern that is not a regular expression or a lookup does not
8753 contain an @ character, it is matched against the domain part of the subject
8754 address. The only two formats that are recognized this way are a literal
8755 domain, or a domain pattern that starts with *. In both these cases, the effect
8756 is the same as if &`*@`& preceded the pattern. For example:
8757 .code
8758 deny senders = enemy.domain : *.enemy.domain
8759 .endd
8760
8761 The following kinds of more complicated address list pattern can match any
8762 address, including the empty address that is characteristic of bounce message
8763 senders:
8764
8765 .ilist
8766 .cindex "regular expressions" "in address list"
8767 .cindex "address list" "regular expression in"
8768 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8769 done against the complete address, with the pattern as the regular expression.
8770 You must take care that backslash and dollar characters are not misinterpreted
8771 as part of the string expansion. The simplest way to do this is to use &`\N`&
8772 to mark that part of the string as non-expandable. For example:
8773 .code
8774 deny senders = \N^.*this.*@example\.com$\N : \
8775                \N^\d{8}.+@spamhaus.example$\N : ...
8776 .endd
8777 The &`\N`& sequences are removed by the expansion, so these items do indeed
8778 start with &"^"& by the time they are being interpreted as address patterns.
8779
8780 .next
8781 .cindex "address list" "lookup for complete address"
8782 Complete addresses can be looked up by using a pattern that starts with a
8783 lookup type terminated by a semicolon, followed by the data for the lookup. For
8784 example:
8785 .code
8786 deny senders = cdb;/etc/blocked.senders : \
8787   mysql;select address from blocked where \
8788   address='${quote_mysql:$sender_address}'
8789 .endd
8790 Both query-style and single-key lookup types can be used. For a single-key
8791 lookup type, Exim uses the complete address as the key. However, empty keys are
8792 not supported for single-key lookups, so a match against the empty address
8793 always fails. This restriction does not apply to query-style lookups.
8794
8795 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8796 cannot be used, and is ignored if specified, with an entry being written to the
8797 panic log.
8798 .cindex "*@ with single-key lookup"
8799 However, you can configure lookup defaults, as described in section
8800 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8801 default. For example, with this lookup:
8802 .code
8803 accept senders = lsearch*@;/some/file
8804 .endd
8805 the file could contains lines like this:
8806 .code
8807 user1@domain1.example
8808 *@domain2.example
8809 .endd
8810 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8811 that are tried is:
8812 .code
8813 nimrod@jaeger.example
8814 *@jaeger.example
8815 *
8816 .endd
8817 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8818 would mean that every address matches, thus rendering the test useless.
8819
8820 &*Warning 2*&: Do not confuse these two kinds of item:
8821 .code
8822 deny recipients = dbm*@;/some/file
8823 deny recipients = *@dbm;/some/file
8824 .endd
8825 The first does a whole address lookup, with defaulting, as just described,
8826 because it starts with a lookup type. The second matches the local part and
8827 domain independently, as described in a bullet point below.
8828 .endlist
8829
8830
8831 The following kinds of address list pattern can match only non-empty addresses.
8832 If the subject address is empty, a match against any of these pattern types
8833 always fails.
8834
8835
8836 .ilist
8837 .cindex "@@ with single-key lookup"
8838 .cindex "address list" "@@ lookup type"
8839 .cindex "address list" "split local part and domain"
8840 If a pattern starts with &"@@"& followed by a single-key lookup item
8841 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8842 split into a local part and a domain. The domain is looked up in the file. If
8843 it is not found, there is no match. If it is found, the data that is looked up
8844 from the file is treated as a colon-separated list of local part patterns, each
8845 of which is matched against the subject local part in turn.
8846
8847 .cindex "asterisk" "in address list"
8848 The lookup may be a partial one, and/or one involving a search for a default
8849 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8850 patterns that are looked up can be regular expressions or begin with &"*"&, or
8851 even be further lookups. They may also be independently negated. For example,
8852 with
8853 .code
8854 deny senders = @@dbm;/etc/reject-by-domain
8855 .endd
8856 the data from which the DBM file is built could contain lines like
8857 .code
8858 baddomain.com:  !postmaster : *
8859 .endd
8860 to reject all senders except &%postmaster%& from that domain.
8861
8862 .cindex "local part" "starting with !"
8863 If a local part that actually begins with an exclamation mark is required, it
8864 has to be specified using a regular expression. In &(lsearch)& files, an entry
8865 may be split over several lines by indenting the second and subsequent lines,
8866 but the separating colon must still be included at line breaks. White space
8867 surrounding the colons is ignored. For example:
8868 .code
8869 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8870   spammer3 : spammer4
8871 .endd
8872 As in all colon-separated lists in Exim, a colon can be included in an item by
8873 doubling.
8874
8875 If the last item in the list starts with a right angle-bracket, the remainder
8876 of the item is taken as a new key to look up in order to obtain a continuation
8877 list of local parts. The new key can be any sequence of characters. Thus one
8878 might have entries like
8879 .code
8880 aol.com: spammer1 : spammer 2 : >*
8881 xyz.com: spammer3 : >*
8882 *:       ^\d{8}$
8883 .endd
8884 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8885 local parts for all domains, in addition to the specific local parts listed for
8886 each domain. Of course, using this feature costs another lookup each time a
8887 chain is followed, but the effort needed to maintain the data is reduced.
8888
8889 .cindex "loop" "in lookups"
8890 It is possible to construct loops using this facility, and in order to catch
8891 them, the chains may be no more than fifty items long.
8892
8893 .next
8894 The @@<&'lookup'&> style of item can also be used with a query-style
8895 lookup, but in this case, the chaining facility is not available. The lookup
8896 can only return a single list of local parts.
8897 .endlist
8898
8899 &*Warning*&: There is an important difference between the address list items
8900 in these two examples:
8901 .code
8902 senders = +my_list
8903 senders = *@+my_list
8904 .endd
8905 In the first one, &`my_list`& is a named address list, whereas in the second
8906 example it is a named domain list.
8907
8908
8909
8910
8911 .section "Case of letters in address lists" "SECTcasletadd"
8912 .cindex "case of local parts"
8913 .cindex "address list" "case forcing"
8914 .cindex "case forcing in address lists"
8915 Domains in email addresses are always handled caselessly, but for local parts
8916 case may be significant on some systems (see &%caseful_local_part%& for how
8917 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8918 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8919 blocking lists should be done in a case-independent manner. Since most address
8920 lists in Exim are used for this kind of control, Exim attempts to do this by
8921 default.
8922
8923 The domain portion of an address is always lowercased before matching it to an
8924 address list. The local part is lowercased by default, and any string
8925 comparisons that take place are done caselessly. This means that the data in
8926 the address list itself, in files included as plain file names, and in any file
8927 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8928 keys in files that are looked up by a search type other than &(lsearch)& (which
8929 works caselessly) must be in lower case, because these lookups are not
8930 case-independent.
8931
8932 .cindex "&`+caseful`&"
8933 To allow for the possibility of caseful address list matching, if an item in
8934 an address list is the string &"+caseful"&, the original case of the local
8935 part is restored for any comparisons that follow, and string comparisons are no
8936 longer case-independent. This does not affect the domain, which remains in
8937 lower case. However, although independent matches on the domain alone are still
8938 performed caselessly, regular expressions that match against an entire address
8939 become case-sensitive after &"+caseful"& has been seen.
8940
8941
8942
8943 .section "Local part lists" "SECTlocparlis"
8944 .cindex "list" "local part list"
8945 .cindex "local part" "list"
8946 Case-sensitivity in local part lists is handled in the same way as for address
8947 lists, as just described. The &"+caseful"& item can be used if required. In a
8948 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8949 set false, the subject is lowercased and the matching is initially
8950 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8951 matching in the local part list, but not elsewhere in the router. If
8952 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8953 option is case-sensitive from the start.
8954
8955 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8956 comments are handled in the same way as address lists &-- they are recognized
8957 only if the # is preceded by white space or the start of the line.
8958 Otherwise, local part lists are matched in the same way as domain lists, except
8959 that the special items that refer to the local host (&`@`&, &`@[]`&,
8960 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8961 Refer to section &<<SECTdomainlist>>& for details of the other available item
8962 types.
8963 .ecindex IIDdohoadli
8964
8965
8966
8967
8968 . ////////////////////////////////////////////////////////////////////////////
8969 . ////////////////////////////////////////////////////////////////////////////
8970
8971 .chapter "String expansions" "CHAPexpand"
8972 .scindex IIDstrexp "expansion" "of strings"
8973 Many strings in Exim's run time configuration are expanded before use. Some of
8974 them are expanded every time they are used; others are expanded only once.
8975
8976 When a string is being expanded it is copied verbatim from left to right except
8977 when a dollar or backslash character is encountered. A dollar specifies the
8978 start of a portion of the string that is interpreted and replaced as described
8979 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8980 escape character, as described in the following section.
8981
8982 Whether a string is expanded depends upon the context.  Usually this is solely
8983 dependent upon the option for which a value is sought; in this documentation,
8984 options for which string expansion is performed are marked with &dagger; after
8985 the data type.  ACL rules always expand strings.  A couple of expansion
8986 conditions do not expand some of the brace-delimited branches, for security
8987 reasons.
8988
8989
8990
8991 .section "Literal text in expanded strings" "SECTlittext"
8992 .cindex "expansion" "including literal text"
8993 An uninterpreted dollar can be included in an expanded string by putting a
8994 backslash in front of it. A backslash can be used to prevent any special
8995 character being treated specially in an expansion, including backslash itself.
8996 If the string appears in quotes in the configuration file, two backslashes are
8997 required because the quotes themselves cause interpretation of backslashes when
8998 the string is read in (see section &<<SECTstrings>>&).
8999
9000 .cindex "expansion" "non-expandable substrings"
9001 A portion of the string can specified as non-expandable by placing it between
9002 two occurrences of &`\N`&. This is particularly useful for protecting regular
9003 expressions, which often contain backslashes and dollar signs. For example:
9004 .code
9005 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9006 .endd
9007 On encountering the first &`\N`&, the expander copies subsequent characters
9008 without interpretation until it reaches the next &`\N`& or the end of the
9009 string.
9010
9011
9012
9013 .section "Character escape sequences in expanded strings" "SECID82"
9014 .cindex "expansion" "escape sequences"
9015 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9016 expanded string is recognized as an escape sequence for the character newline,
9017 carriage return, or tab, respectively. A backslash followed by up to three
9018 octal digits is recognized as an octal encoding for a single character, and a
9019 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9020 encoding.
9021
9022 These escape sequences are also recognized in quoted strings when they are read
9023 in. Their interpretation in expansions as well is useful for unquoted strings,
9024 and for other cases such as looked-up strings that are then expanded.
9025
9026
9027 .section "Testing string expansions" "SECID83"
9028 .cindex "expansion" "testing"
9029 .cindex "testing" "string expansion"
9030 .oindex "&%-be%&"
9031 Many expansions can be tested by calling Exim with the &%-be%& option. This
9032 takes the command arguments, or lines from the standard input if there are no
9033 arguments, runs them through the string expansion code, and writes the results
9034 to the standard output. Variables based on configuration values are set up, but
9035 since no message is being processed, variables such as &$local_part$& have no
9036 value. Nevertheless the &%-be%& option can be useful for checking out file and
9037 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9038 and &%nhash%&.
9039
9040 Exim gives up its root privilege when it is called with the &%-be%& option, and
9041 instead runs under the uid and gid it was called with, to prevent users from
9042 using &%-be%& for reading files to which they do not have access.
9043
9044 .oindex "&%-bem%&"
9045 If you want to test expansions that include variables whose values are taken
9046 from a message, there are two other options that can be used. The &%-bem%&
9047 option is like &%-be%& except that it is followed by a file name. The file is
9048 read as a message before doing the test expansions. For example:
9049 .code
9050 exim -bem /tmp/test.message '$h_subject:'
9051 .endd
9052 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9053 Exim message identifier. For example:
9054 .code
9055 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9056 .endd
9057 This loads the message from Exim's spool before doing the test expansions, and
9058 is therefore restricted to admin users.
9059
9060
9061 .section "Forced expansion failure" "SECTforexpfai"
9062 .cindex "expansion" "forced failure"
9063 A number of expansions that are described in the following section have
9064 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9065 (which are sometimes called &"curly brackets"&). Which of the two strings is
9066 used depends on some condition that is evaluated as part of the expansion. If,
9067 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9068 the entire string expansion fails in a way that can be detected by the code
9069 that requested the expansion. This is called &"forced expansion failure"&, and
9070 its consequences depend on the circumstances. In some cases it is no different
9071 from any other expansion failure, but in others a different action may be
9072 taken. Such variations are mentioned in the documentation of the option that is
9073 being expanded.
9074
9075
9076
9077
9078 .section "Expansion items" "SECTexpansionitems"
9079 The following items are recognized in expanded strings. White space may be used
9080 between sub-items that are keywords or substrings enclosed in braces inside an
9081 outer set of braces, to improve readability. &*Warning*&: Within braces,
9082 white space is significant.
9083
9084 .vlist
9085 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9086 .cindex "expansion" "variables"
9087 Substitute the contents of the named variable, for example:
9088 .code
9089 $local_part
9090 ${domain}
9091 .endd
9092 The second form can be used to separate the name from subsequent alphanumeric
9093 characters. This form (using braces) is available only for variables; it does
9094 &'not'& apply to message headers. The names of the variables are given in
9095 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9096 given, the expansion fails.
9097
9098 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9099 .cindex "expansion" "operators"
9100 The string is first itself expanded, and then the operation specified by
9101 <&'op'&> is applied to it. For example:
9102 .code
9103 ${lc:$local_part}
9104 .endd
9105 The string starts with the first character after the colon, which may be
9106 leading white space. A list of operators is given in section &<<SECTexpop>>&
9107 below. The operator notation is used for simple expansion items that have just
9108 one argument, because it reduces the number of braces and therefore makes the
9109 string easier to understand.
9110
9111 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9112 This item inserts &"basic"& header lines. It is described with the &%header%&
9113 expansion item below.
9114
9115
9116 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9117 .cindex "expansion" "calling an acl"
9118 .cindex "&%acl%&" "call from expansion"
9119 The name and zero to nine argument strings are first expanded separately.  The expanded
9120 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9121 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9122 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9123 and may use the variables; if another acl expansion is used the values
9124 are restored after it returns.  If the ACL sets
9125 a value using a "message =" modifier and returns accept or deny, the value becomes
9126 the result of the expansion.
9127 If no message is set and the ACL returns accept or deny
9128 the expansion result is an empty string.
9129 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9130
9131
9132 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9133        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9134 .cindex "expansion" "extracting certificate fields"
9135 .cindex "&%certextract%&" "certificate fields"
9136 .cindex "certificate" "extracting fields"
9137 The <&'certificate'&> must be a variable of type certificate.
9138 The field name is expanded and used to retrieve the relevant field from
9139 the certificate.  Supported fields are:
9140 .display
9141 &`version        `&
9142 &`serial_number  `&
9143 &`subject        `& RFC4514 DN
9144 &`issuer         `& RFC4514 DN
9145 &`notbefore      `& time
9146 &`notafter       `& time
9147 &`sig_algorithm  `&
9148 &`signature      `&
9149 &`subj_altname   `& tagged list
9150 &`ocsp_uri       `& list
9151 &`crl_uri        `& list
9152 .endd
9153 If the field is found,
9154 <&'string2'&> is expanded, and replaces the whole item;
9155 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9156 variable &$value$& contains the value that has been extracted. Afterwards, it
9157 is restored to any previous value it might have had.
9158
9159 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9160 key is not found. If {<&'string2'&>} is also omitted, the value that was
9161 extracted is used.
9162
9163 Some field names take optional modifiers, appended and separated by commas.
9164
9165 The field selectors marked as "RFC4514" above
9166 output a Distinguished Name string which is
9167 not quite
9168 parseable by Exim as a comma-separated tagged list
9169 (the exceptions being elements containing commas).
9170 RDN elements of a single type may be selected by
9171 a modifier of the type label; if so the expansion
9172 result is a list (newline-separated by default).
9173 The separator may be changed by another modifier of
9174 a right angle-bracket followed immediately by the new separator.
9175 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9176
9177 The field selectors marked as "time" above
9178 take an optional modifier of "int"
9179 for which the result is the number of seconds since epoch.
9180 Otherwise the result is a human-readable string
9181 in the timezone selected by the main "timezone" option.
9182
9183 The field selectors marked as "list" above return a list,
9184 newline-separated by default,
9185 (embedded separator characters in elements are doubled).
9186 The separator may be changed by a modifier of
9187 a right angle-bracket followed immediately by the new separator.
9188
9189 The field selectors marked as "tagged" above
9190 prefix each list element with a type string and an equals sign.
9191 Elements of only one type may be selected by a modifier
9192 which is one of "dns", "uri" or "mail";
9193 if so the element tags are omitted.
9194
9195 If not otherwise noted field values are presented in human-readable form.
9196
9197 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9198        {*&<&'arg'&>&*}...}*&"
9199 .cindex &%dlfunc%&
9200 This expansion dynamically loads and then calls a locally-written C function.
9201 This functionality is available only if Exim is compiled with
9202 .code
9203 EXPAND_DLFUNC=yes
9204 .endd
9205 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9206 object so that it doesn't reload the same object file in the same Exim process
9207 (but of course Exim does start new processes frequently).
9208
9209 There may be from zero to eight arguments to the function. When compiling
9210 a local function that is to be called in this way, &_local_scan.h_& should be
9211 included. The Exim variables and functions that are defined by that API
9212 are also available for dynamically loaded functions. The function itself
9213 must have the following type:
9214 .code
9215 int dlfunction(uschar **yield, int argc, uschar *argv[])
9216 .endd
9217 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9218 function should return one of the following values:
9219
9220 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9221 into the expanded string that is being built.
9222
9223 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9224 from &'yield'&, if it is set.
9225
9226 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9227 taken from &'yield'& if it is set.
9228
9229 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9230
9231 When compiling a function that is to be used in this way with gcc,
9232 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9233 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9234
9235
9236 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9237 .cindex "expansion" "extracting value from environment"
9238 .cindex "environment" "values from"
9239 The key is first expanded separately, and leading and trailing white space
9240 removed.
9241 This is then searched for as a name in the environment.
9242 If a variable is found then its value is placed in &$value$&
9243 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9244
9245 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9246 appear, for example:
9247 .code
9248 ${env{USER}{$value} fail }
9249 .endd
9250 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9251 {<&'string1'&>} must be present for &"fail"& to be recognized.
9252
9253 If {<&'string2'&>} is omitted an empty string is substituted on
9254 search failure.
9255 If {<&'string1'&>} is omitted the search result is substituted on
9256 search success.
9257
9258 The environment is adjusted by the &%keep_environment%& and
9259 &%add_environment%& main section options.
9260
9261
9262 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9263        {*&<&'string3'&>&*}}*&"
9264 .cindex "expansion" "extracting substrings by key"
9265 .cindex "&%extract%&" "substrings by key"
9266 The key and <&'string1'&> are first expanded separately. Leading and trailing
9267 white space is removed from the key (but not from any of the strings). The key
9268 must not be empty and must not consist entirely of digits.
9269 The expanded <&'string1'&> must be of the form:
9270 .display
9271 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9272 .endd
9273 .vindex "&$value$&"
9274 where the equals signs and spaces (but not both) are optional. If any of the
9275 values contain white space, they must be enclosed in double quotes, and any
9276 values that are enclosed in double quotes are subject to escape processing as
9277 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9278 for the value that corresponds to the key. The search is case-insensitive. If
9279 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9280 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9281 variable &$value$& contains the value that has been extracted. Afterwards, it
9282 is restored to any previous value it might have had.
9283
9284 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9285 key is not found. If {<&'string2'&>} is also omitted, the value that was
9286 extracted is used. Thus, for example, these two expansions are identical, and
9287 yield &"2001"&:
9288 .code
9289 ${extract{gid}{uid=1984 gid=2001}}
9290 ${extract{gid}{uid=1984 gid=2001}{$value}}
9291 .endd
9292 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9293 appear, for example:
9294 .code
9295 ${extract{Z}{A=... B=...}{$value} fail }
9296 .endd
9297 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9298 {<&'string2'&>} must be present for &"fail"& to be recognized.
9299
9300
9301 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9302         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9303 .cindex "expansion" "extracting substrings by number"
9304 .cindex "&%extract%&" "substrings by number"
9305 The <&'number'&> argument must consist entirely of decimal digits,
9306 apart from leading and trailing white space, which is ignored.
9307 This is what distinguishes this form of &%extract%& from the previous kind. It
9308 behaves in the same way, except that, instead of extracting a named field, it
9309 extracts from <&'string1'&> the field whose number is given as the first
9310 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9311 <&'string3'&> as before.
9312
9313 The fields in the string are separated by any one of the characters in the
9314 separator string. These may include space or tab characters.
9315 The first field is numbered one. If the number is negative, the fields are
9316 counted from the end of the string, with the rightmost one numbered -1. If the
9317 number given is zero, the entire string is returned. If the modulus of the
9318 number is greater than the number of fields in the string, the result is the
9319 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9320 provided. For example:
9321 .code
9322 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9323 .endd
9324 yields &"42"&, and
9325 .code
9326 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9327 .endd
9328 yields &"99"&. Two successive separators mean that the field between them is
9329 empty (for example, the fifth field above).
9330
9331
9332 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9333 .cindex "list" "selecting by condition"
9334 .cindex "expansion" "selecting from list by condition"
9335 .vindex "&$item$&"
9336 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9337 default, but the separator can be changed in the usual way. For each item
9338 in this list, its value is place in &$item$&, and then the condition is
9339 evaluated. If the condition is true, &$item$& is added to the output as an
9340 item in a new list; if the condition is false, the item is discarded. The
9341 separator used for the output list is the same as the one used for the
9342 input, but a separator setting is not included in the output. For example:
9343 .code
9344 ${filter{a:b:c}{!eq{$item}{b}}
9345 .endd
9346 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9347 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9348
9349
9350 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9351 .cindex "hash function" "textual"
9352 .cindex "expansion" "textual hash"
9353 This is a textual hashing function, and was the first to be implemented in
9354 early versions of Exim. In current releases, there are other hashing functions
9355 (numeric, MD5, and SHA-1), which are described below.
9356
9357 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9358 <&'n'&>. If you are using fixed values for these numbers, that is, if
9359 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9360 use the simpler operator notation that avoids some of the braces:
9361 .code
9362 ${hash_<n>_<m>:<string>}
9363 .endd
9364 The second number is optional (in both notations). If <&'n'&> is greater than
9365 or equal to the length of the string, the expansion item returns the string.
9366 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9367 function to the string. The new string consists of characters taken from the
9368 first <&'m'&> characters of the string
9369 .code
9370 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9371 .endd
9372 If <&'m'&> is not present the value 26 is used, so that only lower case
9373 letters appear. For example:
9374 .display
9375 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9376 &`$hash{5}{monty}}           `&   yields  &`monty`&
9377 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9378 .endd
9379
9380 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9381         &*$h_*&<&'header&~name'&>&*:*&" &&&
9382        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9383         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9384        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9385         &*$rh_*&<&'header&~name'&>&*:*&"
9386 .cindex "expansion" "header insertion"
9387 .vindex "&$header_$&"
9388 .vindex "&$bheader_$&"
9389 .vindex "&$rheader_$&"
9390 .cindex "header lines" "in expansion strings"
9391 .cindex "header lines" "character sets"
9392 .cindex "header lines" "decoding"
9393 Substitute the contents of the named message header line, for example
9394 .code
9395 $header_reply-to:
9396 .endd
9397 The newline that terminates a header line is not included in the expansion, but
9398 internal newlines (caused by splitting the header line over several physical
9399 lines) may be present.
9400
9401 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9402 the data in the header line is interpreted.
9403
9404 .ilist
9405 .cindex "white space" "in header lines"
9406 &%rheader%& gives the original &"raw"& content of the header line, with no
9407 processing at all, and without the removal of leading and trailing white space.
9408
9409 .next
9410 .cindex "base64 encoding" "in header lines"
9411 &%bheader%& removes leading and trailing white space, and then decodes base64
9412 or quoted-printable MIME &"words"& within the header text, but does no
9413 character set translation. If decoding of what looks superficially like a MIME
9414 &"word"& fails, the raw string is returned. If decoding
9415 .cindex "binary zero" "in header line"
9416 produces a binary zero character, it is replaced by a question mark &-- this is
9417 what Exim does for binary zeros that are actually received in header lines.
9418
9419 .next
9420 &%header%& tries to translate the string as decoded by &%bheader%& to a
9421 standard character set. This is an attempt to produce the same string as would
9422 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9423 returned. Translation is attempted only on operating systems that support the
9424 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9425 a system Makefile or in &_Local/Makefile_&.
9426 .endlist ilist
9427
9428 In a filter file, the target character set for &%header%& can be specified by a
9429 command of the following form:
9430 .code
9431 headers charset "UTF-8"
9432 .endd
9433 This command affects all references to &$h_$& (or &$header_$&) expansions in
9434 subsequently obeyed filter commands. In the absence of this command, the target
9435 character set in a filter is taken from the setting of the &%headers_charset%&
9436 option in the runtime configuration. The value of this option defaults to the
9437 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9438 ISO-8859-1.
9439
9440 Header names follow the syntax of RFC 2822, which states that they may contain
9441 any printing characters except space and colon. Consequently, curly brackets
9442 &'do not'& terminate header names, and should not be used to enclose them as
9443 if they were variables. Attempting to do so causes a syntax error.
9444
9445 Only header lines that are common to all copies of a message are visible to
9446 this mechanism. These are the original header lines that are received with the
9447 message, and any that are added by an ACL statement or by a system
9448 filter. Header lines that are added to a particular copy of a message by a
9449 router or transport are not accessible.
9450
9451 For incoming SMTP messages, no header lines are visible in
9452 ACLs that are obeyed before the data phase completes,
9453 because the header structure is not set up until the message is received.
9454 They are visible in DKIM, PRDR and DATA ACLs.
9455 Header lines that are added in a RCPT ACL (for example)
9456 are saved until the message's incoming header lines are available, at which
9457 point they are added.
9458 When any of the above ACLs ar
9459 running, however, header lines added by earlier ACLs are visible.
9460
9461 Upper case and lower case letters are synonymous in header names. If the
9462 following character is white space, the terminating colon may be omitted, but
9463 this is not recommended, because you may then forget it when it is needed. When
9464 white space terminates the header name, this white space is included in the
9465 expanded string.  If the message does not contain the given header, the
9466 expansion item is replaced by an empty string. (See the &%def%& condition in
9467 section &<<SECTexpcond>>& for a means of testing for the existence of a
9468 header.)
9469
9470 If there is more than one header with the same name, they are all concatenated
9471 to form the substitution string, up to a maximum length of 64K. Unless
9472 &%rheader%& is being used, leading and trailing white space is removed from
9473 each header before concatenation, and a completely empty header is ignored. A
9474 newline character is then inserted between non-empty headers, but there is no
9475 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9476 those headers that contain lists of addresses, a comma is also inserted at the
9477 junctions between headers. This does not happen for the &%rheader%& expansion.
9478
9479
9480 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9481 .cindex "expansion" "hmac hashing"
9482 .cindex &%hmac%&
9483 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9484 shared secret and some text into a message authentication code, as specified in
9485 RFC 2104. This differs from &`${md5:secret_text...}`& or
9486 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9487 cryptographic hash, allowing for authentication that is not possible with MD5
9488 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9489 present. For example:
9490 .code
9491 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9492 .endd
9493 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9494 produces:
9495 .code
9496 dd97e3ba5d1a61b5006108f8c8252953
9497 .endd
9498 As an example of how this might be used, you might put in the main part of
9499 an Exim configuration:
9500 .code
9501 SPAMSCAN_SECRET=cohgheeLei2thahw
9502 .endd
9503 In a router or a transport you could then have:
9504 .code
9505 headers_add = \
9506   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9507   ${hmac{md5}{SPAMSCAN_SECRET}\
9508   {${primary_hostname},${message_exim_id},$h_message-id:}}
9509 .endd
9510 Then given a message, you can check where it was scanned by looking at the
9511 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9512 this header line is authentic by recomputing the authentication code from the
9513 host name, message ID and the &'Message-id:'& header line. This can be done
9514 using Exim's &%-be%& option, or by other means, for example by using the
9515 &'hmac_md5_hex()'& function in Perl.
9516
9517
9518 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9519 .cindex "expansion" "conditional"
9520 .cindex "&%if%&, expansion item"
9521 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9522 item; otherwise <&'string2'&> is used. The available conditions are described
9523 in section &<<SECTexpcond>>& below. For example:
9524 .code
9525 ${if eq {$local_part}{postmaster} {yes}{no} }
9526 .endd
9527 The second string need not be present; if it is not and the condition is not
9528 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9529 be present instead of the second string (without any curly brackets). In this
9530 case, the expansion is forced to fail if the condition is not true (see section
9531 &<<SECTforexpfai>>&).
9532
9533 If both strings are omitted, the result is the string &`true`& if the condition
9534 is true, and the empty string if the condition is false. This makes it less
9535 cumbersome to write custom ACL and router conditions. For example, instead of
9536 .code
9537 condition = ${if >{$acl_m4}{3}{true}{false}}
9538 .endd
9539 you can use
9540 .code
9541 condition = ${if >{$acl_m4}{3}}
9542 .endd
9543
9544
9545
9546 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9547 .cindex expansion "imap folder"
9548 .cindex "&%imapfolder%& expansion item"
9549 This item converts a (possibly multilevel, or with non-ASCII characters)
9550 folder specification to a Maildir name for filesystem use.
9551 For information on internationalisation support see &<<SECTi18nMDA>>&.
9552
9553
9554
9555 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9556 .cindex "expansion" "string truncation"
9557 .cindex "&%length%& expansion item"
9558 The &%length%& item is used to extract the initial portion of a string. Both
9559 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9560 you are using a fixed value for the number, that is, if <&'string1'&> does not
9561 change when expanded, you can use the simpler operator notation that avoids
9562 some of the braces:
9563 .code
9564 ${length_<n>:<string>}
9565 .endd
9566 The result of this item is either the first <&'n'&> characters or the whole
9567 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9568 &%strlen%&, which gives the length of a string.
9569
9570
9571 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9572         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9573 .cindex "expansion" "extracting list elements by number"
9574 .cindex "&%listextract%&" "extract list elements by number"
9575 .cindex "list" "extracting elements by number"
9576 The <&'number'&> argument must consist entirely of decimal digits,
9577 apart from an optional leading minus,
9578 and leading and trailing white space (which is ignored).
9579
9580 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9581 default, but the separator can be changed in the usual way.
9582
9583 The first field of the list is numbered one.
9584 If the number is negative, the fields are
9585 counted from the end of the list, with the rightmost one numbered -1.
9586 The numbered element of the list is extracted and placed in &$value$&,
9587 then <&'string2'&> is expanded as the result.
9588
9589 If the modulus of the
9590 number is zero or greater than the number of fields in the string,
9591 the result is the expansion of <&'string3'&>.
9592
9593 For example:
9594 .code
9595 ${listextract{2}{x:42:99}}
9596 .endd
9597 yields &"42"&, and
9598 .code
9599 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9600 .endd
9601 yields &"result: 42"&.
9602
9603 If {<&'string3'&>} is omitted, an empty string is used for string3.
9604 If {<&'string2'&>} is also omitted, the value that was
9605 extracted is used.
9606 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9607
9608
9609 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9610         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9611 This is the first of one of two different types of lookup item, which are both
9612 described in the next item.
9613
9614 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9615         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9616 .cindex "expansion" "lookup in"
9617 .cindex "file" "lookups"
9618 .cindex "lookup" "in expanded string"
9619 The two forms of lookup item specify data lookups in files and databases, as
9620 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9621 lookups, and the second is used for query-style lookups. The <&'key'&>,
9622 <&'file'&>, and <&'query'&> strings are expanded before use.
9623
9624 If there is any white space in a lookup item which is part of a filter command,
9625 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9626 other place where white space is significant, the lookup item must be enclosed
9627 in double quotes. The use of data lookups in users' filter files may be locked
9628 out by the system administrator.
9629
9630 .vindex "&$value$&"
9631 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9632 During its expansion, the variable &$value$& contains the data returned by the
9633 lookup. Afterwards it reverts to the value it had previously (at the outer
9634 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9635 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9636 string on failure. If <&'string2'&> is provided, it can itself be a nested
9637 lookup, thus providing a mechanism for looking up a default value when the
9638 original lookup fails.
9639
9640 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9641 data for the outer lookup while the parameters of the second lookup are
9642 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9643 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9644 appear, and in this case, if the lookup fails, the entire expansion is forced
9645 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9646 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9647 successful lookup, and nothing in the case of failure.
9648
9649 For single-key lookups, the string &"partial"& is permitted to precede the
9650 search type in order to do partial matching, and * or *@ may follow a search
9651 type to request default lookups if the key does not match (see sections
9652 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9653
9654 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9655 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9656 and non-wild parts of the key during the expansion of the replacement text.
9657 They return to their previous values at the end of the lookup item.
9658
9659 This example looks up the postmaster alias in the conventional alias file:
9660 .code
9661 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9662 .endd
9663 This example uses NIS+ to look up the full name of the user corresponding to
9664 the local part of an address, forcing the expansion to fail if it is not found:
9665 .code
9666 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9667   {$value}fail}
9668 .endd
9669
9670
9671 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9672 .cindex "expansion" "list creation"
9673 .vindex "&$item$&"
9674 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9675 default, but the separator can be changed in the usual way. For each item
9676 in this list, its value is place in &$item$&, and then <&'string2'&> is
9677 expanded and added to the output as an item in a new list. The separator used
9678 for the output list is the same as the one used for the input, but a separator
9679 setting is not included in the output. For example:
9680 .code
9681 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9682 .endd
9683 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9684 value of &$item$& is restored to what it was before. See also the &*filter*&
9685 and &*reduce*& expansion items.
9686
9687 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9688 .cindex "expansion" "numeric hash"
9689 .cindex "hash function" "numeric"
9690 The three strings are expanded; the first two must yield numbers. Call them
9691 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9692 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9693 can use the simpler operator notation that avoids some of the braces:
9694 .code
9695 ${nhash_<n>_<m>:<string>}
9696 .endd
9697 The second number is optional (in both notations). If there is only one number,
9698 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9699 processed by a div/mod hash function that returns two numbers, separated by a
9700 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9701 example,
9702 .code
9703 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9704 .endd
9705 returns the string &"6/33"&.
9706
9707
9708
9709 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9710 .cindex "Perl" "use in expanded string"
9711 .cindex "expansion" "calling Perl from"
9712 This item is available only if Exim has been built to include an embedded Perl
9713 interpreter. The subroutine name and the arguments are first separately
9714 expanded, and then the Perl subroutine is called with those arguments. No
9715 additional arguments need be given; the maximum number permitted, including the
9716 name of the subroutine, is nine.
9717
9718 The return value of the subroutine is inserted into the expanded string, unless
9719 the return value is &%undef%&. In that case, the expansion fails in the same
9720 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9721 Whatever you return is evaluated in a scalar context. For example, if you
9722 return the name of a Perl vector, the return value is the size of the vector,
9723 not its contents.
9724
9725 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9726 with the error message that was passed to &%die%&. More details of the embedded
9727 Perl facility are given in chapter &<<CHAPperl>>&.
9728
9729 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9730 out the use of this expansion item in filter files.
9731
9732
9733 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9734 .cindex "&%prvs%& expansion item"
9735 The first argument is a complete email address and the second is secret
9736 keystring. The third argument, specifying a key number, is optional. If absent,
9737 it defaults to 0. The result of the expansion is a prvs-signed email address,
9738 to be typically used with the &%return_path%& option on an &(smtp)& transport
9739 as part of a bounce address tag validation (BATV) scheme. For more discussion
9740 and an example, see section &<<SECTverifyPRVS>>&.
9741
9742 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9743         {*&<&'string'&>&*}}*&"
9744 .cindex "&%prvscheck%& expansion item"
9745 This expansion item is the complement of the &%prvs%& item. It is used for
9746 checking prvs-signed addresses. If the expansion of the first argument does not
9747 yield a syntactically valid prvs-signed address, the whole item expands to the
9748 empty string. When the first argument does expand to a syntactically valid
9749 prvs-signed address, the second argument is expanded, with the prvs-decoded
9750 version of the address and the key number extracted from the address in the
9751 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9752
9753 These two variables can be used in the expansion of the second argument to
9754 retrieve the secret. The validity of the prvs-signed address is then checked
9755 against the secret. The result is stored in the variable &$prvscheck_result$&,
9756 which is empty for failure or &"1"& for success.
9757
9758 The third argument is optional; if it is missing, it defaults to an empty
9759 string. This argument is now expanded. If the result is an empty string, the
9760 result of the expansion is the decoded version of the address. This is the case
9761 whether or not the signature was valid. Otherwise, the result of the expansion
9762 is the expansion of the third argument.
9763
9764 All three variables can be used in the expansion of the third argument.
9765 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9766 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9767
9768 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9769 .cindex "expansion" "inserting an entire file"
9770 .cindex "file" "inserting into expansion"
9771 .cindex "&%readfile%& expansion item"
9772 The file name and end-of-line string are first expanded separately. The file is
9773 then read, and its contents replace the entire item. All newline characters in
9774 the file are replaced by the end-of-line string if it is present. Otherwise,
9775 newlines are left in the string.
9776 String expansion is not applied to the contents of the file. If you want this,
9777 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9778 the string expansion fails.
9779
9780 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9781 locks out the use of this expansion item in filter files.
9782
9783
9784
9785 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9786         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9787 .cindex "expansion" "inserting from a socket"
9788 .cindex "socket, use of in expansion"
9789 .cindex "&%readsocket%& expansion item"
9790 This item inserts data from a Unix domain or TCP socket into the expanded
9791 string. The minimal way of using it uses just two arguments, as in these
9792 examples:
9793 .code
9794 ${readsocket{/socket/name}{request string}}
9795 ${readsocket{inet:some.host:1234}{request string}}
9796 .endd
9797 For a Unix domain socket, the first substring must be the path to the socket.
9798 For an Internet socket, the first substring must contain &`inet:`& followed by
9799 a host name or IP address, followed by a colon and a port, which can be a
9800 number or the name of a TCP port in &_/etc/services_&. An IP address may
9801 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9802 example:
9803 .code
9804 ${readsocket{inet:[::1]:1234}{request string}}
9805 .endd
9806 Only a single host name may be given, but if looking it up yields more than
9807 one IP address, they are each tried in turn until a connection is made. For
9808 both kinds of socket, Exim makes a connection, writes the request string
9809 unless it is an empty string; and no terminating NUL is ever sent)
9810 and reads from the socket until an end-of-file
9811 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9812 extend what can be done. Firstly, you can vary the timeout. For example:
9813 .code
9814 ${readsocket{/socket/name}{request string}{3s}}
9815 .endd
9816 The third argument is a list of options, of which the first element is the timeout
9817 and must be present if the argument is given.
9818 Further elements are options of form &'name=value'&.
9819 One option type is currently recognised, defining whether (the default)
9820 or not a shutdown is done on the connection after sending the request.
9821 Example, to not do so (preferred, eg. by some webservers):
9822 .code
9823 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
9824 .endd
9825 A fourth argument allows you to change any newlines that are in the data
9826 that is read, in the same way as for &%readfile%& (see above). This example
9827 turns them into spaces:
9828 .code
9829 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9830 .endd
9831 As with all expansions, the substrings are expanded before the processing
9832 happens. Errors in these sub-expansions cause the expansion to fail. In
9833 addition, the following errors can occur:
9834
9835 .ilist
9836 Failure to create a socket file descriptor;
9837 .next
9838 Failure to connect the socket;
9839 .next
9840 Failure to write the request string;
9841 .next
9842 Timeout on reading from the socket.
9843 .endlist
9844
9845 By default, any of these errors causes the expansion to fail. However, if
9846 you supply a fifth substring, it is expanded and used when any of the above
9847 errors occurs. For example:
9848 .code
9849 ${readsocket{/socket/name}{request string}{3s}{\n}\
9850   {socket failure}}
9851 .endd
9852 You can test for the existence of a Unix domain socket by wrapping this
9853 expansion in &`${if exists`&, but there is a race condition between that test
9854 and the actual opening of the socket, so it is safer to use the fifth argument
9855 if you want to be absolutely sure of avoiding an expansion error for a
9856 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9857
9858 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9859 locks out the use of this expansion item in filter files.
9860
9861
9862 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9863 .cindex "expansion" "reducing a list to a scalar"
9864 .cindex "list" "reducing to a scalar"
9865 .vindex "&$value$&"
9866 .vindex "&$item$&"
9867 This operation reduces a list to a single, scalar string. After expansion,
9868 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9869 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9870 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9871 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9872 them. The result of that expansion is assigned to &$value$& before the next
9873 iteration. When the end of the list is reached, the final value of &$value$& is
9874 added to the expansion output. The &*reduce*& expansion item can be used in a
9875 number of ways. For example, to add up a list of numbers:
9876 .code
9877 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9878 .endd
9879 The result of that expansion would be &`6`&. The maximum of a list of numbers
9880 can be found:
9881 .code
9882 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9883 .endd
9884 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9885 restored to what they were before. See also the &*filter*& and &*map*&
9886 expansion items.
9887
9888 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9889 This item inserts &"raw"& header lines. It is described with the &%header%&
9890 expansion item above.
9891
9892 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9893         {*&<&'string2'&>&*}}*&"
9894 .cindex "expansion" "running a command"
9895 .cindex "&%run%& expansion item"
9896 The command and its arguments are first expanded as one string. The string is
9897 split apart into individual arguments by spaces, and then the command is run
9898 in a separate process, but under the same uid and gid.  As in other command
9899 executions from Exim, a shell is not used by default. If the command requires
9900 a shell, you must explicitly code it.
9901
9902 Since the arguments are split by spaces, when there is a variable expansion
9903 which has an empty result, it will cause the situation that the argument will
9904 simply be omitted when the program is actually executed by Exim. If the
9905 script/program requires a specific number of arguments and the expanded
9906 variable could possibly result in this empty expansion, the variable must be
9907 quoted. This is more difficult if the expanded variable itself could result
9908 in a string containing quotes, because it would interfere with the quotes
9909 around the command arguments. A possible guard against this is to wrap the
9910 variable in the &%sg%& operator to change any quote marks to some other
9911 character.
9912
9913 The standard input for the command exists, but is empty. The standard output
9914 and standard error are set to the same file descriptor.
9915 .cindex "return code" "from &%run%& expansion"
9916 .vindex "&$value$&"
9917 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9918 and replaces the entire item; during this expansion, the standard output/error
9919 from the command is in the variable &$value$&. If the command fails,
9920 <&'string2'&>, if present, is expanded and used. Once again, during the
9921 expansion, the standard output/error from the command is in the variable
9922 &$value$&.
9923
9924 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9925 can be the word &"fail"& (not in braces) to force expansion failure if the
9926 command does not succeed. If both strings are omitted, the result is contents
9927 of the standard output/error on success, and nothing on failure.
9928
9929 .vindex "&$run_in_acl$&"
9930 The standard output/error of the command is put in the variable &$value$&.
9931 In this ACL example, the output of a command is logged for the admin to
9932 troubleshoot:
9933 .code
9934 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9935       log_message  = Output of id: $value
9936 .endd
9937 If the command requires shell idioms, such as the > redirect operator, the
9938 shell must be invoked directly, such as with:
9939 .code
9940 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9941 .endd
9942
9943 .vindex "&$runrc$&"
9944 The return code from the command is put in the variable &$runrc$&, and this
9945 remains set afterwards, so in a filter file you can do things like this:
9946 .code
9947 if "${run{x y z}{}}$runrc" is 1 then ...
9948   elif $runrc is 2 then ...
9949   ...
9950 endif
9951 .endd
9952 If execution of the command fails (for example, the command does not exist),
9953 the return code is 127 &-- the same code that shells use for non-existent
9954 commands.
9955
9956 &*Warning*&: In a router or transport, you cannot assume the order in which
9957 option values are expanded, except for those preconditions whose order of
9958 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9959 by the expansion of one option, and use it in another.
9960
9961 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9962 out the use of this expansion item in filter files.
9963
9964
9965 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9966 .cindex "expansion" "string substitution"
9967 .cindex "&%sg%& expansion item"
9968 This item works like Perl's substitution operator (s) with the global (/g)
9969 option; hence its name. However, unlike the Perl equivalent, Exim does not
9970 modify the subject string; instead it returns the modified string for insertion
9971 into the overall expansion. The item takes three arguments: the subject string,
9972 a regular expression, and a substitution string. For example:
9973 .code
9974 ${sg{abcdefabcdef}{abc}{xyz}}
9975 .endd
9976 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9977 if any $ or \ characters are required in the regular expression or in the
9978 substitution string, they have to be escaped. For example:
9979 .code
9980 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9981 .endd
9982 yields &"defabc"&, and
9983 .code
9984 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9985 .endd
9986 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9987 the regular expression from string expansion.
9988
9989
9990
9991 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9992 .cindex sorting "a list"
9993 .cindex list sorting
9994 .cindex expansion "list sorting"
9995 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9996 default, but the separator can be changed in the usual way.
9997 The <&'comparator'&> argument is interpreted as the operator
9998 of a two-argument expansion condition.
9999 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10000 The comparison should return true when applied to two values
10001 if the first value should sort before the second value.
10002 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10003 the element being placed in &$item$&,
10004 to give values for comparison.
10005
10006 The item result is a sorted list,
10007 with the original list separator,
10008 of the list elements (in full) of the original.
10009
10010 Examples:
10011 .code
10012 ${sort{3:2:1:4}{<}{$item}}
10013 .endd
10014 sorts a list of numbers, and
10015 .code
10016 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10017 .endd
10018 will sort an MX lookup into priority order.
10019
10020
10021 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10022 .cindex "&%substr%& expansion item"
10023 .cindex "substring extraction"
10024 .cindex "expansion" "substring extraction"
10025 The three strings are expanded; the first two must yield numbers. Call them
10026 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10027 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10028 can use the simpler operator notation that avoids some of the braces:
10029 .code
10030 ${substr_<n>_<m>:<string>}
10031 .endd
10032 The second number is optional (in both notations).
10033 If it is absent in the simpler format, the preceding underscore must also be
10034 omitted.
10035
10036 The &%substr%& item can be used to extract more general substrings than
10037 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10038 length required. For example
10039 .code
10040 ${substr{3}{2}{$local_part}}
10041 .endd
10042 If the starting offset is greater than the string length the result is the
10043 null string; if the length plus starting offset is greater than the string
10044 length, the result is the right-hand part of the string, starting from the
10045 given offset. The first character in the string has offset zero.
10046
10047 The &%substr%& expansion item can take negative offset values to count
10048 from the right-hand end of its operand. The last character is offset -1, the
10049 second-last is offset -2, and so on. Thus, for example,
10050 .code
10051 ${substr{-5}{2}{1234567}}
10052 .endd
10053 yields &"34"&. If the absolute value of a negative offset is greater than the
10054 length of the string, the substring starts at the beginning of the string, and
10055 the length is reduced by the amount of overshoot. Thus, for example,
10056 .code
10057 ${substr{-5}{2}{12}}
10058 .endd
10059 yields an empty string, but
10060 .code
10061 ${substr{-3}{2}{12}}
10062 .endd
10063 yields &"1"&.
10064
10065 When the second number is omitted from &%substr%&, the remainder of the string
10066 is taken if the offset is positive. If it is negative, all characters in the
10067 string preceding the offset point are taken. For example, an offset of -1 and
10068 no length, as in these semantically identical examples:
10069 .code
10070 ${substr_-1:abcde}
10071 ${substr{-1}{abcde}}
10072 .endd
10073 yields all but the last character of the string, that is, &"abcd"&.
10074
10075
10076
10077 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10078         {*&<&'replacements'&>&*}}*&"
10079 .cindex "expansion" "character translation"
10080 .cindex "&%tr%& expansion item"
10081 This item does single-character translation on its subject string. The second
10082 argument is a list of characters to be translated in the subject string. Each
10083 matching character is replaced by the corresponding character from the
10084 replacement list. For example
10085 .code
10086 ${tr{abcdea}{ac}{13}}
10087 .endd
10088 yields &`1b3de1`&. If there are duplicates in the second character string, the
10089 last occurrence is used. If the third string is shorter than the second, its
10090 last character is replicated. However, if it is empty, no translation takes
10091 place.
10092 .endlist
10093
10094
10095
10096 .section "Expansion operators" "SECTexpop"
10097 .cindex "expansion" "operators"
10098 For expansion items that perform transformations on a single argument string,
10099 the &"operator"& notation is used because it is simpler and uses fewer braces.
10100 The substring is first expanded before the operation is applied to it. The
10101 following operations can be performed:
10102
10103 .vlist
10104 .vitem &*${address:*&<&'string'&>&*}*&
10105 .cindex "expansion" "RFC 2822 address handling"
10106 .cindex "&%address%& expansion item"
10107 The string is interpreted as an RFC 2822 address, as it might appear in a
10108 header line, and the effective address is extracted from it. If the string does
10109 not parse successfully, the result is empty.
10110
10111
10112 .vitem &*${addresses:*&<&'string'&>&*}*&
10113 .cindex "expansion" "RFC 2822 address handling"
10114 .cindex "&%addresses%& expansion item"
10115 The string (after expansion) is interpreted as a list of addresses in RFC
10116 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10117 operative address (&'local-part@domain'&) is extracted from each item, and the
10118 result of the expansion is a colon-separated list, with appropriate
10119 doubling of colons should any happen to be present in the email addresses.
10120 Syntactically invalid RFC2822 address items are omitted from the output.
10121
10122 It is possible to specify a character other than colon for the output
10123 separator by starting the string with > followed by the new separator
10124 character. For example:
10125 .code
10126 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10127 .endd
10128 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10129 expansion item, which extracts the working address from a single RFC2822
10130 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10131 processing lists.
10132
10133 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10134 a strict interpretation of header line formatting.  Exim parses the bare,
10135 unquoted portion of an email address and if it finds a comma, treats it as an
10136 email address separator. For the example header line:
10137 .code
10138 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10139 .endd
10140 The first example below demonstrates that Q-encoded email addresses are parsed
10141 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10142 It does not see the comma because it's still encoded as "=2C".  The second
10143 example below is passed the contents of &`$header_from:`&, meaning it gets
10144 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10145 The third example shows that the presence of a comma is skipped when it is
10146 quoted.
10147 .code
10148 # exim -be '${addresses:From: \
10149 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10150 user@example.com
10151 # exim -be '${addresses:From: Last, First <user@example.com>}'
10152 Last:user@example.com
10153 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10154 user@example.com
10155 .endd
10156
10157 .vitem &*${base32:*&<&'digits'&>&*}*&
10158 .cindex "&%base32%& expansion item"
10159 .cindex "expansion" "conversion to base 32"
10160 The string must consist entirely of decimal digits. The number is converted to
10161 base 32 and output as a (empty, for zero) string of characters.
10162 Only lowercase letters are used.
10163
10164 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10165 .cindex "&%base32d%& expansion item"
10166 .cindex "expansion" "conversion to base 32"
10167 The string must consist entirely of base-32 digits.
10168 The number is converted to decimal and output as a string.
10169
10170 .vitem &*${base62:*&<&'digits'&>&*}*&
10171 .cindex "&%base62%& expansion item"
10172 .cindex "expansion" "conversion to base 62"
10173 The string must consist entirely of decimal digits. The number is converted to
10174 base 62 and output as a string of six characters, including leading zeros. In
10175 the few operating environments where Exim uses base 36 instead of base 62 for
10176 its message identifiers (because those systems do not have case-sensitive file
10177 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10178 be absolutely clear: this is &'not'& base64 encoding.
10179
10180 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10181 .cindex "&%base62d%& expansion item"
10182 .cindex "expansion" "conversion to base 62"
10183 The string must consist entirely of base-62 digits, or, in operating
10184 environments where Exim uses base 36 instead of base 62 for its message
10185 identifiers, base-36 digits. The number is converted to decimal and output as a
10186 string.
10187
10188 .vitem &*${base64:*&<&'string'&>&*}*&
10189 .cindex "expansion" "base64 encoding"
10190 .cindex "base64 encoding" "in string expansion"
10191 .cindex "&%base64%& expansion item"
10192 .cindex certificate "base64 of DER"
10193 This operator converts a string into one that is base64 encoded.
10194
10195 If the string is a single variable of type certificate,
10196 returns the base64 encoding of the DER form of the certificate.
10197
10198
10199 .vitem &*${base64d:*&<&'string'&>&*}*&
10200 .cindex "expansion" "base64 decoding"
10201 .cindex "base64 decoding" "in string expansion"
10202 .cindex "&%base64d%& expansion item"
10203 This operator converts a base64-encoded string into the un-coded form.
10204
10205
10206 .vitem &*${domain:*&<&'string'&>&*}*&
10207 .cindex "domain" "extraction"
10208 .cindex "expansion" "domain extraction"
10209 The string is interpreted as an RFC 2822 address and the domain is extracted
10210 from it. If the string does not parse successfully, the result is empty.
10211
10212
10213 .vitem &*${escape:*&<&'string'&>&*}*&
10214 .cindex "expansion" "escaping non-printing characters"
10215 .cindex "&%escape%& expansion item"
10216 If the string contains any non-printing characters, they are converted to
10217 escape sequences starting with a backslash. Whether characters with the most
10218 significant bit set (so-called &"8-bit characters"&) count as printing or not
10219 is controlled by the &%print_topbitchars%& option.
10220
10221 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10222 .cindex "expansion" "escaping 8-bit characters"
10223 .cindex "&%escape8bit%& expansion item"
10224 If the string contains and characters with the most significant bit set,
10225 they are converted to escape sequences starting with a backslash.
10226 Backslashes and DEL characters are also converted.
10227
10228
10229 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10230 .cindex "expansion" "expression evaluation"
10231 .cindex "expansion" "arithmetic expression"
10232 .cindex "&%eval%& expansion item"
10233 These items supports simple arithmetic and bitwise logical operations in
10234 expansion strings. The string (after expansion) must be a conventional
10235 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10236 logical operators, and parentheses. All operations are carried out using
10237 integer arithmetic. The operator priorities are as follows (the same as in the
10238 C programming language):
10239 .table2 70pt 300pt
10240 .irow &'highest:'& "not (~), negate (-)"
10241 .irow ""   "multiply (*), divide (/), remainder (%)"
10242 .irow ""   "plus (+), minus (-)"
10243 .irow ""   "shift-left (<<), shift-right (>>)"
10244 .irow ""   "and (&&)"
10245 .irow ""   "xor (^)"
10246 .irow &'lowest:'&  "or (|)"
10247 .endtable
10248 Binary operators with the same priority are evaluated from left to right. White
10249 space is permitted before or after operators.
10250
10251 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10252 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10253 decimal, even if they start with a leading zero; hexadecimal numbers are not
10254 permitted. This can be useful when processing numbers extracted from dates or
10255 times, which often do have leading zeros.
10256
10257 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10258 or 1024*1024*1024,
10259 respectively. Negative numbers are supported. The result of the computation is
10260 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10261
10262 .display
10263 &`${eval:1+1}            `&  yields 2
10264 &`${eval:1+2*3}          `&  yields 7
10265 &`${eval:(1+2)*3}        `&  yields 9
10266 &`${eval:2+42%5}         `&  yields 4
10267 &`${eval:0xc&amp;5}          `&  yields 4
10268 &`${eval:0xc|5}          `&  yields 13
10269 &`${eval:0xc^5}          `&  yields 9
10270 &`${eval:0xc>>1}         `&  yields 6
10271 &`${eval:0xc<<1}         `&  yields 24
10272 &`${eval:~255&amp;0x1234}    `&  yields 4608
10273 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10274 .endd
10275
10276 As a more realistic example, in an ACL you might have
10277 .code
10278 deny   message = Too many bad recipients
10279        condition =                    \
10280          ${if and {                   \
10281            {>{$rcpt_count}{10}}       \
10282            {                          \
10283            <                          \
10284              {$recipients_count}      \
10285              {${eval:$rcpt_count/2}}  \
10286            }                          \
10287          }{yes}{no}}
10288 .endd
10289 The condition is true if there have been more than 10 RCPT commands and
10290 fewer than half of them have resulted in a valid recipient.
10291
10292
10293 .vitem &*${expand:*&<&'string'&>&*}*&
10294 .cindex "expansion" "re-expansion of substring"
10295 The &%expand%& operator causes a string to be expanded for a second time. For
10296 example,
10297 .code
10298 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10299 .endd
10300 first looks up a string in a file while expanding the operand for &%expand%&,
10301 and then re-expands what it has found.
10302
10303
10304 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10305 .cindex "Unicode"
10306 .cindex "UTF-8" "conversion from"
10307 .cindex "expansion" "UTF-8 conversion"
10308 .cindex "&%from_utf8%& expansion item"
10309 The world is slowly moving towards Unicode, although there are no standards for
10310 email yet. However, other applications (including some databases) are starting
10311 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10312 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10313 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10314 the result is an undefined sequence of bytes.
10315
10316 Unicode code points with values less than 256 are compatible with ASCII and
10317 ISO-8859-1 (also known as Latin-1).
10318 For example, character 169 is the copyright symbol in both cases, though the
10319 way it is encoded is different. In UTF-8, more than one byte is needed for
10320 characters with code values greater than 127, whereas ISO-8859-1 is a
10321 single-byte encoding (but thereby limited to 256 characters). This makes
10322 translation from UTF-8 to ISO-8859-1 straightforward.
10323
10324
10325 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10326 .cindex "hash function" "textual"
10327 .cindex "expansion" "textual hash"
10328 The &%hash%& operator is a simpler interface to the hashing function that can
10329 be used when the two parameters are fixed numbers (as opposed to strings that
10330 change when expanded). The effect is the same as
10331 .code
10332 ${hash{<n>}{<m>}{<string>}}
10333 .endd
10334 See the description of the general &%hash%& item above for details. The
10335 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10336
10337
10338
10339 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10340 .cindex "base64 encoding" "conversion from hex"
10341 .cindex "expansion" "hex to base64"
10342 .cindex "&%hex2b64%& expansion item"
10343 This operator converts a hex string into one that is base64 encoded. This can
10344 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10345
10346
10347
10348 .vitem &*${hexquote:*&<&'string'&>&*}*&
10349 .cindex "quoting" "hex-encoded unprintable characters"
10350 .cindex "&%hexquote%& expansion item"
10351 This operator converts non-printable characters in a string into a hex
10352 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10353 as is, and other byte values are converted to &`\xNN`&, for example a
10354 byte value 127 is converted to &`\x7f`&.
10355
10356
10357 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10358 .cindex "&%ipv6denorm%& expansion item"
10359 .cindex "IP address" normalisation
10360 This expands an IPv6 address to a full eight-element colon-separated set
10361 of hex digits including leading zeroes.
10362 A trailing ipv4-style dotted-decimal set is converted to hex.
10363 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10364
10365 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10366 .cindex "&%ipv6norm%& expansion item"
10367 .cindex "IP address" normalisation
10368 .cindex "IP address" "canonical form"
10369 This converts an IPv6 address to canonical form.
10370 Leading zeroes of groups are omitted, and the longest
10371 set of zero-valued groups is replaced with a double colon.
10372 A trailing ipv4-style dotted-decimal set is converted to hex.
10373 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10374
10375
10376 .vitem &*${lc:*&<&'string'&>&*}*&
10377 .cindex "case forcing in strings"
10378 .cindex "string" "case forcing"
10379 .cindex "lower casing"
10380 .cindex "expansion" "case forcing"
10381 .cindex "&%lc%& expansion item"
10382 This forces the letters in the string into lower-case, for example:
10383 .code
10384 ${lc:$local_part}
10385 .endd
10386
10387 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10388 .cindex "expansion" "string truncation"
10389 .cindex "&%length%& expansion item"
10390 The &%length%& operator is a simpler interface to the &%length%& function that
10391 can be used when the parameter is a fixed number (as opposed to a string that
10392 changes when expanded). The effect is the same as
10393 .code
10394 ${length{<number>}{<string>}}
10395 .endd
10396 See the description of the general &%length%& item above for details. Note that
10397 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10398 when &%length%& is used as an operator.
10399
10400
10401 .vitem &*${listcount:*&<&'string'&>&*}*&
10402 .cindex "expansion" "list item count"
10403 .cindex "list" "item count"
10404 .cindex "list" "count of items"
10405 .cindex "&%listcount%& expansion item"
10406 The string is interpreted as a list and the number of items is returned.
10407
10408
10409 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10410 .cindex "expansion" "named list"
10411 .cindex "&%listnamed%& expansion item"
10412 The name is interpreted as a named list and the content of the list is returned,
10413 expanding any referenced lists, re-quoting as needed for colon-separation.
10414 If the optional type is given it must be one of "a", "d", "h" or "l"
10415 and selects address-, domain-, host- or localpart- lists to search among respectively.
10416 Otherwise all types are searched in an undefined order and the first
10417 matching list is returned.
10418
10419
10420 .vitem &*${local_part:*&<&'string'&>&*}*&
10421 .cindex "expansion" "local part extraction"
10422 .cindex "&%local_part%& expansion item"
10423 The string is interpreted as an RFC 2822 address and the local part is
10424 extracted from it. If the string does not parse successfully, the result is
10425 empty.
10426
10427
10428 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10429 .cindex "masked IP address"
10430 .cindex "IP address" "masking"
10431 .cindex "CIDR notation"
10432 .cindex "expansion" "IP address masking"
10433 .cindex "&%mask%& expansion item"
10434 If the form of the string to be operated on is not an IP address followed by a
10435 slash and an integer (that is, a network address in CIDR notation), the
10436 expansion fails. Otherwise, this operator converts the IP address to binary,
10437 masks off the least significant bits according to the bit count, and converts
10438 the result back to text, with mask appended. For example,
10439 .code
10440 ${mask:10.111.131.206/28}
10441 .endd
10442 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10443 be mostly used for looking up masked addresses in files, the result for an IPv6
10444 address uses dots to separate components instead of colons, because colon
10445 terminates a key string in lsearch files. So, for example,
10446 .code
10447 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10448 .endd
10449 returns the string
10450 .code
10451 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10452 .endd
10453 Letters in IPv6 addresses are always output in lower case.
10454
10455
10456 .vitem &*${md5:*&<&'string'&>&*}*&
10457 .cindex "MD5 hash"
10458 .cindex "expansion" "MD5 hash"
10459 .cindex certificate fingerprint
10460 .cindex "&%md5%& expansion item"
10461 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10462 as a 32-digit hexadecimal number, in which any letters are in lower case.
10463
10464 If the string is a single variable of type certificate,
10465 returns the MD5 hash fingerprint of the certificate.
10466
10467
10468 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10469 .cindex "expansion" "numeric hash"
10470 .cindex "hash function" "numeric"
10471 The &%nhash%& operator is a simpler interface to the numeric hashing function
10472 that can be used when the two parameters are fixed numbers (as opposed to
10473 strings that change when expanded). The effect is the same as
10474 .code
10475 ${nhash{<n>}{<m>}{<string>}}
10476 .endd
10477 See the description of the general &%nhash%& item above for details.
10478
10479
10480 .vitem &*${quote:*&<&'string'&>&*}*&
10481 .cindex "quoting" "in string expansions"
10482 .cindex "expansion" "quoting"
10483 .cindex "&%quote%& expansion item"
10484 The &%quote%& operator puts its argument into double quotes if it
10485 is an empty string or
10486 contains anything other than letters, digits, underscores, dots, and hyphens.
10487 Any occurrences of double quotes and backslashes are escaped with a backslash.
10488 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10489 respectively For example,
10490 .code
10491 ${quote:ab"*"cd}
10492 .endd
10493 becomes
10494 .code
10495 "ab\"*\"cd"
10496 .endd
10497 The place where this is useful is when the argument is a substitution from a
10498 variable or a message header.
10499
10500 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10501 .cindex "&%quote_local_part%& expansion item"
10502 This operator is like &%quote%&, except that it quotes the string only if
10503 required to do so by the rules of RFC 2822 for quoting local parts. For
10504 example, a plus sign would not cause quoting (but it would for &%quote%&).
10505 If you are creating a new email address from the contents of &$local_part$&
10506 (or any other unknown data), you should always use this operator.
10507
10508
10509 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10510 .cindex "quoting" "lookup-specific"
10511 This operator applies lookup-specific quoting rules to the string. Each
10512 query-style lookup type has its own quoting rules which are described with
10513 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10514 .code
10515 ${quote_ldap:two * two}
10516 .endd
10517 returns
10518 .code
10519 two%20%5C2A%20two
10520 .endd
10521 For single-key lookup types, no quoting is ever necessary and this operator
10522 yields an unchanged string.
10523
10524
10525 .vitem &*${randint:*&<&'n'&>&*}*&
10526 .cindex "random number"
10527 This operator returns a somewhat random number which is less than the
10528 supplied number and is at least 0.  The quality of this randomness depends
10529 on how Exim was built; the values are not suitable for keying material.
10530 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10531 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10532 for versions of GnuTLS with that function.
10533 Otherwise, the implementation may be arc4random(), random() seeded by
10534 srandomdev() or srandom(), or a custom implementation even weaker than
10535 random().
10536
10537
10538 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10539 .cindex "expansion" "IP address"
10540 This operator reverses an IP address; for IPv4 addresses, the result is in
10541 dotted-quad decimal form, while for IPv6 addresses the result is in
10542 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10543 for DNS.  For example,
10544 .code
10545 ${reverse_ip:192.0.2.4}
10546 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10547 .endd
10548 returns
10549 .code
10550 4.2.0.192
10551 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
10552 .endd
10553
10554
10555 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10556 .cindex "expansion" "RFC 2047"
10557 .cindex "RFC 2047" "expansion operator"
10558 .cindex "&%rfc2047%& expansion item"
10559 This operator encodes text according to the rules of RFC 2047. This is an
10560 encoding that is used in header lines to encode non-ASCII characters. It is
10561 assumed that the input string is in the encoding specified by the
10562 &%headers_charset%& option, which gets its default at build time. If the string
10563 contains only characters in the range 33&--126, and no instances of the
10564 characters
10565 .code
10566 ? = ( ) < > @ , ; : \ " . [ ] _
10567 .endd
10568 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10569 string, using as many &"encoded words"& as necessary to encode all the
10570 characters.
10571
10572
10573 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10574 .cindex "expansion" "RFC 2047"
10575 .cindex "RFC 2047" "decoding"
10576 .cindex "&%rfc2047d%& expansion item"
10577 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10578 bytes are replaced by question marks. Characters are converted into the
10579 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10580 not recognized unless &%check_rfc2047_length%& is set false.
10581
10582 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10583 access a header line, RFC 2047 decoding is done automatically. You do not need
10584 to use this operator as well.
10585
10586
10587
10588 .vitem &*${rxquote:*&<&'string'&>&*}*&
10589 .cindex "quoting" "in regular expressions"
10590 .cindex "regular expressions" "quoting"
10591 .cindex "&%rxquote%& expansion item"
10592 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10593 characters in its argument. This is useful when substituting the values of
10594 variables or headers inside regular expressions.
10595
10596
10597 .vitem &*${sha1:*&<&'string'&>&*}*&
10598 .cindex "SHA-1 hash"
10599 .cindex "expansion" "SHA-1 hashing"
10600 .cindex certificate fingerprint
10601 .cindex "&%sha1%& expansion item"
10602 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10603 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10604
10605 If the string is a single variable of type certificate,
10606 returns the SHA-1 hash fingerprint of the certificate.
10607
10608
10609 .vitem &*${sha256:*&<&'string'&>&*}*&
10610 .cindex "SHA-256 hash"
10611 .cindex certificate fingerprint
10612 .cindex "expansion" "SHA-256 hashing"
10613 .cindex "&%sha256%& expansion item"
10614 The &%sha256%& operator computes the SHA-256 hash value of the string
10615 and returns
10616 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10617
10618 If the string is a single variable of type certificate,
10619 returns the SHA-256 hash fingerprint of the certificate.
10620
10621
10622 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10623        &*${sha3_<n>:*&<&'string'&>&*}*&
10624 .cindex "SHA3 hash"
10625 .cindex "expansion" "SHA3 hashing"
10626 .cindex "&%sha3%& expansion item"
10627 The &%sha3%& operator computes the SHA3-256 hash value of the string
10628 and returns
10629 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10630
10631 If a number is appended, separated by an underbar, it specifies
10632 the output length.  Values of 224, 256, 384 and 512 are accepted;
10633 with 256 being the default.
10634
10635 The &%sha3%& expansion item is only supported if Exim has been
10636 compiled with GnuTLS 3.5.0 or later.
10637
10638
10639 .vitem &*${stat:*&<&'string'&>&*}*&
10640 .cindex "expansion" "statting a file"
10641 .cindex "file" "extracting characteristics"
10642 .cindex "&%stat%& expansion item"
10643 The string, after expansion, must be a file path. A call to the &[stat()]&
10644 function is made for this path. If &[stat()]& fails, an error occurs and the
10645 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10646 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10647 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10648 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10649 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10650 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10651 can extract individual fields using the &%extract%& expansion item.
10652
10653 The use of the &%stat%& expansion in users' filter files can be locked out by
10654 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10655 systems for files larger than 2GB.
10656
10657 .vitem &*${str2b64:*&<&'string'&>&*}*&
10658 .cindex "&%str2b64%& expansion item"
10659 Now deprecated, a synonym for the &%base64%& expansion operator.
10660
10661
10662
10663 .vitem &*${strlen:*&<&'string'&>&*}*&
10664 .cindex "expansion" "string length"
10665 .cindex "string" "length in expansion"
10666 .cindex "&%strlen%& expansion item"
10667 The item is replace by the length of the expanded string, expressed as a
10668 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10669
10670
10671 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10672 .cindex "&%substr%& expansion item"
10673 .cindex "substring extraction"
10674 .cindex "expansion" "substring expansion"
10675 The &%substr%& operator is a simpler interface to the &%substr%& function that
10676 can be used when the two parameters are fixed numbers (as opposed to strings
10677 that change when expanded). The effect is the same as
10678 .code
10679 ${substr{<start>}{<length>}{<string>}}
10680 .endd
10681 See the description of the general &%substr%& item above for details. The
10682 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10683
10684 .vitem &*${time_eval:*&<&'string'&>&*}*&
10685 .cindex "&%time_eval%& expansion item"
10686 .cindex "time interval" "decoding"
10687 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10688 seconds.
10689
10690 .vitem &*${time_interval:*&<&'string'&>&*}*&
10691 .cindex "&%time_interval%& expansion item"
10692 .cindex "time interval" "formatting"
10693 The argument (after sub-expansion) must be a sequence of decimal digits that
10694 represents an interval of time as a number of seconds. It is converted into a
10695 number of larger units and output in Exim's normal time format, for example,
10696 &`1w3d4h2m6s`&.
10697
10698 .vitem &*${uc:*&<&'string'&>&*}*&
10699 .cindex "case forcing in strings"
10700 .cindex "string" "case forcing"
10701 .cindex "upper casing"
10702 .cindex "expansion" "case forcing"
10703 .cindex "&%uc%& expansion item"
10704 This forces the letters in the string into upper-case.
10705
10706 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10707 .cindex "correction of invalid utf-8 sequences in strings"
10708 .cindex "utf-8" "utf-8 sequences"
10709 .cindex "incorrect utf-8"
10710 .cindex "expansion" "utf-8 forcing"
10711 .cindex "&%utf8clean%& expansion item"
10712 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10713
10714 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10715        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10716        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10717        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10718 .cindex expansion UTF-8
10719 .cindex UTF-8 expansion
10720 .cindex EAI
10721 .cindex internationalisation
10722 .cindex "&%utf8_domain_to_alabel%& expansion item"
10723 .cindex "&%utf8_domain_from_alabel%& expansion item"
10724 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10725 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10726 These convert EAI mail name components between UTF-8 and a-label forms.
10727 For information on internationalisation support see &<<SECTi18nMTA>>&.
10728 .endlist
10729
10730
10731
10732
10733
10734
10735 .section "Expansion conditions" "SECTexpcond"
10736 .scindex IIDexpcond "expansion" "conditions"
10737 The following conditions are available for testing by the &%${if%& construct
10738 while expanding strings:
10739
10740 .vlist
10741 .vitem &*!*&<&'condition'&>
10742 .cindex "expansion" "negating a condition"
10743 .cindex "negation" "in expansion condition"
10744 Preceding any condition with an exclamation mark negates the result of the
10745 condition.
10746
10747 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10748 .cindex "numeric comparison"
10749 .cindex "expansion" "numeric comparison"
10750 There are a number of symbolic operators for doing numeric comparisons. They
10751 are:
10752 .display
10753 &`=   `&   equal
10754 &`==  `&   equal
10755 &`>   `&   greater
10756 &`>=  `&   greater or equal
10757 &`<   `&   less
10758 &`<=  `&   less or equal
10759 .endd
10760 For example:
10761 .code
10762 ${if >{$message_size}{10M} ...
10763 .endd
10764 Note that the general negation operator provides for inequality testing. The
10765 two strings must take the form of optionally signed decimal integers,
10766 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10767 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10768 As a special case, the numerical value of an empty string is taken as
10769 zero.
10770
10771 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10772 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10773 10M, not if 10M is larger than &$message_size$&.
10774
10775
10776 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10777         {*&<&'arg2'&>&*}...}*&
10778 .cindex "expansion" "calling an acl"
10779 .cindex "&%acl%&" "expansion condition"
10780 The name and zero to nine argument strings are first expanded separately.  The expanded
10781 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10782 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10783 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10784 and may use the variables; if another acl expansion is used the values
10785 are restored after it returns.  If the ACL sets
10786 a value using a "message =" modifier the variable $value becomes
10787 the result of the expansion, otherwise it is empty.
10788 If the ACL returns accept the condition is true; if deny, false.
10789 If the ACL returns defer the result is a forced-fail.
10790
10791 .vitem &*bool&~{*&<&'string'&>&*}*&
10792 .cindex "expansion" "boolean parsing"
10793 .cindex "&%bool%& expansion condition"
10794 This condition turns a string holding a true or false representation into
10795 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10796 (case-insensitively); also integer numbers map to true if non-zero,
10797 false if zero.
10798 An empty string is treated as false.
10799 Leading and trailing whitespace is ignored;
10800 thus a string consisting only of whitespace is false.
10801 All other string values will result in expansion failure.
10802
10803 When combined with ACL variables, this expansion condition will let you
10804 make decisions in one place and act on those decisions in another place.
10805 For example:
10806 .code
10807 ${if bool{$acl_m_privileged_sender} ...
10808 .endd
10809
10810
10811 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10812 .cindex "expansion" "boolean parsing"
10813 .cindex "&%bool_lax%& expansion condition"
10814 Like &%bool%&, this condition turns a string into a boolean state.  But
10815 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10816 loose definition that the Router &%condition%& option uses.  The empty string
10817 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10818 true.  Leading and trailing whitespace is ignored.
10819
10820 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10821
10822 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10823 .cindex "expansion" "encrypted comparison"
10824 .cindex "encrypted strings, comparing"
10825 .cindex "&%crypteq%& expansion condition"
10826 This condition is included in the Exim binary if it is built to support any
10827 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10828 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10829 included in the binary.
10830
10831 The &%crypteq%& condition has two arguments. The first is encrypted and
10832 compared against the second, which is already encrypted. The second string may
10833 be in the LDAP form for storing encrypted strings, which starts with the
10834 encryption type in curly brackets, followed by the data. If the second string
10835 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10836 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10837 Typically this will be a field from a password file. An example of an encrypted
10838 string in LDAP form is:
10839 .code
10840 {md5}CY9rzUYh03PK3k6DJie09g==
10841 .endd
10842 If such a string appears directly in an expansion, the curly brackets have to
10843 be quoted, because they are part of the expansion syntax. For example:
10844 .code
10845 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10846 .endd
10847 The following encryption types (whose names are matched case-independently) are
10848 supported:
10849
10850 .ilist
10851 .cindex "MD5 hash"
10852 .cindex "base64 encoding" "in encrypted password"
10853 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10854 printable characters to compare with the remainder of the second string. If the
10855 length of the comparison string is 24, Exim assumes that it is base64 encoded
10856 (as in the above example). If the length is 32, Exim assumes that it is a
10857 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10858 comparison fails.
10859
10860 .next
10861 .cindex "SHA-1 hash"
10862 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10863 printable characters to compare with the remainder of the second string. If the
10864 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10865 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10866 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10867
10868 .next
10869 .cindex "&[crypt()]&"
10870 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10871 only the first eight characters of the password. However, in modern operating
10872 systems this is no longer true, and in many cases the entire password is used,
10873 whatever its length.
10874
10875 .next
10876 .cindex "&[crypt16()]&"
10877 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10878 use up to 16 characters of the password in some operating systems. Again, in
10879 modern operating systems, more characters may be used.
10880 .endlist
10881 Exim has its own version of &[crypt16()]&, which is just a double call to
10882 &[crypt()]&. For operating systems that have their own version, setting
10883 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10884 operating system version instead of its own. This option is set by default in
10885 the OS-dependent &_Makefile_& for those operating systems that are known to
10886 support &[crypt16()]&.
10887
10888 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10889 it was not using the same algorithm as some operating systems' versions. It
10890 turns out that as well as &[crypt16()]& there is a function called
10891 &[bigcrypt()]& in some operating systems. This may or may not use the same
10892 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10893
10894 However, since there is now a move away from the traditional &[crypt()]&
10895 functions towards using SHA1 and other algorithms, tidying up this area of
10896 Exim is seen as very low priority.
10897
10898 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10899 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10900 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10901 default is &`{crypt}`&. Whatever the default, you can always use either
10902 function by specifying it explicitly in curly brackets.
10903
10904 .vitem &*def:*&<&'variable&~name'&>
10905 .cindex "expansion" "checking for empty variable"
10906 .cindex "&%def%& expansion condition"
10907 The &%def%& condition must be followed by the name of one of the expansion
10908 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10909 variable does not contain the empty string. For example:
10910 .code
10911 ${if def:sender_ident {from $sender_ident}}
10912 .endd
10913 Note that the variable name is given without a leading &%$%& character. If the
10914 variable does not exist, the expansion fails.
10915
10916 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10917         &~&*def:h_*&<&'header&~name'&>&*:*&"
10918 .cindex "expansion" "checking header line existence"
10919 This condition is true if a message is being processed and the named header
10920 exists in the message. For example,
10921 .code
10922 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10923 .endd
10924 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10925 the header name must be terminated by a colon if white space does not follow.
10926
10927 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10928        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10929 .cindex "string" "comparison"
10930 .cindex "expansion" "string comparison"
10931 .cindex "&%eq%& expansion condition"
10932 .cindex "&%eqi%& expansion condition"
10933 The two substrings are first expanded. The condition is true if the two
10934 resulting strings are identical. For &%eq%& the comparison includes the case of
10935 letters, whereas for &%eqi%& the comparison is case-independent.
10936
10937 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10938 .cindex "expansion" "file existence test"
10939 .cindex "file" "existence test"
10940 .cindex "&%exists%&, expansion condition"
10941 The substring is first expanded and then interpreted as an absolute path. The
10942 condition is true if the named file (or directory) exists. The existence test
10943 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10944 users' filter files may be locked out by the system administrator.
10945
10946 .vitem &*first_delivery*&
10947 .cindex "delivery" "first"
10948 .cindex "first delivery"
10949 .cindex "expansion" "first delivery test"
10950 .cindex "&%first_delivery%& expansion condition"
10951 This condition, which has no data, is true during a message's first delivery
10952 attempt. It is false during any subsequent delivery attempts.
10953
10954
10955 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10956        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10957 .cindex "list" "iterative conditions"
10958 .cindex "expansion" "&*forall*& condition"
10959 .cindex "expansion" "&*forany*& condition"
10960 .vindex "&$item$&"
10961 These conditions iterate over a list. The first argument is expanded to form
10962 the list. By default, the list separator is a colon, but it can be changed by
10963 the normal method. The second argument is interpreted as a condition that is to
10964 be applied to each item in the list in turn. During the interpretation of the
10965 condition, the current list item is placed in a variable called &$item$&.
10966 .ilist
10967 For &*forany*&, interpretation stops if the condition is true for any item, and
10968 the result of the whole condition is true. If the condition is false for all
10969 items in the list, the overall condition is false.
10970 .next
10971 For &*forall*&, interpretation stops if the condition is false for any item,
10972 and the result of the whole condition is false. If the condition is true for
10973 all items in the list, the overall condition is true.
10974 .endlist
10975 Note that negation of &*forany*& means that the condition must be false for all
10976 items for the overall condition to succeed, and negation of &*forall*& means
10977 that the condition must be false for at least one item. In this example, the
10978 list separator is changed to a comma:
10979 .code
10980 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10981 .endd
10982 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10983 being processed, to enable these expansion items to be nested.
10984
10985 To scan a named list, expand it with the &*listnamed*& operator.
10986
10987
10988 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10989        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10990 .cindex "string" "comparison"
10991 .cindex "expansion" "string comparison"
10992 .cindex "&%ge%& expansion condition"
10993 .cindex "&%gei%& expansion condition"
10994 The two substrings are first expanded. The condition is true if the first
10995 string is lexically greater than or equal to the second string. For &%ge%& the
10996 comparison includes the case of letters, whereas for &%gei%& the comparison is
10997 case-independent.
10998
10999 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11000        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11001 .cindex "string" "comparison"
11002 .cindex "expansion" "string comparison"
11003 .cindex "&%gt%& expansion condition"
11004 .cindex "&%gti%& expansion condition"
11005 The two substrings are first expanded. The condition is true if the first
11006 string is lexically greater than the second string. For &%gt%& the comparison
11007 includes the case of letters, whereas for &%gti%& the comparison is
11008 case-independent.
11009
11010 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11011        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11012 .cindex "string" "comparison"
11013 .cindex "list" "iterative conditions"
11014 Both strings are expanded; the second string is treated as a list of simple
11015 strings; if the first string is a member of the second, then the condition
11016 is true.
11017
11018 These are simpler to use versions of the more powerful &*forany*& condition.
11019 Examples, and the &*forany*& equivalents:
11020 .code
11021 ${if inlist{needle}{foo:needle:bar}}
11022   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11023 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11024   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11025 .endd
11026
11027 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11028        &*isip4&~{*&<&'string'&>&*}*& &&&
11029        &*isip6&~{*&<&'string'&>&*}*&
11030 .cindex "IP address" "testing string format"
11031 .cindex "string" "testing for IP address"
11032 .cindex "&%isip%& expansion condition"
11033 .cindex "&%isip4%& expansion condition"
11034 .cindex "&%isip6%& expansion condition"
11035 The substring is first expanded, and then tested to see if it has the form of
11036 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11037 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11038
11039 For an IPv4 address, the test is for four dot-separated components, each of
11040 which consists of from one to three digits. For an IPv6 address, up to eight
11041 colon-separated components are permitted, each containing from one to four
11042 hexadecimal digits. There may be fewer than eight components if an empty
11043 component (adjacent colons) is present. Only one empty component is permitted.
11044
11045 .new
11046 &*Note*&: The checks used to be just on the form of the address; actual numerical
11047 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11048 check.
11049 This is no longer the case.
11050 .wen
11051
11052 The main use of these tests is to distinguish between IP addresses and
11053 host names, or between IPv4 and IPv6 addresses. For example, you could use
11054 .code
11055 ${if isip4{$sender_host_address}...
11056 .endd
11057 to test which IP version an incoming SMTP connection is using.
11058
11059 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11060 .cindex "LDAP" "use for authentication"
11061 .cindex "expansion" "LDAP authentication test"
11062 .cindex "&%ldapauth%& expansion condition"
11063 This condition supports user authentication using LDAP. See section
11064 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11065 queries. For this use, the query must contain a user name and password. The
11066 query itself is not used, and can be empty. The condition is true if the
11067 password is not empty, and the user name and password are accepted by the LDAP
11068 server. An empty password is rejected without calling LDAP because LDAP binds
11069 with an empty password are considered anonymous regardless of the username, and
11070 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11071 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11072 this can be used.
11073
11074
11075 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11076        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11077 .cindex "string" "comparison"
11078 .cindex "expansion" "string comparison"
11079 .cindex "&%le%& expansion condition"
11080 .cindex "&%lei%& expansion condition"
11081 The two substrings are first expanded. The condition is true if the first
11082 string is lexically less than or equal to the second string. For &%le%& the
11083 comparison includes the case of letters, whereas for &%lei%& the comparison is
11084 case-independent.
11085
11086 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11087        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11088 .cindex "string" "comparison"
11089 .cindex "expansion" "string comparison"
11090 .cindex "&%lt%& expansion condition"
11091 .cindex "&%lti%& expansion condition"
11092 The two substrings are first expanded. The condition is true if the first
11093 string is lexically less than the second string. For &%lt%& the comparison
11094 includes the case of letters, whereas for &%lti%& the comparison is
11095 case-independent.
11096
11097
11098 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11099 .cindex "expansion" "regular expression comparison"
11100 .cindex "regular expressions" "match in expanded string"
11101 .cindex "&%match%& expansion condition"
11102 The two substrings are first expanded. The second is then treated as a regular
11103 expression and applied to the first. Because of the pre-expansion, if the
11104 regular expression contains dollar, or backslash characters, they must be
11105 escaped. Care must also be taken if the regular expression contains braces
11106 (curly brackets). A closing brace must be escaped so that it is not taken as a
11107 premature termination of <&'string2'&>. The easiest approach is to use the
11108 &`\N`& feature to disable expansion of the regular expression.
11109 For example,
11110 .code
11111 ${if match {$local_part}{\N^\d{3}\N} ...
11112 .endd
11113 If the whole expansion string is in double quotes, further escaping of
11114 backslashes is also required.
11115
11116 The condition is true if the regular expression match succeeds.
11117 The regular expression is not required to begin with a circumflex
11118 metacharacter, but if there is no circumflex, the expression is not anchored,
11119 and it may match anywhere in the subject, not just at the start. If you want
11120 the pattern to match at the end of the subject, you must include the &`$`&
11121 metacharacter at an appropriate point.
11122
11123 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11124 At the start of an &%if%& expansion the values of the numeric variable
11125 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11126 succeeds causes them to be reset to the substrings of that condition and they
11127 will have these values during the expansion of the success string. At the end
11128 of the &%if%& expansion, the previous values are restored. After testing a
11129 combination of conditions using &%or%&, the subsequent values of the numeric
11130 variables are those of the condition that succeeded.
11131
11132 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11133 .cindex "&%match_address%& expansion condition"
11134 See &*match_local_part*&.
11135
11136 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11137 .cindex "&%match_domain%& expansion condition"
11138 See &*match_local_part*&.
11139
11140 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11141 .cindex "&%match_ip%& expansion condition"
11142 This condition matches an IP address to a list of IP address patterns. It must
11143 be followed by two argument strings. The first (after expansion) must be an IP
11144 address or an empty string. The second (not expanded) is a restricted host
11145 list that can match only an IP address, not a host name. For example:
11146 .code
11147 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11148 .endd
11149 The specific types of host list item that are permitted in the list are:
11150
11151 .ilist
11152 An IP address, optionally with a CIDR mask.
11153 .next
11154 A single asterisk, which matches any IP address.
11155 .next
11156 An empty item, which matches only if the IP address is empty. This could be
11157 useful for testing for a locally submitted message or one from specific hosts
11158 in a single test such as
11159 . ==== As this is a nested list, any displays it contains must be indented
11160 . ==== as otherwise they are too far to the left. This comment applies to
11161 . ==== the use of xmlto plus fop. There's no problem when formatting with
11162 . ==== sdop, with or without the extra indent.
11163 .code
11164   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11165 .endd
11166 where the first item in the list is the empty string.
11167 .next
11168 The item @[] matches any of the local host's interface addresses.
11169 .next
11170 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11171 even if &`net-`& is not specified. There is never any attempt to turn the IP
11172 address into a host name. The most common type of linear search for
11173 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11174 masks. For example:
11175 .code
11176   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11177 .endd
11178 It is of course possible to use other kinds of lookup, and in such a case, you
11179 do need to specify the &`net-`& prefix if you want to specify a specific
11180 address mask, for example:
11181 .code
11182   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11183 .endd
11184 However, unless you are combining a &%match_ip%& condition with others, it is
11185 just as easy to use the fact that a lookup is itself a condition, and write:
11186 .code
11187   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11188 .endd
11189 .endlist ilist
11190
11191 Note that <&'string2'&> is not itself subject to string expansion, unless
11192 Exim was built with the EXPAND_LISTMATCH_RHS option.
11193
11194 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11195
11196 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11197 .cindex "domain list" "in expansion condition"
11198 .cindex "address list" "in expansion condition"
11199 .cindex "local part" "list, in expansion condition"
11200 .cindex "&%match_local_part%& expansion condition"
11201 This condition, together with &%match_address%& and &%match_domain%&, make it
11202 possible to test domain, address, and local part lists within expansions. Each
11203 condition requires two arguments: an item and a list to match. A trivial
11204 example is:
11205 .code
11206 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11207 .endd
11208 In each case, the second argument may contain any of the allowable items for a
11209 list of the appropriate type. Also, because the second argument (after
11210 expansion) is a standard form of list, it is possible to refer to a named list.
11211 Thus, you can use conditions like this:
11212 .code
11213 ${if match_domain{$domain}{+local_domains}{...
11214 .endd
11215 .cindex "&`+caseful`&"
11216 For address lists, the matching starts off caselessly, but the &`+caseful`&
11217 item can be used, as in all address lists, to cause subsequent items to
11218 have their local parts matched casefully. Domains are always matched
11219 caselessly.
11220
11221 Note that <&'string2'&> is not itself subject to string expansion, unless
11222 Exim was built with the EXPAND_LISTMATCH_RHS option.
11223
11224 &*Note*&: Host lists are &'not'& supported in this way. This is because
11225 hosts have two identities: a name and an IP address, and it is not clear
11226 how to specify cleanly how such a test would work. However, IP addresses can be
11227 matched using &%match_ip%&.
11228
11229 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11230 .cindex "PAM authentication"
11231 .cindex "AUTH" "with PAM"
11232 .cindex "Solaris" "PAM support"
11233 .cindex "expansion" "PAM authentication test"
11234 .cindex "&%pam%& expansion condition"
11235 &'Pluggable Authentication Modules'&
11236 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11237 available in the latest releases of Solaris and in some GNU/Linux
11238 distributions. The Exim support, which is intended for use in conjunction with
11239 the SMTP AUTH command, is available only if Exim is compiled with
11240 .code
11241 SUPPORT_PAM=yes
11242 .endd
11243 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11244 in some releases of GNU/Linux &%-ldl%& is also needed.
11245
11246 The argument string is first expanded, and the result must be a
11247 colon-separated list of strings. Leading and trailing white space is ignored.
11248 The PAM module is initialized with the service name &"exim"& and the user name
11249 taken from the first item in the colon-separated data string (<&'string1'&>).
11250 The remaining items in the data string are passed over in response to requests
11251 from the authentication function. In the simple case there will only be one
11252 request, for a password, so the data consists of just two strings.
11253
11254 There can be problems if any of the strings are permitted to contain colon
11255 characters. In the usual way, these have to be doubled to avoid being taken as
11256 separators. If the data is being inserted from a variable, the &%sg%& expansion
11257 item can be used to double any existing colons. For example, the configuration
11258 of a LOGIN authenticator might contain this setting:
11259 .code
11260 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11261 .endd
11262 For a PLAIN authenticator you could use:
11263 .code
11264 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11265 .endd
11266 In some operating systems, PAM authentication can be done only from a process
11267 running as root. Since Exim is running as the Exim user when receiving
11268 messages, this means that PAM cannot be used directly in those systems.
11269 A patched version of the &'pam_unix'& module that comes with the
11270 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11271 The patched module allows one special uid/gid combination, in addition to root,
11272 to authenticate. If you build the patched module to allow the Exim user and
11273 group, PAM can then be used from an Exim authenticator.
11274
11275
11276 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11277 .cindex "&'pwcheck'& daemon"
11278 .cindex "Cyrus"
11279 .cindex "expansion" "&'pwcheck'& authentication test"
11280 .cindex "&%pwcheck%& expansion condition"
11281 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11282 This is one way of making it possible for passwords to be checked by a process
11283 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11284 deprecated. Its replacement is &'saslauthd'& (see below).
11285
11286 The pwcheck support is not included in Exim by default. You need to specify
11287 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11288 building Exim. For example:
11289 .code
11290 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11291 .endd
11292 You do not need to install the full Cyrus software suite in order to use
11293 the pwcheck daemon. You can compile and install just the daemon alone
11294 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11295 access to the &_/var/pwcheck_& directory.
11296
11297 The &%pwcheck%& condition takes one argument, which must be the user name and
11298 password, separated by a colon. For example, in a LOGIN authenticator
11299 configuration, you might have this:
11300 .code
11301 server_condition = ${if pwcheck{$auth1:$auth2}}
11302 .endd
11303 Again, for a PLAIN authenticator configuration, this would be:
11304 .code
11305 server_condition = ${if pwcheck{$auth2:$auth3}}
11306 .endd
11307 .vitem &*queue_running*&
11308 .cindex "queue runner" "detecting when delivering from"
11309 .cindex "expansion" "queue runner test"
11310 .cindex "&%queue_running%& expansion condition"
11311 This condition, which has no data, is true during delivery attempts that are
11312 initiated by queue runner processes, and false otherwise.
11313
11314
11315 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11316 .cindex "Radius"
11317 .cindex "expansion" "Radius authentication"
11318 .cindex "&%radius%& expansion condition"
11319 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11320 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11321 the Radius client configuration file in order to build Exim with Radius
11322 support.
11323
11324 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11325 library, using the original API. If you are using release 0.4.0 or later of
11326 this library, you need to set
11327 .code
11328 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11329 .endd
11330 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11331 &%libradius%& library that comes with FreeBSD. To do this, set
11332 .code
11333 RADIUS_LIB_TYPE=RADLIB
11334 .endd
11335 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11336 You may also have to supply a suitable setting in EXTRALIBS so that the
11337 Radius library can be found when Exim is linked.
11338
11339 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11340 Radius client library, which calls the Radius server. The condition is true if
11341 the authentication is successful. For example:
11342 .code
11343 server_condition = ${if radius{<arguments>}}
11344 .endd
11345
11346
11347 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11348         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11349 .cindex "&'saslauthd'& daemon"
11350 .cindex "Cyrus"
11351 .cindex "expansion" "&'saslauthd'& authentication test"
11352 .cindex "&%saslauthd%& expansion condition"
11353 This condition supports user authentication using the Cyrus &'saslauthd'&
11354 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11355 Using this daemon is one way of making it possible for passwords to be checked
11356 by a process that is not running as root.
11357
11358 The saslauthd support is not included in Exim by default. You need to specify
11359 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11360 building Exim. For example:
11361 .code
11362 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11363 .endd
11364 You do not need to install the full Cyrus software suite in order to use
11365 the saslauthd daemon. You can compile and install just the daemon alone
11366 from the Cyrus SASL library.
11367
11368 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11369 two are mandatory. For example:
11370 .code
11371 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11372 .endd
11373 The service and the realm are optional (which is why the arguments are enclosed
11374 in their own set of braces). For details of the meaning of the service and
11375 realm, and how to run the daemon, consult the Cyrus documentation.
11376 .endlist vlist
11377
11378
11379
11380 .section "Combining expansion conditions" "SECID84"
11381 .cindex "expansion" "combining conditions"
11382 Several conditions can be tested at once by combining them using the &%and%&
11383 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11384 conditions on their own, and precede their lists of sub-conditions. Each
11385 sub-condition must be enclosed in braces within the overall braces that contain
11386 the list. No repetition of &%if%& is used.
11387
11388
11389 .vlist
11390 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11391 .cindex "&""or""& expansion condition"
11392 .cindex "expansion" "&""or""& of conditions"
11393 The sub-conditions are evaluated from left to right. The condition is true if
11394 any one of the sub-conditions is true.
11395 For example,
11396 .code
11397 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11398 .endd
11399 When a true sub-condition is found, the following ones are parsed but not
11400 evaluated. If there are several &"match"& sub-conditions the values of the
11401 numeric variables afterwards are taken from the first one that succeeds.
11402
11403 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11404 .cindex "&""and""& expansion condition"
11405 .cindex "expansion" "&""and""& of conditions"
11406 The sub-conditions are evaluated from left to right. The condition is true if
11407 all of the sub-conditions are true. If there are several &"match"&
11408 sub-conditions, the values of the numeric variables afterwards are taken from
11409 the last one. When a false sub-condition is found, the following ones are
11410 parsed but not evaluated.
11411 .endlist
11412 .ecindex IIDexpcond
11413
11414
11415
11416
11417 .section "Expansion variables" "SECTexpvar"
11418 .cindex "expansion" "variables, list of"
11419 This section contains an alphabetical list of all the expansion variables. Some
11420 of them are available only when Exim is compiled with specific options such as
11421 support for TLS or the content scanning extension.
11422
11423 .vlist
11424 .vitem "&$0$&, &$1$&, etc"
11425 .cindex "numerical variables (&$1$& &$2$& etc)"
11426 When a &%match%& expansion condition succeeds, these variables contain the
11427 captured substrings identified by the regular expression during subsequent
11428 processing of the success string of the containing &%if%& expansion item.
11429 In the expansion condition case
11430 they do not retain their values afterwards; in fact, their previous
11431 values are restored at the end of processing an &%if%& item. The numerical
11432 variables may also be set externally by some other matching process which
11433 precedes the expansion of the string. For example, the commands available in
11434 Exim filter files include an &%if%& command with its own regular expression
11435 matching condition.
11436
11437 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11438 Within an acl condition, expansion condition or expansion item
11439 any arguments are copied to these variables,
11440 any unused variables being made empty.
11441
11442 .vitem "&$acl_c...$&"
11443 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11444 can be given any name that starts with &$acl_c$& and is at least six characters
11445 long, but the sixth character must be either a digit or an underscore. For
11446 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11447 variables persist throughout the lifetime of an SMTP connection. They can be
11448 used to pass information between ACLs and between different invocations of the
11449 same ACL. When a message is received, the values of these variables are saved
11450 with the message, and can be accessed by filters, routers, and transports
11451 during subsequent delivery.
11452
11453 .vitem "&$acl_m...$&"
11454 These variables are like the &$acl_c...$& variables, except that their values
11455 are reset after a message has been received. Thus, if several messages are
11456 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11457 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11458 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11459 message is received, the values of these variables are saved with the message,
11460 and can be accessed by filters, routers, and transports during subsequent
11461 delivery.
11462
11463 .vitem &$acl_narg$&
11464 Within an acl condition, expansion condition or expansion item
11465 this variable has the number of arguments.
11466
11467 .vitem &$acl_verify_message$&
11468 .vindex "&$acl_verify_message$&"
11469 After an address verification has failed, this variable contains the failure
11470 message. It retains its value for use in subsequent modifiers. The message can
11471 be preserved by coding like this:
11472 .code
11473 warn !verify = sender
11474      set acl_m0 = $acl_verify_message
11475 .endd
11476 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11477 &%log_message%& modifiers, to include information about the verification
11478 failure.
11479
11480 .vitem &$address_data$&
11481 .vindex "&$address_data$&"
11482 This variable is set by means of the &%address_data%& option in routers. The
11483 value then remains with the address while it is processed by subsequent routers
11484 and eventually a transport. If the transport is handling multiple addresses,
11485 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11486 for more details. &*Note*&: The contents of &$address_data$& are visible in
11487 user filter files.
11488
11489 If &$address_data$& is set when the routers are called from an ACL to verify
11490 a recipient address, the final value is still in the variable for subsequent
11491 conditions and modifiers of the ACL statement. If routing the address caused it
11492 to be redirected to just one address, the child address is also routed as part
11493 of the verification, and in this case the final value of &$address_data$& is
11494 from the child's routing.
11495
11496 If &$address_data$& is set when the routers are called from an ACL to verify a
11497 sender address, the final value is also preserved, but this time in
11498 &$sender_address_data$&, to distinguish it from data from a recipient
11499 address.
11500
11501 In both cases (recipient and sender verification), the value does not persist
11502 after the end of the current ACL statement. If you want to preserve
11503 these values for longer, you can save them in ACL variables.
11504
11505 .vitem &$address_file$&
11506 .vindex "&$address_file$&"
11507 When, as a result of aliasing, forwarding, or filtering, a message is directed
11508 to a specific file, this variable holds the name of the file when the transport
11509 is running. At other times, the variable is empty. For example, using the
11510 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11511 .code
11512 /home/r2d2/savemail
11513 .endd
11514 then when the &(address_file)& transport is running, &$address_file$&
11515 contains the text string &`/home/r2d2/savemail`&.
11516 .cindex "Sieve filter" "value of &$address_file$&"
11517 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11518 then up to the transport configuration to generate an appropriate absolute path
11519 to the relevant file.
11520
11521 .vitem &$address_pipe$&
11522 .vindex "&$address_pipe$&"
11523 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11524 this variable holds the pipe command when the transport is running.
11525
11526 .vitem "&$auth1$& &-- &$auth3$&"
11527 .vindex "&$auth1$&, &$auth2$&, etc"
11528 These variables are used in SMTP authenticators (see chapters
11529 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11530
11531 .vitem &$authenticated_id$&
11532 .cindex "authentication" "id"
11533 .vindex "&$authenticated_id$&"
11534 When a server successfully authenticates a client it may be configured to
11535 preserve some of the authentication information in the variable
11536 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11537 user/password authenticator configuration might preserve the user name for use
11538 in the routers. Note that this is not the same information that is saved in
11539 &$sender_host_authenticated$&.
11540 When a message is submitted locally (that is, not over a TCP connection)
11541 the value of &$authenticated_id$& is normally the login name of the calling
11542 process. However, a trusted user can override this by means of the &%-oMai%&
11543 command line option.
11544
11545 .vitem &$authenticated_fail_id$&
11546 .cindex "authentication" "fail" "id"
11547 .vindex "&$authenticated_fail_id$&"
11548 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11549 will contain the failed authentication id. If more than one authentication
11550 id is attempted, it will contain only the last one. The variable is
11551 available for processing in the ACL's, generally the quit or notquit ACL.
11552 A message to a local recipient could still be accepted without requiring
11553 authentication, which means this variable could also be visible in all of
11554 the ACL's as well.
11555
11556
11557 .vitem &$authenticated_sender$&
11558 .cindex "sender" "authenticated"
11559 .cindex "authentication" "sender"
11560 .cindex "AUTH" "on MAIL command"
11561 .vindex "&$authenticated_sender$&"
11562 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11563 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11564 described in section &<<SECTauthparamail>>&. Unless the data is the string
11565 &"<>"&, it is set as the authenticated sender of the message, and the value is
11566 available during delivery in the &$authenticated_sender$& variable. If the
11567 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11568
11569 .vindex "&$qualify_domain$&"
11570 When a message is submitted locally (that is, not over a TCP connection), the
11571 value of &$authenticated_sender$& is an address constructed from the login
11572 name of the calling process and &$qualify_domain$&, except that a trusted user
11573 can override this by means of the &%-oMas%& command line option.
11574
11575
11576 .vitem &$authentication_failed$&
11577 .cindex "authentication" "failure"
11578 .vindex "&$authentication_failed$&"
11579 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11580 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11581 possible to distinguish between &"did not try to authenticate"&
11582 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11583 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11584 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11585 negative response to an AUTH command, including (for example) an attempt to use
11586 an undefined mechanism.
11587
11588 .vitem &$av_failed$&
11589 .cindex "content scanning" "AV scanner failure"
11590 This variable is available when Exim is compiled with the content-scanning
11591 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11592 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11593 the ACL malware condition.
11594
11595 .vitem &$body_linecount$&
11596 .cindex "message body" "line count"
11597 .cindex "body of message" "line count"
11598 .vindex "&$body_linecount$&"
11599 When a message is being received or delivered, this variable contains the
11600 number of lines in the message's body. See also &$message_linecount$&.
11601
11602 .vitem &$body_zerocount$&
11603 .cindex "message body" "binary zero count"
11604 .cindex "body of message" "binary zero count"
11605 .cindex "binary zero" "in message body"
11606 .vindex "&$body_zerocount$&"
11607 When a message is being received or delivered, this variable contains the
11608 number of binary zero bytes (ASCII NULs) in the message's body.
11609
11610 .vitem &$bounce_recipient$&
11611 .vindex "&$bounce_recipient$&"
11612 This is set to the recipient address of a bounce message while Exim is creating
11613 it. It is useful if a customized bounce message text file is in use (see
11614 chapter &<<CHAPemsgcust>>&).
11615
11616 .vitem &$bounce_return_size_limit$&
11617 .vindex "&$bounce_return_size_limit$&"
11618 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11619 up to a multiple of 1000. It is useful when a customized error message text
11620 file is in use (see chapter &<<CHAPemsgcust>>&).
11621
11622 .vitem &$caller_gid$&
11623 .cindex "gid (group id)" "caller"
11624 .vindex "&$caller_gid$&"
11625 The real group id under which the process that called Exim was running. This is
11626 not the same as the group id of the originator of a message (see
11627 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11628 incarnation normally contains the Exim gid.
11629
11630 .vitem &$caller_uid$&
11631 .cindex "uid (user id)" "caller"
11632 .vindex "&$caller_uid$&"
11633 The real user id under which the process that called Exim was running. This is
11634 not the same as the user id of the originator of a message (see
11635 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11636 incarnation normally contains the Exim uid.
11637
11638 .vitem &$callout_address$&
11639 .vindex "&$callout_address$&"
11640 After a callout for verification, spamd or malware daemon service, the
11641 address that was connected to.
11642
11643 .vitem &$compile_number$&
11644 .vindex "&$compile_number$&"
11645 The building process for Exim keeps a count of the number
11646 of times it has been compiled. This serves to distinguish different
11647 compilations of the same version of the program.
11648
11649 .vitem &$config_dir$&
11650 .vindex "&$config_dir$&"
11651 The directory name of the main configuration file. That is, the content of
11652 &$config_file$& with the last component stripped. The value does not
11653 contain the trailing slash. If &$config_file$& does not contain a slash,
11654 &$config_dir$& is ".".
11655
11656 .vitem &$config_file$&
11657 .vindex "&$config_file$&"
11658 The name of the main configuration file Exim is using.
11659
11660 .vitem &$dkim_cur_signer$& &&&
11661        &$dkim_verify_status$& &&&
11662        &$dkim_verify_reason$& &&&
11663        &$dkim_domain$& &&&
11664        &$dkim_identity$& &&&
11665        &$dkim_selector$& &&&
11666        &$dkim_algo$& &&&
11667        &$dkim_canon_body$& &&&
11668        &$dkim_canon_headers$& &&&
11669        &$dkim_copiedheaders$& &&&
11670        &$dkim_bodylength$& &&&
11671        &$dkim_created$& &&&
11672        &$dkim_expires$& &&&
11673        &$dkim_headernames$& &&&
11674        &$dkim_key_testing$& &&&
11675        &$dkim_key_nosubdomains$& &&&
11676        &$dkim_key_srvtype$& &&&
11677        &$dkim_key_granularity$& &&&
11678        &$dkim_key_notes$& &&&
11679        &$dkim_key_length$&
11680 These variables are only available within the DKIM ACL.
11681 For details see chapter &<<CHAPdkim>>&.
11682
11683 .vitem &$dkim_signers$&
11684 .vindex &$dkim_signers$&
11685 When a message has been received this variable contains
11686 a colon-separated list of signer domains and identities for the message.
11687 For details see chapter &<<CHAPdkim>>&.
11688
11689 .vitem &$dnslist_domain$& &&&
11690        &$dnslist_matched$& &&&
11691        &$dnslist_text$& &&&
11692        &$dnslist_value$&
11693 .vindex "&$dnslist_domain$&"
11694 .vindex "&$dnslist_matched$&"
11695 .vindex "&$dnslist_text$&"
11696 .vindex "&$dnslist_value$&"
11697 .cindex "black list (DNS)"
11698 When a DNS (black) list lookup succeeds, these variables are set to contain
11699 the following data from the lookup: the list's domain name, the key that was
11700 looked up, the contents of any associated TXT record, and the value from the
11701 main A record. See section &<<SECID204>>& for more details.
11702
11703 .vitem &$domain$&
11704 .vindex "&$domain$&"
11705 When an address is being routed, or delivered on its own, this variable
11706 contains the domain. Uppercase letters in the domain are converted into lower
11707 case for &$domain$&.
11708
11709 Global address rewriting happens when a message is received, so the value of
11710 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11711 is set during user filtering, but not during system filtering, because a
11712 message may have many recipients and the system filter is called just once.
11713
11714 When more than one address is being delivered at once (for example, several
11715 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11716 have the same domain. Transports can be restricted to handling only one domain
11717 at a time if the value of &$domain$& is required at transport time &-- this is
11718 the default for local transports. For further details of the environment in
11719 which local transports are run, see chapter &<<CHAPenvironment>>&.
11720
11721 .oindex "&%delay_warning_condition%&"
11722 At the end of a delivery, if all deferred addresses have the same domain, it is
11723 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11724
11725 The &$domain$& variable is also used in some other circumstances:
11726
11727 .ilist
11728 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11729 the recipient address. The domain of the &'sender'& address is in
11730 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11731 normally set during the running of the MAIL ACL. However, if the sender address
11732 is verified with a callout during the MAIL ACL, the sender domain is placed in
11733 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11734 the &(smtp)& transport.
11735
11736 .next
11737 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11738 &$domain$& contains the domain portion of the address that is being rewritten;
11739 it can be used in the expansion of the replacement address, for example, to
11740 rewrite domains by file lookup.
11741
11742 .next
11743 With one important exception, whenever a domain list is being scanned,
11744 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11745 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11746 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11747 that, in a RCPT ACL, the sender domain list can be dependent on the
11748 recipient domain (which is what is in &$domain$& at this time).
11749
11750 .next
11751 .cindex "ETRN" "value of &$domain$&"
11752 .oindex "&%smtp_etrn_command%&"
11753 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11754 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11755 .endlist
11756
11757
11758 .vitem &$domain_data$&
11759 .vindex "&$domain_data$&"
11760 When the &%domains%& option on a router matches a domain by
11761 means of a lookup, the data read by the lookup is available during the running
11762 of the router as &$domain_data$&. In addition, if the driver routes the
11763 address to a transport, the value is available in that transport. If the
11764 transport is handling multiple addresses, the value from the first address is
11765 used.
11766
11767 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11768 domain by means of a lookup. The data read by the lookup is available during
11769 the rest of the ACL statement. In all other situations, this variable expands
11770 to nothing.
11771
11772 .vitem &$exim_gid$&
11773 .vindex "&$exim_gid$&"
11774 This variable contains the numerical value of the Exim group id.
11775
11776 .vitem &$exim_path$&
11777 .vindex "&$exim_path$&"
11778 This variable contains the path to the Exim binary.
11779
11780 .vitem &$exim_uid$&
11781 .vindex "&$exim_uid$&"
11782 This variable contains the numerical value of the Exim user id.
11783
11784 .vitem &$exim_version$&
11785 .vindex "&$exim_version$&"
11786 This variable contains the version string of the Exim build.
11787 The first character is a major version number, currently 4.
11788 Then after a dot, the next group of digits is a minor version number.
11789 There may be other characters following the minor version.
11790
11791 .vitem &$header_$&<&'name'&>
11792 This is not strictly an expansion variable. It is expansion syntax for
11793 inserting the message header line with the given name. Note that the name must
11794 be terminated by colon or white space, because it may contain a wide variety of
11795 characters. Note also that braces must &'not'& be used.
11796
11797 .vitem &$headers_added$&
11798 .vindex "&$headers_added$&"
11799 Within an ACL this variable contains the headers added so far by
11800 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11801 The headers are a newline-separated list.
11802
11803 .vitem &$home$&
11804 .vindex "&$home$&"
11805 When the &%check_local_user%& option is set for a router, the user's home
11806 directory is placed in &$home$& when the check succeeds. In particular, this
11807 means it is set during the running of users' filter files. A router may also
11808 explicitly set a home directory for use by a transport; this can be overridden
11809 by a setting on the transport itself.
11810
11811 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11812 of the environment variable HOME, which is subject to the
11813 &%keep_environment%& and &%add_environment%& main config options.
11814
11815 .vitem &$host$&
11816 .vindex "&$host$&"
11817 If a router assigns an address to a transport (any transport), and passes a
11818 list of hosts with the address, the value of &$host$& when the transport starts
11819 to run is the name of the first host on the list. Note that this applies both
11820 to local and remote transports.
11821
11822 .cindex "transport" "filter"
11823 .cindex "filter" "transport filter"
11824 For the &(smtp)& transport, if there is more than one host, the value of
11825 &$host$& changes as the transport works its way through the list. In
11826 particular, when the &(smtp)& transport is expanding its options for encryption
11827 using TLS, or for specifying a transport filter (see chapter
11828 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11829 is connected.
11830
11831 When used in the client part of an authenticator configuration (see chapter
11832 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11833 client is connected.
11834
11835
11836 .vitem &$host_address$&
11837 .vindex "&$host_address$&"
11838 This variable is set to the remote host's IP address whenever &$host$& is set
11839 for a remote connection. It is also set to the IP address that is being checked
11840 when the &%ignore_target_hosts%& option is being processed.
11841
11842 .vitem &$host_data$&
11843 .vindex "&$host_data$&"
11844 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11845 result of the lookup is made available in the &$host_data$& variable. This
11846 allows you, for example, to do things like this:
11847 .code
11848 deny  hosts = net-lsearch;/some/file
11849 message = $host_data
11850 .endd
11851 .vitem &$host_lookup_deferred$&
11852 .cindex "host name" "lookup, failure of"
11853 .vindex "&$host_lookup_deferred$&"
11854 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11855 message comes from a remote host and there is an attempt to look up the host's
11856 name from its IP address, and the attempt is not successful, one of these
11857 variables is set to &"1"&.
11858
11859 .ilist
11860 If the lookup receives a definite negative response (for example, a DNS lookup
11861 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11862
11863 .next
11864 If there is any kind of problem during the lookup, such that Exim cannot
11865 tell whether or not the host name is defined (for example, a timeout for a DNS
11866 lookup), &$host_lookup_deferred$& is set to &"1"&.
11867 .endlist ilist
11868
11869 Looking up a host's name from its IP address consists of more than just a
11870 single reverse lookup. Exim checks that a forward lookup of at least one of the
11871 names it receives from a reverse lookup yields the original IP address. If this
11872 is not the case, Exim does not accept the looked up name(s), and
11873 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11874 IP address (for example, the existence of a PTR record in the DNS) is not
11875 sufficient on its own for the success of a host name lookup. If the reverse
11876 lookup succeeds, but there is a lookup problem such as a timeout when checking
11877 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11878 &"1"&. See also &$sender_host_name$&.
11879
11880 .vitem &$host_lookup_failed$&
11881 .vindex "&$host_lookup_failed$&"
11882 See &$host_lookup_deferred$&.
11883
11884 .vitem &$host_port$&
11885 .vindex "&$host_port$&"
11886 This variable is set to the remote host's TCP port whenever &$host$& is set
11887 for an outbound connection.
11888
11889 .vitem &$initial_cwd$&
11890 .vindex "&$initial_cwd$&
11891 This variable contains the full path name of the initial working
11892 directory of the current Exim process. This may differ from the current
11893 working directory, as Exim changes this to "/" during early startup, and
11894 to &$spool_directory$& later.
11895
11896 .vitem &$inode$&
11897 .vindex "&$inode$&"
11898 The only time this variable is set is while expanding the &%directory_file%&
11899 option in the &(appendfile)& transport. The variable contains the inode number
11900 of the temporary file which is about to be renamed. It can be used to construct
11901 a unique name for the file.
11902
11903 .vitem &$interface_address$&
11904 .vindex "&$interface_address$&"
11905 This is an obsolete name for &$received_ip_address$&.
11906
11907 .vitem &$interface_port$&
11908 .vindex "&$interface_port$&"
11909 This is an obsolete name for &$received_port$&.
11910
11911 .vitem &$item$&
11912 .vindex "&$item$&"
11913 This variable is used during the expansion of &*forall*& and &*forany*&
11914 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11915 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11916 empty.
11917
11918 .vitem &$ldap_dn$&
11919 .vindex "&$ldap_dn$&"
11920 This variable, which is available only when Exim is compiled with LDAP support,
11921 contains the DN from the last entry in the most recently successful LDAP
11922 lookup.
11923
11924 .vitem &$load_average$&
11925 .vindex "&$load_average$&"
11926 This variable contains the system load average, multiplied by 1000 so that it
11927 is an integer. For example, if the load average is 0.21, the value of the
11928 variable is 210. The value is recomputed every time the variable is referenced.
11929
11930 .vitem &$local_part$&
11931 .vindex "&$local_part$&"
11932 When an address is being routed, or delivered on its own, this
11933 variable contains the local part. When a number of addresses are being
11934 delivered together (for example, multiple RCPT commands in an SMTP
11935 session), &$local_part$& is not set.
11936
11937 Global address rewriting happens when a message is received, so the value of
11938 &$local_part$& during routing and delivery is the value after rewriting.
11939 &$local_part$& is set during user filtering, but not during system filtering,
11940 because a message may have many recipients and the system filter is called just
11941 once.
11942
11943 .vindex "&$local_part_prefix$&"
11944 .vindex "&$local_part_suffix$&"
11945 If a local part prefix or suffix has been recognized, it is not included in the
11946 value of &$local_part$& during routing and subsequent delivery. The values of
11947 any prefix or suffix are in &$local_part_prefix$& and
11948 &$local_part_suffix$&, respectively.
11949
11950 When a message is being delivered to a file, pipe, or autoreply transport as a
11951 result of aliasing or forwarding, &$local_part$& is set to the local part of
11952 the parent address, not to the file name or command (see &$address_file$& and
11953 &$address_pipe$&).
11954
11955 When an ACL is running for a RCPT command, &$local_part$& contains the
11956 local part of the recipient address.
11957
11958 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11959 &$local_part$& contains the local part of the address that is being rewritten;
11960 it can be used in the expansion of the replacement address, for example.
11961
11962 In all cases, all quoting is removed from the local part. For example, for both
11963 the addresses
11964 .code
11965 "abc:xyz"@test.example
11966 abc\:xyz@test.example
11967 .endd
11968 the value of &$local_part$& is
11969 .code
11970 abc:xyz
11971 .endd
11972 If you use &$local_part$& to create another address, you should always wrap it
11973 inside a quoting operator. For example, in a &(redirect)& router you could
11974 have:
11975 .code
11976 data = ${quote_local_part:$local_part}@new.domain.example
11977 .endd
11978 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11979 to process local parts in a case-dependent manner in a router, you can set the
11980 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11981
11982 .vitem &$local_part_data$&
11983 .vindex "&$local_part_data$&"
11984 When the &%local_parts%& option on a router matches a local part by means of a
11985 lookup, the data read by the lookup is available during the running of the
11986 router as &$local_part_data$&. In addition, if the driver routes the address
11987 to a transport, the value is available in that transport. If the transport is
11988 handling multiple addresses, the value from the first address is used.
11989
11990 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11991 matches a local part by means of a lookup. The data read by the lookup is
11992 available during the rest of the ACL statement. In all other situations, this
11993 variable expands to nothing.
11994
11995 .vitem &$local_part_prefix$&
11996 .vindex "&$local_part_prefix$&"
11997 When an address is being routed or delivered, and a
11998 specific prefix for the local part was recognized, it is available in this
11999 variable, having been removed from &$local_part$&.
12000
12001 .vitem &$local_part_suffix$&
12002 .vindex "&$local_part_suffix$&"
12003 When an address is being routed or delivered, and a
12004 specific suffix for the local part was recognized, it is available in this
12005 variable, having been removed from &$local_part$&.
12006
12007 .vitem &$local_scan_data$&
12008 .vindex "&$local_scan_data$&"
12009 This variable contains the text returned by the &[local_scan()]& function when
12010 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12011
12012 .vitem &$local_user_gid$&
12013 .vindex "&$local_user_gid$&"
12014 See &$local_user_uid$&.
12015
12016 .vitem &$local_user_uid$&
12017 .vindex "&$local_user_uid$&"
12018 This variable and &$local_user_gid$& are set to the uid and gid after the
12019 &%check_local_user%& router precondition succeeds. This means that their values
12020 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12021 and &%condition%&), for the &%address_data%& expansion, and for any
12022 router-specific expansions. At all other times, the values in these variables
12023 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12024
12025 .vitem &$localhost_number$&
12026 .vindex "&$localhost_number$&"
12027 This contains the expanded value of the
12028 &%localhost_number%& option. The expansion happens after the main options have
12029 been read.
12030
12031 .vitem &$log_inodes$&
12032 .vindex "&$log_inodes$&"
12033 The number of free inodes in the disk partition where Exim's
12034 log files are being written. The value is recalculated whenever the variable is
12035 referenced. If the relevant file system does not have the concept of inodes,
12036 the value of is -1. See also the &%check_log_inodes%& option.
12037
12038 .vitem &$log_space$&
12039 .vindex "&$log_space$&"
12040 The amount of free space (as a number of kilobytes) in the disk
12041 partition where Exim's log files are being written. The value is recalculated
12042 whenever the variable is referenced. If the operating system does not have the
12043 ability to find the amount of free space (only true for experimental systems),
12044 the space value is -1. See also the &%check_log_space%& option.
12045
12046
12047 .vitem &$lookup_dnssec_authenticated$&
12048 .vindex "&$lookup_dnssec_authenticated$&"
12049 This variable is set after a DNS lookup done by
12050 a dnsdb lookup expansion, dnslookup router or smtp transport.
12051 .cindex "DNS" "DNSSEC"
12052 It will be empty if &(DNSSEC)& was not requested,
12053 &"no"& if the result was not labelled as authenticated data
12054 and &"yes"& if it was.
12055 Results that are labelled as authoritative answer that match
12056 the &%dns_trust_aa%& configuration variable count also
12057 as authenticated data.
12058
12059 .vitem &$mailstore_basename$&
12060 .vindex "&$mailstore_basename$&"
12061 This variable is set only when doing deliveries in &"mailstore"& format in the
12062 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12063 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12064 contains the basename of the files that are being written, that is, the name
12065 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12066 variable is empty.
12067
12068 .vitem &$malware_name$&
12069 .vindex "&$malware_name$&"
12070 This variable is available when Exim is compiled with the
12071 content-scanning extension. It is set to the name of the virus that was found
12072 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12073
12074 .vitem &$max_received_linelength$&
12075 .vindex "&$max_received_linelength$&"
12076 .cindex "maximum" "line length"
12077 .cindex "line length" "maximum"
12078 This variable contains the number of bytes in the longest line that was
12079 received as part of the message, not counting the line termination
12080 character(s).
12081
12082 .vitem &$message_age$&
12083 .cindex "message" "age of"
12084 .vindex "&$message_age$&"
12085 This variable is set at the start of a delivery attempt to contain the number
12086 of seconds since the message was received. It does not change during a single
12087 delivery attempt.
12088
12089 .vitem &$message_body$&
12090 .cindex "body of message" "expansion variable"
12091 .cindex "message body" "in expansion"
12092 .cindex "binary zero" "in message body"
12093 .vindex "&$message_body$&"
12094 .oindex "&%message_body_visible%&"
12095 This variable contains the initial portion of a message's body while it is
12096 being delivered, and is intended mainly for use in filter files. The maximum
12097 number of characters of the body that are put into the variable is set by the
12098 &%message_body_visible%& configuration option; the default is 500.
12099
12100 .oindex "&%message_body_newlines%&"
12101 By default, newlines are converted into spaces in &$message_body$&, to make it
12102 easier to search for phrases that might be split over a line break. However,
12103 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12104 zeros are always converted into spaces.
12105
12106 .vitem &$message_body_end$&
12107 .cindex "body of message" "expansion variable"
12108 .cindex "message body" "in expansion"
12109 .vindex "&$message_body_end$&"
12110 This variable contains the final portion of a message's
12111 body while it is being delivered. The format and maximum size are as for
12112 &$message_body$&.
12113
12114 .vitem &$message_body_size$&
12115 .cindex "body of message" "size"
12116 .cindex "message body" "size"
12117 .vindex "&$message_body_size$&"
12118 When a message is being delivered, this variable contains the size of the body
12119 in bytes. The count starts from the character after the blank line that
12120 separates the body from the header. Newlines are included in the count. See
12121 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12122
12123 .vitem &$message_exim_id$&
12124 .vindex "&$message_exim_id$&"
12125 When a message is being received or delivered, this variable contains the
12126 unique message id that is generated and used by Exim to identify the message.
12127 An id is not created for a message until after its header has been successfully
12128 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12129 line; it is the local id that Exim assigns to the message, for example:
12130 &`1BXTIK-0001yO-VA`&.
12131
12132 .vitem &$message_headers$&
12133 .vindex &$message_headers$&
12134 This variable contains a concatenation of all the header lines when a message
12135 is being processed, except for lines added by routers or transports. The header
12136 lines are separated by newline characters. Their contents are decoded in the
12137 same way as a header line that is inserted by &%bheader%&.
12138
12139 .vitem &$message_headers_raw$&
12140 .vindex &$message_headers_raw$&
12141 This variable is like &$message_headers$& except that no processing of the
12142 contents of header lines is done.
12143
12144 .vitem &$message_id$&
12145 This is an old name for &$message_exim_id$&. It is now deprecated.
12146
12147 .vitem &$message_linecount$&
12148 .vindex "&$message_linecount$&"
12149 This variable contains the total number of lines in the header and body of the
12150 message. Compare &$body_linecount$&, which is the count for the body only.
12151 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12152 number of lines received. Before delivery happens (that is, before filters,
12153 routers, and transports run) the count is increased to include the
12154 &'Received:'& header line that Exim standardly adds, and also any other header
12155 lines that are added by ACLs. The blank line that separates the message header
12156 from the body is not counted.
12157
12158 As with the special case of &$message_size$&, during the expansion of the
12159 appendfile transport's maildir_tag option in maildir format, the value of
12160 &$message_linecount$& is the precise size of the number of newlines in the
12161 file that has been written (minus one for the blank line between the
12162 header and the body).
12163
12164 Here is an example of the use of this variable in a DATA ACL:
12165 .code
12166 deny message   = Too many lines in message header
12167      condition = \
12168       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12169 .endd
12170 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12171 message has not yet been received.
12172
12173 .vitem &$message_size$&
12174 .cindex "size" "of message"
12175 .cindex "message" "size"
12176 .vindex "&$message_size$&"
12177 When a message is being processed, this variable contains its size in bytes. In
12178 most cases, the size includes those headers that were received with the
12179 message, but not those (such as &'Envelope-to:'&) that are added to individual
12180 deliveries as they are written. However, there is one special case: during the
12181 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12182 doing a delivery in maildir format, the value of &$message_size$& is the
12183 precise size of the file that has been written. See also
12184 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12185
12186 .cindex "RCPT" "value of &$message_size$&"
12187 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12188 contains the size supplied on the MAIL command, or -1 if no size was given. The
12189 value may not, of course, be truthful.
12190
12191 .vitem &$mime_$&&'xxx'&
12192 A number of variables whose names start with &$mime$& are
12193 available when Exim is compiled with the content-scanning extension. For
12194 details, see section &<<SECTscanmimepart>>&.
12195
12196 .vitem "&$n0$& &-- &$n9$&"
12197 These variables are counters that can be incremented by means
12198 of the &%add%& command in filter files.
12199
12200 .vitem &$original_domain$&
12201 .vindex "&$domain$&"
12202 .vindex "&$original_domain$&"
12203 When a top-level address is being processed for delivery, this contains the
12204 same value as &$domain$&. However, if a &"child"& address (for example,
12205 generated by an alias, forward, or filter file) is being processed, this
12206 variable contains the domain of the original address (lower cased). This
12207 differs from &$parent_domain$& only when there is more than one level of
12208 aliasing or forwarding. When more than one address is being delivered in a
12209 single transport run, &$original_domain$& is not set.
12210
12211 If a new address is created by means of a &%deliver%& command in a system
12212 filter, it is set up with an artificial &"parent"& address. This has the local
12213 part &'system-filter'& and the default qualify domain.
12214
12215 .vitem &$original_local_part$&
12216 .vindex "&$local_part$&"
12217 .vindex "&$original_local_part$&"
12218 When a top-level address is being processed for delivery, this contains the
12219 same value as &$local_part$&, unless a prefix or suffix was removed from the
12220 local part, because &$original_local_part$& always contains the full local
12221 part. When a &"child"& address (for example, generated by an alias, forward, or
12222 filter file) is being processed, this variable contains the full local part of
12223 the original address.
12224
12225 If the router that did the redirection processed the local part
12226 case-insensitively, the value in &$original_local_part$& is in lower case.
12227 This variable differs from &$parent_local_part$& only when there is more than
12228 one level of aliasing or forwarding. When more than one address is being
12229 delivered in a single transport run, &$original_local_part$& is not set.
12230
12231 If a new address is created by means of a &%deliver%& command in a system
12232 filter, it is set up with an artificial &"parent"& address. This has the local
12233 part &'system-filter'& and the default qualify domain.
12234
12235 .vitem &$originator_gid$&
12236 .cindex "gid (group id)" "of originating user"
12237 .cindex "sender" "gid"
12238 .vindex "&$caller_gid$&"
12239 .vindex "&$originator_gid$&"
12240 This variable contains the value of &$caller_gid$& that was set when the
12241 message was received. For messages received via the command line, this is the
12242 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12243 normally the gid of the Exim user.
12244
12245 .vitem &$originator_uid$&
12246 .cindex "uid (user id)" "of originating user"
12247 .cindex "sender" "uid"
12248 .vindex "&$caller_uid$&"
12249 .vindex "&$originator_uid$&"
12250 The value of &$caller_uid$& that was set when the message was received. For
12251 messages received via the command line, this is the uid of the sending user.
12252 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12253 user.
12254
12255 .vitem &$parent_domain$&
12256 .vindex "&$parent_domain$&"
12257 This variable is similar to &$original_domain$& (see
12258 above), except that it refers to the immediately preceding parent address.
12259
12260 .vitem &$parent_local_part$&
12261 .vindex "&$parent_local_part$&"
12262 This variable is similar to &$original_local_part$&
12263 (see above), except that it refers to the immediately preceding parent address.
12264
12265 .vitem &$pid$&
12266 .cindex "pid (process id)" "of current process"
12267 .vindex "&$pid$&"
12268 This variable contains the current process id.
12269
12270 .vitem &$pipe_addresses$&
12271 .cindex "filter" "transport filter"
12272 .cindex "transport" "filter"
12273 .vindex "&$pipe_addresses$&"
12274 This is not an expansion variable, but is mentioned here because the string
12275 &`$pipe_addresses`& is handled specially in the command specification for the
12276 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12277 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12278 It cannot be used in general expansion strings, and provokes an &"unknown
12279 variable"& error if encountered.
12280
12281 .vitem &$primary_hostname$&
12282 .vindex "&$primary_hostname$&"
12283 This variable contains the value set by &%primary_hostname%& in the
12284 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12285 a single-component name, Exim calls &[gethostbyname()]& (or
12286 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12287 qualified host name. See also &$smtp_active_hostname$&.
12288
12289
12290 .vitem &$proxy_external_address$& &&&
12291        &$proxy_external_port$& &&&
12292        &$proxy_local_address$& &&&
12293        &$proxy_local_port$& &&&
12294        &$proxy_session$&
12295 These variables are only available when built with Proxy Protocol
12296 or SOCKS5 support.
12297 For details see chapter &<<SECTproxyInbound>>&.
12298
12299 .vitem &$prdr_requested$&
12300 .cindex "PRDR" "variable for"
12301 This variable is set to &"yes"& if PRDR was requested by the client for the
12302 current message, otherwise &"no"&.
12303
12304 .vitem &$prvscheck_address$&
12305 This variable is used in conjunction with the &%prvscheck%& expansion item,
12306 which is described in sections &<<SECTexpansionitems>>& and
12307 &<<SECTverifyPRVS>>&.
12308
12309 .vitem &$prvscheck_keynum$&
12310 This variable is used in conjunction with the &%prvscheck%& expansion item,
12311 which is described in sections &<<SECTexpansionitems>>& and
12312 &<<SECTverifyPRVS>>&.
12313
12314 .vitem &$prvscheck_result$&
12315 This variable is used in conjunction with the &%prvscheck%& expansion item,
12316 which is described in sections &<<SECTexpansionitems>>& and
12317 &<<SECTverifyPRVS>>&.
12318
12319 .vitem &$qualify_domain$&
12320 .vindex "&$qualify_domain$&"
12321 The value set for the &%qualify_domain%& option in the configuration file.
12322
12323 .vitem &$qualify_recipient$&
12324 .vindex "&$qualify_recipient$&"
12325 The value set for the &%qualify_recipient%& option in the configuration file,
12326 or if not set, the value of &$qualify_domain$&.
12327
12328 .vitem &$queue_name$&
12329 .vindex &$queue_name$&
12330 .cindex "named queues"
12331 .cindex queues named
12332 The name of the spool queue in use; empty for the default queue.
12333
12334 .vitem &$rcpt_count$&
12335 .vindex "&$rcpt_count$&"
12336 When a message is being received by SMTP, this variable contains the number of
12337 RCPT commands received for the current message. If this variable is used in a
12338 RCPT ACL, its value includes the current command.
12339
12340 .vitem &$rcpt_defer_count$&
12341 .vindex "&$rcpt_defer_count$&"
12342 .cindex "4&'xx'& responses" "count of"
12343 When a message is being received by SMTP, this variable contains the number of
12344 RCPT commands in the current message that have previously been rejected with a
12345 temporary (4&'xx'&) response.
12346
12347 .vitem &$rcpt_fail_count$&
12348 .vindex "&$rcpt_fail_count$&"
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 permanent (5&'xx'&) response.
12352
12353 .vitem &$received_count$&
12354 .vindex "&$received_count$&"
12355 This variable contains the number of &'Received:'& header lines in the message,
12356 including the one added by Exim (so its value is always greater than zero). It
12357 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12358 delivering.
12359
12360 .vitem &$received_for$&
12361 .vindex "&$received_for$&"
12362 If there is only a single recipient address in an incoming message, this
12363 variable contains that address when the &'Received:'& header line is being
12364 built. The value is copied after recipient rewriting has happened, but before
12365 the &[local_scan()]& function is run.
12366
12367 .vitem &$received_ip_address$&
12368 .vindex "&$received_ip_address$&"
12369 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12370 variable is set to the address of the local IP interface, and &$received_port$&
12371 is set to the local port number. (The remote IP address and port are in
12372 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12373 the port value is -1 unless it has been set using the &%-oMi%& command line
12374 option.
12375
12376 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12377 could be used, for example, to make the file name for a TLS certificate depend
12378 on which interface and/or port is being used for the incoming connection. The
12379 values of &$received_ip_address$& and &$received_port$& are saved with any
12380 messages that are received, thus making these variables available at delivery
12381 time.
12382 For outbound connections see &$sending_ip_address$&.
12383
12384 .vitem &$received_port$&
12385 .vindex "&$received_port$&"
12386 See &$received_ip_address$&.
12387
12388 .vitem &$received_protocol$&
12389 .vindex "&$received_protocol$&"
12390 When a message is being processed, this variable contains the name of the
12391 protocol by which it was received. Most of the names used by Exim are defined
12392 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12393 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12394 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12395 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12396 connection and the client was successfully authenticated.
12397
12398 Exim uses the protocol name &"smtps"& for the case when encryption is
12399 automatically set up on connection without the use of STARTTLS (see
12400 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12401 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12402 where the client initially uses EHLO, sets up an encrypted connection using
12403 STARTTLS, and then uses HELO afterwards.
12404
12405 The &%-oMr%& option provides a way of specifying a custom protocol name for
12406 messages that are injected locally by trusted callers. This is commonly used to
12407 identify messages that are being re-injected after some kind of scanning.
12408
12409 .vitem &$received_time$&
12410 .vindex "&$received_time$&"
12411 This variable contains the date and time when the current message was received,
12412 as a number of seconds since the start of the Unix epoch.
12413
12414 .vitem &$recipient_data$&
12415 .vindex "&$recipient_data$&"
12416 This variable is set after an indexing lookup success in an ACL &%recipients%&
12417 condition. It contains the data from the lookup, and the value remains set
12418 until the next &%recipients%& test. Thus, you can do things like this:
12419 .display
12420 &`require recipients  = cdb*@;/some/file`&
12421 &`deny    `&&'some further test involving'& &`$recipient_data`&
12422 .endd
12423 &*Warning*&: This variable is set only when a lookup is used as an indexing
12424 method in the address list, using the semicolon syntax as in the example above.
12425 The variable is not set for a lookup that is used as part of the string
12426 expansion that all such lists undergo before being interpreted.
12427
12428 .vitem &$recipient_verify_failure$&
12429 .vindex "&$recipient_verify_failure$&"
12430 In an ACL, when a recipient verification fails, this variable contains
12431 information about the failure. It is set to one of the following words:
12432
12433 .ilist
12434 &"qualify"&: The address was unqualified (no domain), and the message
12435 was neither local nor came from an exempted host.
12436
12437 .next
12438 &"route"&: Routing failed.
12439
12440 .next
12441 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12442 or before the MAIL command (that is, on initial connection, HELO, or
12443 MAIL).
12444
12445 .next
12446 &"recipient"&: The RCPT command in a callout was rejected.
12447 .next
12448
12449 &"postmaster"&: The postmaster check in a callout was rejected.
12450 .endlist
12451
12452 The main use of this variable is expected to be to distinguish between
12453 rejections of MAIL and rejections of RCPT.
12454
12455 .vitem &$recipients$&
12456 .vindex "&$recipients$&"
12457 This variable contains a list of envelope recipients for a message. A comma and
12458 a space separate the addresses in the replacement text. However, the variable
12459 is not generally available, to prevent exposure of Bcc recipients in
12460 unprivileged users' filter files. You can use &$recipients$& only in these
12461 cases:
12462
12463 .olist
12464 In a system filter file.
12465 .next
12466 In the ACLs associated with the DATA command and with non-SMTP messages, that
12467 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12468 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12469 &%acl_not_smtp_mime%&.
12470 .next
12471 From within a &[local_scan()]& function.
12472 .endlist
12473
12474
12475 .vitem &$recipients_count$&
12476 .vindex "&$recipients_count$&"
12477 When a message is being processed, this variable contains the number of
12478 envelope recipients that came with the message. Duplicates are not excluded
12479 from the count. While a message is being received over SMTP, the number
12480 increases for each accepted recipient. It can be referenced in an ACL.
12481
12482
12483 .vitem &$regex_match_string$&
12484 .vindex "&$regex_match_string$&"
12485 This variable is set to contain the matching regular expression after a
12486 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12487
12488 .vitem "&$regex1$&, &$regex2$&, etc"
12489 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12490 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12491 these variables contain the
12492 captured substrings identified by the regular expression.
12493
12494
12495 .vitem &$reply_address$&
12496 .vindex "&$reply_address$&"
12497 When a message is being processed, this variable contains the contents of the
12498 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12499 contents of the &'From:'& header line. Apart from the removal of leading
12500 white space, the value is not processed in any way. In particular, no RFC 2047
12501 decoding or character code translation takes place.
12502
12503 .vitem &$return_path$&
12504 .vindex "&$return_path$&"
12505 When a message is being delivered, this variable contains the return path &--
12506 the sender field that will be sent as part of the envelope. It is not enclosed
12507 in <> characters. At the start of routing an address, &$return_path$& has the
12508 same value as &$sender_address$&, but if, for example, an incoming message to a
12509 mailing list has been expanded by a router which specifies a different address
12510 for bounce messages, &$return_path$& subsequently contains the new bounce
12511 address, whereas &$sender_address$& always contains the original sender address
12512 that was received with the message. In other words, &$sender_address$& contains
12513 the incoming envelope sender, and &$return_path$& contains the outgoing
12514 envelope sender.
12515
12516 .vitem &$return_size_limit$&
12517 .vindex "&$return_size_limit$&"
12518 This is an obsolete name for &$bounce_return_size_limit$&.
12519
12520 .vitem &$router_name$&
12521 .cindex "router" "name"
12522 .cindex "name" "of router"
12523 .vindex "&$router_name$&"
12524 During the running of a router this variable contains its name.
12525
12526 .vitem &$runrc$&
12527 .cindex "return code" "from &%run%& expansion"
12528 .vindex "&$runrc$&"
12529 This variable contains the return code from a command that is run by the
12530 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12531 assume the order in which option values are expanded, except for those
12532 preconditions whose order of testing is documented. Therefore, you cannot
12533 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12534 another.
12535
12536 .vitem &$self_hostname$&
12537 .oindex "&%self%&" "value of host name"
12538 .vindex "&$self_hostname$&"
12539 When an address is routed to a supposedly remote host that turns out to be the
12540 local host, what happens is controlled by the &%self%& generic router option.
12541 One of its values causes the address to be passed to another router. When this
12542 happens, &$self_hostname$& is set to the name of the local host that the
12543 original router encountered. In other circumstances its contents are null.
12544
12545 .vitem &$sender_address$&
12546 .vindex "&$sender_address$&"
12547 When a message is being processed, this variable contains the sender's address
12548 that was received in the message's envelope. The case of letters in the address
12549 is retained, in both the local part and the domain. For bounce messages, the
12550 value of this variable is the empty string. See also &$return_path$&.
12551
12552 .vitem &$sender_address_data$&
12553 .vindex "&$address_data$&"
12554 .vindex "&$sender_address_data$&"
12555 If &$address_data$& is set when the routers are called from an ACL to verify a
12556 sender address, the final value is preserved in &$sender_address_data$&, to
12557 distinguish it from data from a recipient address. The value does not persist
12558 after the end of the current ACL statement. If you want to preserve it for
12559 longer, you can save it in an ACL variable.
12560
12561 .vitem &$sender_address_domain$&
12562 .vindex "&$sender_address_domain$&"
12563 The domain portion of &$sender_address$&.
12564
12565 .vitem &$sender_address_local_part$&
12566 .vindex "&$sender_address_local_part$&"
12567 The local part portion of &$sender_address$&.
12568
12569 .vitem &$sender_data$&
12570 .vindex "&$sender_data$&"
12571 This variable is set after a lookup success in an ACL &%senders%& condition or
12572 in a router &%senders%& option. It contains the data from the lookup, and the
12573 value remains set until the next &%senders%& test. Thus, you can do things like
12574 this:
12575 .display
12576 &`require senders      = cdb*@;/some/file`&
12577 &`deny    `&&'some further test involving'& &`$sender_data`&
12578 .endd
12579 &*Warning*&: This variable is set only when a lookup is used as an indexing
12580 method in the address list, using the semicolon syntax as in the example above.
12581 The variable is not set for a lookup that is used as part of the string
12582 expansion that all such lists undergo before being interpreted.
12583
12584 .vitem &$sender_fullhost$&
12585 .vindex "&$sender_fullhost$&"
12586 When a message is received from a remote host, this variable contains the host
12587 name and IP address in a single string. It ends with the IP address in square
12588 brackets, followed by a colon and a port number if the logging of ports is
12589 enabled. The format of the rest of the string depends on whether the host
12590 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12591 looking up its IP address. (Looking up the IP address can be forced by the
12592 &%host_lookup%& option, independent of verification.) A plain host name at the
12593 start of the string is a verified host name; if this is not present,
12594 verification either failed or was not requested. A host name in parentheses is
12595 the argument of a HELO or EHLO command. This is omitted if it is identical to
12596 the verified host name or to the host's IP address in square brackets.
12597
12598 .vitem &$sender_helo_dnssec$&
12599 .vindex "&$sender_helo_dnssec$&"
12600 This boolean variable is true if a successful HELO verification was
12601 .cindex "DNS" "DNSSEC"
12602 done using DNS information the resolver library stated was authenticated data.
12603
12604 .vitem &$sender_helo_name$&
12605 .vindex "&$sender_helo_name$&"
12606 When a message is received from a remote host that has issued a HELO or EHLO
12607 command, the argument of that command is placed in this variable. It is also
12608 set if HELO or EHLO is used when a message is received using SMTP locally via
12609 the &%-bs%& or &%-bS%& options.
12610
12611 .vitem &$sender_host_address$&
12612 .vindex "&$sender_host_address$&"
12613 When a message is received from a remote host using SMTP,
12614 this variable contains that
12615 host's IP address. For locally non-SMTP submitted messages, it is empty.
12616
12617 .vitem &$sender_host_authenticated$&
12618 .vindex "&$sender_host_authenticated$&"
12619 This variable contains the name (not the public name) of the authenticator
12620 driver that successfully authenticated the client from which the message was
12621 received. It is empty if there was no successful authentication. See also
12622 &$authenticated_id$&.
12623
12624 .vitem &$sender_host_dnssec$&
12625 .vindex "&$sender_host_dnssec$&"
12626 If an attempt to populate &$sender_host_name$& has been made
12627 (by reference, &%hosts_lookup%& or
12628 otherwise) then this boolean will have been set true if, and only if, the
12629 resolver library states that both
12630 the reverse and forward DNS were authenticated data.  At all
12631 other times, this variable is false.
12632
12633 .cindex "DNS" "DNSSEC"
12634 It is likely that you will need to coerce DNSSEC support on in the resolver
12635 library, by setting:
12636 .code
12637 dns_dnssec_ok = 1
12638 .endd
12639
12640 Exim does not perform DNSSEC validation itself, instead leaving that to a
12641 validating resolver (e.g. unbound, or bind with suitable configuration).
12642
12643 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12644 mechanism in the list, then this variable will be false.
12645
12646 This requires that your system resolver library support EDNS0 (and that
12647 DNSSEC flags exist in the system headers).  If the resolver silently drops
12648 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
12649 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
12650
12651
12652 .vitem &$sender_host_name$&
12653 .vindex "&$sender_host_name$&"
12654 When a message is received from a remote host, this variable contains the
12655 host's name as obtained by looking up its IP address. For messages received by
12656 other means, this variable is empty.
12657
12658 .vindex "&$host_lookup_failed$&"
12659 If the host name has not previously been looked up, a reference to
12660 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12661 A looked up name is accepted only if it leads back to the original IP address
12662 via a forward lookup. If either the reverse or the forward lookup fails to find
12663 any data, or if the forward lookup does not yield the original IP address,
12664 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12665
12666 .vindex "&$host_lookup_deferred$&"
12667 However, if either of the lookups cannot be completed (for example, there is a
12668 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12669 &$host_lookup_failed$& remains set to &"0"&.
12670
12671 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12672 host name again if there is a subsequent reference to &$sender_host_name$&
12673 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12674 is set to &"1"&.
12675
12676 Exim does not automatically look up every calling host's name. If you want
12677 maximum efficiency, you should arrange your configuration so that it avoids
12678 these lookups altogether. The lookup happens only if one or more of the
12679 following are true:
12680
12681 .ilist
12682 A string containing &$sender_host_name$& is expanded.
12683 .next
12684 The calling host matches the list in &%host_lookup%&. In the default
12685 configuration, this option is set to *, so it must be changed if lookups are
12686 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12687 .next
12688 Exim needs the host name in order to test an item in a host list. The items
12689 that require this are described in sections &<<SECThoslispatnam>>& and
12690 &<<SECThoslispatnamsk>>&.
12691 .next
12692 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12693 In this case, the host name is required to compare with the name quoted in any
12694 EHLO or HELO commands that the client issues.
12695 .next
12696 The remote host issues a EHLO or HELO command that quotes one of the
12697 domains in &%helo_lookup_domains%&. The default value of this option is
12698 . ==== As this is a nested list, any displays it contains must be indented
12699 . ==== as otherwise they are too far to the left.
12700 .code
12701   helo_lookup_domains = @ : @[]
12702 .endd
12703 which causes a lookup if a remote host (incorrectly) gives the server's name or
12704 IP address in an EHLO or HELO command.
12705 .endlist
12706
12707
12708 .vitem &$sender_host_port$&
12709 .vindex "&$sender_host_port$&"
12710 When a message is received from a remote host, this variable contains the port
12711 number that was used on the remote host.
12712
12713 .vitem &$sender_ident$&
12714 .vindex "&$sender_ident$&"
12715 When a message is received from a remote host, this variable contains the
12716 identification received in response to an RFC 1413 request. When a message has
12717 been received locally, this variable contains the login name of the user that
12718 called Exim.
12719
12720 .vitem &$sender_rate_$&&'xxx'&
12721 A number of variables whose names begin &$sender_rate_$& are set as part of the
12722 &%ratelimit%& ACL condition. Details are given in section
12723 &<<SECTratelimiting>>&.
12724
12725 .vitem &$sender_rcvhost$&
12726 .cindex "DNS" "reverse lookup"
12727 .cindex "reverse DNS lookup"
12728 .vindex "&$sender_rcvhost$&"
12729 This is provided specifically for use in &'Received:'& headers. It starts with
12730 either the verified host name (as obtained from a reverse DNS lookup) or, if
12731 there is no verified host name, the IP address in square brackets. After that
12732 there may be text in parentheses. When the first item is a verified host name,
12733 the first thing in the parentheses is the IP address in square brackets,
12734 followed by a colon and a port number if port logging is enabled. When the
12735 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12736 the parentheses.
12737
12738 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12739 was used and its argument was not identical to the real host name or IP
12740 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12741 all three items are present in the parentheses, a newline and tab are inserted
12742 into the string, to improve the formatting of the &'Received:'& header.
12743
12744 .vitem &$sender_verify_failure$&
12745 .vindex "&$sender_verify_failure$&"
12746 In an ACL, when a sender verification fails, this variable contains information
12747 about the failure. The details are the same as for
12748 &$recipient_verify_failure$&.
12749
12750 .vitem &$sending_ip_address$&
12751 .vindex "&$sending_ip_address$&"
12752 This variable is set whenever an outgoing SMTP connection to another host has
12753 been set up. It contains the IP address of the local interface that is being
12754 used. This is useful if a host that has more than one IP address wants to take
12755 on different personalities depending on which one is being used. For incoming
12756 connections, see &$received_ip_address$&.
12757
12758 .vitem &$sending_port$&
12759 .vindex "&$sending_port$&"
12760 This variable is set whenever an outgoing SMTP connection to another host has
12761 been set up. It contains the local port that is being used. For incoming
12762 connections, see &$received_port$&.
12763
12764 .vitem &$smtp_active_hostname$&
12765 .vindex "&$smtp_active_hostname$&"
12766 During an incoming SMTP session, this variable contains the value of the active
12767 host name, as specified by the &%smtp_active_hostname%& option. The value of
12768 &$smtp_active_hostname$& is saved with any message that is received, so its
12769 value can be consulted during routing and delivery.
12770
12771 .vitem &$smtp_command$&
12772 .vindex "&$smtp_command$&"
12773 During the processing of an incoming SMTP command, this variable contains the
12774 entire command. This makes it possible to distinguish between HELO and EHLO in
12775 the HELO ACL, and also to distinguish between commands such as these:
12776 .code
12777 MAIL FROM:<>
12778 MAIL FROM: <>
12779 .endd
12780 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12781 command, the address in &$smtp_command$& is the original address before any
12782 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12783 the address after SMTP-time rewriting.
12784
12785 .vitem &$smtp_command_argument$&
12786 .cindex "SMTP" "command, argument for"
12787 .vindex "&$smtp_command_argument$&"
12788 While an ACL is running to check an SMTP command, this variable contains the
12789 argument, that is, the text that follows the command name, with leading white
12790 space removed. Following the introduction of &$smtp_command$&, this variable is
12791 somewhat redundant, but is retained for backwards compatibility.
12792
12793 .vitem &$smtp_count_at_connection_start$&
12794 .vindex "&$smtp_count_at_connection_start$&"
12795 This variable is set greater than zero only in processes spawned by the Exim
12796 daemon for handling incoming SMTP connections. The name is deliberately long,
12797 in order to emphasize what the contents are. When the daemon accepts a new
12798 connection, it increments this variable. A copy of the variable is passed to
12799 the child process that handles the connection, but its value is fixed, and
12800 never changes. It is only an approximation of how many incoming connections
12801 there actually are, because many other connections may come and go while a
12802 single connection is being processed. When a child process terminates, the
12803 daemon decrements its copy of the variable.
12804
12805 .vitem "&$sn0$& &-- &$sn9$&"
12806 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12807 that were current at the end of the system filter file. This allows a system
12808 filter file to set values that can be tested in users' filter files. For
12809 example, a system filter could set a value indicating how likely it is that a
12810 message is junk mail.
12811
12812 .vitem &$spam_$&&'xxx'&
12813 A number of variables whose names start with &$spam$& are available when Exim
12814 is compiled with the content-scanning extension. For details, see section
12815 &<<SECTscanspamass>>&.
12816
12817
12818 .vitem &$spool_directory$&
12819 .vindex "&$spool_directory$&"
12820 The name of Exim's spool directory.
12821
12822 .vitem &$spool_inodes$&
12823 .vindex "&$spool_inodes$&"
12824 The number of free inodes in the disk partition where Exim's spool files are
12825 being written. The value is recalculated whenever the variable is referenced.
12826 If the relevant file system does not have the concept of inodes, the value of
12827 is -1. See also the &%check_spool_inodes%& option.
12828
12829 .vitem &$spool_space$&
12830 .vindex "&$spool_space$&"
12831 The amount of free space (as a number of kilobytes) in the disk partition where
12832 Exim's spool files are being written. The value is recalculated whenever the
12833 variable is referenced. If the operating system does not have the ability to
12834 find the amount of free space (only true for experimental systems), the space
12835 value is -1. For example, to check in an ACL that there is at least 50
12836 megabytes free on the spool, you could write:
12837 .code
12838 condition = ${if > {$spool_space}{50000}}
12839 .endd
12840 See also the &%check_spool_space%& option.
12841
12842
12843 .vitem &$thisaddress$&
12844 .vindex "&$thisaddress$&"
12845 This variable is set only during the processing of the &%foranyaddress%&
12846 command in a filter file. Its use is explained in the description of that
12847 command, which can be found in the separate document entitled &'Exim's
12848 interfaces to mail filtering'&.
12849
12850 .vitem &$tls_in_bits$&
12851 .vindex "&$tls_in_bits$&"
12852 Contains an approximation of the TLS cipher's bit-strength
12853 on the inbound connection; the meaning of
12854 this depends upon the TLS implementation used.
12855 If TLS has not been negotiated, the value will be 0.
12856 The value of this is automatically fed into the Cyrus SASL authenticator
12857 when acting as a server, to specify the "external SSF" (a SASL term).
12858
12859 The deprecated &$tls_bits$& variable refers to the inbound side
12860 except when used in the context of an outbound SMTP delivery, when it refers to
12861 the outbound.
12862
12863 .vitem &$tls_out_bits$&
12864 .vindex "&$tls_out_bits$&"
12865 Contains an approximation of the TLS cipher's bit-strength
12866 on an outbound SMTP connection; the meaning of
12867 this depends upon the TLS implementation used.
12868 If TLS has not been negotiated, the value will be 0.
12869
12870 .vitem &$tls_in_ourcert$&
12871 .vindex "&$tls_in_ourcert$&"
12872 .cindex certificate variables
12873 This variable refers to the certificate presented to the peer of an
12874 inbound connection when the message was received.
12875 It is only useful as the argument of a
12876 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12877 or a &%def%& condition.
12878
12879 .vitem &$tls_in_peercert$&
12880 .vindex "&$tls_in_peercert$&"
12881 This variable refers to the certificate presented by the peer of an
12882 inbound connection when the message was received.
12883 It is only useful as the argument of a
12884 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12885 or a &%def%& condition.
12886 If certificate verification fails it may refer to a failing chain element
12887 which is not the leaf.
12888
12889 .vitem &$tls_out_ourcert$&
12890 .vindex "&$tls_out_ourcert$&"
12891 This variable refers to the certificate presented to the peer of an
12892 outbound connection.  It is only useful as the argument of a
12893 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12894 or a &%def%& condition.
12895
12896 .vitem &$tls_out_peercert$&
12897 .vindex "&$tls_out_peercert$&"
12898 This variable refers to the certificate presented by the peer of an
12899 outbound connection.  It is only useful as the argument of a
12900 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12901 or a &%def%& condition.
12902 If certificate verification fails it may refer to a failing chain element
12903 which is not the leaf.
12904
12905 .vitem &$tls_in_certificate_verified$&
12906 .vindex "&$tls_in_certificate_verified$&"
12907 This variable is set to &"1"& if a TLS certificate was verified when the
12908 message was received, and &"0"& otherwise.
12909
12910 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12911 except when used in the context of an outbound SMTP delivery, when it refers to
12912 the outbound.
12913
12914 .vitem &$tls_out_certificate_verified$&
12915 .vindex "&$tls_out_certificate_verified$&"
12916 This variable is set to &"1"& if a TLS certificate was verified when an
12917 outbound SMTP connection was made,
12918 and &"0"& otherwise.
12919
12920 .vitem &$tls_in_cipher$&
12921 .vindex "&$tls_in_cipher$&"
12922 .vindex "&$tls_cipher$&"
12923 When a message is received from a remote host over an encrypted SMTP
12924 connection, this variable is set to the cipher suite that was negotiated, for
12925 example DES-CBC3-SHA. In other circumstances, in particular, for message
12926 received over unencrypted connections, the variable is empty. Testing
12927 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
12928 non-encrypted connections during ACL processing.
12929
12930 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12931 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12932 becomes the same as &$tls_out_cipher$&.
12933
12934 .vitem &$tls_out_cipher$&
12935 .vindex "&$tls_out_cipher$&"
12936 This variable is
12937 cleared before any outgoing SMTP connection is made,
12938 and then set to the outgoing cipher suite if one is negotiated. See chapter
12939 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12940 details of the &(smtp)& transport.
12941
12942 .vitem &$tls_in_ocsp$&
12943 .vindex "&$tls_in_ocsp$&"
12944 When a message is received from a remote client connection
12945 the result of any OCSP request from the client is encoded in this variable:
12946 .code
12947 0 OCSP proof was not requested (default value)
12948 1 No response to request
12949 2 Response not verified
12950 3 Verification failed
12951 4 Verification succeeded
12952 .endd
12953
12954 .vitem &$tls_out_ocsp$&
12955 .vindex "&$tls_out_ocsp$&"
12956 When a message is sent to a remote host connection
12957 the result of any OCSP request made is encoded in this variable.
12958 See &$tls_in_ocsp$& for values.
12959
12960 .vitem &$tls_in_peerdn$&
12961 .vindex "&$tls_in_peerdn$&"
12962 .vindex "&$tls_peerdn$&"
12963 .cindex certificate "extracting fields"
12964 When a message is received from a remote host over an encrypted SMTP
12965 connection, and Exim is configured to request a certificate from the client,
12966 the value of the Distinguished Name of the certificate is made available in the
12967 &$tls_in_peerdn$& during subsequent processing.
12968 If certificate verification fails it may refer to a failing chain element
12969 which is not the leaf.
12970
12971 The deprecated &$tls_peerdn$& variable refers to the inbound side
12972 except when used in the context of an outbound SMTP delivery, when it refers to
12973 the outbound.
12974
12975 .vitem &$tls_out_peerdn$&
12976 .vindex "&$tls_out_peerdn$&"
12977 When a message is being delivered to a remote host over an encrypted SMTP
12978 connection, and Exim is configured to request a certificate from the server,
12979 the value of the Distinguished Name of the certificate is made available in the
12980 &$tls_out_peerdn$& during subsequent processing.
12981 If certificate verification fails it may refer to a failing chain element
12982 which is not the leaf.
12983
12984 .vitem &$tls_in_sni$&
12985 .vindex "&$tls_in_sni$&"
12986 .vindex "&$tls_sni$&"
12987 .cindex "TLS" "Server Name Indication"
12988 When a TLS session is being established, if the client sends the Server
12989 Name Indication extension, the value will be placed in this variable.
12990 If the variable appears in &%tls_certificate%& then this option and
12991 some others, described in &<<SECTtlssni>>&,
12992 will be re-expanded early in the TLS session, to permit
12993 a different certificate to be presented (and optionally a different key to be
12994 used) to the client, based upon the value of the SNI extension.
12995
12996 The deprecated &$tls_sni$& variable refers to the inbound side
12997 except when used in the context of an outbound SMTP delivery, when it refers to
12998 the outbound.
12999
13000 .vitem &$tls_out_sni$&
13001 .vindex "&$tls_out_sni$&"
13002 .cindex "TLS" "Server Name Indication"
13003 During outbound
13004 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13005 the transport.
13006
13007 .vitem &$tod_bsdinbox$&
13008 .vindex "&$tod_bsdinbox$&"
13009 The time of day and the date, in the format required for BSD-style mailbox
13010 files, for example: Thu Oct 17 17:14:09 1995.
13011
13012 .vitem &$tod_epoch$&
13013 .vindex "&$tod_epoch$&"
13014 The time and date as a number of seconds since the start of the Unix epoch.
13015
13016 .vitem &$tod_epoch_l$&
13017 .vindex "&$tod_epoch_l$&"
13018 The time and date as a number of microseconds since the start of the Unix epoch.
13019
13020 .vitem &$tod_full$&
13021 .vindex "&$tod_full$&"
13022 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13023 +0100. The timezone is always given as a numerical offset from UTC, with
13024 positive values used for timezones that are ahead (east) of UTC, and negative
13025 values for those that are behind (west).
13026
13027 .vitem &$tod_log$&
13028 .vindex "&$tod_log$&"
13029 The time and date in the format used for writing Exim's log files, for example:
13030 1995-10-12 15:32:29, but without a timezone.
13031
13032 .vitem &$tod_logfile$&
13033 .vindex "&$tod_logfile$&"
13034 This variable contains the date in the format yyyymmdd. This is the format that
13035 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13036 flag.
13037
13038 .vitem &$tod_zone$&
13039 .vindex "&$tod_zone$&"
13040 This variable contains the numerical value of the local timezone, for example:
13041 -0500.
13042
13043 .vitem &$tod_zulu$&
13044 .vindex "&$tod_zulu$&"
13045 This variable contains the UTC date and time in &"Zulu"& format, as specified
13046 by ISO 8601, for example: 20030221154023Z.
13047
13048 .vitem &$transport_name$&
13049 .cindex "transport" "name"
13050 .cindex "name" "of transport"
13051 .vindex "&$transport_name$&"
13052 During the running of a transport, this variable contains its name.
13053
13054 .vitem &$value$&
13055 .vindex "&$value$&"
13056 This variable contains the result of an expansion lookup, extraction operation,
13057 or external command, as described above. It is also used during a
13058 &*reduce*& expansion.
13059
13060 .vitem &$verify_mode$&
13061 .vindex "&$verify_mode$&"
13062 While a router or transport is being run in verify mode or for cutthrough delivery,
13063 contains "S" for sender-verification or "R" for recipient-verification.
13064 Otherwise, empty.
13065
13066 .vitem &$version_number$&
13067 .vindex "&$version_number$&"
13068 The version number of Exim.
13069
13070 .vitem &$warn_message_delay$&
13071 .vindex "&$warn_message_delay$&"
13072 This variable is set only during the creation of a message warning about a
13073 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13074
13075 .vitem &$warn_message_recipients$&
13076 .vindex "&$warn_message_recipients$&"
13077 This variable is set only during the creation of a message warning about a
13078 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13079 .endlist
13080 .ecindex IIDstrexp
13081
13082
13083
13084 . ////////////////////////////////////////////////////////////////////////////
13085 . ////////////////////////////////////////////////////////////////////////////
13086
13087 .chapter "Embedded Perl" "CHAPperl"
13088 .scindex IIDperl "Perl" "calling from Exim"
13089 Exim can be built to include an embedded Perl interpreter. When this is done,
13090 Perl subroutines can be called as part of the string expansion process. To make
13091 use of the Perl support, you need version 5.004 or later of Perl installed on
13092 your system. To include the embedded interpreter in the Exim binary, include
13093 the line
13094 .code
13095 EXIM_PERL = perl.o
13096 .endd
13097 in your &_Local/Makefile_& and then build Exim in the normal way.
13098
13099
13100 .section "Setting up so Perl can be used" "SECID85"
13101 .oindex "&%perl_startup%&"
13102 Access to Perl subroutines is via a global configuration option called
13103 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13104 no &%perl_startup%& option in the Exim configuration file then no Perl
13105 interpreter is started and there is almost no overhead for Exim (since none of
13106 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13107 option then the associated value is taken to be Perl code which is executed in
13108 a newly created Perl interpreter.
13109
13110 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13111 need backslashes before any characters to escape special meanings. The option
13112 should usually be something like
13113 .code
13114 perl_startup = do '/etc/exim.pl'
13115 .endd
13116 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13117 use from Exim. Exim can be configured either to start up a Perl interpreter as
13118 soon as it is entered, or to wait until the first time it is needed. Starting
13119 the interpreter at the beginning ensures that it is done while Exim still has
13120 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13121 fact used in a particular run. Also, note that this does not mean that Exim is
13122 necessarily running as root when Perl is called at a later time. By default,
13123 the interpreter is started only when it is needed, but this can be changed in
13124 two ways:
13125
13126 .ilist
13127 .oindex "&%perl_at_start%&"
13128 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13129 a startup when Exim is entered.
13130 .next
13131 The command line option &%-ps%& also requests a startup when Exim is entered,
13132 overriding the setting of &%perl_at_start%&.
13133 .endlist
13134
13135 There is also a command line option &%-pd%& (for delay) which suppresses the
13136 initial startup, even if &%perl_at_start%& is set.
13137
13138 .ilist
13139 .oindex "&%perl_taintmode%&"
13140 .cindex "Perl" "taintmode"
13141 To provide more security executing Perl code via the embedded Perl
13142 interpreter, the &%perl_taintmode%& option can be set. This enables the
13143 taint mode of the Perl interpreter. You are encouraged to set this
13144 option to a true value. To avoid breaking existing installations, it
13145 defaults to false.
13146
13147
13148 .section "Calling Perl subroutines" "SECID86"
13149 When the configuration file includes a &%perl_startup%& option you can make use
13150 of the string expansion item to call the Perl subroutines that are defined
13151 by the &%perl_startup%& code. The operator is used in any of the following
13152 forms:
13153 .code
13154 ${perl{foo}}
13155 ${perl{foo}{argument}}
13156 ${perl{foo}{argument1}{argument2} ... }
13157 .endd
13158 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13159 arguments may be passed. Passing more than this results in an expansion failure
13160 with an error message of the form
13161 .code
13162 Too many arguments passed to Perl subroutine "foo" (max is 8)
13163 .endd
13164 The return value of the Perl subroutine is evaluated in a scalar context before
13165 it is passed back to Exim to be inserted into the expanded string. If the
13166 return value is &'undef'&, the expansion is forced to fail in the same way as
13167 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13168 by obeying Perl's &%die%& function, the expansion fails with the error message
13169 that was passed to &%die%&.
13170
13171
13172 .section "Calling Exim functions from Perl" "SECID87"
13173 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13174 is available to call back into Exim's string expansion function. For example,
13175 the Perl code
13176 .code
13177 my $lp = Exim::expand_string('$local_part');
13178 .endd
13179 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13180 Note those are single quotes and not double quotes to protect against
13181 &$local_part$& being interpolated as a Perl variable.
13182
13183 If the string expansion is forced to fail by a &"fail"& item, the result of
13184 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13185 expansion string, the Perl call from the original expansion string fails with
13186 an appropriate error message, in the same way as if &%die%& were used.
13187
13188 .cindex "debugging" "from embedded Perl"
13189 .cindex "log" "writing from embedded Perl"
13190 Two other Exim functions are available for use from within Perl code.
13191 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13192 debugging is enabled. If you want a newline at the end, you must supply it.
13193 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13194 timestamp. In this case, you should not supply a terminating newline.
13195
13196
13197 .section "Use of standard output and error by Perl" "SECID88"
13198 .cindex "Perl" "standard output and error"
13199 You should not write to the standard error or output streams from within your
13200 Perl code, as it is not defined how these are set up. In versions of Exim
13201 before 4.50, it is possible for the standard output or error to refer to the
13202 SMTP connection during message reception via the daemon. Writing to this stream
13203 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13204 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13205 avoided, but the output is lost.
13206
13207 .cindex "Perl" "use of &%warn%&"
13208 The Perl &%warn%& statement writes to the standard error stream by default.
13209 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13210 you have no control. When Exim starts up the Perl interpreter, it arranges for
13211 output from the &%warn%& statement to be written to the Exim main log. You can
13212 change this by including appropriate Perl magic somewhere in your Perl code.
13213 For example, to discard &%warn%& output completely, you need this:
13214 .code
13215 $SIG{__WARN__} = sub { };
13216 .endd
13217 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13218 example, the code for the subroutine is empty, so it does nothing, but you can
13219 include any Perl code that you like. The text of the &%warn%& message is passed
13220 as the first subroutine argument.
13221 .ecindex IIDperl
13222
13223
13224 . ////////////////////////////////////////////////////////////////////////////
13225 . ////////////////////////////////////////////////////////////////////////////
13226
13227 .chapter "Starting the daemon and the use of network interfaces" &&&
13228          "CHAPinterfaces" &&&
13229          "Starting the daemon"
13230 .cindex "daemon" "starting"
13231 .cindex "interface" "listening"
13232 .cindex "network interface"
13233 .cindex "interface" "network"
13234 .cindex "IP address" "for listening"
13235 .cindex "daemon" "listening IP addresses"
13236 .cindex "TCP/IP" "setting listening interfaces"
13237 .cindex "TCP/IP" "setting listening ports"
13238 A host that is connected to a TCP/IP network may have one or more physical
13239 hardware network interfaces. Each of these interfaces may be configured as one
13240 or more &"logical"& interfaces, which are the entities that a program actually
13241 works with. Each of these logical interfaces is associated with an IP address.
13242 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13243 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13244 knowledge about the host's interfaces for use in three different circumstances:
13245
13246 .olist
13247 When a listening daemon is started, Exim needs to know which interfaces
13248 and ports to listen on.
13249 .next
13250 When Exim is routing an address, it needs to know which IP addresses
13251 are associated with local interfaces. This is required for the correct
13252 processing of MX lists by removing the local host and others with the
13253 same or higher priority values. Also, Exim needs to detect cases
13254 when an address is routed to an IP address that in fact belongs to the
13255 local host. Unless the &%self%& router option or the &%allow_localhost%&
13256 option of the smtp transport is set (as appropriate), this is treated
13257 as an error situation.
13258 .next
13259 When Exim connects to a remote host, it may need to know which interface to use
13260 for the outgoing connection.
13261 .endlist
13262
13263
13264 Exim's default behaviour is likely to be appropriate in the vast majority
13265 of cases. If your host has only one interface, and you want all its IP
13266 addresses to be treated in the same way, and you are using only the
13267 standard SMTP port, you should not need to take any special action. The
13268 rest of this chapter does not apply to you.
13269
13270 In a more complicated situation you may want to listen only on certain
13271 interfaces, or on different ports, and for this reason there are a number of
13272 options that can be used to influence Exim's behaviour. The rest of this
13273 chapter describes how they operate.
13274
13275 When a message is received over TCP/IP, the interface and port that were
13276 actually used are set in &$received_ip_address$& and &$received_port$&.
13277
13278
13279
13280 .section "Starting a listening daemon" "SECID89"
13281 When a listening daemon is started (by means of the &%-bd%& command line
13282 option), the interfaces and ports on which it listens are controlled by the
13283 following options:
13284
13285 .ilist
13286 &%daemon_smtp_ports%& contains a list of default ports
13287 or service names.
13288 (For backward compatibility, this option can also be specified in the singular.)
13289 .next
13290 &%local_interfaces%& contains list of interface IP addresses on which to
13291 listen. Each item may optionally also specify a port.
13292 .endlist
13293
13294 The default list separator in both cases is a colon, but this can be changed as
13295 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13296 it is usually best to change the separator to avoid having to double all the
13297 colons. For example:
13298 .code
13299 local_interfaces = <; 127.0.0.1 ; \
13300                       192.168.23.65 ; \
13301                       ::1 ; \
13302                       3ffe:ffff:836f::fe86:a061
13303 .endd
13304 There are two different formats for specifying a port along with an IP address
13305 in &%local_interfaces%&:
13306
13307 .olist
13308 The port is added onto the address with a dot separator. For example, to listen
13309 on port 1234 on two different IP addresses:
13310 .code
13311 local_interfaces = <; 192.168.23.65.1234 ; \
13312                       3ffe:ffff:836f::fe86:a061.1234
13313 .endd
13314 .next
13315 The IP address is enclosed in square brackets, and the port is added
13316 with a colon separator, for example:
13317 .code
13318 local_interfaces = <; [192.168.23.65]:1234 ; \
13319                       [3ffe:ffff:836f::fe86:a061]:1234
13320 .endd
13321 .endlist
13322
13323 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13324 default setting contains just one port:
13325 .code
13326 daemon_smtp_ports = smtp
13327 .endd
13328 If more than one port is listed, each interface that does not have its own port
13329 specified listens on all of them. Ports that are listed in
13330 &%daemon_smtp_ports%& can be identified either by name (defined in
13331 &_/etc/services_&) or by number. However, when ports are given with individual
13332 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13333
13334
13335
13336 .section "Special IP listening addresses" "SECID90"
13337 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13338 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13339 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13340 instead of setting up separate listening sockets for each interface. The
13341 default value of &%local_interfaces%& is
13342 .code
13343 local_interfaces = 0.0.0.0
13344 .endd
13345 when Exim is built without IPv6 support; otherwise it is:
13346 .code
13347 local_interfaces = <; ::0 ; 0.0.0.0
13348 .endd
13349 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13350
13351
13352
13353 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13354 The &%-oX%& command line option can be used to override the values of
13355 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13356 instance. Another way of doing this would be to use macros and the &%-D%&
13357 option. However, &%-oX%& can be used by any admin user, whereas modification of
13358 the runtime configuration by &%-D%& is allowed only when the caller is root or
13359 exim.
13360
13361 The value of &%-oX%& is a list of items. The default colon separator can be
13362 changed in the usual way if required. If there are any items that do not
13363 contain dots or colons (that is, are not IP addresses), the value of
13364 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13365 items that do contain dots or colons, the value of &%local_interfaces%& is
13366 replaced by those items. Thus, for example,
13367 .code
13368 -oX 1225
13369 .endd
13370 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13371 whereas
13372 .code
13373 -oX 192.168.34.5.1125
13374 .endd
13375 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13376 (However, since &%local_interfaces%& now contains no items without ports, the
13377 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13378
13379
13380
13381 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13382 .cindex "ssmtp protocol"
13383 .cindex "smtps protocol"
13384 .cindex "SMTP" "ssmtp protocol"
13385 .cindex "SMTP" "smtps protocol"
13386 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13387 before the STARTTLS command was standardized for SMTP. Some legacy clients
13388 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13389 list of port numbers or service names,
13390 connections to those ports must use SSMTP. The most
13391 common use of this option is expected to be
13392 .code
13393 tls_on_connect_ports = 465
13394 .endd
13395 because 465 is the usual port number used by the legacy clients. There is also
13396 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13397 this way when a daemon is started.
13398
13399 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13400 daemon to listen on those ports. You must still specify them in
13401 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13402 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13403 connections via the daemon.)
13404
13405
13406
13407
13408 .section "IPv6 address scopes" "SECID92"
13409 .cindex "IPv6" "address scopes"
13410 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13411 can, in principle, have the same link-local IPv6 address on different
13412 interfaces. Thus, additional information is needed, over and above the IP
13413 address, to distinguish individual interfaces. A convention of using a
13414 percent sign followed by something (often the interface name) has been
13415 adopted in some cases, leading to addresses like this:
13416 .code
13417 fe80::202:b3ff:fe03:45c1%eth0
13418 .endd
13419 To accommodate this usage, a percent sign followed by an arbitrary string is
13420 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13421 to convert a textual IPv6 address for actual use. This function recognizes the
13422 percent convention in operating systems that support it, and it processes the
13423 address appropriately. Unfortunately, some older libraries have problems with
13424 &[getaddrinfo()]&. If
13425 .code
13426 IPV6_USE_INET_PTON=yes
13427 .endd
13428 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13429 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13430 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13431 function.) Of course, this means that the additional functionality of
13432 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13433
13434 .section "Disabling IPv6" "SECID93"
13435 .cindex "IPv6" "disabling"
13436 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13437 run on a host whose kernel does not support IPv6. The binary will fall back to
13438 using IPv4, but it may waste resources looking up AAAA records, and trying to
13439 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13440 .oindex "&%disable_ipv6%&"
13441 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13442 activities take place. AAAA records are never looked up, and any IPv6 addresses
13443 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13444 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13445 to handle IPv6 literal addresses.
13446
13447 On the other hand, when IPv6 is in use, there may be times when you want to
13448 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13449 option to globally suppress the lookup of AAAA records for specified domains,
13450 and you can use the &%ignore_target_hosts%& generic router option to ignore
13451 IPv6 addresses in an individual router.
13452
13453
13454
13455 .section "Examples of starting a listening daemon" "SECID94"
13456 The default case in an IPv6 environment is
13457 .code
13458 daemon_smtp_ports = smtp
13459 local_interfaces = <; ::0 ; 0.0.0.0
13460 .endd
13461 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13462 Either one or two sockets may be used, depending on the characteristics of
13463 the TCP/IP stack. (This is complicated and messy; for more information,
13464 read the comments in the &_daemon.c_& source file.)
13465
13466 To specify listening on ports 25 and 26 on all interfaces:
13467 .code
13468 daemon_smtp_ports = 25 : 26
13469 .endd
13470 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13471 .code
13472 local_interfaces = <; ::0.25     ; ::0.26 \
13473                       0.0.0.0.25 ; 0.0.0.0.26
13474 .endd
13475 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13476 IPv4 loopback address only:
13477 .code
13478 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13479 .endd
13480 To specify listening on the default port on specific interfaces only:
13481 .code
13482 local_interfaces = 10.0.0.67 : 192.168.34.67
13483 .endd
13484 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13485
13486
13487
13488 .section "Recognizing the local host" "SECTreclocipadd"
13489 The &%local_interfaces%& option is also used when Exim needs to determine
13490 whether or not an IP address refers to the local host. That is, the IP
13491 addresses of all the interfaces on which a daemon is listening are always
13492 treated as local.
13493
13494 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13495 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13496 available interfaces from the operating system, and extracts the relevant
13497 (that is, IPv4 or IPv6) addresses to use for checking.
13498
13499 Some systems set up large numbers of virtual interfaces in order to provide
13500 many virtual web servers. In this situation, you may want to listen for
13501 email on only a few of the available interfaces, but nevertheless treat all
13502 interfaces as local when routing. You can do this by setting
13503 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13504 &"all"& wildcard values. These addresses are recognized as local, but are not
13505 used for listening. Consider this example:
13506 .code
13507 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13508                       192.168.53.235 ; \
13509                       3ffe:2101:12:1:a00:20ff:fe86:a061
13510
13511 extra_local_interfaces = <; ::0 ; 0.0.0.0
13512 .endd
13513 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13514 address, but all available interface addresses are treated as local when
13515 Exim is routing.
13516
13517 In some environments the local host name may be in an MX list, but with an IP
13518 address that is not assigned to any local interface. In other cases it may be
13519 desirable to treat other host names as if they referred to the local host. Both
13520 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13521 This contains host names rather than IP addresses. When a host is referenced
13522 during routing, either via an MX record or directly, it is treated as the local
13523 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13524 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13525
13526
13527
13528 .section "Delivering to a remote host" "SECID95"
13529 Delivery to a remote host is handled by the smtp transport. By default, it
13530 allows the system's TCP/IP functions to choose which interface to use (if
13531 there is more than one) when connecting to a remote host. However, the
13532 &%interface%& option can be set to specify which interface is used. See the
13533 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13534 details.
13535
13536
13537
13538
13539 . ////////////////////////////////////////////////////////////////////////////
13540 . ////////////////////////////////////////////////////////////////////////////
13541
13542 .chapter "Main configuration" "CHAPmainconfig"
13543 .scindex IIDconfima "configuration file" "main section"
13544 .scindex IIDmaiconf "main configuration"
13545 The first part of the run time configuration file contains three types of item:
13546
13547 .ilist
13548 Macro definitions: These lines start with an upper case letter. See section
13549 &<<SECTmacrodefs>>& for details of macro processing.
13550 .next
13551 Named list definitions: These lines start with one of the words &"domainlist"&,
13552 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13553 section &<<SECTnamedlists>>&.
13554 .next
13555 Main configuration settings: Each setting occupies one line of the file
13556 (with possible continuations). If any setting is preceded by the word
13557 &"hide"&, the &%-bP%& command line option displays its value to admin users
13558 only. See section &<<SECTcos>>& for a description of the syntax of these option
13559 settings.
13560 .endlist
13561
13562 This chapter specifies all the main configuration options, along with their
13563 types and default values. For ease of finding a particular option, they appear
13564 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13565 are now so many options, they are first listed briefly in functional groups, as
13566 an aid to finding the name of the option you are looking for. Some options are
13567 listed in more than one group.
13568
13569 .section "Miscellaneous" "SECID96"
13570 .table2
13571 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13572 .row &%debug_store%&                 "do extra internal checks"
13573 .row &%disable_ipv6%&                "do no IPv6 processing"
13574 .row &%keep_malformed%&              "for broken files &-- should not happen"
13575 .row &%localhost_number%&            "for unique message ids in clusters"
13576 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13577 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13578 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13579 .row &%print_topbitchars%&           "top-bit characters are printing"
13580 .row &%timezone%&                    "force time zone"
13581 .endtable
13582
13583
13584 .section "Exim parameters" "SECID97"
13585 .table2
13586 .row &%exim_group%&                  "override compiled-in value"
13587 .row &%exim_path%&                   "override compiled-in value"
13588 .row &%exim_user%&                   "override compiled-in value"
13589 .row &%primary_hostname%&            "default from &[uname()]&"
13590 .row &%split_spool_directory%&       "use multiple directories"
13591 .row &%spool_directory%&             "override compiled-in value"
13592 .endtable
13593
13594
13595
13596 .section "Privilege controls" "SECID98"
13597 .table2
13598 .row &%admin_groups%&                "groups that are Exim admin users"
13599 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13600 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13601 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13602 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13603 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13604 .row &%never_users%&                 "do not run deliveries as these"
13605 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13606 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13607 .row &%trusted_groups%&              "groups that are trusted"
13608 .row &%trusted_users%&               "users that are trusted"
13609 .endtable
13610
13611
13612
13613 .section "Logging" "SECID99"
13614 .table2
13615 .row &%event_action%&                "custom logging"
13616 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13617 .row &%log_file_path%&               "override compiled-in value"
13618 .row &%log_selector%&                "set/unset optional logging"
13619 .row &%log_timezone%&                "add timezone to log lines"
13620 .row &%message_logs%&                "create per-message logs"
13621 .row &%preserve_message_logs%&       "after message completion"
13622 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13623 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13624 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13625 .row &%syslog_facility%&             "set syslog &""facility""& field"
13626 .row &%syslog_pid%&                  "pid in syslog lines"
13627 .row &%syslog_processname%&          "set syslog &""ident""& field"
13628 .row &%syslog_timestamp%&            "timestamp syslog lines"
13629 .row &%write_rejectlog%&             "control use of message log"
13630 .endtable
13631
13632
13633
13634 .section "Frozen messages" "SECID100"
13635 .table2
13636 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13637 .row &%freeze_tell%&                 "send message when freezing"
13638 .row &%move_frozen_messages%&        "to another directory"
13639 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13640 .endtable
13641
13642
13643
13644 .section "Data lookups" "SECID101"
13645 .table2
13646 .row &%ibase_servers%&               "InterBase servers"
13647 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13648 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13649 .row &%ldap_cert_file%&              "client cert file for LDAP"
13650 .row &%ldap_cert_key%&               "client key file for LDAP"
13651 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13652 .row &%ldap_default_servers%&        "used if no server in query"
13653 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13654 .row &%ldap_start_tls%&              "require TLS within LDAP"
13655 .row &%ldap_version%&                "set protocol version"
13656 .row &%lookup_open_max%&             "lookup files held open"
13657 .row &%mysql_servers%&               "default MySQL servers"
13658 .row &%oracle_servers%&              "Oracle servers"
13659 .row &%pgsql_servers%&               "default PostgreSQL servers"
13660 .row &%sqlite_lock_timeout%&         "as it says"
13661 .endtable
13662
13663
13664
13665 .section "Message ids" "SECID102"
13666 .table2
13667 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13668 .row &%message_id_header_text%&      "ditto"
13669 .endtable
13670
13671
13672
13673 .section "Embedded Perl Startup" "SECID103"
13674 .table2
13675 .row &%perl_at_start%&               "always start the interpreter"
13676 .row &%perl_startup%&                "code to obey when starting Perl"
13677 .row &%perl_taintmode%&              "enable taint mode in Perl"
13678 .endtable
13679
13680
13681
13682 .section "Daemon" "SECID104"
13683 .table2
13684 .row &%daemon_smtp_ports%&           "default ports"
13685 .row &%daemon_startup_retries%&      "number of times to retry"
13686 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13687 .row &%extra_local_interfaces%&      "not necessarily listened on"
13688 .row &%local_interfaces%&            "on which to listen, with optional ports"
13689 .row &%pid_file_path%&               "override compiled-in value"
13690 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13691 .endtable
13692
13693
13694
13695 .section "Resource control" "SECID105"
13696 .table2
13697 .row &%check_log_inodes%&            "before accepting a message"
13698 .row &%check_log_space%&             "before accepting a message"
13699 .row &%check_spool_inodes%&          "before accepting a message"
13700 .row &%check_spool_space%&           "before accepting a message"
13701 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13702 .row &%queue_only_load%&             "queue incoming if load high"
13703 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13704 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13705 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13706 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13707 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13708 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13709 .row &%smtp_accept_max_per_connection%& "messages per connection"
13710 .row &%smtp_accept_max_per_host%&    "connections from one host"
13711 .row &%smtp_accept_queue%&           "queue mail if more connections"
13712 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13713                                            connection"
13714 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13715 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13716 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13717 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13718 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13719 .endtable
13720
13721
13722
13723 .section "Policy controls" "SECID106"
13724 .table2
13725 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13726 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13727 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13728 .row &%acl_smtp_auth%&               "ACL for AUTH"
13729 .row &%acl_smtp_connect%&            "ACL for connection"
13730 .row &%acl_smtp_data%&               "ACL for DATA"
13731 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13732 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13733 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13734 .row &%acl_smtp_expn%&               "ACL for EXPN"
13735 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13736 .row &%acl_smtp_mail%&               "ACL for MAIL"
13737 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13738 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13739 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13740 .row &%acl_smtp_predata%&            "ACL for start of data"
13741 .row &%acl_smtp_quit%&               "ACL for QUIT"
13742 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13743 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13744 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13745 .row &%av_scanner%&                  "specify virus scanner"
13746 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13747                                       words""&"
13748 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13749 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13750 .row &%header_maxsize%&              "total size of message header"
13751 .row &%header_line_maxsize%&         "individual header line limit"
13752 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13753 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13754 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13755 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13756 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13757 .row &%host_lookup%&                 "host name looked up for these hosts"
13758 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13759 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13760 .row &%host_reject_connection%&      "reject connection from these hosts"
13761 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13762 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13763 .row &%message_size_limit%&          "for all messages"
13764 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13765 .row &%spamd_address%&               "set interface to SpamAssassin"
13766 .row &%strict_acl_vars%&             "object to unset ACL variables"
13767 .endtable
13768
13769
13770
13771 .section "Callout cache" "SECID107"
13772 .table2
13773 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13774                                          item"
13775 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13776                                          item"
13777 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13778 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13779 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13780 .endtable
13781
13782
13783
13784 .section "TLS" "SECID108"
13785 .table2
13786 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13787 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13788 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13789 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13790 .row &%tls_certificate%&             "location of server certificate"
13791 .row &%tls_crl%&                     "certificate revocation list"
13792 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13793 .row &%tls_dhparam%&                 "DH parameters for server"
13794 .row &%tls_eccurve%&                 "EC curve selection for server"
13795 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13796 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13797 .row &%tls_privatekey%&              "location of server private key"
13798 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13799 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13800 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13801 .row &%tls_verify_certificates%&     "expected client certificates"
13802 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13803 .endtable
13804
13805
13806
13807 .section "Local user handling" "SECID109"
13808 .table2
13809 .row &%finduser_retries%&            "useful in NIS environments"
13810 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13811 .row &%gecos_pattern%&               "ditto"
13812 .row &%max_username_length%&         "for systems that truncate"
13813 .row &%unknown_login%&               "used when no login name found"
13814 .row &%unknown_username%&            "ditto"
13815 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13816 .row &%uucp_from_sender%&            "ditto"
13817 .endtable
13818
13819
13820
13821 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13822 .table2
13823 .row &%header_maxsize%&              "total size of message header"
13824 .row &%header_line_maxsize%&         "individual header line limit"
13825 .row &%message_size_limit%&          "applies to all messages"
13826 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13827 .row &%received_header_text%&        "expanded to make &'Received:'&"
13828 .row &%received_headers_max%&        "for mail loop detection"
13829 .row &%recipients_max%&              "limit per message"
13830 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13831 .endtable
13832
13833
13834
13835
13836 .section "Non-SMTP incoming messages" "SECID111"
13837 .table2
13838 .row &%receive_timeout%&             "for non-SMTP messages"
13839 .endtable
13840
13841
13842
13843
13844
13845 .section "Incoming SMTP messages" "SECID112"
13846 See also the &'Policy controls'& section above.
13847
13848 .table2
13849 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13850 .row &%host_lookup%&                 "host name looked up for these hosts"
13851 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13852 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13853 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13854 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13855 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13856 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13857 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13858 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13859 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13860 .row &%smtp_accept_max_per_connection%& "messages per connection"
13861 .row &%smtp_accept_max_per_host%&    "connections from one host"
13862 .row &%smtp_accept_queue%&           "queue mail if more connections"
13863 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13864                                            connection"
13865 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13866 .row &%smtp_active_hostname%&        "host name to use in messages"
13867 .row &%smtp_banner%&                 "text for welcome banner"
13868 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13869 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13870 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13871 .row &%smtp_etrn_command%&           "what to run for ETRN"
13872 .row &%smtp_etrn_serialize%&         "only one at once"
13873 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13874 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13875 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13876 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13877 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13878 .row &%smtp_receive_timeout%&        "per command or data line"
13879 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13880 .row &%smtp_return_error_details%&   "give detail on rejections"
13881 .endtable
13882
13883
13884
13885 .section "SMTP extensions" "SECID113"
13886 .table2
13887 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13888 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13889 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
13890 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13891 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13892 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13893 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13894 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13895 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13896 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13897 .endtable
13898
13899
13900
13901 .section "Processing messages" "SECID114"
13902 .table2
13903 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13904 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13905 .row &%allow_utf8_domains%&          "in addresses"
13906 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13907                                       words""&"
13908 .row &%delivery_date_remove%&        "from incoming messages"
13909 .row &%envelope_to_remove%&          "from incoming messages"
13910 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13911 .row &%headers_charset%&             "default for translations"
13912 .row &%qualify_domain%&              "default for senders"
13913 .row &%qualify_recipient%&           "default for recipients"
13914 .row &%return_path_remove%&          "from incoming messages"
13915 .row &%strip_excess_angle_brackets%& "in addresses"
13916 .row &%strip_trailing_dot%&          "at end of addresses"
13917 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13918 .endtable
13919
13920
13921
13922 .section "System filter" "SECID115"
13923 .table2
13924 .row &%system_filter%&               "locate system filter"
13925 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13926                                             directory"
13927 .row &%system_filter_file_transport%& "transport for delivery to a file"
13928 .row &%system_filter_group%&         "group for filter running"
13929 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13930 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13931 .row &%system_filter_user%&          "user for filter running"
13932 .endtable
13933
13934
13935
13936 .section "Routing and delivery" "SECID116"
13937 .table2
13938 .row &%disable_ipv6%&                "do no IPv6 processing"
13939 .row &%dns_again_means_nonexist%&    "for broken domains"
13940 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13941 .row &%dns_dnssec_ok%&               "parameter for resolver"
13942 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13943 .row &%dns_retrans%&                 "parameter for resolver"
13944 .row &%dns_retry%&                   "parameter for resolver"
13945 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13946 .row &%dns_use_edns0%&               "parameter for resolver"
13947 .row &%hold_domains%&                "hold delivery for these domains"
13948 .row &%local_interfaces%&            "for routing checks"
13949 .row &%queue_domains%&               "no immediate delivery for these"
13950 .row &%queue_only%&                  "no immediate delivery at all"
13951 .row &%queue_only_file%&             "no immediate delivery if file exists"
13952 .row &%queue_only_load%&             "no immediate delivery if load is high"
13953 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13954 .row &%queue_only_override%&         "allow command line to override"
13955 .row &%queue_run_in_order%&          "order of arrival"
13956 .row &%queue_run_max%&               "of simultaneous queue runners"
13957 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13958 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13959 .row &%remote_sort_domains%&         "order of remote deliveries"
13960 .row &%retry_data_expire%&           "timeout for retry data"
13961 .row &%retry_interval_max%&          "safety net for retry rules"
13962 .endtable
13963
13964
13965
13966 .section "Bounce and warning messages" "SECID117"
13967 .table2
13968 .row &%bounce_message_file%&         "content of bounce"
13969 .row &%bounce_message_text%&         "content of bounce"
13970 .row &%bounce_return_body%&          "include body if returning message"
13971 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13972 .row &%bounce_return_message%&       "include original message in bounce"
13973 .row &%bounce_return_size_limit%&    "limit on returned message"
13974 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13975 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13976 .row &%errors_copy%&                 "copy bounce messages"
13977 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13978 .row &%delay_warning%&               "time schedule"
13979 .row &%delay_warning_condition%&     "condition for warning messages"
13980 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13981 .row &%smtp_return_error_details%&   "give detail on rejections"
13982 .row &%warn_message_file%&           "content of warning message"
13983 .endtable
13984
13985
13986
13987 .section "Alphabetical list of main options" "SECTalomo"
13988 Those options that undergo string expansion before use are marked with
13989 &dagger;.
13990
13991 .option accept_8bitmime main boolean true
13992 .cindex "8BITMIME"
13993 .cindex "8-bit characters"
13994 .cindex "log" "selectors"
13995 .cindex "log" "8BITMIME"
13996 This option causes Exim to send 8BITMIME in its response to an SMTP
13997 EHLO command, and to accept the BODY= parameter on MAIL commands.
13998 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13999 takes no steps to do anything special with messages received by this route.
14000
14001 Historically Exim kept this option off by default, but the maintainers
14002 feel that in today's Internet, this causes more problems than it solves.
14003 It now defaults to true.
14004 A more detailed analysis of the issues is provided by Dan Bernstein:
14005 .display
14006 &url(http://cr.yp.to/smtp/8bitmime.html)
14007 .endd
14008
14009 To log received 8BITMIME status use
14010 .code
14011 log_selector = +8bitmime
14012 .endd
14013
14014 .option acl_not_smtp main string&!! unset
14015 .cindex "&ACL;" "for non-SMTP messages"
14016 .cindex "non-SMTP messages" "ACLs for"
14017 This option defines the ACL that is run when a non-SMTP message has been
14018 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14019 further details.
14020
14021 .option acl_not_smtp_mime main string&!! unset
14022 This option defines the ACL that is run for individual MIME parts of non-SMTP
14023 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14024 SMTP messages.
14025
14026 .option acl_not_smtp_start main string&!! unset
14027 .cindex "&ACL;" "at start of non-SMTP message"
14028 .cindex "non-SMTP messages" "ACLs for"
14029 This option defines the ACL that is run before Exim starts reading a
14030 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14031
14032 .option acl_smtp_auth main string&!! unset
14033 .cindex "&ACL;" "setting up for SMTP commands"
14034 .cindex "AUTH" "ACL for"
14035 This option defines the ACL that is run when an SMTP AUTH command is
14036 received. See chapter &<<CHAPACL>>& for further details.
14037
14038 .option acl_smtp_connect main string&!! unset
14039 .cindex "&ACL;" "on SMTP connection"
14040 This option defines the ACL that is run when an SMTP connection is received.
14041 See chapter &<<CHAPACL>>& for further details.
14042
14043 .option acl_smtp_data main string&!! unset
14044 .cindex "DATA" "ACL for"
14045 This option defines the ACL that is run after an SMTP DATA command has been
14046 processed and the message itself has been received, but before the final
14047 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14048
14049 .option acl_smtp_data_prdr main string&!! accept
14050 .cindex "PRDR" "ACL for"
14051 .cindex "DATA" "PRDR ACL for"
14052 .cindex "&ACL;" "PRDR-related"
14053 .cindex "&ACL;" "per-user data processing"
14054 This option defines the ACL that,
14055 if the PRDR feature has been negotiated,
14056 is run for each recipient after an SMTP DATA command has been
14057 processed and the message itself has been received, but before the
14058 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14059
14060 .option acl_smtp_dkim main string&!! unset
14061 .cindex DKIM "ACL for"
14062 This option defines the ACL that is run for each DKIM signature
14063 (by default, or as specified in the dkim_verify_signers option)
14064 of a received message.
14065 See chapter &<<CHAPdkim>>& for further details.
14066
14067 .option acl_smtp_etrn main string&!! unset
14068 .cindex "ETRN" "ACL for"
14069 This option defines the ACL that is run when an SMTP ETRN command is
14070 received. See chapter &<<CHAPACL>>& for further details.
14071
14072 .option acl_smtp_expn main string&!! unset
14073 .cindex "EXPN" "ACL for"
14074 This option defines the ACL that is run when an SMTP EXPN command is
14075 received. See chapter &<<CHAPACL>>& for further details.
14076
14077 .option acl_smtp_helo main string&!! unset
14078 .cindex "EHLO" "ACL for"
14079 .cindex "HELO" "ACL for"
14080 This option defines the ACL that is run when an SMTP EHLO or HELO
14081 command is received. See chapter &<<CHAPACL>>& for further details.
14082
14083
14084 .option acl_smtp_mail main string&!! unset
14085 .cindex "MAIL" "ACL for"
14086 This option defines the ACL that is run when an SMTP MAIL command is
14087 received. See chapter &<<CHAPACL>>& for further details.
14088
14089 .option acl_smtp_mailauth main string&!! unset
14090 .cindex "AUTH" "on MAIL command"
14091 This option defines the ACL that is run when there is an AUTH parameter on
14092 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14093 &<<CHAPSMTPAUTH>>& for details of authentication.
14094
14095 .option acl_smtp_mime main string&!! unset
14096 .cindex "MIME content scanning" "ACL for"
14097 This option is available when Exim is built with the content-scanning
14098 extension. It defines the ACL that is run for each MIME part in a message. See
14099 section &<<SECTscanmimepart>>& for details.
14100
14101 .option acl_smtp_notquit main string&!! unset
14102 .cindex "not-QUIT, ACL for"
14103 This option defines the ACL that is run when an SMTP session
14104 ends without a QUIT command being received.
14105 See chapter &<<CHAPACL>>& for further details.
14106
14107 .option acl_smtp_predata main string&!! unset
14108 This option defines the ACL that is run when an SMTP DATA command is
14109 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14110 further details.
14111
14112 .option acl_smtp_quit main string&!! unset
14113 .cindex "QUIT, ACL for"
14114 This option defines the ACL that is run when an SMTP QUIT command is
14115 received. See chapter &<<CHAPACL>>& for further details.
14116
14117 .option acl_smtp_rcpt main string&!! unset
14118 .cindex "RCPT" "ACL for"
14119 This option defines the ACL that is run when an SMTP RCPT command is
14120 received. See chapter &<<CHAPACL>>& for further details.
14121
14122 .option acl_smtp_starttls main string&!! unset
14123 .cindex "STARTTLS, ACL for"
14124 This option defines the ACL that is run when an SMTP STARTTLS command is
14125 received. See chapter &<<CHAPACL>>& for further details.
14126
14127 .option acl_smtp_vrfy main string&!! unset
14128 .cindex "VRFY" "ACL for"
14129 This option defines the ACL that is run when an SMTP VRFY command is
14130 received. See chapter &<<CHAPACL>>& for further details.
14131
14132 .option add_environment main "string list" empty
14133 .cindex "environment" "set values"
14134 This option allows to set individual environment variables that the
14135 currently linked libraries and programs in child processes use.
14136 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14137
14138 .option admin_groups main "string list&!!" unset
14139 .cindex "admin user"
14140 This option is expanded just once, at the start of Exim's processing. If the
14141 current group or any of the supplementary groups of an Exim caller is in this
14142 colon-separated list, the caller has admin privileges. If all your system
14143 programmers are in a specific group, for example, you can give them all Exim
14144 admin privileges by putting that group in &%admin_groups%&. However, this does
14145 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14146 To permit this, you have to add individuals to the Exim group.
14147
14148 .option allow_domain_literals main boolean false
14149 .cindex "domain literal"
14150 If this option is set, the RFC 2822 domain literal format is permitted in
14151 email addresses. The option is not set by default, because the domain literal
14152 format is not normally required these days, and few people know about it. It
14153 has, however, been exploited by mail abusers.
14154
14155 Unfortunately, it seems that some DNS black list maintainers are using this
14156 format to report black listing to postmasters. If you want to accept messages
14157 addressed to your hosts by IP address, you need to set
14158 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14159 domains (defined in the named domain list &%local_domains%& in the default
14160 configuration). This &"magic string"& matches the domain literal form of all
14161 the local host's IP addresses.
14162
14163
14164 .option allow_mx_to_ip main boolean false
14165 .cindex "MX record" "pointing to IP address"
14166 It appears that more and more DNS zone administrators are breaking the rules
14167 and putting domain names that look like IP addresses on the right hand side of
14168 MX records. Exim follows the rules and rejects this, giving an error message
14169 that explains the misconfiguration. However, some other MTAs support this
14170 practice, so to avoid &"Why can't Exim do this?"& complaints,
14171 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14172 recommended, except when you have no other choice.
14173
14174 .option allow_utf8_domains main boolean false
14175 .cindex "domain" "UTF-8 characters in"
14176 .cindex "UTF-8" "in domain name"
14177 Lots of discussion is going on about internationalized domain names. One
14178 camp is strongly in favour of just using UTF-8 characters, and it seems
14179 that at least two other MTAs permit this. This option allows Exim users to
14180 experiment if they wish.
14181
14182 If it is set true, Exim's domain parsing function allows valid
14183 UTF-8 multicharacters to appear in domain name components, in addition to
14184 letters, digits, and hyphens. However, just setting this option is not
14185 enough; if you want to look up these domain names in the DNS, you must also
14186 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14187 suitable setting is:
14188 .code
14189 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14190   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14191 .endd
14192 Alternatively, you can just disable this feature by setting
14193 .code
14194 dns_check_names_pattern =
14195 .endd
14196 That is, set the option to an empty string so that no check is done.
14197
14198
14199 .option auth_advertise_hosts main "host list&!!" *
14200 .cindex "authentication" "advertising"
14201 .cindex "AUTH" "advertising"
14202 If any server authentication mechanisms are configured, Exim advertises them in
14203 response to an EHLO command only if the calling host matches this list.
14204 Otherwise, Exim does not advertise AUTH.
14205 Exim does not accept AUTH commands from clients to which it has not
14206 advertised the availability of AUTH. The advertising of individual
14207 authentication mechanisms can be controlled by the use of the
14208 &%server_advertise_condition%& generic authenticator option on the individual
14209 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14210
14211 Certain mail clients (for example, Netscape) require the user to provide a name
14212 and password for authentication if AUTH is advertised, even though it may
14213 not be needed (the host may accept messages from hosts on its local LAN without
14214 authentication, for example). The &%auth_advertise_hosts%& option can be used
14215 to make these clients more friendly by excluding them from the set of hosts to
14216 which Exim advertises AUTH.
14217
14218 .cindex "AUTH" "advertising when encrypted"
14219 If you want to advertise the availability of AUTH only when the connection
14220 is encrypted using TLS, you can make use of the fact that the value of this
14221 option is expanded, with a setting like this:
14222 .code
14223 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14224 .endd
14225 .vindex "&$tls_in_cipher$&"
14226 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14227 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14228 expansion is *, which matches all hosts.
14229
14230
14231 .option auto_thaw main time 0s
14232 .cindex "thawing messages"
14233 .cindex "unfreezing messages"
14234 If this option is set to a time greater than zero, a queue runner will try a
14235 new delivery attempt on any frozen message, other than a bounce message, if
14236 this much time has passed since it was frozen. This may result in the message
14237 being re-frozen if nothing has changed since the last attempt. It is a way of
14238 saying &"keep on trying, even though there are big problems"&.
14239
14240 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14241 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14242 thought to be very useful any more, and its use should probably be avoided.
14243
14244
14245 .option av_scanner main string "see below"
14246 This option is available if Exim is built with the content-scanning extension.
14247 It specifies which anti-virus scanner to use. The default value is:
14248 .code
14249 sophie:/var/run/sophie
14250 .endd
14251 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14252 before use. See section &<<SECTscanvirus>>& for further details.
14253
14254
14255 .option bi_command main string unset
14256 .oindex "&%-bi%&"
14257 This option supplies the name of a command that is run when Exim is called with
14258 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14259 just the command name, it is not a complete command line. If an argument is
14260 required, it must come from the &%-oA%& command line option.
14261
14262
14263 .option bounce_message_file main string unset
14264 .cindex "bounce message" "customizing"
14265 .cindex "customizing" "bounce message"
14266 This option defines a template file containing paragraphs of text to be used
14267 for constructing bounce messages.  Details of the file's contents are given in
14268 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14269
14270
14271 .option bounce_message_text main string unset
14272 When this option is set, its contents are included in the default bounce
14273 message immediately after &"This message was created automatically by mail
14274 delivery software."& It is not used if &%bounce_message_file%& is set.
14275
14276 .option bounce_return_body main boolean true
14277 .cindex "bounce message" "including body"
14278 This option controls whether the body of an incoming message is included in a
14279 bounce message when &%bounce_return_message%& is true. The default setting
14280 causes the entire message, both header and body, to be returned (subject to the
14281 value of &%bounce_return_size_limit%&). If this option is false, only the
14282 message header is included. In the case of a non-SMTP message containing an
14283 error that is detected during reception, only those header lines preceding the
14284 point at which the error was detected are returned.
14285 .cindex "bounce message" "including original"
14286
14287 .option bounce_return_linesize_limit main integer 998
14288 .cindex "size" "of bounce lines, limit"
14289 .cindex "bounce message" "line length limit"
14290 .cindex "limit" "bounce message line length"
14291 This option sets a limit in bytes on the line length of messages
14292 that are returned to senders due to delivery problems,
14293 when &%bounce_return_message%& is true.
14294 The default value corresponds to RFC limits.
14295 If the message being returned has lines longer than this value it is
14296 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14297
14298 The option also applies to bounces returned when an error is detected
14299 during reception of a message.
14300 In this case lines from the original are truncated.
14301
14302 The option does not apply to messages generated by an &(autoreply)& transport.
14303
14304
14305 .option bounce_return_message main boolean true
14306 If this option is set false, none of the original message is included in
14307 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14308 &%bounce_return_body%&.
14309
14310
14311 .option bounce_return_size_limit main integer 100K
14312 .cindex "size" "of bounce, limit"
14313 .cindex "bounce message" "size limit"
14314 .cindex "limit" "bounce message size"
14315 This option sets a limit in bytes on the size of messages that are returned to
14316 senders as part of bounce messages when &%bounce_return_message%& is true. The
14317 limit should be less than the value of the global &%message_size_limit%& and of
14318 any &%message_size_limit%& settings on transports, to allow for the bounce text
14319 that Exim generates. If this option is set to zero there is no limit.
14320
14321 When the body of any message that is to be included in a bounce message is
14322 greater than the limit, it is truncated, and a comment pointing this out is
14323 added at the top. The actual cutoff may be greater than the value given, owing
14324 to the use of buffering for transferring the message in chunks (typically 8K in
14325 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14326 messages.
14327
14328 .option bounce_sender_authentication main string unset
14329 .cindex "bounce message" "sender authentication"
14330 .cindex "authentication" "bounce message"
14331 .cindex "AUTH" "on bounce message"
14332 This option provides an authenticated sender address that is sent with any
14333 bounce messages generated by Exim that are sent over an authenticated SMTP
14334 connection. A typical setting might be:
14335 .code
14336 bounce_sender_authentication = mailer-daemon@my.domain.example
14337 .endd
14338 which would cause bounce messages to be sent using the SMTP command:
14339 .code
14340 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14341 .endd
14342 The value of &%bounce_sender_authentication%& must always be a complete email
14343 address.
14344
14345 .option callout_domain_negative_expire main time 3h
14346 .cindex "caching" "callout timeouts"
14347 .cindex "callout" "caching timeouts"
14348 This option specifies the expiry time for negative callout cache data for a
14349 domain. See section &<<SECTcallver>>& for details of callout verification, and
14350 section &<<SECTcallvercache>>& for details of the caching.
14351
14352
14353 .option callout_domain_positive_expire main time 7d
14354 This option specifies the expiry time for positive callout cache data for a
14355 domain. See section &<<SECTcallver>>& for details of callout verification, and
14356 section &<<SECTcallvercache>>& for details of the caching.
14357
14358
14359 .option callout_negative_expire main time 2h
14360 This option specifies the expiry time for negative callout cache data for an
14361 address. See section &<<SECTcallver>>& for details of callout verification, and
14362 section &<<SECTcallvercache>>& for details of the caching.
14363
14364
14365 .option callout_positive_expire main time 24h
14366 This option specifies the expiry time for positive callout cache data for an
14367 address. See section &<<SECTcallver>>& for details of callout verification, and
14368 section &<<SECTcallvercache>>& for details of the caching.
14369
14370
14371 .option callout_random_local_part main string&!! "see below"
14372 This option defines the &"random"& local part that can be used as part of
14373 callout verification. The default value is
14374 .code
14375 $primary_hostname-$tod_epoch-testing
14376 .endd
14377 See section &<<CALLaddparcall>>& for details of how this value is used.
14378
14379
14380 .option check_log_inodes main integer 100
14381 See &%check_spool_space%& below.
14382
14383
14384 .option check_log_space main integer 10M
14385 See &%check_spool_space%& below.
14386
14387 .oindex "&%check_rfc2047_length%&"
14388 .cindex "RFC 2047" "disabling length check"
14389 .option check_rfc2047_length main boolean true
14390 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14391 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14392 word; strings to be encoded that exceed this length are supposed to use
14393 multiple encoded words. By default, Exim does not recognize encoded words that
14394 exceed the maximum length. However, it seems that some software, in violation
14395 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14396 set false, Exim recognizes encoded words of any length.
14397
14398
14399 .option check_spool_inodes main integer 100
14400 See &%check_spool_space%& below.
14401
14402
14403 .option check_spool_space main integer 10M
14404 .cindex "checking disk space"
14405 .cindex "disk space, checking"
14406 .cindex "spool directory" "checking space"
14407 The four &%check_...%& options allow for checking of disk resources before a
14408 message is accepted.
14409
14410 .vindex "&$log_inodes$&"
14411 .vindex "&$log_space$&"
14412 .vindex "&$spool_inodes$&"
14413 .vindex "&$spool_space$&"
14414 When any of these options are nonzero, they apply to all incoming messages. If you
14415 want to apply different checks to different kinds of message, you can do so by
14416 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14417 &$spool_space$& in an ACL with appropriate additional conditions.
14418
14419
14420 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14421 either value is greater than zero, for example:
14422 .code
14423 check_spool_space = 100M
14424 check_spool_inodes = 100
14425 .endd
14426 The spool partition is the one that contains the directory defined by
14427 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14428 transit.
14429
14430 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14431 files are written if either is greater than zero. These should be set only if
14432 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14433
14434 If there is less space or fewer inodes than requested, Exim refuses to accept
14435 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14436 error response to the MAIL command. If ESMTP is in use and there was a
14437 SIZE parameter on the MAIL command, its value is added to the
14438 &%check_spool_space%& value, and the check is performed even if
14439 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14440
14441 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14442 number of kilobytes (though specified in bytes).
14443 If a non-multiple of 1024 is specified, it is rounded up.
14444
14445 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14446 failure a message is written to stderr and Exim exits with a non-zero code, as
14447 it obviously cannot send an error message of any kind.
14448
14449 There is a slight performance penalty for these checks.
14450 Versions of Exim preceding 4.88 had these disabled by default;
14451 high-rate installations confident they will never run out of resources
14452 may wish to deliberately disable them.
14453
14454 .option chunking_advertise_hosts main "host list&!!" *
14455 .cindex CHUNKING advertisement
14456 .cindex "RFC 3030" "CHUNKING"
14457 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14458 these hosts.
14459 Hosts may use the BDAT command as an alternate to DATA.
14460
14461 .option debug_store main boolean &`false`&
14462 .cindex debugging "memory corruption"
14463 .cindex memory debugging
14464 This option, when true, enables extra checking in Exim's internal memory
14465 management.  For use when a memory corruption issue is being investigated,
14466 it should normally be left as default.
14467
14468 .option daemon_smtp_ports main string &`smtp`&
14469 .cindex "port" "for daemon"
14470 .cindex "TCP/IP" "setting listening ports"
14471 This option specifies one or more default SMTP ports on which the Exim daemon
14472 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14473 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14474
14475 .option daemon_startup_retries main integer 9
14476 .cindex "daemon startup, retrying"
14477 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14478 the daemon at startup when it cannot immediately bind a listening socket
14479 (typically because the socket is already in use): &%daemon_startup_retries%&
14480 defines the number of retries after the first failure, and
14481 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14482
14483 .option daemon_startup_sleep main time 30s
14484 See &%daemon_startup_retries%&.
14485
14486 .option delay_warning main "time list" 24h
14487 .cindex "warning of delay"
14488 .cindex "delay warning, specifying"
14489 .cindex "queue" "delay warning"
14490 When a message is delayed, Exim sends a warning message to the sender at
14491 intervals specified by this option. The data is a colon-separated list of times
14492 after which to send warning messages. If the value of the option is an empty
14493 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14494 message has been on the queue for longer than the last time, the last interval
14495 between the times is used to compute subsequent warning times. For example,
14496 with
14497 .code
14498 delay_warning = 4h:8h:24h
14499 .endd
14500 the first message is sent after 4 hours, the second after 8 hours, and
14501 the third one after 24 hours. After that, messages are sent every 16 hours,
14502 because that is the interval between the last two times on the list. If you set
14503 just one time, it specifies the repeat interval. For example, with:
14504 .code
14505 delay_warning = 6h
14506 .endd
14507 messages are repeated every six hours. To stop warnings after a given time, set
14508 a very large time at the end of the list. For example:
14509 .code
14510 delay_warning = 2h:12h:99d
14511 .endd
14512 Note that the option is only evaluated at the time a delivery attempt fails,
14513 which depends on retry and queue-runner configuration.
14514 Typically retries will be configured more frequently than warning messages.
14515
14516 .option delay_warning_condition main string&!! "see below"
14517 .vindex "&$domain$&"
14518 The string is expanded at the time a warning message might be sent. If all the
14519 deferred addresses have the same domain, it is set in &$domain$& during the
14520 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14521 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14522 &"false"& (the comparison being done caselessly) then the warning message is
14523 not sent. The default is:
14524 .code
14525 delay_warning_condition = ${if or {\
14526   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14527   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14528   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14529   } {no}{yes}}
14530 .endd
14531 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14532 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14533 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14534 &"auto-replied"& in an &'Auto-Submitted:'& header.
14535
14536 .option deliver_drop_privilege main boolean false
14537 .cindex "unprivileged delivery"
14538 .cindex "delivery" "unprivileged"
14539 If this option is set true, Exim drops its root privilege at the start of a
14540 delivery process, and runs as the Exim user throughout. This severely restricts
14541 the kinds of local delivery that are possible, but is viable in certain types
14542 of configuration. There is a discussion about the use of root privilege in
14543 chapter &<<CHAPsecurity>>&.
14544
14545 .option deliver_queue_load_max main fixed-point unset
14546 .cindex "load average"
14547 .cindex "queue runner" "abandoning"
14548 When this option is set, a queue run is abandoned if the system load average
14549 becomes greater than the value of the option. The option has no effect on
14550 ancient operating systems on which Exim cannot determine the load average.
14551 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14552
14553
14554 .option delivery_date_remove main boolean true
14555 .cindex "&'Delivery-date:'& header line"
14556 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14557 message when it is delivered, in exactly the same way as &'Return-path:'& is
14558 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14559 should not be present in incoming messages, and this option causes them to be
14560 removed at the time the message is received, to avoid any problems that might
14561 occur when a delivered message is subsequently sent on to some other recipient.
14562
14563 .option disable_fsync main boolean false
14564 .cindex "&[fsync()]&, disabling"
14565 This option is available only if Exim was built with the compile-time option
14566 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14567 a runtime configuration generates an &"unknown option"& error. You should not
14568 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14569 really, really, really understand what you are doing. &'No pre-compiled
14570 distributions of Exim should ever make this option available.'&
14571
14572 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14573 updated files' data to be written to disc before continuing. Unexpected events
14574 such as crashes and power outages may cause data to be lost or scrambled.
14575 Here be Dragons. &*Beware.*&
14576
14577
14578 .option disable_ipv6 main boolean false
14579 .cindex "IPv6" "disabling"
14580 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14581 activities take place. AAAA records are never looked up, and any IPv6 addresses
14582 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14583 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14584 to handle IPv6 literal addresses.
14585
14586
14587 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14588 .cindex DKIM "controlling calls to the ACL"
14589 This option gives a list of DKIM domains for which the DKIM ACL is run.
14590 It is expanded after the message is received; by default it runs
14591 the ACL once for each signature in the message.
14592 See chapter &<<CHAPdkim>>&.
14593
14594
14595 .option dns_again_means_nonexist main "domain list&!!" unset
14596 .cindex "DNS" "&""try again""& response; overriding"
14597 DNS lookups give a &"try again"& response for the DNS errors
14598 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14599 keep trying to deliver a message, or to give repeated temporary errors to
14600 incoming mail. Sometimes the effect is caused by a badly set up name server and
14601 may persist for a long time. If a domain which exhibits this problem matches
14602 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14603 This option should be used with care. You can make it apply to reverse lookups
14604 by a setting such as this:
14605 .code
14606 dns_again_means_nonexist = *.in-addr.arpa
14607 .endd
14608 This option applies to all DNS lookups that Exim does. It also applies when the
14609 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14610 since these are most likely to be caused by DNS lookup problems. The
14611 &(dnslookup)& router has some options of its own for controlling what happens
14612 when lookups for MX or SRV records give temporary errors. These more specific
14613 options are applied after this global option.
14614
14615 .option dns_check_names_pattern main string "see below"
14616 .cindex "DNS" "pre-check of name syntax"
14617 When this option is set to a non-empty string, it causes Exim to check domain
14618 names for characters that are not allowed in host names before handing them to
14619 the DNS resolver, because some resolvers give temporary errors for names that
14620 contain unusual characters. If a domain name contains any unwanted characters,
14621 a &"not found"& result is forced, and the resolver is not called. The check is
14622 done by matching the domain name against a regular expression, which is the
14623 value of this option. The default pattern is
14624 .code
14625 dns_check_names_pattern = \
14626   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14627 .endd
14628 which permits only letters, digits, slashes, and hyphens in components, but
14629 they must start and end with a letter or digit. Slashes are not, in fact,
14630 permitted in host names, but they are found in certain NS records (which can be
14631 accessed in Exim by using a &%dnsdb%& lookup). If you set
14632 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14633 empty string.
14634
14635 .option dns_csa_search_limit main integer 5
14636 This option controls the depth of parental searching for CSA SRV records in the
14637 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14638
14639 .option dns_csa_use_reverse main boolean true
14640 This option controls whether or not an IP address, given as a CSA domain, is
14641 reversed and looked up in the reverse DNS, as described in more detail in
14642 section &<<SECTverifyCSA>>&.
14643
14644
14645 .option dns_dnssec_ok main integer -1
14646 .cindex "DNS" "resolver options"
14647 .cindex "DNS" "DNSSEC"
14648 If this option is set to a non-negative number then Exim will initialise the
14649 DNS resolver library to either use or not use DNSSEC, overriding the system
14650 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14651
14652 If the resolver library does not support DNSSEC then this option has no effect.
14653
14654
14655 .option dns_ipv4_lookup main "domain list&!!" unset
14656 .cindex "IPv6" "DNS lookup for AAAA records"
14657 .cindex "DNS" "IPv6 lookup for AAAA records"
14658 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14659 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14660 (A records) when trying to find IP addresses for hosts, unless the host's
14661 domain matches this list.
14662
14663 This is a fudge to help with name servers that give big delays or otherwise do
14664 not work for the AAAA record type. In due course, when the world's name
14665 servers have all been upgraded, there should be no need for this option.
14666
14667
14668 .option dns_retrans main time 0s
14669 .cindex "DNS" "resolver options"
14670 .cindex timeout "dns lookup"
14671 .cindex "DNS" timeout
14672 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14673 retransmission and retry parameters for DNS lookups. Values of zero (the
14674 defaults) leave the system default settings unchanged. The first value is the
14675 time between retries, and the second is the number of retries. It isn't
14676 totally clear exactly how these settings affect the total time a DNS lookup may
14677 take. I haven't found any documentation about timeouts on DNS lookups; these
14678 parameter values are available in the external resolver interface structure,
14679 but nowhere does it seem to describe how they are used or what you might want
14680 to set in them.
14681 See also the &%slow_lookup_log%& option.
14682
14683
14684 .option dns_retry main integer 0
14685 See &%dns_retrans%& above.
14686
14687
14688 .option dns_trust_aa main "domain list&!!" unset
14689 .cindex "DNS" "resolver options"
14690 .cindex "DNS" "DNSSEC"
14691 If this option is set then lookup results marked with the AA bit
14692 (Authoritative Answer) are trusted the same way as if they were
14693 DNSSEC-verified. The authority section's name of the answer must
14694 match with this expanded domain list.
14695
14696 Use this option only if you talk directly to a resolver that is
14697 authoritative for some zones and does not set the AD (Authentic Data)
14698 bit in the answer. Some DNS servers may have an configuration option to
14699 mark the answers from their own zones as verified (they set the AD bit).
14700 Others do not have this option. It is considered as poor practice using
14701 a resolver that is an authoritative server for some zones.
14702
14703 Use this option only if you really have to (e.g. if you want
14704 to use DANE for remote delivery to a server that is listed in the DNS
14705 zones that your resolver is authoritative for).
14706
14707 If the DNS answer packet has the AA bit set and contains resource record
14708 in the answer section, the name of the first NS record appearing in the
14709 authority section is compared against the list. If the answer packet is
14710 authoritative but the answer section is empty, the name of the first SOA
14711 record in the authoritative section is used instead.
14712
14713 .cindex "DNS" "resolver options"
14714 .option dns_use_edns0 main integer -1
14715 .cindex "DNS" "resolver options"
14716 .cindex "DNS" "EDNS0"
14717 .cindex "DNS" "OpenBSD
14718 If this option is set to a non-negative number then Exim will initialise the
14719 DNS resolver library to either use or not use EDNS0 extensions, overriding
14720 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14721 on.
14722
14723 If the resolver library does not support EDNS0 then this option has no effect.
14724
14725 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
14726 means that DNSSEC will not work with Exim on that platform either, unless Exim
14727 is linked against an alternative DNS client library.
14728
14729
14730 .option drop_cr main boolean false
14731 This is an obsolete option that is now a no-op. It used to affect the way Exim
14732 handled CR and LF characters in incoming messages. What happens now is
14733 described in section &<<SECTlineendings>>&.
14734
14735 .option dsn_advertise_hosts main "host list&!!" unset
14736 .cindex "bounce messages" "success"
14737 .cindex "DSN" "success"
14738 .cindex "Delivery Status Notification" "success"
14739 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14740 and accepted from, these hosts.
14741 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14742 and RET and ORCPT options on MAIL FROM commands.
14743 A NOTIFY=SUCCESS option requests success-DSN messages.
14744 A NOTIFY= option with no argument requests that no delay or failure DSNs
14745 are sent.
14746
14747 .option dsn_from main "string&!!" "see below"
14748 .cindex "&'From:'& header line" "in bounces"
14749 .cindex "bounce messages" "&'From:'& line, specifying"
14750 This option can be used to vary the contents of &'From:'& header lines in
14751 bounces and other automatically generated messages (&"Delivery Status
14752 Notifications"& &-- hence the name of the option). The default setting is:
14753 .code
14754 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14755 .endd
14756 The value is expanded every time it is needed. If the expansion fails, a
14757 panic is logged, and the default value is used.
14758
14759 .option envelope_to_remove main boolean true
14760 .cindex "&'Envelope-to:'& header line"
14761 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14762 message when it is delivered, in exactly the same way as &'Return-path:'& is
14763 handled. &'Envelope-to:'& records the original recipient address from the
14764 message's envelope that caused the delivery to happen. Such headers should not
14765 be present in incoming messages, and this option causes them to be removed at
14766 the time the message is received, to avoid any problems that might occur when a
14767 delivered message is subsequently sent on to some other recipient.
14768
14769
14770 .option errors_copy main "string list&!!" unset
14771 .cindex "bounce message" "copy to other address"
14772 .cindex "copy of bounce message"
14773 Setting this option causes Exim to send bcc copies of bounce messages that it
14774 generates to other addresses. &*Note*&: This does not apply to bounce messages
14775 coming from elsewhere. The value of the option is a colon-separated list of
14776 items. Each item consists of a pattern, terminated by white space, followed by
14777 a comma-separated list of email addresses. If a pattern contains spaces, it
14778 must be enclosed in double quotes.
14779
14780 Each pattern is processed in the same way as a single item in an address list
14781 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14782 the bounce message, the message is copied to the addresses on the list. The
14783 items are scanned in order, and once a matching one is found, no further items
14784 are examined. For example:
14785 .code
14786 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14787               rqps@mydomain   hostmaster@mydomain.example,\
14788                               postmaster@mydomain.example
14789 .endd
14790 .vindex "&$domain$&"
14791 .vindex "&$local_part$&"
14792 The address list is expanded before use. The expansion variables &$local_part$&
14793 and &$domain$& are set from the original recipient of the error message, and if
14794 there was any wildcard matching in the pattern, the expansion
14795 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14796 variables &$0$&, &$1$&, etc. are set in the normal way.
14797
14798
14799 .option errors_reply_to main string unset
14800 .cindex "bounce message" "&'Reply-to:'& in"
14801 By default, Exim's bounce and delivery warning messages contain the header line
14802 .display
14803 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14804 .endd
14805 .oindex &%quota_warn_message%&
14806 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14807 A warning message that is generated by the &%quota_warn_message%& option in an
14808 &(appendfile)& transport may contain its own &'From:'& header line that
14809 overrides the default.
14810
14811 Experience shows that people reply to bounce messages. If the
14812 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14813 and warning messages. For example:
14814 .code
14815 errors_reply_to = postmaster@my.domain.example
14816 .endd
14817 The value of the option is not expanded. It must specify a valid RFC 2822
14818 address. However, if a warning message that is generated by the
14819 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14820 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14821 not used.
14822
14823
14824 .option event_action main string&!! unset
14825 .cindex events
14826 This option declares a string to be expanded for Exim's events mechanism.
14827 For details see chapter &<<CHAPevents>>&.
14828
14829
14830 .option exim_group main string "compile-time configured"
14831 .cindex "gid (group id)" "Exim's own"
14832 .cindex "Exim group"
14833 This option changes the gid under which Exim runs when it gives up root
14834 privilege. The default value is compiled into the binary. The value of this
14835 option is used only when &%exim_user%& is also set. Unless it consists entirely
14836 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14837 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14838 security issues.
14839
14840
14841 .option exim_path main string "see below"
14842 .cindex "Exim binary, path name"
14843 This option specifies the path name of the Exim binary, which is used when Exim
14844 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14845 the directory configured at compile time by the BIN_DIRECTORY setting. It
14846 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14847 other place.
14848 &*Warning*&: Do not use a macro to define the value of this option, because
14849 you will break those Exim utilities that scan the configuration file to find
14850 where the binary is. (They then use the &%-bP%& option to extract option
14851 settings such as the value of &%spool_directory%&.)
14852
14853
14854 .option exim_user main string "compile-time configured"
14855 .cindex "uid (user id)" "Exim's own"
14856 .cindex "Exim user"
14857 This option changes the uid under which Exim runs when it gives up root
14858 privilege. The default value is compiled into the binary. Ownership of the run
14859 time configuration file and the use of the &%-C%& and &%-D%& command line
14860 options is checked against the values in the binary, not what is set here.
14861
14862 Unless it consists entirely of digits, the string is looked up using
14863 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14864 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14865 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14866
14867
14868 .option extra_local_interfaces main "string list" unset
14869 This option defines network interfaces that are to be considered local when
14870 routing, but which are not used for listening by the daemon. See section
14871 &<<SECTreclocipadd>>& for details.
14872
14873
14874 . Allow this long option name to split; give it unsplit as a fifth argument
14875 . for the automatic .oindex that is generated by .option.
14876
14877 .option "extract_addresses_remove_arguments" main boolean true &&&
14878          extract_addresses_remove_arguments
14879 .oindex "&%-t%&"
14880 .cindex "command line" "addresses with &%-t%&"
14881 .cindex "Sendmail compatibility" "&%-t%& option"
14882 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14883 are present on the command line when the &%-t%& option is used to build an
14884 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14885 line addresses are removed from the recipients list. This is also how Smail
14886 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14887 command line addresses are added to those obtained from the header lines. When
14888 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14889 argument headers. If it is set false, Exim adds rather than removes argument
14890 addresses.
14891
14892
14893 .option finduser_retries main integer 0
14894 .cindex "NIS, retrying user lookups"
14895 On systems running NIS or other schemes in which user and group information is
14896 distributed from a remote system, there can be times when &[getpwnam()]& and
14897 related functions fail, even when given valid data, because things time out.
14898 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14899 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14900 many extra times to find a user or a group, waiting for one second between
14901 retries.
14902
14903 .cindex "&_/etc/passwd_&" "multiple reading of"
14904 You should not set this option greater than zero if your user information is in
14905 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14906 search the file multiple times for non-existent users, and also cause delay.
14907
14908
14909
14910 .option freeze_tell main "string list, comma separated" unset
14911 .cindex "freezing messages" "sending a message when freezing"
14912 On encountering certain errors, or when configured to do so in a system filter,
14913 ACL, or special router, Exim freezes a message. This means that no further
14914 delivery attempts take place until an administrator thaws the message, or the
14915 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14916 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14917 warning message whenever it freezes something, unless the message it is
14918 freezing is a locally-generated bounce message. (Without this exception there
14919 is the possibility of looping.) The warning message is sent to the addresses
14920 supplied as the comma-separated value of this option. If several of the
14921 message's addresses cause freezing, only a single message is sent. If the
14922 freezing was automatic, the reason(s) for freezing can be found in the message
14923 log. If you configure freezing in a filter or ACL, you must arrange for any
14924 logging that you require.
14925
14926
14927 .option gecos_name main string&!! unset
14928 .cindex "HP-UX"
14929 .cindex "&""gecos""& field, parsing"
14930 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14931 password file to hold other information in addition to users' real names. Exim
14932 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14933 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14934 of the field are used unchanged, except that, if an ampersand is encountered,
14935 it is replaced by the user's login name with the first character forced to
14936 upper case, since this is a convention that is observed on many systems.
14937
14938 When these options are set, &%gecos_pattern%& is treated as a regular
14939 expression that is to be applied to the field (again with && replaced by the
14940 login name), and if it matches, &%gecos_name%& is expanded and used as the
14941 user's name.
14942
14943 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14944 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14945 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14946 name terminates at the first comma, the following can be used:
14947 .code
14948 gecos_pattern = ([^,]*)
14949 gecos_name = $1
14950 .endd
14951
14952 .option gecos_pattern main string unset
14953 See &%gecos_name%& above.
14954
14955
14956 .option gnutls_compat_mode main boolean unset
14957 This option controls whether GnuTLS is used in compatibility mode in an Exim
14958 server. This reduces security slightly, but improves interworking with older
14959 implementations of TLS.
14960
14961
14962 option gnutls_allow_auto_pkcs11 main boolean unset
14963 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14964 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14965
14966 See
14967 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14968 for documentation.
14969
14970
14971
14972 .option headers_charset main string "see below"
14973 This option sets a default character set for translating from encoded MIME
14974 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14975 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14976 ultimate default is ISO-8859-1. For more details see the description of header
14977 insertions in section &<<SECTexpansionitems>>&.
14978
14979
14980
14981 .option header_maxsize main integer "see below"
14982 .cindex "header section" "maximum size of"
14983 .cindex "limit" "size of message header section"
14984 This option controls the overall maximum size of a message's header
14985 section. The default is the value of HEADER_MAXSIZE in
14986 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14987 sections are rejected.
14988
14989
14990 .option header_line_maxsize main integer 0
14991 .cindex "header lines" "maximum size of"
14992 .cindex "limit" "size of one header line"
14993 This option limits the length of any individual header line in a message, after
14994 all the continuations have been joined together. Messages with individual
14995 header lines that are longer than the limit are rejected. The default value of
14996 zero means &"no limit"&.
14997
14998
14999
15000
15001 .option helo_accept_junk_hosts main "host list&!!" unset
15002 .cindex "HELO" "accepting junk data"
15003 .cindex "EHLO" "accepting junk data"
15004 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15005 mail, and gives an error response for invalid data. Unfortunately, there are
15006 some SMTP clients that send syntactic junk. They can be accommodated by setting
15007 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15008 if you want to do semantic checking.
15009 See also &%helo_allow_chars%& for a way of extending the permitted character
15010 set.
15011
15012
15013 .option helo_allow_chars main string unset
15014 .cindex "HELO" "underscores in"
15015 .cindex "EHLO" "underscores in"
15016 .cindex "underscore in EHLO/HELO"
15017 This option can be set to a string of rogue characters that are permitted in
15018 all EHLO and HELO names in addition to the standard letters, digits,
15019 hyphens, and dots. If you really must allow underscores, you can set
15020 .code
15021 helo_allow_chars = _
15022 .endd
15023 Note that the value is one string, not a list.
15024
15025
15026 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15027 .cindex "HELO" "forcing reverse lookup"
15028 .cindex "EHLO" "forcing reverse lookup"
15029 If the domain given by a client in a HELO or EHLO command matches this
15030 list, a reverse lookup is done in order to establish the host's true name. The
15031 default forces a lookup if the client host gives the server's name or any of
15032 its IP addresses (in brackets), something that broken clients have been seen to
15033 do.
15034
15035
15036 .option helo_try_verify_hosts main "host list&!!" unset
15037 .cindex "HELO verifying" "optional"
15038 .cindex "EHLO" "verifying, optional"
15039 By default, Exim just checks the syntax of HELO and EHLO commands (see
15040 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15041 to do more extensive checking of the data supplied by these commands. The ACL
15042 condition &`verify = helo`& is provided to make this possible.
15043 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15044 to force the check to occur. From release 4.53 onwards, this is no longer
15045 necessary. If the check has not been done before &`verify = helo`& is
15046 encountered, it is done at that time. Consequently, this option is obsolete.
15047 Its specification is retained here for backwards compatibility.
15048
15049 When an EHLO or HELO command is received, if the calling host matches
15050 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15051 EHLO command either:
15052
15053 .ilist
15054 is an IP literal matching the calling address of the host, or
15055 .next
15056 .cindex "DNS" "reverse lookup"
15057 .cindex "reverse DNS lookup"
15058 matches the host name that Exim obtains by doing a reverse lookup of the
15059 calling host address, or
15060 .next
15061 when looked up in DNS yields the calling host address.
15062 .endlist
15063
15064 However, the EHLO or HELO command is not rejected if any of the checks
15065 fail. Processing continues, but the result of the check is remembered, and can
15066 be detected later in an ACL by the &`verify = helo`& condition.
15067
15068 If DNS was used for successful verification, the variable
15069 .cindex "DNS" "DNSSEC"
15070 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15071
15072 .option helo_verify_hosts main "host list&!!" unset
15073 .cindex "HELO verifying" "mandatory"
15074 .cindex "EHLO" "verifying, mandatory"
15075 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15076 backwards compatibility. For hosts that match this option, Exim checks the host
15077 name given in the HELO or EHLO in the same way as for
15078 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15079 rejected with a 550 error, and entries are written to the main and reject logs.
15080 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15081 error.
15082
15083 .option hold_domains main "domain list&!!" unset
15084 .cindex "domain" "delaying delivery"
15085 .cindex "delivery" "delaying certain domains"
15086 This option allows mail for particular domains to be held on the queue
15087 manually. The option is overridden if a message delivery is forced with the
15088 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15089 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15090 item in &%hold_domains%&, no routing or delivery for that address is done, and
15091 it is deferred every time the message is looked at.
15092
15093 This option is intended as a temporary operational measure for delaying the
15094 delivery of mail while some problem is being sorted out, or some new
15095 configuration tested. If you just want to delay the processing of some
15096 domains until a queue run occurs, you should use &%queue_domains%& or
15097 &%queue_smtp_domains%&, not &%hold_domains%&.
15098
15099 A setting of &%hold_domains%& does not override Exim's code for removing
15100 messages from the queue if they have been there longer than the longest retry
15101 time in any retry rule. If you want to hold messages for longer than the normal
15102 retry times, insert a dummy retry rule with a long retry time.
15103
15104
15105 .option host_lookup main "host list&!!" unset
15106 .cindex "host name" "lookup, forcing"
15107 Exim does not look up the name of a calling host from its IP address unless it
15108 is required to compare against some host list, or the host matches
15109 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15110 option (which normally contains IP addresses rather than host names). The
15111 default configuration file contains
15112 .code
15113 host_lookup = *
15114 .endd
15115 which causes a lookup to happen for all hosts. If the expense of these lookups
15116 is felt to be too great, the setting can be changed or removed.
15117
15118 After a successful reverse lookup, Exim does a forward lookup on the name it
15119 has obtained, to verify that it yields the IP address that it started with. If
15120 this check fails, Exim behaves as if the name lookup failed.
15121
15122 .vindex "&$host_lookup_failed$&"
15123 .vindex "&$sender_host_name$&"
15124 After any kind of failure, the host name (in &$sender_host_name$&) remains
15125 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15126 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15127 &`verify = reverse_host_lookup`& in ACLs.
15128
15129
15130 .option host_lookup_order main "string list" &`bydns:byaddr`&
15131 This option specifies the order of different lookup methods when Exim is trying
15132 to find a host name from an IP address. The default is to do a DNS lookup
15133 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15134 if that fails. You can change the order of these lookups, or omit one entirely,
15135 if you want.
15136
15137 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15138 multiple PTR records in the DNS and the IP address is not listed in
15139 &_/etc/hosts_&. Different operating systems give different results in this
15140 case. That is why the default tries a DNS lookup first.
15141
15142
15143
15144 .option host_reject_connection main "host list&!!" unset
15145 .cindex "host" "rejecting connections from"
15146 If this option is set, incoming SMTP calls from the hosts listed are rejected
15147 as soon as the connection is made.
15148 This option is obsolete, and retained only for backward compatibility, because
15149 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15150 connections immediately.
15151
15152 The ability to give an immediate rejection (either by this option or using an
15153 ACL) is provided for use in unusual cases. Many hosts will just try again,
15154 sometimes without much delay. Normally, it is better to use an ACL to reject
15155 incoming messages at a later stage, such as after RCPT commands. See
15156 chapter &<<CHAPACL>>&.
15157
15158
15159 .option hosts_connection_nolog main "host list&!!" unset
15160 .cindex "host" "not logging connections from"
15161 This option defines a list of hosts for which connection logging does not
15162 happen, even though the &%smtp_connection%& log selector is set. For example,
15163 you might want not to log SMTP connections from local processes, or from
15164 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15165 the daemon; you should therefore strive to restrict its value to a short inline
15166 list of IP addresses and networks. To disable logging SMTP connections from
15167 local processes, you must create a host list with an empty item. For example:
15168 .code
15169 hosts_connection_nolog = :
15170 .endd
15171 If the &%smtp_connection%& log selector is not set, this option has no effect.
15172
15173
15174
15175 .option hosts_proxy main "host list&!!" unset
15176 .cindex proxy "proxy protocol"
15177 This option enables use of Proxy Protocol proxies for incoming
15178 connections.  For details see section &<<SECTproxyInbound>>&.
15179
15180
15181 .option hosts_treat_as_local main "domain list&!!" unset
15182 .cindex "local host" "domains treated as"
15183 .cindex "host" "treated as local"
15184 If this option is set, any host names that match the domain list are treated as
15185 if they were the local host when Exim is scanning host lists obtained from MX
15186 records
15187 or other sources. Note that the value of this option is a domain list, not a
15188 host list, because it is always used to check host names, not IP addresses.
15189
15190 This option also applies when Exim is matching the special items
15191 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15192 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15193 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15194 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15195 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15196 interfaces and recognizing the local host.
15197
15198
15199 .option ibase_servers main "string list" unset
15200 .cindex "InterBase" "server list"
15201 This option provides a list of InterBase servers and associated connection data,
15202 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15203 The option is available only if Exim has been built with InterBase support.
15204
15205
15206
15207 .option ignore_bounce_errors_after main time 10w
15208 .cindex "bounce message" "discarding"
15209 .cindex "discarding bounce message"
15210 This option affects the processing of bounce messages that cannot be delivered,
15211 that is, those that suffer a permanent delivery failure. (Bounce messages that
15212 suffer temporary delivery failures are of course retried in the usual way.)
15213
15214 After a permanent delivery failure, bounce messages are frozen,
15215 because there is no sender to whom they can be returned. When a frozen bounce
15216 message has been on the queue for more than the given time, it is unfrozen at
15217 the next queue run, and a further delivery is attempted. If delivery fails
15218 again, the bounce message is discarded. This makes it possible to keep failed
15219 bounce messages around for a shorter time than the normal maximum retry time
15220 for frozen messages. For example,
15221 .code
15222 ignore_bounce_errors_after = 12h
15223 .endd
15224 retries failed bounce message deliveries after 12 hours, discarding any further
15225 failures. If the value of this option is set to a zero time period, bounce
15226 failures are discarded immediately. Setting a very long time (as in the default
15227 value) has the effect of disabling this option. For ways of automatically
15228 dealing with other kinds of frozen message, see &%auto_thaw%& and
15229 &%timeout_frozen_after%&.
15230
15231
15232 .option ignore_fromline_hosts main "host list&!!" unset
15233 .cindex "&""From""& line"
15234 .cindex "UUCP" "&""From""& line"
15235 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15236 the headers of a message. By default this is treated as the start of the
15237 message's body, which means that any following headers are not recognized as
15238 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15239 match those hosts that insist on sending it. If the sender is actually a local
15240 process rather than a remote host, and is using &%-bs%& to inject the messages,
15241 &%ignore_fromline_local%& must be set to achieve this effect.
15242
15243
15244 .option ignore_fromline_local main boolean false
15245 See &%ignore_fromline_hosts%& above.
15246
15247 .option keep_environment main "string list" unset
15248 .cindex "environment" "values from"
15249 This option contains a string list of environment variables to keep.
15250 You have to trust these variables or you have to be sure that
15251 these variables do not impose any security risk. Keep in mind that
15252 during the startup phase Exim is running with an effective UID 0 in most
15253 installations. As the default value is an empty list, the default
15254 environment for using libraries, running embedded Perl code, or running
15255 external binaries is empty, and does not not even contain PATH or HOME.
15256
15257 Actually the list is interpreted as a list of patterns
15258 (&<<SECTlistexpand>>&), except that it is not expanded first.
15259
15260 WARNING: Macro substitution is still done first, so having a macro
15261 FOO and having FOO_HOME in your &%keep_environment%& option may have
15262 unexpected results. You may work around this using a regular expression
15263 that does not match the macro name: ^[F]OO_HOME$.
15264
15265 Current versions of Exim issue a warning during startup if you do not mention
15266 &%keep_environment%& in your runtime configuration file and if your
15267 current environment is not empty. Future versions may not issue that warning
15268 anymore.
15269
15270 See the &%add_environment%& main config option for a way to set
15271 environment variables to a fixed value.  The environment for &(pipe)&
15272 transports is handled separately, see section &<<SECTpipeenv>>& for
15273 details.
15274
15275
15276 .option keep_malformed main time 4d
15277 This option specifies the length of time to keep messages whose spool files
15278 have been corrupted in some way. This should, of course, never happen. At the
15279 next attempt to deliver such a message, it gets removed. The incident is
15280 logged.
15281
15282
15283 .option ldap_ca_cert_dir main string unset
15284 .cindex "LDAP", "TLS CA certificate directory"
15285 .cindex certificate "directory for LDAP"
15286 This option indicates which directory contains CA certificates for verifying
15287 a TLS certificate presented by an LDAP server.
15288 While Exim does not provide a default value, your SSL library may.
15289 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15290 and constrained to be a directory.
15291
15292
15293 .option ldap_ca_cert_file main string unset
15294 .cindex "LDAP", "TLS CA certificate file"
15295 .cindex certificate "file for LDAP"
15296 This option indicates which file contains CA certificates for verifying
15297 a TLS certificate presented by an LDAP server.
15298 While Exim does not provide a default value, your SSL library may.
15299 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15300 and constrained to be a file.
15301
15302
15303 .option ldap_cert_file main string unset
15304 .cindex "LDAP" "TLS client certificate file"
15305 .cindex certificate "file for LDAP"
15306 This option indicates which file contains an TLS client certificate which
15307 Exim should present to the LDAP server during TLS negotiation.
15308 Should be used together with &%ldap_cert_key%&.
15309
15310
15311 .option ldap_cert_key main string unset
15312 .cindex "LDAP" "TLS client key file"
15313 .cindex certificate "key for LDAP"
15314 This option indicates which file contains the secret/private key to use
15315 to prove identity to the LDAP server during TLS negotiation.
15316 Should be used together with &%ldap_cert_file%&, which contains the
15317 identity to be proven.
15318
15319
15320 .option ldap_cipher_suite main string unset
15321 .cindex "LDAP" "TLS cipher suite"
15322 This controls the TLS cipher-suite negotiation during TLS negotiation with
15323 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15324 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15325
15326
15327 .option ldap_default_servers main "string list" unset
15328 .cindex "LDAP" "default servers"
15329 This option provides a list of LDAP servers which are tried in turn when an
15330 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15331 details of LDAP queries. This option is available only when Exim has been built
15332 with LDAP support.
15333
15334
15335 .option ldap_require_cert main string unset.
15336 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15337 This should be one of the values "hard", "demand", "allow", "try" or "never".
15338 A value other than one of these is interpreted as "never".
15339 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15340 Although Exim does not set a default, the LDAP library probably defaults
15341 to hard/demand.
15342
15343
15344 .option ldap_start_tls main boolean false
15345 .cindex "LDAP" "whether or not to negotiate TLS"
15346 If set, Exim will attempt to negotiate TLS with the LDAP server when
15347 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15348 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15349 of SSL-on-connect.
15350 In the event of failure to negotiate TLS, the action taken is controlled
15351 by &%ldap_require_cert%&.
15352 This option is ignored for &`ldapi`& connections.
15353
15354
15355 .option ldap_version main integer unset
15356 .cindex "LDAP" "protocol version, forcing"
15357 This option can be used to force Exim to set a specific protocol version for
15358 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15359 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15360 the LDAP headers; otherwise it is 2. This option is available only when Exim
15361 has been built with LDAP support.
15362
15363
15364
15365 .option local_from_check main boolean true
15366 .cindex "&'Sender:'& header line" "disabling addition of"
15367 .cindex "&'From:'& header line" "disabling checking of"
15368 When a message is submitted locally (that is, not over a TCP/IP connection) by
15369 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15370 checks that the &'From:'& header line matches the login of the calling user and
15371 the domain specified by &%qualify_domain%&.
15372
15373 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15374 locally submitted message is automatically qualified by Exim, unless the
15375 &%-bnq%& command line option is used.
15376
15377 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15378 on the local part. If the &'From:'& header line does not match, Exim adds a
15379 &'Sender:'& header with an address constructed from the calling user's login
15380 and the default qualify domain.
15381
15382 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15383 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15384 &'Sender:'& header lines supplied by untrusted users, you must also set
15385 &%local_sender_retain%& to be true.
15386
15387 .cindex "envelope sender"
15388 These options affect only the header lines in the message. The envelope sender
15389 is still forced to be the login id at the qualify domain unless
15390 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15391
15392 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15393 request similar header line checking. See section &<<SECTthesenhea>>&, which
15394 has more details about &'Sender:'& processing.
15395
15396
15397
15398
15399 .option local_from_prefix main string unset
15400 When Exim checks the &'From:'& header line of locally submitted messages for
15401 matching the login id (see &%local_from_check%& above), it can be configured to
15402 ignore certain prefixes and suffixes in the local part of the address. This is
15403 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15404 appropriate lists, in the same form as the &%local_part_prefix%& and
15405 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15406 example, if
15407 .code
15408 local_from_prefix = *-
15409 .endd
15410 is set, a &'From:'& line containing
15411 .code
15412 From: anything-user@your.domain.example
15413 .endd
15414 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15415 matches the actual sender address that is constructed from the login name and
15416 qualify domain.
15417
15418
15419 .option local_from_suffix main string unset
15420 See &%local_from_prefix%& above.
15421
15422
15423 .option local_interfaces main "string list" "see below"
15424 This option controls which network interfaces are used by the daemon for
15425 listening; they are also used to identify the local host when routing. Chapter
15426 &<<CHAPinterfaces>>& contains a full description of this option and the related
15427 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15428 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15429 &%local_interfaces%& is
15430 .code
15431 local_interfaces = 0.0.0.0
15432 .endd
15433 when Exim is built without IPv6 support; otherwise it is
15434 .code
15435 local_interfaces = <; ::0 ; 0.0.0.0
15436 .endd
15437
15438 .option local_scan_timeout main time 5m
15439 .cindex "timeout" "for &[local_scan()]& function"
15440 .cindex "&[local_scan()]& function" "timeout"
15441 This timeout applies to the &[local_scan()]& function (see chapter
15442 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15443 the incoming message is rejected with a temporary error if it is an SMTP
15444 message. For a non-SMTP message, the message is dropped and Exim ends with a
15445 non-zero code. The incident is logged on the main and reject logs.
15446
15447
15448
15449 .option local_sender_retain main boolean false
15450 .cindex "&'Sender:'& header line" "retaining from local submission"
15451 When a message is submitted locally (that is, not over a TCP/IP connection) by
15452 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15453 do not want this to happen, you must set &%local_sender_retain%&, and you must
15454 also set &%local_from_check%& to be false (Exim will complain if you do not).
15455 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15456 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15457
15458
15459
15460
15461 .option localhost_number main string&!! unset
15462 .cindex "host" "locally unique number for"
15463 .cindex "message ids" "with multiple hosts"
15464 .vindex "&$localhost_number$&"
15465 Exim's message ids are normally unique only within the local host. If
15466 uniqueness among a set of hosts is required, each host must set a different
15467 value for the &%localhost_number%& option. The string is expanded immediately
15468 after reading the configuration file (so that a number can be computed from the
15469 host name, for example) and the result of the expansion must be a number in the
15470 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15471 systems). This is available in subsequent string expansions via the variable
15472 &$localhost_number$&. When &%localhost_number is set%&, the final two
15473 characters of the message id, instead of just being a fractional part of the
15474 time, are computed from the time and the local host number as described in
15475 section &<<SECTmessiden>>&.
15476
15477
15478
15479 .option log_file_path main "string list&!!" "set at compile time"
15480 .cindex "log" "file path for"
15481 This option sets the path which is used to determine the names of Exim's log
15482 files, or indicates that logging is to be to syslog, or both. It is expanded
15483 when Exim is entered, so it can, for example, contain a reference to the host
15484 name. If no specific path is set for the log files at compile or run time,
15485 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15486 they are written in a sub-directory called &_log_& in Exim's spool directory.
15487 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15488 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15489 used. If this string is fixed at your installation (contains no expansion
15490 variables) it is recommended that you do not set this option in the
15491 configuration file, but instead supply the path using LOG_FILE_PATH in
15492 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15493 early on &-- in particular, failure to read the configuration file.
15494
15495
15496 .option log_selector main string unset
15497 .cindex "log" "selectors"
15498 This option can be used to reduce or increase the number of things that Exim
15499 writes to its log files. Its argument is made up of names preceded by plus or
15500 minus characters. For example:
15501 .code
15502 log_selector = +arguments -retry_defer
15503 .endd
15504 A list of possible names and what they control is given in the chapter on
15505 logging, in section &<<SECTlogselector>>&.
15506
15507
15508 .option log_timezone main boolean false
15509 .cindex "log" "timezone for entries"
15510 .vindex "&$tod_log$&"
15511 .vindex "&$tod_zone$&"
15512 By default, the timestamps on log lines are in local time without the
15513 timezone. This means that if your timezone changes twice a year, the timestamps
15514 in log lines are ambiguous for an hour when the clocks go back. One way of
15515 avoiding this problem is to set the timezone to UTC. An alternative is to set
15516 &%log_timezone%& true. This turns on the addition of the timezone offset to
15517 timestamps in log lines. Turning on this option can add quite a lot to the size
15518 of log files because each line is extended by 6 characters. Note that the
15519 &$tod_log$& variable contains the log timestamp without the zone, but there is
15520 another variable called &$tod_zone$& that contains just the timezone offset.
15521
15522
15523 .option lookup_open_max main integer 25
15524 .cindex "too many open files"
15525 .cindex "open files, too many"
15526 .cindex "file" "too many open"
15527 .cindex "lookup" "maximum open files"
15528 .cindex "limit" "open files for lookups"
15529 This option limits the number of simultaneously open files for single-key
15530 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15531 Exim normally keeps these files open during routing, because often the same
15532 file is required several times. If the limit is reached, Exim closes the least
15533 recently used file. Note that if you are using the &'ndbm'& library, it
15534 actually opens two files for each logical DBM database, though it still counts
15535 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15536 open files"& errors with NDBM, you need to reduce the value of
15537 &%lookup_open_max%&.
15538
15539
15540 .option max_username_length main integer 0
15541 .cindex "length of login name"
15542 .cindex "user name" "maximum length"
15543 .cindex "limit" "user name length"
15544 Some operating systems are broken in that they truncate long arguments to
15545 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15546 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15547 an argument that is longer behaves as if &[getpwnam()]& failed.
15548
15549
15550 .option message_body_newlines main bool false
15551 .cindex "message body" "newlines in variables"
15552 .cindex "newline" "in message body variables"
15553 .vindex "&$message_body$&"
15554 .vindex "&$message_body_end$&"
15555 By default, newlines in the message body are replaced by spaces when setting
15556 the &$message_body$& and &$message_body_end$& expansion variables. If this
15557 option is set true, this no longer happens.
15558
15559
15560 .option message_body_visible main integer 500
15561 .cindex "body of message" "visible size"
15562 .cindex "message body" "visible size"
15563 .vindex "&$message_body$&"
15564 .vindex "&$message_body_end$&"
15565 This option specifies how much of a message's body is to be included in the
15566 &$message_body$& and &$message_body_end$& expansion variables.
15567
15568
15569 .option message_id_header_domain main string&!! unset
15570 .cindex "&'Message-ID:'& header line"
15571 If this option is set, the string is expanded and used as the right hand side
15572 (domain) of the &'Message-ID:'& header that Exim creates if a
15573 locally-originated incoming message does not have one. &"Locally-originated"&
15574 means &"not received over TCP/IP."&
15575 Otherwise, the primary host name is used.
15576 Only letters, digits, dot and hyphen are accepted; any other characters are
15577 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15578 empty string, the option is ignored.
15579
15580
15581 .option message_id_header_text main string&!! unset
15582 If this variable is set, the string is expanded and used to augment the text of
15583 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15584 message does not have one. The text of this header is required by RFC 2822 to
15585 take the form of an address. By default, Exim uses its internal message id as
15586 the local part, and the primary host name as the domain. If this option is set,
15587 it is expanded, and provided the expansion is not forced to fail, and does not
15588 yield an empty string, the result is inserted into the header immediately
15589 before the @, separated from the internal message id by a dot. Any characters
15590 that are illegal in an address are automatically converted into hyphens. This
15591 means that variables such as &$tod_log$& can be used, because the spaces and
15592 colons will become hyphens.
15593
15594
15595 .option message_logs main boolean true
15596 .cindex "message logs" "disabling"
15597 .cindex "log" "message log; disabling"
15598 If this option is turned off, per-message log files are not created in the
15599 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15600 Exim, by reducing the number of files involved in handling a message from a
15601 minimum of four (header spool file, body spool file, delivery journal, and
15602 per-message log) to three. The other major I/O activity is Exim's main log,
15603 which is not affected by this option.
15604
15605
15606 .option message_size_limit main string&!! 50M
15607 .cindex "message" "size limit"
15608 .cindex "limit" "message size"
15609 .cindex "size" "of message, limit"
15610 This option limits the maximum size of message that Exim will process. The
15611 value is expanded for each incoming connection so, for example, it can be made
15612 to depend on the IP address of the remote host for messages arriving via
15613 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15614 optionally followed by K or M.
15615
15616 &*Note*&: This limit cannot be made to depend on a message's sender or any
15617 other properties of an individual message, because it has to be advertised in
15618 the server's response to EHLO. String expansion failure causes a temporary
15619 error. A value of zero means no limit, but its use is not recommended. See also
15620 &%bounce_return_size_limit%&.
15621
15622 Incoming SMTP messages are failed with a 552 error if the limit is
15623 exceeded; locally-generated messages either get a stderr message or a delivery
15624 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15625 an oversized message is logged in both the main and the reject logs. See also
15626 the generic transport option &%message_size_limit%&, which limits the size of
15627 message that an individual transport can process.
15628
15629 If you use a virus-scanner and set this option to to a value larger than the
15630 maximum size that your virus-scanner is configured to support, you may get
15631 failures triggered by large mails.  The right size to configure for the
15632 virus-scanner depends upon what data is passed and the options in use but it's
15633 probably safest to just set it to a little larger than this value.  E.g., with a
15634 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15635 some problems may result.
15636
15637 A value of 0 will disable size limit checking; Exim will still advertise the
15638 SIZE extension in an EHLO response, but without a limit, so as to permit
15639 SMTP clients to still indicate the message size along with the MAIL verb.
15640
15641
15642 .option move_frozen_messages main boolean false
15643 .cindex "frozen messages" "moving"
15644 This option, which is available only if Exim has been built with the setting
15645 .code
15646 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15647 .endd
15648 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15649 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15650 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15651 standard utilities for handling such moved messages, and they do not show up in
15652 lists generated by &%-bp%& or by the Exim monitor.
15653
15654
15655 .option mua_wrapper main boolean false
15656 Setting this option true causes Exim to run in a very restrictive mode in which
15657 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15658 contains a full description of this facility.
15659
15660
15661
15662 .option mysql_servers main "string list" unset
15663 .cindex "MySQL" "server list"
15664 This option provides a list of MySQL servers and associated connection data, to
15665 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15666 option is available only if Exim has been built with MySQL support.
15667
15668
15669 .option never_users main "string list&!!" unset
15670 This option is expanded just once, at the start of Exim's processing. Local
15671 message deliveries are normally run in processes that are setuid to the
15672 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15673 It is usually desirable to prevent any deliveries from running as root, as a
15674 safety precaution.
15675
15676 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15677 list of users that must not be used for local deliveries. This list is fixed in
15678 the binary and cannot be overridden by the configuration file. By default, it
15679 contains just the single user name &"root"&. The &%never_users%& runtime option
15680 can be used to add more users to the fixed list.
15681
15682 If a message is to be delivered as one of the users on the fixed list or the
15683 &%never_users%& list, an error occurs, and delivery is deferred. A common
15684 example is
15685 .code
15686 never_users = root:daemon:bin
15687 .endd
15688 Including root is redundant if it is also on the fixed list, but it does no
15689 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15690 transport driver.
15691
15692
15693 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15694 .cindex "OpenSSL "compatibility options"
15695 This option allows an administrator to adjust the SSL options applied
15696 by OpenSSL to connections.  It is given as a space-separated list of items,
15697 each one to be +added or -subtracted from the current value.
15698
15699 This option is only available if Exim is built against OpenSSL.  The values
15700 available for this option vary according to the age of your OpenSSL install.
15701 The &"all"& value controls a subset of flags which are available, typically
15702 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15703 list the values known on your system and Exim should support all the
15704 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15705 names lose the leading &"SSL_OP_"& and are lower-cased.
15706
15707 Note that adjusting the options can have severe impact upon the security of
15708 SSL as used by Exim.  It is possible to disable safety checks and shoot
15709 yourself in the foot in various unpleasant ways.  This option should not be
15710 adjusted lightly.  An unrecognised item will be detected at startup, by
15711 invoking Exim with the &%-bV%& flag.
15712
15713 The option affects Exim operating both as a server and as a client.
15714
15715 Historical note: prior to release 4.80, Exim defaulted this value to
15716 "+dont_insert_empty_fragments", which may still be needed for compatibility
15717 with some clients, but which lowers security by increasing exposure to
15718 some now infamous attacks.
15719
15720 Examples:
15721 .code
15722 # Make both old MS and old Eudora happy:
15723 openssl_options = -all +microsoft_big_sslv3_buffer \
15724                        +dont_insert_empty_fragments
15725
15726 # Disable older protocol versions:
15727 openssl_options = +no_sslv2 +no_sslv3
15728 .endd
15729
15730 Possible options may include:
15731 .ilist
15732 &`all`&
15733 .next
15734 &`allow_unsafe_legacy_renegotiation`&
15735 .next
15736 &`cipher_server_preference`&
15737 .next
15738 &`dont_insert_empty_fragments`&
15739 .next
15740 &`ephemeral_rsa`&
15741 .next
15742 &`legacy_server_connect`&
15743 .next
15744 &`microsoft_big_sslv3_buffer`&
15745 .next
15746 &`microsoft_sess_id_bug`&
15747 .next
15748 &`msie_sslv2_rsa_padding`&
15749 .next
15750 &`netscape_challenge_bug`&
15751 .next
15752 &`netscape_reuse_cipher_change_bug`&
15753 .next
15754 &`no_compression`&
15755 .next
15756 &`no_session_resumption_on_renegotiation`&
15757 .next
15758 &`no_sslv2`&
15759 .next
15760 &`no_sslv3`&
15761 .next
15762 &`no_ticket`&
15763 .next
15764 &`no_tlsv1`&
15765 .next
15766 &`no_tlsv1_1`&
15767 .next
15768 &`no_tlsv1_2`&
15769 .next
15770 &`safari_ecdhe_ecdsa_bug`&
15771 .next
15772 &`single_dh_use`&
15773 .next
15774 &`single_ecdh_use`&
15775 .next
15776 &`ssleay_080_client_dh_bug`&
15777 .next
15778 &`sslref2_reuse_cert_type_bug`&
15779 .next
15780 &`tls_block_padding_bug`&
15781 .next
15782 &`tls_d5_bug`&
15783 .next
15784 &`tls_rollback_bug`&
15785 .endlist
15786
15787 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15788 all clients connecting using the MacOS SecureTransport TLS facility prior
15789 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15790 to negotiate TLS then this option value might help, provided that your OpenSSL
15791 release is new enough to contain this work-around.  This may be a situation
15792 where you have to upgrade OpenSSL to get buggy clients working.
15793
15794
15795 .option oracle_servers main "string list" unset
15796 .cindex "Oracle" "server list"
15797 This option provides a list of Oracle servers and associated connection data,
15798 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15799 The option is available only if Exim has been built with Oracle support.
15800
15801
15802 .option percent_hack_domains main "domain list&!!" unset
15803 .cindex "&""percent hack""&"
15804 .cindex "source routing" "in email address"
15805 .cindex "address" "source-routed"
15806 The &"percent hack"& is the convention whereby a local part containing a
15807 percent sign is re-interpreted as a new email address, with the percent
15808 replaced by @. This is sometimes called &"source routing"&, though that term is
15809 also applied to RFC 2822 addresses that begin with an @ character. If this
15810 option is set, Exim implements the percent facility for those domains listed,
15811 but no others. This happens before an incoming SMTP address is tested against
15812 an ACL.
15813
15814 &*Warning*&: The &"percent hack"& has often been abused by people who are
15815 trying to get round relaying restrictions. For this reason, it is best avoided
15816 if at all possible. Unfortunately, a number of less security-conscious MTAs
15817 implement it unconditionally. If you are running Exim on a gateway host, and
15818 routing mail through to internal MTAs without processing the local parts, it is
15819 a good idea to reject recipient addresses with percent characters in their
15820 local parts. Exim's default configuration does this.
15821
15822
15823 .option perl_at_start main boolean false
15824 .cindex "Perl"
15825 This option is available only when Exim is built with an embedded Perl
15826 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15827
15828
15829 .option perl_startup main string unset
15830 .cindex "Perl"
15831 This option is available only when Exim is built with an embedded Perl
15832 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15833
15834 .option perl_startup main boolean false
15835 .cindex "Perl"
15836 This Option enables the taint mode of the embedded Perl interpreter.
15837
15838
15839 .option pgsql_servers main "string list" unset
15840 .cindex "PostgreSQL lookup type" "server list"
15841 This option provides a list of PostgreSQL servers and associated connection
15842 data, to be used in conjunction with &(pgsql)& lookups (see section
15843 &<<SECID72>>&). The option is available only if Exim has been built with
15844 PostgreSQL support.
15845
15846
15847 .option pid_file_path main string&!! "set at compile time"
15848 .cindex "daemon" "pid file path"
15849 .cindex "pid file, path for"
15850 This option sets the name of the file to which the Exim daemon writes its
15851 process id. The string is expanded, so it can contain, for example, references
15852 to the host name:
15853 .code
15854 pid_file_path = /var/log/$primary_hostname/exim.pid
15855 .endd
15856 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15857 spool directory.
15858 The value set by the option can be overridden by the &%-oP%& command line
15859 option. A pid file is not written if a &"non-standard"& daemon is run by means
15860 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15861
15862
15863 .option pipelining_advertise_hosts main "host list&!!" *
15864 .cindex "PIPELINING" "suppressing advertising"
15865 This option can be used to suppress the advertisement of the SMTP
15866 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15867 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15868 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15869 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15870 that clients will use it; &"out of order"& commands that are &"expected"& do
15871 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15872
15873
15874 .option prdr_enable main boolean false
15875 .cindex "PRDR" "enabling on server"
15876 This option can be used to enable the Per-Recipient Data Response extension
15877 to SMTP, defined by Eric Hall.
15878 If the option is set, PRDR is advertised by Exim when operating as a server.
15879 If the client requests PRDR, and more than one recipient, for a message
15880 an additional ACL is called for each recipient after the message content
15881 is received.  See section &<<SECTPRDRACL>>&.
15882
15883 .option preserve_message_logs main boolean false
15884 .cindex "message logs" "preserving"
15885 If this option is set, message log files are not deleted when messages are
15886 completed. Instead, they are moved to a sub-directory of the spool directory
15887 called &_msglog.OLD_&, where they remain available for statistical or debugging
15888 purposes. This is a dangerous option to set on systems with any appreciable
15889 volume of mail. Use with care!
15890
15891
15892 .option primary_hostname main string "see below"
15893 .cindex "name" "of local host"
15894 .cindex "host" "name of local"
15895 .cindex "local host" "name of"
15896 .vindex "&$primary_hostname$&"
15897 This specifies the name of the current host. It is used in the default EHLO or
15898 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15899 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15900 The value is also used by default in some SMTP response messages from an Exim
15901 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15902
15903 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15904 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15905 contains only one component, Exim passes it to &[gethostbyname()]& (or
15906 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15907 version. The variable &$primary_hostname$& contains the host name, whether set
15908 explicitly by this option, or defaulted.
15909
15910
15911 .option print_topbitchars main boolean false
15912 .cindex "printing characters"
15913 .cindex "8-bit characters"
15914 By default, Exim considers only those characters whose codes lie in the range
15915 32&--126 to be printing characters. In a number of circumstances (for example,
15916 when writing log entries) non-printing characters are converted into escape
15917 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15918 is set, code values of 128 and above are also considered to be printing
15919 characters.
15920
15921 This option also affects the header syntax checks performed by the
15922 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15923 the user's full name when constructing From: and Sender: addresses (as
15924 described in section &<<SECTconstr>>&). Setting this option can cause
15925 Exim to generate eight bit message headers that do not conform to the
15926 standards.
15927
15928
15929 .option process_log_path main string unset
15930 .cindex "process log path"
15931 .cindex "log" "process log"
15932 .cindex "&'exiwhat'&"
15933 This option sets the name of the file to which an Exim process writes its
15934 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15935 utility script. If this option is unset, the file called &_exim-process.info_&
15936 in Exim's spool directory is used. The ability to specify the name explicitly
15937 can be useful in environments where two different Exims are running, using
15938 different spool directories.
15939
15940
15941 .option prod_requires_admin main boolean true
15942 .oindex "&%-M%&"
15943 .oindex "&%-R%&"
15944 .oindex "&%-q%&"
15945 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15946 admin user unless &%prod_requires_admin%& is set false. See also
15947 &%queue_list_requires_admin%&.
15948
15949
15950 .option qualify_domain main string "see below"
15951 .cindex "domain" "for qualifying addresses"
15952 .cindex "address" "qualification"
15953 This option specifies the domain name that is added to any envelope sender
15954 addresses that do not have a domain qualification. It also applies to
15955 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15956 are accepted by default only for locally-generated messages. Qualification is
15957 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15958 locally-generated messages, unless the &%-bnq%& command line option is used.
15959
15960 Messages from external sources must always contain fully qualified addresses,
15961 unless the sending host matches &%sender_unqualified_hosts%& or
15962 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15963 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15964 necessary. Internally, Exim always works with fully qualified envelope
15965 addresses. If &%qualify_domain%& is not set, it defaults to the
15966 &%primary_hostname%& value.
15967
15968
15969 .option qualify_recipient main string "see below"
15970 This option allows you to specify a different domain for qualifying recipient
15971 addresses to the one that is used for senders. See &%qualify_domain%& above.
15972
15973
15974
15975 .option queue_domains main "domain list&!!" unset
15976 .cindex "domain" "specifying non-immediate delivery"
15977 .cindex "queueing incoming messages"
15978 .cindex "message" "queueing certain domains"
15979 This option lists domains for which immediate delivery is not required.
15980 A delivery process is started whenever a message is received, but only those
15981 domains that do not match are processed. All other deliveries wait until the
15982 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15983
15984
15985 .option queue_list_requires_admin main boolean true
15986 .oindex "&%-bp%&"
15987 The &%-bp%& command-line option, which lists the messages that are on the
15988 queue, requires the caller to be an admin user unless
15989 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15990
15991
15992 .option queue_only main boolean false
15993 .cindex "queueing incoming messages"
15994 .cindex "message" "queueing unconditionally"
15995 If &%queue_only%& is set, a delivery process is not automatically started
15996 whenever a message is received. Instead, the message waits on the queue for the
15997 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15998 delivered immediately when certain conditions (such as heavy load) occur.
15999
16000 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16001 and &%-odi%& command line options override &%queue_only%& unless
16002 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16003 &%queue_only_load%&, and &%smtp_accept_queue%&.
16004
16005
16006 .option queue_only_file main string unset
16007 .cindex "queueing incoming messages"
16008 .cindex "message" "queueing by file existence"
16009 This option can be set to a colon-separated list of absolute path names, each
16010 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16011 it tests for the existence of each listed path using a call to &[stat()]&. For
16012 each path that exists, the corresponding queueing option is set.
16013 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16014 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16015 .code
16016 queue_only_file = smtp/some/file
16017 .endd
16018 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16019 &_/some/file_& exists.
16020
16021
16022 .option queue_only_load main fixed-point unset
16023 .cindex "load average"
16024 .cindex "queueing incoming messages"
16025 .cindex "message" "queueing by load"
16026 If the system load average is higher than this value, incoming messages from
16027 all sources are queued, and no automatic deliveries are started. If this
16028 happens during local or remote SMTP input, all subsequent messages received on
16029 the same SMTP connection are queued by default, whatever happens to the load in
16030 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16031 false.
16032
16033 Deliveries will subsequently be performed by queue runner processes. This
16034 option has no effect on ancient operating systems on which Exim cannot
16035 determine the load average. See also &%deliver_queue_load_max%& and
16036 &%smtp_load_reserve%&.
16037
16038
16039 .option queue_only_load_latch main boolean true
16040 .cindex "load average" "re-evaluating per message"
16041 When this option is true (the default), once one message has been queued
16042 because the load average is higher than the value set by &%queue_only_load%&,
16043 all subsequent messages received on the same SMTP connection are also queued.
16044 This is a deliberate choice; even though the load average may fall below the
16045 threshold, it doesn't seem right to deliver later messages on the same
16046 connection when not delivering earlier ones. However, there are special
16047 circumstances such as very long-lived connections from scanning appliances
16048 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16049 should be set false. This causes the value of the load average to be
16050 re-evaluated for each message.
16051
16052
16053 .option queue_only_override main boolean true
16054 .cindex "queueing incoming messages"
16055 When this option is true, the &%-od%&&'x'& command line options override the
16056 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16057 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16058 to override; they are accepted, but ignored.
16059
16060
16061 .option queue_run_in_order main boolean false
16062 .cindex "queue runner" "processing messages in order"
16063 If this option is set, queue runs happen in order of message arrival instead of
16064 in an arbitrary order. For this to happen, a complete list of the entire queue
16065 must be set up before the deliveries start. When the queue is all held in a
16066 single directory (the default), a single list is created for both the ordered
16067 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16068 single list is not created when &%queue_run_in_order%& is false. In this case,
16069 the sub-directories are processed one at a time (in a random order), and this
16070 avoids setting up one huge list for the whole queue. Thus, setting
16071 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16072 when the queue is large, because of the extra work in setting up the single,
16073 large list. In most situations, &%queue_run_in_order%& should not be set.
16074
16075
16076
16077 .option queue_run_max main integer&!! 5
16078 .cindex "queue runner" "maximum number of"
16079 This controls the maximum number of queue runner processes that an Exim daemon
16080 can run simultaneously. This does not mean that it starts them all at once,
16081 but rather that if the maximum number are still running when the time comes to
16082 start another one, it refrains from starting another one. This can happen with
16083 very large queues and/or very sluggish deliveries. This option does not,
16084 however, interlock with other processes, so additional queue runners can be
16085 started by other means, or by killing and restarting the daemon.
16086
16087 Setting this option to zero does not suppress queue runs; rather, it disables
16088 the limit, allowing any number of simultaneous queue runner processes to be
16089 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16090 the daemon's command line.
16091
16092 .cindex queues named
16093 .cindex "named queues"
16094 To set limits for different named queues use
16095 an expansion depending on the &$queue_name$& variable.
16096
16097 .option queue_smtp_domains main "domain list&!!" unset
16098 .cindex "queueing incoming messages"
16099 .cindex "message" "queueing remote deliveries"
16100 When this option is set, a delivery process is started whenever a message is
16101 received, routing is performed, and local deliveries take place.
16102 However, if any SMTP deliveries are required for domains that match
16103 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16104 message waits on the queue for the next queue run. Since routing of the message
16105 has taken place, Exim knows to which remote hosts it must be delivered, and so
16106 when the queue run happens, multiple messages for the same host are delivered
16107 over a single SMTP connection. The &%-odqs%& command line option causes all
16108 SMTP deliveries to be queued in this way, and is equivalent to setting
16109 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16110 &%queue_domains%&.
16111
16112
16113 .option receive_timeout main time 0s
16114 .cindex "timeout" "for non-SMTP input"
16115 This option sets the timeout for accepting a non-SMTP message, that is, the
16116 maximum time that Exim waits when reading a message on the standard input. If
16117 the value is zero, it will wait for ever. This setting is overridden by the
16118 &%-or%& command line option. The timeout for incoming SMTP messages is
16119 controlled by &%smtp_receive_timeout%&.
16120
16121 .option received_header_text main string&!! "see below"
16122 .cindex "customizing" "&'Received:'& header"
16123 .cindex "&'Received:'& header line" "customizing"
16124 This string defines the contents of the &'Received:'& message header that is
16125 added to each message, except for the timestamp, which is automatically added
16126 on at the end (preceded by a semicolon). The string is expanded each time it is
16127 used. If the expansion yields an empty string, no &'Received:'& header line is
16128 added to the message. Otherwise, the string should start with the text
16129 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16130 header lines. The default setting is:
16131
16132 .code
16133 received_header_text = Received: \
16134   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16135   {${if def:sender_ident \
16136   {from ${quote_local_part:$sender_ident} }}\
16137   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16138   by $primary_hostname \
16139   ${if def:received_protocol {with $received_protocol}} \
16140   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16141   (Exim $version_number)\n\t\
16142   ${if def:sender_address \
16143   {(envelope-from <$sender_address>)\n\t}}\
16144   id $message_exim_id\
16145   ${if def:received_for {\n\tfor $received_for}}
16146 .endd
16147
16148 The reference to the TLS cipher is omitted when Exim is built without TLS
16149 support. The use of conditional expansions ensures that this works for both
16150 locally generated messages and messages received from remote hosts, giving
16151 header lines such as the following:
16152 .code
16153 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16154 by marley.carol.example with esmtp (Exim 4.00)
16155 (envelope-from <bob@carol.example>)
16156 id 16IOWa-00019l-00
16157 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16158 Received: by scrooge.carol.example with local (Exim 4.00)
16159 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16160 .endd
16161 Until the body of the message has been received, the timestamp is the time when
16162 the message started to be received. Once the body has arrived, and all policy
16163 checks have taken place, the timestamp is updated to the time at which the
16164 message was accepted.
16165
16166
16167 .option received_headers_max main integer 30
16168 .cindex "loop" "prevention"
16169 .cindex "mail loop prevention"
16170 .cindex "&'Received:'& header line" "counting"
16171 When a message is to be delivered, the number of &'Received:'& headers is
16172 counted, and if it is greater than this parameter, a mail loop is assumed to
16173 have occurred, the delivery is abandoned, and an error message is generated.
16174 This applies to both local and remote deliveries.
16175
16176
16177 .option recipient_unqualified_hosts main "host list&!!" unset
16178 .cindex "unqualified addresses"
16179 .cindex "host" "unqualified addresses from"
16180 This option lists those hosts from which Exim is prepared to accept unqualified
16181 recipient addresses in message envelopes. The addresses are made fully
16182 qualified by the addition of the &%qualify_recipient%& value. This option also
16183 affects message header lines. Exim does not reject unqualified recipient
16184 addresses in headers, but it qualifies them only if the message came from a
16185 host that matches &%recipient_unqualified_hosts%&,
16186 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16187 option was not set.
16188
16189
16190 .option recipients_max main integer 0
16191 .cindex "limit" "number of recipients"
16192 .cindex "recipient" "maximum number"
16193 If this option is set greater than zero, it specifies the maximum number of
16194 original recipients for any message. Additional recipients that are generated
16195 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16196 all recipients over the limit; earlier recipients are delivered as normal.
16197 Non-SMTP messages with too many recipients are failed, and no deliveries are
16198 done.
16199
16200 .cindex "RCPT" "maximum number of incoming"
16201 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16202 RCPT commands in a single message.
16203
16204
16205 .option recipients_max_reject main boolean false
16206 If this option is set true, Exim rejects SMTP messages containing too many
16207 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16208 error to the eventual DATA command. Otherwise (the default) it gives a 452
16209 error to the surplus RCPT commands and accepts the message on behalf of the
16210 initial set of recipients. The remote server should then re-send the message
16211 for the remaining recipients at a later time.
16212
16213
16214 .option remote_max_parallel main integer 2
16215 .cindex "delivery" "parallelism for remote"
16216 This option controls parallel delivery of one message to a number of remote
16217 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16218 does all the remote deliveries for a message one by one. Otherwise, if a single
16219 message has to be delivered to more than one remote host, or if several copies
16220 have to be sent to the same remote host, up to &%remote_max_parallel%&
16221 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16222 deliveries are required, the maximum number of processes are started, and as
16223 each one finishes, another is begun. The order of starting processes is the
16224 same as if sequential delivery were being done, and can be controlled by the
16225 &%remote_sort_domains%& option. If parallel delivery takes place while running
16226 with debugging turned on, the debugging output from each delivery process is
16227 tagged with its process id.
16228
16229 This option controls only the maximum number of parallel deliveries for one
16230 message in one Exim delivery process. Because Exim has no central queue
16231 manager, there is no way of controlling the total number of simultaneous
16232 deliveries if the configuration allows a delivery attempt as soon as a message
16233 is received.
16234
16235 .cindex "number of deliveries"
16236 .cindex "delivery" "maximum number of"
16237 If you want to control the total number of deliveries on the system, you
16238 need to set the &%queue_only%& option. This ensures that all incoming messages
16239 are added to the queue without starting a delivery process. Then set up an Exim
16240 daemon to start queue runner processes at appropriate intervals (probably
16241 fairly often, for example, every minute), and limit the total number of queue
16242 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16243 delivers only one message at a time, the maximum number of deliveries that can
16244 then take place at once is &%queue_run_max%& multiplied by
16245 &%remote_max_parallel%&.
16246
16247 If it is purely remote deliveries you want to control, use
16248 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16249 doing the SMTP routing before queueing, so that several messages for the same
16250 host will eventually get delivered down the same connection.
16251
16252
16253 .option remote_sort_domains main "domain list&!!" unset
16254 .cindex "sorting remote deliveries"
16255 .cindex "delivery" "sorting remote"
16256 When there are a number of remote deliveries for a message, they are sorted by
16257 domain into the order given by this list. For example,
16258 .code
16259 remote_sort_domains = *.cam.ac.uk:*.uk
16260 .endd
16261 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16262 then to those in the &%uk%& domain, then to any others.
16263
16264
16265 .option retry_data_expire main time 7d
16266 .cindex "hints database" "data expiry"
16267 This option sets a &"use before"& time on retry information in Exim's hints
16268 database. Any older retry data is ignored. This means that, for example, once a
16269 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16270 past failures.
16271
16272
16273 .option retry_interval_max main time 24h
16274 .cindex "retry" "limit on interval"
16275 .cindex "limit" "on retry interval"
16276 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16277 intervals between delivery attempts for messages that cannot be delivered
16278 straight away. This option sets an overall limit to the length of time between
16279 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16280 the default value.
16281
16282
16283 .option return_path_remove main boolean true
16284 .cindex "&'Return-path:'& header line" "removing"
16285 RFC 2821, section 4.4, states that an SMTP server must insert a
16286 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16287 The &'Return-path:'& header preserves the sender address as received in the
16288 MAIL command. This description implies that this header should not be present
16289 in an incoming message. If &%return_path_remove%& is true, any existing
16290 &'Return-path:'& headers are removed from messages at the time they are
16291 received. Exim's transports have options for adding &'Return-path:'& headers at
16292 the time of delivery. They are normally used only for final local deliveries.
16293
16294
16295 .option return_size_limit main integer 100K
16296 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16297
16298
16299 .option rfc1413_hosts main "host list&!!" @[]
16300 .cindex "RFC 1413"
16301 .cindex "host" "for RFC 1413 calls"
16302 RFC 1413 identification calls are made to any client host which matches
16303 an item in the list.
16304 The default value specifies just this host, being any local interface
16305 for the system.
16306
16307 .option rfc1413_query_timeout main time 0s
16308 .cindex "RFC 1413" "query timeout"
16309 .cindex "timeout" "for RFC 1413 call"
16310 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16311 no RFC 1413 calls are ever made.
16312
16313
16314 .option sender_unqualified_hosts main "host list&!!" unset
16315 .cindex "unqualified addresses"
16316 .cindex "host" "unqualified addresses from"
16317 This option lists those hosts from which Exim is prepared to accept unqualified
16318 sender addresses. The addresses are made fully qualified by the addition of
16319 &%qualify_domain%&. This option also affects message header lines. Exim does
16320 not reject unqualified addresses in headers that contain sender addresses, but
16321 it qualifies them only if the message came from a host that matches
16322 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16323 using TCP/IP), and the &%-bnq%& option was not set.
16324
16325 .option set_environment main "string list" empty
16326 .cindex "environment"
16327 This option allows to set individual environment variables that the
16328 currently linked libraries and programs in child processes use. The
16329 default list is empty,
16330
16331
16332 .option slow_lookup_log main integer 0
16333 .cindex "logging" "slow lookups"
16334 .cindex "dns" "logging slow lookups"
16335 This option controls logging of slow lookups.
16336 If the value is nonzero it is taken as a number of milliseconds
16337 and lookups taking longer than this are logged.
16338 Currently this applies only to DNS lookups.
16339
16340
16341
16342 .option smtp_accept_keepalive main boolean true
16343 .cindex "keepalive" "on incoming connection"
16344 This option controls the setting of the SO_KEEPALIVE option on incoming
16345 TCP/IP socket connections. When set, it causes the kernel to probe idle
16346 connections periodically, by sending packets with &"old"& sequence numbers. The
16347 other end of the connection should send an acknowledgment if the connection is
16348 still okay or a reset if the connection has been aborted. The reason for doing
16349 this is that it has the beneficial effect of freeing up certain types of
16350 connection that can get stuck when the remote host is disconnected without
16351 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16352 hours to detect unreachable hosts.
16353
16354
16355
16356 .option smtp_accept_max main integer 20
16357 .cindex "limit" "incoming SMTP connections"
16358 .cindex "SMTP" "incoming connection count"
16359 .cindex "inetd"
16360 This option specifies the maximum number of simultaneous incoming SMTP calls
16361 that Exim will accept. It applies only to the listening daemon; there is no
16362 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16363 value is set to zero, no limit is applied. However, it is required to be
16364 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16365 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16366
16367 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16368 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16369 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16370 and &%smtp_load_reserve%& are then checked before accepting the connection.
16371
16372
16373 .option smtp_accept_max_nonmail main integer 10
16374 .cindex "limit" "non-mail SMTP commands"
16375 .cindex "SMTP" "limiting non-mail commands"
16376 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16377 the connection if there are too many. This option defines &"too many"&. The
16378 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16379 client looping sending EHLO, for example. The check is applied only if the
16380 client host matches &%smtp_accept_max_nonmail_hosts%&.
16381
16382 When a new message is expected, one occurrence of RSET is not counted. This
16383 allows a client to send one RSET between messages (this is not necessary,
16384 but some clients do it). Exim also allows one uncounted occurrence of HELO
16385 or EHLO, and one occurrence of STARTTLS between messages. After
16386 starting up a TLS session, another EHLO is expected, and so it too is not
16387 counted. The first occurrence of AUTH in a connection, or immediately
16388 following STARTTLS is not counted. Otherwise, all commands other than
16389 MAIL, RCPT, DATA, and QUIT are counted.
16390
16391
16392 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16393 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16394 check by setting this option. The default value makes it apply to all hosts. By
16395 changing the value, you can exclude any badly-behaved hosts that you have to
16396 live with.
16397
16398
16399 . Allow this long option name to split; give it unsplit as a fifth argument
16400 . for the automatic .oindex that is generated by .option.
16401 . We insert " &~&~" which is both pretty nasty visually and results in
16402 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16403 . zero-width-space, which would be nicer visually and results in (at least)
16404 . html that Firefox will split on when it's forced to reflow (rather than
16405 . inserting a horizontal scrollbar).  However, the text is still not
16406 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16407 . the option name to split.
16408
16409 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16410          smtp_accept_max_per_connection
16411 .cindex "SMTP" "limiting incoming message count"
16412 .cindex "limit" "messages per SMTP connection"
16413 The value of this option limits the number of MAIL commands that Exim is
16414 prepared to accept over a single SMTP connection, whether or not each command
16415 results in the transfer of a message. After the limit is reached, a 421
16416 response is given to subsequent MAIL commands. This limit is a safety
16417 precaution against a client that goes mad (incidents of this type have been
16418 seen).
16419
16420
16421 .option smtp_accept_max_per_host main string&!! unset
16422 .cindex "limit" "SMTP connections from one host"
16423 .cindex "host" "limiting SMTP connections from"
16424 This option restricts the number of simultaneous IP connections from a single
16425 host (strictly, from a single IP address) to the Exim daemon. The option is
16426 expanded, to enable different limits to be applied to different hosts by
16427 reference to &$sender_host_address$&. Once the limit is reached, additional
16428 connection attempts from the same host are rejected with error code 421. This
16429 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16430 of zero imposes no limit. If this option is set greater than zero, it is
16431 required that &%smtp_accept_max%& be non-zero.
16432
16433 &*Warning*&: When setting this option you should not use any expansion
16434 constructions that take an appreciable amount of time. The expansion and test
16435 happen in the main daemon loop, in order to reject additional connections
16436 without forking additional processes (otherwise a denial-of-service attack
16437 could cause a vast number or processes to be created). While the daemon is
16438 doing this processing, it cannot accept any other incoming connections.
16439
16440
16441
16442 .option smtp_accept_queue main integer 0
16443 .cindex "SMTP" "incoming connection count"
16444 .cindex "queueing incoming messages"
16445 .cindex "message" "queueing by SMTP connection count"
16446 If the number of simultaneous incoming SMTP connections being handled via the
16447 listening daemon exceeds this value, messages received by SMTP are just placed
16448 on the queue; no delivery processes are started automatically. The count is
16449 fixed at the start of an SMTP connection. It cannot be updated in the
16450 subprocess that receives messages, and so the queueing or not queueing applies
16451 to all messages received in the same connection.
16452
16453 A value of zero implies no limit, and clearly any non-zero value is useful only
16454 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16455 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16456 various &%-od%&&'x'& command line options.
16457
16458
16459 . See the comment on smtp_accept_max_per_connection
16460
16461 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16462          smtp_accept_queue_per_connection
16463 .cindex "queueing incoming messages"
16464 .cindex "message" "queueing by message count"
16465 This option limits the number of delivery processes that Exim starts
16466 automatically when receiving messages via SMTP, whether via the daemon or by
16467 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16468 and the number of messages received in a single SMTP session exceeds this
16469 number, subsequent messages are placed on the queue, but no delivery processes
16470 are started. This helps to limit the number of Exim processes when a server
16471 restarts after downtime and there is a lot of mail waiting for it on other
16472 systems. On large systems, the default should probably be increased, and on
16473 dial-in client systems it should probably be set to zero (that is, disabled).
16474
16475
16476 .option smtp_accept_reserve main integer 0
16477 .cindex "SMTP" "incoming call count"
16478 .cindex "host" "reserved"
16479 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16480 number of SMTP connections that are reserved for connections from the hosts
16481 that are specified in &%smtp_reserve_hosts%&. The value set in
16482 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16483 restricted to this number of connections; the option specifies a minimum number
16484 of connection slots for them, not a maximum. It is a guarantee that this group
16485 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16486 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16487 individual host.
16488
16489 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16490 set to 5, once there are 45 active connections (from any hosts), new
16491 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16492 provided the other criteria for acceptance are met.
16493
16494
16495 .option smtp_active_hostname main string&!! unset
16496 .cindex "host" "name in SMTP responses"
16497 .cindex "SMTP" "host name in responses"
16498 .vindex "&$primary_hostname$&"
16499 This option is provided for multi-homed servers that want to masquerade as
16500 several different hosts. At the start of an incoming SMTP connection, its value
16501 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16502 responses. For example, it is used as domain name in the response to an
16503 incoming HELO or EHLO command.
16504
16505 .vindex "&$smtp_active_hostname$&"
16506 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16507 is saved with any messages that are received. It is therefore available for use
16508 in routers and transports when the message is later delivered.
16509
16510 If this option is unset, or if its expansion is forced to fail, or if the
16511 expansion results in an empty string, the value of &$primary_hostname$& is
16512 used. Other expansion failures cause a message to be written to the main and
16513 panic logs, and the SMTP command receives a temporary error. Typically, the
16514 value of &%smtp_active_hostname%& depends on the incoming interface address.
16515 For example:
16516 .code
16517 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16518   {cox.mydomain}{box.mydomain}}
16519 .endd
16520
16521 Although &$smtp_active_hostname$& is primarily concerned with incoming
16522 messages, it is also used as the default for HELO commands in callout
16523 verification if there is no remote transport from which to obtain a
16524 &%helo_data%& value.
16525
16526 .option smtp_banner main string&!! "see below"
16527 .cindex "SMTP" "welcome banner"
16528 .cindex "banner for SMTP"
16529 .cindex "welcome banner for SMTP"
16530 .cindex "customizing" "SMTP banner"
16531 This string, which is expanded every time it is used, is output as the initial
16532 positive response to an SMTP connection. The default setting is:
16533 .code
16534 smtp_banner = $smtp_active_hostname ESMTP Exim \
16535   $version_number $tod_full
16536 .endd
16537 Failure to expand the string causes a panic error. If you want to create a
16538 multiline response to the initial SMTP connection, use &"\n"& in the string at
16539 appropriate points, but not at the end. Note that the 220 code is not included
16540 in this string. Exim adds it automatically (several times in the case of a
16541 multiline response).
16542
16543
16544 .option smtp_check_spool_space main boolean true
16545 .cindex "checking disk space"
16546 .cindex "disk space, checking"
16547 .cindex "spool directory" "checking space"
16548 When this option is set, if an incoming SMTP session encounters the SIZE
16549 option on a MAIL command, it checks that there is enough space in the
16550 spool directory's partition to accept a message of that size, while still
16551 leaving free the amount specified by &%check_spool_space%& (even if that value
16552 is zero). If there isn't enough space, a temporary error code is returned.
16553
16554
16555 .option smtp_connect_backlog main integer 20
16556 .cindex "connection backlog"
16557 .cindex "SMTP" "connection backlog"
16558 .cindex "backlog of connections"
16559 This option specifies a maximum number of waiting SMTP connections. Exim passes
16560 this value to the TCP/IP system when it sets up its listener. Once this number
16561 of connections are waiting for the daemon's attention, subsequent connection
16562 attempts are refused at the TCP/IP level. At least, that is what the manuals
16563 say; in some circumstances such connection attempts have been observed to time
16564 out instead. For large systems it is probably a good idea to increase the
16565 value (to 50, say). It also gives some protection against denial-of-service
16566 attacks by SYN flooding.
16567
16568
16569 .option smtp_enforce_sync main boolean true
16570 .cindex "SMTP" "synchronization checking"
16571 .cindex "synchronization checking in SMTP"
16572 The SMTP protocol specification requires the client to wait for a response from
16573 the server at certain points in the dialogue. Without PIPELINING these
16574 synchronization points are after every command; with PIPELINING they are
16575 fewer, but they still exist.
16576
16577 Some spamming sites send out a complete set of SMTP commands without waiting
16578 for any response. Exim protects against this by rejecting a message if the
16579 client has sent further input when it should not have. The error response &"554
16580 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16581 for this error cannot be perfect because of transmission delays (unexpected
16582 input may be on its way but not yet received when Exim checks). However, it
16583 does detect many instances.
16584
16585 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16586 If you want to disable the check selectively (for example, only for certain
16587 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16588 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16589
16590
16591
16592 .option smtp_etrn_command main string&!! unset
16593 .cindex "ETRN" "command to be run"
16594 .vindex "&$domain$&"
16595 If this option is set, the given command is run whenever an SMTP ETRN
16596 command is received from a host that is permitted to issue such commands (see
16597 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16598 are independently expanded. The expansion variable &$domain$& is set to the
16599 argument of the ETRN command, and no syntax checking is done on it. For
16600 example:
16601 .code
16602 smtp_etrn_command = /etc/etrn_command $domain \
16603                     $sender_host_address
16604 .endd
16605 A new process is created to run the command, but Exim does not wait for it to
16606 complete. Consequently, its status cannot be checked. If the command cannot be
16607 run, a line is written to the panic log, but the ETRN caller still receives
16608 a 250 success response. Exim is normally running under its own uid when
16609 receiving SMTP, so it is not possible for it to change the uid before running
16610 the command.
16611
16612
16613 .option smtp_etrn_serialize main boolean true
16614 .cindex "ETRN" "serializing"
16615 When this option is set, it prevents the simultaneous execution of more than
16616 one identical command as a result of ETRN in an SMTP connection. See
16617 section &<<SECTETRN>>& for details.
16618
16619
16620 .option smtp_load_reserve main fixed-point unset
16621 .cindex "load average"
16622 If the system load average ever gets higher than this, incoming SMTP calls are
16623 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16624 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16625 the load is over the limit. The option has no effect on ancient operating
16626 systems on which Exim cannot determine the load average. See also
16627 &%deliver_queue_load_max%& and &%queue_only_load%&.
16628
16629
16630
16631 .option smtp_max_synprot_errors main integer 3
16632 .cindex "SMTP" "limiting syntax and protocol errors"
16633 .cindex "limit" "SMTP syntax and protocol errors"
16634 Exim rejects SMTP commands that contain syntax or protocol errors. In
16635 particular, a syntactically invalid email address, as in this command:
16636 .code
16637 RCPT TO:<abc xyz@a.b.c>
16638 .endd
16639 causes immediate rejection of the command, before any other tests are done.
16640 (The ACL cannot be run if there is no valid address to set up for it.) An
16641 example of a protocol error is receiving RCPT before MAIL. If there are
16642 too many syntax or protocol errors in one SMTP session, the connection is
16643 dropped. The limit is set by this option.
16644
16645 .cindex "PIPELINING" "expected errors"
16646 When the PIPELINING extension to SMTP is in use, some protocol errors are
16647 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16648 Exim assumes that PIPELINING will be used if it advertises it (see
16649 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16650 not count towards the limit.
16651
16652
16653
16654 .option smtp_max_unknown_commands main integer 3
16655 .cindex "SMTP" "limiting unknown commands"
16656 .cindex "limit" "unknown SMTP commands"
16657 If there are too many unrecognized commands in an incoming SMTP session, an
16658 Exim server drops the connection. This is a defence against some kinds of abuse
16659 that subvert web
16660 clients
16661 into making connections to SMTP ports; in these circumstances, a number of
16662 non-SMTP command lines are sent first.
16663
16664
16665
16666 .option smtp_ratelimit_hosts main "host list&!!" unset
16667 .cindex "SMTP" "rate limiting"
16668 .cindex "limit" "rate of message arrival"
16669 .cindex "RCPT" "rate limiting"
16670 Some sites find it helpful to be able to limit the rate at which certain hosts
16671 can send them messages, and the rate at which an individual message can specify
16672 recipients.
16673
16674 Exim has two rate-limiting facilities. This section describes the older
16675 facility, which can limit rates within a single connection. The newer
16676 &%ratelimit%& ACL condition can limit rates across all connections. See section
16677 &<<SECTratelimiting>>& for details of the newer facility.
16678
16679 When a host matches &%smtp_ratelimit_hosts%&, the values of
16680 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16681 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16682 respectively. Each option, if set, must contain a set of four comma-separated
16683 values:
16684
16685 .ilist
16686 A threshold, before which there is no rate limiting.
16687 .next
16688 An initial time delay. Unlike other times in Exim, numbers with decimal
16689 fractional parts are allowed here.
16690 .next
16691 A factor by which to increase the delay each time.
16692 .next
16693 A maximum value for the delay. This should normally be less than 5 minutes,
16694 because after that time, the client is liable to timeout the SMTP command.
16695 .endlist
16696
16697 For example, these settings have been used successfully at the site which
16698 first suggested this feature, for controlling mail from their customers:
16699 .code
16700 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16701 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16702 .endd
16703 The first setting specifies delays that are applied to MAIL commands after
16704 two have been received over a single connection. The initial delay is 0.5
16705 seconds, increasing by a factor of 1.05 each time. The second setting applies
16706 delays to RCPT commands when more than four occur in a single message.
16707
16708
16709 .option smtp_ratelimit_mail main string unset
16710 See &%smtp_ratelimit_hosts%& above.
16711
16712
16713 .option smtp_ratelimit_rcpt main string unset
16714 See &%smtp_ratelimit_hosts%& above.
16715
16716
16717 .option smtp_receive_timeout main time&!! 5m
16718 .cindex "timeout" "for SMTP input"
16719 .cindex "SMTP" "input timeout"
16720 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16721 input, including batch SMTP. If a line of input (either an SMTP command or a
16722 data line) is not received within this time, the SMTP connection is dropped and
16723 the message is abandoned.
16724 A line is written to the log containing one of the following messages:
16725 .code
16726 SMTP command timeout on connection from...
16727 SMTP data timeout on connection from...
16728 .endd
16729 The former means that Exim was expecting to read an SMTP command; the latter
16730 means that it was in the DATA phase, reading the contents of a message.
16731
16732 If the first character of the option is a &"$"& the option is
16733 expanded before use and may depend on
16734 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16735
16736
16737 .oindex "&%-os%&"
16738 The value set by this option can be overridden by the
16739 &%-os%& command-line option. A setting of zero time disables the timeout, but
16740 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16741 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16742 timeout is controlled by &%receive_timeout%& and &%-or%&.
16743
16744
16745 .option smtp_reserve_hosts main "host list&!!" unset
16746 This option defines hosts for which SMTP connections are reserved; see
16747 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16748
16749
16750 .option smtp_return_error_details main boolean false
16751 .cindex "SMTP" "details policy failures"
16752 .cindex "policy control" "rejection, returning details"
16753 In the default state, Exim uses bland messages such as
16754 &"Administrative prohibition"& when it rejects SMTP commands for policy
16755 reasons. Many sysadmins like this because it gives away little information
16756 to spammers. However, some other sysadmins who are applying strict checking
16757 policies want to give out much fuller information about failures. Setting
16758 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16759 example, instead of &"Administrative prohibition"&, it might give:
16760 .code
16761 550-Rejected after DATA: '>' missing at end of address:
16762 550 failing address in "From" header is: <user@dom.ain
16763 .endd
16764
16765
16766 .option smtputf8_advertise_hosts main "host list&!!" *
16767 .cindex "SMTPUTF8" "advertising"
16768 When Exim is built with support for internationalised mail names,
16769 the availability thereof is advertised in
16770 response to EHLO only to those client hosts that match this option. See
16771 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16772
16773
16774 .option spamd_address main string "see below"
16775 This option is available when Exim is compiled with the content-scanning
16776 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16777 The default value is
16778 .code
16779 127.0.0.1 783
16780 .endd
16781 See section &<<SECTscanspamass>>& for more details.
16782
16783
16784
16785 .option split_spool_directory main boolean false
16786 .cindex "multiple spool directories"
16787 .cindex "spool directory" "split"
16788 .cindex "directories, multiple"
16789 If this option is set, it causes Exim to split its input directory into 62
16790 subdirectories, each with a single alphanumeric character as its name. The
16791 sixth character of the message id is used to allocate messages to
16792 subdirectories; this is the least significant base-62 digit of the time of
16793 arrival of the message.
16794
16795 Splitting up the spool in this way may provide better performance on systems
16796 where there are long mail queues, by reducing the number of files in any one
16797 directory. The msglog directory is also split up in a similar way to the input
16798 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16799 are still placed in the single directory &_msglog.OLD_&.
16800
16801 It is not necessary to take any special action for existing messages when
16802 changing &%split_spool_directory%&. Exim notices messages that are in the
16803 &"wrong"& place, and continues to process them. If the option is turned off
16804 after a period of being on, the subdirectories will eventually empty and be
16805 automatically deleted.
16806
16807 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16808 changes. Instead of creating a list of all messages in the queue, and then
16809 trying to deliver each one in turn, it constructs a list of those in one
16810 sub-directory and tries to deliver them, before moving on to the next
16811 sub-directory. The sub-directories are processed in a random order. This
16812 spreads out the scanning of the input directories, and uses less memory. It is
16813 particularly beneficial when there are lots of messages on the queue. However,
16814 if &%queue_run_in_order%& is set, none of this new processing happens. The
16815 entire queue has to be scanned and sorted before any deliveries can start.
16816
16817
16818 .option spool_directory main string&!! "set at compile time"
16819 .cindex "spool directory" "path to"
16820 This defines the directory in which Exim keeps its spool, that is, the messages
16821 it is waiting to deliver. The default value is taken from the compile-time
16822 configuration setting, if there is one. If not, this option must be set. The
16823 string is expanded, so it can contain, for example, a reference to
16824 &$primary_hostname$&.
16825
16826 If the spool directory name is fixed on your installation, it is recommended
16827 that you set it at build time rather than from this option, particularly if the
16828 log files are being written to the spool directory (see &%log_file_path%&).
16829 Otherwise log files cannot be used for errors that are detected early on, such
16830 as failures in the configuration file.
16831
16832 By using this option to override the compiled-in path, it is possible to run
16833 tests of Exim without using the standard spool.
16834
16835 .option sqlite_lock_timeout main time 5s
16836 .cindex "sqlite lookup type" "lock timeout"
16837 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16838 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16839
16840 .option strict_acl_vars main boolean false
16841 .cindex "&ACL;" "variables, handling unset"
16842 This option controls what happens if a syntactically valid but undefined ACL
16843 variable is referenced. If it is false (the default), an empty string
16844 is substituted; if it is true, an error is generated. See section
16845 &<<SECTaclvariables>>& for details of ACL variables.
16846
16847 .option strip_excess_angle_brackets main boolean false
16848 .cindex "angle brackets, excess"
16849 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16850 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16851 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16852 passed on to another MTA, the excess angle brackets are not passed on. If this
16853 option is not set, multiple pairs of angle brackets cause a syntax error.
16854
16855
16856 .option strip_trailing_dot main boolean false
16857 .cindex "trailing dot on domain"
16858 .cindex "dot" "trailing on domain"
16859 If this option is set, a trailing dot at the end of a domain in an address is
16860 ignored. If this is in the envelope and the message is passed on to another
16861 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16862 domain causes a syntax error.
16863 However, addresses in header lines are checked only when an ACL requests header
16864 syntax checking.
16865
16866
16867 .option syslog_duplication main boolean true
16868 .cindex "syslog" "duplicate log lines; suppressing"
16869 When Exim is logging to syslog, it writes the log lines for its three
16870 separate logs at different syslog priorities so that they can in principle
16871 be separated on the logging hosts. Some installations do not require this
16872 separation, and in those cases, the duplication of certain log lines is a
16873 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16874 particular log line is written to syslog. For lines that normally go to
16875 both the main log and the reject log, the reject log version (possibly
16876 containing message header lines) is written, at LOG_NOTICE priority.
16877 Lines that normally go to both the main and the panic log are written at
16878 the LOG_ALERT priority.
16879
16880
16881 .option syslog_facility main string unset
16882 .cindex "syslog" "facility; setting"
16883 This option sets the syslog &"facility"& name, used when Exim is logging to
16884 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16885 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16886 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16887 details of Exim's logging.
16888
16889
16890 .option syslog_pid main boolean true
16891 .cindex "syslog" "pid"
16892 If &%syslog_pid%& is set false, the PID on Exim's log lines are
16893 omitted when these lines are sent to syslog. (Syslog normally prefixes
16894 the log lines with the PID of the logging process automatically.) You need
16895 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
16896 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
16897
16898
16899
16900 .option syslog_processname main string &`exim`&
16901 .cindex "syslog" "process name; setting"
16902 This option sets the syslog &"ident"& name, used when Exim is logging to
16903 syslog. The value must be no longer than 32 characters. See chapter
16904 &<<CHAPlog>>& for details of Exim's logging.
16905
16906
16907
16908 .option syslog_timestamp main boolean true
16909 .cindex "syslog" "timestamps"
16910 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16911 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16912 details of Exim's logging.
16913
16914
16915 .option system_filter main string&!! unset
16916 .cindex "filter" "system filter"
16917 .cindex "system filter" "specifying"
16918 .cindex "Sieve filter" "not available for system filter"
16919 This option specifies an Exim filter file that is applied to all messages at
16920 the start of each delivery attempt, before any routing is done. System filters
16921 must be Exim filters; they cannot be Sieve filters. If the system filter
16922 generates any deliveries to files or pipes, or any new mail messages, the
16923 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16924 which transports are to be used. Details of this facility are given in chapter
16925 &<<CHAPsystemfilter>>&.
16926 A forced expansion failure results in no filter operation.
16927
16928
16929 .option system_filter_directory_transport main string&!! unset
16930 .vindex "&$address_file$&"
16931 This sets the name of the transport driver that is to be used when the
16932 &%save%& command in a system message filter specifies a path ending in &"/"&,
16933 implying delivery of each message into a separate file in some directory.
16934 During the delivery, the variable &$address_file$& contains the path name.
16935
16936
16937 .option system_filter_file_transport main string&!! unset
16938 .cindex "file" "transport for system filter"
16939 This sets the name of the transport driver that is to be used when the &%save%&
16940 command in a system message filter specifies a path not ending in &"/"&. During
16941 the delivery, the variable &$address_file$& contains the path name.
16942
16943 .option system_filter_group main string unset
16944 .cindex "gid (group id)" "system filter"
16945 This option is used only when &%system_filter_user%& is also set. It sets the
16946 gid under which the system filter is run, overriding any gid that is associated
16947 with the user. The value may be numerical or symbolic.
16948
16949 .option system_filter_pipe_transport main string&!! unset
16950 .cindex "&(pipe)& transport" "for system filter"
16951 .vindex "&$address_pipe$&"
16952 This specifies the transport driver that is to be used when a &%pipe%& command
16953 is used in a system filter. During the delivery, the variable &$address_pipe$&
16954 contains the pipe command.
16955
16956
16957 .option system_filter_reply_transport main string&!! unset
16958 .cindex "&(autoreply)& transport" "for system filter"
16959 This specifies the transport driver that is to be used when a &%mail%& command
16960 is used in a system filter.
16961
16962
16963 .option system_filter_user main string unset
16964 .cindex "uid (user id)" "system filter"
16965 If this option is set to root, the system filter is run in the main Exim
16966 delivery process, as root.  Otherwise, the system filter runs in a separate
16967 process, as the given user, defaulting to the Exim run-time user.
16968 Unless the string consists entirely of digits, it
16969 is looked up in the password data. Failure to find the named user causes a
16970 configuration error. The gid is either taken from the password data, or
16971 specified by &%system_filter_group%&. When the uid is specified numerically,
16972 &%system_filter_group%& is required to be set.
16973
16974 If the system filter generates any pipe, file, or reply deliveries, the uid
16975 under which the filter is run is used when transporting them, unless a
16976 transport option overrides.
16977
16978
16979 .option tcp_nodelay main boolean true
16980 .cindex "daemon" "TCP_NODELAY on sockets"
16981 .cindex "Nagle algorithm"
16982 .cindex "TCP_NODELAY on listening sockets"
16983 If this option is set false, it stops the Exim daemon setting the
16984 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16985 turns off the &"Nagle algorithm"&, which is a way of improving network
16986 performance in interactive (character-by-character) situations. Turning it off
16987 should improve Exim's performance a bit, so that is what happens by default.
16988 However, it appears that some broken clients cannot cope, and time out. Hence
16989 this option. It affects only those sockets that are set up for listening by the
16990 daemon. Sockets created by the smtp transport for delivering mail always set
16991 TCP_NODELAY.
16992
16993
16994 .option timeout_frozen_after main time 0s
16995 .cindex "frozen messages" "timing out"
16996 .cindex "timeout" "frozen messages"
16997 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16998 message of any kind that has been on the queue for longer than the given time
16999 is automatically cancelled at the next queue run. If the frozen message is a
17000 bounce message, it is just discarded; otherwise, a bounce is sent to the
17001 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17002 If you want to timeout frozen bounce messages earlier than other kinds of
17003 frozen message, see &%ignore_bounce_errors_after%&.
17004
17005 &*Note:*& the default value of zero means no timeouts; with this setting,
17006 frozen messages remain on the queue forever (except for any frozen bounce
17007 messages that are released by &%ignore_bounce_errors_after%&).
17008
17009
17010 .option timezone main string unset
17011 .cindex "timezone, setting"
17012 .cindex "environment" "values from"
17013 The value of &%timezone%& is used to set the environment variable TZ while
17014 running Exim (if it is different on entry). This ensures that all timestamps
17015 created by Exim are in the required timezone. If you want all your timestamps
17016 to be in UTC (aka GMT) you should set
17017 .code
17018 timezone = UTC
17019 .endd
17020 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17021 or, if that is not set, from the value of the TZ environment variable when Exim
17022 is built. If &%timezone%& is set to the empty string, either at build or run
17023 time, any existing TZ variable is removed from the environment when Exim
17024 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17025 unfortunately not all, operating systems.
17026
17027
17028 .option tls_advertise_hosts main "host list&!!" *
17029 .cindex "TLS" "advertising"
17030 .cindex "encryption" "on SMTP connection"
17031 .cindex "SMTP" "encrypted connection"
17032 When Exim is built with support for TLS encrypted connections, the availability
17033 of the STARTTLS command to set up an encrypted session is advertised in
17034 response to EHLO only to those client hosts that match this option. See
17035 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17036 Note that the default value requires that a certificate be supplied
17037 using the &%tls_certificate%& option.  If TLS support for incoming connections
17038 is not required the &%tls_advertise_hosts%& option should be set empty.
17039
17040
17041 .option tls_certificate main string&!! unset
17042 .cindex "TLS" "server certificate; location of"
17043 .cindex "certificate" "server, location of"
17044 The value of this option is expanded, and must then be the absolute path to a
17045 file which contains the server's certificates. The server's private key is also
17046 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17047 &<<CHAPTLS>>& for further details.
17048
17049 &*Note*&: The certificates defined by this option are used only when Exim is
17050 receiving incoming messages as a server. If you want to supply certificates for
17051 use when sending messages as a client, you must set the &%tls_certificate%&
17052 option in the relevant &(smtp)& transport.
17053
17054 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17055 if the OpenSSL build supports TLS extensions and the TLS client sends the
17056 Server Name Indication extension, then this option and others documented in
17057 &<<SECTtlssni>>& will be re-expanded.
17058
17059 If this option is unset or empty a fresh self-signed certificate will be
17060 generated for every connection.
17061
17062 .option tls_crl main string&!! unset
17063 .cindex "TLS" "server certificate revocation list"
17064 .cindex "certificate" "revocation list for server"
17065 This option specifies a certificate revocation list. The expanded value must
17066 be the name of a file that contains a CRL in PEM format.
17067
17068 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17069
17070
17071 .option tls_dh_max_bits main integer 2236
17072 .cindex "TLS" "D-H bit count"
17073 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17074 the chosen TLS library.  That value might prove to be too high for
17075 interoperability.  This option provides a maximum clamp on the value
17076 suggested, trading off security for interoperability.
17077
17078 The value must be at least 1024.
17079
17080 The value 2236 was chosen because, at time of adding the option, it was the
17081 hard-coded maximum value supported by the NSS cryptographic library, as used
17082 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17083
17084 If you prefer more security and are willing to break some clients, raise this
17085 number.
17086
17087 Note that the value passed to GnuTLS for *generating* a new prime may be a
17088 little less than this figure, because GnuTLS is inexact and may produce a
17089 larger prime than requested.
17090
17091
17092 .option tls_dhparam main string&!! unset
17093 .cindex "TLS" "D-H parameters for server"
17094 The value of this option is expanded and indicates the source of DH parameters
17095 to be used by Exim.
17096
17097 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17098 local DH parameters*&, which has been supported across all versions of Exim.  The
17099 other specific constants available are a fallback so that even when
17100 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17101
17102 If &%tls_dhparam%& is a filename starting with a &`/`&,
17103 then it names a file from which DH
17104 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17105 PKCS#3 representation of the DH prime.  If the file does not exist, for
17106 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17107 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17108 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17109 and treated as though the &%tls_dhparam%& were set to "none".
17110
17111 If this option expands to the string "none", then no DH parameters will be
17112 loaded by Exim.
17113
17114 If this option expands to the string "historic" and Exim is using GnuTLS, then
17115 Exim will attempt to load a file from inside the spool directory.  If the file
17116 does not exist, Exim will attempt to create it.
17117 See section &<<SECTgnutlsparam>>& for further details.
17118
17119 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17120 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17121
17122 In older versions of Exim the default was the 2048 bit prime described in section
17123 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17124 in IKE is assigned number 23.
17125
17126 Otherwise, the option must expand to the name used by Exim for any of a number
17127 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17128 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17129 the number used by IKE, or "default" which corresponds to
17130 &`exim.dev.20160529.3`&.
17131
17132 The available standard primes are:
17133 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17134 &`ike1`&, &`ike2`&, &`ike5`&,
17135 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17136 &`ike22`&, &`ike23`& and &`ike24`&.
17137
17138 The available additional primes are:
17139 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17140
17141 Some of these will be too small to be accepted by clients.
17142 Some may be too large to be accepted by clients.
17143 The open cryptographic community has suspicions about the integrity of some
17144 of the later IKE values, which led into RFC7919 providing new fixed constants
17145 (the "ffdhe" identifiers).
17146
17147 At this point, all of the "ike" values should be considered obsolete;
17148 they're still in Exim to avoid breaking unusual configurations, but are
17149 candidates for removal the next time we have backwards-incompatible changes.
17150
17151 The TLS protocol does not negotiate an acceptable size for this; clients tend
17152 to hard-drop connections if what is offered by the server is unacceptable,
17153 whether too large or too small, and there's no provision for the client to
17154 tell the server what these constraints are.  Thus, as a server operator, you
17155 need to make an educated guess as to what is most likely to work for your
17156 userbase.
17157
17158 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17159 is most likely to maximise interoperability.  The upper bound comes from
17160 applications using the Mozilla Network Security Services (NSS) library, which
17161 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17162 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17163 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17164 acceptable bound from 1024 to 2048.
17165
17166
17167 .option tls_eccurve main string&!! &`auto`&
17168 .cindex TLS "EC cryptography"
17169 This option selects a EC curve for use by Exim when used with OpenSSL.
17170 It has no effect when Exim is used with GnuTLS.
17171
17172 After expansion it must contain a valid EC curve parameter, such as
17173 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17174 for valid selections.
17175
17176 For OpenSSL versions before (and not including) 1.0.2, the string
17177 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17178 &`auto`& tells the library to choose.
17179
17180 If the option expands to an empty string, no EC curves will be enabled.
17181
17182
17183 .option tls_ocsp_file main string&!! unset
17184 .cindex TLS "certificate status"
17185 .cindex TLS "OCSP proof file"
17186 This option
17187 must if set expand to the absolute path to a file which contains a current
17188 status proof for the server's certificate, as obtained from the
17189 Certificate Authority.
17190
17191 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17192
17193
17194 .option tls_on_connect_ports main "string list" unset
17195 .cindex SSMTP
17196 .cindex SMTPS
17197 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17198 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17199 set up without waiting for the client to issue a STARTTLS command. For
17200 further details, see section &<<SECTsupobssmt>>&.
17201
17202
17203
17204 .option tls_privatekey main string&!! unset
17205 .cindex "TLS" "server private key; location of"
17206 The value of this option is expanded, and must then be the absolute path to a
17207 file which contains the server's private key. If this option is unset, or if
17208 the expansion is forced to fail, or the result is an empty string, the private
17209 key is assumed to be in the same file as the server's certificates. See chapter
17210 &<<CHAPTLS>>& for further details.
17211
17212 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17213
17214
17215 .option tls_remember_esmtp main boolean false
17216 .cindex "TLS" "esmtp state; remembering"
17217 .cindex "TLS" "broken clients"
17218 If this option is set true, Exim violates the RFCs by remembering that it is in
17219 &"esmtp"& state after successfully negotiating a TLS session. This provides
17220 support for broken clients that fail to send a new EHLO after starting a
17221 TLS session.
17222
17223
17224 .option tls_require_ciphers main string&!! unset
17225 .cindex "TLS" "requiring specific ciphers"
17226 .cindex "cipher" "requiring specific"
17227 This option controls which ciphers can be used for incoming TLS connections.
17228 The &(smtp)& transport has an option of the same name for controlling outgoing
17229 connections. This option is expanded for each connection, so can be varied for
17230 different clients if required. The value of this option must be a list of
17231 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17232 in somewhat different ways. If GnuTLS is being used, the client controls the
17233 preference order of the available ciphers. Details are given in sections
17234 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17235
17236
17237 .option tls_try_verify_hosts main "host list&!!" unset
17238 .cindex "TLS" "client certificate verification"
17239 .cindex "certificate" "verification of client"
17240 See &%tls_verify_hosts%& below.
17241
17242
17243 .option tls_verify_certificates main string&!! system
17244 .cindex "TLS" "client certificate verification"
17245 .cindex "certificate" "verification of client"
17246 The value of this option is expanded, and must then be either the
17247 word "system"
17248 or the absolute path to
17249 a file or directory containing permitted certificates for clients that
17250 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17251
17252 The "system" value for the option will use a
17253 system default location compiled into the SSL library.
17254 This is not available for GnuTLS versions preceding 3.0.20,
17255 and will be taken as empty; an explicit location
17256 must be specified.
17257
17258 The use of a directory for the option value is not available for GnuTLS versions
17259 preceding 3.3.6 and a single file must be used.
17260
17261 With OpenSSL the certificates specified
17262 explicitly
17263 either by file or directory
17264 are added to those given by the system default location.
17265
17266 These certificates should be for the certificate authorities trusted, rather
17267 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17268 the value is a file then the certificates are sent by Exim as a server to
17269 connecting clients, defining the list of accepted certificate authorities.
17270 Thus the values defined should be considered public data.  To avoid this,
17271 use the explicit directory version.
17272
17273 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17274
17275 A forced expansion failure or setting to an empty string is equivalent to
17276 being unset.
17277
17278
17279 .option tls_verify_hosts main "host list&!!" unset
17280 .cindex "TLS" "client certificate verification"
17281 .cindex "certificate" "verification of client"
17282 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17283 certificates from clients. The expected certificates are defined by
17284 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17285 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17286 &%tls_verify_certificates%& is not set.
17287
17288 Any client that matches &%tls_verify_hosts%& is constrained by
17289 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17290 present one of the listed certificates. If it does not, the connection is
17291 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17292 the host to use TLS. It can still send SMTP commands through unencrypted
17293 connections. Forcing a client to use TLS has to be done separately using an
17294 ACL to reject inappropriate commands when the connection is not encrypted.
17295
17296 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17297 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17298 certificate and checks it against &%tls_verify_certificates%&, but does not
17299 abort the connection if there is no certificate or if it does not match. This
17300 state can be detected in an ACL, which makes it possible to implement policies
17301 such as &"accept for relay only if a verified certificate has been received,
17302 but accept for local delivery if encrypted, even without a verified
17303 certificate"&.
17304
17305 Client hosts that match neither of these lists are not asked to present
17306 certificates.
17307
17308
17309 .option trusted_groups main "string list&!!" unset
17310 .cindex "trusted groups"
17311 .cindex "groups" "trusted"
17312 This option is expanded just once, at the start of Exim's processing. If this
17313 option is set, any process that is running in one of the listed groups, or
17314 which has one of them as a supplementary group, is trusted. The groups can be
17315 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17316 details of what trusted callers are permitted to do. If neither
17317 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17318 are trusted.
17319
17320 .option trusted_users main "string list&!!" unset
17321 .cindex "trusted users"
17322 .cindex "user" "trusted"
17323 This option is expanded just once, at the start of Exim's processing. If this
17324 option is set, any process that is running as one of the listed users is
17325 trusted. The users can be specified numerically or by name. See section
17326 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17327 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17328 Exim user are trusted.
17329
17330 .option unknown_login main string&!! unset
17331 .cindex "uid (user id)" "unknown caller"
17332 .vindex "&$caller_uid$&"
17333 This is a specialized feature for use in unusual configurations. By default, if
17334 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17335 gives up. The &%unknown_login%& option can be used to set a login name to be
17336 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17337 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17338 is used for the user's real name (gecos field), unless this has been set by the
17339 &%-F%& option.
17340
17341 .option unknown_username main string unset
17342 See &%unknown_login%&.
17343
17344 .option untrusted_set_sender main "address list&!!" unset
17345 .cindex "trusted users"
17346 .cindex "sender" "setting by untrusted user"
17347 .cindex "untrusted user setting sender"
17348 .cindex "user" "untrusted setting sender"
17349 .cindex "envelope sender"
17350 When an untrusted user submits a message to Exim using the standard input, Exim
17351 normally creates an envelope sender address from the user's login and the
17352 default qualification domain. Data from the &%-f%& option (for setting envelope
17353 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17354 is used) is ignored.
17355
17356 However, untrusted users are permitted to set an empty envelope sender address,
17357 to declare that a message should never generate any bounces. For example:
17358 .code
17359 exim -f '<>' user@domain.example
17360 .endd
17361 .vindex "&$sender_ident$&"
17362 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17363 other envelope sender addresses in a controlled way. When it is set, untrusted
17364 users are allowed to set envelope sender addresses that match any of the
17365 patterns in the list. Like all address lists, the string is expanded. The
17366 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17367 users to setting senders that start with their login ids
17368 followed by a hyphen
17369 by a setting like this:
17370 .code
17371 untrusted_set_sender = ^$sender_ident-
17372 .endd
17373 If you want to allow untrusted users to set envelope sender addresses without
17374 restriction, you can use
17375 .code
17376 untrusted_set_sender = *
17377 .endd
17378 The &%untrusted_set_sender%& option applies to all forms of local input, but
17379 only to the setting of the envelope sender. It does not permit untrusted users
17380 to use the other options which trusted user can use to override message
17381 parameters. Furthermore, it does not stop Exim from removing an existing
17382 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17383 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17384 overriding these actions. The handling of the &'Sender:'& header is also
17385 described in section &<<SECTthesenhea>>&.
17386
17387 The log line for a message's arrival shows the envelope sender following
17388 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17389 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17390 envelope sender address, the user's login is shown in parentheses after the
17391 sender address.
17392
17393
17394 .option uucp_from_pattern main string "see below"
17395 .cindex "&""From""& line"
17396 .cindex "UUCP" "&""From""& line"
17397 Some applications that pass messages to an MTA via a command line interface use
17398 an initial line starting with &"From&~"& to pass the envelope sender. In
17399 particular, this is used by UUCP software. Exim recognizes such a line by means
17400 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17401 matches, the sender address is constructed by expanding the contents of
17402 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17403 default pattern recognizes lines in the following two forms:
17404 .code
17405 From ph10 Fri Jan  5 12:35 GMT 1996
17406 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17407 .endd
17408 The pattern can be seen by running
17409 .code
17410 exim -bP uucp_from_pattern
17411 .endd
17412 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17413 year in the second case. The first word after &"From&~"& is matched in the
17414 regular expression by a parenthesized subpattern. The default value for
17415 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17416 (&"ph10"& in the example above) as the message's sender. See also
17417 &%ignore_fromline_hosts%&.
17418
17419
17420 .option uucp_from_sender main string&!! &`$1`&
17421 See &%uucp_from_pattern%& above.
17422
17423
17424 .option warn_message_file main string unset
17425 .cindex "warning of delay" "customizing the message"
17426 .cindex "customizing" "warning message"
17427 This option defines a template file containing paragraphs of text to be used
17428 for constructing the warning message which is sent by Exim when a message has
17429 been on the queue for a specified amount of time, as specified by
17430 &%delay_warning%&. Details of the file's contents are given in chapter
17431 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17432
17433
17434 .option write_rejectlog main boolean true
17435 .cindex "reject log" "disabling"
17436 If this option is set false, Exim no longer writes anything to the reject log.
17437 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17438 .ecindex IIDconfima
17439 .ecindex IIDmaiconf
17440
17441
17442
17443
17444 . ////////////////////////////////////////////////////////////////////////////
17445 . ////////////////////////////////////////////////////////////////////////////
17446
17447 .chapter "Generic options for routers" "CHAProutergeneric"
17448 .scindex IIDgenoprou1 "options" "generic; for routers"
17449 .scindex IIDgenoprou2 "generic options" "router"
17450 This chapter describes the generic options that apply to all routers.
17451 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17452
17453 For a general description of how a router operates, see sections
17454 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17455 which the preconditions are tested. The order of expansion of the options that
17456 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17457 &%headers_remove%&, &%transport%&.
17458
17459
17460
17461 .option address_data routers string&!! unset
17462 .cindex "router" "data attached to address"
17463 The string is expanded just before the router is run, that is, after all the
17464 precondition tests have succeeded. If the expansion is forced to fail, the
17465 router declines, the value of &%address_data%& remains unchanged, and the
17466 &%more%& option controls what happens next. Other expansion failures cause
17467 delivery of the address to be deferred.
17468
17469 .vindex "&$address_data$&"
17470 When the expansion succeeds, the value is retained with the address, and can be
17471 accessed using the variable &$address_data$& in the current router, subsequent
17472 routers, and the eventual transport.
17473
17474 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17475 that runs a user's filter file, the contents of &$address_data$& are accessible
17476 in the filter. This is not normally a problem, because such data is usually
17477 either not confidential or it &"belongs"& to the current user, but if you do
17478 put confidential data into &$address_data$& you need to remember this point.
17479
17480 Even if the router declines or passes, the value of &$address_data$& remains
17481 with the address, though it can be changed by another &%address_data%& setting
17482 on a subsequent router. If a router generates child addresses, the value of
17483 &$address_data$& propagates to them. This also applies to the special kind of
17484 &"child"& that is generated by a router with the &%unseen%& option.
17485
17486 The idea of &%address_data%& is that you can use it to look up a lot of data
17487 for the address once, and then pick out parts of the data later. For example,
17488 you could use a single LDAP lookup to return a string of the form
17489 .code
17490 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17491 .endd
17492 In the transport you could pick out the mailbox by a setting such as
17493 .code
17494 file = ${extract{mailbox}{$address_data}}
17495 .endd
17496 This makes the configuration file less messy, and also reduces the number of
17497 lookups (though Exim does cache lookups).
17498
17499 .vindex "&$sender_address_data$&"
17500 .vindex "&$address_data$&"
17501 The &%address_data%& facility is also useful as a means of passing information
17502 from one router to another, and from a router to a transport. In addition, if
17503 &$address_data$& is set by a router when verifying a recipient address from an
17504 ACL, it remains available for use in the rest of the ACL statement. After
17505 verifying a sender, the value is transferred to &$sender_address_data$&.
17506
17507
17508
17509 .option address_test routers&!? boolean true
17510 .oindex "&%-bt%&"
17511 .cindex "router" "skipping when address testing"
17512 If this option is set false, the router is skipped when routing is being tested
17513 by means of the &%-bt%& command line option. This can be a convenience when
17514 your first router sends messages to an external scanner, because it saves you
17515 having to set the &"already scanned"& indicator when testing real address
17516 routing.
17517
17518
17519
17520 .option cannot_route_message routers string&!! unset
17521 .cindex "router" "customizing &""cannot route""& message"
17522 .cindex "customizing" "&""cannot route""& message"
17523 This option specifies a text message that is used when an address cannot be
17524 routed because Exim has run out of routers. The default message is
17525 &"Unrouteable address"&. This option is useful only on routers that have
17526 &%more%& set false, or on the very last router in a configuration, because the
17527 value that is used is taken from the last router that is considered. This
17528 includes a router that is skipped because its preconditions are not met, as
17529 well as a router that declines. For example, using the default configuration,
17530 you could put:
17531 .code
17532 cannot_route_message = Remote domain not found in DNS
17533 .endd
17534 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17535 and
17536 .code
17537 cannot_route_message = Unknown local user
17538 .endd
17539 on the final router that checks for local users. If string expansion fails for
17540 this option, the default message is used. Unless the expansion failure was
17541 explicitly forced, a message about the failure is written to the main and panic
17542 logs, in addition to the normal message about the routing failure.
17543
17544
17545 .option caseful_local_part routers boolean false
17546 .cindex "case of local parts"
17547 .cindex "router" "case of local parts"
17548 By default, routers handle the local parts of addresses in a case-insensitive
17549 manner, though the actual case is preserved for transmission with the message.
17550 If you want the case of letters to be significant in a router, you must set
17551 this option true. For individual router options that contain address or local
17552 part lists (for example, &%local_parts%&), case-sensitive matching can be
17553 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17554 more details.
17555
17556 .vindex "&$local_part$&"
17557 .vindex "&$original_local_part$&"
17558 .vindex "&$parent_local_part$&"
17559 The value of the &$local_part$& variable is forced to lower case while a
17560 router is running unless &%caseful_local_part%& is set. When a router assigns
17561 an address to a transport, the value of &$local_part$& when the transport runs
17562 is the same as it was in the router. Similarly, when a router generates child
17563 addresses by aliasing or forwarding, the values of &$original_local_part$&
17564 and &$parent_local_part$& are those that were used by the redirecting router.
17565
17566 This option applies to the processing of an address by a router. When a
17567 recipient address is being processed in an ACL, there is a separate &%control%&
17568 modifier that can be used to specify case-sensitive processing within the ACL
17569 (see section &<<SECTcontrols>>&).
17570
17571
17572
17573 .option check_local_user routers&!? boolean false
17574 .cindex "local user, checking in router"
17575 .cindex "router" "checking for local user"
17576 .cindex "&_/etc/passwd_&"
17577 .vindex "&$home$&"
17578 When this option is true, Exim checks that the local part of the recipient
17579 address (with affixes removed if relevant) is the name of an account on the
17580 local system. The check is done by calling the &[getpwnam()]& function rather
17581 than trying to read &_/etc/passwd_& directly. This means that other methods of
17582 holding password data (such as NIS) are supported. If the local part is a local
17583 user, &$home$& is set from the password data, and can be tested in other
17584 preconditions that are evaluated after this one (the order of evaluation is
17585 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17586 overridden by &%router_home_directory%&. If the local part is not a local user,
17587 the router is skipped.
17588
17589 If you want to check that the local part is either the name of a local user
17590 or matches something else, you cannot combine &%check_local_user%& with a
17591 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17592 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17593 setting to achieve this. For example:
17594 .code
17595 local_parts = passwd;$local_part : lsearch;/etc/other/users
17596 .endd
17597 Note, however, that the side effects of &%check_local_user%& (such as setting
17598 up a home directory) do not occur when a &(passwd)& lookup is used in a
17599 &%local_parts%& (or any other) precondition.
17600
17601
17602
17603 .option condition routers&!? string&!! unset
17604 .cindex "router" "customized precondition"
17605 This option specifies a general precondition test that has to succeed for the
17606 router to be called. The &%condition%& option is the last precondition to be
17607 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17608 result is a forced failure, or an empty string, or one of the strings &"0"& or
17609 &"no"& or &"false"& (checked without regard to the case of the letters), the
17610 router is skipped, and the address is offered to the next one.
17611
17612 If the result is any other value, the router is run (as this is the last
17613 precondition to be evaluated, all the other preconditions must be true).
17614
17615 This option is unusual in that multiple &%condition%& options may be present.
17616 All &%condition%& options must succeed.
17617
17618 The &%condition%& option provides a means of applying custom conditions to the
17619 running of routers. Note that in the case of a simple conditional expansion,
17620 the default expansion values are exactly what is wanted. For example:
17621 .code
17622 condition = ${if >{$message_age}{600}}
17623 .endd
17624 Because of the default behaviour of the string expansion, this is equivalent to
17625 .code
17626 condition = ${if >{$message_age}{600}{true}{}}
17627 .endd
17628
17629 A multiple condition example, which succeeds:
17630 .code
17631 condition = ${if >{$message_age}{600}}
17632 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17633 condition = foobar
17634 .endd
17635
17636 If the expansion fails (other than forced failure) delivery is deferred. Some
17637 of the other precondition options are common special cases that could in fact
17638 be specified using &%condition%&.
17639
17640 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17641 are far older, and use one set of semantics.  ACLs are newer and when
17642 they were created, the ACL &%condition%& process was given far stricter
17643 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17644 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17645 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17646 Router rules processing behavior.
17647
17648 This is best illustrated in an example:
17649 .code
17650 # If used in an ACL condition will fail with a syntax error, but
17651 # in a router condition any extra characters are treated as a string
17652
17653 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17654 true {yes} {no}}
17655
17656 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17657  {yes} {no}}
17658 .endd
17659 In each example above, the &%if%& statement actually ends after
17660 &"{google.com}}"&.  Since no true or false braces were defined, the
17661 default &%if%& behavior is to return a boolean true or a null answer
17662 (which evaluates to false). The rest of the line is then treated as a
17663 string. So the first example resulted in the boolean answer &"true"&
17664 with the string &" {yes} {no}}"& appended to it. The second example
17665 resulted in the null output (indicating false) with the string
17666 &" {yes} {no}}"& appended to it.
17667
17668 In fact you can put excess forward braces in too.  In the router
17669 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17670 mean something, like after a &"$"& or when required as part of a
17671 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17672 string characters.
17673
17674 Thus, in a Router, the above expansion strings will both always evaluate
17675 true, as the result of expansion is a non-empty string which doesn't
17676 match an explicit false value.  This can be tricky to debug.  By
17677 contrast, in an ACL either of those strings will always result in an
17678 expansion error because the result doesn't look sufficiently boolean.
17679
17680
17681 .option debug_print routers string&!! unset
17682 .cindex "testing" "variables in drivers"
17683 If this option is set and debugging is enabled (see the &%-d%& command line
17684 option) or in address-testing mode (see the &%-bt%& command line option),
17685 the string is expanded and included in the debugging output.
17686 If expansion of the string fails, the error message is written to the debugging
17687 output, and Exim carries on processing.
17688 This option is provided to help with checking out the values of variables and
17689 so on when debugging router configurations. For example, if a &%condition%&
17690 option appears not to be working, &%debug_print%& can be used to output the
17691 variables it references. The output happens after checks for &%domains%&,
17692 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17693 are tested. A newline is added to the text if it does not end with one.
17694 The variable &$router_name$& contains the name of the router.
17695
17696
17697
17698 .option disable_logging routers boolean false
17699 If this option is set true, nothing is logged for any routing errors
17700 or for any deliveries caused by this router. You should not set this option
17701 unless you really, really know what you are doing. See also the generic
17702 transport option of the same name.
17703
17704 .option dnssec_request_domains routers "domain list&!!" unset
17705 .cindex "MX record" "security"
17706 .cindex "DNSSEC" "MX lookup"
17707 .cindex "security" "MX lookup"
17708 .cindex "DNS" "DNSSEC"
17709 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17710 the dnssec request bit set.
17711 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17712
17713 .option dnssec_require_domains routers "domain list&!!" unset
17714 .cindex "MX record" "security"
17715 .cindex "DNSSEC" "MX lookup"
17716 .cindex "security" "MX lookup"
17717 .cindex "DNS" "DNSSEC"
17718 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17719 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17720 (AD bit) set will be ignored and logged as a host-lookup failure.
17721 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17722
17723
17724 .option domains routers&!? "domain list&!!" unset
17725 .cindex "router" "restricting to specific domains"
17726 .vindex "&$domain_data$&"
17727 If this option is set, the router is skipped unless the current domain matches
17728 the list. If the match is achieved by means of a file lookup, the data that the
17729 lookup returned for the domain is placed in &$domain_data$& for use in string
17730 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17731 a list of the order in which preconditions are evaluated.
17732
17733
17734
17735 .option driver routers string unset
17736 This option must always be set. It specifies which of the available routers is
17737 to be used.
17738
17739
17740 .option dsn_lasthop routers boolean false
17741 .cindex "DSN" "success"
17742 .cindex "Delivery Status Notification" "success"
17743 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17744 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17745 instead send a success DSN as if the next hop does not support DSN.
17746 Not effective on redirect routers.
17747
17748
17749
17750 .option errors_to routers string&!! unset
17751 .cindex "envelope sender"
17752 .cindex "router" "changing address for errors"
17753 If a router successfully handles an address, it may assign the address to a
17754 transport for delivery or it may generate child addresses. In both cases, if
17755 there is a delivery problem during later processing, the resulting bounce
17756 message is sent to the address that results from expanding this string,
17757 provided that the address verifies successfully. The &%errors_to%& option is
17758 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17759
17760 The &%errors_to%& setting associated with an address can be overridden if it
17761 subsequently passes through other routers that have their own &%errors_to%&
17762 settings, or if the message is delivered by a transport with a &%return_path%&
17763 setting.
17764
17765 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17766 the expansion fails to verify, the errors address associated with the incoming
17767 address is used. At top level, this is the envelope sender. A non-forced
17768 expansion failure causes delivery to be deferred.
17769
17770 If an address for which &%errors_to%& has been set ends up being delivered over
17771 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17772 any bounces that are generated by other MTAs on the delivery route are also
17773 sent there. You can set &%errors_to%& to the empty string by either of these
17774 settings:
17775 .code
17776 errors_to =
17777 errors_to = ""
17778 .endd
17779 An expansion item that yields an empty string has the same effect. If you do
17780 this, a locally detected delivery error for addresses processed by this router
17781 no longer gives rise to a bounce message; the error is discarded. If the
17782 address is delivered to a remote host, the return path is set to &`<>`&, unless
17783 overridden by the &%return_path%& option on the transport.
17784
17785 .vindex "&$address_data$&"
17786 If for some reason you want to discard local errors, but use a non-empty
17787 MAIL command for remote delivery, you can preserve the original return
17788 path in &$address_data$& in the router, and reinstate it in the transport by
17789 setting &%return_path%&.
17790
17791 The most common use of &%errors_to%& is to direct mailing list bounces to the
17792 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17793 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17794
17795
17796
17797 .option expn routers&!? boolean true
17798 .cindex "address" "testing"
17799 .cindex "testing" "addresses"
17800 .cindex "EXPN" "router skipping"
17801 .cindex "router" "skipping for EXPN"
17802 If this option is turned off, the router is skipped when testing an address
17803 as a result of processing an SMTP EXPN command. You might, for example,
17804 want to turn it off on a router for users' &_.forward_& files, while leaving it
17805 on for the system alias file.
17806 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17807 are evaluated.
17808
17809 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17810 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17811 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17812
17813
17814
17815 .option fail_verify routers boolean false
17816 .cindex "router" "forcing verification failure"
17817 Setting this option has the effect of setting both &%fail_verify_sender%& and
17818 &%fail_verify_recipient%& to the same value.
17819
17820
17821
17822 .option fail_verify_recipient routers boolean false
17823 If this option is true and an address is accepted by this router when
17824 verifying a recipient, verification fails.
17825
17826
17827
17828 .option fail_verify_sender routers boolean false
17829 If this option is true and an address is accepted by this router when
17830 verifying a sender, verification fails.
17831
17832
17833
17834 .option fallback_hosts routers "string list" unset
17835 .cindex "router" "fallback hosts"
17836 .cindex "fallback" "hosts specified on router"
17837 String expansion is not applied to this option. The argument must be a
17838 colon-separated list of host names or IP addresses. The list separator can be
17839 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17840 each name or address. In fact, the format of each item is exactly the same as
17841 defined for the list of hosts in a &(manualroute)& router (see section
17842 &<<SECTformatonehostitem>>&).
17843
17844 If a router queues an address for a remote transport, this host list is
17845 associated with the address, and used instead of the transport's fallback host
17846 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17847 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17848 transport for further details.
17849
17850
17851 .option group routers string&!! "see below"
17852 .cindex "gid (group id)" "local delivery"
17853 .cindex "local transports" "uid and gid"
17854 .cindex "transport" "local"
17855 .cindex "router" "setting group"
17856 When a router queues an address for a transport, and the transport does not
17857 specify a group, the group given here is used when running the delivery
17858 process.
17859 The group may be specified numerically or by name. If expansion fails, the
17860 error is logged and delivery is deferred.
17861 The default is unset, unless &%check_local_user%& is set, when the default
17862 is taken from the password information. See also &%initgroups%& and &%user%&
17863 and the discussion in chapter &<<CHAPenvironment>>&.
17864
17865
17866
17867 .option headers_add routers list&!! unset
17868 .cindex "header lines" "adding"
17869 .cindex "router" "adding header lines"
17870 This option specifies a list of text headers,
17871 newline-separated (by default, changeable in the usual way),
17872 that is associated with any addresses that are accepted by the router.
17873 Each item is separately expanded, at routing time.  However, this
17874 option has no effect when an address is just being verified. The way in which
17875 the text is used to add header lines at transport time is described in section
17876 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17877 message is in the process of being transported. This means that references to
17878 header lines in string expansions in the transport's configuration do not
17879 &"see"& the added header lines.
17880
17881 The &%headers_add%& option is expanded after &%errors_to%&, but before
17882 &%headers_remove%& and &%transport%&. If an item is empty, or if
17883 an item expansion is forced to fail, the item has no effect. Other expansion
17884 failures are treated as configuration errors.
17885
17886 Unlike most options, &%headers_add%& can be specified multiple times
17887 for a router; all listed headers are added.
17888
17889 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17890 router that has the &%one_time%& option set.
17891
17892 .cindex "duplicate addresses"
17893 .oindex "&%unseen%&"
17894 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17895 additions are deleted when the address is passed on to subsequent routers.
17896 For a &%redirect%& router, if a generated address is the same as the incoming
17897 address, this can lead to duplicate addresses with different header
17898 modifications. Exim does not do duplicate deliveries (except, in certain
17899 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17900 which of the duplicates is discarded, so this ambiguous situation should be
17901 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17902
17903
17904
17905 .option headers_remove routers list&!! unset
17906 .cindex "header lines" "removing"
17907 .cindex "router" "removing header lines"
17908 This option specifies a list of text headers,
17909 colon-separated (by default, changeable in the usual way),
17910 that is associated with any addresses that are accepted by the router.
17911 Each item is separately expanded, at routing time.  However, this
17912 option has no effect when an address is just being verified. The way in which
17913 the text is used to remove header lines at transport time is described in
17914 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17915 the message is in the process of being transported. This means that references
17916 to header lines in string expansions in the transport's configuration still
17917 &"see"& the original header lines.
17918
17919 The &%headers_remove%& option is expanded after &%errors_to%& and
17920 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17921 the item has no effect. Other expansion failures are treated as configuration
17922 errors.
17923
17924 Unlike most options, &%headers_remove%& can be specified multiple times
17925 for a router; all listed headers are removed.
17926
17927 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17928 router that has the &%one_time%& option set.
17929
17930 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17931 removal requests are deleted when the address is passed on to subsequent
17932 routers, and this can lead to problems with duplicates -- see the similar
17933 warning for &%headers_add%& above.
17934
17935 &*Warning 3*&: Because of the separate expansion of the list items,
17936 items that contain a list separator must have it doubled.
17937 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17938
17939
17940
17941 .option ignore_target_hosts routers "host list&!!" unset
17942 .cindex "IP address" "discarding"
17943 .cindex "router" "discarding IP addresses"
17944 Although this option is a host list, it should normally contain IP address
17945 entries rather than names. If any host that is looked up by the router has an
17946 IP address that matches an item in this list, Exim behaves as if that IP
17947 address did not exist. This option allows you to cope with rogue DNS entries
17948 like
17949 .code
17950 remote.domain.example.  A  127.0.0.1
17951 .endd
17952 by setting
17953 .code
17954 ignore_target_hosts = 127.0.0.1
17955 .endd
17956 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17957 discarded in this way, the router declines. In a conventional configuration, an
17958 attempt to mail to such a domain would normally provoke the &"unrouteable
17959 domain"& error, and an attempt to verify an address in the domain would fail.
17960 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17961 router declines if presented with one of the listed addresses.
17962
17963 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17964 means of the first or the second of the following settings, respectively:
17965 .code
17966 ignore_target_hosts = 0.0.0.0/0
17967 ignore_target_hosts = <; 0::0/0
17968 .endd
17969 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17970 in the second line matches all IPv6 addresses.
17971
17972 This option may also be useful for ignoring link-local and site-local IPv6
17973 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17974 is expanded before use as a list, it is possible to make it dependent on the
17975 domain that is being routed.
17976
17977 .vindex "&$host_address$&"
17978 During its expansion, &$host_address$& is set to the IP address that is being
17979 checked.
17980
17981 .option initgroups routers boolean false
17982 .cindex "additional groups"
17983 .cindex "groups" "additional"
17984 .cindex "local transports" "uid and gid"
17985 .cindex "transport" "local"
17986 If the router queues an address for a transport, and this option is true, and
17987 the uid supplied by the router is not overridden by the transport, the
17988 &[initgroups()]& function is called when running the transport to ensure that
17989 any additional groups associated with the uid are set up. See also &%group%&
17990 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17991
17992
17993
17994 .option local_part_prefix routers&!? "string list" unset
17995 .cindex "router" "prefix for local part"
17996 .cindex "prefix" "for local part, used in router"
17997 If this option is set, the router is skipped unless the local part starts with
17998 one of the given strings, or &%local_part_prefix_optional%& is true. See
17999 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18000 evaluated.
18001
18002 The list is scanned from left to right, and the first prefix that matches is
18003 used. A limited form of wildcard is available; if the prefix begins with an
18004 asterisk, it matches the longest possible sequence of arbitrary characters at
18005 the start of the local part. An asterisk should therefore always be followed by
18006 some character that does not occur in normal local parts.
18007 .cindex "multiple mailboxes"
18008 .cindex "mailbox" "multiple"
18009 Wildcarding can be used to set up multiple user mailboxes, as described in
18010 section &<<SECTmulbox>>&.
18011
18012 .vindex "&$local_part$&"
18013 .vindex "&$local_part_prefix$&"
18014 During the testing of the &%local_parts%& option, and while the router is
18015 running, the prefix is removed from the local part, and is available in the
18016 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18017 the router accepts the address, this remains true during subsequent delivery by
18018 a transport. In particular, the local part that is transmitted in the RCPT
18019 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18020 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18021 the relevant transport.
18022
18023 When an address is being verified, &%local_part_prefix%& affects only the
18024 behaviour of the router. If the callout feature of verification is in use, this
18025 means that the full address, including the prefix, will be used during the
18026 callout.
18027
18028 The prefix facility is commonly used to handle local parts of the form
18029 &%owner-something%&. Another common use is to support local parts of the form
18030 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18031 to tell a user their forwarding is broken &-- by placing a router like this one
18032 immediately before the router that handles &_.forward_& files:
18033 .code
18034 real_localuser:
18035   driver = accept
18036   local_part_prefix = real-
18037   check_local_user
18038   transport = local_delivery
18039 .endd
18040 For security, it would probably be a good idea to restrict the use of this
18041 router to locally-generated messages, using a condition such as this:
18042 .code
18043   condition = ${if match {$sender_host_address}\
18044                          {\N^(|127\.0\.0\.1)$\N}}
18045 .endd
18046
18047 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18048 both conditions must be met if not optional. Care must be taken if wildcards
18049 are used in both a prefix and a suffix on the same router. Different
18050 separator characters must be used to avoid ambiguity.
18051
18052
18053 .option local_part_prefix_optional routers boolean false
18054 See &%local_part_prefix%& above.
18055
18056
18057
18058 .option local_part_suffix routers&!? "string list" unset
18059 .cindex "router" "suffix for local part"
18060 .cindex "suffix for local part" "used in router"
18061 This option operates in the same way as &%local_part_prefix%&, except that the
18062 local part must end (rather than start) with the given string, the
18063 &%local_part_suffix_optional%& option determines whether the suffix is
18064 mandatory, and the wildcard * character, if present, must be the last
18065 character of the suffix. This option facility is commonly used to handle local
18066 parts of the form &%something-request%& and multiple user mailboxes of the form
18067 &%username-foo%&.
18068
18069
18070 .option local_part_suffix_optional routers boolean false
18071 See &%local_part_suffix%& above.
18072
18073
18074
18075 .option local_parts routers&!? "local part list&!!" unset
18076 .cindex "router" "restricting to specific local parts"
18077 .cindex "local part" "checking in router"
18078 The router is run only if the local part of the address matches the list.
18079 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18080 are evaluated, and
18081 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18082 string is expanded, it is possible to make it depend on the domain, for
18083 example:
18084 .code
18085 local_parts = dbm;/usr/local/specials/$domain
18086 .endd
18087 .vindex "&$local_part_data$&"
18088 If the match is achieved by a lookup, the data that the lookup returned
18089 for the local part is placed in the variable &$local_part_data$& for use in
18090 expansions of the router's private options. You might use this option, for
18091 example, if you have a large number of local virtual domains, and you want to
18092 send all postmaster mail to the same place without having to set up an alias in
18093 each virtual domain:
18094 .code
18095 postmaster:
18096   driver = redirect
18097   local_parts = postmaster
18098   data = postmaster@real.domain.example
18099 .endd
18100
18101
18102 .option log_as_local routers boolean "see below"
18103 .cindex "log" "delivery line"
18104 .cindex "delivery" "log line format"
18105 Exim has two logging styles for delivery, the idea being to make local
18106 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18107 recipient address is given just as the local part, without a domain. The use of
18108 this style is controlled by this option. It defaults to true for the &(accept)&
18109 router, and false for all the others. This option applies only when a
18110 router assigns an address to a transport. It has no effect on routers that
18111 redirect addresses.
18112
18113
18114
18115 .option more routers boolean&!! true
18116 The result of string expansion for this option must be a valid boolean value,
18117 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18118 result causes an error, and delivery is deferred. If the expansion is forced to
18119 fail, the default value for the option (true) is used. Other failures cause
18120 delivery to be deferred.
18121
18122 If this option is set false, and the router declines to handle the address, no
18123 further routers are tried, routing fails, and the address is bounced.
18124 .oindex "&%self%&"
18125 However, if the router explicitly passes an address to the following router by
18126 means of the setting
18127 .code
18128 self = pass
18129 .endd
18130 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18131 does not affect the behaviour if one of the precondition tests fails. In that
18132 case, the address is always passed to the next router.
18133
18134 Note that &%address_data%& is not considered to be a precondition. If its
18135 expansion is forced to fail, the router declines, and the value of &%more%&
18136 controls what happens next.
18137
18138
18139 .option pass_on_timeout routers boolean false
18140 .cindex "timeout" "of router"
18141 .cindex "router" "timeout"
18142 If a router times out during a host lookup, it normally causes deferral of the
18143 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18144 router, overriding &%no_more%&. This may be helpful for systems that are
18145 intermittently connected to the Internet, or those that want to pass to a smart
18146 host any messages that cannot immediately be delivered.
18147
18148 There are occasional other temporary errors that can occur while doing DNS
18149 lookups. They are treated in the same way as a timeout, and this option
18150 applies to all of them.
18151
18152
18153
18154 .option pass_router routers string unset
18155 .cindex "router" "go to after &""pass""&"
18156 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18157 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18158 routing to continue, and overriding a false setting of &%more%&. When one of
18159 these routers returns &"pass"&, the address is normally handed on to the next
18160 router in sequence. This can be changed by setting &%pass_router%& to the name
18161 of another router. However (unlike &%redirect_router%&) the named router must
18162 be below the current router, to avoid loops. Note that this option applies only
18163 to the special case of &"pass"&. It does not apply when a router returns
18164 &"decline"& because it cannot handle an address.
18165
18166
18167
18168 .option redirect_router routers string unset
18169 .cindex "router" "start at after redirection"
18170 Sometimes an administrator knows that it is pointless to reprocess addresses
18171 generated from alias or forward files with the same router again. For
18172 example, if an alias file translates real names into login ids there is no
18173 point searching the alias file a second time, especially if it is a large file.
18174
18175 The &%redirect_router%& option can be set to the name of any router instance.
18176 It causes the routing of any generated addresses to start at the named router
18177 instead of at the first router. This option has no effect if the router in
18178 which it is set does not generate new addresses.
18179
18180
18181
18182 .option require_files routers&!? "string list&!!" unset
18183 .cindex "file" "requiring for router"
18184 .cindex "router" "requiring file existence"
18185 This option provides a general mechanism for predicating the running of a
18186 router on the existence or non-existence of certain files or directories.
18187 Before running a router, as one of its precondition tests, Exim works its way
18188 through the &%require_files%& list, expanding each item separately.
18189
18190 Because the list is split before expansion, any colons in expansion items must
18191 be doubled, or the facility for using a different list separator must be used.
18192 If any expansion is forced to fail, the item is ignored. Other expansion
18193 failures cause routing of the address to be deferred.
18194
18195 If any expanded string is empty, it is ignored. Otherwise, except as described
18196 below, each string must be a fully qualified file path, optionally preceded by
18197 &"!"&. The paths are passed to the &[stat()]& function to test for the
18198 existence of the files or directories. The router is skipped if any paths not
18199 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18200
18201 .cindex "NFS"
18202 If &[stat()]& cannot determine whether a file exists or not, delivery of
18203 the message is deferred. This can happen when NFS-mounted filesystems are
18204 unavailable.
18205
18206 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18207 options, so you cannot use it to check for the existence of a file in which to
18208 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18209 full list of the order in which preconditions are evaluated.) However, as
18210 these options are all expanded, you can use the &%exists%& expansion condition
18211 to make such tests. The &%require_files%& option is intended for checking files
18212 that the router may be going to use internally, or which are needed by a
18213 transport (for example &_.procmailrc_&).
18214
18215 During delivery, the &[stat()]& function is run as root, but there is a
18216 facility for some checking of the accessibility of a file by another user.
18217 This is not a proper permissions check, but just a &"rough"& check that
18218 operates as follows:
18219
18220 If an item in a &%require_files%& list does not contain any forward slash
18221 characters, it is taken to be the user (and optional group, separated by a
18222 comma) to be checked for subsequent files in the list. If no group is specified
18223 but the user is specified symbolically, the gid associated with the uid is
18224 used. For example:
18225 .code
18226 require_files = mail:/some/file
18227 require_files = $local_part:$home/.procmailrc
18228 .endd
18229 If a user or group name in a &%require_files%& list does not exist, the
18230 &%require_files%& condition fails.
18231
18232 Exim performs the check by scanning along the components of the file path, and
18233 checking the access for the given uid and gid. It checks for &"x"& access on
18234 directories, and &"r"& access on the final file. Note that this means that file
18235 access control lists, if the operating system has them, are ignored.
18236
18237 &*Warning 1*&: When the router is being run to verify addresses for an
18238 incoming SMTP message, Exim is not running as root, but under its own uid. This
18239 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18240 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18241 user is not permitted to read one of the directories on the file's path.
18242
18243 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18244 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18245 without root access. In this case, if a check for access by a particular user
18246 is requested, Exim creates a subprocess that runs as that user, and tries the
18247 check again in that process.
18248
18249 The default action for handling an unresolved EACCES is to consider it to
18250 be caused by a configuration error, and routing is deferred because the
18251 existence or non-existence of the file cannot be determined. However, in some
18252 circumstances it may be desirable to treat this condition as if the file did
18253 not exist. If the file name (or the exclamation mark that precedes the file
18254 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18255 as if the file did not exist. For example:
18256 .code
18257 require_files = +/some/file
18258 .endd
18259 If the router is not an essential part of verification (for example, it
18260 handles users' &_.forward_& files), another solution is to set the &%verify%&
18261 option false so that the router is skipped when verifying.
18262
18263
18264
18265 .option retry_use_local_part routers boolean "see below"
18266 .cindex "hints database" "retry keys"
18267 .cindex "local part" "in retry keys"
18268 When a delivery suffers a temporary routing failure, a retry record is created
18269 in Exim's hints database. For addresses whose routing depends only on the
18270 domain, the key for the retry record should not involve the local part, but for
18271 other addresses, both the domain and the local part should be included.
18272 Usually, remote routing is of the former kind, and local routing is of the
18273 latter kind.
18274
18275 This option controls whether the local part is used to form the key for retry
18276 hints for addresses that suffer temporary errors while being handled by this
18277 router. The default value is true for any router that has &%check_local_user%&
18278 set, and false otherwise. Note that this option does not apply to hints keys
18279 for transport delays; they are controlled by a generic transport option of the
18280 same name.
18281
18282 The setting of &%retry_use_local_part%& applies only to the router on which it
18283 appears. If the router generates child addresses, they are routed
18284 independently; this setting does not become attached to them.
18285
18286
18287
18288 .option router_home_directory routers string&!! unset
18289 .cindex "router" "home directory for"
18290 .cindex "home directory" "for router"
18291 .vindex "&$home$&"
18292 This option sets a home directory for use while the router is running. (Compare
18293 &%transport_home_directory%&, which sets a home directory for later
18294 transporting.) In particular, if used on a &(redirect)& router, this option
18295 sets a value for &$home$& while a filter is running. The value is expanded;
18296 forced expansion failure causes the option to be ignored &-- other failures
18297 cause the router to defer.
18298
18299 Expansion of &%router_home_directory%& happens immediately after the
18300 &%check_local_user%& test (if configured), before any further expansions take
18301 place.
18302 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18303 are evaluated.)
18304 While the router is running, &%router_home_directory%& overrides the value of
18305 &$home$& that came from &%check_local_user%&.
18306
18307 When a router accepts an address and assigns it to a local transport (including
18308 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18309 delivery), the home directory setting for the transport is taken from the first
18310 of these values that is set:
18311
18312 .ilist
18313 The &%home_directory%& option on the transport;
18314 .next
18315 The &%transport_home_directory%& option on the router;
18316 .next
18317 The password data if &%check_local_user%& is set on the router;
18318 .next
18319 The &%router_home_directory%& option on the router.
18320 .endlist
18321
18322 In other words, &%router_home_directory%& overrides the password data for the
18323 router, but not for the transport.
18324
18325
18326
18327 .option self routers string freeze
18328 .cindex "MX record" "pointing to local host"
18329 .cindex "local host" "MX pointing to"
18330 This option applies to those routers that use a recipient address to find a
18331 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18332 and &(manualroute)& routers.
18333 Certain configurations of the &(queryprogram)& router can also specify a list
18334 of remote hosts.
18335 Usually such routers are configured to send the message to a remote host via an
18336 &(smtp)& transport. The &%self%& option specifies what happens when the first
18337 host on the list turns out to be the local host.
18338 The way in which Exim checks for the local host is described in section
18339 &<<SECTreclocipadd>>&.
18340
18341 Normally this situation indicates either an error in Exim's configuration (for
18342 example, the router should be configured not to process this domain), or an
18343 error in the DNS (for example, the MX should not point to this host). For this
18344 reason, the default action is to log the incident, defer the address, and
18345 freeze the message. The following alternatives are provided for use in special
18346 cases:
18347
18348 .vlist
18349 .vitem &%defer%&
18350 Delivery of the message is tried again later, but the message is not frozen.
18351
18352 .vitem "&%reroute%&: <&'domain'&>"
18353 The domain is changed to the given domain, and the address is passed back to
18354 be reprocessed by the routers. No rewriting of headers takes place. This
18355 behaviour is essentially a redirection.
18356
18357 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18358 The domain is changed to the given domain, and the address is passed back to be
18359 reprocessed by the routers. Any headers that contain the original domain are
18360 rewritten.
18361
18362 .vitem &%pass%&
18363 .oindex "&%more%&"
18364 .vindex "&$self_hostname$&"
18365 The router passes the address to the next router, or to the router named in the
18366 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18367 subsequent routing and delivery, the variable &$self_hostname$& contains the
18368 name of the local host that the router encountered. This can be used to
18369 distinguish between different cases for hosts with multiple names. The
18370 combination
18371 .code
18372 self = pass
18373 no_more
18374 .endd
18375 ensures that only those addresses that routed to the local host are passed on.
18376 Without &%no_more%&, addresses that were declined for other reasons would also
18377 be passed to the next router.
18378
18379 .vitem &%fail%&
18380 Delivery fails and an error report is generated.
18381
18382 .vitem &%send%&
18383 .cindex "local host" "sending to"
18384 The anomaly is ignored and the address is queued for the transport. This
18385 setting should be used with extreme caution. For an &(smtp)& transport, it
18386 makes sense only in cases where the program that is listening on the SMTP port
18387 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18388 different configuration file that handles the domain in another way.
18389 .endlist
18390
18391
18392
18393 .option senders routers&!? "address list&!!" unset
18394 .cindex "router" "checking senders"
18395 If this option is set, the router is skipped unless the message's sender
18396 address matches something on the list.
18397 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18398 are evaluated.
18399
18400 There are issues concerning verification when the running of routers is
18401 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18402 setting, it sets the sender to the null string. When using the &%-bt%& option
18403 to check a configuration file, it is necessary also to use the &%-f%& option to
18404 set an appropriate sender. For incoming mail, the sender is unset when
18405 verifying the sender, but is available when verifying any recipients. If the
18406 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18407 matters.
18408
18409
18410 .option translate_ip_address routers string&!! unset
18411 .cindex "IP address" "translating"
18412 .cindex "packet radio"
18413 .cindex "router" "IP address translation"
18414 There exist some rare networking situations (for example, packet radio) where
18415 it is helpful to be able to translate IP addresses generated by normal routing
18416 mechanisms into other IP addresses, thus performing a kind of manual IP
18417 routing. This should be done only if the normal IP routing of the TCP/IP stack
18418 is inadequate or broken. Because this is an extremely uncommon requirement, the
18419 code to support this option is not included in the Exim binary unless
18420 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18421
18422 .vindex "&$host_address$&"
18423 The &%translate_ip_address%& string is expanded for every IP address generated
18424 by the router, with the generated address set in &$host_address$&. If the
18425 expansion is forced to fail, no action is taken.
18426 For any other expansion error, delivery of the message is deferred.
18427 If the result of the expansion is an IP address, that replaces the original
18428 address; otherwise the result is assumed to be a host name &-- this is looked
18429 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18430 produce one or more replacement IP addresses. For example, to subvert all IP
18431 addresses in some specific networks, this could be added to a router:
18432 .code
18433 translate_ip_address = \
18434   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18435     {$value}fail}}
18436 .endd
18437 The file would contain lines like
18438 .code
18439 10.2.3.128/26    some.host
18440 10.8.4.34/26     10.44.8.15
18441 .endd
18442 You should not make use of this facility unless you really understand what you
18443 are doing.
18444
18445
18446
18447 .option transport routers string&!! unset
18448 This option specifies the transport to be used when a router accepts an address
18449 and sets it up for delivery. A transport is never needed if a router is used
18450 only for verification. The value of the option is expanded at routing time,
18451 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18452 and result must be the name of one of the configured transports. If it is not,
18453 delivery is deferred.
18454
18455 The &%transport%& option is not used by the &(redirect)& router, but it does
18456 have some private options that set up transports for pipe and file deliveries
18457 (see chapter &<<CHAPredirect>>&).
18458
18459
18460
18461 .option transport_current_directory routers string&!! unset
18462 .cindex "current directory for local transport"
18463 This option associates a current directory with any address that is routed
18464 to a local transport. This can happen either because a transport is
18465 explicitly configured for the router, or because it generates a delivery to a
18466 file or a pipe. During the delivery process (that is, at transport time), this
18467 option string is expanded and is set as the current directory, unless
18468 overridden by a setting on the transport.
18469 If the expansion fails for any reason, including forced failure, an error is
18470 logged, and delivery is deferred.
18471 See chapter &<<CHAPenvironment>>& for details of the local delivery
18472 environment.
18473
18474
18475
18476
18477 .option transport_home_directory routers string&!! "see below"
18478 .cindex "home directory" "for local transport"
18479 This option associates a home directory with any address that is routed to a
18480 local transport. This can happen either because a transport is explicitly
18481 configured for the router, or because it generates a delivery to a file or a
18482 pipe. During the delivery process (that is, at transport time), the option
18483 string is expanded and is set as the home directory, unless overridden by a
18484 setting of &%home_directory%& on the transport.
18485 If the expansion fails for any reason, including forced failure, an error is
18486 logged, and delivery is deferred.
18487
18488 If the transport does not specify a home directory, and
18489 &%transport_home_directory%& is not set for the router, the home directory for
18490 the transport is taken from the password data if &%check_local_user%& is set for
18491 the router. Otherwise it is taken from &%router_home_directory%& if that option
18492 is set; if not, no home directory is set for the transport.
18493
18494 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18495 environment.
18496
18497
18498
18499
18500 .option unseen routers boolean&!! false
18501 .cindex "router" "carrying on after success"
18502 The result of string expansion for this option must be a valid boolean value,
18503 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18504 result causes an error, and delivery is deferred. If the expansion is forced to
18505 fail, the default value for the option (false) is used. Other failures cause
18506 delivery to be deferred.
18507
18508 When this option is set true, routing does not cease if the router accepts the
18509 address. Instead, a copy of the incoming address is passed to the next router,
18510 overriding a false setting of &%more%&. There is little point in setting
18511 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18512 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18513 sometimes true and sometimes false).
18514
18515 .cindex "copy of message (&%unseen%& option)"
18516 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18517 qualifier in filter files. It can be used to cause copies of messages to be
18518 delivered to some other destination, while also carrying out a normal delivery.
18519 In effect, the current address is made into a &"parent"& that has two children
18520 &-- one that is delivered as specified by this router, and a clone that goes on
18521 to be routed further. For this reason, &%unseen%& may not be combined with the
18522 &%one_time%& option in a &(redirect)& router.
18523
18524 &*Warning*&: Header lines added to the address (or specified for removal) by
18525 this router or by previous routers affect the &"unseen"& copy of the message
18526 only. The clone that continues to be processed by further routers starts with
18527 no added headers and none specified for removal. For a &%redirect%& router, if
18528 a generated address is the same as the incoming address, this can lead to
18529 duplicate addresses with different header modifications. Exim does not do
18530 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18531 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18532 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18533 &%redirect%& router may be of help.
18534
18535 Unlike the handling of header modifications, any data that was set by the
18536 &%address_data%& option in the current or previous routers &'is'& passed on to
18537 subsequent routers.
18538
18539
18540 .option user routers string&!! "see below"
18541 .cindex "uid (user id)" "local delivery"
18542 .cindex "local transports" "uid and gid"
18543 .cindex "transport" "local"
18544 .cindex "router" "user for filter processing"
18545 .cindex "filter" "user for processing"
18546 When a router queues an address for a transport, and the transport does not
18547 specify a user, the user given here is used when running the delivery process.
18548 The user may be specified numerically or by name. If expansion fails, the
18549 error is logged and delivery is deferred.
18550 This user is also used by the &(redirect)& router when running a filter file.
18551 The default is unset, except when &%check_local_user%& is set. In this case,
18552 the default is taken from the password information. If the user is specified as
18553 a name, and &%group%& is not set, the group associated with the user is used.
18554 See also &%initgroups%& and &%group%& and the discussion in chapter
18555 &<<CHAPenvironment>>&.
18556
18557
18558
18559 .option verify routers&!? boolean true
18560 Setting this option has the effect of setting &%verify_sender%& and
18561 &%verify_recipient%& to the same value.
18562
18563
18564 .option verify_only routers&!? boolean false
18565 .cindex "EXPN" "with &%verify_only%&"
18566 .oindex "&%-bv%&"
18567 .cindex "router" "used only when verifying"
18568 If this option is set, the router is used only when verifying an address,
18569 delivering in cutthrough mode or
18570 testing with the &%-bv%& option, not when actually doing a delivery, testing
18571 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18572 restricted to verifying only senders or recipients by means of
18573 &%verify_sender%& and &%verify_recipient%&.
18574
18575 &*Warning*&: When the router is being run to verify addresses for an incoming
18576 SMTP message, Exim is not running as root, but under its own uid. If the router
18577 accesses any files, you need to make sure that they are accessible to the Exim
18578 user or group.
18579
18580
18581 .option verify_recipient routers&!? boolean true
18582 If this option is false, the router is skipped when verifying recipient
18583 addresses,
18584 delivering in cutthrough mode
18585 or testing recipient verification using &%-bv%&.
18586 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18587 are evaluated.
18588 See also the &$verify_mode$& variable.
18589
18590
18591 .option verify_sender routers&!? boolean true
18592 If this option is false, the router is skipped when verifying sender addresses
18593 or testing sender verification using &%-bvs%&.
18594 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18595 are evaluated.
18596 See also the &$verify_mode$& variable.
18597 .ecindex IIDgenoprou1
18598 .ecindex IIDgenoprou2
18599
18600
18601
18602
18603
18604
18605 . ////////////////////////////////////////////////////////////////////////////
18606 . ////////////////////////////////////////////////////////////////////////////
18607
18608 .chapter "The accept router" "CHID4"
18609 .cindex "&(accept)& router"
18610 .cindex "routers" "&(accept)&"
18611 The &(accept)& router has no private options of its own. Unless it is being
18612 used purely for verification (see &%verify_only%&) a transport is required to
18613 be defined by the generic &%transport%& option. If the preconditions that are
18614 specified by generic options are met, the router accepts the address and queues
18615 it for the given transport. The most common use of this router is for setting
18616 up deliveries to local mailboxes. For example:
18617 .code
18618 localusers:
18619   driver = accept
18620   domains = mydomain.example
18621   check_local_user
18622   transport = local_delivery
18623 .endd
18624 The &%domains%& condition in this example checks the domain of the address, and
18625 &%check_local_user%& checks that the local part is the login of a local user.
18626 When both preconditions are met, the &(accept)& router runs, and queues the
18627 address for the &(local_delivery)& transport.
18628
18629
18630
18631
18632
18633
18634 . ////////////////////////////////////////////////////////////////////////////
18635 . ////////////////////////////////////////////////////////////////////////////
18636
18637 .chapter "The dnslookup router" "CHAPdnslookup"
18638 .scindex IIDdnsrou1 "&(dnslookup)& router"
18639 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18640 The &(dnslookup)& router looks up the hosts that handle mail for the
18641 recipient's domain in the DNS. A transport must always be set for this router,
18642 unless &%verify_only%& is set.
18643
18644 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18645 SRV records. If none are found, or if SRV support is not configured,
18646 MX records are looked up. If no MX records exist, address records are sought.
18647 However, &%mx_domains%& can be set to disable the direct use of address
18648 records.
18649
18650 MX records of equal priority are sorted by Exim into a random order. Exim then
18651 looks for address records for the host names obtained from MX or SRV records.
18652 When a host has more than one IP address, they are sorted into a random order,
18653 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18654 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18655 generic option, the router declines.
18656
18657 Unless they have the highest priority (lowest MX value), MX records that point
18658 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18659 are discarded, together with any other MX records of equal or lower priority.
18660
18661 .cindex "MX record" "pointing to local host"
18662 .cindex "local host" "MX pointing to"
18663 .oindex "&%self%&" "in &(dnslookup)& router"
18664 If the host pointed to by the highest priority MX record, or looked up as an
18665 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18666 happens is controlled by the generic &%self%& option.
18667
18668
18669 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18670 There have been problems with DNS servers when SRV records are looked up.
18671 Some misbehaving servers return a DNS error or timeout when a non-existent
18672 SRV record is sought. Similar problems have in the past been reported for
18673 MX records. The global &%dns_again_means_nonexist%& option can help with this
18674 problem, but it is heavy-handed because it is a global option.
18675
18676 For this reason, there are two options, &%srv_fail_domains%& and
18677 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18678 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18679 an attempt to look up an SRV or MX record causes one of these results, and the
18680 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18681 such record"&. In the case of an SRV lookup, this means that the router
18682 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18683 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18684 case routing fails.
18685
18686
18687 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18688 .cindex "&(dnslookup)& router" "declines"
18689 There are a few cases where a &(dnslookup)& router will decline to accept
18690 an address; if such a router is expected to handle "all remaining non-local
18691 domains", then it is important to set &%no_more%&.
18692
18693 The router will defer rather than decline if the domain
18694 is found in the &%fail_defer_domains%& router option.
18695
18696 Reasons for a &(dnslookup)& router to decline currently include:
18697 .ilist
18698 The domain does not exist in DNS
18699 .next
18700 The domain exists but the MX record's host part is just "."; this is a common
18701 convention (borrowed from SRV) used to indicate that there is no such service
18702 for this domain and to not fall back to trying A/AAAA records.
18703 .next
18704 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18705 .next
18706 MX record points to a non-existent host.
18707 .next
18708 MX record points to an IP address and the main section option
18709 &%allow_mx_to_ip%& is not set.
18710 .next
18711 MX records exist and point to valid hosts, but all hosts resolve only to
18712 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18713 .next
18714 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18715 &%dns_check_names_pattern%& for handling one variant of this)
18716 .next
18717 &%check_secondary_mx%& is set on this router but the local host can
18718 not be found in the MX records (see below)
18719 .endlist
18720
18721
18722
18723
18724 .section "Private options for dnslookup" "SECID118"
18725 .cindex "options" "&(dnslookup)& router"
18726 The private options for the &(dnslookup)& router are as follows:
18727
18728 .option check_secondary_mx dnslookup boolean false
18729 .cindex "MX record" "checking for secondary"
18730 If this option is set, the router declines unless the local host is found in
18731 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18732 process domains for which the local host is a secondary mail exchanger
18733 differently to other domains. The way in which Exim decides whether a host is
18734 the local host is described in section &<<SECTreclocipadd>>&.
18735
18736
18737 .option check_srv dnslookup string&!! unset
18738 .cindex "SRV record" "enabling use of"
18739 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18740 addition to MX and address records. The support is disabled by default. To
18741 enable SRV support, set the &%check_srv%& option to the name of the service
18742 required. For example,
18743 .code
18744 check_srv = smtp
18745 .endd
18746 looks for SRV records that refer to the normal smtp service. The option is
18747 expanded, so the service name can vary from message to message or address
18748 to address. This might be helpful if SRV records are being used for a
18749 submission service. If the expansion is forced to fail, the &%check_srv%&
18750 option is ignored, and the router proceeds to look for MX records in the
18751 normal way.
18752
18753 When the expansion succeeds, the router searches first for SRV records for
18754 the given service (it assumes TCP protocol). A single SRV record with a
18755 host name that consists of just a single dot indicates &"no such service for
18756 this domain"&; if this is encountered, the router declines. If other kinds of
18757 SRV record are found, they are used to construct a host list for delivery
18758 according to the rules of RFC 2782. MX records are not sought in this case.
18759
18760 When no SRV records are found, MX records (and address records) are sought in
18761 the traditional way. In other words, SRV records take precedence over MX
18762 records, just as MX records take precedence over address records. Note that
18763 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18764 defined it. It is apparently believed that MX records are sufficient for email
18765 and that SRV records should not be used for this purpose. However, SRV records
18766 have an additional &"weight"& feature which some people might find useful when
18767 trying to split an SMTP load between hosts of different power.
18768
18769 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18770 when there is a DNS lookup error.
18771
18772
18773
18774
18775 .option fail_defer_domains dnslookup "domain list&!!" unset
18776 .cindex "MX record" "not found"
18777 DNS lookups for domains matching &%fail_defer_domains%&
18778 which find no matching record will cause the router to defer
18779 rather than the default behaviour of decline.
18780 This maybe be useful for queueing messages for a newly created
18781 domain while the DNS configuration is not ready.
18782 However, it will result in any message with mistyped domains
18783 also being queued.
18784
18785
18786 .option mx_domains dnslookup "domain list&!!" unset
18787 .cindex "MX record" "required to exist"
18788 .cindex "SRV record" "required to exist"
18789 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18790 record in order to be recognized. (The name of this option could be improved.)
18791 For example, if all the mail hosts in &'fict.example'& are known to have MX
18792 records, except for those in &'discworld.fict.example'&, you could use this
18793 setting:
18794 .code
18795 mx_domains = ! *.discworld.fict.example : *.fict.example
18796 .endd
18797 This specifies that messages addressed to a domain that matches the list but
18798 has no MX record should be bounced immediately instead of being routed using
18799 the address record.
18800
18801
18802 .option mx_fail_domains dnslookup "domain list&!!" unset
18803 If the DNS lookup for MX records for one of the domains in this list causes a
18804 DNS lookup error, Exim behaves as if no MX records were found. See section
18805 &<<SECTprowitdnsloo>>& for more discussion.
18806
18807
18808
18809
18810 .option qualify_single dnslookup boolean true
18811 .cindex "DNS" "resolver options"
18812 .cindex "DNS" "qualifying single-component names"
18813 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18814 lookups. Typically, but not standardly, this causes the resolver to qualify
18815 single-component names with the default domain. For example, on a machine
18816 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18817 &'thesaurus.ref.example'& inside the resolver. For details of what your
18818 resolver actually does, consult your man pages for &'resolver'& and
18819 &'resolv.conf'&.
18820
18821
18822
18823 .option rewrite_headers dnslookup boolean true
18824 .cindex "rewriting" "header lines"
18825 .cindex "header lines" "rewriting"
18826 If the domain name in the address that is being processed is not fully
18827 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18828 an address is specified as &'dormouse@teaparty'&, the domain might be
18829 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18830 occur as a result of setting the &%widen_domains%& option. If
18831 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18832 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18833 header lines of the message are rewritten with the full domain name.
18834
18835 This option should be turned off only when it is known that no message is
18836 ever going to be sent outside an environment where the abbreviation makes
18837 sense.
18838
18839 When an MX record is looked up in the DNS and matches a wildcard record, name
18840 servers normally return a record containing the name that has been looked up,
18841 making it impossible to detect whether a wildcard was present or not. However,
18842 some name servers have recently been seen to return the wildcard entry. If the
18843 name returned by a DNS lookup begins with an asterisk, it is not used for
18844 header rewriting.
18845
18846
18847 .option same_domain_copy_routing dnslookup boolean false
18848 .cindex "address" "copying routing"
18849 Addresses with the same domain are normally routed by the &(dnslookup)& router
18850 to the same list of hosts. However, this cannot be presumed, because the router
18851 options and preconditions may refer to the local part of the address. By
18852 default, therefore, Exim routes each address in a message independently. DNS
18853 servers run caches, so repeated DNS lookups are not normally expensive, and in
18854 any case, personal messages rarely have more than a few recipients.
18855
18856 If you are running mailing lists with large numbers of subscribers at the same
18857 domain, and you are using a &(dnslookup)& router which is independent of the
18858 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18859 lookups for identical domains in one message. In this case, when &(dnslookup)&
18860 routes an address to a remote transport, any other unrouted addresses in the
18861 message that have the same domain are automatically given the same routing
18862 without processing them independently,
18863 provided the following conditions are met:
18864
18865 .ilist
18866 No router that processed the address specified &%headers_add%& or
18867 &%headers_remove%&.
18868 .next
18869 The router did not change the address in any way, for example, by &"widening"&
18870 the domain.
18871 .endlist
18872
18873
18874
18875
18876 .option search_parents dnslookup boolean false
18877 .cindex "DNS" "resolver options"
18878 When this option is true, the resolver option RES_DNSRCH is set for DNS
18879 lookups. This is different from the &%qualify_single%& option in that it
18880 applies to domains containing dots. Typically, but not standardly, it causes
18881 the resolver to search for the name in the current domain and in parent
18882 domains. For example, on a machine in the &'fict.example'& domain, if looking
18883 up &'teaparty.wonderland'& failed, the resolver would try
18884 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18885 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18886
18887 Setting this option true can cause problems in domains that have a wildcard MX
18888 record, because any domain that does not have its own MX record matches the
18889 local wildcard.
18890
18891
18892
18893 .option srv_fail_domains dnslookup "domain list&!!" unset
18894 If the DNS lookup for SRV records for one of the domains in this list causes a
18895 DNS lookup error, Exim behaves as if no SRV records were found. See section
18896 &<<SECTprowitdnsloo>>& for more discussion.
18897
18898
18899
18900
18901 .option widen_domains dnslookup "string list" unset
18902 .cindex "domain" "partial; widening"
18903 If a DNS lookup fails and this option is set, each of its strings in turn is
18904 added onto the end of the domain, and the lookup is tried again. For example,
18905 if
18906 .code
18907 widen_domains = fict.example:ref.example
18908 .endd
18909 is set and a lookup of &'klingon.dictionary'& fails,
18910 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18911 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18912 and &%search_parents%& options can cause some widening to be undertaken inside
18913 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18914 when verifying, unless &%rewrite_headers%& is false (not the default).
18915
18916
18917 .section "Effect of qualify_single and search_parents" "SECID119"
18918 When a domain from an envelope recipient is changed by the resolver as a result
18919 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18920 corresponding address in the message's header lines unless &%rewrite_headers%&
18921 is set false. Exim then re-routes the address, using the full domain.
18922
18923 These two options affect only the DNS lookup that takes place inside the router
18924 for the domain of the address that is being routed. They do not affect lookups
18925 such as that implied by
18926 .code
18927 domains = @mx_any
18928 .endd
18929 that may happen while processing a router precondition before the router is
18930 entered. No widening ever takes place for these lookups.
18931 .ecindex IIDdnsrou1
18932 .ecindex IIDdnsrou2
18933
18934
18935
18936
18937
18938
18939
18940
18941
18942 . ////////////////////////////////////////////////////////////////////////////
18943 . ////////////////////////////////////////////////////////////////////////////
18944
18945 .chapter "The ipliteral router" "CHID5"
18946 .cindex "&(ipliteral)& router"
18947 .cindex "domain literal" "routing"
18948 .cindex "routers" "&(ipliteral)&"
18949 This router has no private options. Unless it is being used purely for
18950 verification (see &%verify_only%&) a transport is required to be defined by the
18951 generic &%transport%& option. The router accepts the address if its domain part
18952 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18953 router handles the address
18954 .code
18955 root@[192.168.1.1]
18956 .endd
18957 by setting up delivery to the host with that IP address. IPv4 domain literals
18958 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18959 are similar, but the address is preceded by &`ipv6:`&. For example:
18960 .code
18961 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18962 .endd
18963 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18964 grounds that sooner or later somebody will try it.
18965
18966 .oindex "&%self%&" "in &(ipliteral)& router"
18967 If the IP address matches something in &%ignore_target_hosts%&, the router
18968 declines. If an IP literal turns out to refer to the local host, the generic
18969 &%self%& option determines what happens.
18970
18971 The RFCs require support for domain literals; however, their use is
18972 controversial in today's Internet. If you want to use this router, you must
18973 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18974 Exim will not recognize the domain literal syntax in addresses.
18975
18976
18977
18978 . ////////////////////////////////////////////////////////////////////////////
18979 . ////////////////////////////////////////////////////////////////////////////
18980
18981 .chapter "The iplookup router" "CHID6"
18982 .cindex "&(iplookup)& router"
18983 .cindex "routers" "&(iplookup)&"
18984 The &(iplookup)& router was written to fulfil a specific requirement in
18985 Cambridge University (which in fact no longer exists). For this reason, it is
18986 not included in the binary of Exim by default. If you want to include it, you
18987 must set
18988 .code
18989 ROUTER_IPLOOKUP=yes
18990 .endd
18991 in your &_Local/Makefile_& configuration file.
18992
18993 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18994 connection to one or more specific hosts. The host can then return the same or
18995 a different address &-- in effect rewriting the recipient address in the
18996 message's envelope. The new address is then passed on to subsequent routers. If
18997 this process fails, the address can be passed on to other routers, or delivery
18998 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18999 must not be specified for it.
19000
19001 .cindex "options" "&(iplookup)& router"
19002 .option hosts iplookup string unset
19003 This option must be supplied. Its value is a colon-separated list of host
19004 names. The hosts are looked up using &[gethostbyname()]&
19005 (or &[getipnodebyname()]& when available)
19006 and are tried in order until one responds to the query. If none respond, what
19007 happens is controlled by &%optional%&.
19008
19009
19010 .option optional iplookup boolean false
19011 If &%optional%& is true, if no response is obtained from any host, the address
19012 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19013 delivery to the address is deferred.
19014
19015
19016 .option port iplookup integer 0
19017 .cindex "port" "&(iplookup)& router"
19018 This option must be supplied. It specifies the port number for the TCP or UDP
19019 call.
19020
19021
19022 .option protocol iplookup string udp
19023 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19024 protocols is to be used.
19025
19026
19027 .option query iplookup string&!! "see below"
19028 This defines the content of the query that is sent to the remote hosts. The
19029 default value is:
19030 .code
19031 $local_part@$domain $local_part@$domain
19032 .endd
19033 The repetition serves as a way of checking that a response is to the correct
19034 query in the default case (see &%response_pattern%& below).
19035
19036
19037 .option reroute iplookup string&!! unset
19038 If this option is not set, the rerouted address is precisely the byte string
19039 returned by the remote host, up to the first white space, if any. If set, the
19040 string is expanded to form the rerouted address. It can include parts matched
19041 in the response by &%response_pattern%& by means of numeric variables such as
19042 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19043 whether or not a pattern is in use. In all cases, the rerouted address must end
19044 up in the form &'local_part@domain'&.
19045
19046
19047 .option response_pattern iplookup string unset
19048 This option can be set to a regular expression that is applied to the string
19049 returned from the remote host. If the pattern does not match the response, the
19050 router declines. If &%response_pattern%& is not set, no checking of the
19051 response is done, unless the query was defaulted, in which case there is a
19052 check that the text returned after the first white space is the original
19053 address. This checks that the answer that has been received is in response to
19054 the correct question. For example, if the response is just a new domain, the
19055 following could be used:
19056 .code
19057 response_pattern = ^([^@]+)$
19058 reroute = $local_part@$1
19059 .endd
19060
19061 .option timeout iplookup time 5s
19062 This specifies the amount of time to wait for a response from the remote
19063 machine. The same timeout is used for the &[connect()]& function for a TCP
19064 call. It does not apply to UDP.
19065
19066
19067
19068
19069 . ////////////////////////////////////////////////////////////////////////////
19070 . ////////////////////////////////////////////////////////////////////////////
19071
19072 .chapter "The manualroute router" "CHID7"
19073 .scindex IIDmanrou1 "&(manualroute)& router"
19074 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19075 .cindex "domain" "manually routing"
19076 The &(manualroute)& router is so-called because it provides a way of manually
19077 routing an address according to its domain. It is mainly used when you want to
19078 route addresses to remote hosts according to your own rules, bypassing the
19079 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19080 route to local transports, a facility that may be useful if you want to save
19081 messages for dial-in hosts in local files.
19082
19083 The &(manualroute)& router compares a list of domain patterns with the domain
19084 it is trying to route. If there is no match, the router declines. Each pattern
19085 has associated with it a list of hosts and some other optional data, which may
19086 include a transport. The combination of a pattern and its data is called a
19087 &"routing rule"&. For patterns that do not have an associated transport, the
19088 generic &%transport%& option must specify a transport, unless the router is
19089 being used purely for verification (see &%verify_only%&).
19090
19091 .vindex "&$host$&"
19092 In the case of verification, matching the domain pattern is sufficient for the
19093 router to accept the address. When actually routing an address for delivery,
19094 an address that matches a domain pattern is queued for the associated
19095 transport. If the transport is not a local one, a host list must be associated
19096 with the pattern; IP addresses are looked up for the hosts, and these are
19097 passed to the transport along with the mail address. For local transports, a
19098 host list is optional. If it is present, it is passed in &$host$& as a single
19099 text string.
19100
19101 The list of routing rules can be provided as an inline string in
19102 &%route_list%&, or the data can be obtained by looking up the domain in a file
19103 or database by setting &%route_data%&. Only one of these settings may appear in
19104 any one instance of &(manualroute)&. The format of routing rules is described
19105 below, following the list of private options.
19106
19107
19108 .section "Private options for manualroute" "SECTprioptman"
19109
19110 .cindex "options" "&(manualroute)& router"
19111 The private options for the &(manualroute)& router are as follows:
19112
19113 .option host_all_ignored manualroute string defer
19114 See &%host_find_failed%&.
19115
19116 .option host_find_failed manualroute string freeze
19117 This option controls what happens when &(manualroute)& tries to find an IP
19118 address for a host, and the host does not exist. The option can be set to one
19119 of the following values:
19120 .code
19121 decline
19122 defer
19123 fail
19124 freeze
19125 ignore
19126 pass
19127 .endd
19128 The default (&"freeze"&) assumes that this state is a serious configuration
19129 error. The difference between &"pass"& and &"decline"& is that the former
19130 forces the address to be passed to the next router (or the router defined by
19131 &%pass_router%&),
19132 .oindex "&%more%&"
19133 overriding &%no_more%&, whereas the latter passes the address to the next
19134 router only if &%more%& is true.
19135
19136 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19137 cannot be found. If all the hosts in the list are ignored, the behaviour is
19138 controlled by the &%host_all_ignored%& option. This takes the same values
19139 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19140
19141 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19142 state; if a host lookup gets a temporary error, delivery is deferred unless the
19143 generic &%pass_on_timeout%& option is set.
19144
19145
19146 .option hosts_randomize manualroute boolean false
19147 .cindex "randomized host list"
19148 .cindex "host" "list of; randomized"
19149 If this option is set, the order of the items in a host list in a routing rule
19150 is randomized each time the list is used, unless an option in the routing rule
19151 overrides (see below). Randomizing the order of a host list can be used to do
19152 crude load sharing. However, if more than one mail address is routed by the
19153 same router to the same host list, the host lists are considered to be the same
19154 (even though they may be randomized into different orders) for the purpose of
19155 deciding whether to batch the deliveries into a single SMTP transaction.
19156
19157 When &%hosts_randomize%& is true, a host list may be split
19158 into groups whose order is separately randomized. This makes it possible to
19159 set up MX-like behaviour. The boundaries between groups are indicated by an
19160 item that is just &`+`& in the host list. For example:
19161 .code
19162 route_list = * host1:host2:host3:+:host4:host5
19163 .endd
19164 The order of the first three hosts and the order of the last two hosts is
19165 randomized for each use, but the first three always end up before the last two.
19166 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19167 randomized host list is passed to an &(smtp)& transport that also has
19168 &%hosts_randomize set%&, the list is not re-randomized.
19169
19170
19171 .option route_data manualroute string&!! unset
19172 If this option is set, it must expand to yield the data part of a routing rule.
19173 Typically, the expansion string includes a lookup based on the domain. For
19174 example:
19175 .code
19176 route_data = ${lookup{$domain}dbm{/etc/routes}}
19177 .endd
19178 If the expansion is forced to fail, or the result is an empty string, the
19179 router declines. Other kinds of expansion failure cause delivery to be
19180 deferred.
19181
19182
19183 .option route_list manualroute "string list" unset
19184 This string is a list of routing rules, in the form defined below. Note that,
19185 unlike most string lists, the items are separated by semicolons. This is so
19186 that they may contain colon-separated host lists.
19187
19188
19189 .option same_domain_copy_routing manualroute boolean false
19190 .cindex "address" "copying routing"
19191 Addresses with the same domain are normally routed by the &(manualroute)&
19192 router to the same list of hosts. However, this cannot be presumed, because the
19193 router options and preconditions may refer to the local part of the address. By
19194 default, therefore, Exim routes each address in a message independently. DNS
19195 servers run caches, so repeated DNS lookups are not normally expensive, and in
19196 any case, personal messages rarely have more than a few recipients.
19197
19198 If you are running mailing lists with large numbers of subscribers at the same
19199 domain, and you are using a &(manualroute)& router which is independent of the
19200 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19201 lookups for identical domains in one message. In this case, when
19202 &(manualroute)& routes an address to a remote transport, any other unrouted
19203 addresses in the message that have the same domain are automatically given the
19204 same routing without processing them independently. However, this is only done
19205 if &%headers_add%& and &%headers_remove%& are unset.
19206
19207
19208
19209
19210 .section "Routing rules in route_list" "SECID120"
19211 The value of &%route_list%& is a string consisting of a sequence of routing
19212 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19213 entered as two semicolons. Alternatively, the list separator can be changed as
19214 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19215 Empty rules are ignored. The format of each rule is
19216 .display
19217 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19218 .endd
19219 The following example contains two rules, each with a simple domain pattern and
19220 no options:
19221 .code
19222 route_list = \
19223   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19224   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19225 .endd
19226 The three parts of a rule are separated by white space. The pattern and the
19227 list of hosts can be enclosed in quotes if necessary, and if they are, the
19228 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19229 single domain pattern, which is the only mandatory item in the rule. The
19230 pattern is in the same format as one item in a domain list (see section
19231 &<<SECTdomainlist>>&),
19232 except that it may not be the name of an interpolated file.
19233 That is, it may be wildcarded, or a regular expression, or a file or database
19234 lookup (with semicolons doubled, because of the use of semicolon as a separator
19235 in a &%route_list%&).
19236
19237 The rules in &%route_list%& are searched in order until one of the patterns
19238 matches the domain that is being routed. The list of hosts and then options are
19239 then used as described below. If there is no match, the router declines. When
19240 &%route_list%& is set, &%route_data%& must not be set.
19241
19242
19243
19244 .section "Routing rules in route_data" "SECID121"
19245 The use of &%route_list%& is convenient when there are only a small number of
19246 routing rules. For larger numbers, it is easier to use a file or database to
19247 hold the routing information, and use the &%route_data%& option instead.
19248 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19249 Most commonly, &%route_data%& is set as a string that contains an
19250 expansion lookup. For example, suppose we place two routing rules in a file
19251 like this:
19252 .code
19253 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19254 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19255 .endd
19256 This data can be accessed by setting
19257 .code
19258 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19259 .endd
19260 Failure of the lookup results in an empty string, causing the router to
19261 decline. However, you do not have to use a lookup in &%route_data%&. The only
19262 requirement is that the result of expanding the string is a list of hosts,
19263 possibly followed by options, separated by white space. The list of hosts must
19264 be enclosed in quotes if it contains white space.
19265
19266
19267
19268
19269 .section "Format of the list of hosts" "SECID122"
19270 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19271 always separately expanded before use. If the expansion fails, the router
19272 declines. The result of the expansion must be a colon-separated list of names
19273 and/or IP addresses, optionally also including ports. The format of each item
19274 in the list is described in the next section. The list separator can be changed
19275 as described in section &<<SECTlistconstruct>>&.
19276
19277 If the list of hosts was obtained from a &%route_list%& item, the following
19278 variables are set during its expansion:
19279
19280 .ilist
19281 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19282 If the domain was matched against a regular expression, the numeric variables
19283 &$1$&, &$2$&, etc. may be set. For example:
19284 .code
19285 route_list = ^domain(\d+)   host-$1.text.example
19286 .endd
19287 .next
19288 &$0$& is always set to the entire domain.
19289 .next
19290 &$1$& is also set when partial matching is done in a file lookup.
19291
19292 .next
19293 .vindex "&$value$&"
19294 If the pattern that matched the domain was a lookup item, the data that was
19295 looked up is available in the expansion variable &$value$&. For example:
19296 .code
19297 route_list = lsearch;;/some/file.routes  $value
19298 .endd
19299 .endlist
19300
19301 Note the doubling of the semicolon in the pattern that is necessary because
19302 semicolon is the default route list separator.
19303
19304
19305
19306 .section "Format of one host item" "SECTformatonehostitem"
19307 Each item in the list of hosts is either a host name or an IP address,
19308 optionally with an attached port number. When no port is given, an IP address
19309 is not enclosed in brackets. When a port is specified, it overrides the port
19310 specification on the transport. The port is separated from the name or address
19311 by a colon. This leads to some complications:
19312
19313 .ilist
19314 Because colon is the default separator for the list of hosts, either
19315 the colon that specifies a port must be doubled, or the list separator must
19316 be changed. The following two examples have the same effect:
19317 .code
19318 route_list = * "host1.tld::1225 : host2.tld::1226"
19319 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19320 .endd
19321 .next
19322 When IPv6 addresses are involved, it gets worse, because they contain
19323 colons of their own. To make this case easier, it is permitted to
19324 enclose an IP address (either v4 or v6) in square brackets if a port
19325 number follows. For example:
19326 .code
19327 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19328 .endd
19329 .endlist
19330
19331 .section "How the list of hosts is used" "SECThostshowused"
19332 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19333 the hosts is tried, in the order specified, when carrying out the SMTP
19334 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19335 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19336 transport.
19337
19338 Hosts may be listed by name or by IP address. An unadorned name in the list of
19339 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19340 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19341 records in the DNS. For example:
19342 .code
19343 route_list = *  x.y.z:p.q.r/MX:e.f.g
19344 .endd
19345 If this feature is used with a port specifier, the port must come last. For
19346 example:
19347 .code
19348 route_list = *  dom1.tld/mx::1225
19349 .endd
19350 If the &%hosts_randomize%& option is set, the order of the items in the list is
19351 randomized before any lookups are done. Exim then scans the list; for any name
19352 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19353 be an interface on the local host and the item is not the first in the list,
19354 Exim discards it and any subsequent items. If it is the first item, what
19355 happens is controlled by the
19356 .oindex "&%self%&" "in &(manualroute)& router"
19357 &%self%& option of the router.
19358
19359 A name on the list that is followed by &`/MX`& is replaced with the list of
19360 hosts obtained by looking up MX records for the name. This is always a DNS
19361 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19362 below) are not relevant here. The order of these hosts is determined by the
19363 preference values in the MX records, according to the usual rules. Because
19364 randomizing happens before the MX lookup, it does not affect the order that is
19365 defined by MX preferences.
19366
19367 If the local host is present in the sublist obtained from MX records, but is
19368 not the most preferred host in that list, it and any equally or less
19369 preferred hosts are removed before the sublist is inserted into the main list.
19370
19371 If the local host is the most preferred host in the MX list, what happens
19372 depends on where in the original list of hosts the &`/MX`& item appears. If it
19373 is not the first item (that is, there are previous hosts in the main list),
19374 Exim discards this name and any subsequent items in the main list.
19375
19376 If the MX item is first in the list of hosts, and the local host is the
19377 most preferred host, what happens is controlled by the &%self%& option of the
19378 router.
19379
19380 DNS failures when lookup up the MX records are treated in the same way as DNS
19381 failures when looking up IP addresses: &%pass_on_timeout%& and
19382 &%host_find_failed%& are used when relevant.
19383
19384 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19385 whether obtained from an MX lookup or not.
19386
19387
19388
19389 .section "How the options are used" "SECThowoptused"
19390 The options are a sequence of words; in practice no more than three are ever
19391 present. One of the words can be the name of a transport; this overrides the
19392 &%transport%& option on the router for this particular routing rule only. The
19393 other words (if present) control randomization of the list of hosts on a
19394 per-rule basis, and how the IP addresses of the hosts are to be found when
19395 routing to a remote transport. These options are as follows:
19396
19397 .ilist
19398 &%randomize%&: randomize the order of the hosts in this list, overriding the
19399 setting of &%hosts_randomize%& for this routing rule only.
19400 .next
19401 &%no_randomize%&: do not randomize the order of the hosts in this list,
19402 overriding the setting of &%hosts_randomize%& for this routing rule only.
19403 .next
19404 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19405 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19406 also look in &_/etc/hosts_& or other sources of information.
19407 .next
19408 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19409 no address records are found. If there is a temporary DNS error (such as a
19410 timeout), delivery is deferred.
19411 .endlist
19412
19413 For example:
19414 .code
19415 route_list = domain1  host1:host2:host3  randomize bydns;\
19416              domain2  host4:host5
19417 .endd
19418 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19419 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19420 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19421 or &[gethostbyname()]&, and the result of the lookup is the result of that
19422 call.
19423
19424 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19425 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19426 instead of TRY_AGAIN. That is why the default action is to try a DNS
19427 lookup first. Only if that gives a definite &"no such host"& is the local
19428 function called.
19429
19430
19431
19432 If no IP address for a host can be found, what happens is controlled by the
19433 &%host_find_failed%& option.
19434
19435 .vindex "&$host$&"
19436 When an address is routed to a local transport, IP addresses are not looked up.
19437 The host list is passed to the transport in the &$host$& variable.
19438
19439
19440
19441 .section "Manualroute examples" "SECID123"
19442 In some of the examples that follow, the presence of the &%remote_smtp%&
19443 transport, as defined in the default configuration file, is assumed:
19444
19445 .ilist
19446 .cindex "smart host" "example router"
19447 The &(manualroute)& router can be used to forward all external mail to a
19448 &'smart host'&. If you have set up, in the main part of the configuration, a
19449 named domain list that contains your local domains, for example:
19450 .code
19451 domainlist local_domains = my.domain.example
19452 .endd
19453 You can arrange for all other domains to be routed to a smart host by making
19454 your first router something like this:
19455 .code
19456 smart_route:
19457   driver = manualroute
19458   domains = !+local_domains
19459   transport = remote_smtp
19460   route_list = * smarthost.ref.example
19461 .endd
19462 This causes all non-local addresses to be sent to the single host
19463 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19464 they are tried in order
19465 (but you can use &%hosts_randomize%& to vary the order each time).
19466 Another way of configuring the same thing is this:
19467 .code
19468 smart_route:
19469   driver = manualroute
19470   transport = remote_smtp
19471   route_list = !+local_domains  smarthost.ref.example
19472 .endd
19473 There is no difference in behaviour between these two routers as they stand.
19474 However, they behave differently if &%no_more%& is added to them. In the first
19475 example, the router is skipped if the domain does not match the &%domains%&
19476 precondition; the following router is always tried. If the router runs, it
19477 always matches the domain and so can never decline. Therefore, &%no_more%&
19478 would have no effect. In the second case, the router is never skipped; it
19479 always runs. However, if it doesn't match the domain, it declines. In this case
19480 &%no_more%& would prevent subsequent routers from running.
19481
19482 .next
19483 .cindex "mail hub example"
19484 A &'mail hub'& is a host which receives mail for a number of domains via MX
19485 records in the DNS and delivers it via its own private routing mechanism. Often
19486 the final destinations are behind a firewall, with the mail hub being the one
19487 machine that can connect to machines both inside and outside the firewall. The
19488 &(manualroute)& router is usually used on a mail hub to route incoming messages
19489 to the correct hosts. For a small number of domains, the routing can be inline,
19490 using the &%route_list%& option, but for a larger number a file or database
19491 lookup is easier to manage.
19492
19493 If the domain names are in fact the names of the machines to which the mail is
19494 to be sent by the mail hub, the configuration can be quite simple. For
19495 example:
19496 .code
19497 hub_route:
19498   driver = manualroute
19499   transport = remote_smtp
19500   route_list = *.rhodes.tvs.example  $domain
19501 .endd
19502 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19503 whose names are the same as the mail domains. A similar approach can be taken
19504 if the host name can be obtained from the domain name by a string manipulation
19505 that the expansion facilities can handle. Otherwise, a lookup based on the
19506 domain can be used to find the host:
19507 .code
19508 through_firewall:
19509   driver = manualroute
19510   transport = remote_smtp
19511   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19512 .endd
19513 The result of the lookup must be the name or IP address of the host (or
19514 hosts) to which the address is to be routed. If the lookup fails, the route
19515 data is empty, causing the router to decline. The address then passes to the
19516 next router.
19517
19518 .next
19519 .cindex "batched SMTP output example"
19520 .cindex "SMTP" "batched outgoing; example"
19521 You can use &(manualroute)& to deliver messages to pipes or files in batched
19522 SMTP format for onward transportation by some other means. This is one way of
19523 storing mail for a dial-up host when it is not connected. The route list entry
19524 can be as simple as a single domain name in a configuration like this:
19525 .code
19526 save_in_file:
19527   driver = manualroute
19528   transport = batchsmtp_appendfile
19529   route_list = saved.domain.example
19530 .endd
19531 though often a pattern is used to pick up more than one domain. If there are
19532 several domains or groups of domains with different transport requirements,
19533 different transports can be listed in the routing information:
19534 .code
19535 save_in_file:
19536   driver = manualroute
19537   route_list = \
19538     *.saved.domain1.example  $domain  batch_appendfile; \
19539     *.saved.domain2.example  \
19540       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19541       batch_pipe
19542 .endd
19543 .vindex "&$domain$&"
19544 .vindex "&$host$&"
19545 The first of these just passes the domain in the &$host$& variable, which
19546 doesn't achieve much (since it is also in &$domain$&), but the second does a
19547 file lookup to find a value to pass, causing the router to decline to handle
19548 the address if the lookup fails.
19549
19550 .next
19551 .cindex "UUCP" "example of router for"
19552 Routing mail directly to UUCP software is a specific case of the use of
19553 &(manualroute)& in a gateway to another mail environment. This is an example of
19554 one way it can be done:
19555 .code
19556 # Transport
19557 uucp:
19558   driver = pipe
19559   user = nobody
19560   command = /usr/local/bin/uux -r - \
19561     ${substr_-5:$host}!rmail ${local_part}
19562   return_fail_output = true
19563
19564 # Router
19565 uucphost:
19566   transport = uucp
19567   driver = manualroute
19568   route_data = \
19569     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19570 .endd
19571 The file &_/usr/local/exim/uucphosts_& contains entries like
19572 .code
19573 darksite.ethereal.example:           darksite.UUCP
19574 .endd
19575 It can be set up more simply without adding and removing &".UUCP"& but this way
19576 makes clear the distinction between the domain name
19577 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19578 .endlist
19579 .ecindex IIDmanrou1
19580 .ecindex IIDmanrou2
19581
19582
19583
19584
19585
19586
19587
19588
19589 . ////////////////////////////////////////////////////////////////////////////
19590 . ////////////////////////////////////////////////////////////////////////////
19591
19592 .chapter "The queryprogram router" "CHAPdriverlast"
19593 .scindex IIDquerou1 "&(queryprogram)& router"
19594 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19595 .cindex "routing" "by external program"
19596 The &(queryprogram)& router routes an address by running an external command
19597 and acting on its output. This is an expensive way to route, and is intended
19598 mainly for use in lightly-loaded systems, or for performing experiments.
19599 However, if it is possible to use the precondition options (&%domains%&,
19600 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19601 be used in special cases, even on a busy host. There are the following private
19602 options:
19603 .cindex "options" "&(queryprogram)& router"
19604
19605 .option command queryprogram string&!! unset
19606 This option must be set. It specifies the command that is to be run. The
19607 command is split up into a command name and arguments, and then each is
19608 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19609 &<<CHAPpipetransport>>&).
19610
19611
19612 .option command_group queryprogram string unset
19613 .cindex "gid (group id)" "in &(queryprogram)& router"
19614 This option specifies a gid to be set when running the command while routing an
19615 address for deliver. It must be set if &%command_user%& specifies a numerical
19616 uid. If it begins with a digit, it is interpreted as the numerical value of the
19617 gid. Otherwise it is looked up using &[getgrnam()]&.
19618
19619
19620 .option command_user queryprogram string unset
19621 .cindex "uid (user id)" "for &(queryprogram)&"
19622 This option must be set. It specifies the uid which is set when running the
19623 command while routing an address for delivery. If the value begins with a digit,
19624 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19625 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19626 not set, a value for the gid also.
19627
19628 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19629 root, which it does during a normal delivery in a conventional configuration.
19630 However, when an address is being verified during message reception, Exim is
19631 usually running as the Exim user, not as root. If the &(queryprogram)& router
19632 is called from a non-root process, Exim cannot change uid or gid before running
19633 the command. In this circumstance the command runs under the current uid and
19634 gid.
19635
19636
19637 .option current_directory queryprogram string /
19638 This option specifies an absolute path which is made the current directory
19639 before running the command.
19640
19641
19642 .option timeout queryprogram time 1h
19643 If the command does not complete within the timeout period, its process group
19644 is killed and the message is frozen. A value of zero time specifies no
19645 timeout.
19646
19647
19648 The standard output of the command is connected to a pipe, which is read when
19649 the command terminates. It should consist of a single line of output,
19650 containing up to five fields, separated by white space. The maximum length of
19651 the line is 1023 characters. Longer lines are silently truncated. The first
19652 field is one of the following words (case-insensitive):
19653
19654 .ilist
19655 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19656 below).
19657 .next
19658 &'Decline'&: the router declines; pass the address to the next router, unless
19659 &%no_more%& is set.
19660 .next
19661 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19662 subsequent text on the line is an error message. If the router is run as part
19663 of address verification during an incoming SMTP message, the message is
19664 included in the SMTP response.
19665 .next
19666 &'Defer'&: routing could not be completed at this time; try again later. Any
19667 subsequent text on the line is an error message which is logged. It is not
19668 included in any SMTP response.
19669 .next
19670 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19671 .next
19672 &'Pass'&: pass the address to the next router (or the router specified by
19673 &%pass_router%&), overriding &%no_more%&.
19674 .next
19675 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19676 new addresses, which are routed independently, starting with the first router,
19677 or the router specified by &%redirect_router%&, if set.
19678 .endlist
19679
19680 When the first word is &'accept'&, the remainder of the line consists of a
19681 number of keyed data values, as follows (split into two lines here, to fit on
19682 the page):
19683 .code
19684 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19685 LOOKUP=byname|bydns DATA=<text>
19686 .endd
19687 The data items can be given in any order, and all are optional. If no transport
19688 is included, the transport specified by the generic &%transport%& option is
19689 used. The list of hosts and the lookup type are needed only if the transport is
19690 an &(smtp)& transport that does not itself supply a list of hosts.
19691
19692 The format of the list of hosts is the same as for the &(manualroute)& router.
19693 As well as host names and IP addresses with optional port numbers, as described
19694 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19695 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19696 (see section &<<SECThostshowused>>&).
19697
19698 If the lookup type is not specified, Exim behaves as follows when trying to
19699 find an IP address for each host: First, a DNS lookup is done. If this yields
19700 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19701 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19702 result of the lookup is the result of that call.
19703
19704 .vindex "&$address_data$&"
19705 If the DATA field is set, its value is placed in the &$address_data$&
19706 variable. For example, this return line
19707 .code
19708 accept hosts=x1.y.example:x2.y.example data="rule1"
19709 .endd
19710 routes the address to the default transport, passing a list of two hosts. When
19711 the transport runs, the string &"rule1"& is in &$address_data$&.
19712 .ecindex IIDquerou1
19713 .ecindex IIDquerou2
19714
19715
19716
19717
19718 . ////////////////////////////////////////////////////////////////////////////
19719 . ////////////////////////////////////////////////////////////////////////////
19720
19721 .chapter "The redirect router" "CHAPredirect"
19722 .scindex IIDredrou1 "&(redirect)& router"
19723 .scindex IIDredrou2 "routers" "&(redirect)&"
19724 .cindex "alias file" "in a &(redirect)& router"
19725 .cindex "address redirection" "&(redirect)& router"
19726 The &(redirect)& router handles several kinds of address redirection. Its most
19727 common uses are for resolving local part aliases from a central alias file
19728 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19729 files, but it has many other potential uses. The incoming address can be
19730 redirected in several different ways:
19731
19732 .ilist
19733 It can be replaced by one or more new addresses which are themselves routed
19734 independently.
19735 .next
19736 It can be routed to be delivered to a given file or directory.
19737 .next
19738 It can be routed to be delivered to a specified pipe command.
19739 .next
19740 It can cause an automatic reply to be generated.
19741 .next
19742 It can be forced to fail, optionally with a custom error message.
19743 .next
19744 It can be temporarily deferred, optionally with a custom message.
19745 .next
19746 It can be discarded.
19747 .endlist
19748
19749 The generic &%transport%& option must not be set for &(redirect)& routers.
19750 However, there are some private options which define transports for delivery to
19751 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19752 &%pipe_transport%& and &%reply_transport%& descriptions below.
19753
19754 If success DSNs have been requested
19755 .cindex "DSN" "success"
19756 .cindex "Delivery Status Notification" "success"
19757 redirection triggers one and the DSN options are not passed any further.
19758
19759
19760
19761 .section "Redirection data" "SECID124"
19762 The router operates by interpreting a text string which it obtains either by
19763 expanding the contents of the &%data%& option, or by reading the entire
19764 contents of a file whose name is given in the &%file%& option. These two
19765 options are mutually exclusive. The first is commonly used for handling system
19766 aliases, in a configuration like this:
19767 .code
19768 system_aliases:
19769   driver = redirect
19770   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19771 .endd
19772 If the lookup fails, the expanded string in this example is empty. When the
19773 expansion of &%data%& results in an empty string, the router declines. A forced
19774 expansion failure also causes the router to decline; other expansion failures
19775 cause delivery to be deferred.
19776
19777 A configuration using &%file%& is commonly used for handling users'
19778 &_.forward_& files, like this:
19779 .code
19780 userforward:
19781   driver = redirect
19782   check_local_user
19783   file = $home/.forward
19784   no_verify
19785 .endd
19786 If the file does not exist, or causes no action to be taken (for example, it is
19787 empty or consists only of comments), the router declines. &*Warning*&: This
19788 is not the case when the file contains syntactically valid items that happen to
19789 yield empty addresses, for example, items containing only RFC 2822 address
19790 comments.
19791
19792
19793
19794 .section "Forward files and address verification" "SECID125"
19795 .cindex "address redirection" "while verifying"
19796 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19797 &_.forward_& files, as in the example above. There are two reasons for this:
19798
19799 .ilist
19800 When Exim is receiving an incoming SMTP message from a remote host, it is
19801 running under the Exim uid, not as root. Exim is unable to change uid to read
19802 the file as the user, and it may not be able to read it as the Exim user. So in
19803 practice the router may not be able to operate.
19804 .next
19805 However, even when the router can operate, the existence of a &_.forward_& file
19806 is unimportant when verifying an address. What should be checked is whether the
19807 local part is a valid user name or not. Cutting out the redirection processing
19808 saves some resources.
19809 .endlist
19810
19811
19812
19813
19814
19815
19816 .section "Interpreting redirection data" "SECID126"
19817 .cindex "Sieve filter" "specifying in redirection data"
19818 .cindex "filter" "specifying in redirection data"
19819 The contents of the data string, whether obtained from &%data%& or &%file%&,
19820 can be interpreted in two different ways:
19821
19822 .ilist
19823 If the &%allow_filter%& option is set true, and the data begins with the text
19824 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19825 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19826 respectively. Details of the syntax and semantics of filter files are described
19827 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19828 document is intended for use by end users.
19829 .next
19830 Otherwise, the data must be a comma-separated list of redirection items, as
19831 described in the next section.
19832 .endlist
19833
19834 When a message is redirected to a file (a &"mail folder"&), the file name given
19835 in a non-filter redirection list must always be an absolute path. A filter may
19836 generate a relative path &-- how this is handled depends on the transport's
19837 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19838 for the &(appendfile)& transport.
19839
19840
19841
19842 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19843 .cindex "address redirection" "non-filter list items"
19844 When the redirection data is not an Exim or Sieve filter, for example, if it
19845 comes from a conventional alias or forward file, it consists of a list of
19846 addresses, file names, pipe commands, or certain special items (see section
19847 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19848 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19849 depending on their default values. The items in the list are separated by
19850 commas or newlines.
19851 If a comma is required in an item, the entire item must be enclosed in double
19852 quotes.
19853
19854 Lines starting with a # character are comments, and are ignored, and # may
19855 also appear following a comma, in which case everything between the # and the
19856 next newline character is ignored.
19857
19858 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19859 double quotes are retained because some forms of mail address require their use
19860 (but never to enclose the entire address). In the following description,
19861 &"item"& refers to what remains after any surrounding double quotes have been
19862 removed.
19863
19864 .vindex "&$local_part$&"
19865 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19866 and the expansion contains a reference to &$local_part$&, you should make use
19867 of the &%quote_local_part%& expansion operator, in case the local part contains
19868 special characters. For example, to redirect all mail for the domain
19869 &'obsolete.example'&, retaining the existing local part, you could use this
19870 setting:
19871 .code
19872 data = ${quote_local_part:$local_part}@newdomain.example
19873 .endd
19874
19875
19876 .section "Redirecting to a local mailbox" "SECTredlocmai"
19877 .cindex "routing" "loops in"
19878 .cindex "loop" "while routing, avoidance of"
19879 .cindex "address redirection" "to local mailbox"
19880 A redirection item may safely be the same as the address currently under
19881 consideration. This does not cause a routing loop, because a router is
19882 automatically skipped if any ancestor of the address that is being processed
19883 is the same as the current address and was processed by the current router.
19884 Such an address is therefore passed to the following routers, so it is handled
19885 as if there were no redirection. When making this loop-avoidance test, the
19886 complete local part, including any prefix or suffix, is used.
19887
19888 .cindex "address redirection" "local part without domain"
19889 Specifying the same local part without a domain is a common usage in personal
19890 filter files when the user wants to have messages delivered to the local
19891 mailbox and also forwarded elsewhere. For example, the user whose login is
19892 &'cleo'& might have a &_.forward_& file containing this:
19893 .code
19894 cleo, cleopatra@egypt.example
19895 .endd
19896 .cindex "backslash in alias file"
19897 .cindex "alias file" "backslash in"
19898 For compatibility with other MTAs, such unqualified local parts may be
19899 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19900 it does make a difference if more than one domain is being handled
19901 synonymously.
19902
19903 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19904 2822 address that does not include a domain, the item is qualified using the
19905 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19906 addresses are qualified using the value in &%qualify_recipient%&, but you can
19907 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19908
19909 Care must be taken if there are alias names for local users.
19910 Consider an MTA handling a single local domain where the system alias file
19911 contains:
19912 .code
19913 Sam.Reman: spqr
19914 .endd
19915 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19916 messages in the local mailbox, and also forward copies elsewhere. He creates
19917 this forward file:
19918 .code
19919 Sam.Reman, spqr@reme.elsewhere.example
19920 .endd
19921 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19922 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19923 second time round, because it has previously routed it,
19924 and the following routers presumably cannot handle the alias. The forward file
19925 should really contain
19926 .code
19927 spqr, spqr@reme.elsewhere.example
19928 .endd
19929 but because this is such a common error, the &%check_ancestor%& option (see
19930 below) exists to provide a way to get round it. This is normally set on a
19931 &(redirect)& router that is handling users' &_.forward_& files.
19932
19933
19934
19935 .section "Special items in redirection lists" "SECTspecitredli"
19936 In addition to addresses, the following types of item may appear in redirection
19937 lists (that is, in non-filter redirection data):
19938
19939 .ilist
19940 .cindex "pipe" "in redirection list"
19941 .cindex "address redirection" "to pipe"
19942 An item is treated as a pipe command if it begins with &"|"& and does not parse
19943 as a valid RFC 2822 address that includes a domain. A transport for running the
19944 command must be specified by the &%pipe_transport%& option.
19945 Normally, either the router or the transport specifies a user and a group under
19946 which to run the delivery. The default is to use the Exim user and group.
19947
19948 Single or double quotes can be used for enclosing the individual arguments of
19949 the pipe command; no interpretation of escapes is done for single quotes. If
19950 the command contains a comma character, it is necessary to put the whole item
19951 in double quotes, for example:
19952 .code
19953 "|/some/command ready,steady,go"
19954 .endd
19955 since items in redirection lists are terminated by commas. Do not, however,
19956 quote just the command. An item such as
19957 .code
19958 |"/some/command ready,steady,go"
19959 .endd
19960 is interpreted as a pipe with a rather strange command name, and no arguments.
19961
19962 Note that the above example assumes that the text comes from a lookup source
19963 of some sort, so that the quotes are part of the data.  If composing a
19964 redirect router with a &%data%& option directly specifying this command, the
19965 quotes will be used by the configuration parser to define the extent of one
19966 string, but will not be passed down into the redirect router itself.  There
19967 are two main approaches to get around this: escape quotes to be part of the
19968 data itself, or avoid using this mechanism and instead create a custom
19969 transport with the &%command%& option set and reference that transport from
19970 an &%accept%& router.
19971
19972 .next
19973 .cindex "file" "in redirection list"
19974 .cindex "address redirection" "to file"
19975 An item is interpreted as a path name if it begins with &"/"& and does not
19976 parse as a valid RFC 2822 address that includes a domain. For example,
19977 .code
19978 /home/world/minbari
19979 .endd
19980 is treated as a file name, but
19981 .code
19982 /s=molari/o=babylon/@x400gate.way
19983 .endd
19984 is treated as an address. For a file name, a transport must be specified using
19985 the &%file_transport%& option. However, if the generated path name ends with a
19986 forward slash character, it is interpreted as a directory name rather than a
19987 file name, and &%directory_transport%& is used instead.
19988
19989 Normally, either the router or the transport specifies a user and a group under
19990 which to run the delivery. The default is to use the Exim user and group.
19991
19992 .cindex "&_/dev/null_&"
19993 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19994 bypassed at a high level, and the log entry shows &"**bypassed**"&
19995 instead of a transport name. In this case the user and group are not used.
19996
19997 .next
19998 .cindex "included address list"
19999 .cindex "address redirection" "included external list"
20000 If an item is of the form
20001 .code
20002 :include:<path name>
20003 .endd
20004 a list of further items is taken from the given file and included at that
20005 point. &*Note*&: Such a file can not be a filter file; it is just an
20006 out-of-line addition to the list. The items in the included list are separated
20007 by commas or newlines and are not subject to expansion. If this is the first
20008 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20009 the alias name. This example is incorrect:
20010 .code
20011 list1    :include:/opt/lists/list1
20012 .endd
20013 It must be given as
20014 .code
20015 list1:   :include:/opt/lists/list1
20016 .endd
20017 .next
20018 .cindex "address redirection" "to black hole"
20019 .cindex "delivery" "discard"
20020 .cindex "delivery" "blackhole"
20021 .cindex "black hole"
20022 .cindex "abandoning mail"
20023 Sometimes you want to throw away mail to a particular local part.  Making the
20024 &%data%& option expand to an empty string does not work, because that causes
20025 the router to decline. Instead, the alias item
20026 .code
20027 :blackhole:
20028 .endd
20029 can be used. It does what its name implies. No delivery is
20030 done, and no error message is generated. This has the same effect as specifying
20031 &_/dev/null_& as a destination, but it can be independently disabled.
20032
20033 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20034 delivery is done for the original local part, even if other redirection items
20035 are present. If you are generating a multi-item list (for example, by reading a
20036 database) and need the ability to provide a no-op item, you must use
20037 &_/dev/null_&.
20038
20039 .next
20040 .cindex "delivery" "forcing failure"
20041 .cindex "delivery" "forcing deferral"
20042 .cindex "failing delivery" "forcing"
20043 .cindex "deferred delivery, forcing"
20044 .cindex "customizing" "failure message"
20045 An attempt to deliver a particular address can be deferred or forced to fail by
20046 redirection items of the form
20047 .code
20048 :defer:
20049 :fail:
20050 .endd
20051 respectively. When a redirection list contains such an item, it applies
20052 to the entire redirection; any other items in the list are ignored. Any
20053 text following &':fail:'& or &':defer:'& is placed in the error text
20054 associated with the failure. For example, an alias file might contain:
20055 .code
20056 X.Employee:  :fail: Gone away, no forwarding address
20057 .endd
20058 In the case of an address that is being verified from an ACL or as the subject
20059 of a
20060 .cindex "VRFY" "error text, display of"
20061 VRFY command, the text is included in the SMTP error response by
20062 default.
20063 .cindex "EXPN" "error text, display of"
20064 The text is not included in the response to an EXPN command. In non-SMTP cases
20065 the text is included in the error message that Exim generates.
20066
20067 .cindex "SMTP" "error codes"
20068 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20069 &':fail:'&. However, if the message starts with three digits followed by a
20070 space, optionally followed by an extended code of the form &'n.n.n'&, also
20071 followed by a space, and the very first digit is the same as the default error
20072 code, the code from the message is used instead. If the very first digit is
20073 incorrect, a panic error is logged, and the default code is used. You can
20074 suppress the use of the supplied code in a redirect router by setting the
20075 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20076 ignored.
20077
20078 .vindex "&$acl_verify_message$&"
20079 In an ACL, an explicitly provided message overrides the default, but the
20080 default message is available in the variable &$acl_verify_message$& and can
20081 therefore be included in a custom message if this is desired.
20082
20083 Normally the error text is the rest of the redirection list &-- a comma does
20084 not terminate it &-- but a newline does act as a terminator. Newlines are not
20085 normally present in alias expansions. In &(lsearch)& lookups they are removed
20086 as part of the continuation process, but they may exist in other kinds of
20087 lookup and in &':include:'& files.
20088
20089 During routing for message delivery (as opposed to verification), a redirection
20090 containing &':fail:'& causes an immediate failure of the incoming address,
20091 whereas &':defer:'& causes the message to remain on the queue so that a
20092 subsequent delivery attempt can happen at a later time. If an address is
20093 deferred for too long, it will ultimately fail, because the normal retry
20094 rules still apply.
20095
20096 .next
20097 .cindex "alias file" "exception to default"
20098 Sometimes it is useful to use a single-key search type with a default (see
20099 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20100 for exceptions to the default. These can be handled by aliasing them to
20101 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20102 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20103 results in an empty redirection list has the same effect.
20104 .endlist
20105
20106
20107 .section "Duplicate addresses" "SECTdupaddr"
20108 .cindex "duplicate addresses"
20109 .cindex "address duplicate, discarding"
20110 .cindex "pipe" "duplicated"
20111 Exim removes duplicate addresses from the list to which it is delivering, so as
20112 to deliver just one copy to each address. This does not apply to deliveries
20113 routed to pipes by different immediate parent addresses, but an indirect
20114 aliasing scheme of the type
20115 .code
20116 pipe:       |/some/command $local_part
20117 localpart1: pipe
20118 localpart2: pipe
20119 .endd
20120 does not work with a message that is addressed to both local parts, because
20121 when the second is aliased to the intermediate local part &"pipe"& it gets
20122 discarded as being the same as a previously handled address. However, a scheme
20123 such as
20124 .code
20125 localpart1: |/some/command $local_part
20126 localpart2: |/some/command $local_part
20127 .endd
20128 does result in two different pipe deliveries, because the immediate parents of
20129 the pipes are distinct.
20130
20131
20132
20133 .section "Repeated redirection expansion" "SECID128"
20134 .cindex "repeated redirection expansion"
20135 .cindex "address redirection" "repeated for each delivery attempt"
20136 When a message cannot be delivered to all of its recipients immediately,
20137 leading to two or more delivery attempts, redirection expansion is carried out
20138 afresh each time for those addresses whose children were not all previously
20139 delivered. If redirection is being used as a mailing list, this can lead to new
20140 members of the list receiving copies of old messages. The &%one_time%& option
20141 can be used to avoid this.
20142
20143
20144 .section "Errors in redirection lists" "SECID129"
20145 .cindex "address redirection" "errors"
20146 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20147 error is skipped, and an entry is written to the main log. This may be useful
20148 for mailing lists that are automatically managed. Otherwise, if an error is
20149 detected while generating the list of new addresses, the original address is
20150 deferred. See also &%syntax_errors_to%&.
20151
20152
20153
20154 .section "Private options for the redirect router" "SECID130"
20155
20156 .cindex "options" "&(redirect)& router"
20157 The private options for the &(redirect)& router are as follows:
20158
20159
20160 .option allow_defer redirect boolean false
20161 Setting this option allows the use of &':defer:'& in non-filter redirection
20162 data, or the &%defer%& command in an Exim filter file.
20163
20164
20165 .option allow_fail redirect boolean false
20166 .cindex "failing delivery" "from filter"
20167 If this option is true, the &':fail:'& item can be used in a redirection list,
20168 and the &%fail%& command may be used in an Exim filter file.
20169
20170
20171 .option allow_filter redirect boolean false
20172 .cindex "filter" "enabling use of"
20173 .cindex "Sieve filter" "enabling use of"
20174 Setting this option allows Exim to interpret redirection data that starts with
20175 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20176 are some features of Exim filter files that some administrators may wish to
20177 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20178
20179 It is also possible to lock out Exim filters or Sieve filters while allowing
20180 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20181
20182
20183 The filter is run using the uid and gid set by the generic &%user%& and
20184 &%group%& options. These take their defaults from the password data if
20185 &%check_local_user%& is set, so in the normal case of users' personal filter
20186 files, the filter is run as the relevant user. When &%allow_filter%& is set
20187 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20188
20189
20190
20191 .option allow_freeze redirect boolean false
20192 .cindex "freezing messages" "allowing in filter"
20193 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20194 This command is more normally encountered in system filters, and is disabled by
20195 default for redirection filters because it isn't something you usually want to
20196 let ordinary users do.
20197
20198
20199
20200 .option check_ancestor redirect boolean false
20201 This option is concerned with handling generated addresses that are the same
20202 as some address in the list of redirection ancestors of the current address.
20203 Although it is turned off by default in the code, it is set in the default
20204 configuration file for handling users' &_.forward_& files. It is recommended
20205 for this use of the &(redirect)& router.
20206
20207 When &%check_ancestor%& is set, if a generated address (including the domain)
20208 is the same as any ancestor of the current address, it is replaced by a copy of
20209 the current address. This helps in the case where local part A is aliased to B,
20210 and B has a &_.forward_& file pointing back to A. For example, within a single
20211 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20212 &_&~jb/.forward_& contains:
20213 .code
20214 \Joe.Bloggs, <other item(s)>
20215 .endd
20216 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20217 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20218 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20219 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20220 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20221 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20222 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20223 original address. See also the &%repeat_use%& option below.
20224
20225
20226 .option check_group redirect boolean "see below"
20227 When the &%file%& option is used, the group owner of the file is checked only
20228 when this option is set. The permitted groups are those listed in the
20229 &%owngroups%& option, together with the user's default group if
20230 &%check_local_user%& is set. If the file has the wrong group, routing is
20231 deferred. The default setting for this option is true if &%check_local_user%&
20232 is set and the &%modemask%& option permits the group write bit, or if the
20233 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20234
20235
20236
20237 .option check_owner redirect boolean "see below"
20238 When the &%file%& option is used, the owner of the file is checked only when
20239 this option is set. If &%check_local_user%& is set, the local user is
20240 permitted; otherwise the owner must be one of those listed in the &%owners%&
20241 option. The default value for this option is true if &%check_local_user%& or
20242 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20243
20244
20245 .option data redirect string&!! unset
20246 This option is mutually exclusive with &%file%&. One or other of them must be
20247 set, but not both. The contents of &%data%& are expanded, and then used as the
20248 list of forwarding items, or as a set of filtering instructions. If the
20249 expansion is forced to fail, or the result is an empty string or a string that
20250 has no effect (consists entirely of comments), the router declines.
20251
20252 When filtering instructions are used, the string must begin with &"#Exim
20253 filter"&, and all comments in the string, including this initial one, must be
20254 terminated with newline characters. For example:
20255 .code
20256 data = #Exim filter\n\
20257        if $h_to: contains Exim then save $home/mail/exim endif
20258 .endd
20259 If you are reading the data from a database where newlines cannot be included,
20260 you can use the &${sg}$& expansion item to turn the escape string of your
20261 choice into a newline.
20262
20263
20264 .option directory_transport redirect string&!! unset
20265 A &(redirect)& router sets up a direct delivery to a directory when a path name
20266 ending with a slash is specified as a new &"address"&. The transport used is
20267 specified by this option, which, after expansion, must be the name of a
20268 configured transport. This should normally be an &(appendfile)& transport.
20269
20270
20271 .option file redirect string&!! unset
20272 This option specifies the name of a file that contains the redirection data. It
20273 is mutually exclusive with the &%data%& option. The string is expanded before
20274 use; if the expansion is forced to fail, the router declines. Other expansion
20275 failures cause delivery to be deferred. The result of a successful expansion
20276 must be an absolute path. The entire file is read and used as the redirection
20277 data. If the data is an empty string or a string that has no effect (consists
20278 entirely of comments), the router declines.
20279
20280 .cindex "NFS" "checking for file existence"
20281 If the attempt to open the file fails with a &"does not exist"& error, Exim
20282 runs a check on the containing directory,
20283 unless &%ignore_enotdir%& is true (see below).
20284 If the directory does not appear to exist, delivery is deferred. This can
20285 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20286 is a mount problem. If the containing directory does exist, but the file does
20287 not, the router declines.
20288
20289
20290 .option file_transport redirect string&!! unset
20291 .vindex "&$address_file$&"
20292 A &(redirect)& router sets up a direct delivery to a file when a path name not
20293 ending in a slash is specified as a new &"address"&. The transport used is
20294 specified by this option, which, after expansion, must be the name of a
20295 configured transport. This should normally be an &(appendfile)& transport. When
20296 it is running, the file name is in &$address_file$&.
20297
20298
20299 .option filter_prepend_home redirect boolean true
20300 When this option is true, if a &(save)& command in an Exim filter specifies a
20301 relative path, and &$home$& is defined, it is automatically prepended to the
20302 relative path. If this option is set false, this action does not happen. The
20303 relative path is then passed to the transport unmodified.
20304
20305
20306 .option forbid_blackhole redirect boolean false
20307 If this option is true, the &':blackhole:'& item may not appear in a
20308 redirection list.
20309
20310
20311 .option forbid_exim_filter redirect boolean false
20312 If this option is set true, only Sieve filters are permitted when
20313 &%allow_filter%& is true.
20314
20315
20316
20317
20318 .option forbid_file redirect boolean false
20319 .cindex "delivery" "to file; forbidding"
20320 .cindex "Sieve filter" "forbidding delivery to a file"
20321 .cindex "Sieve filter" "&""keep""& facility; disabling"
20322 If this option is true, this router may not generate a new address that
20323 specifies delivery to a local file or directory, either from a filter or from a
20324 conventional forward file. This option is forced to be true if &%one_time%& is
20325 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20326 locks out the Sieve's &"keep"& facility.
20327
20328
20329 .option forbid_filter_dlfunc redirect boolean false
20330 .cindex "filter" "locking out certain features"
20331 If this option is true, string expansions in Exim filters are not allowed to
20332 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20333 functions.
20334
20335 .option forbid_filter_existstest redirect boolean false
20336 .cindex "expansion" "statting a file"
20337 If this option is true, string expansions in Exim filters are not allowed to
20338 make use of the &%exists%& condition or the &%stat%& expansion item.
20339
20340 .option forbid_filter_logwrite redirect boolean false
20341 If this option is true, use of the logging facility in Exim filters is not
20342 permitted. Logging is in any case available only if the filter is being run
20343 under some unprivileged uid (which is normally the case for ordinary users'
20344 &_.forward_& files).
20345
20346
20347 .option forbid_filter_lookup redirect boolean false
20348 If this option is true, string expansions in Exim filter files are not allowed
20349 to make use of &%lookup%& items.
20350
20351
20352 .option forbid_filter_perl redirect boolean false
20353 This option has an effect only if Exim is built with embedded Perl support. If
20354 it is true, string expansions in Exim filter files are not allowed to make use
20355 of the embedded Perl support.
20356
20357
20358 .option forbid_filter_readfile redirect boolean false
20359 If this option is true, string expansions in Exim filter files are not allowed
20360 to make use of &%readfile%& items.
20361
20362
20363 .option forbid_filter_readsocket redirect boolean false
20364 If this option is true, string expansions in Exim filter files are not allowed
20365 to make use of &%readsocket%& items.
20366
20367
20368 .option forbid_filter_reply redirect boolean false
20369 If this option is true, this router may not generate an automatic reply
20370 message. Automatic replies can be generated only from Exim or Sieve filter
20371 files, not from traditional forward files. This option is forced to be true if
20372 &%one_time%& is set.
20373
20374
20375 .option forbid_filter_run redirect boolean false
20376 If this option is true, string expansions in Exim filter files are not allowed
20377 to make use of &%run%& items.
20378
20379
20380 .option forbid_include redirect boolean false
20381 If this option is true, items of the form
20382 .code
20383 :include:<path name>
20384 .endd
20385 are not permitted in non-filter redirection lists.
20386
20387
20388 .option forbid_pipe redirect boolean false
20389 .cindex "delivery" "to pipe; forbidding"
20390 If this option is true, this router may not generate a new address which
20391 specifies delivery to a pipe, either from an Exim filter or from a conventional
20392 forward file. This option is forced to be true if &%one_time%& is set.
20393
20394
20395 .option forbid_sieve_filter redirect boolean false
20396 If this option is set true, only Exim filters are permitted when
20397 &%allow_filter%& is true.
20398
20399
20400 .cindex "SMTP" "error codes"
20401 .option forbid_smtp_code redirect boolean false
20402 If this option is set true, any SMTP error codes that are present at the start
20403 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20404 the default codes (451 and 550, respectively) are always used.
20405
20406
20407
20408
20409 .option hide_child_in_errmsg redirect boolean false
20410 .cindex "bounce message" "redirection details; suppressing"
20411 If this option is true, it prevents Exim from quoting a child address if it
20412 generates a bounce or delay message for it. Instead it says &"an address
20413 generated from <&'the top level address'&>"&. Of course, this applies only to
20414 bounces generated locally. If a message is forwarded to another host, &'its'&
20415 bounce may well quote the generated address.
20416
20417
20418 .option ignore_eacces redirect boolean false
20419 .cindex "EACCES"
20420 If this option is set and an attempt to open a redirection file yields the
20421 EACCES error (permission denied), the &(redirect)& router behaves as if the
20422 file did not exist.
20423
20424
20425 .option ignore_enotdir redirect boolean false
20426 .cindex "ENOTDIR"
20427 If this option is set and an attempt to open a redirection file yields the
20428 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20429 router behaves as if the file did not exist.
20430
20431 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20432 router that has the &%file%& option set discovers that the file does not exist
20433 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20434 against unmounted NFS directories. If the parent can not be statted, delivery
20435 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20436 is set, because that option tells Exim to ignore &"something on the path is not
20437 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20438 that some operating systems give ENOENT where others give ENOTDIR.
20439
20440
20441
20442 .option include_directory redirect string unset
20443 If this option is set, the path names of any &':include:'& items in a
20444 redirection list must start with this directory.
20445
20446
20447 .option modemask redirect "octal integer" 022
20448 This specifies mode bits which must not be set for a file specified by the
20449 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20450
20451
20452 .option one_time redirect boolean false
20453 .cindex "one-time aliasing/forwarding expansion"
20454 .cindex "alias file" "one-time expansion"
20455 .cindex "forward file" "one-time expansion"
20456 .cindex "mailing lists" "one-time expansion"
20457 .cindex "address redirection" "one-time expansion"
20458 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20459 files each time it tries to deliver a message causes a problem when one or more
20460 of the generated addresses fails be delivered at the first attempt. The problem
20461 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20462 but of what happens when the redirection list changes during the time that the
20463 message is on Exim's queue. This is particularly true in the case of mailing
20464 lists, where new subscribers might receive copies of messages that were posted
20465 before they subscribed.
20466
20467 If &%one_time%& is set and any addresses generated by the router fail to
20468 deliver at the first attempt, the failing addresses are added to the message as
20469 &"top level"& addresses, and the parent address that generated them is marked
20470 &"delivered"&. Thus, redirection does not happen again at the next delivery
20471 attempt.
20472
20473 &*Warning 1*&: Any header line addition or removal that is specified by this
20474 router would be lost if delivery did not succeed at the first attempt. For this
20475 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20476 permitted when &%one_time%& is set.
20477
20478 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20479 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20480 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20481
20482 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20483 &%one_time%&.
20484
20485 The original top-level address is remembered with each of the generated
20486 addresses, and is output in any log messages. However, any intermediate parent
20487 addresses are not recorded. This makes a difference to the log only if
20488 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20489 typically be used for mailing lists, where there is normally just one level of
20490 expansion.
20491
20492
20493 .option owners redirect "string list" unset
20494 .cindex "ownership" "alias file"
20495 .cindex "ownership" "forward file"
20496 .cindex "alias file" "ownership"
20497 .cindex "forward file" "ownership"
20498 This specifies a list of permitted owners for the file specified by &%file%&.
20499 This list is in addition to the local user when &%check_local_user%& is set.
20500 See &%check_owner%& above.
20501
20502
20503 .option owngroups redirect "string list" unset
20504 This specifies a list of permitted groups for the file specified by &%file%&.
20505 The list is in addition to the local user's primary group when
20506 &%check_local_user%& is set. See &%check_group%& above.
20507
20508
20509 .option pipe_transport redirect string&!! unset
20510 .vindex "&$address_pipe$&"
20511 A &(redirect)& router sets up a direct delivery to a pipe when a string
20512 starting with a vertical bar character is specified as a new &"address"&. The
20513 transport used is specified by this option, which, after expansion, must be the
20514 name of a configured transport. This should normally be a &(pipe)& transport.
20515 When the transport is run, the pipe command is in &$address_pipe$&.
20516
20517
20518 .option qualify_domain redirect string&!! unset
20519 .vindex "&$qualify_recipient$&"
20520 If this option is set, and an unqualified address (one without a domain) is
20521 generated, and that address would normally be qualified by the global setting
20522 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20523 expanding this string. If the expansion fails, the router declines. If you want
20524 to revert to the default, you can have the expansion generate
20525 &$qualify_recipient$&.
20526
20527 This option applies to all unqualified addresses generated by Exim filters,
20528 but for traditional &_.forward_& files, it applies only to addresses that are
20529 not preceded by a backslash. Sieve filters cannot generate unqualified
20530 addresses.
20531
20532 .option qualify_preserve_domain redirect boolean false
20533 .cindex "domain" "in redirection; preserving"
20534 .cindex "preserving domain in redirection"
20535 .cindex "address redirection" "domain; preserving"
20536 If this option is set, the router's local &%qualify_domain%& option must not be
20537 set (a configuration error occurs if it is). If an unqualified address (one
20538 without a domain) is generated, it is qualified with the domain of the parent
20539 address (the immediately preceding ancestor) instead of the global
20540 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20541 this applies whether or not the address is preceded by a backslash.
20542
20543
20544 .option repeat_use redirect boolean true
20545 If this option is set false, the router is skipped for a child address that has
20546 any ancestor that was routed by this router. This test happens before any of
20547 the other preconditions are tested. Exim's default anti-looping rules skip
20548 only when the ancestor is the same as the current address. See also
20549 &%check_ancestor%& above and the generic &%redirect_router%& option.
20550
20551
20552 .option reply_transport redirect string&!! unset
20553 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20554 &%vacation%& command is used in a filter file. The transport used is specified
20555 by this option, which, after expansion, must be the name of a configured
20556 transport. This should normally be an &(autoreply)& transport. Other transports
20557 are unlikely to do anything sensible or useful.
20558
20559
20560 .option rewrite redirect boolean true
20561 .cindex "address redirection" "disabling rewriting"
20562 If this option is set false, addresses generated by the router are not
20563 subject to address rewriting. Otherwise, they are treated like new addresses
20564 and are rewritten according to the global rewriting rules.
20565
20566
20567 .option sieve_subaddress redirect string&!! unset
20568 The value of this option is passed to a Sieve filter to specify the
20569 :subaddress part of an address.
20570
20571 .option sieve_useraddress redirect string&!! unset
20572 The value of this option is passed to a Sieve filter to specify the :user part
20573 of an address. However, if it is unset, the entire original local part
20574 (including any prefix or suffix) is used for :user.
20575
20576
20577 .option sieve_vacation_directory redirect string&!! unset
20578 .cindex "Sieve filter" "vacation directory"
20579 To enable the &"vacation"& extension for Sieve filters, you must set
20580 &%sieve_vacation_directory%& to the directory where vacation databases are held
20581 (do not put anything else in that directory), and ensure that the
20582 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20583 needs their own directory; Exim will create it if necessary.
20584
20585
20586
20587 .option skip_syntax_errors redirect boolean false
20588 .cindex "forward file" "broken"
20589 .cindex "address redirection" "broken files"
20590 .cindex "alias file" "broken"
20591 .cindex "broken alias or forward files"
20592 .cindex "ignoring faulty addresses"
20593 .cindex "skipping faulty addresses"
20594 .cindex "error" "skipping bad syntax"
20595 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20596 non-filter redirection data are skipped, and each failing address is logged. If
20597 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20598 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20599 are expanded and placed at the head of the error message generated by
20600 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20601 be the same address as the generic &%errors_to%& option. The
20602 &%skip_syntax_errors%& option is often used when handling mailing lists.
20603
20604 If all the addresses in a redirection list are skipped because of syntax
20605 errors, the router declines to handle the original address, and it is passed to
20606 the following routers.
20607
20608 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20609 error in the filter causes filtering to be abandoned without any action being
20610 taken. The incident is logged, and the router declines to handle the address,
20611 so it is passed to the following routers.
20612
20613 .cindex "Sieve filter" "syntax errors in"
20614 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20615 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20616 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20617
20618 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20619 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20620 option, used with an address that does not get redirected, can be used to
20621 notify users of these errors, by means of a router like this:
20622 .code
20623 userforward:
20624   driver = redirect
20625   allow_filter
20626   check_local_user
20627   file = $home/.forward
20628   file_transport = address_file
20629   pipe_transport = address_pipe
20630   reply_transport = address_reply
20631   no_verify
20632   skip_syntax_errors
20633   syntax_errors_to = real-$local_part@$domain
20634   syntax_errors_text = \
20635    This is an automatically generated message. An error has\n\
20636    been found in your .forward file. Details of the error are\n\
20637    reported below. While this error persists, you will receive\n\
20638    a copy of this message for every message that is addressed\n\
20639    to you. If your .forward file is a filter file, or if it is\n\
20640    a non-filter file containing no valid forwarding addresses,\n\
20641    a copy of each incoming message will be put in your normal\n\
20642    mailbox. If a non-filter file contains at least one valid\n\
20643    forwarding address, forwarding to the valid addresses will\n\
20644    happen, and those will be the only deliveries that occur.
20645 .endd
20646 You also need a router to ensure that local addresses that are prefixed by
20647 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20648 put this immediately before the &(userforward)& router:
20649 .code
20650 real_localuser:
20651   driver = accept
20652   check_local_user
20653   local_part_prefix = real-
20654   transport = local_delivery
20655 .endd
20656 For security, it would probably be a good idea to restrict the use of this
20657 router to locally-generated messages, using a condition such as this:
20658 .code
20659   condition = ${if match {$sender_host_address}\
20660                          {\N^(|127\.0\.0\.1)$\N}}
20661 .endd
20662
20663
20664 .option syntax_errors_text redirect string&!! unset
20665 See &%skip_syntax_errors%& above.
20666
20667
20668 .option syntax_errors_to redirect string unset
20669 See &%skip_syntax_errors%& above.
20670 .ecindex IIDredrou1
20671 .ecindex IIDredrou2
20672
20673
20674
20675
20676
20677
20678 . ////////////////////////////////////////////////////////////////////////////
20679 . ////////////////////////////////////////////////////////////////////////////
20680
20681 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20682          "Environment for local transports"
20683 .scindex IIDenvlotra1 "local transports" "environment for"
20684 .scindex IIDenvlotra2 "environment" "local transports"
20685 .scindex IIDenvlotra3 "transport" "local; environment for"
20686 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20687 transport can be thought of as similar to a pipe.) Exim always runs transports
20688 in subprocesses, under specified uids and gids. Typical deliveries to local
20689 mailboxes run under the uid and gid of the local user.
20690
20691 Exim also sets a specific current directory while running the transport; for
20692 some transports a home directory setting is also relevant. The &(pipe)&
20693 transport is the only one that sets up environment variables; see section
20694 &<<SECTpipeenv>>& for details.
20695
20696 The values used for the uid, gid, and the directories may come from several
20697 different places. In many cases, the router that handles the address associates
20698 settings with that address as a result of its &%check_local_user%&, &%group%&,
20699 or &%user%& options. However, values may also be given in the transport's own
20700 configuration, and these override anything that comes from the router.
20701
20702
20703
20704 .section "Concurrent deliveries" "SECID131"
20705 .cindex "concurrent deliveries"
20706 .cindex "simultaneous deliveries"
20707 If two different messages for the same local recipient arrive more or less
20708 simultaneously, the two delivery processes are likely to run concurrently. When
20709 the &(appendfile)& transport is used to write to a file, Exim applies locking
20710 rules to stop concurrent processes from writing to the same file at the same
20711 time.
20712
20713 However, when you use a &(pipe)& transport, it is up to you to arrange any
20714 locking that is needed. Here is a silly example:
20715 .code
20716 my_transport:
20717   driver = pipe
20718   command = /bin/sh -c 'cat >>/some/file'
20719 .endd
20720 This is supposed to write the message at the end of the file. However, if two
20721 messages arrive at the same time, the file will be scrambled. You can use the
20722 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20723 file using the same algorithm that Exim itself uses.
20724
20725
20726
20727
20728 .section "Uids and gids" "SECTenvuidgid"
20729 .cindex "local transports" "uid and gid"
20730 .cindex "transport" "local; uid and gid"
20731 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20732 overrides any group that the router set in the address, even if &%user%& is not
20733 set for the transport. This makes it possible, for example, to run local mail
20734 delivery under the uid of the recipient (set by the router), but in a special
20735 group (set by the transport). For example:
20736 .code
20737 # Routers ...
20738 # User/group are set by check_local_user in this router
20739 local_users:
20740   driver = accept
20741   check_local_user
20742   transport = group_delivery
20743
20744 # Transports ...
20745 # This transport overrides the group
20746 group_delivery:
20747   driver = appendfile
20748   file = /var/spool/mail/$local_part
20749   group = mail
20750 .endd
20751 If &%user%& is set for a transport, its value overrides what is set in the
20752 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20753 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20754 set.
20755
20756 .oindex "&%initgroups%&"
20757 When the uid is taken from the transport's configuration, the &[initgroups()]&
20758 function is called for the groups associated with that uid if the
20759 &%initgroups%& option is set for the transport. When the uid is not specified
20760 by the transport, but is associated with the address by a router, the option
20761 for calling &[initgroups()]& is taken from the router configuration.
20762
20763 .cindex "&(pipe)& transport" "uid for"
20764 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20765 is set and &%user%& is not set, the uid of the process that called Exim to
20766 receive the message is used, and if &%group%& is not set, the corresponding
20767 original gid is also used.
20768
20769 This is the detailed preference order for obtaining a gid; the first of the
20770 following that is set is used:
20771
20772 .ilist
20773 A &%group%& setting of the transport;
20774 .next
20775 A &%group%& setting of the router;
20776 .next
20777 A gid associated with a user setting of the router, either as a result of
20778 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20779 .next
20780 The group associated with a non-numeric &%user%& setting of the transport;
20781 .next
20782 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20783 the uid is the creator's uid;
20784 .next
20785 The Exim gid if the Exim uid is being used as a default.
20786 .endlist
20787
20788 If, for example, the user is specified numerically on the router and there are
20789 no group settings, no gid is available. In this situation, an error occurs.
20790 This is different for the uid, for which there always is an ultimate default.
20791 The first of the following that is set is used:
20792
20793 .ilist
20794 A &%user%& setting of the transport;
20795 .next
20796 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20797 .next
20798 A &%user%& setting of the router;
20799 .next
20800 A &%check_local_user%& setting of the router;
20801 .next
20802 The Exim uid.
20803 .endlist
20804
20805 Of course, an error will still occur if the uid that is chosen is on the
20806 &%never_users%& list.
20807
20808
20809
20810
20811
20812 .section "Current and home directories" "SECID132"
20813 .cindex "current directory for local transport"
20814 .cindex "home directory" "for local transport"
20815 .cindex "transport" "local; home directory for"
20816 .cindex "transport" "local; current directory for"
20817 Routers may set current and home directories for local transports by means of
20818 the &%transport_current_directory%& and &%transport_home_directory%& options.
20819 However, if the transport's &%current_directory%& or &%home_directory%& options
20820 are set, they override the router's values. In detail, the home directory
20821 for a local transport is taken from the first of these values that is set:
20822
20823 .ilist
20824 The &%home_directory%& option on the transport;
20825 .next
20826 The &%transport_home_directory%& option on the router;
20827 .next
20828 The password data if &%check_local_user%& is set on the router;
20829 .next
20830 The &%router_home_directory%& option on the router.
20831 .endlist
20832
20833 The current directory is taken from the first of these values that is set:
20834
20835 .ilist
20836 The &%current_directory%& option on the transport;
20837 .next
20838 The &%transport_current_directory%& option on the router.
20839 .endlist
20840
20841
20842 If neither the router nor the transport sets a current directory, Exim uses the
20843 value of the home directory, if it is set. Otherwise it sets the current
20844 directory to &_/_& before running a local transport.
20845
20846
20847
20848 .section "Expansion variables derived from the address" "SECID133"
20849 .vindex "&$domain$&"
20850 .vindex "&$local_part$&"
20851 .vindex "&$original_domain$&"
20852 Normally a local delivery is handling a single address, and in that case the
20853 variables such as &$domain$& and &$local_part$& are set during local
20854 deliveries. However, in some circumstances more than one address may be handled
20855 at once (for example, while writing batch SMTP for onward transmission by some
20856 other means). In this case, the variables associated with the local part are
20857 never set, &$domain$& is set only if all the addresses have the same domain,
20858 and &$original_domain$& is never set.
20859 .ecindex IIDenvlotra1
20860 .ecindex IIDenvlotra2
20861 .ecindex IIDenvlotra3
20862
20863
20864
20865
20866
20867
20868
20869 . ////////////////////////////////////////////////////////////////////////////
20870 . ////////////////////////////////////////////////////////////////////////////
20871
20872 .chapter "Generic options for transports" "CHAPtransportgeneric"
20873 .scindex IIDgenoptra1 "generic options" "transport"
20874 .scindex IIDgenoptra2 "options" "generic; for transports"
20875 .scindex IIDgenoptra3 "transport" "generic options for"
20876 The following generic options apply to all transports:
20877
20878
20879 .option body_only transports boolean false
20880 .cindex "transport" "body only"
20881 .cindex "message" "transporting body only"
20882 .cindex "body of message" "transporting"
20883 If this option is set, the message's headers are not transported. It is
20884 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20885 or &(pipe)& transports, the settings of &%message_prefix%& and
20886 &%message_suffix%& should be checked, because this option does not
20887 automatically suppress them.
20888
20889
20890 .option current_directory transports string&!! unset
20891 .cindex "transport" "current directory for"
20892 This specifies the current directory that is to be set while running the
20893 transport, overriding any value that may have been set by the router.
20894 If the expansion fails for any reason, including forced failure, an error is
20895 logged, and delivery is deferred.
20896
20897
20898 .option disable_logging transports boolean false
20899 If this option is set true, nothing is logged for any
20900 deliveries by the transport or for any
20901 transport errors. You should not set this option unless you really, really know
20902 what you are doing.
20903
20904
20905 .option debug_print transports string&!! unset
20906 .cindex "testing" "variables in drivers"
20907 If this option is set and debugging is enabled (see the &%-d%& command line
20908 option), the string is expanded and included in the debugging output when the
20909 transport is run.
20910 If expansion of the string fails, the error message is written to the debugging
20911 output, and Exim carries on processing.
20912 This facility is provided to help with checking out the values of variables and
20913 so on when debugging driver configurations. For example, if a &%headers_add%&
20914 option is not working properly, &%debug_print%& could be used to output the
20915 variables it references. A newline is added to the text if it does not end with
20916 one.
20917 The variables &$transport_name$& and &$router_name$& contain the name of the
20918 transport and the router that called it.
20919
20920 .option delivery_date_add transports boolean false
20921 .cindex "&'Delivery-date:'& header line"
20922 If this option is true, a &'Delivery-date:'& header is added to the message.
20923 This gives the actual time the delivery was made. As this is not a standard
20924 header, Exim has a configuration option (&%delivery_date_remove%&) which
20925 requests its removal from incoming messages, so that delivered messages can
20926 safely be resent to other recipients.
20927
20928
20929 .option driver transports string unset
20930 This specifies which of the available transport drivers is to be used.
20931 There is no default, and this option must be set for every transport.
20932
20933
20934 .option envelope_to_add transports boolean false
20935 .cindex "&'Envelope-to:'& header line"
20936 If this option is true, an &'Envelope-to:'& header is added to the message.
20937 This gives the original address(es) in the incoming envelope that caused this
20938 delivery to happen. More than one address may be present if the transport is
20939 configured to handle several addresses at once, or if more than one original
20940 address was redirected to the same final address. As this is not a standard
20941 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20942 its removal from incoming messages, so that delivered messages can safely be
20943 resent to other recipients.
20944
20945
20946 .option event_action transports string&!! unset
20947 .cindex events
20948 This option declares a string to be expanded for Exim's events mechanism.
20949 For details see chapter &<<CHAPevents>>&.
20950
20951
20952 .option group transports string&!! "Exim group"
20953 .cindex "transport" "group; specifying"
20954 This option specifies a gid for running the transport process, overriding any
20955 value that the router supplies, and also overriding any value associated with
20956 &%user%& (see below).
20957
20958
20959 .option headers_add transports list&!! unset
20960 .cindex "header lines" "adding in transport"
20961 .cindex "transport" "header lines; adding"
20962 This option specifies a list of text headers,
20963 newline-separated (by default, changeable in the usual way),
20964 which are (separately) expanded and added to the header
20965 portion of a message as it is transported, as described in section
20966 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20967 routers. If the result of the expansion is an empty string, or if the expansion
20968 is forced to fail, no action is taken. Other expansion failures are treated as
20969 errors and cause the delivery to be deferred.
20970
20971 Unlike most options, &%headers_add%& can be specified multiple times
20972 for a transport; all listed headers are added.
20973
20974
20975 .option headers_only transports boolean false
20976 .cindex "transport" "header lines only"
20977 .cindex "message" "transporting headers only"
20978 .cindex "header lines" "transporting"
20979 If this option is set, the message's body is not transported. It is mutually
20980 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20981 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20982 checked, since this option does not automatically suppress them.
20983
20984
20985 .option headers_remove transports list&!! unset
20986 .cindex "header lines" "removing"
20987 .cindex "transport" "header lines; removing"
20988 This option specifies a list of header names,
20989 colon-separated (by default, changeable in the usual way);
20990 these headers are omitted from the message as it is transported, as described
20991 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20992 routers.
20993 Each list item is separately expanded.
20994 If the result of the expansion is an empty string, or if the expansion
20995 is forced to fail, no action is taken. Other expansion failures are treated as
20996 errors and cause the delivery to be deferred.
20997
20998 Unlike most options, &%headers_remove%& can be specified multiple times
20999 for a transport; all listed headers are removed.
21000
21001 &*Warning*&: Because of the separate expansion of the list items,
21002 items that contain a list separator must have it doubled.
21003 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21004
21005
21006
21007 .option headers_rewrite transports string unset
21008 .cindex "transport" "header lines; rewriting"
21009 .cindex "rewriting" "at transport time"
21010 This option allows addresses in header lines to be rewritten at transport time,
21011 that is, as the message is being copied to its destination. The contents of the
21012 option are a colon-separated list of rewriting rules. Each rule is in exactly
21013 the same form as one of the general rewriting rules that are applied when a
21014 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21015 example,
21016 .code
21017 headers_rewrite = a@b c@d f : \
21018                   x@y w@z
21019 .endd
21020 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21021 &'w@z'& in all address-bearing header lines. The rules are applied to the
21022 header lines just before they are written out at transport time, so they affect
21023 only those copies of the message that pass through the transport. However, only
21024 the message's original header lines, and any that were added by a system
21025 filter, are rewritten. If a router or transport adds header lines, they are not
21026 affected by this option. These rewriting rules are &'not'& applied to the
21027 envelope. You can change the return path using &%return_path%&, but you cannot
21028 change envelope recipients at this time.
21029
21030
21031 .option home_directory transports string&!! unset
21032 .cindex "transport" "home directory for"
21033 .vindex "&$home$&"
21034 This option specifies a home directory setting for a local transport,
21035 overriding any value that may be set by the router. The home directory is
21036 placed in &$home$& while expanding the transport's private options. It is also
21037 used as the current directory if no current directory is set by the
21038 &%current_directory%& option on the transport or the
21039 &%transport_current_directory%& option on the router. If the expansion fails
21040 for any reason, including forced failure, an error is logged, and delivery is
21041 deferred.
21042
21043
21044 .option initgroups transports boolean false
21045 .cindex "additional groups"
21046 .cindex "groups" "additional"
21047 .cindex "transport" "group; additional"
21048 If this option is true and the uid for the delivery process is provided by the
21049 transport, the &[initgroups()]& function is called when running the transport
21050 to ensure that any additional groups associated with the uid are set up.
21051
21052
21053 .option max_parallel transports integer&!! unset
21054 .cindex limit "transport parallelism"
21055 .cindex transport "parallel processes"
21056 .cindex transport "concurrency limit"
21057 .cindex "delivery" "parallelism for transport"
21058 If this option is set and expands to an integer greater than zero
21059 it limits the number of concurrent runs of the transport.
21060 The control does not apply to shadow transports.
21061
21062 .cindex "hints database" "transport concurrency control"
21063 Exim implements this control by means of a hints database in which a record is
21064 incremented whenever a transport process is being created. The record
21065 is decremented and possibly removed when the process terminates.
21066 Obviously there is scope for
21067 records to get left lying around if there is a system or program crash. To
21068 guard against this, Exim ignores any records that are more than six hours old.
21069
21070 If you use this option, you should also arrange to delete the
21071 relevant hints database whenever your system reboots. The names of the files
21072 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21073 may be one or two files, depending on the type of DBM in use. The same files
21074 are used for ETRN and smtp transport serialization.
21075
21076
21077 .option message_size_limit transports string&!! 0
21078 .cindex "limit" "message size per transport"
21079 .cindex "size" "of message, limit"
21080 .cindex "transport" "message size; limiting"
21081 This option controls the size of messages passed through the transport. It is
21082 expanded before use; the result of the expansion must be a sequence of decimal
21083 digits, optionally followed by K or M. If the expansion fails for any reason,
21084 including forced failure, or if the result is not of the required form,
21085 delivery is deferred. If the value is greater than zero and the size of a
21086 message exceeds this limit, the address is failed. If there is any chance that
21087 the resulting bounce message could be routed to the same transport, you should
21088 ensure that &%return_size_limit%& is less than the transport's
21089 &%message_size_limit%&, as otherwise the bounce message will fail to get
21090 delivered.
21091
21092
21093
21094 .option rcpt_include_affixes transports boolean false
21095 .cindex "prefix" "for local part, including in envelope"
21096 .cindex "suffix for local part" "including in envelope"
21097 .cindex "local part" "prefix"
21098 .cindex "local part" "suffix"
21099 When this option is false (the default), and an address that has had any
21100 affixes (prefixes or suffixes) removed from the local part is delivered by any
21101 form of SMTP or LMTP, the affixes are not included. For example, if a router
21102 that contains
21103 .code
21104 local_part_prefix = *-
21105 .endd
21106 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21107 is delivered with
21108 .code
21109 RCPT TO:<xyz@some.domain>
21110 .endd
21111 This is also the case when an ACL-time callout is being used to verify a
21112 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21113 whole local part is included in the RCPT command. This option applies to BSMTP
21114 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21115 &(lmtp)& and &(smtp)& transports.
21116
21117
21118 .option retry_use_local_part transports boolean "see below"
21119 .cindex "hints database" "retry keys"
21120 When a delivery suffers a temporary failure, a retry record is created
21121 in Exim's hints database. For remote deliveries, the key for the retry record
21122 is based on the name and/or IP address of the failing remote host. For local
21123 deliveries, the key is normally the entire address, including both the local
21124 part and the domain. This is suitable for most common cases of local delivery
21125 temporary failure &-- for example, exceeding a mailbox quota should delay only
21126 deliveries to that mailbox, not to the whole domain.
21127
21128 However, in some special cases you may want to treat a temporary local delivery
21129 as a failure associated with the domain, and not with a particular local part.
21130 (For example, if you are storing all mail for some domain in files.) You can do
21131 this by setting &%retry_use_local_part%& false.
21132
21133 For all the local transports, its default value is true. For remote transports,
21134 the default value is false for tidiness, but changing the value has no effect
21135 on a remote transport in the current implementation.
21136
21137
21138 .option return_path transports string&!! unset
21139 .cindex "envelope sender"
21140 .cindex "transport" "return path; changing"
21141 .cindex "return path" "changing in transport"
21142 If this option is set, the string is expanded at transport time and replaces
21143 the existing return path (envelope sender) value in the copy of the message
21144 that is being delivered. An empty return path is permitted. This feature is
21145 designed for remote deliveries, where the value of this option is used in the
21146 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21147 only effect is to change the address that is placed in the &'Return-path:'&
21148 header line, if one is added to the message (see the next option).
21149
21150 &*Note:*& A changed return path is not logged unless you add
21151 &%return_path_on_delivery%& to the log selector.
21152
21153 .vindex "&$return_path$&"
21154 The expansion can refer to the existing value via &$return_path$&. This is
21155 either the message's envelope sender, or an address set by the
21156 &%errors_to%& option on a router. If the expansion is forced to fail, no
21157 replacement occurs; if it fails for another reason, delivery is deferred. This
21158 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21159 section &<<SECTverp>>&.
21160
21161 &*Note*&: If a delivery error is detected locally, including the case when a
21162 remote server rejects a message at SMTP time, the bounce message is not sent to
21163 the value of this option. It is sent to the previously set errors address.
21164 This defaults to the incoming sender address, but can be changed by setting
21165 &%errors_to%& in a router.
21166
21167
21168
21169 .option return_path_add transports boolean false
21170 .cindex "&'Return-path:'& header line"
21171 If this option is true, a &'Return-path:'& header is added to the message.
21172 Although the return path is normally available in the prefix line of BSD
21173 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21174 have easy access to it.
21175
21176 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21177 the delivery SMTP server makes the final delivery"&. This implies that this
21178 header should not be present in incoming messages. Exim has a configuration
21179 option, &%return_path_remove%&, which requests removal of this header from
21180 incoming messages, so that delivered messages can safely be resent to other
21181 recipients.
21182
21183
21184 .option shadow_condition transports string&!! unset
21185 See &%shadow_transport%& below.
21186
21187
21188 .option shadow_transport transports string unset
21189 .cindex "shadow transport"
21190 .cindex "transport" "shadow"
21191 A local transport may set the &%shadow_transport%& option to the name of
21192 another local transport. Shadow remote transports are not supported.
21193
21194 Whenever a delivery to the main transport succeeds, and either
21195 &%shadow_condition%& is unset, or its expansion does not result in the empty
21196 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21197 passed to the shadow transport, with the same delivery address or addresses. If
21198 expansion fails, no action is taken except that non-forced expansion failures
21199 cause a log line to be written.
21200
21201 The result of the shadow transport is discarded and does not affect the
21202 subsequent processing of the message. Only a single level of shadowing is
21203 provided; the &%shadow_transport%& option is ignored on any transport when it
21204 is running as a shadow. Options concerned with output from pipes are also
21205 ignored. The log line for the successful delivery has an item added on the end,
21206 of the form
21207 .code
21208 ST=<shadow transport name>
21209 .endd
21210 If the shadow transport did not succeed, the error message is put in
21211 parentheses afterwards. Shadow transports can be used for a number of different
21212 purposes, including keeping more detailed log information than Exim normally
21213 provides, and implementing automatic acknowledgment policies based on message
21214 headers that some sites insist on.
21215
21216
21217 .option transport_filter transports string&!! unset
21218 .cindex "transport" "filter"
21219 .cindex "filter" "transport filter"
21220 This option sets up a filtering (in the Unix shell sense) process for messages
21221 at transport time. It should not be confused with mail filtering as set up by
21222 individual users or via a system filter.
21223 If unset, or expanding to an empty string, no filtering is done.
21224
21225 When the message is about to be written out, the command specified by
21226 &%transport_filter%& is started up in a separate, parallel process, and
21227 the entire message, including the header lines, is passed to it on its standard
21228 input (this in fact is done from a third process, to avoid deadlock). The
21229 command must be specified as an absolute path.
21230
21231 The lines of the message that are written to the transport filter are
21232 terminated by newline (&"\n"&). The message is passed to the filter before any
21233 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21234 lines beginning with a dot, and also before any processing implied by the
21235 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21236 &(pipe)& transports.
21237
21238 The standard error for the filter process is set to the same destination as its
21239 standard output; this is read and written to the message's ultimate
21240 destination. The process that writes the message to the filter, the
21241 filter itself, and the original process that reads the result and delivers it
21242 are all run in parallel, like a shell pipeline.
21243
21244 The filter can perform any transformations it likes, but of course should take
21245 care not to break RFC 2822 syntax. Exim does not check the result, except to
21246 test for a final newline when SMTP is in use. All messages transmitted over
21247 SMTP must end with a newline, so Exim supplies one if it is missing.
21248
21249 .cindex "content scanning" "per user"
21250 A transport filter can be used to provide content-scanning on a per-user basis
21251 at delivery time if the only required effect of the scan is to modify the
21252 message. For example, a content scan could insert a new header line containing
21253 a spam score. This could be interpreted by a filter in the user's MUA. It is
21254 not possible to discard a message at this stage.
21255
21256 .cindex "SMTP" "SIZE"
21257 A problem might arise if the filter increases the size of a message that is
21258 being sent down an SMTP connection. If the receiving SMTP server has indicated
21259 support for the SIZE parameter, Exim will have sent the size of the message
21260 at the start of the SMTP session. If what is actually sent is substantially
21261 more, the server might reject the message. This can be worked round by setting
21262 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21263 additions to the message, or to disable the use of SIZE altogether.
21264
21265 .vindex "&$pipe_addresses$&"
21266 The value of the &%transport_filter%& option is the command string for starting
21267 the filter, which is run directly from Exim, not under a shell. The string is
21268 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21269 Exim breaks it up into arguments and then expands each argument separately (see
21270 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21271 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21272 of arguments, one for each address that applies to this delivery. (This isn't
21273 an ideal name for this feature here, but as it was already implemented for the
21274 &(pipe)& transport, it seemed sensible not to change it.)
21275
21276 .vindex "&$host$&"
21277 .vindex "&$host_address$&"
21278 The expansion variables &$host$& and &$host_address$& are available when the
21279 transport is a remote one. They contain the name and IP address of the host to
21280 which the message is being sent. For example:
21281 .code
21282 transport_filter = /some/directory/transport-filter.pl \
21283   $host $host_address $sender_address $pipe_addresses
21284 .endd
21285
21286 Two problems arise if you want to use more complicated expansion items to
21287 generate transport filter commands, both of which due to the fact that the
21288 command is split up &'before'& expansion.
21289 .ilist
21290 If an expansion item contains white space, you must quote it, so that it is all
21291 part of the same command item. If the entire option setting is one such
21292 expansion item, you have to take care what kind of quoting you use. For
21293 example:
21294 .code
21295 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21296 .endd
21297 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21298 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21299 stripped by Exim when it read the option's value. When the value is used, if
21300 the single quotes were missing, the line would be split into two items,
21301 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21302 Exim tried to expand the first one.
21303 .next
21304 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21305 expansion cannot generate multiple arguments, or a command name followed by
21306 arguments. Consider this example:
21307 .code
21308 transport_filter = ${lookup{$host}lsearch{/a/file}\
21309                     {$value}{/bin/cat}}
21310 .endd
21311 The result of the lookup is interpreted as the name of the command, even
21312 if it contains white space. The simplest way round this is to use a shell:
21313 .code
21314 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21315                                {$value}{/bin/cat}}
21316 .endd
21317 .endlist
21318
21319 The filter process is run under the same uid and gid as the normal delivery.
21320 For remote deliveries this is the Exim uid/gid by default. The command should
21321 normally yield a zero return code. Transport filters are not supposed to fail.
21322 A non-zero code is taken to mean that the transport filter encountered some
21323 serious problem. Delivery of the message is deferred; the message remains on
21324 the queue and is tried again later. It is not possible to cause a message to be
21325 bounced from a transport filter.
21326
21327 If a transport filter is set on an autoreply transport, the original message is
21328 passed through the filter as it is being copied into the newly generated
21329 message, which happens if the &%return_message%& option is set.
21330
21331
21332 .option transport_filter_timeout transports time 5m
21333 .cindex "transport" "filter, timeout"
21334 When Exim is reading the output of a transport filter, it applies a timeout
21335 that can be set by this option. Exceeding the timeout is normally treated as a
21336 temporary delivery failure. However, if a transport filter is used with a
21337 &(pipe)& transport, a timeout in the transport filter is treated in the same
21338 way as a timeout in the pipe command itself. By default, a timeout is a hard
21339 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21340 becomes a temporary error.
21341
21342
21343 .option user transports string&!! "Exim user"
21344 .cindex "uid (user id)" "local delivery"
21345 .cindex "transport" "user, specifying"
21346 This option specifies the user under whose uid the delivery process is to be
21347 run, overriding any uid that may have been set by the router. If the user is
21348 given as a name, the uid is looked up from the password data, and the
21349 associated group is taken as the value of the gid to be used if the &%group%&
21350 option is not set.
21351
21352 For deliveries that use local transports, a user and group are normally
21353 specified explicitly or implicitly (for example, as a result of
21354 &%check_local_user%&) by the router or transport.
21355
21356 .cindex "hints database" "access by remote transport"
21357 For remote transports, you should leave this option unset unless you really are
21358 sure you know what you are doing. When a remote transport is running, it needs
21359 to be able to access Exim's hints databases, because each host may have its own
21360 retry data.
21361 .ecindex IIDgenoptra1
21362 .ecindex IIDgenoptra2
21363 .ecindex IIDgenoptra3
21364
21365
21366
21367
21368
21369
21370 . ////////////////////////////////////////////////////////////////////////////
21371 . ////////////////////////////////////////////////////////////////////////////
21372
21373 .chapter "Address batching in local transports" "CHAPbatching" &&&
21374          "Address batching"
21375 .cindex "transport" "local; address batching in"
21376 The only remote transport (&(smtp)&) is normally configured to handle more than
21377 one address at a time, so that when several addresses are routed to the same
21378 remote host, just one copy of the message is sent. Local transports, however,
21379 normally handle one address at a time. That is, a separate instance of the
21380 transport is run for each address that is routed to the transport. A separate
21381 copy of the message is delivered each time.
21382
21383 .cindex "batched local delivery"
21384 .oindex "&%batch_max%&"
21385 .oindex "&%batch_id%&"
21386 In special cases, it may be desirable to handle several addresses at once in a
21387 local transport, for example:
21388
21389 .ilist
21390 In an &(appendfile)& transport, when storing messages in files for later
21391 delivery by some other means, a single copy of the message with multiple
21392 recipients saves space.
21393 .next
21394 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21395 a single copy saves time, and is the normal way LMTP is expected to work.
21396 .next
21397 In a &(pipe)& transport, when passing the message
21398 to a scanner program or
21399 to some other delivery mechanism such as UUCP, multiple recipients may be
21400 acceptable.
21401 .endlist
21402
21403 These three local transports all have the same options for controlling multiple
21404 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21405 repeating the information for each transport, these options are described here.
21406
21407 The &%batch_max%& option specifies the maximum number of addresses that can be
21408 delivered together in a single run of the transport. Its default value is one
21409 (no batching). When more than one address is routed to a transport that has a
21410 &%batch_max%& value greater than one, the addresses are delivered in a batch
21411 (that is, in a single run of the transport with multiple recipients), subject
21412 to certain conditions:
21413
21414 .ilist
21415 .vindex "&$local_part$&"
21416 If any of the transport's options contain a reference to &$local_part$&, no
21417 batching is possible.
21418 .next
21419 .vindex "&$domain$&"
21420 If any of the transport's options contain a reference to &$domain$&, only
21421 addresses with the same domain are batched.
21422 .next
21423 .cindex "customizing" "batching condition"
21424 If &%batch_id%& is set, it is expanded for each address, and only those
21425 addresses with the same expanded value are batched. This allows you to specify
21426 customized batching conditions. Failure of the expansion for any reason,
21427 including forced failure, disables batching, but it does not stop the delivery
21428 from taking place.
21429 .next
21430 Batched addresses must also have the same errors address (where to send
21431 delivery errors), the same header additions and removals, the same user and
21432 group for the transport, and if a host list is present, the first host must
21433 be the same.
21434 .endlist
21435
21436 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21437 both when the file or pipe command is specified in the transport, and when it
21438 is specified by a &(redirect)& router, but all the batched addresses must of
21439 course be routed to the same file or pipe command. These two transports have an
21440 option called &%use_bsmtp%&, which causes them to deliver the message in
21441 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21442 &%check_string%& and &%escape_string%& options are forced to the values
21443 .code
21444 check_string = "."
21445 escape_string = ".."
21446 .endd
21447 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21448 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21449 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21450
21451 .cindex "&'Envelope-to:'& header line"
21452 If the generic &%envelope_to_add%& option is set for a batching transport, the
21453 &'Envelope-to:'& header that is added to the message contains all the addresses
21454 that are being processed together. If you are using a batching &(appendfile)&
21455 transport without &%use_bsmtp%&, the only way to preserve the recipient
21456 addresses is to set the &%envelope_to_add%& option.
21457
21458 .cindex "&(pipe)& transport" "with multiple addresses"
21459 .vindex "&$pipe_addresses$&"
21460 If you are using a &(pipe)& transport without BSMTP, and setting the
21461 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21462 the command. This is not a true variable; it is a bit of magic that causes each
21463 of the recipient addresses to be inserted into the command as a separate
21464 argument. This provides a way of accessing all the addresses that are being
21465 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21466 are specified by a &(redirect)& router.
21467
21468
21469
21470
21471 . ////////////////////////////////////////////////////////////////////////////
21472 . ////////////////////////////////////////////////////////////////////////////
21473
21474 .chapter "The appendfile transport" "CHAPappendfile"
21475 .scindex IIDapptra1 "&(appendfile)& transport"
21476 .scindex IIDapptra2 "transports" "&(appendfile)&"
21477 .cindex "directory creation"
21478 .cindex "creating directories"
21479 The &(appendfile)& transport delivers a message by appending it to an existing
21480 file, or by creating an entirely new file in a specified directory. Single
21481 files to which messages are appended can be in the traditional Unix mailbox
21482 format, or optionally in the MBX format supported by the Pine MUA and
21483 University of Washington IMAP daemon, &'inter alia'&. When each message is
21484 being delivered as a separate file, &"maildir"& format can optionally be used
21485 to give added protection against failures that happen part-way through the
21486 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21487 supported. For all file formats, Exim attempts to create as many levels of
21488 directory as necessary, provided that &%create_directory%& is set.
21489
21490 The code for the optional formats is not included in the Exim binary by
21491 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21492 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21493 included.
21494
21495 .cindex "quota" "system"
21496 Exim recognizes system quota errors, and generates an appropriate message. Exim
21497 also supports its own quota control within the transport, for use when the
21498 system facility is unavailable or cannot be used for some reason.
21499
21500 If there is an error while appending to a file (for example, quota exceeded or
21501 partition filled), Exim attempts to reset the file's length and last
21502 modification time back to what they were before. If there is an error while
21503 creating an entirely new file, the new file is removed.
21504
21505 Before appending to a file, a number of security checks are made, and the
21506 file is locked. A detailed description is given below, after the list of
21507 private options.
21508
21509 The &(appendfile)& transport is most commonly used for local deliveries to
21510 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21511 putting messages into files for remote delivery by some means other than Exim.
21512 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21513 option).
21514
21515
21516
21517 .section "The file and directory options" "SECTfildiropt"
21518 The &%file%& option specifies a single file, to which the message is appended;
21519 the &%directory%& option specifies a directory, in which a new file containing
21520 the message is created. Only one of these two options can be set, and for
21521 normal deliveries to mailboxes, one of them &'must'& be set.
21522
21523 .vindex "&$address_file$&"
21524 .vindex "&$local_part$&"
21525 However, &(appendfile)& is also used for delivering messages to files or
21526 directories whose names (or parts of names) are obtained from alias,
21527 forwarding, or filtering operations (for example, a &%save%& command in a
21528 user's Exim filter). When such a transport is running, &$local_part$& contains
21529 the local part that was aliased or forwarded, and &$address_file$& contains the
21530 name (or partial name) of the file or directory generated by the redirection
21531 operation. There are two cases:
21532
21533 .ilist
21534 If neither &%file%& nor &%directory%& is set, the redirection operation
21535 must specify an absolute path (one that begins with &`/`&). This is the most
21536 common case when users with local accounts use filtering to sort mail into
21537 different folders. See for example, the &(address_file)& transport in the
21538 default configuration. If the path ends with a slash, it is assumed to be the
21539 name of a directory. A delivery to a directory can also be forced by setting
21540 &%maildir_format%& or &%mailstore_format%&.
21541 .next
21542 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21543 used to determine the file or directory name for the delivery. Normally, the
21544 contents of &$address_file$& are used in some way in the string expansion.
21545 .endlist
21546
21547
21548 .cindex "Sieve filter" "configuring &(appendfile)&"
21549 .cindex "Sieve filter" "relative mailbox path handling"
21550 As an example of the second case, consider an environment where users do not
21551 have home directories. They may be permitted to use Exim filter commands of the
21552 form:
21553 .code
21554 save folder23
21555 .endd
21556 or Sieve filter commands of the form:
21557 .code
21558 require "fileinto";
21559 fileinto "folder23";
21560 .endd
21561 In this situation, the expansion of &%file%& or &%directory%& in the transport
21562 must transform the relative path into an appropriate absolute file name. In the
21563 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21564 is used as a result of a &"keep"& action in the filter. This example shows one
21565 way of handling this requirement:
21566 .code
21567 file = ${if eq{$address_file}{inbox} \
21568             {/var/mail/$local_part} \
21569             {${if eq{${substr_0_1:$address_file}}{/} \
21570                   {$address_file} \
21571                   {$home/mail/$address_file} \
21572             }} \
21573        }
21574 .endd
21575 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21576 location, absolute paths are used without change, and other folders are in the
21577 &_mail_& directory within the home directory.
21578
21579 &*Note 1*&: While processing an Exim filter, a relative path such as
21580 &_folder23_& is turned into an absolute path if a home directory is known to
21581 the router. In particular, this is the case if &%check_local_user%& is set. If
21582 you want to prevent this happening at routing time, you can set
21583 &%router_home_directory%& empty. This forces the router to pass the relative
21584 path to the transport.
21585
21586 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21587 the &%file%& or &%directory%& option is still used if it is set.
21588
21589
21590
21591
21592 .section "Private options for appendfile" "SECID134"
21593 .cindex "options" "&(appendfile)& transport"
21594
21595
21596
21597 .option allow_fifo appendfile boolean false
21598 .cindex "fifo (named pipe)"
21599 .cindex "named pipe (fifo)"
21600 .cindex "pipe" "named (fifo)"
21601 Setting this option permits delivery to named pipes (FIFOs) as well as to
21602 regular files. If no process is reading the named pipe at delivery time, the
21603 delivery is deferred.
21604
21605
21606 .option allow_symlink appendfile boolean false
21607 .cindex "symbolic link" "to mailbox"
21608 .cindex "mailbox" "symbolic link"
21609 By default, &(appendfile)& will not deliver if the path name for the file is
21610 that of a symbolic link. Setting this option relaxes that constraint, but there
21611 are security issues involved in the use of symbolic links. Be sure you know
21612 what you are doing if you set this. Details of exactly what this option affects
21613 are included in the discussion which follows this list of options.
21614
21615
21616 .option batch_id appendfile string&!! unset
21617 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21618 However, batching is automatically disabled for &(appendfile)& deliveries that
21619 happen as a result of forwarding or aliasing or other redirection directly to a
21620 file.
21621
21622
21623 .option batch_max appendfile integer 1
21624 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21625
21626
21627 .option check_group appendfile boolean false
21628 When this option is set, the group owner of the file defined by the &%file%&
21629 option is checked to see that it is the same as the group under which the
21630 delivery process is running. The default setting is false because the default
21631 file mode is 0600, which means that the group is irrelevant.
21632
21633
21634 .option check_owner appendfile boolean true
21635 When this option is set, the owner of the file defined by the &%file%& option
21636 is checked to ensure that it is the same as the user under which the delivery
21637 process is running.
21638
21639
21640 .option check_string appendfile string "see below"
21641 .cindex "&""From""& line"
21642 As &(appendfile)& writes the message, the start of each line is tested for
21643 matching &%check_string%&, and if it does, the initial matching characters are
21644 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21645 a literal string, not a regular expression, and the case of any letters it
21646 contains is significant.
21647
21648 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21649 are forced to &"."& and &".."& respectively, and any settings in the
21650 configuration are ignored. Otherwise, they default to &"From&~"& and
21651 &">From&~"& when the &%file%& option is set, and unset when any of the
21652 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21653
21654 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21655 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21656 &"From&~"& indicates the start of a new message. All four options need changing
21657 if another format is used. For example, to deliver to mailboxes in MMDF format:
21658 .cindex "MMDF format mailbox"
21659 .cindex "mailbox" "MMDF format"
21660 .code
21661 check_string = "\1\1\1\1\n"
21662 escape_string = "\1\1\1\1 \n"
21663 message_prefix = "\1\1\1\1\n"
21664 message_suffix = "\1\1\1\1\n"
21665 .endd
21666 .option create_directory appendfile boolean true
21667 .cindex "directory creation"
21668 When this option is true, Exim attempts to create any missing superior
21669 directories for the file that it is about to write. A created directory's mode
21670 is given by the &%directory_mode%& option.
21671
21672 The group ownership of a newly created directory is highly dependent on the
21673 operating system (and possibly the file system) that is being used. For
21674 example, in Solaris, if the parent directory has the setgid bit set, its group
21675 is propagated to the child; if not, the currently set group is used. However,
21676 in FreeBSD, the parent's group is always used.
21677
21678
21679
21680 .option create_file appendfile string anywhere
21681 This option constrains the location of files and directories that are created
21682 by this transport. It applies to files defined by the &%file%& option and
21683 directories defined by the &%directory%& option. In the case of maildir
21684 delivery, it applies to the top level directory, not the maildir directories
21685 beneath.
21686
21687 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21688 &"belowhome"&. In the second and third cases, a home directory must have been
21689 set for the transport. This option is not useful when an explicit file name is
21690 given for normal mailbox deliveries. It is intended for the case when file
21691 names are generated from users' &_.forward_& files. These are usually handled
21692 by an &(appendfile)& transport called &%address_file%&. See also
21693 &%file_must_exist%&.
21694
21695
21696 .option directory appendfile string&!! unset
21697 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21698 or &%directory%& must be set, unless the delivery is the direct result of a
21699 redirection (see section &<<SECTfildiropt>>&).
21700
21701 When &%directory%& is set, the string is expanded, and the message is delivered
21702 into a new file or files in or below the given directory, instead of being
21703 appended to a single mailbox file. A number of different formats are provided
21704 (see &%maildir_format%& and &%mailstore_format%&), and see section
21705 &<<SECTopdir>>& for further details of this form of delivery.
21706
21707
21708 .option directory_file appendfile string&!! "see below"
21709 .cindex "base62"
21710 .vindex "&$inode$&"
21711 When &%directory%& is set, but neither &%maildir_format%& nor
21712 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21713 whose name is obtained by expanding this string. The default value is:
21714 .code
21715 q${base62:$tod_epoch}-$inode
21716 .endd
21717 This generates a unique name from the current time, in base 62 form, and the
21718 inode of the file. The variable &$inode$& is available only when expanding this
21719 option.
21720
21721
21722 .option directory_mode appendfile "octal integer" 0700
21723 If &(appendfile)& creates any directories as a result of the
21724 &%create_directory%& option, their mode is specified by this option.
21725
21726
21727 .option escape_string appendfile string "see description"
21728 See &%check_string%& above.
21729
21730
21731 .option file appendfile string&!! unset
21732 This option is mutually exclusive with the &%directory%& option, but one of
21733 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21734 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21735 specifies a single file, to which the message is appended. One or more of
21736 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21737 &%file%&.
21738
21739 .cindex "NFS" "lock file"
21740 .cindex "locking files"
21741 .cindex "lock files"
21742 If you are using more than one host to deliver over NFS into the same
21743 mailboxes, you should always use lock files.
21744
21745 The string value is expanded for each delivery, and must yield an absolute
21746 path. The most common settings of this option are variations on one of these
21747 examples:
21748 .code
21749 file = /var/spool/mail/$local_part
21750 file = /home/$local_part/inbox
21751 file = $home/inbox
21752 .endd
21753 .cindex "&""sticky""& bit"
21754 In the first example, all deliveries are done into the same directory. If Exim
21755 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21756 create a file in the directory, so the &"sticky"& bit must be turned on for
21757 deliveries to be possible, or alternatively the &%group%& option can be used to
21758 run the delivery under a group id which has write access to the directory.
21759
21760
21761
21762 .option file_format appendfile string unset
21763 .cindex "file" "mailbox; checking existing format"
21764 This option requests the transport to check the format of an existing file
21765 before adding to it. The check consists of matching a specific string at the
21766 start of the file. The value of the option consists of an even number of
21767 colon-separated strings. The first of each pair is the test string, and the
21768 second is the name of a transport. If the transport associated with a matched
21769 string is not the current transport, control is passed over to the other
21770 transport. For example, suppose the standard &(local_delivery)& transport has
21771 this added to it:
21772 .code
21773 file_format = "From       : local_delivery :\
21774                \1\1\1\1\n : local_mmdf_delivery"
21775 .endd
21776 Mailboxes that begin with &"From"& are still handled by this transport, but if
21777 a mailbox begins with four binary ones followed by a newline, control is passed
21778 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21779 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21780 is assumed to match the current transport. If the start of a mailbox doesn't
21781 match any string, or if the transport named for a given string is not defined,
21782 delivery is deferred.
21783
21784
21785 .option file_must_exist appendfile boolean false
21786 If this option is true, the file specified by the &%file%& option must exist.
21787 A temporary error occurs if it does not, causing delivery to be deferred.
21788 If this option is false, the file is created if it does not exist.
21789
21790
21791 .option lock_fcntl_timeout appendfile time 0s
21792 .cindex "timeout" "mailbox locking"
21793 .cindex "mailbox" "locking, blocking and non-blocking"
21794 .cindex "locking files"
21795 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21796 when locking an open mailbox file. If the call fails, the delivery process
21797 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21798 Non-blocking calls are used so that the file is not kept open during the wait
21799 for the lock; the reason for this is to make it as safe as possible for
21800 deliveries over NFS in the case when processes might be accessing an NFS
21801 mailbox without using a lock file. This should not be done, but
21802 misunderstandings and hence misconfigurations are not unknown.
21803
21804 On a busy system, however, the performance of a non-blocking lock approach is
21805 not as good as using a blocking lock with a timeout. In this case, the waiting
21806 is done inside the system call, and Exim's delivery process acquires the lock
21807 and can proceed as soon as the previous lock holder releases it.
21808
21809 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21810 timeout, are used. There may still be some retrying: the maximum number of
21811 retries is
21812 .code
21813 (lock_retries * lock_interval) / lock_fcntl_timeout
21814 .endd
21815 rounded up to the next whole number. In other words, the total time during
21816 which &(appendfile)& is trying to get a lock is roughly the same, unless
21817 &%lock_fcntl_timeout%& is set very large.
21818
21819 You should consider setting this option if you are getting a lot of delayed
21820 local deliveries because of errors of the form
21821 .code
21822 failed to lock mailbox /some/file (fcntl)
21823 .endd
21824
21825 .option lock_flock_timeout appendfile time 0s
21826 This timeout applies to file locking when using &[flock()]& (see
21827 &%use_flock%&); the timeout operates in a similar manner to
21828 &%lock_fcntl_timeout%&.
21829
21830
21831 .option lock_interval appendfile time 3s
21832 This specifies the time to wait between attempts to lock the file. See below
21833 for details of locking.
21834
21835
21836 .option lock_retries appendfile integer 10
21837 This specifies the maximum number of attempts to lock the file. A value of zero
21838 is treated as 1. See below for details of locking.
21839
21840
21841 .option lockfile_mode appendfile "octal integer" 0600
21842 This specifies the mode of the created lock file, when a lock file is being
21843 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21844
21845
21846 .option lockfile_timeout appendfile time 30m
21847 .cindex "timeout" "mailbox locking"
21848 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21849 exists and is older than this value, it is assumed to have been left behind by
21850 accident, and Exim attempts to remove it.
21851
21852
21853 .option mailbox_filecount appendfile string&!! unset
21854 .cindex "mailbox" "specifying size of"
21855 .cindex "size" "of mailbox"
21856 If this option is set, it is expanded, and the result is taken as the current
21857 number of files in the mailbox. It must be a decimal number, optionally
21858 followed by K or M. This provides a way of obtaining this information from an
21859 external source that maintains the data.
21860
21861
21862 .option mailbox_size appendfile string&!! unset
21863 .cindex "mailbox" "specifying size of"
21864 .cindex "size" "of mailbox"
21865 If this option is set, it is expanded, and the result is taken as the current
21866 size the mailbox. It must be a decimal number, optionally followed by K or M.
21867 This provides a way of obtaining this information from an external source that
21868 maintains the data. This is likely to be helpful for maildir deliveries where
21869 it is computationally expensive to compute the size of a mailbox.
21870
21871
21872
21873 .option maildir_format appendfile boolean false
21874 .cindex "maildir format" "specifying"
21875 If this option is set with the &%directory%& option, the delivery is into a new
21876 file, in the &"maildir"& format that is used by other mail software. When the
21877 transport is activated directly from a &(redirect)& router (for example, the
21878 &(address_file)& transport in the default configuration), setting
21879 &%maildir_format%& causes the path received from the router to be treated as a
21880 directory, whether or not it ends with &`/`&. This option is available only if
21881 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21882 &<<SECTmaildirdelivery>>& below for further details.
21883
21884
21885 .option maildir_quota_directory_regex appendfile string "See below"
21886 .cindex "maildir format" "quota; directories included in"
21887 .cindex "quota" "maildir; directories included in"
21888 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21889 a regular expression for specifying directories, relative to the quota
21890 directory (see &%quota_directory%&), that should be included in the quota
21891 calculation. The default value is:
21892 .code
21893 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21894 .endd
21895 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21896 (directories whose names begin with a dot). If you want to exclude the
21897 &_Trash_&
21898 folder from the count (as some sites do), you need to change this setting to
21899 .code
21900 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21901 .endd
21902 This uses a negative lookahead in the regular expression to exclude the
21903 directory whose name is &_.Trash_&. When a directory is excluded from quota
21904 calculations, quota processing is bypassed for any messages that are delivered
21905 directly into that directory.
21906
21907
21908 .option maildir_retries appendfile integer 10
21909 This option specifies the number of times to retry when writing a file in
21910 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21911
21912
21913 .option maildir_tag appendfile string&!! unset
21914 This option applies only to deliveries in maildir format, and is described in
21915 section &<<SECTmaildirdelivery>>& below.
21916
21917
21918 .option maildir_use_size_file appendfile&!! boolean false
21919 .cindex "maildir format" "&_maildirsize_& file"
21920 The result of string expansion for this option must be a valid boolean value.
21921 If it is true, it enables support for &_maildirsize_& files. Exim
21922 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21923 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21924 value is zero. See &%maildir_quota_directory_regex%& above and section
21925 &<<SECTmaildirdelivery>>& below for further details.
21926
21927 .option maildirfolder_create_regex appendfile string unset
21928 .cindex "maildir format" "&_maildirfolder_& file"
21929 .cindex "&_maildirfolder_&, creating"
21930 The value of this option is a regular expression. If it is unset, it has no
21931 effect. Otherwise, before a maildir delivery takes place, the pattern is
21932 matched against the name of the maildir directory, that is, the directory
21933 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21934 delivery. If there is a match, Exim checks for the existence of a file called
21935 &_maildirfolder_& in the directory, and creates it if it does not exist.
21936 See section &<<SECTmaildirdelivery>>& for more details.
21937
21938
21939 .option mailstore_format appendfile boolean false
21940 .cindex "mailstore format" "specifying"
21941 If this option is set with the &%directory%& option, the delivery is into two
21942 new files in  &"mailstore"& format. The option is available only if
21943 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21944 below for further details.
21945
21946
21947 .option mailstore_prefix appendfile string&!! unset
21948 This option applies only to deliveries in mailstore format, and is described in
21949 section &<<SECTopdir>>& below.
21950
21951
21952 .option mailstore_suffix appendfile string&!! unset
21953 This option applies only to deliveries in mailstore format, and is described in
21954 section &<<SECTopdir>>& below.
21955
21956
21957 .option mbx_format appendfile boolean false
21958 .cindex "locking files"
21959 .cindex "file" "locking"
21960 .cindex "file" "MBX format"
21961 .cindex "MBX format, specifying"
21962 This option is available only if Exim has been compiled with SUPPORT_MBX
21963 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21964 the message is appended to the mailbox file in MBX format instead of
21965 traditional Unix format. This format is supported by Pine4 and its associated
21966 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21967
21968 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21969 automatically changed by the use of &%mbx_format%&. They should normally be set
21970 empty when using MBX format, so this option almost always appears in this
21971 combination:
21972 .code
21973 mbx_format = true
21974 message_prefix =
21975 message_suffix =
21976 .endd
21977 If none of the locking options are mentioned in the configuration,
21978 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21979 is possible to specify the other kinds of locking with &%mbx_format%&, but
21980 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21981 interworks with &'c-client'&, providing for shared access to the mailbox. It
21982 should not be used if any program that does not use this form of locking is
21983 going to access the mailbox, nor should it be used if the mailbox file is NFS
21984 mounted, because it works only when the mailbox is accessed from a single host.
21985
21986 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21987 the standard version of &'c-client'&, because as long as it has a mailbox open
21988 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21989 append messages to it.
21990
21991
21992 .option message_prefix appendfile string&!! "see below"
21993 .cindex "&""From""& line"
21994 The string specified here is expanded and output at the start of every message.
21995 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21996 in which case it is:
21997 .code
21998 message_prefix = "From ${if def:return_path{$return_path}\
21999   {MAILER-DAEMON}} $tod_bsdinbox\n"
22000 .endd
22001 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22002 &`\n`& to &`\r\n`& in &%message_prefix%&.
22003
22004 .option message_suffix appendfile string&!! "see below"
22005 The string specified here is expanded and output at the end of every message.
22006 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22007 in which case it is a single newline character. The suffix can be suppressed by
22008 setting
22009 .code
22010 message_suffix =
22011 .endd
22012 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22013 &`\n`& to &`\r\n`& in &%message_suffix%&.
22014
22015 .option mode appendfile "octal integer" 0600
22016 If the output file is created, it is given this mode. If it already exists and
22017 has wider permissions, they are reduced to this mode. If it has narrower
22018 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22019 if the delivery is the result of a &%save%& command in a filter file specifying
22020 a particular mode, the mode of the output file is always forced to take that
22021 value, and this option is ignored.
22022
22023
22024 .option mode_fail_narrower appendfile boolean true
22025 This option applies in the case when an existing mailbox file has a narrower
22026 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22027 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22028 continues with the delivery attempt, using the existing mode of the file.
22029
22030
22031 .option notify_comsat appendfile boolean false
22032 If this option is true, the &'comsat'& daemon is notified after every
22033 successful delivery to a user mailbox. This is the daemon that notifies logged
22034 on users about incoming mail.
22035
22036
22037 .option quota appendfile string&!! unset
22038 .cindex "quota" "imposed by Exim"
22039 This option imposes a limit on the size of the file to which Exim is appending,
22040 or to the total space used in the directory tree when the &%directory%& option
22041 is set. In the latter case, computation of the space used is expensive, because
22042 all the files in the directory (and any sub-directories) have to be
22043 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22044 &%maildir_use_size_file%& for ways to avoid this in environments where users
22045 have no shell access to their mailboxes).
22046
22047 As there is no interlock against two simultaneous deliveries into a
22048 multi-file mailbox, it is possible for the quota to be overrun in this case.
22049 For single-file mailboxes, of course, an interlock is a necessity.
22050
22051 A file's size is taken as its &'used'& value. Because of blocking effects, this
22052 may be a lot less than the actual amount of disk space allocated to the file.
22053 If the sizes of a number of files are being added up, the rounding effect can
22054 become quite noticeable, especially on systems that have large block sizes.
22055 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22056 the obvious value which users understand most easily.
22057
22058 The value of the option is expanded, and must then be a numerical value
22059 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22060 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
22061 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22062 be handled.
22063
22064 &*Note*&: A value of zero is interpreted as &"no quota"&.
22065
22066 The expansion happens while Exim is running as root, before it changes uid for
22067 the delivery. This means that files that are inaccessible to the end user can
22068 be used to hold quota values that are looked up in the expansion. When delivery
22069 fails because this quota is exceeded, the handling of the error is as for
22070 system quota failures.
22071
22072 By default, Exim's quota checking mimics system quotas, and restricts the
22073 mailbox to the specified maximum size, though the value is not accurate to the
22074 last byte, owing to separator lines and additional headers that may get added
22075 during message delivery. When a mailbox is nearly full, large messages may get
22076 refused even though small ones are accepted, because the size of the current
22077 message is added to the quota when the check is made. This behaviour can be
22078 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22079 for exceeding the quota does not include the current message. Thus, deliveries
22080 continue until the quota has been exceeded; thereafter, no further messages are
22081 delivered. See also &%quota_warn_threshold%&.
22082
22083
22084 .option quota_directory appendfile string&!! unset
22085 This option defines the directory to check for quota purposes when delivering
22086 into individual files. The default is the delivery directory, or, if a file
22087 called &_maildirfolder_& exists in a maildir directory, the parent of the
22088 delivery directory.
22089
22090
22091 .option quota_filecount appendfile string&!! 0
22092 This option applies when the &%directory%& option is set. It limits the total
22093 number of files in the directory (compare the inode limit in system quotas). It
22094 can only be used if &%quota%& is also set. The value is expanded; an expansion
22095 failure causes delivery to be deferred. A value of zero is interpreted as
22096 &"no quota"&.
22097
22098
22099 .option quota_is_inclusive appendfile boolean true
22100 See &%quota%& above.
22101
22102
22103 .option quota_size_regex appendfile string unset
22104 This option applies when one of the delivery modes that writes a separate file
22105 for each message is being used. When Exim wants to find the size of one of
22106 these files in order to test the quota, it first checks &%quota_size_regex%&.
22107 If this is set to a regular expression that matches the file name, and it
22108 captures one string, that string is interpreted as a representation of the
22109 file's size. The value of &%quota_size_regex%& is not expanded.
22110
22111 This feature is useful only when users have no shell access to their mailboxes
22112 &-- otherwise they could defeat the quota simply by renaming the files. This
22113 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22114 the file length to the file name. For example:
22115 .code
22116 maildir_tag = ,S=$message_size
22117 quota_size_regex = ,S=(\d+)
22118 .endd
22119 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22120 number of lines in the message.
22121
22122 The regular expression should not assume that the length is at the end of the
22123 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22124 sometimes add other information onto the ends of message file names.
22125
22126 Section &<<SECID136>>& contains further information.
22127
22128
22129 .option quota_warn_message appendfile string&!! "see below"
22130 See below for the use of this option. If it is not set when
22131 &%quota_warn_threshold%& is set, it defaults to
22132 .code
22133 quota_warn_message = "\
22134   To: $local_part@$domain\n\
22135   Subject: Your mailbox\n\n\
22136   This message is automatically created \
22137   by mail delivery software.\n\n\
22138   The size of your mailbox has exceeded \
22139   a warning threshold that is\n\
22140   set by the system administrator.\n"
22141 .endd
22142
22143
22144 .option quota_warn_threshold appendfile string&!! 0
22145 .cindex "quota" "warning threshold"
22146 .cindex "mailbox" "size warning"
22147 .cindex "size" "of mailbox"
22148 This option is expanded in the same way as &%quota%& (see above). If the
22149 resulting value is greater than zero, and delivery of the message causes the
22150 size of the file or total space in the directory tree to cross the given
22151 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22152 may be specified as a percentage of it by following the value with a percent
22153 sign. For example:
22154 .code
22155 quota = 10M
22156 quota_warn_threshold = 75%
22157 .endd
22158 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22159 percent sign is ignored.
22160
22161 The warning message itself is specified by the &%quota_warn_message%& option,
22162 and it must start with a &'To:'& header line containing the recipient(s) of the
22163 warning message. These do not necessarily have to include the recipient(s) of
22164 the original message. A &'Subject:'& line should also normally be supplied. You
22165 can include any other header lines that you want. If you do not include a
22166 &'From:'& line, the default is:
22167 .code
22168 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22169 .endd
22170 .oindex &%errors_reply_to%&
22171 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22172 option.
22173
22174 The &%quota%& option does not have to be set in order to use this option; they
22175 are independent of one another except when the threshold is specified as a
22176 percentage.
22177
22178
22179 .option use_bsmtp appendfile boolean false
22180 .cindex "envelope sender"
22181 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22182 format, with the envelope sender and recipient(s) included as SMTP commands. If
22183 you want to include a leading HELO command with such messages, you can do
22184 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22185 for details of batch SMTP.
22186
22187
22188 .option use_crlf appendfile boolean false
22189 .cindex "carriage return"
22190 .cindex "linefeed"
22191 This option causes lines to be terminated with the two-character CRLF sequence
22192 (carriage return, linefeed) instead of just a linefeed character. In the case
22193 of batched SMTP, the byte sequence written to the file is then an exact image
22194 of what would be sent down a real SMTP connection.
22195
22196 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22197 (which are used to supply the traditional &"From&~"& and blank line separators
22198 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22199 carriage return characters if these are needed. In cases where these options
22200 have non-empty defaults, the values end with a single linefeed, so they must be
22201 changed to end with &`\r\n`& if &%use_crlf%& is set.
22202
22203
22204 .option use_fcntl_lock appendfile boolean "see below"
22205 This option controls the use of the &[fcntl()]& function to lock a file for
22206 exclusive use when a message is being appended. It is set by default unless
22207 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22208 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22209 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22210
22211
22212 .option use_flock_lock appendfile boolean false
22213 This option is provided to support the use of &[flock()]& for file locking, for
22214 the few situations where it is needed. Most modern operating systems support
22215 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22216 each other. Exim uses &[fcntl()]& locking by default.
22217
22218 This option is required only if you are using an operating system where
22219 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22220 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22221 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22222
22223 .cindex "Solaris" "&[flock()]& support"
22224 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22225 have it (and some, I think, provide a not quite right version built on top of
22226 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22227 the ability to use it, and any attempt to do so will cause a configuration
22228 error.
22229
22230 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22231 is just being mapped onto &[fcntl()]& by the OS).
22232
22233
22234 .option use_lockfile appendfile boolean "see below"
22235 If this option is turned off, Exim does not attempt to create a lock file when
22236 appending to a mailbox file. In this situation, the only locking is by
22237 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22238 sure that every MUA that is ever going to look at your users' mailboxes uses
22239 &[fcntl()]& rather than a lock file, and even then only when you are not
22240 delivering over NFS from more than one host.
22241
22242 .cindex "NFS" "lock file"
22243 In order to append to an NFS file safely from more than one host, it is
22244 necessary to take out a lock &'before'& opening the file, and the lock file
22245 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22246 file corruption.
22247
22248 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22249 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22250 except when &%mbx_format%& is set.
22251
22252
22253 .option use_mbx_lock appendfile boolean "see below"
22254 This option is available only if Exim has been compiled with SUPPORT_MBX
22255 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22256 locking rules be used. It is set by default if &%mbx_format%& is set and none
22257 of the locking options are mentioned in the configuration. The locking rules
22258 are the same as are used by the &'c-client'& library that underlies Pine and
22259 the IMAP4 and POP daemons that come with it (see the discussion below). The
22260 rules allow for shared access to the mailbox. However, this kind of locking
22261 does not work when the mailbox is NFS mounted.
22262
22263 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22264 &%use_flock_lock%& to control what kind of locking is used in implementing the
22265 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22266 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22267
22268
22269
22270
22271 .section "Operational details for appending" "SECTopappend"
22272 .cindex "appending to a file"
22273 .cindex "file" "appending"
22274 Before appending to a file, the following preparations are made:
22275
22276 .ilist
22277 If the name of the file is &_/dev/null_&, no action is taken, and a success
22278 return is given.
22279
22280 .next
22281 .cindex "directory creation"
22282 If any directories on the file's path are missing, Exim creates them if the
22283 &%create_directory%& option is set. A created directory's mode is given by the
22284 &%directory_mode%& option.
22285
22286 .next
22287 If &%file_format%& is set, the format of an existing file is checked. If this
22288 indicates that a different transport should be used, control is passed to that
22289 transport.
22290
22291 .next
22292 .cindex "file" "locking"
22293 .cindex "locking files"
22294 .cindex "NFS" "lock file"
22295 If &%use_lockfile%& is set, a lock file is built in a way that will work
22296 reliably over NFS, as follows:
22297
22298 .olist
22299 Create a &"hitching post"& file whose name is that of the lock file with the
22300 current time, primary host name, and process id added, by opening for writing
22301 as a new file. If this fails with an access error, delivery is deferred.
22302 .next
22303 Close the hitching post file, and hard link it to the lock file name.
22304 .next
22305 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22306 Unlink the hitching post name.
22307 .next
22308 Otherwise, use &[stat()]& to get information about the hitching post file, and
22309 then unlink hitching post name. If the number of links is exactly two, creation
22310 of the lock file succeeded but something (for example, an NFS server crash and
22311 restart) caused this fact not to be communicated to the &[link()]& call.
22312 .next
22313 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22314 up to &%lock_retries%& times. However, since any program that writes to a
22315 mailbox should complete its task very quickly, it is reasonable to time out old
22316 lock files that are normally the result of user agent and system crashes. If an
22317 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22318 it before trying again.
22319 .endlist olist
22320
22321 .next
22322 A call is made to &[lstat()]& to discover whether the main file exists, and if
22323 so, what its characteristics are. If &[lstat()]& fails for any reason other
22324 than non-existence, delivery is deferred.
22325
22326 .next
22327 .cindex "symbolic link" "to mailbox"
22328 .cindex "mailbox" "symbolic link"
22329 If the file does exist and is a symbolic link, delivery is deferred, unless the
22330 &%allow_symlink%& option is set, in which case the ownership of the link is
22331 checked, and then &[stat()]& is called to find out about the real file, which
22332 is then subjected to the checks below. The check on the top-level link
22333 ownership prevents one user creating a link for another's mailbox in a sticky
22334 directory, though allowing symbolic links in this case is definitely not a good
22335 idea. If there is a chain of symbolic links, the intermediate ones are not
22336 checked.
22337
22338 .next
22339 If the file already exists but is not a regular file, or if the file's owner
22340 and group (if the group is being checked &-- see &%check_group%& above) are
22341 different from the user and group under which the delivery is running,
22342 delivery is deferred.
22343
22344 .next
22345 If the file's permissions are more generous than specified, they are reduced.
22346 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22347 is set false, in which case the delivery is tried using the existing
22348 permissions.
22349
22350 .next
22351 The file's inode number is saved, and the file is then opened for appending.
22352 If this fails because the file has vanished, &(appendfile)& behaves as if it
22353 hadn't existed (see below). For any other failures, delivery is deferred.
22354
22355 .next
22356 If the file is opened successfully, check that the inode number hasn't
22357 changed, that it is still a regular file, and that the owner and permissions
22358 have not changed. If anything is wrong, defer delivery and freeze the message.
22359
22360 .next
22361 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22362 option is set. Otherwise, check that the file is being created in a permitted
22363 directory if the &%create_file%& option is set (deferring on failure), and then
22364 open for writing as a new file, with the O_EXCL and O_CREAT options,
22365 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22366 set). In this case, which can happen if the link points to a non-existent file,
22367 the file is opened for writing using O_CREAT but not O_EXCL, because
22368 that prevents link following.
22369
22370 .next
22371 .cindex "loop" "while file testing"
22372 If opening fails because the file exists, obey the tests given above for
22373 existing files. However, to avoid looping in a situation where the file is
22374 being continuously created and destroyed, the exists/not-exists loop is broken
22375 after 10 repetitions, and the message is then frozen.
22376
22377 .next
22378 If opening fails with any other error, defer delivery.
22379
22380 .next
22381 .cindex "file" "locking"
22382 .cindex "locking files"
22383 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22384 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22385 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22386 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22387 file, and an exclusive lock on the file whose name is
22388 .code
22389 /tmp/.<device-number>.<inode-number>
22390 .endd
22391 using the device and inode numbers of the open mailbox file, in accordance with
22392 the MBX locking rules. This file is created with a mode that is specified by
22393 the &%lockfile_mode%& option.
22394
22395 If Exim fails to lock the file, there are two possible courses of action,
22396 depending on the value of the locking timeout. This is obtained from
22397 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22398
22399 If the timeout value is zero, the file is closed, Exim waits for
22400 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22401 to lock it again. This happens up to &%lock_retries%& times, after which the
22402 delivery is deferred.
22403
22404 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22405 &[flock()]& are used (with the given timeout), so there has already been some
22406 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22407 immediately. It retries up to
22408 .code
22409 (lock_retries * lock_interval) / <timeout>
22410 .endd
22411 times (rounded up).
22412 .endlist
22413
22414 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22415 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22416
22417
22418 .section "Operational details for delivery to a new file" "SECTopdir"
22419 .cindex "delivery" "to single file"
22420 .cindex "&""From""& line"
22421 When the &%directory%& option is set instead of &%file%&, each message is
22422 delivered into a newly-created file or set of files. When &(appendfile)& is
22423 activated directly from a &(redirect)& router, neither &%file%& nor
22424 &%directory%& is normally set, because the path for delivery is supplied by the
22425 router. (See for example, the &(address_file)& transport in the default
22426 configuration.) In this case, delivery is to a new file if either the path name
22427 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22428
22429 No locking is required while writing the message to a new file, so the various
22430 locking options of the transport are ignored. The &"From"& line that by default
22431 separates messages in a single file is not normally needed, nor is the escaping
22432 of message lines that start with &"From"&, and there is no need to ensure a
22433 newline at the end of each message. Consequently, the default values for
22434 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22435 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22436
22437 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22438 the files in the delivery directory by default. However, you can specify a
22439 different directory by setting &%quota_directory%&. Also, for maildir
22440 deliveries (see below) the &_maildirfolder_& convention is honoured.
22441
22442
22443 .cindex "maildir format"
22444 .cindex "mailstore format"
22445 There are three different ways in which delivery to individual files can be
22446 done, controlled by the settings of the &%maildir_format%& and
22447 &%mailstore_format%& options. Note that code to support maildir or mailstore
22448 formats is not included in the binary unless SUPPORT_MAILDIR or
22449 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22450
22451 .cindex "directory creation"
22452 In all three cases an attempt is made to create the directory and any necessary
22453 sub-directories if they do not exist, provided that the &%create_directory%&
22454 option is set (the default). The location of a created directory can be
22455 constrained by setting &%create_file%&. A created directory's mode is given by
22456 the &%directory_mode%& option. If creation fails, or if the
22457 &%create_directory%& option is not set when creation is required, delivery is
22458 deferred.
22459
22460
22461
22462 .section "Maildir delivery" "SECTmaildirdelivery"
22463 .cindex "maildir format" "description of"
22464 If the &%maildir_format%& option is true, Exim delivers each message by writing
22465 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22466 directory that is defined by the &%directory%& option (the &"delivery
22467 directory"&). If the delivery is successful, the file is renamed into the
22468 &_new_& subdirectory.
22469
22470 In the file name, <&'stime'&> is the current time of day in seconds, and
22471 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22472 Exim checks that the time-of-day clock has moved on by at least one microsecond
22473 before terminating the delivery process. This guarantees uniqueness for the
22474 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22475 opening it. If any response other than ENOENT (does not exist) is given,
22476 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22477
22478 Before Exim carries out a maildir delivery, it ensures that subdirectories
22479 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22480 do not exist, Exim tries to create them and any superior directories in their
22481 path, subject to the &%create_directory%& and &%create_file%& options. If the
22482 &%maildirfolder_create_regex%& option is set, and the regular expression it
22483 contains matches the delivery directory, Exim also ensures that a file called
22484 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22485 &_maildirfolder_& file cannot be created, delivery is deferred.
22486
22487 These features make it possible to use Exim to create all the necessary files
22488 and directories in a maildir mailbox, including subdirectories for maildir++
22489 folders. Consider this example:
22490 .code
22491 maildir_format = true
22492 directory = /var/mail/$local_part\
22493            ${if eq{$local_part_suffix}{}{}\
22494            {/.${substr_1:$local_part_suffix}}}
22495 maildirfolder_create_regex = /\.[^/]+$
22496 .endd
22497 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22498 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22499 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22500 not match this name, so Exim will not look for or create the file
22501 &_/var/mail/pimbo/maildirfolder_&, though it will create
22502 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22503
22504 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22505 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22506 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22507 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22508 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22509
22510 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22511 not inadvertently match the toplevel maildir directory, because a
22512 &_maildirfolder_& file at top level would completely break quota calculations.
22513
22514 .cindex "quota" "in maildir delivery"
22515 .cindex "maildir++"
22516 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22517 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22518 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22519 Exim assumes the directory is a maildir++ folder directory, which is one level
22520 down from the user's top level mailbox directory. This causes it to start at
22521 the parent directory instead of the current directory when calculating the
22522 amount of space used.
22523
22524 One problem with delivering into a multi-file mailbox is that it is
22525 computationally expensive to compute the size of the mailbox for quota
22526 checking. Various approaches have been taken to reduce the amount of work
22527 needed. The next two sections describe two of them. A third alternative is to
22528 use some external process for maintaining the size data, and use the expansion
22529 of the &%mailbox_size%& option as a way of importing it into Exim.
22530
22531
22532
22533
22534 .section "Using tags to record message sizes" "SECID135"
22535 If &%maildir_tag%& is set, the string is expanded for each delivery.
22536 When the maildir file is renamed into the &_new_& sub-directory, the
22537 tag is added to its name. However, if adding the tag takes the length of the
22538 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22539 the tag is dropped and the maildir file is created with no tag.
22540
22541
22542 .vindex "&$message_size$&"
22543 Tags can be used to encode the size of files in their names; see
22544 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22545 happens after the message has been written. The value of the &$message_size$&
22546 variable is set to the number of bytes actually written. If the expansion is
22547 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22548 be deferred. The expanded tag may contain any printing characters except &"/"&.
22549 Non-printing characters in the string are ignored; if the resulting string is
22550 empty, it is ignored. If it starts with an alphanumeric character, a leading
22551 colon is inserted; this default has not proven to be the path that popular
22552 maildir implementations have chosen (but changing it in Exim would break
22553 backwards compatibility).
22554
22555 For one common implementation, you might set:
22556 .code
22557 maildir_tag = ,S=${message_size}
22558 .endd
22559 but you should check the documentation of the other software to be sure.
22560
22561 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22562 as this allows Exim to extract the size from your tag, instead of having to
22563 &[stat()]& each message file.
22564
22565
22566 .section "Using a maildirsize file" "SECID136"
22567 .cindex "quota" "in maildir delivery"
22568 .cindex "maildir format" "&_maildirsize_& file"
22569 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22570 storing quota and message size information in a file called &_maildirsize_&
22571 within the toplevel maildir directory. If this file does not exist, Exim
22572 creates it, setting the quota from the &%quota%& option of the transport. If
22573 the maildir directory itself does not exist, it is created before any attempt
22574 to write a &_maildirsize_& file.
22575
22576 The &_maildirsize_& file is used to hold information about the sizes of
22577 messages in the maildir, thus speeding up quota calculations. The quota value
22578 in the file is just a cache; if the quota is changed in the transport, the new
22579 value overrides the cached value when the next message is delivered. The cache
22580 is maintained for the benefit of other programs that access the maildir and
22581 need to know the quota.
22582
22583 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22584 file is maintained (with a zero quota setting), but no quota is imposed.
22585
22586 A regular expression is available for controlling which directories in the
22587 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22588 See the description of the &%maildir_quota_directory_regex%& option above for
22589 details.
22590
22591
22592 .section "Mailstore delivery" "SECID137"
22593 .cindex "mailstore format" "description of"
22594 If the &%mailstore_format%& option is true, each message is written as two
22595 files in the given directory. A unique base name is constructed from the
22596 message id and the current delivery process, and the files that are written use
22597 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22598 contains the message's envelope, and the &_.msg_& file contains the message
22599 itself. The base name is placed in the variable &$mailstore_basename$&.
22600
22601 During delivery, the envelope is first written to a file with the suffix
22602 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22603 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22604 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22605 file before accessing either of them. An alternative approach is to wait for
22606 the absence of a &_.tmp_& file.
22607
22608 The envelope file starts with any text defined by the &%mailstore_prefix%&
22609 option, expanded and terminated by a newline if there isn't one. Then follows
22610 the sender address on one line, then all the recipient addresses, one per line.
22611 There can be more than one recipient only if the &%batch_max%& option is set
22612 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22613 appended to the file, followed by a newline if it does not end with one.
22614
22615 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22616 failure, it is ignored. Other expansion errors are treated as serious
22617 configuration errors, and delivery is deferred. The variable
22618 &$mailstore_basename$& is available for use during these expansions.
22619
22620
22621 .section "Non-special new file delivery" "SECID138"
22622 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22623 file is created directly in the named directory. For example, when delivering
22624 messages into files in batched SMTP format for later delivery to some host (see
22625 section &<<SECTbatchSMTP>>&), a setting such as
22626 .code
22627 directory = /var/bsmtp/$host
22628 .endd
22629 might be used. A message is written to a file with a temporary name, which is
22630 then renamed when the delivery is complete. The final name is obtained by
22631 expanding the contents of the &%directory_file%& option.
22632 .ecindex IIDapptra1
22633 .ecindex IIDapptra2
22634
22635
22636
22637
22638
22639
22640 . ////////////////////////////////////////////////////////////////////////////
22641 . ////////////////////////////////////////////////////////////////////////////
22642
22643 .chapter "The autoreply transport" "CHID8"
22644 .scindex IIDauttra1 "transports" "&(autoreply)&"
22645 .scindex IIDauttra2 "&(autoreply)& transport"
22646 The &(autoreply)& transport is not a true transport in that it does not cause
22647 the message to be transmitted. Instead, it generates a new mail message as an
22648 automatic reply to the incoming message. &'References:'& and
22649 &'Auto-Submitted:'& header lines are included. These are constructed according
22650 to the rules in RFCs 2822 and 3834, respectively.
22651
22652 If the router that passes the message to this transport does not have the
22653 &%unseen%& option set, the original message (for the current recipient) is not
22654 delivered anywhere. However, when the &%unseen%& option is set on the router
22655 that passes the message to this transport, routing of the address continues, so
22656 another router can set up a normal message delivery.
22657
22658
22659 The &(autoreply)& transport is usually run as the result of mail filtering, a
22660 &"vacation"& message being the standard example. However, it can also be run
22661 directly from a router like any other transport. To reduce the possibility of
22662 message cascades, messages created by the &(autoreply)& transport always have
22663 empty envelope sender addresses, like bounce messages.
22664
22665 The parameters of the message to be sent can be specified in the configuration
22666 by options described below. However, these are used only when the address
22667 passed to the transport does not contain its own reply information. When the
22668 transport is run as a consequence of a
22669 &%mail%&
22670 or &%vacation%& command in a filter file, the parameters of the message are
22671 supplied by the filter, and passed with the address. The transport's options
22672 that define the message are then ignored (so they are not usually set in this
22673 case). The message is specified entirely by the filter or by the transport; it
22674 is never built from a mixture of options. However, the &%file_optional%&,
22675 &%mode%&, and &%return_message%& options apply in all cases.
22676
22677 &(Autoreply)& is implemented as a local transport. When used as a result of a
22678 command in a user's filter file, &(autoreply)& normally runs under the uid and
22679 gid of the user, and with appropriate current and home directories (see chapter
22680 &<<CHAPenvironment>>&).
22681
22682 There is a subtle difference between routing a message to a &(pipe)& transport
22683 that generates some text to be returned to the sender, and routing it to an
22684 &(autoreply)& transport. This difference is noticeable only if more than one
22685 address from the same message is so handled. In the case of a pipe, the
22686 separate outputs from the different addresses are gathered up and returned to
22687 the sender in a single message, whereas if &(autoreply)& is used, a separate
22688 message is generated for each address that is passed to it.
22689
22690 Non-printing characters are not permitted in the header lines generated for the
22691 message that &(autoreply)& creates, with the exception of newlines that are
22692 immediately followed by white space. If any non-printing characters are found,
22693 the transport defers.
22694 Whether characters with the top bit set count as printing characters or not is
22695 controlled by the &%print_topbitchars%& global option.
22696
22697 If any of the generic options for manipulating headers (for example,
22698 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22699 of the original message that is included in the generated message when
22700 &%return_message%& is set. They do not apply to the generated message itself.
22701
22702 .vindex "&$sender_address$&"
22703 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22704 the message, indicating that there were no recipients, it does not treat this
22705 as an error. This means that autoreplies sent to &$sender_address$& when this
22706 is empty (because the incoming message is a bounce message) do not cause
22707 problems. They are just discarded.
22708
22709
22710
22711 .section "Private options for autoreply" "SECID139"
22712 .cindex "options" "&(autoreply)& transport"
22713
22714 .option bcc autoreply string&!! unset
22715 This specifies the addresses that are to receive &"blind carbon copies"& of the
22716 message when the message is specified by the transport.
22717
22718
22719 .option cc autoreply string&!! unset
22720 This specifies recipients of the message and the contents of the &'Cc:'& header
22721 when the message is specified by the transport.
22722
22723
22724 .option file autoreply string&!! unset
22725 The contents of the file are sent as the body of the message when the message
22726 is specified by the transport. If both &%file%& and &%text%& are set, the text
22727 string comes first.
22728
22729
22730 .option file_expand autoreply boolean false
22731 If this is set, the contents of the file named by the &%file%& option are
22732 subjected to string expansion as they are added to the message.
22733
22734
22735 .option file_optional autoreply boolean false
22736 If this option is true, no error is generated if the file named by the &%file%&
22737 option or passed with the address does not exist or cannot be read.
22738
22739
22740 .option from autoreply string&!! unset
22741 This specifies the contents of the &'From:'& header when the message is
22742 specified by the transport.
22743
22744
22745 .option headers autoreply string&!! unset
22746 This specifies additional RFC 2822 headers that are to be added to the message
22747 when the message is specified by the transport. Several can be given by using
22748 &"\n"& to separate them. There is no check on the format.
22749
22750
22751 .option log autoreply string&!! unset
22752 This option names a file in which a record of every message sent is logged when
22753 the message is specified by the transport.
22754
22755
22756 .option mode autoreply "octal integer" 0600
22757 If either the log file or the &"once"& file has to be created, this mode is
22758 used.
22759
22760
22761 .option never_mail autoreply "address list&!!" unset
22762 If any run of the transport creates a message with a recipient that matches any
22763 item in the list, that recipient is quietly discarded. If all recipients are
22764 discarded, no message is created. This applies both when the recipients are
22765 generated by a filter and when they are specified in the transport.
22766
22767
22768
22769 .option once autoreply string&!! unset
22770 This option names a file or DBM database in which a record of each &'To:'&
22771 recipient is kept when the message is specified by the transport. &*Note*&:
22772 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22773
22774 If &%once%& is unset, or is set to an empty string, the message is always sent.
22775 By default, if &%once%& is set to a non-empty file name, the message
22776 is not sent if a potential recipient is already listed in the database.
22777 However, if the &%once_repeat%& option specifies a time greater than zero, the
22778 message is sent if that much time has elapsed since a message was last sent to
22779 this recipient. A setting of zero time for &%once_repeat%& (the default)
22780 prevents a message from being sent a second time &-- in this case, zero means
22781 infinity.
22782
22783 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22784 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22785 greater than zero, it changes the way Exim implements the &%once%& option.
22786 Instead of using a DBM file to record every recipient it sends to, it uses a
22787 regular file, whose size will never get larger than the given value.
22788
22789 In the file, Exim keeps a linear list of recipient addresses and the times at
22790 which they were sent messages. If the file is full when a new address needs to
22791 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22792 means that a given recipient may receive multiple messages, but at
22793 unpredictable intervals that depend on the rate of turnover of addresses in the
22794 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22795
22796
22797 .option once_file_size autoreply integer 0
22798 See &%once%& above.
22799
22800
22801 .option once_repeat autoreply time&!! 0s
22802 See &%once%& above.
22803 After expansion, the value of this option must be a valid time value.
22804
22805
22806 .option reply_to autoreply string&!! unset
22807 This specifies the contents of the &'Reply-To:'& header when the message is
22808 specified by the transport.
22809
22810
22811 .option return_message autoreply boolean false
22812 If this is set, a copy of the original message is returned with the new
22813 message, subject to the maximum size set in the &%return_size_limit%& global
22814 configuration option.
22815
22816
22817 .option subject autoreply string&!! unset
22818 This specifies the contents of the &'Subject:'& header when the message is
22819 specified by the transport. It is tempting to quote the original subject in
22820 automatic responses. For example:
22821 .code
22822 subject = Re: $h_subject:
22823 .endd
22824 There is a danger in doing this, however. It may allow a third party to
22825 subscribe your users to an opt-in mailing list, provided that the list accepts
22826 bounce messages as subscription confirmations. Well-managed lists require a
22827 non-bounce message to confirm a subscription, so the danger is relatively
22828 small.
22829
22830
22831
22832 .option text autoreply string&!! unset
22833 This specifies a single string to be used as the body of the message when the
22834 message is specified by the transport. If both &%text%& and &%file%& are set,
22835 the text comes first.
22836
22837
22838 .option to autoreply string&!! unset
22839 This specifies recipients of the message and the contents of the &'To:'& header
22840 when the message is specified by the transport.
22841 .ecindex IIDauttra1
22842 .ecindex IIDauttra2
22843
22844
22845
22846
22847 . ////////////////////////////////////////////////////////////////////////////
22848 . ////////////////////////////////////////////////////////////////////////////
22849
22850 .chapter "The lmtp transport" "CHAPLMTP"
22851 .cindex "transports" "&(lmtp)&"
22852 .cindex "&(lmtp)& transport"
22853 .cindex "LMTP" "over a pipe"
22854 .cindex "LMTP" "over a socket"
22855 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22856 specified command
22857 or by interacting with a Unix domain socket.
22858 This transport is something of a cross between the &(pipe)& and &(smtp)&
22859 transports. Exim also has support for using LMTP over TCP/IP; this is
22860 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22861 to be of minority interest, the default build-time configure in &_src/EDITME_&
22862 has it commented out. You need to ensure that
22863 .code
22864 TRANSPORT_LMTP=yes
22865 .endd
22866 .cindex "options" "&(lmtp)& transport"
22867 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22868 included in the Exim binary. The private options of the &(lmtp)& transport are
22869 as follows:
22870
22871 .option batch_id lmtp string&!! unset
22872 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22873
22874
22875 .option batch_max lmtp integer 1
22876 This limits the number of addresses that can be handled in a single delivery.
22877 Most LMTP servers can handle several addresses at once, so it is normally a
22878 good idea to increase this value. See the description of local delivery
22879 batching in chapter &<<CHAPbatching>>&.
22880
22881
22882 .option command lmtp string&!! unset
22883 This option must be set if &%socket%& is not set. The string is a command which
22884 is run in a separate process. It is split up into a command name and list of
22885 arguments, each of which is separately expanded (so expansion cannot change the
22886 number of arguments). The command is run directly, not via a shell. The message
22887 is passed to the new process using the standard input and output to operate the
22888 LMTP protocol.
22889
22890 .option ignore_quota lmtp boolean false
22891 .cindex "LMTP" "ignoring quota errors"
22892 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22893 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22894 in its response to the LHLO command.
22895
22896 .option socket lmtp string&!! unset
22897 This option must be set if &%command%& is not set. The result of expansion must
22898 be the name of a Unix domain socket. The transport connects to the socket and
22899 delivers the message to it using the LMTP protocol.
22900
22901
22902 .option timeout lmtp time 5m
22903 The transport is aborted if the created process or Unix domain socket does not
22904 respond to LMTP commands or message input within this timeout. Delivery
22905 is deferred, and will be tried again later. Here is an example of a typical
22906 LMTP transport:
22907 .code
22908 lmtp:
22909   driver = lmtp
22910   command = /some/local/lmtp/delivery/program
22911   batch_max = 20
22912   user = exim
22913 .endd
22914 This delivers up to 20 addresses at a time, in a mixture of domains if
22915 necessary, running as the user &'exim'&.
22916
22917
22918
22919 . ////////////////////////////////////////////////////////////////////////////
22920 . ////////////////////////////////////////////////////////////////////////////
22921
22922 .chapter "The pipe transport" "CHAPpipetransport"
22923 .scindex IIDpiptra1 "transports" "&(pipe)&"
22924 .scindex IIDpiptra2 "&(pipe)& transport"
22925 The &(pipe)& transport is used to deliver messages via a pipe to a command
22926 running in another process. One example is the use of &(pipe)& as a
22927 pseudo-remote transport for passing messages to some other delivery mechanism
22928 (such as UUCP). Another is the use by individual users to automatically process
22929 their incoming messages. The &(pipe)& transport can be used in one of the
22930 following ways:
22931
22932 .ilist
22933 .vindex "&$local_part$&"
22934 A router routes one address to a transport in the normal way, and the
22935 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22936 contains the local part of the address (as usual), and the command that is run
22937 is specified by the &%command%& option on the transport.
22938 .next
22939 .vindex "&$pipe_addresses$&"
22940 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22941 transport can handle more than one address in a single run. In this case, when
22942 more than one address is routed to the transport, &$local_part$& is not set
22943 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22944 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22945 that are routed to the transport.
22946 .next
22947 .vindex "&$address_pipe$&"
22948 A router redirects an address directly to a pipe command (for example, from an
22949 alias or forward file). In this case, &$address_pipe$& contains the text of the
22950 pipe command, and the &%command%& option on the transport is ignored unless
22951 &%force_command%& is set. If only one address is being transported
22952 (&%batch_max%& is not greater than one, or only one address was redirected to
22953 this pipe command), &$local_part$& contains the local part that was redirected.
22954 .endlist
22955
22956
22957 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22958 deliver messages over pipes using the LMTP interactive protocol. This is
22959 implemented by the &(lmtp)& transport.
22960
22961 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22962 &_.forward_& file, the command runs under the uid and gid of that user. In
22963 other cases, the uid and gid have to be specified explicitly, either on the
22964 transport or on the router that handles the address. Current and &"home"&
22965 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22966 details of the local delivery environment and chapter &<<CHAPbatching>>&
22967 for a discussion of local delivery batching.
22968
22969
22970 .section "Concurrent delivery" "SECID140"
22971 If two messages arrive at almost the same time, and both are routed to a pipe
22972 delivery, the two pipe transports may be run concurrently. You must ensure that
22973 any pipe commands you set up are robust against this happening. If the commands
22974 write to a file, the &%exim_lock%& utility might be of use.
22975 Alternatively the &%max_parallel%& option could be used with a value
22976 of "1" to enforce serialization.
22977
22978
22979
22980
22981 .section "Returned status and data" "SECID141"
22982 .cindex "&(pipe)& transport" "returned data"
22983 If the command exits with a non-zero return code, the delivery is deemed to
22984 have failed, unless either the &%ignore_status%& option is set (in which case
22985 the return code is treated as zero), or the return code is one of those listed
22986 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22987 later"&. In this case, delivery is deferred. Details of a permanent failure are
22988 logged, but are not included in the bounce message, which merely contains
22989 &"local delivery failed"&.
22990
22991 If the command exits on a signal and the &%freeze_signal%& option is set then
22992 the message will be frozen in the queue. If that option is not set, a bounce
22993 will be sent as normal.
22994
22995 If the return code is greater than 128 and the command being run is a shell
22996 script, it normally means that the script was terminated by a signal whose
22997 value is the return code minus 128. The &%freeze_signal%& option does not
22998 apply in this case.
22999
23000 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23001 return code is set to 127. This is the value that a shell returns if it is
23002 asked to run a non-existent command. The wording for the log line suggests that
23003 a non-existent command may be the problem.
23004
23005 The &%return_output%& option can affect the result of a pipe delivery. If it is
23006 set and the command produces any output on its standard output or standard
23007 error streams, the command is considered to have failed, even if it gave a zero
23008 return code or if &%ignore_status%& is set. The output from the command is
23009 included as part of the bounce message. The &%return_fail_output%& option is
23010 similar, except that output is returned only when the command exits with a
23011 failure return code, that is, a value other than zero or a code that matches
23012 &%temp_errors%&.
23013
23014
23015
23016 .section "How the command is run" "SECThowcommandrun"
23017 .cindex "&(pipe)& transport" "path for command"
23018 The command line is (by default) broken down into a command name and arguments
23019 by the &(pipe)& transport itself. The &%allow_commands%& and
23020 &%restrict_to_path%& options can be used to restrict the commands that may be
23021 run.
23022
23023 .cindex "quoting" "in pipe command"
23024 Unquoted arguments are delimited by white space. If an argument appears in
23025 double quotes, backslash is interpreted as an escape character in the usual
23026 way. If an argument appears in single quotes, no escaping is done.
23027
23028 String expansion is applied to the command line except when it comes from a
23029 traditional &_.forward_& file (commands from a filter file are expanded). The
23030 expansion is applied to each argument in turn rather than to the whole line.
23031 For this reason, any string expansion item that contains white space must be
23032 quoted so as to be contained within a single argument. A setting such as
23033 .code
23034 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23035 .endd
23036 will not work, because the expansion item gets split between several
23037 arguments. You have to write
23038 .code
23039 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23040 .endd
23041 to ensure that it is all in one argument. The expansion is done in this way,
23042 argument by argument, so that the number of arguments cannot be changed as a
23043 result of expansion, and quotes or backslashes in inserted variables do not
23044 interact with external quoting. However, this leads to problems if you want to
23045 generate multiple arguments (or the command name plus arguments) from a single
23046 expansion. In this situation, the simplest solution is to use a shell. For
23047 example:
23048 .code
23049 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23050 .endd
23051
23052 .cindex "transport" "filter"
23053 .cindex "filter" "transport filter"
23054 .vindex "&$pipe_addresses$&"
23055 Special handling takes place when an argument consists of precisely the text
23056 &`$pipe_addresses`&. This is not a general expansion variable; the only
23057 place this string is recognized is when it appears as an argument for a pipe or
23058 transport filter command. It causes each address that is being handled to be
23059 inserted in the argument list at that point &'as a separate argument'&. This
23060 avoids any problems with spaces or shell metacharacters, and is of use when a
23061 &(pipe)& transport is handling groups of addresses in a batch.
23062
23063 If &%force_command%& is enabled on the transport, Special handling takes place
23064 for an argument that consists of precisely the text &`$address_pipe`&.  It
23065 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23066 argument is inserted in the argument list at that point
23067 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23068 the only item in the argument; in fact, if it were then &%force_command%&
23069 should behave as a no-op.  Rather, it should be used to adjust the command
23070 run while preserving the argument vector separation.
23071
23072 After splitting up into arguments and expansion, the resulting command is run
23073 in a subprocess directly from the transport, &'not'& under a shell. The
23074 message that is being delivered is supplied on the standard input, and the
23075 standard output and standard error are both connected to a single pipe that is
23076 read by Exim. The &%max_output%& option controls how much output the command
23077 may produce, and the &%return_output%& and &%return_fail_output%& options
23078 control what is done with it.
23079
23080 Not running the command under a shell (by default) lessens the security risks
23081 in cases when a command from a user's filter file is built out of data that was
23082 taken from an incoming message. If a shell is required, it can of course be
23083 explicitly specified as the command to be run. However, there are circumstances
23084 where existing commands (for example, in &_.forward_& files) expect to be run
23085 under a shell and cannot easily be modified. To allow for these cases, there is
23086 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23087 works. Instead of breaking up the command line as just described, it expands it
23088 as a single string and passes the result to &_/bin/sh_&. The
23089 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23090 with &%use_shell%&, and the whole mechanism is inherently less secure.
23091
23092
23093
23094 .section "Environment variables" "SECTpipeenv"
23095 .cindex "&(pipe)& transport" "environment for command"
23096 .cindex "environment" "&(pipe)& transport"
23097 The environment variables listed below are set up when the command is invoked.
23098 This list is a compromise for maximum compatibility with other MTAs. Note that
23099 the &%environment%& option can be used to add additional variables to this
23100 environment. The environment for the &(pipe)& transport is not subject
23101 to the &%add_environment%& and &%keep_environment%& main config options.
23102 .display
23103 &`DOMAIN            `&   the domain of the address
23104 &`HOME              `&   the home directory, if set
23105 &`HOST              `&   the host name when called from a router (see below)
23106 &`LOCAL_PART        `&   see below
23107 &`LOCAL_PART_PREFIX `&   see below
23108 &`LOCAL_PART_SUFFIX `&   see below
23109 &`LOGNAME           `&   see below
23110 &`MESSAGE_ID        `&   Exim's local ID for the message
23111 &`PATH              `&   as specified by the &%path%& option below
23112 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23113 &`RECIPIENT         `&   the complete recipient address
23114 &`SENDER            `&   the sender of the message (empty if a bounce)
23115 &`SHELL             `&   &`/bin/sh`&
23116 &`TZ                `&   the value of the &%timezone%& option, if set
23117 &`USER              `&   see below
23118 .endd
23119 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23120 router, LOCAL_PART is set to the local part of the address. When it is
23121 called as a result of a forward or alias expansion, LOCAL_PART is set to
23122 the local part of the address that was expanded. In both cases, any affixes are
23123 removed from the local part, and made available in LOCAL_PART_PREFIX and
23124 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23125 same value as LOCAL_PART for compatibility with other MTAs.
23126
23127 .cindex "HOST"
23128 HOST is set only when a &(pipe)& transport is called from a router that
23129 associates hosts with an address, typically when using &(pipe)& as a
23130 pseudo-remote transport. HOST is set to the first host name specified by
23131 the router.
23132
23133 .cindex "HOME"
23134 If the transport's generic &%home_directory%& option is set, its value is used
23135 for the HOME environment variable. Otherwise, a home directory may be set
23136 by the router's &%transport_home_directory%& option, which defaults to the
23137 user's home directory if &%check_local_user%& is set.
23138
23139
23140 .section "Private options for pipe" "SECID142"
23141 .cindex "options" "&(pipe)& transport"
23142
23143
23144
23145 .option allow_commands pipe "string list&!!" unset
23146 .cindex "&(pipe)& transport" "permitted commands"
23147 The string is expanded, and is then interpreted as a colon-separated list of
23148 permitted commands. If &%restrict_to_path%& is not set, the only commands
23149 permitted are those in the &%allow_commands%& list. They need not be absolute
23150 paths; the &%path%& option is still used for relative paths. If
23151 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23152 in the &%allow_commands%& list, or a name without any slashes that is found on
23153 the path. In other words, if neither &%allow_commands%& nor
23154 &%restrict_to_path%& is set, there is no restriction on the command, but
23155 otherwise only commands that are permitted by one or the other are allowed. For
23156 example, if
23157 .code
23158 allow_commands = /usr/bin/vacation
23159 .endd
23160 and &%restrict_to_path%& is not set, the only permitted command is
23161 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23162 &%use_shell%& is set.
23163
23164
23165 .option batch_id pipe string&!! unset
23166 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23167
23168
23169 .option batch_max pipe integer 1
23170 This limits the number of addresses that can be handled in a single delivery.
23171 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23172
23173
23174 .option check_string pipe string unset
23175 As &(pipe)& writes the message, the start of each line is tested for matching
23176 &%check_string%&, and if it does, the initial matching characters are replaced
23177 by the contents of &%escape_string%&, provided both are set. The value of
23178 &%check_string%& is a literal string, not a regular expression, and the case of
23179 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23180 of &%check_string%& and &%escape_string%& are forced to values that implement
23181 the SMTP escaping protocol. Any settings made in the configuration file are
23182 ignored.
23183
23184
23185 .option command pipe string&!! unset
23186 This option need not be set when &(pipe)& is being used to deliver to pipes
23187 obtained directly from address redirections. In other cases, the option must be
23188 set, to provide a command to be run. It need not yield an absolute path (see
23189 the &%path%& option below). The command is split up into separate arguments by
23190 Exim, and each argument is separately expanded, as described in section
23191 &<<SECThowcommandrun>>& above.
23192
23193
23194 .option environment pipe string&!! unset
23195 .cindex "&(pipe)& transport" "environment for command"
23196 .cindex "environment" "&(pipe)& transport"
23197 This option is used to add additional variables to the environment in which the
23198 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23199 a string which is expanded, and then interpreted as a colon-separated list of
23200 environment settings of the form <&'name'&>=<&'value'&>.
23201
23202
23203 .option escape_string pipe string unset
23204 See &%check_string%& above.
23205
23206
23207 .option freeze_exec_fail pipe boolean false
23208 .cindex "exec failure"
23209 .cindex "failure of exec"
23210 .cindex "&(pipe)& transport" "failure of exec"
23211 Failure to exec the command in a pipe transport is by default treated like
23212 any other failure while running the command. However, if &%freeze_exec_fail%&
23213 is set, failure to exec is treated specially, and causes the message to be
23214 frozen, whatever the setting of &%ignore_status%&.
23215
23216
23217 .option freeze_signal pipe boolean false
23218 .cindex "signal exit"
23219 .cindex "&(pipe)& transport", "signal exit"
23220 Normally if the process run by a command in a pipe transport exits on a signal,
23221 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23222 frozen in Exim's queue instead.
23223
23224
23225 .option force_command pipe boolean false
23226 .cindex "force command"
23227 .cindex "&(pipe)& transport", "force command"
23228 Normally when a router redirects an address directly to a pipe command
23229 the &%command%& option on the transport is ignored.  If &%force_command%&
23230 is set, the &%command%& option will used. This is especially
23231 useful for forcing a wrapper or additional argument to be added to the
23232 command. For example:
23233 .code
23234 command = /usr/bin/remote_exec myhost -- $address_pipe
23235 force_command
23236 .endd
23237
23238 Note that &$address_pipe$& is handled specially in &%command%& when
23239 &%force_command%& is set, expanding out to the original argument vector as
23240 separate items, similarly to a Unix shell &`"$@"`& construct.
23241
23242
23243 .option ignore_status pipe boolean false
23244 If this option is true, the status returned by the subprocess that is set up to
23245 run the command is ignored, and Exim behaves as if zero had been returned.
23246 Otherwise, a non-zero status or termination by signal causes an error return
23247 from the transport unless the status value is one of those listed in
23248 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23249
23250 &*Note*&: This option does not apply to timeouts, which do not return a status.
23251 See the &%timeout_defer%& option for how timeouts are handled.
23252
23253
23254 .option log_defer_output pipe boolean false
23255 .cindex "&(pipe)& transport" "logging output"
23256 If this option is set, and the status returned by the command is
23257 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23258 and any output was produced on stdout or stderr, the first line of it is
23259 written to the main log.
23260
23261
23262 .option log_fail_output pipe boolean false
23263 If this option is set, and the command returns any output on stdout or
23264 stderr, and also ends with a return code that is neither zero nor one of
23265 the return codes listed in &%temp_errors%& (that is, the delivery
23266 failed), the first line of output is written to the main log. This
23267 option and &%log_output%& are mutually exclusive.  Only one of them may
23268 be set.
23269
23270
23271 .option log_output pipe boolean false
23272 If this option is set and the command returns any output on stdout or
23273 stderr, the first line of output is written to the main log, whatever
23274 the return code. This option and &%log_fail_output%& are mutually
23275 exclusive. Only one of them may be set.
23276
23277
23278 .option max_output pipe integer 20K
23279 This specifies the maximum amount of output that the command may produce on its
23280 standard output and standard error file combined. If the limit is exceeded, the
23281 process running the command is killed. This is intended as a safety measure to
23282 catch runaway processes. The limit is applied independently of the settings of
23283 the options that control what is done with such output (for example,
23284 &%return_output%&). Because of buffering effects, the amount of output may
23285 exceed the limit by a small amount before Exim notices.
23286
23287
23288 .option message_prefix pipe string&!! "see below"
23289 The string specified here is expanded and output at the start of every message.
23290 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23291 .code
23292 message_prefix = \
23293   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23294   ${tod_bsdinbox}\n
23295 .endd
23296 .cindex "Cyrus"
23297 .cindex "&%tmail%&"
23298 .cindex "&""From""& line"
23299 This is required by the commonly used &_/usr/bin/vacation_& program.
23300 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23301 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23302 setting
23303 .code
23304 message_prefix =
23305 .endd
23306 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23307 &`\n`& to &`\r\n`& in &%message_prefix%&.
23308
23309
23310 .option message_suffix pipe string&!! "see below"
23311 The string specified here is expanded and output at the end of every message.
23312 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23313 The suffix can be suppressed by setting
23314 .code
23315 message_suffix =
23316 .endd
23317 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23318 &`\n`& to &`\r\n`& in &%message_suffix%&.
23319
23320
23321 .option path pipe string&!! "/bin:/usr/bin"
23322 This option is expanded and
23323 specifies the string that is set up in the PATH environment
23324 variable of the subprocess.
23325 If the &%command%& option does not yield an absolute path name, the command is
23326 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23327 apply to a command specified as a transport filter.
23328
23329
23330 .option permit_coredump pipe boolean false
23331 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23332 a core-dump of a pipe command, enable this command.  This enables core-dumps
23333 during delivery and affects both the Exim binary and the pipe command run.
23334 It is recommended that this option remain off unless and until you have a need
23335 for it and that this only be enabled when needed, as the risk of excessive
23336 resource consumption can be quite high.  Note also that Exim is typically
23337 installed as a setuid binary and most operating systems will inhibit coredumps
23338 of these by default, so further OS-specific action may be required.
23339
23340
23341 .option pipe_as_creator pipe boolean false
23342 .cindex "uid (user id)" "local delivery"
23343 If the generic &%user%& option is not set and this option is true, the delivery
23344 process is run under the uid that was in force when Exim was originally called
23345 to accept the message. If the group id is not otherwise set (via the generic
23346 &%group%& option), the gid that was in force when Exim was originally called to
23347 accept the message is used.
23348
23349
23350 .option restrict_to_path pipe boolean false
23351 When this option is set, any command name not listed in &%allow_commands%& must
23352 contain no slashes. The command is searched for only in the directories listed
23353 in the &%path%& option. This option is intended for use in the case when a pipe
23354 command has been generated from a user's &_.forward_& file. This is usually
23355 handled by a &(pipe)& transport called &%address_pipe%&.
23356
23357
23358 .option return_fail_output pipe boolean false
23359 If this option is true, and the command produced any output and ended with a
23360 return code other than zero or one of the codes listed in &%temp_errors%& (that
23361 is, the delivery failed), the output is returned in the bounce message.
23362 However, if the message has a null sender (that is, it is itself a bounce
23363 message), output from the command is discarded. This option and
23364 &%return_output%& are mutually exclusive. Only one of them may be set.
23365
23366
23367
23368 .option return_output pipe boolean false
23369 If this option is true, and the command produced any output, the delivery is
23370 deemed to have failed whatever the return code from the command, and the output
23371 is returned in the bounce message. Otherwise, the output is just discarded.
23372 However, if the message has a null sender (that is, it is a bounce message),
23373 output from the command is always discarded, whatever the setting of this
23374 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23375 of them may be set.
23376
23377
23378
23379 .option temp_errors pipe "string list" "see below"
23380 .cindex "&(pipe)& transport" "temporary failure"
23381 This option contains either a colon-separated list of numbers, or a single
23382 asterisk. If &%ignore_status%& is false
23383 and &%return_output%& is not set,
23384 and the command exits with a non-zero return code, the failure is treated as
23385 temporary and the delivery is deferred if the return code matches one of the
23386 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23387 codes are treated as permanent errors. The default setting contains the codes
23388 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23389 compiled on a system that does not define these macros, it assumes values of 75
23390 and 73, respectively.
23391
23392
23393 .option timeout pipe time 1h
23394 If the command fails to complete within this time, it is killed. This normally
23395 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23396 specifies no timeout. In order to ensure that any subprocesses created by the
23397 command are also killed, Exim makes the initial process a process group leader,
23398 and kills the whole process group on a timeout. However, this can be defeated
23399 if one of the processes starts a new process group.
23400
23401 .option timeout_defer pipe boolean false
23402 A timeout in a &(pipe)& transport, either in the command that the transport
23403 runs, or in a transport filter that is associated with it, is by default
23404 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23405 is set true, both kinds of timeout become temporary errors, causing the
23406 delivery to be deferred.
23407
23408 .option umask pipe "octal integer" 022
23409 This specifies the umask setting for the subprocess that runs the command.
23410
23411
23412 .option use_bsmtp pipe boolean false
23413 .cindex "envelope sender"
23414 If this option is set true, the &(pipe)& transport writes messages in &"batch
23415 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23416 commands. If you want to include a leading HELO command with such messages,
23417 you can do so by setting the &%message_prefix%& option. See section
23418 &<<SECTbatchSMTP>>& for details of batch SMTP.
23419
23420 .option use_classresources pipe boolean false
23421 .cindex "class resources (BSD)"
23422 This option is available only when Exim is running on FreeBSD, NetBSD, or
23423 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23424 resource limits when a &(pipe)& transport is run to perform a delivery. The
23425 limits for the uid under which the pipe is to run are obtained from the login
23426 class database.
23427
23428
23429 .option use_crlf pipe boolean false
23430 .cindex "carriage return"
23431 .cindex "linefeed"
23432 This option causes lines to be terminated with the two-character CRLF sequence
23433 (carriage return, linefeed) instead of just a linefeed character. In the case
23434 of batched SMTP, the byte sequence written to the pipe is then an exact image
23435 of what would be sent down a real SMTP connection.
23436
23437 The contents of the &%message_prefix%& and &%message_suffix%& options are
23438 written verbatim, so must contain their own carriage return characters if these
23439 are needed. When &%use_bsmtp%& is not set, the default values for both
23440 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23441 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23442
23443
23444 .option use_shell pipe boolean false
23445 .vindex "&$pipe_addresses$&"
23446 If this option is set, it causes the command to be passed to &_/bin/sh_&
23447 instead of being run directly from the transport, as described in section
23448 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23449 where the command is expected to be run under a shell and cannot easily be
23450 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23451 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23452 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23453 its &%-c%& option.
23454
23455
23456
23457 .section "Using an external local delivery agent" "SECID143"
23458 .cindex "local delivery" "using an external agent"
23459 .cindex "&'procmail'&"
23460 .cindex "external local delivery"
23461 .cindex "delivery" "&'procmail'&"
23462 .cindex "delivery" "by external agent"
23463 The &(pipe)& transport can be used to pass all messages that require local
23464 delivery to a separate local delivery agent such as &%procmail%&. When doing
23465 this, care must be taken to ensure that the pipe is run under an appropriate
23466 uid and gid. In some configurations one wants this to be a uid that is trusted
23467 by the delivery agent to supply the correct sender of the message. It may be
23468 necessary to recompile or reconfigure the delivery agent so that it trusts an
23469 appropriate user. The following is an example transport and router
23470 configuration for &%procmail%&:
23471 .code
23472 # transport
23473 procmail_pipe:
23474   driver = pipe
23475   command = /usr/local/bin/procmail -d $local_part
23476   return_path_add
23477   delivery_date_add
23478   envelope_to_add
23479   check_string = "From "
23480   escape_string = ">From "
23481   umask = 077
23482   user = $local_part
23483   group = mail
23484
23485 # router
23486 procmail:
23487   driver = accept
23488   check_local_user
23489   transport = procmail_pipe
23490 .endd
23491 In this example, the pipe is run as the local user, but with the group set to
23492 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23493 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23494 user to supply a correct sender address. If you do not specify either a
23495 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23496 home directory is the user's home directory by default.
23497
23498 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23499 .code
23500 IFS=" "
23501 .endd
23502 as shown in some &%procmail%& documentation, because Exim does not by default
23503 use a shell to run pipe commands.
23504
23505 .cindex "Cyrus"
23506 The next example shows a transport and a router for a system where local
23507 deliveries are handled by the Cyrus IMAP server.
23508 .code
23509 # transport
23510 local_delivery_cyrus:
23511   driver = pipe
23512   command = /usr/cyrus/bin/deliver \
23513             -m ${substr_1:$local_part_suffix} -- $local_part
23514   user = cyrus
23515   group = mail
23516   return_output
23517   log_output
23518   message_prefix =
23519   message_suffix =
23520
23521 # router
23522 local_user_cyrus:
23523   driver = accept
23524   check_local_user
23525   local_part_suffix = .*
23526   transport = local_delivery_cyrus
23527 .endd
23528 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23529 &%return_output%& to cause any text written by Cyrus to be returned to the
23530 sender.
23531 .ecindex IIDpiptra1
23532 .ecindex IIDpiptra2
23533
23534
23535 . ////////////////////////////////////////////////////////////////////////////
23536 . ////////////////////////////////////////////////////////////////////////////
23537
23538 .chapter "The smtp transport" "CHAPsmtptrans"
23539 .scindex IIDsmttra1 "transports" "&(smtp)&"
23540 .scindex IIDsmttra2 "&(smtp)& transport"
23541 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23542 or LMTP protocol. The list of hosts to try can either be taken from the address
23543 that is being processed (having been set up by the router), or specified
23544 explicitly for the transport. Timeout and retry processing (see chapter
23545 &<<CHAPretry>>&) is applied to each IP address independently.
23546
23547
23548 .section "Multiple messages on a single connection" "SECID144"
23549 The sending of multiple messages over a single TCP/IP connection can arise in
23550 two ways:
23551
23552 .ilist
23553 If a message contains more than &%max_rcpt%& (see below) addresses that are
23554 routed to the same host, more than one copy of the message has to be sent to
23555 that host. In this situation, multiple copies may be sent in a single run of
23556 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23557 does when it has too many addresses to send in one message also depends on the
23558 value of the global &%remote_max_parallel%& option. Details are given in
23559 section &<<SECToutSMTPTCP>>&.)
23560 .next
23561 .cindex "hints database" "remembering routing"
23562 When a message has been successfully delivered over a TCP/IP connection, Exim
23563 looks in its hints database to see if there are any other messages awaiting a
23564 connection to the same host. If there are, a new delivery process is started
23565 for one of them, and the current TCP/IP connection is passed on to it. The new
23566 process may in turn send multiple copies and possibly create yet another
23567 process.
23568 .endlist
23569
23570
23571 For each copy sent over the same TCP/IP connection, a sequence counter is
23572 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23573 no further messages are sent over that connection.
23574
23575
23576
23577 .section "Use of the $host and $host_address variables" "SECID145"
23578 .vindex "&$host$&"
23579 .vindex "&$host_address$&"
23580 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23581 &$host_address$& are the name and IP address of the first host on the host list
23582 passed by the router. However, when the transport is about to connect to a
23583 specific host, and while it is connected to that host, &$host$& and
23584 &$host_address$& are set to the values for that host. These are the values
23585 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23586 &%serialize_hosts%&, and the various TLS options are expanded.
23587
23588
23589 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23590 .vindex &$tls_bits$&
23591 .vindex &$tls_cipher$&
23592 .vindex &$tls_peerdn$&
23593 .vindex &$tls_sni$&
23594 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23595 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23596 are the values that were set when the message was received.
23597 These are the values that are used for options that are expanded before any
23598 SMTP connections are made. Just before each connection is made, these four
23599 variables are emptied. If TLS is subsequently started, they are set to the
23600 appropriate values for the outgoing connection, and these are the values that
23601 are in force when any authenticators are run and when the
23602 &%authenticated_sender%& option is expanded.
23603
23604 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23605 and will be removed in a future release.
23606
23607
23608 .section "Private options for smtp" "SECID146"
23609 .cindex "options" "&(smtp)& transport"
23610 The private options of the &(smtp)& transport are as follows:
23611
23612
23613 .option address_retry_include_sender smtp boolean true
23614 .cindex "4&'xx'& responses" "retrying after"
23615 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23616 is the combination of sender and recipient that is delayed in subsequent queue
23617 runs until the retry time is reached. You can delay the recipient without
23618 reference to the sender (which is what earlier versions of Exim did), by
23619 setting &%address_retry_include_sender%& false. However, this can lead to
23620 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23621
23622 .option allow_localhost smtp boolean false
23623 .cindex "local host" "sending to"
23624 .cindex "fallback" "hosts specified on transport"
23625 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23626 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23627 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23628 the delivery anyway. This should be used only in special cases when the
23629 configuration ensures that no looping will result (for example, a differently
23630 configured Exim is listening on the port to which the message is sent).
23631
23632
23633 .option authenticated_sender smtp string&!! unset
23634 .cindex "Cyrus"
23635 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23636 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23637 overriding any existing authenticated sender value. If the string expansion is
23638 forced to fail, the option is ignored. Other expansion failures cause delivery
23639 to be deferred. If the result of expansion is an empty string, that is also
23640 ignored.
23641
23642 The expansion happens after the outgoing connection has been made and TLS
23643 started, if required. This means that the &$host$&, &$host_address$&,
23644 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23645 particular connection.
23646
23647 If the SMTP session is not authenticated, the expansion of
23648 &%authenticated_sender%& still happens (and can cause the delivery to be
23649 deferred if it fails), but no AUTH= item is added to MAIL commands
23650 unless &%authenticated_sender_force%& is true.
23651
23652 This option allows you to use the &(smtp)& transport in LMTP mode to
23653 deliver mail to Cyrus IMAP and provide the proper local part as the
23654 &"authenticated sender"&, via a setting such as:
23655 .code
23656 authenticated_sender = $local_part
23657 .endd
23658 This removes the need for IMAP subfolders to be assigned special ACLs to
23659 allow direct delivery to those subfolders.
23660
23661 Because of expected uses such as that just described for Cyrus (when no
23662 domain is involved), there is no checking on the syntax of the provided
23663 value.
23664
23665
23666 .option authenticated_sender_force smtp boolean false
23667 If this option is set true, the &%authenticated_sender%& option's value
23668 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23669 authenticated as a client.
23670
23671
23672 .option command_timeout smtp time 5m
23673 This sets a timeout for receiving a response to an SMTP command that has been
23674 sent out. It is also used when waiting for the initial banner line from the
23675 remote host. Its value must not be zero.
23676
23677
23678 .option connect_timeout smtp time 5m
23679 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23680 to a remote host. A setting of zero allows the system timeout (typically
23681 several minutes) to act. To have any effect, the value of this option must be
23682 less than the system timeout. However, it has been observed that on some
23683 systems there is no system timeout, which is why the default value for this
23684 option is 5 minutes, a value recommended by RFC 1123.
23685
23686
23687 .option connection_max_messages smtp integer 500
23688 .cindex "SMTP" "passed connection"
23689 .cindex "SMTP" "multiple deliveries"
23690 .cindex "multiple SMTP deliveries"
23691 This controls the maximum number of separate message deliveries that are sent
23692 over a single TCP/IP connection. If the value is zero, there is no limit.
23693 For testing purposes, this value can be overridden by the &%-oB%& command line
23694 option.
23695
23696
23697 .option data_timeout smtp time 5m
23698 This sets a timeout for the transmission of each block in the data portion of
23699 the message. As a result, the overall timeout for a message depends on the size
23700 of the message. Its value must not be zero. See also &%final_timeout%&.
23701
23702
23703 .option dkim_domain smtp string&!! unset
23704 .option dkim_selector smtp string&!! unset
23705 .option dkim_private_key smtp string&!! unset
23706 .option dkim_canon smtp string&!! unset
23707 .option dkim_strict smtp string&!! unset
23708 .option dkim_sign_headers smtp string&!! unset
23709 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
23710
23711
23712 .option delay_after_cutoff smtp boolean true
23713 This option controls what happens when all remote IP addresses for a given
23714 domain have been inaccessible for so long that they have passed their retry
23715 cutoff times.
23716
23717 In the default state, if the next retry time has not been reached for any of
23718 them, the address is bounced without trying any deliveries. In other words,
23719 Exim delays retrying an IP address after the final cutoff time until a new
23720 retry time is reached, and can therefore bounce an address without ever trying
23721 a delivery, when machines have been down for a long time. Some people are
23722 unhappy at this prospect, so...
23723
23724 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23725 addresses are past their final cutoff time, Exim tries to deliver to those
23726 IP addresses that have not been tried since the message arrived. If there are
23727 none, of if they all fail, the address is bounced. In other words, it does not
23728 delay when a new message arrives, but immediately tries those expired IP
23729 addresses that haven't been tried since the message arrived. If there is a
23730 continuous stream of messages for the dead hosts, unsetting
23731 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23732 to them.
23733
23734
23735 .option dns_qualify_single smtp boolean true
23736 If the &%hosts%& or &%fallback_hosts%& option is being used,
23737 and the &%gethostbyname%& option is false,
23738 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23739 in chapter &<<CHAPdnslookup>>& for more details.
23740
23741
23742 .option dns_search_parents smtp boolean false
23743 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23744 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23745 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23746 details.
23747
23748
23749 .option dnssec_request_domains smtp "domain list&!!" unset
23750 .cindex "MX record" "security"
23751 .cindex "DNSSEC" "MX lookup"
23752 .cindex "security" "MX lookup"
23753 .cindex "DNS" "DNSSEC"
23754 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23755 the dnssec request bit set.
23756 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23757
23758
23759
23760 .option dnssec_require_domains smtp "domain list&!!" unset
23761 .cindex "MX record" "security"
23762 .cindex "DNSSEC" "MX lookup"
23763 .cindex "security" "MX lookup"
23764 .cindex "DNS" "DNSSEC"
23765 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
23766 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23767 (AD bit) set will be ignored and logged as a host-lookup failure.
23768 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23769
23770
23771
23772 .option dscp smtp string&!! unset
23773 .cindex "DCSP" "outbound"
23774 This option causes the DSCP value associated with a socket to be set to one
23775 of a number of fixed strings or to numeric value.
23776 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23777 Common values include &`throughput`&, &`mincost`&, and on newer systems
23778 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23779
23780 The outbound packets from Exim will be marked with this value in the header
23781 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23782 that these values will have any effect, not be stripped by networking
23783 equipment, or do much of anything without cooperation with your Network
23784 Engineer and those of all network operators between the source and destination.
23785
23786
23787 .option fallback_hosts smtp "string list" unset
23788 .cindex "fallback" "hosts specified on transport"
23789 String expansion is not applied to this option. The argument must be a
23790 colon-separated list of host names or IP addresses, optionally also including
23791 port numbers, though the separator can be changed, as described in section
23792 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23793 item in a &%route_list%& setting for the &(manualroute)& router, as described
23794 in section &<<SECTformatonehostitem>>&.
23795
23796 Fallback hosts can also be specified on routers, which associate them with the
23797 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23798 &%fallback_hosts%& specified on the transport is used only if the address does
23799 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23800 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23801 However, &%hosts_randomize%& does apply to fallback host lists.
23802
23803 If Exim is unable to deliver to any of the hosts for a particular address, and
23804 the errors are not permanent rejections, the address is put on a separate
23805 transport queue with its host list replaced by the fallback hosts, unless the
23806 address was routed via MX records and the current host was in the original MX
23807 list. In that situation, the fallback host list is not used.
23808
23809 Once normal deliveries are complete, the fallback queue is delivered by
23810 re-running the same transports with the new host lists. If several failing
23811 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23812 copy of the message is sent.
23813
23814 The resolution of the host names on the fallback list is controlled by the
23815 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23816 both to cases when the host list comes with the address and when it is taken
23817 from &%hosts%&. This option provides a &"use a smart host only if delivery
23818 fails"& facility.
23819
23820
23821 .option final_timeout smtp time 10m
23822 This is the timeout that applies while waiting for the response to the final
23823 line containing just &"."& that terminates a message. Its value must not be
23824 zero.
23825
23826 .option gethostbyname smtp boolean false
23827 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23828 being used, names are looked up using &[gethostbyname()]&
23829 (or &[getipnodebyname()]& when available)
23830 instead of using the DNS. Of course, that function may in fact use the DNS, but
23831 it may also consult other sources of information such as &_/etc/hosts_&.
23832
23833 .option gnutls_compat_mode smtp boolean unset
23834 This option controls whether GnuTLS is used in compatibility mode in an Exim
23835 server. This reduces security slightly, but improves interworking with older
23836 implementations of TLS.
23837
23838 .option helo_data smtp string&!! "see below"
23839 .cindex "HELO" "argument, setting"
23840 .cindex "EHLO" "argument, setting"
23841 .cindex "LHLO argument setting"
23842 The value of this option is expanded after a connection to a another host has
23843 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23844 command that starts the outgoing SMTP or LMTP session. The default value of the
23845 option is:
23846 .code
23847 $primary_hostname
23848 .endd
23849 During the expansion, the variables &$host$& and &$host_address$& are set to
23850 the identity of the remote host, and the variables &$sending_ip_address$& and
23851 &$sending_port$& are set to the local IP address and port number that are being
23852 used. These variables can be used to generate different values for different
23853 servers or different local IP addresses. For example, if you want the string
23854 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23855 interface address, you could use this:
23856 .code
23857 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23858   {$primary_hostname}}
23859 .endd
23860 The use of &%helo_data%& applies both to sending messages and when doing
23861 callouts.
23862
23863 .option hosts smtp "string list&!!" unset
23864 Hosts are associated with an address by a router such as &(dnslookup)&, which
23865 finds the hosts by looking up the address domain in the DNS, or by
23866 &(manualroute)&, which has lists of hosts in its configuration. However,
23867 email addresses can be passed to the &(smtp)& transport by any router, and not
23868 all of them can provide an associated list of hosts.
23869
23870 The &%hosts%& option specifies a list of hosts to be used if the address being
23871 processed does not have any hosts associated with it. The hosts specified by
23872 &%hosts%& are also used, whether or not the address has its own hosts, if
23873 &%hosts_override%& is set.
23874
23875 The string is first expanded, before being interpreted as a colon-separated
23876 list of host names or IP addresses, possibly including port numbers. The
23877 separator may be changed to something other than colon, as described in section
23878 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23879 item in a &%route_list%& setting for the &(manualroute)& router, as described
23880 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23881 of the &(manualroute)& router is not available here.
23882
23883 If the expansion fails, delivery is deferred. Unless the failure was caused by
23884 the inability to complete a lookup, the error is logged to the panic log as
23885 well as the main log. Host names are looked up either by searching directly for
23886 address records in the DNS or by calling &[gethostbyname()]& (or
23887 &[getipnodebyname()]& when available), depending on the setting of the
23888 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23889 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23890 address are used.
23891
23892 During delivery, the hosts are tried in order, subject to their retry status,
23893 unless &%hosts_randomize%& is set.
23894
23895
23896 .option hosts_avoid_esmtp smtp "host list&!!" unset
23897 .cindex "ESMTP, avoiding use of"
23898 .cindex "HELO" "forcing use of"
23899 .cindex "EHLO" "avoiding use of"
23900 .cindex "PIPELINING" "avoiding the use of"
23901 This option is for use with broken hosts that announce ESMTP facilities (for
23902 example, PIPELINING) and then fail to implement them properly. When a host
23903 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23904 start of the SMTP session. This means that it cannot use any of the ESMTP
23905 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23906
23907
23908 .option hosts_avoid_pipelining smtp "host list&!!" unset
23909 .cindex "PIPELINING" "avoiding the use of"
23910 Exim will not use the SMTP PIPELINING extension when delivering to any host
23911 that matches this list, even if the server host advertises PIPELINING support.
23912
23913
23914 .option hosts_avoid_tls smtp "host list&!!" unset
23915 .cindex "TLS" "avoiding for certain hosts"
23916 Exim will not try to start a TLS session when delivering to any host that
23917 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23918
23919 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23920 .cindex "TLS" "avoiding for certain hosts"
23921 Exim will not try to start a TLS session for a verify callout,
23922 or when delivering in cutthrough mode,
23923 to any host that matches this list.
23924
23925
23926 .option hosts_max_try smtp integer 5
23927 .cindex "host" "maximum number to try"
23928 .cindex "limit" "number of hosts tried"
23929 .cindex "limit" "number of MX tried"
23930 .cindex "MX record" "maximum tried"
23931 This option limits the number of IP addresses that are tried for any one
23932 delivery in cases where there are temporary delivery errors. Section
23933 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23934
23935
23936 .option hosts_max_try_hardlimit smtp integer 50
23937 This is an additional check on the maximum number of IP addresses that Exim
23938 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23939 why it exists.
23940
23941
23942
23943 .option hosts_nopass_tls smtp "host list&!!" unset
23944 .cindex "TLS" "passing connection"
23945 .cindex "multiple SMTP deliveries"
23946 .cindex "TLS" "multiple message deliveries"
23947 For any host that matches this list, a connection on which a TLS session has
23948 been started will not be passed to a new delivery process for sending another
23949 message on the same connection. See section &<<SECTmulmessam>>& for an
23950 explanation of when this might be needed.
23951
23952 .new
23953 .option hosts_noproxy_tls smtp "host list&!!" *
23954 .cindex "TLS" "passing connection"
23955 .cindex "multiple SMTP deliveries"
23956 .cindex "TLS" "multiple message deliveries"
23957 For any host that matches this list, a TLS session which has
23958 been started will not be passed to a new delivery process for sending another
23959 message on the same session.
23960
23961 The traditional implementation closes down TLS and re-starts it in the new
23962 process, on the same open TCP connection, for each successive message
23963 sent.  If permitted by this option a pipe to to the new process is set up
23964 instead, and the original process maintains the TLS connection and proxies
23965 the SMTP connection from and to the new process and any subsequents.
23966 The new process has no access to TLS information, so cannot include it in
23967 logging.
23968 .wen
23969
23970
23971
23972 .option hosts_override smtp boolean false
23973 If this option is set and the &%hosts%& option is also set, any hosts that are
23974 attached to the address are ignored, and instead the hosts specified by the
23975 &%hosts%& option are always used. This option does not apply to
23976 &%fallback_hosts%&.
23977
23978
23979 .option hosts_randomize smtp boolean false
23980 .cindex "randomized host list"
23981 .cindex "host" "list of; randomized"
23982 .cindex "fallback" "randomized hosts"
23983 If this option is set, and either the list of hosts is taken from the
23984 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23985 were not obtained from MX records (this includes fallback hosts from the
23986 router), and were not randomized by the router, the order of trying the hosts
23987 is randomized each time the transport runs. Randomizing the order of a host
23988 list can be used to do crude load sharing.
23989
23990 When &%hosts_randomize%& is true, a host list may be split into groups whose
23991 order is separately randomized. This makes it possible to set up MX-like
23992 behaviour. The boundaries between groups are indicated by an item that is just
23993 &`+`& in the host list. For example:
23994 .code
23995 hosts = host1:host2:host3:+:host4:host5
23996 .endd
23997 The order of the first three hosts and the order of the last two hosts is
23998 randomized for each use, but the first three always end up before the last two.
23999 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24000
24001 .option hosts_require_auth smtp "host list&!!" unset
24002 .cindex "authentication" "required by client"
24003 This option provides a list of servers for which authentication must succeed
24004 before Exim will try to transfer a message. If authentication fails for
24005 servers which are not in this list, Exim tries to send unauthenticated. If
24006 authentication fails for one of these servers, delivery is deferred. This
24007 temporary error is detectable in the retry rules, so it can be turned into a
24008 hard failure if required. See also &%hosts_try_auth%&, and chapter
24009 &<<CHAPSMTPAUTH>>& for details of authentication.
24010
24011
24012 .option hosts_request_ocsp smtp "host list&!!" *
24013 .cindex "TLS" "requiring for certain servers"
24014 Exim will request a Certificate Status on a
24015 TLS session for any host that matches this list.
24016 &%tls_verify_certificates%& should also be set for the transport.
24017
24018 .option hosts_require_ocsp smtp "host list&!!" unset
24019 .cindex "TLS" "requiring for certain servers"
24020 Exim will request, and check for a valid Certificate Status being given, on a
24021 TLS session for any host that matches this list.
24022 &%tls_verify_certificates%& should also be set for the transport.
24023
24024 .option hosts_require_tls smtp "host list&!!" unset
24025 .cindex "TLS" "requiring for certain servers"
24026 Exim will insist on using a TLS session when delivering to any host that
24027 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24028 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24029 incoming messages, use an appropriate ACL.
24030
24031 .option hosts_try_auth smtp "host list&!!" unset
24032 .cindex "authentication" "optional in client"
24033 This option provides a list of servers to which, provided they announce
24034 authentication support, Exim will attempt to authenticate as a client when it
24035 connects. If authentication fails, Exim will try to transfer the message
24036 unauthenticated. See also &%hosts_require_auth%&, and chapter
24037 &<<CHAPSMTPAUTH>>& for details of authentication.
24038
24039 .option hosts_try_chunking smtp "host list&!!" *
24040 .cindex CHUNKING "enabling, in client"
24041 .cindex BDAT "SMTP command"
24042 .cindex "RFC 3030" "CHUNKING"
24043 This option provides a list of servers to which, provided they announce
24044 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24045 BDAT will not be used in conjunction with a transport filter.
24046
24047 .option hosts_try_fastopen smtp "host list!!" unset
24048 .cindex "fast open, TCP" "enabling, in client"
24049 .cindex "TCP Fast Open" "enabling, in client"
24050 .cindex "RFC 7413" "TCP Fast Open"
24051 This option provides a list of servers to which, provided
24052 the facility is supported by this system, Exim will attempt to
24053 perform a TCP Fast Open.
24054 No data is sent on the SYN segment but, if the remote server also
24055 supports the facility, it can send its SMTP banner immediately after
24056 the SYN,ACK segment.  This can save up to one round-trip time.
24057
24058 The facility is only active for previously-contacted servers,
24059 as the initiator must present a cookie in the SYN segment.
24060
24061 On (at least some) current Linux distributions the facility must be enabled
24062 in the kernel by the sysadmin before the support is usable.
24063
24064 .option hosts_try_prdr smtp "host list&!!" *
24065 .cindex "PRDR" "enabling, optional in client"
24066 This option provides a list of servers to which, provided they announce
24067 PRDR support, Exim will attempt to negotiate PRDR
24068 for multi-recipient messages.
24069 The option can usually be left as default.
24070
24071 .option interface smtp "string list&!!" unset
24072 .cindex "bind IP address"
24073 .cindex "IP address" "binding"
24074 .vindex "&$host$&"
24075 .vindex "&$host_address$&"
24076 This option specifies which interface to bind to when making an outgoing SMTP
24077 call. The value is an IP address, not an interface name such as
24078 &`eth0`&. Do not confuse this with the interface address that was used when a
24079 message was received, which is in &$received_ip_address$&, formerly known as
24080 &$interface_address$&. The name was changed to minimize confusion with the
24081 outgoing interface address. There is no variable that contains an outgoing
24082 interface address because, unless it is set by this option, its value is
24083 unknown.
24084
24085 During the expansion of the &%interface%& option the variables &$host$& and
24086 &$host_address$& refer to the host to which a connection is about to be made
24087 during the expansion of the string. Forced expansion failure, or an empty
24088 string result causes the option to be ignored. Otherwise, after expansion, the
24089 string must be a list of IP addresses, colon-separated by default, but the
24090 separator can be changed in the usual way. For example:
24091 .code
24092 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24093 .endd
24094 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24095 connection. If none of them are the correct type, the option is ignored. If
24096 &%interface%& is not set, or is ignored, the system's IP functions choose which
24097 interface to use if the host has more than one.
24098
24099
24100 .option keepalive smtp boolean true
24101 .cindex "keepalive" "on outgoing connection"
24102 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24103 connections. When set, it causes the kernel to probe idle connections
24104 periodically, by sending packets with &"old"& sequence numbers. The other end
24105 of the connection should send a acknowledgment if the connection is still okay
24106 or a reset if the connection has been aborted. The reason for doing this is
24107 that it has the beneficial effect of freeing up certain types of connection
24108 that can get stuck when the remote host is disconnected without tidying up the
24109 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24110 unreachable hosts.
24111
24112
24113 .option lmtp_ignore_quota smtp boolean false
24114 .cindex "LMTP" "ignoring quota errors"
24115 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24116 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24117 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24118
24119 .option max_rcpt smtp integer 100
24120 .cindex "RCPT" "maximum number of outgoing"
24121 This option limits the number of RCPT commands that are sent in a single
24122 SMTP message transaction. Each set of addresses is treated independently, and
24123 so can cause parallel connections to the same host if &%remote_max_parallel%&
24124 permits this.
24125
24126
24127 .option multi_domain smtp boolean&!! true
24128 .vindex "&$domain$&"
24129 When this option is set, the &(smtp)& transport can handle a number of
24130 addresses containing a mixture of different domains provided they all resolve
24131 to the same list of hosts. Turning the option off restricts the transport to
24132 handling only one domain at a time. This is useful if you want to use
24133 &$domain$& in an expansion for the transport, because it is set only when there
24134 is a single domain involved in a remote delivery.
24135
24136 It is expanded per-address and can depend on any of
24137 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24138 &$host$&, &$host_address$& and &$host_port$&.
24139
24140 .option port smtp string&!! "see below"
24141 .cindex "port" "sending TCP/IP"
24142 .cindex "TCP/IP" "setting outgoing port"
24143 This option specifies the TCP/IP port on the server to which Exim connects.
24144 &*Note:*& Do not confuse this with the port that was used when a message was
24145 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24146 The name was changed to minimize confusion with the outgoing port. There is no
24147 variable that contains an outgoing port.
24148
24149 If the value of this option begins with a digit it is taken as a port number;
24150 otherwise it is looked up using &[getservbyname()]&. The default value is
24151 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
24152 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
24153 is deferred.
24154
24155
24156
24157 .option protocol smtp string smtp
24158 .cindex "LMTP" "over TCP/IP"
24159 .cindex "ssmtp protocol" "outbound"
24160 .cindex "TLS" "SSL-on-connect outbound"
24161 .vindex "&$port$&"
24162 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24163 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24164 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24165 deliveries into closed message stores. Exim also has support for running LMTP
24166 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24167
24168 If this option is set to &"smtps"&, the default value for the &%port%& option
24169 changes to &"smtps"&, and the transport initiates TLS immediately after
24170 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24171 The Internet standards bodies strongly discourage use of this mode.
24172
24173
24174 .option retry_include_ip_address smtp boolean&!! true
24175 Exim normally includes both the host name and the IP address in the key it
24176 constructs for indexing retry data after a temporary delivery failure. This
24177 means that when one of several IP addresses for a host is failing, it gets
24178 tried periodically (controlled by the retry rules), but use of the other IP
24179 addresses is not affected.
24180
24181 However, in some dialup environments hosts are assigned a different IP address
24182 each time they connect. In this situation the use of the IP address as part of
24183 the retry key leads to undesirable behaviour. Setting this option false causes
24184 Exim to use only the host name.
24185 Since it is expanded it can be made to depend on the host or domain.
24186
24187
24188 .option serialize_hosts smtp "host list&!!" unset
24189 .cindex "serializing connections"
24190 .cindex "host" "serializing connections"
24191 Because Exim operates in a distributed manner, if several messages for the same
24192 host arrive at around the same time, more than one simultaneous connection to
24193 the remote host can occur. This is not usually a problem except when there is a
24194 slow link between the hosts. In that situation it may be helpful to restrict
24195 Exim to one connection at a time. This can be done by setting
24196 &%serialize_hosts%& to match the relevant hosts.
24197
24198 .cindex "hints database" "serializing deliveries to a host"
24199 Exim implements serialization by means of a hints database in which a record is
24200 written whenever a process connects to one of the restricted hosts. The record
24201 is deleted when the connection is completed. Obviously there is scope for
24202 records to get left lying around if there is a system or program crash. To
24203 guard against this, Exim ignores any records that are more than six hours old.
24204
24205 If you set up this kind of serialization, you should also arrange to delete the
24206 relevant hints database whenever your system reboots. The names of the files
24207 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24208 may be one or two files, depending on the type of DBM in use. The same files
24209 are used for ETRN serialization.
24210
24211 See also the &%max_parallel%& generic transport option.
24212
24213
24214 .option size_addition smtp integer 1024
24215 .cindex "SMTP" "SIZE"
24216 .cindex "message" "size issue for transport filter"
24217 .cindex "size" "of message"
24218 .cindex "transport" "filter"
24219 .cindex "filter" "transport filter"
24220 If a remote SMTP server indicates that it supports the SIZE option of the
24221 MAIL command, Exim uses this to pass over the message size at the start of
24222 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24223 sends, to allow for headers and other text that may be added during delivery by
24224 configuration options or in a transport filter. It may be necessary to increase
24225 this if a lot of text is added to messages.
24226
24227 Alternatively, if the value of &%size_addition%& is set negative, it disables
24228 the use of the SIZE option altogether.
24229
24230
24231 .option socks_proxy smtp string&!! unset
24232 .cindex proxy SOCKS
24233 This option enables use of SOCKS proxies for connections made by the
24234 transport.  For details see section &<<SECTproxySOCKS>>&.
24235
24236
24237 .option tls_certificate smtp string&!! unset
24238 .cindex "TLS" "client certificate, location of"
24239 .cindex "certificate" "client, location of"
24240 .vindex "&$host$&"
24241 .vindex "&$host_address$&"
24242 The value of this option must be the absolute path to a file which contains the
24243 client's certificate, for possible use when sending a message over an encrypted
24244 connection. The values of &$host$& and &$host_address$& are set to the name and
24245 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24246 details of TLS.
24247
24248 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24249 certificate when sending messages as a client. The global option of the same
24250 name specifies the certificate for Exim as a server; it is not automatically
24251 assumed that the same certificate should be used when Exim is operating as a
24252 client.
24253
24254
24255 .option tls_crl smtp string&!! unset
24256 .cindex "TLS" "client certificate revocation list"
24257 .cindex "certificate" "revocation list for client"
24258 This option specifies a certificate revocation list. The expanded value must
24259 be the name of a file that contains a CRL in PEM format.
24260
24261
24262 .option tls_dh_min_bits smtp integer 1024
24263 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24264 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24265 key agreement is negotiated, the server will provide a large prime number
24266 for use.  This option establishes the minimum acceptable size of that number.
24267 If the parameter offered by the server is too small, then the TLS handshake
24268 will fail.
24269
24270 Only supported when using GnuTLS.
24271
24272
24273 .option tls_privatekey smtp string&!! unset
24274 .cindex "TLS" "client private key, location of"
24275 .vindex "&$host$&"
24276 .vindex "&$host_address$&"
24277 The value of this option must be the absolute path to a file which contains the
24278 client's private key. This is used when sending a message over an encrypted
24279 connection using a client certificate. The values of &$host$& and
24280 &$host_address$& are set to the name and address of the server during the
24281 expansion. If this option is unset, or the expansion is forced to fail, or the
24282 result is an empty string, the private key is assumed to be in the same file as
24283 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24284
24285
24286 .option tls_require_ciphers smtp string&!! unset
24287 .cindex "TLS" "requiring specific ciphers"
24288 .cindex "cipher" "requiring specific"
24289 .vindex "&$host$&"
24290 .vindex "&$host_address$&"
24291 The value of this option must be a list of permitted cipher suites, for use
24292 when setting up an outgoing encrypted connection. (There is a global option of
24293 the same name for controlling incoming connections.) The values of &$host$& and
24294 &$host_address$& are set to the name and address of the server during the
24295 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24296 is used in different ways by OpenSSL and GnuTLS (see sections
24297 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24298 ciphers is a preference order.
24299
24300
24301
24302 .option tls_sni smtp string&!! unset
24303 .cindex "TLS" "Server Name Indication"
24304 .vindex "&$tls_sni$&"
24305 If this option is set then it sets the $tls_out_sni variable and causes any
24306 TLS session to pass this value as the Server Name Indication extension to
24307 the remote side, which can be used by the remote side to select an appropriate
24308 certificate and private key for the session.
24309
24310 See &<<SECTtlssni>>& for more information.
24311
24312 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24313 TLS extensions.
24314
24315
24316
24317
24318 .option tls_tempfail_tryclear smtp boolean true
24319 .cindex "4&'xx'& responses" "to STARTTLS"
24320 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24321 setting up a TLS session, this option determines whether or not Exim should try
24322 to deliver the message unencrypted. If it is set false, delivery to the
24323 current host is deferred; if there are other hosts, they are tried. If this
24324 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24325 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24326 TLS negotiation fails, Exim closes the current connection (because it is in an
24327 unknown state), opens a new one to the same host, and then tries the delivery
24328 in clear.
24329
24330
24331 .option tls_try_verify_hosts smtp "host list&!!" *
24332 .cindex "TLS" "server certificate verification"
24333 .cindex "certificate" "verification of server"
24334 This option gives a list of hosts for which, on encrypted connections,
24335 certificate verification will be tried but need not succeed.
24336 The &%tls_verify_certificates%& option must also be set.
24337 Note that unless the host is in this list
24338 TLS connections will be denied to hosts using self-signed certificates
24339 when &%tls_verify_certificates%& is matched.
24340 The &$tls_out_certificate_verified$& variable is set when
24341 certificate verification succeeds.
24342
24343
24344 .option tls_verify_cert_hostnames smtp "host list&!!" *
24345 .cindex "TLS" "server certificate hostname verification"
24346 .cindex "certificate" "verification of server"
24347 This option give a list of hosts for which,
24348 while verifying the server certificate,
24349 checks will be included on the host name
24350 (note that this will generally be the result of a DNS MX lookup)
24351 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24352 limited to being the initial component of a 3-or-more component FQDN.
24353
24354 There is no equivalent checking on client certificates.
24355
24356
24357 .option tls_verify_certificates smtp string&!! system
24358 .cindex "TLS" "server certificate verification"
24359 .cindex "certificate" "verification of server"
24360 .vindex "&$host$&"
24361 .vindex "&$host_address$&"
24362 The value of this option must be either the
24363 word "system"
24364 or the absolute path to
24365 a file or directory containing permitted certificates for servers,
24366 for use when setting up an encrypted connection.
24367
24368 The "system" value for the option will use a location compiled into the SSL library.
24369 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24370 is taken as empty and an explicit location
24371 must be specified.
24372
24373 The use of a directory for the option value is not available for GnuTLS versions
24374 preceding 3.3.6 and a single file must be used.
24375
24376 With OpenSSL the certificates specified
24377 explicitly
24378 either by file or directory
24379 are added to those given by the system default location.
24380
24381 The values of &$host$& and
24382 &$host_address$& are set to the name and address of the server during the
24383 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24384
24385 For back-compatibility,
24386 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24387 (a single-colon empty list counts as being set)
24388 and certificate verification fails the TLS connection is closed.
24389
24390
24391 .option tls_verify_hosts smtp "host list&!!" unset
24392 .cindex "TLS" "server certificate verification"
24393 .cindex "certificate" "verification of server"
24394 This option gives a list of hosts for which, on encrypted connections,
24395 certificate verification must succeed.
24396 The &%tls_verify_certificates%& option must also be set.
24397 If both this option and &%tls_try_verify_hosts%& are unset
24398 operation is as if this option selected all hosts.
24399
24400
24401
24402
24403 .section "How the limits for the number of hosts to try are used" &&&
24404          "SECTvalhosmax"
24405 .cindex "host" "maximum number to try"
24406 .cindex "limit" "hosts; maximum number tried"
24407 There are two options that are concerned with the number of hosts that are
24408 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24409 &%hosts_max_try_hardlimit%&.
24410
24411
24412 The &%hosts_max_try%& option limits the number of hosts that are tried
24413 for a single delivery. However, despite the term &"host"& in its name, the
24414 option actually applies to each IP address independently. In other words, a
24415 multihomed host is treated as several independent hosts, just as it is for
24416 retrying.
24417
24418 Many of the larger ISPs have multiple MX records which often point to
24419 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24420 created as a result of routing one of these domains.
24421
24422 Trying every single IP address on such a long list does not seem sensible; if
24423 several at the top of the list fail, it is reasonable to assume there is some
24424 problem that is likely to affect all of them. Roughly speaking, the value of
24425 &%hosts_max_try%& is the maximum number that are tried before deferring the
24426 delivery. However, the logic cannot be quite that simple.
24427
24428 Firstly, IP addresses that are skipped because their retry times have not
24429 arrived do not count, and in addition, addresses that are past their retry
24430 limits are also not counted, even when they are tried. This means that when
24431 some IP addresses are past their retry limits, more than the value of
24432 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24433 that all IP addresses are considered before timing out an email address (but
24434 see below for an exception).
24435
24436 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24437 list to see if there is a subsequent host with a different (higher valued) MX.
24438 If there is, that host is considered next, and the current IP address is used
24439 but not counted. This behaviour helps in the case of a domain with a retry rule
24440 that hardly ever delays any hosts, as is now explained:
24441
24442 Consider the case of a long list of hosts with one MX value, and a few with a
24443 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24444 hosts at the top of the list are tried at first. With the default retry rule,
24445 which specifies increasing retry times, the higher MX hosts are eventually
24446 tried when those at the top of the list are skipped because they have not
24447 reached their retry times.
24448
24449 However, it is common practice to put a fixed short retry time on domains for
24450 large ISPs, on the grounds that their servers are rarely down for very long.
24451 Unfortunately, these are exactly the domains that tend to resolve to long lists
24452 of hosts. The short retry time means that the lowest MX hosts are tried every
24453 time. The attempts may be in a different order because of random sorting, but
24454 without the special MX check, the higher MX hosts would never be tried until
24455 all the lower MX hosts had timed out (which might be several days), because
24456 there are always some lower MX hosts that have reached their retry times. With
24457 the special check, Exim considers at least one IP address from each MX value at
24458 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24459 reached.
24460
24461 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24462 particular, Exim normally eventually tries all the IP addresses before timing
24463 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24464 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24465 been set up with hundreds of IP addresses for some domains. It can
24466 take a very long time indeed for an address to time out in these cases.
24467
24468 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24469 Exim never tries more than this number of IP addresses; if it hits this limit
24470 and they are all timed out, the email address is bounced, even though not all
24471 possible IP addresses have been tried.
24472 .ecindex IIDsmttra1
24473 .ecindex IIDsmttra2
24474
24475
24476
24477
24478
24479 . ////////////////////////////////////////////////////////////////////////////
24480 . ////////////////////////////////////////////////////////////////////////////
24481
24482 .chapter "Address rewriting" "CHAPrewrite"
24483 .scindex IIDaddrew "rewriting" "addresses"
24484 There are some circumstances in which Exim automatically rewrites domains in
24485 addresses. The two most common are when an address is given without a domain
24486 (referred to as an &"unqualified address"&) or when an address contains an
24487 abbreviated domain that is expanded by DNS lookup.
24488
24489 Unqualified envelope addresses are accepted only for locally submitted
24490 messages, or for messages that are received from hosts matching
24491 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24492 appropriate. Unqualified addresses in header lines are qualified if they are in
24493 locally submitted messages, or messages from hosts that are permitted to send
24494 unqualified envelope addresses. Otherwise, unqualified addresses in header
24495 lines are neither qualified nor rewritten.
24496
24497 One situation in which Exim does &'not'& automatically rewrite a domain is
24498 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24499 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24500 do this. The new RFCs do not contain this suggestion.
24501
24502
24503 .section "Explicitly configured address rewriting" "SECID147"
24504 This chapter describes the rewriting rules that can be used in the
24505 main rewrite section of the configuration file, and also in the generic
24506 &%headers_rewrite%& option that can be set on any transport.
24507
24508 Some people believe that configured address rewriting is a Mortal Sin.
24509 Others believe that life is not possible without it. Exim provides the
24510 facility; you do not have to use it.
24511
24512 The main rewriting rules that appear in the &"rewrite"& section of the
24513 configuration file are applied to addresses in incoming messages, both envelope
24514 addresses and addresses in header lines. Each rule specifies the types of
24515 address to which it applies.
24516
24517 Whether or not addresses in header lines are rewritten depends on the origin of
24518 the headers and the type of rewriting. Global rewriting, that is, rewriting
24519 rules from the rewrite section of the configuration file, is applied only to
24520 those headers that were received with the message. Header lines that are added
24521 by ACLs or by a system filter or by individual routers or transports (which
24522 are specific to individual recipient addresses) are not rewritten by the global
24523 rules.
24524
24525 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24526 applies all headers except those added by routers and transports. That is, as
24527 well as the headers that were received with the message, it also applies to
24528 headers that were added by an ACL or a system filter.
24529
24530
24531 In general, rewriting addresses from your own system or domain has some
24532 legitimacy. Rewriting other addresses should be done only with great care and
24533 in special circumstances. The author of Exim believes that rewriting should be
24534 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24535 Although it can sometimes be used as a routing tool, this is very strongly
24536 discouraged.
24537
24538 There are two commonly encountered circumstances where rewriting is used, as
24539 illustrated by these examples:
24540
24541 .ilist
24542 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24543 exchange mail with each other behind a firewall, but there is only a single
24544 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24545 &'hitch.fict.example'& when sending mail off-site.
24546 .next
24547 A host rewrites the local parts of its own users so that, for example,
24548 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24549 .endlist
24550
24551
24552
24553 .section "When does rewriting happen?" "SECID148"
24554 .cindex "rewriting" "timing of"
24555 .cindex "&ACL;" "rewriting addresses in"
24556 Configured address rewriting can take place at several different stages of a
24557 message's processing.
24558
24559 .vindex "&$sender_address$&"
24560 At the start of an ACL for MAIL, the sender address may have been rewritten
24561 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24562 ordinary rewrite rules have yet been applied. If, however, the sender address
24563 is verified in the ACL, it is rewritten before verification, and remains
24564 rewritten thereafter. The subsequent value of &$sender_address$& is the
24565 rewritten address. This also applies if sender verification happens in a
24566 RCPT ACL. Otherwise, when the sender address is not verified, it is
24567 rewritten as soon as a message's header lines have been received.
24568
24569 .vindex "&$domain$&"
24570 .vindex "&$local_part$&"
24571 Similarly, at the start of an ACL for RCPT, the current recipient's address
24572 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24573 rewrite rules have yet been applied to it. However, the behaviour is different
24574 from the sender address when a recipient is verified. The address is rewritten
24575 for the verification, but the rewriting is not remembered at this stage. The
24576 value of &$local_part$& and &$domain$& after verification are always the same
24577 as they were before (that is, they contain the unrewritten &-- except for
24578 SMTP-time rewriting &-- address).
24579
24580 As soon as a message's header lines have been received, all the envelope
24581 recipient addresses are permanently rewritten, and rewriting is also applied to
24582 the addresses in the header lines (if configured). This happens before adding
24583 any header lines that were specified in MAIL or RCPT ACLs, and
24584 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24585 before the DATA ACL and &[local_scan()]& functions are run.
24586
24587 When an address is being routed, either for delivery or for verification,
24588 rewriting is applied immediately to child addresses that are generated by
24589 redirection, unless &%no_rewrite%& is set on the router.
24590
24591 .cindex "envelope sender" "rewriting at transport time"
24592 .cindex "rewriting" "at transport time"
24593 .cindex "header lines" "rewriting at transport time"
24594 At transport time, additional rewriting of addresses in header lines can be
24595 specified by setting the generic &%headers_rewrite%& option on a transport.
24596 This option contains rules that are identical in form to those in the rewrite
24597 section of the configuration file. They are applied to the original message
24598 header lines and any that were added by ACLs or a system filter. They are not
24599 applied to header lines that are added by routers or the transport.
24600
24601 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24602 transport option. However, it is not possible to rewrite envelope recipients at
24603 transport time.
24604
24605
24606
24607
24608 .section "Testing the rewriting rules that apply on input" "SECID149"
24609 .cindex "rewriting" "testing"
24610 .cindex "testing" "rewriting"
24611 Exim's input rewriting configuration appears in a part of the run time
24612 configuration file headed by &"begin rewrite"&. It can be tested by the
24613 &%-brw%& command line option. This takes an address (which can be a full RFC
24614 2822 address) as its argument. The output is a list of how the address would be
24615 transformed by the rewriting rules for each of the different places it might
24616 appear in an incoming message, that is, for each different header and for the
24617 envelope sender and recipient fields. For example,
24618 .code
24619 exim -brw ph10@exim.workshop.example
24620 .endd
24621 might produce the output
24622 .code
24623 sender: Philip.Hazel@exim.workshop.example
24624 from: Philip.Hazel@exim.workshop.example
24625 to: ph10@exim.workshop.example
24626 cc: ph10@exim.workshop.example
24627 bcc: ph10@exim.workshop.example
24628 reply-to: Philip.Hazel@exim.workshop.example
24629 env-from: Philip.Hazel@exim.workshop.example
24630 env-to: ph10@exim.workshop.example
24631 .endd
24632 which shows that rewriting has been set up for that address when used in any of
24633 the source fields, but not when it appears as a recipient address. At the
24634 present time, there is no equivalent way of testing rewriting rules that are
24635 set for a particular transport.
24636
24637
24638 .section "Rewriting rules" "SECID150"
24639 .cindex "rewriting" "rules"
24640 The rewrite section of the configuration file consists of lines of rewriting
24641 rules in the form
24642 .display
24643 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24644 .endd
24645 Rewriting rules that are specified for the &%headers_rewrite%& generic
24646 transport option are given as a colon-separated list. Each item in the list
24647 takes the same form as a line in the main rewriting configuration (except that
24648 any colons must be doubled, of course).
24649
24650 The formats of source patterns and replacement strings are described below.
24651 Each is terminated by white space, unless enclosed in double quotes, in which
24652 case normal quoting conventions apply inside the quotes. The flags are single
24653 characters which may appear in any order. Spaces and tabs between them are
24654 ignored.
24655
24656 For each address that could potentially be rewritten, the rules are scanned in
24657 order, and replacements for the address from earlier rules can themselves be
24658 replaced by later rules (but see the &"q"& and &"R"& flags).
24659
24660 The order in which addresses are rewritten is undefined, may change between
24661 releases, and must not be relied on, with one exception: when a message is
24662 received, the envelope sender is always rewritten first, before any header
24663 lines are rewritten. For example, the replacement string for a rewrite of an
24664 address in &'To:'& must not assume that the message's address in &'From:'& has
24665 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24666 that the envelope sender has already been rewritten.
24667
24668 .vindex "&$domain$&"
24669 .vindex "&$local_part$&"
24670 The variables &$local_part$& and &$domain$& can be used in the replacement
24671 string to refer to the address that is being rewritten. Note that lookup-driven
24672 rewriting can be done by a rule of the form
24673 .code
24674 *@*   ${lookup ...
24675 .endd
24676 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24677 refer to the address that is being rewritten.
24678
24679
24680 .section "Rewriting patterns" "SECID151"
24681 .cindex "rewriting" "patterns"
24682 .cindex "address list" "in a rewriting pattern"
24683 The source pattern in a rewriting rule is any item which may appear in an
24684 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24685 single-item address list, which means that it is expanded before being tested
24686 against the address. As always, if you use a regular expression as a pattern,
24687 you must take care to escape dollar and backslash characters, or use the &`\N`&
24688 facility to suppress string expansion within the regular expression.
24689
24690 Domains in patterns should be given in lower case. Local parts in patterns are
24691 case-sensitive. If you want to do case-insensitive matching of local parts, you
24692 can use a regular expression that starts with &`^(?i)`&.
24693
24694 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24695 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24696 depending on the type of match which occurred. These can be used in the
24697 replacement string to insert portions of the incoming address. &$0$& always
24698 refers to the complete incoming address. When a regular expression is used, the
24699 numerical variables are set from its capturing subexpressions. For other types
24700 of pattern they are set as follows:
24701
24702 .ilist
24703 If a local part or domain starts with an asterisk, the numerical variables
24704 refer to the character strings matched by asterisks, with &$1$& associated with
24705 the first asterisk, and &$2$& with the second, if present. For example, if the
24706 pattern
24707 .code
24708 *queen@*.fict.example
24709 .endd
24710 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24711 .code
24712 $0 = hearts-queen@wonderland.fict.example
24713 $1 = hearts-
24714 $2 = wonderland
24715 .endd
24716 Note that if the local part does not start with an asterisk, but the domain
24717 does, it is &$1$& that contains the wild part of the domain.
24718
24719 .next
24720 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24721 of the domain are placed in the next available numerical variables. Suppose,
24722 for example, that the address &'foo@bar.baz.example'& is processed by a
24723 rewriting rule of the form
24724 .display
24725 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24726 .endd
24727 and the key in the file that matches the domain is &`*.baz.example`&. Then
24728 .code
24729 $1 = foo
24730 $2 = bar
24731 $3 = baz.example
24732 .endd
24733 If the address &'foo@baz.example'& is looked up, this matches the same
24734 wildcard file entry, and in this case &$2$& is set to the empty string, but
24735 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24736 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24737 whole domain. For non-partial domain lookups, no numerical variables are set.
24738 .endlist
24739
24740
24741 .section "Rewriting replacements" "SECID152"
24742 .cindex "rewriting" "replacements"
24743 If the replacement string for a rule is a single asterisk, addresses that
24744 match the pattern and the flags are &'not'& rewritten, and no subsequent
24745 rewriting rules are scanned. For example,
24746 .code
24747 hatta@lookingglass.fict.example  *  f
24748 .endd
24749 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24750 &'From:'& headers.
24751
24752 .vindex "&$domain$&"
24753 .vindex "&$local_part$&"
24754 If the replacement string is not a single asterisk, it is expanded, and must
24755 yield a fully qualified address. Within the expansion, the variables
24756 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24757 Any letters they contain retain their original case &-- they are not lower
24758 cased. The numerical variables are set up according to the type of pattern that
24759 matched the address, as described above. If the expansion is forced to fail by
24760 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24761 current rule is abandoned, but subsequent rules may take effect. Any other
24762 expansion failure causes the entire rewriting operation to be abandoned, and an
24763 entry written to the panic log.
24764
24765
24766
24767 .section "Rewriting flags" "SECID153"
24768 There are three different kinds of flag that may appear on rewriting rules:
24769
24770 .ilist
24771 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24772 c, f, h, r, s, t.
24773 .next
24774 A flag that specifies rewriting at SMTP time: S.
24775 .next
24776 Flags that control the rewriting process: Q, q, R, w.
24777 .endlist
24778
24779 For rules that are part of the &%headers_rewrite%& generic transport option,
24780 E, F, T, and S are not permitted.
24781
24782
24783
24784 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24785          "SECID154"
24786 .cindex "rewriting" "flags"
24787 If none of the following flag letters, nor the &"S"& flag (see section
24788 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24789 and to both the sender and recipient fields of the envelope, whereas a
24790 transport-time rewriting rule just applies to all headers. Otherwise, the
24791 rewriting rule is skipped unless the relevant addresses are being processed.
24792 .display
24793 &`E`&       rewrite all envelope fields
24794 &`F`&       rewrite the envelope From field
24795 &`T`&       rewrite the envelope To field
24796 &`b`&       rewrite the &'Bcc:'& header
24797 &`c`&       rewrite the &'Cc:'& header
24798 &`f`&       rewrite the &'From:'& header
24799 &`h`&       rewrite all headers
24800 &`r`&       rewrite the &'Reply-To:'& header
24801 &`s`&       rewrite the &'Sender:'& header
24802 &`t`&       rewrite the &'To:'& header
24803 .endd
24804 "All headers" means all of the headers listed above that can be selected
24805 individually, plus their &'Resent-'& versions. It does not include
24806 other headers such as &'Subject:'& etc.
24807
24808 You should be particularly careful about rewriting &'Sender:'& headers, and
24809 restrict this to special known cases in your own domains.
24810
24811
24812 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24813 .cindex "SMTP" "rewriting malformed addresses"
24814 .cindex "RCPT" "rewriting argument of"
24815 .cindex "MAIL" "rewriting argument of"
24816 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24817 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24818 before any other processing; even before syntax checking. The pattern is
24819 required to be a regular expression, and it is matched against the whole of the
24820 data for the command, including any surrounding angle brackets.
24821
24822 .vindex "&$domain$&"
24823 .vindex "&$local_part$&"
24824 This form of rewrite rule allows for the handling of addresses that are not
24825 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24826 input). Because the input is not required to be a syntactically valid address,
24827 the variables &$local_part$& and &$domain$& are not available during the
24828 expansion of the replacement string. The result of rewriting replaces the
24829 original address in the MAIL or RCPT command.
24830
24831
24832 .section "Flags controlling the rewriting process" "SECID155"
24833 There are four flags which control the way the rewriting process works. These
24834 take effect only when a rule is invoked, that is, when the address is of the
24835 correct type (matches the flags) and matches the pattern:
24836
24837 .ilist
24838 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24839 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24840 absence of &"Q"& the rewritten address must always include a domain.
24841 .next
24842 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24843 even if no rewriting actually takes place because of a &"fail"& in the
24844 expansion. The &"q"& flag is not effective if the address is of the wrong type
24845 (does not match the flags) or does not match the pattern.
24846 .next
24847 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24848 address, up to ten times. It can be combined with the &"q"& flag, to stop
24849 rewriting once it fails to match (after at least one successful rewrite).
24850 .next
24851 .cindex "rewriting" "whole addresses"
24852 When an address in a header is rewritten, the rewriting normally applies only
24853 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24854 left unchanged. For example, rewriting might change
24855 .code
24856 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24857 .endd
24858 into
24859 .code
24860 From: Ford Prefect <prefectf@hitch.fict.example>
24861 .endd
24862 .cindex "RFC 2047"
24863 Sometimes there is a need to replace the whole address item, and this can be
24864 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24865 causes an address in a header line to be rewritten, the entire address is
24866 replaced, not just the working part. The replacement must be a complete RFC
24867 2822 address, including the angle brackets if necessary. If text outside angle
24868 brackets contains a character whose value is greater than 126 or less than 32
24869 (except for tab), the text is encoded according to RFC 2047. The character set
24870 is taken from &%headers_charset%&, which gets its default at build time.
24871
24872 When the &"w"& flag is set on a rule that causes an envelope address to be
24873 rewritten, all but the working part of the replacement address is discarded.
24874 .endlist
24875
24876
24877 .section "Rewriting examples" "SECID156"
24878 Here is an example of the two common rewriting paradigms:
24879 .code
24880 *@*.hitch.fict.example  $1@hitch.fict.example
24881 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24882                      {$value}fail}@hitch.fict.example bctfrF
24883 .endd
24884 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24885 the string expansion to fail if the lookup does not succeed. In this context it
24886 has the effect of leaving the original address unchanged, but Exim goes on to
24887 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24888 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24889 explicitly, which would cause the rewritten address to be the same as before,
24890 at the cost of a small bit of processing. Not supplying either of these is an
24891 error, since the rewritten address would then contain no local part.
24892
24893 The first example above replaces the domain with a superior, more general
24894 domain. This may not be desirable for certain local parts. If the rule
24895 .code
24896 root@*.hitch.fict.example  *
24897 .endd
24898 were inserted before the first rule, rewriting would be suppressed for the
24899 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24900
24901 Rewriting can be made conditional on a number of tests, by making use of
24902 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24903 messages that originate outside the local host:
24904 .code
24905 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24906                          {$1@hitch.fict.example}fail}"
24907 .endd
24908 The replacement string is quoted in this example because it contains white
24909 space.
24910
24911 .cindex "rewriting" "bang paths"
24912 .cindex "bang paths" "rewriting"
24913 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24914 an address it treats it as an unqualified local part which it qualifies with
24915 the local qualification domain (if the source of the message is local or if the
24916 remote host is permitted to send unqualified addresses). Rewriting can
24917 sometimes be used to handle simple bang paths with a fixed number of
24918 components. For example, the rule
24919 .code
24920 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24921 .endd
24922 rewrites a two-component bang path &'host.name!user'& as the domain address
24923 &'user@host.name'&. However, there is a security implication in using this as
24924 a global rewriting rule for envelope addresses. It can provide a backdoor
24925 method for using your system as a relay, because the incoming addresses appear
24926 to be local. If the bang path addresses are received via SMTP, it is safer to
24927 use the &"S"& flag to rewrite them as they are received, so that relay checking
24928 can be done on the rewritten addresses.
24929 .ecindex IIDaddrew
24930
24931
24932
24933
24934
24935 . ////////////////////////////////////////////////////////////////////////////
24936 . ////////////////////////////////////////////////////////////////////////////
24937
24938 .chapter "Retry configuration" "CHAPretry"
24939 .scindex IIDretconf1 "retry" "configuration, description of"
24940 .scindex IIDregconf2 "configuration file" "retry section"
24941 The &"retry"& section of the runtime configuration file contains a list of
24942 retry rules that control how often Exim tries to deliver messages that cannot
24943 be delivered at the first attempt. If there are no retry rules (the section is
24944 empty or not present), there are no retries. In this situation, temporary
24945 errors are treated as permanent. The default configuration contains a single,
24946 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24947 line option can be used to test which retry rule will be used for a given
24948 address, domain and error.
24949
24950 The most common cause of retries is temporary failure to deliver to a remote
24951 host because the host is down, or inaccessible because of a network problem.
24952 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24953 address) basis, not on a per-message basis. Thus, if one message has recently
24954 been delayed, delivery of a new message to the same host is not immediately
24955 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24956 log selector is set, the message
24957 .cindex "retry" "time not reached"
24958 &"retry time not reached"& is written to the main log whenever a delivery is
24959 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24960 the handling of errors during remote deliveries.
24961
24962 Retry processing applies to routing as well as to delivering, except as covered
24963 in the next paragraph. The retry rules do not distinguish between these
24964 actions. It is not possible, for example, to specify different behaviour for
24965 failures to route the domain &'snark.fict.example'& and failures to deliver to
24966 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24967 added complication, so did not implement it. However, although they share the
24968 same retry rule, the actual retry times for routing and transporting a given
24969 domain are maintained independently.
24970
24971 When a delivery is not part of a queue run (typically an immediate delivery on
24972 receipt of a message), the routers are always run, and local deliveries are
24973 always attempted, even if retry times are set for them. This makes for better
24974 behaviour if one particular message is causing problems (for example, causing
24975 quota overflow, or provoking an error in a filter file). If such a delivery
24976 suffers a temporary failure, the retry data is updated as normal, and
24977 subsequent delivery attempts from queue runs occur only when the retry time for
24978 the local address is reached.
24979
24980 .section "Changing retry rules" "SECID157"
24981 If you change the retry rules in your configuration, you should consider
24982 whether or not to delete the retry data that is stored in Exim's spool area in
24983 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24984 always safe; that is why they are called &"hints"&.
24985
24986 The hints retry data contains suggested retry times based on the previous
24987 rules. In the case of a long-running problem with a remote host, it might
24988 record the fact that the host has timed out. If your new rules increase the
24989 timeout time for such a host, you should definitely remove the old retry data
24990 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24991 messages that it should now be retaining.
24992
24993
24994
24995 .section "Format of retry rules" "SECID158"
24996 .cindex "retry" "rules"
24997 Each retry rule occupies one line and consists of three or four parts,
24998 separated by white space: a pattern, an error name, an optional list of sender
24999 addresses, and a list of retry parameters. The pattern and sender lists must be
25000 enclosed in double quotes if they contain white space. The rules are searched
25001 in order until one is found where the pattern, error name, and sender list (if
25002 present) match the failing host or address, the error that occurred, and the
25003 message's sender, respectively.
25004
25005
25006 The pattern is any single item that may appear in an address list (see section
25007 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25008 which means that it is expanded before being tested against the address that
25009 has been delayed. A negated address list item is permitted. Address
25010 list processing treats a plain domain name as if it were preceded by &"*@"&,
25011 which makes it possible for many retry rules to start with just a domain. For
25012 example,
25013 .code
25014 lookingglass.fict.example        *  F,24h,30m;
25015 .endd
25016 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25017 whereas
25018 .code
25019 alice@lookingglass.fict.example  *  F,24h,30m;
25020 .endd
25021 applies only to temporary failures involving the local part &%alice%&.
25022 In practice, almost all rules start with a domain name pattern without a local
25023 part.
25024
25025 .cindex "regular expressions" "in retry rules"
25026 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25027 must match a complete address, not just a domain, because that is how regular
25028 expressions work in address lists.
25029 .display
25030 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25031 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25032 .endd
25033
25034
25035 .section "Choosing which retry rule to use for address errors" "SECID159"
25036 When Exim is looking for a retry rule after a routing attempt has failed (for
25037 example, after a DNS timeout), each line in the retry configuration is tested
25038 against the complete address only if &%retry_use_local_part%& is set for the
25039 router. Otherwise, only the domain is used, except when matching against a
25040 regular expression, when the local part of the address is replaced with &"*"&.
25041 A domain on its own can match a domain pattern, or a pattern that starts with
25042 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25043 &%check_local_user%& is true, and false for other routers.
25044
25045 Similarly, when Exim is looking for a retry rule after a local delivery has
25046 failed (for example, after a mailbox full error), each line in the retry
25047 configuration is tested against the complete address only if
25048 &%retry_use_local_part%& is set for the transport (it defaults true for all
25049 local transports).
25050
25051 .cindex "4&'xx'& responses" "retry rules for"
25052 However, when Exim is looking for a retry rule after a remote delivery attempt
25053 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25054 whole address is always used as the key when searching the retry rules. The
25055 rule that is found is used to create a retry time for the combination of the
25056 failing address and the message's sender. It is the combination of sender and
25057 recipient that is delayed in subsequent queue runs until its retry time is
25058 reached. You can delay the recipient without regard to the sender by setting
25059 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25060 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25061 commands.
25062
25063
25064
25065 .section "Choosing which retry rule to use for host and message errors" &&&
25066          "SECID160"
25067 For a temporary error that is not related to an individual address (for
25068 example, a connection timeout), each line in the retry configuration is checked
25069 twice. First, the name of the remote host is used as a domain name (preceded by
25070 &"*@"& when matching a regular expression). If this does not match the line,
25071 the domain from the email address is tried in a similar fashion. For example,
25072 suppose the MX records for &'a.b.c.example'& are
25073 .code
25074 a.b.c.example  MX  5  x.y.z.example
25075                MX  6  p.q.r.example
25076                MX  7  m.n.o.example
25077 .endd
25078 and the retry rules are
25079 .code
25080 p.q.r.example    *      F,24h,30m;
25081 a.b.c.example    *      F,4d,45m;
25082 .endd
25083 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25084 first rule matches neither the host nor the domain, so Exim looks at the second
25085 rule. This does not match the host, but it does match the domain, so it is used
25086 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25087 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25088 first retry rule is used, because it matches the host.
25089
25090 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25091 first rule to determine retry times, but for all the other hosts for the domain
25092 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25093 routing to &'a.b.c.example'& suffers a temporary failure.
25094
25095 &*Note*&: The host name is used when matching the patterns, not its IP address.
25096 However, if a message is routed directly to an IP address without the use of a
25097 host name, for example, if a &(manualroute)& router contains a setting such as:
25098 .code
25099 route_list = *.a.example  192.168.34.23
25100 .endd
25101 then the &"host name"& that is used when searching for a retry rule is the
25102 textual form of the IP address.
25103
25104 .section "Retry rules for specific errors" "SECID161"
25105 .cindex "retry" "specific errors; specifying"
25106 The second field in a retry rule is the name of a particular error, or an
25107 asterisk, which matches any error. The errors that can be tested for are:
25108
25109 .vlist
25110 .vitem &%auth_failed%&
25111 Authentication failed when trying to send to a host in the
25112 &%hosts_require_auth%& list in an &(smtp)& transport.
25113
25114 .vitem &%data_4xx%&
25115 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25116 after the command, or after sending the message's data.
25117
25118 .vitem &%mail_4xx%&
25119 A 4&'xx'& error was received for an outgoing MAIL command.
25120
25121 .vitem &%rcpt_4xx%&
25122 A 4&'xx'& error was received for an outgoing RCPT command.
25123 .endlist
25124
25125 For the three 4&'xx'& errors, either the first or both of the x's can be given
25126 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25127 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25128 and have retries every ten minutes with a one-hour timeout, you could set up a
25129 retry rule of this form:
25130 .code
25131 the.domain.name  rcpt_452   F,1h,10m
25132 .endd
25133 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25134 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25135
25136 .vlist
25137 .vitem &%lost_connection%&
25138 A server unexpectedly closed the SMTP connection. There may, of course,
25139 legitimate reasons for this (host died, network died), but if it repeats a lot
25140 for the same host, it indicates something odd.
25141
25142 .vitem &%lookup%&
25143 A DNS lookup for a host failed.
25144 Note that a &%dnslookup%& router will need to have matched
25145 its &%fail_defer_domains%& option for this retry type to be usable.
25146 Also note that a &%manualroute%& router will probably need
25147 its &%host_find_failed%& option set to &%defer%&.
25148
25149 .vitem &%refused_MX%&
25150 A connection to a host obtained from an MX record was refused.
25151
25152 .vitem &%refused_A%&
25153 A connection to a host not obtained from an MX record was refused.
25154
25155 .vitem &%refused%&
25156 A connection was refused.
25157
25158 .vitem &%timeout_connect_MX%&
25159 A connection attempt to a host obtained from an MX record timed out.
25160
25161 .vitem &%timeout_connect_A%&
25162 A connection attempt to a host not obtained from an MX record timed out.
25163
25164 .vitem &%timeout_connect%&
25165 A connection attempt timed out.
25166
25167 .vitem &%timeout_MX%&
25168 There was a timeout while connecting or during an SMTP session with a host
25169 obtained from an MX record.
25170
25171 .vitem &%timeout_A%&
25172 There was a timeout while connecting or during an SMTP session with a host not
25173 obtained from an MX record.
25174
25175 .vitem &%timeout%&
25176 There was a timeout while connecting or during an SMTP session.
25177
25178 .vitem &%tls_required%&
25179 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25180 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25181 to STARTTLS, or there was a problem setting up the TLS connection.
25182
25183 .vitem &%quota%&
25184 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25185 transport.
25186
25187 .vitem &%quota_%&<&'time'&>
25188 .cindex "quota" "error testing in retry rule"
25189 .cindex "retry" "quota error testing"
25190 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25191 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25192 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25193 for four days.
25194 .endlist
25195
25196 .cindex "mailbox" "time of last read"
25197 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25198 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25199 it should be based on the last time that the user accessed the mailbox.
25200 However, it is not always possible to determine this. Exim uses the following
25201 heuristic rules:
25202
25203 .ilist
25204 If the mailbox is a single file, the time of last access (the &"atime"&) is
25205 used. As no new messages are being delivered (because the mailbox is over
25206 quota), Exim does not access the file, so this is the time of last user access.
25207 .next
25208 .cindex "maildir format" "time of last read"
25209 For a maildir delivery, the time of last modification of the &_new_&
25210 subdirectory is used. As the mailbox is over quota, no new files are created in
25211 the &_new_& subdirectory, because no new messages are being delivered. Any
25212 change to the &_new_& subdirectory is therefore assumed to be the result of an
25213 MUA moving a new message to the &_cur_& directory when it is first read. The
25214 time that is used is therefore the last time that the user read a new message.
25215 .next
25216 For other kinds of multi-file mailbox, the time of last access cannot be
25217 obtained, so a retry rule that uses this type of error field is never matched.
25218 .endlist
25219
25220 The quota errors apply both to system-enforced quotas and to Exim's own quota
25221 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25222 when a local delivery is deferred because a partition is full (the ENOSPC
25223 error).
25224
25225
25226
25227 .section "Retry rules for specified senders" "SECID162"
25228 .cindex "retry" "rules; sender-specific"
25229 You can specify retry rules that apply only when the failing message has a
25230 specific sender. In particular, this can be used to define retry rules that
25231 apply only to bounce messages. The third item in a retry rule can be of this
25232 form:
25233 .display
25234 &`senders=`&<&'address list'&>
25235 .endd
25236 The retry timings themselves are then the fourth item. For example:
25237 .code
25238 *   rcpt_4xx   senders=:   F,1h,30m
25239 .endd
25240 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25241 host. If the address list contains white space, it must be enclosed in quotes.
25242 For example:
25243 .code
25244 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25245 .endd
25246 &*Warning*&: This facility can be unhelpful if it is used for host errors
25247 (which do not depend on the recipient). The reason is that the sender is used
25248 only to match the retry rule. Once the rule has been found for a host error,
25249 its contents are used to set a retry time for the host, and this will apply to
25250 all messages, not just those with specific senders.
25251
25252 When testing retry rules using &%-brt%&, you can supply a sender using the
25253 &%-f%& command line option, like this:
25254 .code
25255 exim -f "" -brt user@dom.ain
25256 .endd
25257 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25258 list is never matched.
25259
25260
25261
25262
25263
25264 .section "Retry parameters" "SECID163"
25265 .cindex "retry" "parameters in rules"
25266 The third (or fourth, if a senders list is present) field in a retry rule is a
25267 sequence of retry parameter sets, separated by semicolons. Each set consists of
25268 .display
25269 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25270 .endd
25271 The letter identifies the algorithm for computing a new retry time; the cutoff
25272 time is the time beyond which this algorithm no longer applies, and the
25273 arguments vary the algorithm's action. The cutoff time is measured from the
25274 time that the first failure for the domain (combined with the local part if
25275 relevant) was detected, not from the time the message was received.
25276
25277 .cindex "retry" "algorithms"
25278 .cindex "retry" "fixed intervals"
25279 .cindex "retry" "increasing intervals"
25280 .cindex "retry" "random intervals"
25281 The available algorithms are:
25282
25283 .ilist
25284 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25285 the interval.
25286 .next
25287 &'G'&: retry at geometrically increasing intervals. The first argument
25288 specifies a starting value for the interval, and the second a multiplier, which
25289 is used to increase the size of the interval at each retry.
25290 .next
25291 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25292 retry, the previous interval is multiplied by the factor in order to get a
25293 maximum for the next interval. The minimum interval is the first argument of
25294 the parameter, and an actual interval is chosen randomly between them. Such a
25295 rule has been found to be helpful in cluster configurations when all the
25296 members of the cluster restart at once, and may therefore synchronize their
25297 queue processing times.
25298 .endlist
25299
25300 When computing the next retry time, the algorithm definitions are scanned in
25301 order until one whose cutoff time has not yet passed is reached. This is then
25302 used to compute a new retry time that is later than the current time. In the
25303 case of fixed interval retries, this simply means adding the interval to the
25304 current time. For geometrically increasing intervals, retry intervals are
25305 computed from the rule's parameters until one that is greater than the previous
25306 interval is found. The main configuration variable
25307 .cindex "limit" "retry interval"
25308 .cindex "retry" "interval, maximum"
25309 .oindex "&%retry_interval_max%&"
25310 &%retry_interval_max%& limits the maximum interval between retries. It
25311 cannot be set greater than &`24h`&, which is its default value.
25312
25313 A single remote domain may have a number of hosts associated with it, and each
25314 host may have more than one IP address. Retry algorithms are selected on the
25315 basis of the domain name, but are applied to each IP address independently. If,
25316 for example, a host has two IP addresses and one is unusable, Exim will
25317 generate retry times for it and will not try to use it until its next retry
25318 time comes. Thus the good IP address is likely to be tried first most of the
25319 time.
25320
25321 .cindex "hints database" "use for retrying"
25322 Retry times are hints rather than promises. Exim does not make any attempt to
25323 run deliveries exactly at the computed times. Instead, a queue runner process
25324 starts delivery processes for delayed messages periodically, and these attempt
25325 new deliveries only for those addresses that have passed their next retry time.
25326 If a new message arrives for a deferred address, an immediate delivery attempt
25327 occurs only if the address has passed its retry time. In the absence of new
25328 messages, the minimum time between retries is the interval between queue runner
25329 processes. There is not much point in setting retry times of five minutes if
25330 your queue runners happen only once an hour, unless there are a significant
25331 number of incoming messages (which might be the case on a system that is
25332 sending everything to a smart host, for example).
25333
25334 The data in the retry hints database can be inspected by using the
25335 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25336 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25337 &'exinext'& utility script can be used to find out what the next retry times
25338 are for the hosts associated with a particular mail domain, and also for local
25339 deliveries that have been deferred.
25340
25341
25342 .section "Retry rule examples" "SECID164"
25343 Here are some example retry rules:
25344 .code
25345 alice@wonderland.fict.example quota_5d  F,7d,3h
25346 wonderland.fict.example       quota_5d
25347 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25348 lookingglass.fict.example     *         F,24h,30m;
25349 *                 refused_A   F,2h,20m;
25350 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25351 .endd
25352 The first rule sets up special handling for mail to
25353 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25354 mailbox has not been read for at least 5 days. Retries continue every three
25355 hours for 7 days. The second rule handles over-quota errors for all other local
25356 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25357 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25358 fail are bounced immediately if the mailbox has not been read for at least 5
25359 days.
25360
25361 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25362 happen every 15 minutes for an hour, then with geometrically increasing
25363 intervals until two days have passed since a delivery first failed. After the
25364 first hour there is a delay of one hour, then two hours, then four hours, and
25365 so on (this is a rather extreme example).
25366
25367 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25368 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25369 all other domains, with special action for connection refusal from hosts that
25370 were not obtained from an MX record.
25371
25372 The final rule in a retry configuration should always have asterisks in the
25373 first two fields so as to provide a general catch-all for any addresses that do
25374 not have their own special handling. This example tries every 15 minutes for 2
25375 hours, then with intervals starting at one hour and increasing by a factor of
25376 1.5 up to 16 hours, then every 8 hours up to 5 days.
25377
25378
25379
25380 .section "Timeout of retry data" "SECID165"
25381 .cindex "timeout" "of retry data"
25382 .oindex "&%retry_data_expire%&"
25383 .cindex "hints database" "data expiry"
25384 .cindex "retry" "timeout of data"
25385 Exim timestamps the data that it writes to its retry hints database. When it
25386 consults the data during a delivery it ignores any that is older than the value
25387 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25388 been tried for 7 days, Exim will try to deliver to it immediately a message
25389 arrives, and if that fails, it will calculate a retry time as if it were
25390 failing for the first time.
25391
25392 This improves the behaviour for messages routed to rarely-used hosts such as MX
25393 backups. If such a host was down at one time, and happens to be down again when
25394 Exim tries a month later, using the old retry data would imply that it had been
25395 down all the time, which is not a justified assumption.
25396
25397 If a host really is permanently dead, this behaviour causes a burst of retries
25398 every now and again, but only if messages routed to it are rare. If there is a
25399 message at least once every 7 days the retry data never expires.
25400
25401
25402
25403
25404 .section "Long-term failures" "SECID166"
25405 .cindex "delivery failure, long-term"
25406 .cindex "retry" "after long-term failure"
25407 Special processing happens when an email address has been failing for so long
25408 that the cutoff time for the last algorithm is reached. For example, using the
25409 default retry rule:
25410 .code
25411 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25412 .endd
25413 the cutoff time is four days. Reaching the retry cutoff is independent of how
25414 long any specific message has been failing; it is the length of continuous
25415 failure for the recipient address that counts.
25416
25417 When the cutoff time is reached for a local delivery, or for all the IP
25418 addresses associated with a remote delivery, a subsequent delivery failure
25419 causes Exim to give up on the address, and a bounce message is generated.
25420 In order to cater for new messages that use the failing address, a next retry
25421 time is still computed from the final algorithm, and is used as follows:
25422
25423 For local deliveries, one delivery attempt is always made for any subsequent
25424 messages. If this delivery fails, the address fails immediately. The
25425 post-cutoff retry time is not used.
25426
25427 If the delivery is remote, there are two possibilities, controlled by the
25428 .oindex "&%delay_after_cutoff%&"
25429 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25430 default. Until the post-cutoff retry time for one of the IP addresses is
25431 reached, the failing email address is bounced immediately, without a delivery
25432 attempt taking place. After that time, one new delivery attempt is made to
25433 those IP addresses that are past their retry times, and if that still fails,
25434 the address is bounced and new retry times are computed.
25435
25436 In other words, when all the hosts for a given email address have been failing
25437 for a long time, Exim bounces rather then defers until one of the hosts' retry
25438 times is reached. Then it tries once, and bounces if that attempt fails. This
25439 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25440 to a broken destination, but if the host does recover, Exim will eventually
25441 notice.
25442
25443 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25444 addresses are past their final cutoff time, Exim tries to deliver to those IP
25445 addresses that have not been tried since the message arrived. If there are
25446 no suitable IP addresses, or if they all fail, the address is bounced. In other
25447 words, it does not delay when a new message arrives, but tries the expired
25448 addresses immediately, unless they have been tried since the message arrived.
25449 If there is a continuous stream of messages for the failing domains, setting
25450 &%delay_after_cutoff%& false means that there will be many more attempts to
25451 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25452 true.
25453
25454 .section "Deliveries that work intermittently" "SECID167"
25455 .cindex "retry" "intermittently working deliveries"
25456 Some additional logic is needed to cope with cases where a host is
25457 intermittently available, or when a message has some attribute that prevents
25458 its delivery when others to the same address get through. In this situation,
25459 because some messages are successfully delivered, the &"retry clock"& for the
25460 host or address keeps getting reset by the successful deliveries, and so
25461 failing messages remain on the queue for ever because the cutoff time is never
25462 reached.
25463
25464 Two exceptional actions are applied to prevent this happening. The first
25465 applies to errors that are related to a message rather than a remote host.
25466 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25467 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25468 commands, and quota failures. For this type of error, if a message's arrival
25469 time is earlier than the &"first failed"& time for the error, the earlier time
25470 is used when scanning the retry rules to decide when to try next and when to
25471 time out the address.
25472
25473 The exceptional second action applies in all cases. If a message has been on
25474 the queue for longer than the cutoff time of any applicable retry rule for a
25475 given address, a delivery is attempted for that address, even if it is not yet
25476 time, and if this delivery fails, the address is timed out. A new retry time is
25477 not computed in this case, so that other messages for the same address are
25478 considered immediately.
25479 .ecindex IIDretconf1
25480 .ecindex IIDregconf2
25481
25482
25483
25484
25485
25486
25487 . ////////////////////////////////////////////////////////////////////////////
25488 . ////////////////////////////////////////////////////////////////////////////
25489
25490 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25491 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25492 .scindex IIDauthconf2 "authentication"
25493 The &"authenticators"& section of Exim's run time configuration is concerned
25494 with SMTP authentication. This facility is an extension to the SMTP protocol,
25495 described in RFC 2554, which allows a client SMTP host to authenticate itself
25496 to a server. This is a common way for a server to recognize clients that are
25497 permitted to use it as a relay. SMTP authentication is not of relevance to the
25498 transfer of mail between servers that have no managerial connection with each
25499 other.
25500
25501 .cindex "AUTH" "description of"
25502 Very briefly, the way SMTP authentication works is as follows:
25503
25504 .ilist
25505 The server advertises a number of authentication &'mechanisms'& in response to
25506 the client's EHLO command.
25507 .next
25508 The client issues an AUTH command, naming a specific mechanism. The command
25509 may, optionally, contain some authentication data.
25510 .next
25511 The server may issue one or more &'challenges'&, to which the client must send
25512 appropriate responses. In simple authentication mechanisms, the challenges are
25513 just prompts for user names and passwords. The server does not have to issue
25514 any challenges &-- in some mechanisms the relevant data may all be transmitted
25515 with the AUTH command.
25516 .next
25517 The server either accepts or denies authentication.
25518 .next
25519 If authentication succeeds, the client may optionally make use of the AUTH
25520 option on the MAIL command to pass an authenticated sender in subsequent
25521 mail transactions. Authentication lasts for the remainder of the SMTP
25522 connection.
25523 .next
25524 If authentication fails, the client may give up, or it may try a different
25525 authentication mechanism, or it may try transferring mail over the
25526 unauthenticated connection.
25527 .endlist
25528
25529 If you are setting up a client, and want to know which authentication
25530 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25531 SMTP port) on the server, and issue an EHLO command. The response to this
25532 includes the list of supported mechanisms. For example:
25533 .display
25534 &`$ `&&*&`telnet server.example 25`&*&
25535 &`Trying 192.168.34.25...`&
25536 &`Connected to server.example.`&
25537 &`Escape character is &#x0027;^]&#x0027;.`&
25538 &`220 server.example ESMTP Exim 4.20 ...`&
25539 &*&`ehlo client.example`&*&
25540 &`250-server.example Hello client.example [10.8.4.5]`&
25541 &`250-SIZE 52428800`&
25542 &`250-PIPELINING`&
25543 &`250-AUTH PLAIN`&
25544 &`250 HELP`&
25545 .endd
25546 The second-last line of this example output shows that the server supports
25547 authentication using the PLAIN mechanism. In Exim, the different authentication
25548 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25549 routers and transports, which authenticators are included in the binary is
25550 controlled by build-time definitions. The following are currently available,
25551 included by setting
25552 .code
25553 AUTH_CRAM_MD5=yes
25554 AUTH_CYRUS_SASL=yes
25555 AUTH_DOVECOT=yes
25556 AUTH_GSASL=yes
25557 AUTH_HEIMDAL_GSSAPI=yes
25558 AUTH_PLAINTEXT=yes
25559 AUTH_SPA=yes
25560 AUTH_TLS=yes
25561 .endd
25562 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25563 authentication mechanism (RFC 2195), and the second provides an interface to
25564 the Cyrus SASL authentication library.
25565 The third is an interface to Dovecot's authentication system, delegating the
25566 work via a socket interface.
25567 The fourth provides an interface to the GNU SASL authentication library, which
25568 provides mechanisms but typically not data sources.
25569 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25570 supporting setting a server keytab.
25571 The sixth can be configured to support
25572 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25573 not formally documented, but used by several MUAs. The seventh authenticator
25574 supports Microsoft's &'Secure Password Authentication'& mechanism.
25575 The eighth is an Exim authenticator but not an SMTP one;
25576 instead it can use information from a TLS negotiation.
25577
25578 The authenticators are configured using the same syntax as other drivers (see
25579 section &<<SECTfordricon>>&). If no authenticators are required, no
25580 authentication section need be present in the configuration file. Each
25581 authenticator can in principle have both server and client functions. When Exim
25582 is receiving SMTP mail, it is acting as a server; when it is sending out
25583 messages over SMTP, it is acting as a client. Authenticator configuration
25584 options are provided for use in both these circumstances.
25585
25586 To make it clear which options apply to which situation, the prefixes
25587 &%server_%& and &%client_%& are used on option names that are specific to
25588 either the server or the client function, respectively. Server and client
25589 functions are disabled if none of their options are set. If an authenticator is
25590 to be used for both server and client functions, a single definition, using
25591 both sets of options, is required. For example:
25592 .code
25593 cram:
25594   driver = cram_md5
25595   public_name = CRAM-MD5
25596   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25597   client_name = ph10
25598   client_secret = secret2
25599 .endd
25600 The &%server_%& option is used when Exim is acting as a server, and the
25601 &%client_%& options when it is acting as a client.
25602
25603 Descriptions of the individual authenticators are given in subsequent chapters.
25604 The remainder of this chapter covers the generic options for the
25605 authenticators, followed by general discussion of the way authentication works
25606 in Exim.
25607
25608 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25609 per-mechanism basis.  Please read carefully to determine which variables hold
25610 account labels such as usercodes and which hold passwords or other
25611 authenticating data.
25612
25613 Note that some mechanisms support two different identifiers for accounts: the
25614 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25615 and &'authz'& are commonly encountered.  The American spelling is standard here.
25616 Conceptually, authentication data such as passwords are tied to the identifier
25617 used to authenticate; servers may have rules to permit one user to act as a
25618 second user, so that after login the session is treated as though that second
25619 user had logged in.  That second user is the &'authorization id'&.  A robust
25620 configuration might confirm that the &'authz'& field is empty or matches the
25621 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25622 as verified data, the &'authz'& as an unverified request which the server might
25623 choose to honour.
25624
25625 A &'realm'& is a text string, typically a domain name, presented by a server
25626 to a client to help it select an account and credentials to use.  In some
25627 mechanisms, the client and server provably agree on the realm, but clients
25628 typically can not treat the realm as secure data to be blindly trusted.
25629
25630
25631
25632 .section "Generic options for authenticators" "SECID168"
25633 .cindex "authentication" "generic options"
25634 .cindex "options" "generic; for authenticators"
25635
25636 .option client_condition authenticators string&!! unset
25637 When Exim is authenticating as a client, it skips any authenticator whose
25638 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25639 used, for example, to skip plain text authenticators when the connection is not
25640 encrypted by a setting such as:
25641 .code
25642 client_condition = ${if !eq{$tls_out_cipher}{}}
25643 .endd
25644
25645
25646 .option client_set_id authenticators string&!! unset
25647 When client authentication succeeds, this condition is expanded; the
25648 result is used in the log lines for outbound messages.
25649 Typically it will be the user name used for authentication.
25650
25651
25652 .option driver authenticators string unset
25653 This option must always be set. It specifies which of the available
25654 authenticators is to be used.
25655
25656
25657 .option public_name authenticators string unset
25658 This option specifies the name of the authentication mechanism that the driver
25659 implements, and by which it is known to the outside world. These names should
25660 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25661 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25662 defaults to the driver's instance name.
25663
25664
25665 .option server_advertise_condition authenticators string&!! unset
25666 When a server is about to advertise an authentication mechanism, the condition
25667 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25668 mechanism is not advertised.
25669 If the expansion fails, the mechanism is not advertised. If the failure was not
25670 forced, and was not caused by a lookup defer, the incident is logged.
25671 See section &<<SECTauthexiser>>& below for further discussion.
25672
25673
25674 .option server_condition authenticators string&!! unset
25675 This option must be set for a &%plaintext%& server authenticator, where it
25676 is used directly to control authentication. See section &<<SECTplainserver>>&
25677 for details.
25678
25679 For the &(gsasl)& authenticator, this option is required for various
25680 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25681
25682 For the other authenticators, &%server_condition%& can be used as an additional
25683 authentication or authorization mechanism that is applied after the other
25684 authenticator conditions succeed. If it is set, it is expanded when the
25685 authenticator would otherwise return a success code. If the expansion is forced
25686 to fail, authentication fails. Any other expansion failure causes a temporary
25687 error code to be returned. If the result of a successful expansion is an empty
25688 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25689 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25690 other result, a temporary error code is returned, with the expanded string as
25691 the error text.
25692
25693
25694 .option server_debug_print authenticators string&!! unset
25695 If this option is set and authentication debugging is enabled (see the &%-d%&
25696 command line option), the string is expanded and included in the debugging
25697 output when the authenticator is run as a server. This can help with checking
25698 out the values of variables.
25699 If expansion of the string fails, the error message is written to the debugging
25700 output, and Exim carries on processing.
25701
25702
25703 .option server_set_id authenticators string&!! unset
25704 .vindex "&$authenticated_id$&"
25705 When an Exim server successfully authenticates a client, this string is
25706 expanded using data from the authentication, and preserved for any incoming
25707 messages in the variable &$authenticated_id$&. It is also included in the log
25708 lines for incoming messages. For example, a user/password authenticator
25709 configuration might preserve the user name that was used to authenticate, and
25710 refer to it subsequently during delivery of the message.
25711 If expansion fails, the option is ignored.
25712
25713
25714 .option server_mail_auth_condition authenticators string&!! unset
25715 This option allows a server to discard authenticated sender addresses supplied
25716 as part of MAIL commands in SMTP connections that are authenticated by the
25717 driver on which &%server_mail_auth_condition%& is set. The option is not used
25718 as part of the authentication process; instead its (unexpanded) value is
25719 remembered for later use.
25720 How it is used is described in the following section.
25721
25722
25723
25724
25725
25726 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25727 .cindex "authentication" "sender; authenticated"
25728 .cindex "AUTH" "on MAIL command"
25729 When a client supplied an AUTH= item on a MAIL command, Exim applies
25730 the following checks before accepting it as the authenticated sender of the
25731 message:
25732
25733 .ilist
25734 If the connection is not using extended SMTP (that is, HELO was used rather
25735 than EHLO), the use of AUTH= is a syntax error.
25736 .next
25737 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25738 .next
25739 .vindex "&$authenticated_sender$&"
25740 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25741 running, the value of &$authenticated_sender$& is set to the value obtained
25742 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25743 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25744 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25745 given for the MAIL command.
25746 .next
25747 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25748 is accepted and placed in &$authenticated_sender$& only if the client has
25749 authenticated.
25750 .next
25751 If the AUTH= value was accepted by either of the two previous rules, and
25752 the client has authenticated, and the authenticator has a setting for the
25753 &%server_mail_auth_condition%&, the condition is checked at this point. The
25754 valued that was saved from the authenticator is expanded. If the expansion
25755 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25756 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25757 the value of &$authenticated_sender$& is retained and passed on with the
25758 message.
25759 .endlist
25760
25761
25762 When &$authenticated_sender$& is set for a message, it is passed on to other
25763 hosts to which Exim authenticates as a client. Do not confuse this value with
25764 &$authenticated_id$&, which is a string obtained from the authentication
25765 process, and which is not usually a complete email address.
25766
25767 .vindex "&$sender_address$&"
25768 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25769 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25770 therefore make use of &$authenticated_sender$&. The converse is not true: the
25771 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25772 ACL is run.
25773
25774
25775
25776 .section "Authentication on an Exim server" "SECTauthexiser"
25777 .cindex "authentication" "on an Exim server"
25778 When Exim receives an EHLO command, it advertises the public names of those
25779 authenticators that are configured as servers, subject to the following
25780 conditions:
25781
25782 .ilist
25783 The client host must match &%auth_advertise_hosts%& (default *).
25784 .next
25785 It the &%server_advertise_condition%& option is set, its expansion must not
25786 yield the empty string, &"0"&, &"no"&, or &"false"&.
25787 .endlist
25788
25789 The order in which the authenticators are defined controls the order in which
25790 the mechanisms are advertised.
25791
25792 Some mail clients (for example, some versions of Netscape) require the user to
25793 provide a name and password for authentication whenever AUTH is advertised,
25794 even though authentication may not in fact be needed (for example, Exim may be
25795 set up to allow unconditional relaying from the client by an IP address check).
25796 You can make such clients more friendly by not advertising AUTH to them.
25797 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25798 that runs for RCPT) to relay without authentication, you should set
25799 .code
25800 auth_advertise_hosts = ! 10.9.8.0/24
25801 .endd
25802 so that no authentication mechanisms are advertised to them.
25803
25804 The &%server_advertise_condition%& controls the advertisement of individual
25805 authentication mechanisms. For example, it can be used to restrict the
25806 advertisement of a particular mechanism to encrypted connections, by a setting
25807 such as:
25808 .code
25809 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25810 .endd
25811 .vindex "&$tls_in_cipher$&"
25812 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25813 yields &"yes"&, which allows the advertisement to happen.
25814
25815 When an Exim server receives an AUTH command from a client, it rejects it
25816 immediately if AUTH was not advertised in response to an earlier EHLO
25817 command. This is the case if
25818
25819 .ilist
25820 The client host does not match &%auth_advertise_hosts%&; or
25821 .next
25822 No authenticators are configured with server options; or
25823 .next
25824 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25825 server authenticators.
25826 .endlist
25827
25828
25829 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25830 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25831 AUTH is accepted from any client host.
25832
25833 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25834 server authentication mechanism that was advertised in response to EHLO and
25835 that matches the one named in the AUTH command. If it finds one, it runs
25836 the appropriate authentication protocol, and authentication either succeeds or
25837 fails. If there is no matching advertised mechanism, the AUTH command is
25838 rejected with a 504 error.
25839
25840 .vindex "&$received_protocol$&"
25841 .vindex "&$sender_host_authenticated$&"
25842 When a message is received from an authenticated host, the value of
25843 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25844 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25845 public name) of the authenticator driver that successfully authenticated the
25846 client from which the message was received. This variable is empty if there was
25847 no successful authentication.
25848
25849
25850
25851
25852 .section "Testing server authentication" "SECID169"
25853 .cindex "authentication" "testing a server"
25854 .cindex "AUTH" "testing a server"
25855 .cindex "base64 encoding" "creating authentication test data"
25856 Exim's &%-bh%& option can be useful for testing server authentication
25857 configurations. The data for the AUTH command has to be sent using base64
25858 encoding. A quick way to produce such data for testing is the following Perl
25859 script:
25860 .code
25861 use MIME::Base64;
25862 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25863 .endd
25864 .cindex "binary zero" "in authentication data"
25865 This interprets its argument as a Perl string, and then encodes it. The
25866 interpretation as a Perl string allows binary zeros, which are required for
25867 some kinds of authentication, to be included in the data. For example, a
25868 command line to run this script on such data might be
25869 .code
25870 encode '\0user\0password'
25871 .endd
25872 Note the use of single quotes to prevent the shell interpreting the
25873 backslashes, so that they can be interpreted by Perl to specify characters
25874 whose code value is zero.
25875
25876 &*Warning 1*&: If either of the user or password strings starts with an octal
25877 digit, you must use three zeros instead of one after the leading backslash. If
25878 you do not, the octal digit that starts your string will be incorrectly
25879 interpreted as part of the code for the first character.
25880
25881 &*Warning 2*&: If there are characters in the strings that Perl interprets
25882 specially, you must use a Perl escape to prevent them being misinterpreted. For
25883 example, a command such as
25884 .code
25885 encode '\0user@domain.com\0pas$$word'
25886 .endd
25887 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25888
25889 If you have the &%mimencode%& command installed, another way to do produce
25890 base64-encoded strings is to run the command
25891 .code
25892 echo -e -n `\0user\0password' | mimencode
25893 .endd
25894 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25895 in the argument, and the &%-n%& option specifies no newline at the end of its
25896 output. However, not all versions of &%echo%& recognize these options, so you
25897 should check your version before relying on this suggestion.
25898
25899
25900
25901 .section "Authentication by an Exim client" "SECID170"
25902 .cindex "authentication" "on an Exim client"
25903 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25904 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25905 announces support for authentication, and the host matches an entry in either
25906 of these options, Exim (as a client) tries to authenticate as follows:
25907
25908 .ilist
25909 For each authenticator that is configured as a client, in the order in which
25910 they are defined in the configuration, it searches the authentication
25911 mechanisms announced by the server for one whose name matches the public name
25912 of the authenticator.
25913 .next
25914 .vindex "&$host$&"
25915 .vindex "&$host_address$&"
25916 When it finds one that matches, it runs the authenticator's client code. The
25917 variables &$host$& and &$host_address$& are available for any string expansions
25918 that the client might do. They are set to the server's name and IP address. If
25919 any expansion is forced to fail, the authentication attempt is abandoned, and
25920 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25921 delivery to be deferred.
25922 .next
25923 If the result of the authentication attempt is a temporary error or a timeout,
25924 Exim abandons trying to send the message to the host for the moment. It will
25925 try again later. If there are any backup hosts available, they are tried in the
25926 usual way.
25927 .next
25928 If the response to authentication is a permanent error (5&'xx'& code), Exim
25929 carries on searching the list of authenticators and tries another one if
25930 possible. If all authentication attempts give permanent errors, or if there are
25931 no attempts because no mechanisms match (or option expansions force failure),
25932 what happens depends on whether the host matches &%hosts_require_auth%& or
25933 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25934 delivery is deferred. The error can be detected in the retry rules, and thereby
25935 turned into a permanent error if you wish. In the second case, Exim tries to
25936 deliver the message unauthenticated.
25937 .endlist
25938
25939 Note that the hostlist test for whether to do authentication can be
25940 confused if name-IP lookups change between the time the peer is decided
25941 on and the transport running.  For example, with a manualroute
25942 router given a host name, and DNS "round-robin" use by that name: if
25943 the local resolver cache times out between the router and the transport
25944 running, the transport may get an IP for the name for its authentication
25945 check which does not match the connection peer IP.
25946 No authentication will then be done, despite the names being identical.
25947
25948 For such cases use a separate transport which always authenticates.
25949
25950 .cindex "AUTH" "on MAIL command"
25951 When Exim has authenticated itself to a remote server, it adds the AUTH
25952 parameter to the MAIL commands it sends, if it has an authenticated sender for
25953 the message. If the message came from a remote host, the authenticated sender
25954 is the one that was receiving on an incoming MAIL command, provided that the
25955 incoming connection was authenticated and the &%server_mail_auth%& condition
25956 allowed the authenticated sender to be retained. If a local process calls Exim
25957 to send a message, the sender address that is built from the login name and
25958 &%qualify_domain%& is treated as authenticated. However, if the
25959 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25960 the authenticated sender that was received with the message.
25961 .ecindex IIDauthconf1
25962 .ecindex IIDauthconf2
25963
25964
25965
25966
25967
25968
25969 . ////////////////////////////////////////////////////////////////////////////
25970 . ////////////////////////////////////////////////////////////////////////////
25971
25972 .chapter "The plaintext authenticator" "CHAPplaintext"
25973 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25974 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25975 The &(plaintext)& authenticator can be configured to support the PLAIN and
25976 LOGIN authentication mechanisms, both of which transfer authentication data as
25977 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25978 security risk; you are strongly advised to insist on the use of SMTP encryption
25979 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25980 use unencrypted plain text, you should not use the same passwords for SMTP
25981 connections as you do for login accounts.
25982
25983 .section "Plaintext options" "SECID171"
25984 .cindex "options" "&(plaintext)& authenticator (server)"
25985 When configured as a server, &(plaintext)& uses the following options:
25986
25987 .option server_condition authenticators string&!! unset
25988 This is actually a global authentication option, but it must be set in order to
25989 configure the &(plaintext)& driver as a server. Its use is described below.
25990
25991 .option server_prompts plaintext string&!! unset
25992 The contents of this option, after expansion, must be a colon-separated list of
25993 prompt strings. If expansion fails, a temporary authentication rejection is
25994 given.
25995
25996 .section "Using plaintext in a server" "SECTplainserver"
25997 .cindex "AUTH" "in &(plaintext)& authenticator"
25998 .cindex "binary zero" "in &(plaintext)& authenticator"
25999 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26000         "in &(plaintext)& authenticator"
26001 .vindex "&$auth1$&, &$auth2$&, etc"
26002 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26003
26004 When running as a server, &(plaintext)& performs the authentication test by
26005 expanding a string. The data sent by the client with the AUTH command, or in
26006 response to subsequent prompts, is base64 encoded, and so may contain any byte
26007 values when decoded. If any data is supplied with the command, it is treated as
26008 a list of strings, separated by NULs (binary zeros), the first three of which
26009 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26010 (neither LOGIN nor PLAIN uses more than three strings).
26011
26012 For compatibility with previous releases of Exim, the values are also placed in
26013 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26014 variables for this purpose is now deprecated, as it can lead to confusion in
26015 string expansions that also use them for other things.
26016
26017 If there are more strings in &%server_prompts%& than the number of strings
26018 supplied with the AUTH command, the remaining prompts are used to obtain more
26019 data. Each response from the client may be a list of NUL-separated strings.
26020
26021 .vindex "&$authenticated_id$&"
26022 Once a sufficient number of data strings have been received,
26023 &%server_condition%& is expanded. If the expansion is forced to fail,
26024 authentication fails. Any other expansion failure causes a temporary error code
26025 to be returned. If the result of a successful expansion is an empty string,
26026 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26027 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26028 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26029 For any other result, a temporary error code is returned, with the expanded
26030 string as the error text
26031
26032 &*Warning*&: If you use a lookup in the expansion to find the user's
26033 password, be sure to make the authentication fail if the user is unknown.
26034 There are good and bad examples at the end of the next section.
26035
26036
26037
26038 .section "The PLAIN authentication mechanism" "SECID172"
26039 .cindex "PLAIN authentication mechanism"
26040 .cindex "authentication" "PLAIN mechanism"
26041 .cindex "binary zero" "in &(plaintext)& authenticator"
26042 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26043 sent as one item of data (that is, one combined string containing two NUL
26044 separators). The data is sent either as part of the AUTH command, or
26045 subsequently in response to an empty prompt from the server.
26046
26047 The second and third strings are a user name and a corresponding password.
26048 Using a single fixed user name and password as an example, this could be
26049 configured as follows:
26050 .code
26051 fixed_plain:
26052   driver = plaintext
26053   public_name = PLAIN
26054   server_prompts = :
26055   server_condition = \
26056     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26057   server_set_id = $auth2
26058 .endd
26059 Note that the default result strings from &%if%& (&"true"& or an empty string)
26060 are exactly what we want here, so they need not be specified. Obviously, if the
26061 password contains expansion-significant characters such as dollar, backslash,
26062 or closing brace, they have to be escaped.
26063
26064 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26065 the end of a string list are ignored). If all the data comes as part of the
26066 AUTH command, as is commonly the case, the prompt is not used. This
26067 authenticator is advertised in the response to EHLO as
26068 .code
26069 250-AUTH PLAIN
26070 .endd
26071 and a client host can authenticate itself by sending the command
26072 .code
26073 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26074 .endd
26075 As this contains three strings (more than the number of prompts), no further
26076 data is required from the client. Alternatively, the client may just send
26077 .code
26078 AUTH PLAIN
26079 .endd
26080 to initiate authentication, in which case the server replies with an empty
26081 prompt. The client must respond with the combined data string.
26082
26083 The data string is base64 encoded, as required by the RFC. This example,
26084 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26085 represents a zero byte. This is split up into three strings, the first of which
26086 is empty. The &%server_condition%& option in the authenticator checks that the
26087 second two are &`username`& and &`mysecret`& respectively.
26088
26089 Having just one fixed user name and password, as in this example, is not very
26090 realistic, though for a small organization with only a handful of
26091 authenticating clients it could make sense.
26092
26093 A more sophisticated instance of this authenticator could use the user name in
26094 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26095 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26096 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26097 This is an incorrect example:
26098 .code
26099 server_condition = \
26100   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26101 .endd
26102 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26103 which it then compares to the supplied password (&$auth3$&). Why is this example
26104 incorrect? It works fine for existing users, but consider what happens if a
26105 non-existent user name is given. The lookup fails, but as no success/failure
26106 strings are given for the lookup, it yields an empty string. Thus, to defeat
26107 the authentication, all a client has to do is to supply a non-existent user
26108 name and an empty password. The correct way of writing this test is:
26109 .code
26110 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26111   {${if eq{$value}{$auth3}}} {false}}
26112 .endd
26113 In this case, if the lookup succeeds, the result is checked; if the lookup
26114 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26115 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26116 always fails if its second argument is empty. However, the second way of
26117 writing the test makes the logic clearer.
26118
26119
26120 .section "The LOGIN authentication mechanism" "SECID173"
26121 .cindex "LOGIN authentication mechanism"
26122 .cindex "authentication" "LOGIN mechanism"
26123 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26124 in a number of programs. No data is sent with the AUTH command. Instead, a
26125 user name and password are supplied separately, in response to prompts. The
26126 plaintext authenticator can be configured to support this as in this example:
26127 .code
26128 fixed_login:
26129   driver = plaintext
26130   public_name = LOGIN
26131   server_prompts = User Name : Password
26132   server_condition = \
26133     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26134   server_set_id = $auth1
26135 .endd
26136 Because of the way plaintext operates, this authenticator accepts data supplied
26137 with the AUTH command (in contravention of the specification of LOGIN), but
26138 if the client does not supply it (as is the case for LOGIN clients), the prompt
26139 strings are used to obtain two data items.
26140
26141 Some clients are very particular about the precise text of the prompts. For
26142 example, Outlook Express is reported to recognize only &"Username:"& and
26143 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26144 strings. It uses the &%ldapauth%& expansion condition to check the user
26145 name and password by binding to an LDAP server:
26146 .code
26147 login:
26148   driver = plaintext
26149   public_name = LOGIN
26150   server_prompts = Username:: : Password::
26151   server_condition = ${if and{{ \
26152     !eq{}{$auth1} }{ \
26153     ldapauth{\
26154       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26155       pass=${quote:$auth2} \
26156       ldap://ldap.example.org/} }} }
26157   server_set_id = uid=$auth1,ou=people,o=example.org
26158 .endd
26159 We have to check that the username is not empty before using it, because LDAP
26160 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26161 operator to correctly quote the DN for authentication. However, the basic
26162 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26163 correct one to use for the password, because quoting is needed only to make
26164 the password conform to the Exim syntax. At the LDAP level, the password is an
26165 uninterpreted string.
26166
26167
26168 .section "Support for different kinds of authentication" "SECID174"
26169 A number of string expansion features are provided for the purpose of
26170 interfacing to different ways of user authentication. These include checking
26171 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26172 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26173 &<<SECTexpcond>>&.
26174
26175
26176
26177
26178 .section "Using plaintext in a client" "SECID175"
26179 .cindex "options" "&(plaintext)& authenticator (client)"
26180 The &(plaintext)& authenticator has two client options:
26181
26182 .option client_ignore_invalid_base64 plaintext boolean false
26183 If the client receives a server prompt that is not a valid base64 string,
26184 authentication is abandoned by default. However, if this option is set true,
26185 the error in the challenge is ignored and the client sends the response as
26186 usual.
26187
26188 .option client_send plaintext string&!! unset
26189 The string is a colon-separated list of authentication data strings. Each
26190 string is independently expanded before being sent to the server. The first
26191 string is sent with the AUTH command; any more strings are sent in response
26192 to prompts from the server. Before each string is expanded, the value of the
26193 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26194 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26195 way. Thus, the prompt that is received in response to sending the first string
26196 (with the AUTH command) can be used in the expansion of the second string, and
26197 so on. If an invalid base64 string is received when
26198 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26199 &$auth$&<&'n'&> variable.
26200
26201 &*Note*&: You cannot use expansion to create multiple strings, because
26202 splitting takes priority and happens first.
26203
26204 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26205 the data, further processing is applied to each string before it is sent. If
26206 there are any single circumflex characters in the string, they are converted to
26207 NULs. Should an actual circumflex be required as data, it must be doubled in
26208 the string.
26209
26210 This is an example of a client configuration that implements the PLAIN
26211 authentication mechanism with a fixed user name and password:
26212 .code
26213 fixed_plain:
26214   driver = plaintext
26215   public_name = PLAIN
26216   client_send = ^username^mysecret
26217 .endd
26218 The lack of colons means that the entire text is sent with the AUTH
26219 command, with the circumflex characters converted to NULs. A similar example
26220 that uses the LOGIN mechanism is:
26221 .code
26222 fixed_login:
26223   driver = plaintext
26224   public_name = LOGIN
26225   client_send = : username : mysecret
26226 .endd
26227 The initial colon means that the first string is empty, so no data is sent with
26228 the AUTH command itself. The remaining strings are sent in response to
26229 prompts.
26230 .ecindex IIDplaiauth1
26231 .ecindex IIDplaiauth2
26232
26233
26234
26235
26236 . ////////////////////////////////////////////////////////////////////////////
26237 . ////////////////////////////////////////////////////////////////////////////
26238
26239 .chapter "The cram_md5 authenticator" "CHID9"
26240 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26241 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26242 .cindex "CRAM-MD5 authentication mechanism"
26243 .cindex "authentication" "CRAM-MD5 mechanism"
26244 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26245 sends a challenge string to the client, and the response consists of a user
26246 name and the CRAM-MD5 digest of the challenge string combined with a secret
26247 string (password) which is known to both server and client. Thus, the secret
26248 is not sent over the network as plain text, which makes this authenticator more
26249 secure than &(plaintext)&. However, the downside is that the secret has to be
26250 available in plain text at either end.
26251
26252
26253 .section "Using cram_md5 as a server" "SECID176"
26254 .cindex "options" "&(cram_md5)& authenticator (server)"
26255 This authenticator has one server option, which must be set to configure the
26256 authenticator as a server:
26257
26258 .option server_secret cram_md5 string&!! unset
26259 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26260 When the server receives the client's response, the user name is placed in
26261 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26262 obtain the password for that user. The server then computes the CRAM-MD5 digest
26263 that the client should have sent, and checks that it received the correct
26264 string. If the expansion of &%server_secret%& is forced to fail, authentication
26265 fails. If the expansion fails for some other reason, a temporary error code is
26266 returned to the client.
26267
26268 For compatibility with previous releases of Exim, the user name is also placed
26269 in &$1$&. However, the use of this variables for this purpose is now
26270 deprecated, as it can lead to confusion in string expansions that also use
26271 numeric variables for other things.
26272
26273 For example, the following authenticator checks that the user name given by the
26274 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26275 user name, authentication fails.
26276 .code
26277 fixed_cram:
26278   driver = cram_md5
26279   public_name = CRAM-MD5
26280   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26281   server_set_id = $auth1
26282 .endd
26283 .vindex "&$authenticated_id$&"
26284 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26285 name in &$authenticated_id$&. A more typical configuration might look up the
26286 secret string in a file, using the user name as the key. For example:
26287 .code
26288 lookup_cram:
26289   driver = cram_md5
26290   public_name = CRAM-MD5
26291   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26292                   {$value}fail}
26293   server_set_id = $auth1
26294 .endd
26295 Note that this expansion explicitly forces failure if the lookup fails
26296 because &$auth1$& contains an unknown user name.
26297
26298 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26299 using the relevant libraries, you need to know the realm to specify in the
26300 lookup and then ask for the &"userPassword"& attribute for that user in that
26301 realm, with:
26302 .code
26303 cyrusless_crammd5:
26304   driver = cram_md5
26305   public_name = CRAM-MD5
26306   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26307                   dbmjz{/etc/sasldb2}{$value}fail}
26308   server_set_id = $auth1
26309 .endd
26310
26311 .section "Using cram_md5 as a client" "SECID177"
26312 .cindex "options" "&(cram_md5)& authenticator (client)"
26313 When used as a client, the &(cram_md5)& authenticator has two options:
26314
26315
26316
26317 .option client_name cram_md5 string&!! "the primary host name"
26318 This string is expanded, and the result used as the user name data when
26319 computing the response to the server's challenge.
26320
26321
26322 .option client_secret cram_md5 string&!! unset
26323 This option must be set for the authenticator to work as a client. Its value is
26324 expanded and the result used as the secret string when computing the response.
26325
26326
26327 .vindex "&$host$&"
26328 .vindex "&$host_address$&"
26329 Different user names and secrets can be used for different servers by referring
26330 to &$host$& or &$host_address$& in the options. Forced failure of either
26331 expansion string is treated as an indication that this authenticator is not
26332 prepared to handle this case. Exim moves on to the next configured client
26333 authenticator. Any other expansion failure causes Exim to give up trying to
26334 send the message to the current server.
26335
26336 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26337 strings, is:
26338 .code
26339 fixed_cram:
26340   driver = cram_md5
26341   public_name = CRAM-MD5
26342   client_name = ph10
26343   client_secret = secret
26344 .endd
26345 .ecindex IIDcramauth1
26346 .ecindex IIDcramauth2
26347
26348
26349
26350 . ////////////////////////////////////////////////////////////////////////////
26351 . ////////////////////////////////////////////////////////////////////////////
26352
26353 .chapter "The cyrus_sasl authenticator" "CHID10"
26354 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26355 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26356 .cindex "Cyrus" "SASL library"
26357 .cindex "Kerberos"
26358 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26359 Digital Ltd (&url(http://www.aldigital.co.uk)).
26360
26361 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26362 library implementation of the RFC 2222 (&"Simple Authentication and Security
26363 Layer"&). This library supports a number of authentication mechanisms,
26364 including PLAIN and LOGIN, but also several others that Exim does not support
26365 directly. In particular, there is support for Kerberos authentication.
26366
26367 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26368 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26369 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26370 name of the driver to determine which mechanism to support.
26371
26372 Where access to some kind of secret file is required, for example in GSSAPI
26373 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26374 user, and that the Cyrus SASL library has no way of escalating privileges
26375 by default. You may also find you need to set environment variables,
26376 depending on the driver you are using.
26377
26378 The application name provided by Exim is &"exim"&, so various SASL options may
26379 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26380 Kerberos, note that because of limitations in the GSSAPI interface,
26381 changing the server keytab might need to be communicated down to the Kerberos
26382 layer independently. The mechanism for doing so is dependent upon the Kerberos
26383 implementation.
26384
26385 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26386 may be set to point to an alternative keytab file. Exim will pass this
26387 variable through from its own inherited environment when started as root or the
26388 Exim user. The keytab file needs to be readable by the Exim user.
26389 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26390 environment variable.  In practice, for those releases, the Cyrus authenticator
26391 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26392 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26393
26394
26395 .section "Using cyrus_sasl as a server" "SECID178"
26396 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26397 (on a successful authentication) into &$auth1$&. For compatibility with
26398 previous releases of Exim, the username is also placed in &$1$&. However, the
26399 use of this variable for this purpose is now deprecated, as it can lead to
26400 confusion in string expansions that also use numeric variables for other
26401 things.
26402
26403
26404 .option server_hostname cyrus_sasl string&!! "see below"
26405 This option selects the hostname that is used when communicating with the
26406 library. The default value is &`$primary_hostname`&. It is up to the underlying
26407 SASL plug-in what it does with this data.
26408
26409
26410 .option server_mech cyrus_sasl string "see below"
26411 This option selects the authentication mechanism this driver should use. The
26412 default is the value of the generic &%public_name%& option. This option allows
26413 you to use a different underlying mechanism from the advertised name. For
26414 example:
26415 .code
26416 sasl:
26417   driver = cyrus_sasl
26418   public_name = X-ANYTHING
26419   server_mech = CRAM-MD5
26420   server_set_id = $auth1
26421 .endd
26422
26423 .option server_realm cyrus_sasl string&!! unset
26424 This specifies the SASL realm that the server claims to be in.
26425
26426
26427 .option server_service cyrus_sasl string &`smtp`&
26428 This is the SASL service that the server claims to implement.
26429
26430
26431 For straightforward cases, you do not need to set any of the authenticator's
26432 private options. All you need to do is to specify an appropriate mechanism as
26433 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26434 PLAIN, you could have two authenticators as follows:
26435 .code
26436 sasl_cram_md5:
26437   driver = cyrus_sasl
26438   public_name = CRAM-MD5
26439   server_set_id = $auth1
26440
26441 sasl_plain:
26442   driver = cyrus_sasl
26443   public_name = PLAIN
26444   server_set_id = $auth2
26445 .endd
26446 Cyrus SASL does implement the LOGIN authentication method, even though it is
26447 not a standard method. It is disabled by default in the source distribution,
26448 but it is present in many binary distributions.
26449 .ecindex IIDcyrauth1
26450 .ecindex IIDcyrauth2
26451
26452
26453
26454
26455 . ////////////////////////////////////////////////////////////////////////////
26456 . ////////////////////////////////////////////////////////////////////////////
26457 .chapter "The dovecot authenticator" "CHAPdovecot"
26458 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26459 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26460 This authenticator is an interface to the authentication facility of the
26461 Dovecot POP/IMAP server, which can support a number of authentication methods.
26462 Note that Dovecot must be configured to use auth-client not auth-userdb.
26463 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26464 to use the same mechanisms for SMTP authentication. This is a server
26465 authenticator only. There is only one option:
26466
26467 .option server_socket dovecot string unset
26468
26469 This option must specify the socket that is the interface to Dovecot
26470 authentication. The &%public_name%& option must specify an authentication
26471 mechanism that Dovecot is configured to support. You can have several
26472 authenticators for different mechanisms. For example:
26473 .code
26474 dovecot_plain:
26475   driver = dovecot
26476   public_name = PLAIN
26477   server_socket = /var/run/dovecot/auth-client
26478   server_set_id = $auth1
26479
26480 dovecot_ntlm:
26481   driver = dovecot
26482   public_name = NTLM
26483   server_socket = /var/run/dovecot/auth-client
26484   server_set_id = $auth1
26485 .endd
26486 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26487 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26488 option is passed in the Dovecot authentication command. If, for a TLS
26489 connection, a client certificate has been verified, the &"valid-client-cert"&
26490 option is passed. When authentication succeeds, the identity of the user
26491 who authenticated is placed in &$auth1$&.
26492 .ecindex IIDdcotauth1
26493 .ecindex IIDdcotauth2
26494
26495
26496 . ////////////////////////////////////////////////////////////////////////////
26497 . ////////////////////////////////////////////////////////////////////////////
26498 .chapter "The gsasl authenticator" "CHAPgsasl"
26499 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26500 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26501 .cindex "authentication" "GNU SASL"
26502 .cindex "authentication" "SASL"
26503 .cindex "authentication" "EXTERNAL"
26504 .cindex "authentication" "ANONYMOUS"
26505 .cindex "authentication" "PLAIN"
26506 .cindex "authentication" "LOGIN"
26507 .cindex "authentication" "DIGEST-MD5"
26508 .cindex "authentication" "CRAM-MD5"
26509 .cindex "authentication" "SCRAM-SHA-1"
26510 The &(gsasl)& authenticator provides server integration for the GNU SASL
26511 library and the mechanisms it provides.  This is new as of the 4.80 release
26512 and there are a few areas where the library does not let Exim smoothly
26513 scale to handle future authentication mechanisms, so no guarantee can be
26514 made that any particular new authentication mechanism will be supported
26515 without code changes in Exim.
26516
26517
26518 .option server_channelbinding gsasl boolean false
26519 Some authentication mechanisms are able to use external context at both ends
26520 of the session to bind the authentication to that context, and fail the
26521 authentication process if that context differs.  Specifically, some TLS
26522 ciphersuites can provide identifying information about the cryptographic
26523 context.
26524
26525 This means that certificate identity and verification becomes a non-issue,
26526 as a man-in-the-middle attack will cause the correct client and server to
26527 see different identifiers and authentication will fail.
26528
26529 This is currently only supported when using the GnuTLS library.  This is
26530 only usable by mechanisms which support "channel binding"; at time of
26531 writing, that's the SCRAM family.
26532
26533 This defaults off to ensure smooth upgrade across Exim releases, in case
26534 this option causes some clients to start failing.  Some future release
26535 of Exim may switch the default to be true.
26536
26537
26538 .option server_hostname gsasl string&!! "see below"
26539 This option selects the hostname that is used when communicating with the
26540 library. The default value is &`$primary_hostname`&.
26541 Some mechanisms will use this data.
26542
26543
26544 .option server_mech gsasl string "see below"
26545 This option selects the authentication mechanism this driver should use. The
26546 default is the value of the generic &%public_name%& option. This option allows
26547 you to use a different underlying mechanism from the advertised name. For
26548 example:
26549 .code
26550 sasl:
26551   driver = gsasl
26552   public_name = X-ANYTHING
26553   server_mech = CRAM-MD5
26554   server_set_id = $auth1
26555 .endd
26556
26557
26558 .option server_password gsasl string&!! unset
26559 Various mechanisms need access to the cleartext password on the server, so
26560 that proof-of-possession can be demonstrated on the wire, without sending
26561 the password itself.
26562
26563 The data available for lookup varies per mechanism.
26564 In all cases, &$auth1$& is set to the &'authentication id'&.
26565 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26566 if available, else the empty string.
26567 The &$auth3$& variable will always be the &'realm'& if available,
26568 else the empty string.
26569
26570 A forced failure will cause authentication to defer.
26571
26572 If using this option, it may make sense to set the &%server_condition%&
26573 option to be simply "true".
26574
26575
26576 .option server_realm gsasl string&!! unset
26577 This specifies the SASL realm that the server claims to be in.
26578 Some mechanisms will use this data.
26579
26580
26581 .option server_scram_iter gsasl string&!! unset
26582 This option provides data for the SCRAM family of mechanisms.
26583 &$auth1$& is not available at evaluation time.
26584 (This may change, as we receive feedback on use)
26585
26586
26587 .option server_scram_salt gsasl string&!! unset
26588 This option provides data for the SCRAM family of mechanisms.
26589 &$auth1$& is not available at evaluation time.
26590 (This may change, as we receive feedback on use)
26591
26592
26593 .option server_service gsasl string &`smtp`&
26594 This is the SASL service that the server claims to implement.
26595 Some mechanisms will use this data.
26596
26597
26598 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26599 .vindex "&$auth1$&, &$auth2$&, etc"
26600 These may be set when evaluating specific options, as detailed above.
26601 They will also be set when evaluating &%server_condition%&.
26602
26603 Unless otherwise stated below, the &(gsasl)& integration will use the following
26604 meanings for these variables:
26605
26606 .ilist
26607 .vindex "&$auth1$&"
26608 &$auth1$&: the &'authentication id'&
26609 .next
26610 .vindex "&$auth2$&"
26611 &$auth2$&: the &'authorization id'&
26612 .next
26613 .vindex "&$auth3$&"
26614 &$auth3$&: the &'realm'&
26615 .endlist
26616
26617 On a per-mechanism basis:
26618
26619 .ilist
26620 .cindex "authentication" "EXTERNAL"
26621 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26622 the &%server_condition%& option must be present.
26623 .next
26624 .cindex "authentication" "ANONYMOUS"
26625 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26626 the &%server_condition%& option must be present.
26627 .next
26628 .cindex "authentication" "GSSAPI"
26629 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26630 &$auth2$& will be set to the &'authorization id'&,
26631 the &%server_condition%& option must be present.
26632 .endlist
26633
26634 An &'anonymous token'& is something passed along as an unauthenticated
26635 identifier; this is analogous to FTP anonymous authentication passing an
26636 email address, or software-identifier@, as the "password".
26637
26638
26639 An example showing the password having the realm specified in the callback
26640 and demonstrating a Cyrus SASL to GSASL migration approach is:
26641 .code
26642 gsasl_cyrusless_crammd5:
26643   driver = gsasl
26644   public_name = CRAM-MD5
26645   server_realm = imap.example.org
26646   server_password = ${lookup{$auth1:$auth3:userPassword}\
26647                     dbmjz{/etc/sasldb2}{$value}fail}
26648   server_set_id = ${quote:$auth1}
26649   server_condition = yes
26650 .endd
26651
26652
26653 . ////////////////////////////////////////////////////////////////////////////
26654 . ////////////////////////////////////////////////////////////////////////////
26655
26656 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26657 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26658 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26659 .cindex "authentication" "GSSAPI"
26660 .cindex "authentication" "Kerberos"
26661 The &(heimdal_gssapi)& authenticator provides server integration for the
26662 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26663 reliably.
26664
26665 .option server_hostname heimdal_gssapi string&!! "see below"
26666 This option selects the hostname that is used, with &%server_service%&,
26667 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26668 identifier.  The default value is &`$primary_hostname`&.
26669
26670 .option server_keytab heimdal_gssapi string&!! unset
26671 If set, then Heimdal will not use the system default keytab (typically
26672 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26673 The value should be a pathname, with no &"file:"& prefix.
26674
26675 .option server_service heimdal_gssapi string&!! "smtp"
26676 This option specifies the service identifier used, in conjunction with
26677 &%server_hostname%&, for building the identifier for finding credentials
26678 from the keytab.
26679
26680
26681 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26682 Beware that these variables will typically include a realm, thus will appear
26683 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26684 not verified, so a malicious client can set it to anything.
26685
26686 The &$auth1$& field should be safely trustable as a value from the Key
26687 Distribution Center.  Note that these are not quite email addresses.
26688 Each identifier is for a role, and so the left-hand-side may include a
26689 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26690
26691 .vindex "&$auth1$&, &$auth2$&, etc"
26692 .ilist
26693 .vindex "&$auth1$&"
26694 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26695 .next
26696 .vindex "&$auth2$&"
26697 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26698 authentication.  If that was empty, this will also be set to the
26699 GSS Display Name.
26700 .endlist
26701
26702
26703 . ////////////////////////////////////////////////////////////////////////////
26704 . ////////////////////////////////////////////////////////////////////////////
26705
26706 .chapter "The spa authenticator" "CHAPspa"
26707 .scindex IIDspaauth1 "&(spa)& authenticator"
26708 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26709 .cindex "authentication" "Microsoft Secure Password"
26710 .cindex "authentication" "NTLM"
26711 .cindex "Microsoft Secure Password Authentication"
26712 .cindex "NTLM authentication"
26713 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26714 Password Authentication'& mechanism,
26715 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26716 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26717 taken from the Samba project (&url(http://www.samba.org)). The code for the
26718 server side was subsequently contributed by Tom Kistner. The mechanism works as
26719 follows:
26720
26721 .ilist
26722 After the AUTH command has been accepted, the client sends an SPA
26723 authentication request based on the user name and optional domain.
26724 .next
26725 The server sends back a challenge.
26726 .next
26727 The client builds a challenge response which makes use of the user's password
26728 and sends it to the server, which then accepts or rejects it.
26729 .endlist
26730
26731 Encryption is used to protect the password in transit.
26732
26733
26734
26735 .section "Using spa as a server" "SECID179"
26736 .cindex "options" "&(spa)& authenticator (server)"
26737 The &(spa)& authenticator has just one server option:
26738
26739 .option server_password spa string&!! unset
26740 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26741 This option is expanded, and the result must be the cleartext password for the
26742 authenticating user, whose name is at this point in &$auth1$&. For
26743 compatibility with previous releases of Exim, the user name is also placed in
26744 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26745 it can lead to confusion in string expansions that also use numeric variables
26746 for other things. For example:
26747 .code
26748 spa:
26749   driver = spa
26750   public_name = NTLM
26751   server_password = \
26752     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26753 .endd
26754 If the expansion is forced to fail, authentication fails. Any other expansion
26755 failure causes a temporary error code to be returned.
26756
26757
26758
26759
26760
26761 .section "Using spa as a client" "SECID180"
26762 .cindex "options" "&(spa)& authenticator (client)"
26763 The &(spa)& authenticator has the following client options:
26764
26765
26766
26767 .option client_domain spa string&!! unset
26768 This option specifies an optional domain for the authentication.
26769
26770
26771 .option client_password spa string&!! unset
26772 This option specifies the user's password, and must be set.
26773
26774
26775 .option client_username spa string&!! unset
26776 This option specifies the user name, and must be set. Here is an example of a
26777 configuration of this authenticator for use with the mail servers at
26778 &'msn.com'&:
26779 .code
26780 msn:
26781   driver = spa
26782   public_name = MSN
26783   client_username = msn/msn_username
26784   client_password = msn_plaintext_password
26785   client_domain = DOMAIN_OR_UNSET
26786 .endd
26787 .ecindex IIDspaauth1
26788 .ecindex IIDspaauth2
26789
26790
26791
26792
26793
26794 . ////////////////////////////////////////////////////////////////////////////
26795 . ////////////////////////////////////////////////////////////////////////////
26796
26797 .chapter "The tls authenticator" "CHAPtlsauth"
26798 .scindex IIDtlsauth1 "&(tls)& authenticator"
26799 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26800 .cindex "authentication" "Client Certificate"
26801 .cindex "authentication" "X509"
26802 .cindex "Certificate-based authentication"
26803 The &(tls)& authenticator provides server support for
26804 authentication based on client certificates.
26805
26806 It is not an SMTP authentication mechanism and is not
26807 advertised by the server as part of the SMTP EHLO response.
26808 It is an Exim authenticator in the sense that it affects
26809 the protocol element of the log line, can be tested for
26810 by the &%authenticated%& ACL condition, and can set
26811 the &$authenticated_id$& variable.
26812
26813 The client must present a verifiable certificate,
26814 for which it must have been requested via the
26815 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26816 (see &<<CHAPTLS>>&).
26817
26818 If an authenticator of this type is configured it is
26819 run before any SMTP-level communication is done,
26820 and can authenticate the connection.
26821 If it does, SMTP authentication is not offered.
26822
26823 A maximum of one authenticator of this type may be present.
26824
26825
26826 .cindex "options" "&(tls)& authenticator (server)"
26827 The &(tls)& authenticator has three server options:
26828
26829 .option server_param1 tls string&!! unset
26830 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26831 This option is expanded after the TLS negotiation and
26832 the result is placed in &$auth1$&.
26833 If the expansion is forced to fail, authentication fails. Any other expansion
26834 failure causes a temporary error code to be returned.
26835
26836 .option server_param2 tls string&!! unset
26837 .option server_param3 tls string&!! unset
26838 As above, for &$auth2$& and &$auth3$&.
26839
26840 &%server_param1%& may also be spelled &%server_param%&.
26841
26842
26843 Example:
26844 .code
26845 tls:
26846   driver = tls
26847   server_param1 =     ${certextract {subj_altname,mail,>:} \
26848                                     {$tls_in_peercert}}
26849   server_condition =  ${if forany {$auth1} \
26850                             {!= {0} \
26851                                 {${lookup ldap{ldap:///\
26852                          mailname=${quote_ldap_dn:${lc:$item}},\
26853                          ou=users,LDAP_DC?mailid} {$value}{0} \
26854                        }    }   } }
26855   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26856 .endd
26857 This accepts a client certificate that is verifiable against any
26858 of your configured trust-anchors
26859 (which usually means the full set of public CAs)
26860 and which has a SAN with a good account name.
26861 Note that the client cert is on the wire in-clear, including the SAN,
26862 whereas a plaintext SMTP AUTH done inside TLS is not.
26863
26864 . An alternative might use
26865 . .code
26866 .   server_param1 = ${sha256:$tls_in_peercert}
26867 . .endd
26868 . to require one of a set of specific certs that define a given account
26869 . (the verification is still required, but mostly irrelevant).
26870 . This would help for per-device use.
26871 .
26872 . However, for the future we really need support for checking a
26873 . user cert in LDAP - which probably wants a base-64 DER.
26874
26875 .ecindex IIDtlsauth1
26876 .ecindex IIDtlsauth2
26877
26878
26879 Note that because authentication is traditionally an SMTP operation,
26880 the &%authenticated%& ACL condition cannot be used in
26881 a connect- or helo-ACL.
26882
26883
26884
26885 . ////////////////////////////////////////////////////////////////////////////
26886 . ////////////////////////////////////////////////////////////////////////////
26887
26888 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26889          "Encrypted SMTP connections"
26890 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26891 .scindex IIDencsmtp2 "SMTP" "encryption"
26892 .cindex "TLS" "on SMTP connection"
26893 .cindex "OpenSSL"
26894 .cindex "GnuTLS"
26895 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26896 Sockets Layer), is implemented by making use of the OpenSSL library or the
26897 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26898 cryptographic code in the Exim distribution itself for implementing TLS. In
26899 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26900 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26901 You also need to understand the basic concepts of encryption at a managerial
26902 level, and in particular, the way that public keys, private keys, and
26903 certificates are used.
26904
26905 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26906 connection is established, the client issues a STARTTLS command. If the
26907 server accepts this, the client and the server negotiate an encryption
26908 mechanism. If the negotiation succeeds, the data that subsequently passes
26909 between them is encrypted.
26910
26911 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26912 and if so, what cipher suite is in use, whether the client supplied a
26913 certificate, and whether or not that certificate was verified. This makes it
26914 possible for an Exim server to deny or accept certain commands based on the
26915 encryption state.
26916
26917 &*Warning*&: Certain types of firewall and certain anti-virus products can
26918 disrupt TLS connections. You need to turn off SMTP scanning for these products
26919 in order to get TLS to work.
26920
26921
26922
26923 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26924          "SECID284"
26925 .cindex "ssmtp protocol"
26926 .cindex "smtps protocol"
26927 .cindex "SMTP" "ssmtp protocol"
26928 .cindex "SMTP" "smtps protocol"
26929 Early implementations of encrypted SMTP used a different TCP port from normal
26930 SMTP, and expected an encryption negotiation to start immediately, instead of
26931 waiting for a STARTTLS command from the client using the standard SMTP
26932 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26933 allocated for this purpose.
26934
26935 This approach was abandoned when encrypted SMTP was standardized, but there are
26936 still some legacy clients that use it. Exim supports these clients by means of
26937 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26938 numbers; the most common use is expected to be:
26939 .code
26940 tls_on_connect_ports = 465
26941 .endd
26942 The port numbers specified by this option apply to all SMTP connections, both
26943 via the daemon and via &'inetd'&. You still need to specify all the ports that
26944 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26945 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26946 an extra port &-- rather, it specifies different behaviour on a port that is
26947 defined elsewhere.
26948
26949 There is also a &%-tls-on-connect%& command line option. This overrides
26950 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26951
26952
26953
26954
26955
26956
26957 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26958 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26959 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26960 followed later, when the first versions of GnuTLS were released. To build Exim
26961 to use GnuTLS, you need to set
26962 .code
26963 USE_GNUTLS=yes
26964 .endd
26965 in Local/Makefile, in addition to
26966 .code
26967 SUPPORT_TLS=yes
26968 .endd
26969 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26970 include files and libraries for GnuTLS can be found.
26971
26972 There are some differences in usage when using GnuTLS instead of OpenSSL:
26973
26974 .ilist
26975 The &%tls_verify_certificates%& option
26976 cannot be the path of a directory
26977 for GnuTLS versions before 3.3.6
26978 (for later versions, or OpenSSL, it can be either).
26979 .next
26980 The default value for &%tls_dhparam%& differs for historical reasons.
26981 .next
26982 .vindex "&$tls_in_peerdn$&"
26983 .vindex "&$tls_out_peerdn$&"
26984 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26985 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26986 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26987 .next
26988 OpenSSL identifies cipher suites using hyphens as separators, for example:
26989 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26990 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26991 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26992 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26993 to handle its own older variants) when processing lists of cipher suites in the
26994 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26995 option).
26996 .next
26997 The &%tls_require_ciphers%& options operate differently, as described in the
26998 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26999 .next
27000 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
27001 When using OpenSSL, this option is ignored.
27002 (If an API is found to let OpenSSL be configured in this way,
27003 let the Exim Maintainers know and we'll likely use it).
27004 .next
27005 Some other recently added features may only be available in one or the other.
27006 This should be documented with the feature.  If the documentation does not
27007 explicitly state that the feature is infeasible in the other TLS
27008 implementation, then patches are welcome.
27009 .endlist
27010
27011
27012 .section "GnuTLS parameter computation" "SECTgnutlsparam"
27013 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
27014 an explicit path; if the latter, then the text about generation still applies,
27015 but not the chosen filename.
27016 By default, as of Exim 4.80 a hard-coded D-H prime is used.
27017 See the documentation of &%tls_dhparam%& for more information.
27018
27019 GnuTLS uses D-H parameters that may take a substantial amount of time
27020 to compute. It is unreasonable to re-compute them for every TLS session.
27021 Therefore, Exim keeps this data in a file in its spool directory, called
27022 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
27023 of bits requested.
27024 The file is owned by the Exim user and is readable only by
27025 its owner. Every Exim process that start up GnuTLS reads the D-H
27026 parameters from this file. If the file does not exist, the first Exim process
27027 that needs it computes the data and writes it to a temporary file which is
27028 renamed once it is complete. It does not matter if several Exim processes do
27029 this simultaneously (apart from wasting a few resources). Once a file is in
27030 place, new Exim processes immediately start using it.
27031
27032 For maximum security, the parameters that are stored in this file should be
27033 recalculated periodically, the frequency depending on your paranoia level.
27034 If you are avoiding using the fixed D-H primes published in RFCs, then you
27035 are concerned about some advanced attacks and will wish to do this; if you do
27036 not regenerate then you might as well stick to the standard primes.
27037
27038 Arranging this is easy in principle; just delete the file when you want new
27039 values to be computed. However, there may be a problem. The calculation of new
27040 parameters needs random numbers, and these are obtained from &_/dev/random_&.
27041 If the system is not very active, &_/dev/random_& may delay returning data
27042 until enough randomness (entropy) is available. This may cause Exim to hang for
27043 a substantial amount of time, causing timeouts on incoming connections.
27044
27045 The solution is to generate the parameters externally to Exim. They are stored
27046 in &_gnutls-params-N_& in PEM format, which means that they can be
27047 generated externally using the &(certtool)& command that is part of GnuTLS.
27048
27049 To replace the parameters with new ones, instead of deleting the file
27050 and letting Exim re-create it, you can generate new parameters using
27051 &(certtool)& and, when this has been done, replace Exim's cache file by
27052 renaming. The relevant commands are something like this:
27053 .code
27054 # ls
27055 [ look for file; assume gnutls-params-2236 is the most recent ]
27056 # rm -f new-params
27057 # touch new-params
27058 # chown exim:exim new-params
27059 # chmod 0600 new-params
27060 # certtool --generate-dh-params --bits 2236 >>new-params
27061 # openssl dhparam -noout -text -in new-params | head
27062 [ check the first line, make sure it's not more than 2236;
27063   if it is, then go back to the start ("rm") and repeat
27064   until the size generated is at most the size requested ]
27065 # chmod 0400 new-params
27066 # mv new-params gnutls-params-2236
27067 .endd
27068 If Exim never has to generate the parameters itself, the possibility of
27069 stalling is removed.
27070
27071 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27072 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27073 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27074 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27075 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27076 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27077 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27078 which applies to all D-H usage, client or server.  If the value returned by
27079 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27080 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27081 limit, which is still much higher than Exim historically used.
27082
27083 The filename and bits used will change as the GnuTLS maintainers change the
27084 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27085 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27086 2432 bits, while NSS is limited to 2236 bits.
27087
27088 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27089 increase the chance of the generated prime actually being within acceptable
27090 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27091 procedure above.  There is no sane procedure available to Exim to double-check
27092 the size of the generated prime, so it might still be too large.
27093
27094
27095 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27096 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
27097 .oindex "&%tls_require_ciphers%&" "OpenSSL"
27098 There is a function in the OpenSSL library that can be passed a list of cipher
27099 suites before the cipher negotiation takes place. This specifies which ciphers
27100 are acceptable. The list is colon separated and may contain names like
27101 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
27102 directly to this function call.
27103 Many systems will install the OpenSSL manual-pages, so you may have
27104 &'ciphers(1)'& available to you.
27105 The following quotation from the OpenSSL
27106 documentation specifies what forms of item are allowed in the cipher string:
27107
27108 .ilist
27109 It can consist of a single cipher suite such as RC4-SHA.
27110 .next
27111 It can represent a list of cipher suites containing a certain algorithm,
27112 or cipher suites of a certain type. For example SHA1 represents all
27113 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
27114 SSL v3 algorithms.
27115 .next
27116 Lists of cipher suites can be combined in a single cipher string using
27117 the + character. This is used as a logical and operation. For example
27118 SHA1+DES represents all cipher suites containing the SHA1 and the DES
27119 algorithms.
27120 .endlist
27121
27122 Each cipher string can be optionally preceded by one of the characters &`!`&,
27123 &`-`& or &`+`&.
27124 .ilist
27125 If &`!`& is used, the ciphers are permanently deleted from the list. The
27126 ciphers deleted can never reappear in the list even if they are explicitly
27127 stated.
27128 .next
27129 If &`-`& is used, the ciphers are deleted from the list, but some or all
27130 of the ciphers can be added again by later options.
27131 .next
27132 If &`+`& is used, the ciphers are moved to the end of the list. This
27133 option does not add any new ciphers; it just moves matching existing ones.
27134 .endlist
27135
27136 If none of these characters is present, the string is interpreted as
27137 a list of ciphers to be appended to the current preference list. If the list
27138 includes any ciphers already present they will be ignored: that is, they will
27139 not be moved to the end of the list.
27140 .endlist
27141
27142 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27143 string:
27144 .code
27145 # note single-quotes to get ! past any shell history expansion
27146 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27147 .endd
27148
27149 This example will let the library defaults be permitted on the MX port, where
27150 there's probably no identity verification anyway, but ups the ante on the
27151 submission ports where the administrator might have some influence on the
27152 choice of clients used:
27153 .code
27154 # OpenSSL variant; see man ciphers(1)
27155 tls_require_ciphers = ${if =={$received_port}{25}\
27156                            {DEFAULT}\
27157                            {HIGH:!MD5:!SHA1}}
27158 .endd
27159
27160
27161
27162 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27163          "SECTreqciphgnu"
27164 .cindex "GnuTLS" "specifying parameters for"
27165 .cindex "TLS" "specifying ciphers (GnuTLS)"
27166 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27167 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27168 .cindex "TLS" "specifying protocols (GnuTLS)"
27169 .cindex "TLS" "specifying priority string (GnuTLS)"
27170 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27171 The GnuTLS library allows the caller to provide a "priority string", documented
27172 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27173 ciphersuite specification in OpenSSL.
27174
27175 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27176 and controls both protocols and ciphers.
27177
27178 The &%tls_require_ciphers%& option is available both as an global option,
27179 controlling how Exim behaves as a server, and also as an option of the
27180 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27181 the value is string expanded.  The resulting string is not an Exim list and
27182 the string is given to the GnuTLS library, so that Exim does not need to be
27183 aware of future feature enhancements of GnuTLS.
27184
27185 Documentation of the strings accepted may be found in the GnuTLS manual, under
27186 "Priority strings".  This is online as
27187 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
27188 but beware that this relates to GnuTLS 3, which may be newer than the version
27189 installed on your system.  If you are using GnuTLS 3,
27190 then the example code
27191 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27192 on that site can be used to test a given string.
27193
27194 For example:
27195 .code
27196 # Disable older versions of protocols
27197 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27198 .endd
27199
27200 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27201 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27202 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27203
27204 This example will let the library defaults be permitted on the MX port, where
27205 there's probably no identity verification anyway, and lowers security further
27206 by increasing compatibility; but this ups the ante on the submission ports
27207 where the administrator might have some influence on the choice of clients
27208 used:
27209 .code
27210 # GnuTLS variant
27211 tls_require_ciphers = ${if =={$received_port}{25}\
27212                            {NORMAL:%COMPAT}\
27213                            {SECURE128}}
27214 .endd
27215
27216
27217 .section "Configuring an Exim server to use TLS" "SECID182"
27218 .cindex "TLS" "configuring an Exim server"
27219 When Exim has been built with TLS support, it advertises the availability of
27220 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27221 but not to any others. The default value of this option is *, which means
27222 that STARTTLS is alway advertised.  Set it to blank to never advertise;
27223 this is reasonble for systems that want to use TLS only as a client.
27224
27225 If STARTTLS is to be used you
27226 need to set some other options in order to make TLS available.
27227
27228 If a client issues a STARTTLS command and there is some configuration
27229 problem in the server, the command is rejected with a 454 error. If the client
27230 persists in trying to issue SMTP commands, all except QUIT are rejected
27231 with the error
27232 .code
27233 554 Security failure
27234 .endd
27235 If a STARTTLS command is issued within an existing TLS session, it is
27236 rejected with a 554 error code.
27237
27238 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27239 must be set to match some hosts. The default is * which matches all hosts.
27240
27241 If this is all you do, TLS encryption will be enabled but not authentication -
27242 meaning that the peer has no assurance it is actually you he is talking to.
27243 You gain protection from a passive sniffer listening on the wire but not
27244 from someone able to intercept the communication.
27245
27246 Further protection requires some further configuration at the server end.
27247
27248 It is rumoured that all existing clients that support TLS/SSL use RSA
27249 encryption. To make this work you need to set, in the server,
27250 .code
27251 tls_certificate = /some/file/name
27252 tls_privatekey = /some/file/name
27253 .endd
27254 These options are, in fact, expanded strings, so you can make them depend on
27255 the identity of the client that is connected if you wish. The first file
27256 contains the server's X509 certificate, and the second contains the private key
27257 that goes with it. These files need to be
27258 PEM format and readable by the Exim user, and must
27259 always be given as full path names.
27260 The key must not be password-protected.
27261 They can be the same file if both the
27262 certificate and the key are contained within it. If &%tls_privatekey%& is not
27263 set, or if its expansion is forced to fail or results in an empty string, this
27264 is assumed to be the case. The certificate file may also contain intermediate
27265 certificates that need to be sent to the client to enable it to authenticate
27266 the server's certificate.
27267
27268 If you do not understand about certificates and keys, please try to find a
27269 source of this background information, which is not Exim-specific. (There are a
27270 few comments below in section &<<SECTcerandall>>&.)
27271
27272 &*Note*&: These options do not apply when Exim is operating as a client &--
27273 they apply only in the case of a server. If you need to use a certificate in an
27274 Exim client, you must set the options of the same names in an &(smtp)&
27275 transport.
27276
27277 With just these options, an Exim server will be able to use TLS. It does not
27278 require the client to have a certificate (but see below for how to insist on
27279 this). There is one other option that may be needed in other situations. If
27280 .code
27281 tls_dhparam = /some/file/name
27282 .endd
27283 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27284 with the parameters contained in the file.
27285 Set this to &`none`& to disable use of DH entirely, by making no prime
27286 available:
27287 .code
27288 tls_dhparam = none
27289 .endd
27290 This may also be set to a string identifying a standard prime to be used for
27291 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27292 used is &`ike23`&.  There are a few standard primes available, see the
27293 documentation for &%tls_dhparam%& for the complete list.
27294
27295 See the command
27296 .code
27297 openssl dhparam
27298 .endd
27299 for a way of generating file data.
27300
27301 The strings supplied for these three options are expanded every time a client
27302 host connects. It is therefore possible to use different certificates and keys
27303 for different hosts, if you so wish, by making use of the client's IP address
27304 in &$sender_host_address$& to control the expansion. If a string expansion is
27305 forced to fail, Exim behaves as if the option is not set.
27306
27307 .cindex "cipher" "logging"
27308 .cindex "log" "TLS cipher"
27309 .vindex "&$tls_in_cipher$&"
27310 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27311 an incoming TLS connection. It is included in the &'Received:'& header of an
27312 incoming message (by default &-- you can, of course, change this), and it is
27313 also included in the log line that records a message's arrival, keyed by
27314 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27315 condition can be used to test for specific cipher suites in ACLs.
27316
27317 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27318 can check the name of the cipher suite and vary their actions accordingly. The
27319 cipher suite names vary, depending on which TLS library is being used. For
27320 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27321 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27322 documentation for more details.
27323
27324 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27325 (again depending on the &%tls_cipher%& log selector).
27326
27327
27328 .section "Requesting and verifying client certificates" "SECID183"
27329 .cindex "certificate" "verification of client"
27330 .cindex "TLS" "client certificate verification"
27331 If you want an Exim server to request a certificate when negotiating a TLS
27332 session with a client, you must set either &%tls_verify_hosts%& or
27333 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27334 apply to all TLS connections. For any host that matches one of these options,
27335 Exim requests a certificate as part of the setup of the TLS session. The
27336 contents of the certificate are verified by comparing it with a list of
27337 expected certificates.
27338 These may be the system default set (depending on library version),
27339 an explicit file or,
27340 depending on library version, a directory, identified by
27341 &%tls_verify_certificates%&.
27342
27343 A file can contain multiple certificates, concatenated end to end. If a
27344 directory is used
27345 (OpenSSL only),
27346 each certificate must be in a separate file, with a name (or a symbolic link)
27347 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27348 certificate. You can compute the relevant hash by running the command
27349 .code
27350 openssl x509 -hash -noout -in /cert/file
27351 .endd
27352 where &_/cert/file_& contains a single certificate.
27353
27354 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27355 what happens if the client does not supply a certificate, or if the certificate
27356 does not match any of the certificates in the collection named by
27357 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27358 attempt to set up a TLS session is aborted, and the incoming connection is
27359 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27360 session continues. ACLs that run for subsequent SMTP commands can detect the
27361 fact that no certificate was verified, and vary their actions accordingly. For
27362 example, you can insist on a certificate before accepting a message for
27363 relaying, but not when the message is destined for local delivery.
27364
27365 .vindex "&$tls_in_peerdn$&"
27366 When a client supplies a certificate (whether it verifies or not), the value of
27367 the Distinguished Name of the certificate is made available in the variable
27368 &$tls_in_peerdn$& during subsequent processing of the message.
27369
27370 .cindex "log" "distinguished name"
27371 Because it is often a long text string, it is not included in the log line or
27372 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27373 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27374 &%received_header_text%& to change the &'Received:'& header. When no
27375 certificate is supplied, &$tls_in_peerdn$& is empty.
27376
27377
27378 .section "Revoked certificates" "SECID184"
27379 .cindex "TLS" "revoked certificates"
27380 .cindex "revocation list"
27381 .cindex "certificate" "revocation list"
27382 .cindex "OCSP" "stapling"
27383 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27384 certificates are revoked. If you have such a list, you can pass it to an Exim
27385 server using the global option called &%tls_crl%& and to an Exim client using
27386 an identically named option for the &(smtp)& transport. In each case, the value
27387 of the option is expanded and must then be the name of a file that contains a
27388 CRL in PEM format.
27389 The downside is that clients have to periodically re-download a potentially huge
27390 file from every certificate authority they know of.
27391
27392 The way with most moving parts at query time is Online Certificate
27393 Status Protocol (OCSP), where the client verifies the certificate
27394 against an OCSP server run by the CA.  This lets the CA track all
27395 usage of the certs.  It requires running software with access to the
27396 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27397 is based on HTTP and can be proxied accordingly.
27398
27399 The only widespread OCSP server implementation (known to this writer)
27400 comes as part of OpenSSL and aborts on an invalid request, such as
27401 connecting to the port and then disconnecting.  This requires
27402 re-entering the passphrase each time some random client does this.
27403
27404 The third way is OCSP Stapling; in this, the server using a certificate
27405 issued by the CA periodically requests an OCSP proof of validity from
27406 the OCSP server, then serves it up inline as part of the TLS
27407 negotiation.   This approach adds no extra round trips, does not let the
27408 CA track users, scales well with number of certs issued by the CA and is
27409 resilient to temporary OCSP server failures, as long as the server
27410 starts retrying to fetch an OCSP proof some time before its current
27411 proof expires.  The downside is that it requires server support.
27412
27413 Unless Exim is built with the support disabled,
27414 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27415 support for OCSP stapling is included.
27416
27417 There is a global option called &%tls_ocsp_file%&.
27418 The file specified therein is expected to be in DER format, and contain
27419 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27420 option will be re-expanded for SNI, if the &%tls_certificate%& option
27421 contains &`tls_in_sni`&, as per other TLS options.
27422
27423 Exim does not at this time implement any support for fetching a new OCSP
27424 proof.  The burden is on the administrator to handle this, outside of
27425 Exim.  The file specified should be replaced atomically, so that the
27426 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27427 on each connection, so a new file will be handled transparently on the
27428 next connection.
27429
27430 When built with OpenSSL Exim will check for a valid next update timestamp
27431 in the OCSP proof; if not present, or if the proof has expired, it will be
27432 ignored.
27433
27434 For the client to be able to verify the stapled OCSP the server must
27435 also supply, in its stapled information, any intermediate
27436 certificates for the chain leading to the OCSP proof from the signer
27437 of the server certificate.  There may be zero or one such. These
27438 intermediate certificates should be added to the server OCSP stapling
27439 file named by &%tls_ocsp_file%&.
27440
27441 Note that the proof only covers the terminal server certificate,
27442 not any of the chain from CA to it.
27443
27444 There is no current way to staple a proof for a client certificate.
27445
27446 .code
27447   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27448   OCSP server is supplied.  The server URL may be included in the
27449   server certificate, if the CA is helpful.
27450
27451   One failure mode seen was the OCSP Signer cert expiring before the end
27452   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27453   noted this as invalid overall, but the re-fetch script did not.
27454 .endd
27455
27456
27457
27458
27459 .section "Configuring an Exim client to use TLS" "SECID185"
27460 .cindex "cipher" "logging"
27461 .cindex "log" "TLS cipher"
27462 .cindex "log" "distinguished name"
27463 .cindex "TLS" "configuring an Exim client"
27464 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27465 deliveries as well as to incoming, the latter one causing logging of the
27466 server certificate's DN. The remaining client configuration for TLS is all
27467 within the &(smtp)& transport.
27468
27469 It is not necessary to set any options to have TLS work in the &(smtp)&
27470 transport. If Exim is built with TLS support, and TLS is advertised by a
27471 server, the &(smtp)& transport always tries to start a TLS session. However,
27472 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27473 transport) to a list of server hosts for which TLS should not be used.
27474
27475 If you do not want Exim to attempt to send messages unencrypted when an attempt
27476 to set up an encrypted connection fails in any way, you can set
27477 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27478 those hosts, delivery is always deferred if an encrypted connection cannot be
27479 set up. If there are any other hosts for the address, they are tried in the
27480 usual way.
27481
27482 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27483 the message unencrypted. It always does this if the response to STARTTLS is
27484 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27485 session after a success response code, what happens is controlled by the
27486 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27487 delivery to this host is deferred, and other hosts (if available) are tried. If
27488 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27489 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27490 negotiation fails, Exim closes the current connection (because it is in an
27491 unknown state), opens a new one to the same host, and then tries the delivery
27492 unencrypted.
27493
27494 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27495 transport provide the client with a certificate, which is passed to the server
27496 if it requests it. If the server is Exim, it will request a certificate only if
27497 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27498
27499 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27500 specifies a collection of expected server certificates.
27501 These may be the system default set (depending on library version),
27502 a file or,
27503 depending on library version, a directory,
27504 must name a file or,
27505 for OpenSSL only (not GnuTLS), a directory.
27506 The client verifies the server's certificate
27507 against this collection, taking into account any revoked certificates that are
27508 in the list defined by &%tls_crl%&.
27509 Failure to verify fails the TLS connection unless either of the
27510 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27511
27512 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27513 certificate verification to the listed servers.  Verification either must
27514 or need not succeed respectively.
27515
27516 The &(smtp)& transport has two OCSP-related options:
27517 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27518 is requested and required for the connection to proceed.  The default
27519 value is empty.
27520 &%hosts_request_ocsp%&; a host-list for which (additionally)
27521 a Certificate Status is requested (but not necessarily verified).  The default
27522 value is "*" meaning that requests are made unless configured
27523 otherwise.
27524
27525 The host(s) should also be in &%hosts_require_tls%&, and
27526 &%tls_verify_certificates%& configured for the transport,
27527 for OCSP to be relevant.
27528
27529 If
27530 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27531 list of permitted cipher suites. If either of these checks fails, delivery to
27532 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27533 alternative hosts, if any.
27534
27535  &*Note*&:
27536 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27537 is operating as a client. Exim does not assume that a server certificate (set
27538 by the global options of the same name) should also be used when operating as a
27539 client.
27540
27541 .vindex "&$host$&"
27542 .vindex "&$host_address$&"
27543 All the TLS options in the &(smtp)& transport are expanded before use, with
27544 &$host$& and &$host_address$& containing the name and address of the server to
27545 which the client is connected. Forced failure of an expansion causes Exim to
27546 behave as if the relevant option were unset.
27547
27548 .vindex &$tls_out_bits$&
27549 .vindex &$tls_out_cipher$&
27550 .vindex &$tls_out_peerdn$&
27551 .vindex &$tls_out_sni$&
27552 Before an SMTP connection is established, the
27553 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27554 variables are emptied. (Until the first connection, they contain the values
27555 that were set when the message was received.) If STARTTLS is subsequently
27556 successfully obeyed, these variables are set to the relevant values for the
27557 outgoing connection.
27558
27559
27560
27561 .section "Use of TLS Server Name Indication" "SECTtlssni"
27562 .cindex "TLS" "Server Name Indication"
27563 .vindex "&$tls_in_sni$&"
27564 .oindex "&%tls_in_sni%&"
27565 With TLS1.0 or above, there is an extension mechanism by which extra
27566 information can be included at various points in the protocol.  One of these
27567 extensions, documented in RFC 6066 (and before that RFC 4366) is
27568 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27569 client in the initial handshake, so that the server can examine the servername
27570 within and possibly choose to use different certificates and keys (and more)
27571 for this session.
27572
27573 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27574 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27575 address.
27576
27577 With SMTP to MX, there are the same problems here as in choosing the identity
27578 against which to validate a certificate: you can't rely on insecure DNS to
27579 provide the identity which you then cryptographically verify.  So this will
27580 be of limited use in that environment.
27581
27582 With SMTP to Submission, there is a well-defined hostname which clients are
27583 connecting to and can validate certificates against.  Thus clients &*can*&
27584 choose to include this information in the TLS negotiation.  If this becomes
27585 wide-spread, then hosters can choose to present different certificates to
27586 different clients.  Or even negotiate different cipher suites.
27587
27588 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27589 if not empty, will be sent on a TLS session as part of the handshake.  There's
27590 nothing more to it.  Choosing a sensible value not derived insecurely is the
27591 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27592 for the lifetime of the client connection (including during authentication).
27593
27594 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27595 received from a client.
27596 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27597
27598 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27599 option (prior to expansion) then the following options will be re-expanded
27600 during TLS session handshake, to permit alternative values to be chosen:
27601
27602 .ilist
27603 .vindex "&%tls_certificate%&"
27604 &%tls_certificate%&
27605 .next
27606 .vindex "&%tls_crl%&"
27607 &%tls_crl%&
27608 .next
27609 .vindex "&%tls_privatekey%&"
27610 &%tls_privatekey%&
27611 .next
27612 .vindex "&%tls_verify_certificates%&"
27613 &%tls_verify_certificates%&
27614 .next
27615 .vindex "&%tls_ocsp_file%&"
27616 &%tls_ocsp_file%&
27617 .endlist
27618
27619 Great care should be taken to deal with matters of case, various injection
27620 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27621 can always be referenced; it is important to remember that &$tls_in_sni$& is
27622 arbitrary unverified data provided prior to authentication.
27623 Further, the initial certificate is loaded before SNI is arrived, so
27624 an expansion for &%tls_certificate%& must have a default which is used
27625 when &$tls_in_sni$& is empty.
27626
27627 The Exim developers are proceeding cautiously and so far no other TLS options
27628 are re-expanded.
27629
27630 When Exim is built against OpenSSL, OpenSSL must have been built with support
27631 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27632 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27633 see &`-servername`& in the output, then OpenSSL has support.
27634
27635 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27636 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27637 built, then you have SNI support).
27638
27639
27640
27641 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27642          "SECTmulmessam"
27643 .cindex "multiple SMTP deliveries with TLS"
27644 .cindex "TLS" "multiple message deliveries"
27645 Exim sends multiple messages down the same TCP/IP connection by starting up
27646 an entirely new delivery process for each message, passing the socket from
27647 one process to the next. This implementation does not fit well with the use
27648 of TLS, because there is quite a lot of state information associated with a TLS
27649 connection, not just a socket identification. Passing all the state information
27650 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27651 session before passing the socket to a new process. The new process may then
27652 try to start a new TLS session, and if successful, may try to re-authenticate
27653 if AUTH is in use, before sending the next message.
27654
27655 The RFC is not clear as to whether or not an SMTP session continues in clear
27656 after TLS has been shut down, or whether TLS may be restarted again later, as
27657 just described. However, if the server is Exim, this shutdown and
27658 reinitialization works. It is not known which (if any) other servers operate
27659 successfully if the client closes a TLS session and continues with unencrypted
27660 SMTP, but there are certainly some that do not work. For such servers, Exim
27661 should not pass the socket to another process, because the failure of the
27662 subsequent attempt to use it would cause Exim to record a temporary host error,
27663 and delay other deliveries to that host.
27664
27665 To test for this case, Exim sends an EHLO command to the server after
27666 closing down the TLS session. If this fails in any way, the connection is
27667 closed instead of being passed to a new delivery process, but no retry
27668 information is recorded.
27669
27670 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27671 &(smtp)& transport to match those hosts for which Exim should not pass
27672 connections to new processes if TLS has been used.
27673
27674
27675
27676
27677 .section "Certificates and all that" "SECTcerandall"
27678 .cindex "certificate" "references to discussion"
27679 In order to understand fully how TLS works, you need to know about
27680 certificates, certificate signing, and certificate authorities. This is not the
27681 place to give a tutorial, especially as I do not know very much about it
27682 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27683 to Apache, currently at
27684 .display
27685 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27686 .endd
27687 Other parts of the &'modssl'& documentation are also helpful, and have
27688 links to further files.
27689 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27690 0-201-61598-3), contains both introductory and more in-depth descriptions.
27691 Some sample programs taken from the book are available from
27692 .display
27693 &url(http://www.rtfm.com/openssl-examples/)
27694 .endd
27695
27696
27697 .section "Certificate chains" "SECID186"
27698 The file named by &%tls_certificate%& may contain more than one
27699 certificate. This is useful in the case where the certificate that is being
27700 sent is validated by an intermediate certificate which the other end does
27701 not have. Multiple certificates must be in the correct order in the file.
27702 First the host's certificate itself, then the first intermediate
27703 certificate to validate the issuer of the host certificate, then the next
27704 intermediate certificate to validate the issuer of the first intermediate
27705 certificate, and so on, until finally (optionally) the root certificate.
27706 The root certificate must already be trusted by the recipient for
27707 validation to succeed, of course, but if it's not preinstalled, sending the
27708 root certificate along with the rest makes it available for the user to
27709 install if the receiving end is a client MUA that can interact with a user.
27710
27711 Note that certificates using MD5 are unlikely to work on today's Internet;
27712 even if your libraries allow loading them for use in Exim when acting as a
27713 server, increasingly clients will not accept such certificates.  The error
27714 diagnostics in such a case can be frustratingly vague.
27715
27716
27717
27718 .section "Self-signed certificates" "SECID187"
27719 .cindex "certificate" "self-signed"
27720 You can create a self-signed certificate using the &'req'& command provided
27721 with OpenSSL, like this:
27722 . ==== Do not shorten the duration here without reading and considering
27723 . ==== the text below.  Please leave it at 9999 days.
27724 .code
27725 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27726             -days 9999 -nodes
27727 .endd
27728 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27729 delimited and so can be identified independently. The &%-days%& option
27730 specifies a period for which the certificate is valid. The &%-nodes%& option is
27731 important: if you do not set it, the key is encrypted with a passphrase
27732 that you are prompted for, and any use that is made of the key causes more
27733 prompting for the passphrase. This is not helpful if you are going to use
27734 this certificate and key in an MTA, where prompting is not possible.
27735
27736 . ==== I expect to still be working 26 years from now.  The less technical
27737 . ==== debt I create, in terms of storing up trouble for my later years, the
27738 . ==== happier I will be then.  We really have reached the point where we
27739 . ==== should start, at the very least, provoking thought and making folks
27740 . ==== pause before proceeding, instead of leaving all the fixes until two
27741 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27742 . ==== -pdp, 2012
27743 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27744 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27745 the above command might produce a date in the past.  Think carefully about
27746 the lifetime of the systems you're deploying, and either reduce the duration
27747 of the certificate or reconsider your platform deployment.  (At time of
27748 writing, reducing the duration is the most likely choice, but the inexorable
27749 progression of time takes us steadily towards an era where this will not
27750 be a sensible resolution).
27751
27752 A self-signed certificate made in this way is sufficient for testing, and
27753 may be adequate for all your requirements if you are mainly interested in
27754 encrypting transfers, and not in secure identification.
27755
27756 However, many clients require that the certificate presented by the server be a
27757 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27758 certificate. In this situation, the self-signed certificate described above
27759 must be installed on the client host as a trusted root &'certification
27760 authority'& (CA), and the certificate used by Exim must be a user certificate
27761 signed with that self-signed certificate.
27762
27763 For information on creating self-signed CA certificates and using them to sign
27764 user certificates, see the &'General implementation overview'& chapter of the
27765 Open-source PKI book, available online at
27766 &url(http://ospkibook.sourceforge.net/).
27767 .ecindex IIDencsmtp1
27768 .ecindex IIDencsmtp2
27769
27770
27771
27772 . ////////////////////////////////////////////////////////////////////////////
27773 . ////////////////////////////////////////////////////////////////////////////
27774
27775 .chapter "Access control lists" "CHAPACL"
27776 .scindex IIDacl "&ACL;" "description"
27777 .cindex "control of incoming mail"
27778 .cindex "message" "controlling incoming"
27779 .cindex "policy control" "access control lists"
27780 Access Control Lists (ACLs) are defined in a separate section of the run time
27781 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27782 name, terminated by a colon. Here is a complete ACL section that contains just
27783 one very small ACL:
27784 .code
27785 begin acl
27786 small_acl:
27787   accept   hosts = one.host.only
27788 .endd
27789 You can have as many lists as you like in the ACL section, and the order in
27790 which they appear does not matter. The lists are self-terminating.
27791
27792 The majority of ACLs are used to control Exim's behaviour when it receives
27793 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27794 when a local process submits a message using SMTP by specifying the &%-bs%&
27795 option. The most common use is for controlling which recipients are accepted
27796 in incoming messages. In addition, you can define an ACL that is used to check
27797 local non-SMTP messages. The default configuration file contains an example of
27798 a realistic ACL for checking RCPT commands. This is discussed in chapter
27799 &<<CHAPdefconfil>>&.
27800
27801
27802 .section "Testing ACLs" "SECID188"
27803 The &%-bh%& command line option provides a way of testing your ACL
27804 configuration locally by running a fake SMTP session with which you interact.
27805
27806
27807 .section "Specifying when ACLs are used" "SECID189"
27808 .cindex "&ACL;" "options for specifying"
27809 In order to cause an ACL to be used, you have to name it in one of the relevant
27810 options in the main part of the configuration. These options are:
27811 .cindex "AUTH" "ACL for"
27812 .cindex "DATA" "ACLs for"
27813 .cindex "ETRN" "ACL for"
27814 .cindex "EXPN" "ACL for"
27815 .cindex "HELO" "ACL for"
27816 .cindex "EHLO" "ACL for"
27817 .cindex "DKIM" "ACL for"
27818 .cindex "MAIL" "ACL for"
27819 .cindex "QUIT, ACL for"
27820 .cindex "RCPT" "ACL for"
27821 .cindex "STARTTLS, ACL for"
27822 .cindex "VRFY" "ACL for"
27823 .cindex "SMTP" "connection, ACL for"
27824 .cindex "non-SMTP messages" "ACLs for"
27825 .cindex "MIME content scanning" "ACL for"
27826 .cindex "PRDR" "ACL for"
27827
27828 .table2 140pt
27829 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27830 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27831 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27832 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27833 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27834 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27835 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27836 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27837 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27838 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27839 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27840 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27841 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27842 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27843 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27844 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27845 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27846 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27847 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27848 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27849 .endtable
27850
27851 For example, if you set
27852 .code
27853 acl_smtp_rcpt = small_acl
27854 .endd
27855 the little ACL defined above is used whenever Exim receives a RCPT command
27856 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27857 done when RCPT commands arrive. A rejection of RCPT should cause the
27858 sending MTA to give up on the recipient address contained in the RCPT
27859 command, whereas rejection at other times may cause the client MTA to keep on
27860 trying to deliver the message. It is therefore recommended that you do as much
27861 testing as possible at RCPT time.
27862
27863
27864 .section "The non-SMTP ACLs" "SECID190"
27865 .cindex "non-SMTP messages" "ACLs for"
27866 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27867 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27868 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27869 the state of the SMTP connection such as encryption and authentication) are not
27870 relevant and are forbidden in these ACLs. However, the sender and recipients
27871 are known, so the &%senders%& and &%sender_domains%& conditions and the
27872 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27873 &$authenticated_sender$& are also available. You can specify added header lines
27874 in any of these ACLs.
27875
27876 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27877 non-SMTP message, before any of the message has been read. (This is the
27878 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27879 batched SMTP input, it runs after the DATA command has been reached. The
27880 result of this ACL is ignored; it cannot be used to reject a message. If you
27881 really need to, you could set a value in an ACL variable here and reject based
27882 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27883 controls, and in particular, it can be used to set
27884 .code
27885 control = suppress_local_fixups
27886 .endd
27887 This cannot be used in the other non-SMTP ACLs because by the time they are
27888 run, it is too late.
27889
27890 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27891 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27892
27893 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27894 kind of rejection is treated as permanent, because there is no way of sending a
27895 temporary error for these kinds of message.
27896
27897
27898 .section "The SMTP connect ACL" "SECID191"
27899 .cindex "SMTP" "connection, ACL for"
27900 .oindex &%smtp_banner%&
27901 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27902 session, after the test specified by &%host_reject_connection%& (which is now
27903 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27904 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27905 the message override the banner message that is otherwise specified by the
27906 &%smtp_banner%& option.
27907
27908
27909 .section "The EHLO/HELO ACL" "SECID192"
27910 .cindex "EHLO" "ACL for"
27911 .cindex "HELO" "ACL for"
27912 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27913 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27914 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27915 Note that a client may issue more than one EHLO or HELO command in an SMTP
27916 session, and indeed is required to issue a new EHLO or HELO after successfully
27917 setting up encryption following a STARTTLS command.
27918
27919 Note also that a deny neither forces the client to go away nor means that
27920 mail will be refused on the connection.  Consider checking for
27921 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27922
27923 If the command is accepted by an &%accept%& verb that has a &%message%&
27924 modifier, the message may not contain more than one line (it will be truncated
27925 at the first newline and a panic logged if it does). Such a message cannot
27926 affect the EHLO options that are listed on the second and subsequent lines of
27927 an EHLO response.
27928
27929
27930 .section "The DATA ACLs" "SECID193"
27931 .cindex "DATA" "ACLs for"
27932 Two ACLs are associated with the DATA command, because it is two-stage
27933 command, with two responses being sent to the client.
27934 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27935 is obeyed. This gives you control after all the RCPT commands, but before
27936 the message itself is received. It offers the opportunity to give a negative
27937 response to the DATA command before the data is transmitted. Header lines
27938 added by MAIL or RCPT ACLs are not visible at this time, but any that
27939 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27940
27941 You cannot test the contents of the message, for example, to verify addresses
27942 in the headers, at RCPT time or when the DATA command is received. Such
27943 tests have to appear in the ACL that is run after the message itself has been
27944 received, before the final response to the DATA command is sent. This is
27945 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27946 associated with the DATA command.
27947
27948 .cindex CHUNKING "BDAT command"
27949 .cindex BDAT "SMTP command"
27950 .cindex "RFC 3030" CHUNKING
27951 If CHUNKING was advertised and a BDAT command sequence is received,
27952 the &%acl_smtp_predata%& ACL is not run.
27953 . XXX why not?  It should be possible, for the first BDAT.
27954 The &%acl_smtp_data%& is run after the last BDAT command and all of
27955 the data specified is received.
27956
27957 For both of these ACLs, it is not possible to reject individual recipients. An
27958 error response rejects the entire message. Unfortunately, it is known that some
27959 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27960 before or after the data) correctly &-- they keep the message on their queues
27961 and try again later, but that is their problem, though it does waste some of
27962 your resources.
27963
27964 The &%acl_smtp_data%& ACL is run after
27965 the &%acl_smtp_data_prdr%&,
27966 the &%acl_smtp_dkim%&
27967 and the &%acl_smtp_mime%& ACLs.
27968
27969 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27970 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27971 enabled (which is the default).
27972
27973 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27974 received, and is executed for each DKIM signature found in a message.  If not
27975 otherwise specified, the default action is to accept.
27976
27977 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27978
27979 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27980
27981
27982 .section "The SMTP MIME ACL" "SECID194"
27983 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27984 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27985
27986 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27987
27988
27989 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27990 .cindex "PRDR" "ACL for"
27991 .oindex "&%prdr_enable%&"
27992 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27993 with PRDR support enabled (which is the default).
27994 It becomes active only when the PRDR feature is negotiated between
27995 client and server for a message, and more than one recipient
27996 has been accepted.
27997
27998 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27999 has been received, and is executed once for each recipient of the message
28000 with &$local_part$& and &$domain$& valid.
28001 The test may accept, defer or deny for individual recipients.
28002 The &%acl_smtp_data%& will still be called after this ACL and
28003 can reject the message overall, even if this ACL has accepted it
28004 for some or all recipients.
28005
28006 PRDR may be used to support per-user content filtering.  Without it
28007 one must defer any recipient after the first that has a different
28008 content-filter configuration.  With PRDR, the RCPT-time check
28009 .cindex "PRDR" "variable for"
28010 for this can be disabled when the variable &$prdr_requested$&
28011 is &"yes"&.
28012 Any required difference in behaviour of the main DATA-time
28013 ACL should however depend on the PRDR-time ACL having run, as Exim
28014 will avoid doing so in some situations (e.g.  single-recipient mails).
28015
28016 See also the &%prdr_enable%& global option
28017 and the &%hosts_try_prdr%& smtp transport option.
28018
28019 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28020 If the ACL is not defined, processing completes as if
28021 the feature was not requested by the client.
28022
28023 .section "The QUIT ACL" "SECTQUITACL"
28024 .cindex "QUIT, ACL for"
28025 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
28026 does not affect the response code to QUIT, which is always 221. Thus, the ACL
28027 does not in fact control any access.
28028 For this reason, it may only accept
28029 or warn as its final result.
28030
28031 This ACL can be used for tasks such as custom logging at the end of an SMTP
28032 session. For example, you can use ACL variables in other ACLs to count
28033 messages, recipients, etc., and log the totals at QUIT time using one or
28034 more &%logwrite%& modifiers on a &%warn%& verb.
28035
28036 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
28037 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
28038
28039 You do not need to have a final &%accept%&, but if you do, you can use a
28040 &%message%& modifier to specify custom text that is sent as part of the 221
28041 response to QUIT.
28042
28043 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
28044 failure (for example, failure to open a log file, or when Exim is bombing out
28045 because it has detected an unrecoverable error), all SMTP commands from the
28046 client are given temporary error responses until QUIT is received or the
28047 connection is closed. In these special cases, the QUIT ACL does not run.
28048
28049
28050 .section "The not-QUIT ACL" "SECTNOTQUITACL"
28051 .vindex &$acl_smtp_notquit$&
28052 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
28053 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
28054 trouble, such as being unable to write to its log files, this ACL is not run,
28055 because it might try to do things (such as write to log files) that make the
28056 situation even worse.
28057
28058 Like the QUIT ACL, this ACL is provided to make it possible to do customized
28059 logging or to gather statistics, and its outcome is ignored. The &%delay%&
28060 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
28061 and &%warn%&.
28062
28063 .vindex &$smtp_notquit_reason$&
28064 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
28065 to a string that indicates the reason for the termination of the SMTP
28066 connection. The possible values are:
28067 .table2
28068 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
28069 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
28070 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
28071 .irow &`connection-lost`&          "The SMTP connection has been lost"
28072 .irow &`data-timeout`&             "Timeout while reading message data"
28073 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
28074 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
28075 .irow &`signal-exit`&              "SIGTERM or SIGINT"
28076 .irow &`synchronization-error`&    "SMTP synchronization error"
28077 .irow &`tls-failed`&               "TLS failed to start"
28078 .endtable
28079 In most cases when an SMTP connection is closed without having received QUIT,
28080 Exim sends an SMTP response message before actually closing the connection.
28081 With the exception of the &`acl-drop`& case, the default message can be
28082 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
28083 &%drop%& verb in another ACL, it is the message from the other ACL that is
28084 used.
28085
28086
28087 .section "Finding an ACL to use" "SECID195"
28088 .cindex "&ACL;" "finding which to use"
28089 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
28090 you can use different ACLs in different circumstances. For example,
28091 .code
28092 acl_smtp_rcpt = ${if ={25}{$interface_port} \
28093                      {acl_check_rcpt} {acl_check_rcpt_submit} }
28094 .endd
28095 In the default configuration file there are some example settings for
28096 providing an RFC 4409 message submission service on port 587 and a
28097 non-standard &"smtps"& service on port 465. You can use a string
28098 expansion like this to choose an ACL for MUAs on these ports which is
28099 more appropriate for this purpose than the default ACL on port 25.
28100
28101 The expanded string does not have to be the name of an ACL in the
28102 configuration file; there are other possibilities. Having expanded the
28103 string, Exim searches for an ACL as follows:
28104
28105 .ilist
28106 If the string begins with a slash, Exim uses it as a file name, and reads its
28107 contents as an ACL. The lines are processed in the same way as lines in the
28108 Exim configuration file. In particular, continuation lines are supported, blank
28109 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
28110 If the file does not exist or cannot be read, an error occurs (typically
28111 causing a temporary failure of whatever caused the ACL to be run). For example:
28112 .code
28113 acl_smtp_data = /etc/acls/\
28114   ${lookup{$sender_host_address}lsearch\
28115   {/etc/acllist}{$value}{default}}
28116 .endd
28117 This looks up an ACL file to use on the basis of the host's IP address, falling
28118 back to a default if the lookup fails. If an ACL is successfully read from a
28119 file, it is retained in memory for the duration of the Exim process, so that it
28120 can be re-used without having to re-read the file.
28121 .next
28122 If the string does not start with a slash, and does not contain any spaces,
28123 Exim searches the ACL section of the configuration for an ACL whose name
28124 matches the string.
28125 .next
28126 If no named ACL is found, or if the string contains spaces, Exim parses
28127 the string as an inline ACL. This can save typing in cases where you just
28128 want to have something like
28129 .code
28130 acl_smtp_vrfy = accept
28131 .endd
28132 in order to allow free use of the VRFY command. Such a string may contain
28133 newlines; it is processed in the same way as an ACL that is read from a file.
28134 .endlist
28135
28136
28137
28138
28139 .section "ACL return codes" "SECID196"
28140 .cindex "&ACL;" "return codes"
28141 Except for the QUIT ACL, which does not affect the SMTP return code (see
28142 section &<<SECTQUITACL>>& above), the result of running an ACL is either
28143 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
28144 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
28145 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
28146 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28147 This also causes a 4&'xx'& return code.
28148
28149 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28150 &"deny"&, because there is no mechanism for passing temporary errors to the
28151 submitters of non-SMTP messages.
28152
28153
28154 ACLs that are relevant to message reception may also return &"discard"&. This
28155 has the effect of &"accept"&, but causes either the entire message or an
28156 individual recipient address to be discarded. In other words, it is a
28157 blackholing facility. Use it with care.
28158
28159 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
28160 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
28161 RCPT ACL is to discard just the one recipient address. If there are no
28162 recipients left when the message's data is received, the DATA ACL is not
28163 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
28164 remaining recipients. The &"discard"& return is not permitted for the
28165 &%acl_smtp_predata%& ACL.
28166
28167 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
28168 is done on the address and the result determines the SMTP response.
28169
28170
28171 .cindex "&[local_scan()]& function" "when all recipients discarded"
28172 The &[local_scan()]& function is always run, even if there are no remaining
28173 recipients; it may create new recipients.
28174
28175
28176
28177 .section "Unset ACL options" "SECID197"
28178 .cindex "&ACL;" "unset options"
28179 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
28180 all the same. &*Note*&: These defaults apply only when the relevant ACL is
28181 not defined at all. For any defined ACL, the default action when control
28182 reaches the end of the ACL statements is &"deny"&.
28183
28184 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
28185 these two are ACLs that are used only for their side effects. They cannot be
28186 used to accept or reject anything.
28187
28188 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
28189 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
28190 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
28191 when the ACL is not defined is &"accept"&.
28192
28193 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
28194 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
28195 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28196 messages over an SMTP connection. For an example, see the ACL in the default
28197 configuration file.
28198
28199
28200
28201
28202 .section "Data for message ACLs" "SECID198"
28203 .cindex "&ACL;" "data for message ACL"
28204 .vindex &$domain$&
28205 .vindex &$local_part$&
28206 .vindex &$sender_address$&
28207 .vindex &$sender_host_address$&
28208 .vindex &$smtp_command$&
28209 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28210 that contain information about the host and the message's sender (for example,
28211 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28212 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28213 &$local_part$& are set from the argument address. The entire SMTP command
28214 is available in &$smtp_command$&.
28215
28216 When an ACL for the AUTH parameter of MAIL is running, the variables that
28217 contain information about the host are set, but &$sender_address$& is not yet
28218 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28219 how it is used.
28220
28221 .vindex "&$message_size$&"
28222 The &$message_size$& variable is set to the value of the SIZE parameter on
28223 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28224 that parameter is not given. The value is updated to the true message size by
28225 the time the final DATA ACL is run (after the message data has been
28226 received).
28227
28228 .vindex "&$rcpt_count$&"
28229 .vindex "&$recipients_count$&"
28230 The &$rcpt_count$& variable increases by one for each RCPT command received.
28231 The &$recipients_count$& variable increases by one each time a RCPT command is
28232 accepted, so while an ACL for RCPT is being processed, it contains the number
28233 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28234 &$rcpt_count$& contains the total number of RCPT commands, and
28235 &$recipients_count$& contains the total number of accepted recipients.
28236
28237
28238
28239
28240
28241 .section "Data for non-message ACLs" "SECTdatfornon"
28242 .cindex "&ACL;" "data for non-message ACL"
28243 .vindex &$smtp_command_argument$&
28244 .vindex &$smtp_command$&
28245 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28246 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28247 and the entire SMTP command is available in &$smtp_command$&.
28248 These variables can be tested using a &%condition%& condition. For example,
28249 here is an ACL for use with AUTH, which insists that either the session is
28250 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28251 does not permit authentication methods that use cleartext passwords on
28252 unencrypted connections.
28253 .code
28254 acl_check_auth:
28255   accept encrypted = *
28256   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28257                      {CRAM-MD5}}
28258   deny   message   = TLS encryption or CRAM-MD5 required
28259 .endd
28260 (Another way of applying this restriction is to arrange for the authenticators
28261 that use cleartext passwords not to be advertised when the connection is not
28262 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28263 option to do this.)
28264
28265
28266
28267 .section "Format of an ACL" "SECID199"
28268 .cindex "&ACL;" "format of"
28269 .cindex "&ACL;" "verbs, definition of"
28270 An individual ACL consists of a number of statements. Each statement starts
28271 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28272 Modifiers can change the way the verb operates, define error and log messages,
28273 set variables, insert delays, and vary the processing of accepted messages.
28274
28275 If all the conditions are met, the verb is obeyed. The same condition may be
28276 used (with different arguments) more than once in the same statement. This
28277 provides a means of specifying an &"and"& conjunction between conditions. For
28278 example:
28279 .code
28280 deny  dnslists = list1.example
28281       dnslists = list2.example
28282 .endd
28283 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28284 the conditions and modifiers when it reaches a condition that fails. What
28285 happens then depends on the verb (and in one case, on a special modifier). Not
28286 all the conditions make sense at every testing point. For example, you cannot
28287 test a sender address in the ACL that is run for a VRFY command.
28288
28289
28290 .section "ACL verbs" "SECID200"
28291 The ACL verbs are as follows:
28292
28293 .ilist
28294 .cindex "&%accept%& ACL verb"
28295 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28296 of the conditions are not met, what happens depends on whether &%endpass%&
28297 appears among the conditions (for syntax see below). If the failing condition
28298 is before &%endpass%&, control is passed to the next ACL statement; if it is
28299 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28300 check a RCPT command:
28301 .code
28302 accept domains = +local_domains
28303        endpass
28304        verify = recipient
28305 .endd
28306 If the recipient domain does not match the &%domains%& condition, control
28307 passes to the next statement. If it does match, the recipient is verified, and
28308 the command is accepted if verification succeeds. However, if verification
28309 fails, the ACL yields &"deny"&, because the failing condition is after
28310 &%endpass%&.
28311
28312 The &%endpass%& feature has turned out to be confusing to many people, so its
28313 use is not recommended nowadays. It is always possible to rewrite an ACL so
28314 that &%endpass%& is not needed, and it is no longer used in the default
28315 configuration.
28316
28317 .cindex "&%message%& ACL modifier" "with &%accept%&"
28318 If a &%message%& modifier appears on an &%accept%& statement, its action
28319 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28320 (when an &%accept%& verb either accepts or passes control to the next
28321 statement), &%message%& can be used to vary the message that is sent when an
28322 SMTP command is accepted. For example, in a RCPT ACL you could have:
28323 .display
28324 &`accept  `&<&'some conditions'&>
28325 &`        message = OK, I will allow you through today`&
28326 .endd
28327 You can specify an SMTP response code, optionally followed by an &"extended
28328 response code"& at the start of the message, but the first digit must be the
28329 same as would be sent by default, which is 2 for an &%accept%& verb.
28330
28331 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28332 an error message that is used when access is denied. This behaviour is retained
28333 for backward compatibility, but current &"best practice"& is to avoid the use
28334 of &%endpass%&.
28335
28336
28337 .next
28338 .cindex "&%defer%& ACL verb"
28339 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28340 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28341 &%defer%& is the same as &%deny%&, because there is no way of sending a
28342 temporary error. For a RCPT command, &%defer%& is much the same as using a
28343 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28344 be used in any ACL, and even for a recipient it might be a simpler approach.
28345
28346
28347 .next
28348 .cindex "&%deny%& ACL verb"
28349 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28350 the conditions are not met, control is passed to the next ACL statement. For
28351 example,
28352 .code
28353 deny dnslists = blackholes.mail-abuse.org
28354 .endd
28355 rejects commands from hosts that are on a DNS black list.
28356
28357
28358 .next
28359 .cindex "&%discard%& ACL verb"
28360 &%discard%&: This verb behaves like &%accept%&, except that it returns
28361 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28362 that are concerned with receiving messages. When all the conditions are true,
28363 the sending entity receives a &"success"& response. However, &%discard%& causes
28364 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28365 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28366 message's recipients are discarded. Recipients that are discarded before DATA
28367 do not appear in the log line when the &%received_recipients%& log selector is set.
28368
28369 If the &%log_message%& modifier is set when &%discard%& operates,
28370 its contents are added to the line that is automatically written to the log.
28371 The &%message%& modifier operates exactly as it does for &%accept%&.
28372
28373
28374 .next
28375 .cindex "&%drop%& ACL verb"
28376 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28377 forcibly closed after the 5&'xx'& error message has been sent. For example:
28378 .code
28379 drop   message   = I don't take more than 20 RCPTs
28380        condition = ${if > {$rcpt_count}{20}}
28381 .endd
28382 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28383 The connection is always dropped after sending a 550 response.
28384
28385 .next
28386 .cindex "&%require%& ACL verb"
28387 &%require%&: If all the conditions are met, control is passed to the next ACL
28388 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28389 example, when checking a RCPT command,
28390 .code
28391 require message = Sender did not verify
28392         verify  = sender
28393 .endd
28394 passes control to subsequent statements only if the message's sender can be
28395 verified. Otherwise, it rejects the command. Note the positioning of the
28396 &%message%& modifier, before the &%verify%& condition. The reason for this is
28397 discussed in section &<<SECTcondmodproc>>&.
28398
28399 .next
28400 .cindex "&%warn%& ACL verb"
28401 &%warn%&: If all the conditions are true, a line specified by the
28402 &%log_message%& modifier is written to Exim's main log. Control always passes
28403 to the next ACL statement. If any condition is false, the log line is not
28404 written. If an identical log line is requested several times in the same
28405 message, only one copy is actually written to the log. If you want to force
28406 duplicates to be written, use the &%logwrite%& modifier instead.
28407
28408 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28409 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28410 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28411 first failing condition. There is more about adding header lines in section
28412 &<<SECTaddheadacl>>&.
28413
28414 If any condition on a &%warn%& statement cannot be completed (that is, there is
28415 some sort of defer), the log line specified by &%log_message%& is not written.
28416 This does not include the case of a forced failure from a lookup, which
28417 is considered to be a successful completion. After a defer, no further
28418 conditions or modifiers in the &%warn%& statement are processed. The incident
28419 is logged, and the ACL continues to be processed, from the next statement
28420 onwards.
28421
28422
28423 .vindex "&$acl_verify_message$&"
28424 When one of the &%warn%& conditions is an address verification that fails, the
28425 text of the verification failure message is in &$acl_verify_message$&. If you
28426 want this logged, you must set it up explicitly. For example:
28427 .code
28428 warn   !verify = sender
28429        log_message = sender verify failed: $acl_verify_message
28430 .endd
28431 .endlist
28432
28433 At the end of each ACL there is an implicit unconditional &%deny%&.
28434
28435 As you can see from the examples above, the conditions and modifiers are
28436 written one to a line, with the first one on the same line as the verb, and
28437 subsequent ones on following lines. If you have a very long condition, you can
28438 continue it onto several physical lines by the usual backslash continuation
28439 mechanism. It is conventional to align the conditions vertically.
28440
28441
28442
28443 .section "ACL variables" "SECTaclvariables"
28444 .cindex "&ACL;" "variables"
28445 There are some special variables that can be set during ACL processing. They
28446 can be used to pass information between different ACLs, different invocations
28447 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28448 transports, and filters that are used to deliver a message. The names of these
28449 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28450 an underscore, but the remainder of the name can be any sequence of
28451 alphanumeric characters and underscores that you choose. There is no limit on
28452 the number of ACL variables. The two sets act as follows:
28453 .ilist
28454 The values of those variables whose names begin with &$acl_c$& persist
28455 throughout an SMTP connection. They are never reset. Thus, a value that is set
28456 while receiving one message is still available when receiving the next message
28457 on the same SMTP connection.
28458 .next
28459 The values of those variables whose names begin with &$acl_m$& persist only
28460 while a message is being received. They are reset afterwards. They are also
28461 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28462 .endlist
28463
28464 When a message is accepted, the current values of all the ACL variables are
28465 preserved with the message and are subsequently made available at delivery
28466 time. The ACL variables are set by a modifier called &%set%&. For example:
28467 .code
28468 accept hosts = whatever
28469        set acl_m4 = some value
28470 accept authenticated = *
28471        set acl_c_auth = yes
28472 .endd
28473 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28474 be set. If you want to set a variable without taking any action, you can use a
28475 &%warn%& verb without any other modifiers or conditions.
28476
28477 .oindex &%strict_acl_vars%&
28478 What happens if a syntactically valid but undefined ACL variable is
28479 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28480 false (the default), an empty string is substituted; if it is true, an
28481 error is generated.
28482
28483 Versions of Exim before 4.64 have a limited set of numbered variables, but
28484 their names are compatible, so there is no problem with upgrading.
28485
28486
28487 .section "Condition and modifier processing" "SECTcondmodproc"
28488 .cindex "&ACL;" "conditions; processing"
28489 .cindex "&ACL;" "modifiers; processing"
28490 An exclamation mark preceding a condition negates its result. For example:
28491 .code
28492 deny   domains = *.dom.example
28493       !verify  = recipient
28494 .endd
28495 causes the ACL to return &"deny"& if the recipient domain ends in
28496 &'dom.example'& and the recipient address cannot be verified. Sometimes
28497 negation can be used on the right-hand side of a condition. For example, these
28498 two statements are equivalent:
28499 .code
28500 deny  hosts = !192.168.3.4
28501 deny !hosts =  192.168.3.4
28502 .endd
28503 However, for many conditions (&%verify%& being a good example), only left-hand
28504 side negation of the whole condition is possible.
28505
28506 The arguments of conditions and modifiers are expanded. A forced failure
28507 of an expansion causes a condition to be ignored, that is, it behaves as if the
28508 condition is true. Consider these two statements:
28509 .code
28510 accept  senders = ${lookup{$host_name}lsearch\
28511                   {/some/file}{$value}fail}
28512 accept  senders = ${lookup{$host_name}lsearch\
28513                   {/some/file}{$value}{}}
28514 .endd
28515 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28516 the returned list is searched, but if the lookup fails the behaviour is
28517 different in the two cases. The &%fail%& in the first statement causes the
28518 condition to be ignored, leaving no further conditions. The &%accept%& verb
28519 therefore succeeds. The second statement, however, generates an empty list when
28520 the lookup fails. No sender can match an empty list, so the condition fails,
28521 and therefore the &%accept%& also fails.
28522
28523 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28524 specify actions that are taken as the conditions for a statement are checked;
28525 others specify text for messages that are used when access is denied or a
28526 warning is generated. The &%control%& modifier affects the way an incoming
28527 message is handled.
28528
28529 The positioning of the modifiers in an ACL statement is important, because the
28530 processing of a verb ceases as soon as its outcome is known. Only those
28531 modifiers that have already been encountered will take effect. For example,
28532 consider this use of the &%message%& modifier:
28533 .code
28534 require message = Can't verify sender
28535         verify  = sender
28536         message = Can't verify recipient
28537         verify  = recipient
28538         message = This message cannot be used
28539 .endd
28540 If sender verification fails, Exim knows that the result of the statement is
28541 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28542 so its text is used as the error message. If sender verification succeeds, but
28543 recipient verification fails, the second message is used. If recipient
28544 verification succeeds, the third message becomes &"current"&, but is never used
28545 because there are no more conditions to cause failure.
28546
28547 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28548 modifier that is used, because all the conditions must be true for rejection to
28549 happen. Specifying more than one &%message%& modifier does not make sense, and
28550 the message can even be specified after all the conditions. For example:
28551 .code
28552 deny   hosts = ...
28553       !senders = *@my.domain.example
28554        message = Invalid sender from client host
28555 .endd
28556 The &"deny"& result does not happen until the end of the statement is reached,
28557 by which time Exim has set up the message.
28558
28559
28560
28561 .section "ACL modifiers" "SECTACLmodi"
28562 .cindex "&ACL;" "modifiers; list of"
28563 The ACL modifiers are as follows:
28564
28565 .vlist
28566 .vitem &*add_header*&&~=&~<&'text'&>
28567 This modifier specifies one or more header lines that are to be added to an
28568 incoming message, assuming, of course, that the message is ultimately
28569 accepted. For details, see section &<<SECTaddheadacl>>&.
28570
28571 .vitem &*continue*&&~=&~<&'text'&>
28572 .cindex "&%continue%& ACL modifier"
28573 .cindex "database" "updating in ACL"
28574 This modifier does nothing of itself, and processing of the ACL always
28575 continues with the next condition or modifier. The value of &%continue%& is in
28576 the side effects of expanding its argument. Typically this could be used to
28577 update a database. It is really just a syntactic tidiness, to avoid having to
28578 write rather ugly lines like this:
28579 .display
28580 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28581 .endd
28582 Instead, all you need is
28583 .display
28584 &`continue = `&<&'some expansion'&>
28585 .endd
28586
28587 .vitem &*control*&&~=&~<&'text'&>
28588 .cindex "&%control%& ACL modifier"
28589 This modifier affects the subsequent processing of the SMTP connection or of an
28590 incoming message that is accepted. The effect of the first type of control
28591 lasts for the duration of the connection, whereas the effect of the second type
28592 lasts only until the current message has been received. The message-specific
28593 controls always apply to the whole message, not to individual recipients,
28594 even if the &%control%& modifier appears in a RCPT ACL.
28595
28596 As there are now quite a few controls that can be applied, they are described
28597 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28598 in several different ways. For example:
28599
28600 . ==== As this is a nested list, any displays it contains must be indented
28601 . ==== as otherwise they are too far to the left. That comment applies only
28602 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28603 . ==== way.
28604
28605 .ilist
28606 It can be at the end of an &%accept%& statement:
28607 .code
28608     accept  ...some conditions
28609             control = queue_only
28610 .endd
28611 In this case, the control is applied when this statement yields &"accept"&, in
28612 other words, when the conditions are all true.
28613
28614 .next
28615 It can be in the middle of an &%accept%& statement:
28616 .code
28617     accept  ...some conditions...
28618             control = queue_only
28619             ...some more conditions...
28620 .endd
28621 If the first set of conditions are true, the control is applied, even if the
28622 statement does not accept because one of the second set of conditions is false.
28623 In this case, some subsequent statement must yield &"accept"& for the control
28624 to be relevant.
28625
28626 .next
28627 It can be used with &%warn%& to apply the control, leaving the
28628 decision about accepting or denying to a subsequent verb. For
28629 example:
28630 .code
28631     warn    ...some conditions...
28632             control = freeze
28633     accept  ...
28634 .endd
28635 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28636 &%logwrite%&, so it does not add anything to the message and does not write a
28637 log entry.
28638
28639 .next
28640 If you want to apply a control unconditionally, you can use it with a
28641 &%require%& verb. For example:
28642 .code
28643     require  control = no_multiline_responses
28644 .endd
28645 .endlist
28646
28647 .vitem &*delay*&&~=&~<&'time'&>
28648 .cindex "&%delay%& ACL modifier"
28649 .oindex "&%-bh%&"
28650 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28651 the time interval before proceeding. However, when testing Exim using the
28652 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28653 output instead). The time is given in the usual Exim notation, and the delay
28654 happens as soon as the modifier is processed. In an SMTP session, pending
28655 output is flushed before the delay is imposed.
28656
28657 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28658 example:
28659 .code
28660 deny    ...some conditions...
28661         delay = 30s
28662 .endd
28663 The delay happens if all the conditions are true, before the statement returns
28664 &"deny"&. Compare this with:
28665 .code
28666 deny    delay = 30s
28667         ...some conditions...
28668 .endd
28669 which waits for 30s before processing the conditions. The &%delay%& modifier
28670 can also be used with &%warn%& and together with &%control%&:
28671 .code
28672 warn    ...some conditions...
28673         delay = 2m
28674         control = freeze
28675 accept  ...
28676 .endd
28677
28678 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28679 responses to several commands are no longer buffered and sent in one packet (as
28680 they would normally be) because all output is flushed before imposing the
28681 delay. This optimization is disabled so that a number of small delays do not
28682 appear to the client as one large aggregated delay that might provoke an
28683 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28684 using a &%control%& modifier to set &%no_delay_flush%&.
28685
28686
28687 .vitem &*endpass*&
28688 .cindex "&%endpass%& ACL modifier"
28689 This modifier, which has no argument, is recognized only in &%accept%& and
28690 &%discard%& statements. It marks the boundary between the conditions whose
28691 failure causes control to pass to the next statement, and the conditions whose
28692 failure causes the ACL to return &"deny"&. This concept has proved to be
28693 confusing to some people, so the use of &%endpass%& is no longer recommended as
28694 &"best practice"&. See the description of &%accept%& above for more details.
28695
28696
28697 .vitem &*log_message*&&~=&~<&'text'&>
28698 .cindex "&%log_message%& ACL modifier"
28699 This modifier sets up a message that is used as part of the log message if the
28700 ACL denies access or a &%warn%& statement's conditions are true. For example:
28701 .code
28702 require log_message = wrong cipher suite $tls_in_cipher
28703         encrypted   = DES-CBC3-SHA
28704 .endd
28705 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28706 example:
28707 .display
28708 &`discard `&<&'some conditions'&>
28709 &`        log_message = Discarded $local_part@$domain because...`&
28710 .endd
28711 When access is denied, &%log_message%& adds to any underlying error message
28712 that may exist because of a condition failure. For example, while verifying a
28713 recipient address, a &':fail:'& redirection might have already set up a
28714 message.
28715
28716 The message may be defined before the conditions to which it applies, because
28717 the string expansion does not happen until Exim decides that access is to be
28718 denied. This means that any variables that are set by the condition are
28719 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28720 variables are set after a DNS black list lookup succeeds. If the expansion of
28721 &%log_message%& fails, or if the result is an empty string, the modifier is
28722 ignored.
28723
28724 .vindex "&$acl_verify_message$&"
28725 If you want to use a &%warn%& statement to log the result of an address
28726 verification, you can use &$acl_verify_message$& to include the verification
28727 error message.
28728
28729 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28730 the start of the logged message. If the same warning log message is requested
28731 more than once while receiving  a single email message, only one copy is
28732 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28733 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28734 is logged for a successful &%warn%& statement.
28735
28736 If &%log_message%& is not present and there is no underlying error message (for
28737 example, from the failure of address verification), but &%message%& is present,
28738 the &%message%& text is used for logging rejections. However, if any text for
28739 logging contains newlines, only the first line is logged. In the absence of
28740 both &%log_message%& and &%message%&, a default built-in message is used for
28741 logging rejections.
28742
28743
28744 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28745 .cindex "&%log_reject_target%& ACL modifier"
28746 .cindex "logging in ACL" "specifying which log"
28747 This modifier makes it possible to specify which logs are used for messages
28748 about ACL rejections. Its argument is a colon-separated list of words that can
28749 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28750 may be empty, in which case a rejection is not logged at all. For example, this
28751 ACL fragment writes no logging information when access is denied:
28752 .display
28753 &`deny `&<&'some conditions'&>
28754 &`     log_reject_target =`&
28755 .endd
28756 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28757 permanent and temporary rejections. Its effect lasts for the rest of the
28758 current ACL.
28759
28760
28761 .vitem &*logwrite*&&~=&~<&'text'&>
28762 .cindex "&%logwrite%& ACL modifier"
28763 .cindex "logging in ACL" "immediate"
28764 This modifier writes a message to a log file as soon as it is encountered when
28765 processing an ACL. (Compare &%log_message%&, which, except in the case of
28766 &%warn%& and &%discard%&, is used only if the ACL statement denies
28767 access.) The &%logwrite%& modifier can be used to log special incidents in
28768 ACLs. For example:
28769 .display
28770 &`accept `&<&'some special conditions'&>
28771 &`       control  = freeze`&
28772 &`       logwrite = froze message because ...`&
28773 .endd
28774 By default, the message is written to the main log. However, it may begin
28775 with a colon, followed by a comma-separated list of log names, and then
28776 another colon, to specify exactly which logs are to be written. For
28777 example:
28778 .code
28779 logwrite = :main,reject: text for main and reject logs
28780 logwrite = :panic: text for panic log only
28781 .endd
28782
28783
28784 .vitem &*message*&&~=&~<&'text'&>
28785 .cindex "&%message%& ACL modifier"
28786 This modifier sets up a text string that is expanded and used as a response
28787 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28788 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28789 there is some complication if &%endpass%& is involved; see the description of
28790 &%accept%& for details.)
28791
28792 The expansion of the message happens at the time Exim decides that the ACL is
28793 to end, not at the time it processes &%message%&. If the expansion fails, or
28794 generates an empty string, the modifier is ignored. Here is an example where
28795 &%message%& must be specified first, because the ACL ends with a rejection if
28796 the &%hosts%& condition fails:
28797 .code
28798 require  message = Host not recognized
28799          hosts = 10.0.0.0/8
28800 .endd
28801 (Once a condition has failed, no further conditions or modifiers are
28802 processed.)
28803
28804 .cindex "SMTP" "error codes"
28805 .oindex "&%smtp_banner%&
28806 For ACLs that are triggered by SMTP commands, the message is returned as part
28807 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28808 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28809 is accepted. In the case of the connect ACL, accepting with a message modifier
28810 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28811 accept message may not contain more than one line (otherwise it will be
28812 truncated at the first newline and a panic logged), and it cannot affect the
28813 EHLO options.
28814
28815 When SMTP is involved, the message may begin with an overriding response code,
28816 consisting of three digits optionally followed by an &"extended response code"&
28817 of the form &'n.n.n'&, each code being followed by a space. For example:
28818 .code
28819 deny  message = 599 1.2.3 Host not welcome
28820       hosts = 192.168.34.0/24
28821 .endd
28822 The first digit of the supplied response code must be the same as would be sent
28823 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28824 access, but for the predata ACL, note that the default success code is 354, not
28825 2&'xx'&.
28826
28827 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28828 the message modifier cannot override the 221 response code.
28829
28830 The text in a &%message%& modifier is literal; any quotes are taken as
28831 literals, but because the string is expanded, backslash escapes are processed
28832 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28833 response.
28834
28835 .vindex "&$acl_verify_message$&"
28836 For ACLs that are called by an &%acl =%& ACL condition, the message is
28837 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28838
28839 If &%message%& is used on a statement that verifies an address, the message
28840 specified overrides any message that is generated by the verification process.
28841 However, the original message is available in the variable
28842 &$acl_verify_message$&, so you can incorporate it into your message if you
28843 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28844 routers to be passed back as part of the SMTP response, you should either not
28845 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28846
28847 For compatibility with previous releases of Exim, a &%message%& modifier that
28848 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28849 modifier, but this usage is now deprecated. However, &%message%& acts only when
28850 all the conditions are true, wherever it appears in an ACL command, whereas
28851 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28852 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28853 effect.
28854
28855
28856 .vitem &*queue*&&~=&~<&'text'&>
28857 This modifier specifies the use of a named queue for spool files
28858 for the message.
28859 It can only be used before the message is received (i.e. not in
28860 the DATA ACL).
28861 This could be used, for example, for known high-volume burst sources
28862 of traffic, or for quarantine of messages.
28863 Separate queue-runner processes will be needed for named queues.
28864 If the text after expansion is empty, the default queue is used.
28865
28866
28867 .vitem &*remove_header*&&~=&~<&'text'&>
28868 This modifier specifies one or more header names in a colon-separated list
28869  that are to be removed from an incoming message, assuming, of course, that
28870 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28871
28872
28873 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28874 .cindex "&%set%& ACL modifier"
28875 This modifier puts a value into one of the ACL variables (see section
28876 &<<SECTaclvariables>>&).
28877
28878
28879 .vitem &*udpsend*&&~=&~<&'parameters'&>
28880 This modifier sends a UDP packet, for purposes such as statistics
28881 collection or behaviour monitoring. The parameters are expanded, and
28882 the result of the expansion must be a colon-separated list consisting
28883 of a destination server, port number, and the packet contents. The
28884 server can be specified as a host name or IPv4 or IPv6 address. The
28885 separator can be changed with the usual angle bracket syntax. For
28886 example, you might want to collect information on which hosts connect
28887 when:
28888 .code
28889 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28890              $tod_zulu $sender_host_address
28891 .endd
28892 .endlist
28893
28894
28895
28896
28897 .section "Use of the control modifier" "SECTcontrols"
28898 .cindex "&%control%& ACL modifier"
28899 The &%control%& modifier supports the following settings:
28900
28901 .vlist
28902 .vitem &*control&~=&~allow_auth_unadvertised*&
28903 This modifier allows a client host to use the SMTP AUTH command even when it
28904 has not been advertised in response to EHLO. Furthermore, because there are
28905 apparently some really broken clients that do this, Exim will accept AUTH after
28906 HELO (rather than EHLO) when this control is set. It should be used only if you
28907 really need it, and you should limit its use to those broken clients that do
28908 not work without it. For example:
28909 .code
28910 warn hosts   = 192.168.34.25
28911      control = allow_auth_unadvertised
28912 .endd
28913 Normally, when an Exim server receives an AUTH command, it checks the name of
28914 the authentication mechanism that is given in the command to ensure that it
28915 matches an advertised mechanism. When this control is set, the check that a
28916 mechanism has been advertised is bypassed. Any configured mechanism can be used
28917 by the client. This control is permitted only in the connection and HELO ACLs.
28918
28919
28920 .vitem &*control&~=&~caseful_local_part*& &&&
28921        &*control&~=&~caselower_local_part*&
28922 .cindex "&ACL;" "case of local part in"
28923 .cindex "case of local parts"
28924 .vindex "&$local_part$&"
28925 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28926 (that is, during RCPT processing). By default, the contents of &$local_part$&
28927 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28928 any uppercase letters in the original local part are restored in &$local_part$&
28929 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28930 is encountered.
28931
28932 These controls affect only the current recipient. Moreover, they apply only to
28933 local part handling that takes place directly in the ACL (for example, as a key
28934 in lookups). If a test to verify the recipient is obeyed, the case-related
28935 handling of the local part during the verification is controlled by the router
28936 configuration (see the &%caseful_local_part%& generic router option).
28937
28938 This facility could be used, for example, to add a spam score to local parts
28939 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28940 spam score:
28941 .code
28942 warn  control = caseful_local_part
28943       set acl_m4 = ${eval:\
28944                      $acl_m4 + \
28945                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28946                     }
28947       control = caselower_local_part
28948 .endd
28949 Notice that we put back the lower cased version afterwards, assuming that
28950 is what is wanted for subsequent tests.
28951
28952
28953 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
28954 .cindex "&ACL;" "cutthrough routing"
28955 .cindex "cutthrough" "requesting"
28956 This option requests delivery be attempted while the item is being received.
28957
28958 The option is usable in the RCPT ACL.
28959 If enabled for a message received via smtp and routed to an smtp transport,
28960 and only one transport, interface, destination host and port combination
28961 is used for all recipients of the message,
28962 then the delivery connection is made while the receiving connection is open
28963 and data is copied from one to the other.
28964
28965 An attempt to set this option for any recipient but the first
28966 for a mail will be quietly ignored.
28967 If a recipient-verify callout
28968 (with use_sender)
28969 connection is subsequently
28970 requested in the same ACL it is held open and used for
28971 any subsequent recipients and the data,
28972 otherwise one is made after the initial RCPT ACL completes.
28973
28974 Note that routers are used in verify mode,
28975 and cannot depend on content of received headers.
28976 Note also that headers cannot be
28977 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28978 Headers may be modified by routers (subject to the above) and transports.
28979
28980 All the usual ACLs are called; if one results in the message being
28981 rejected, all effort spent in delivery (including the costs on
28982 the ultimate destination) will be wasted.
28983 Note that in the case of data-time ACLs this includes the entire
28984 message body.
28985
28986 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28987 of outgoing messages is done, because it sends data to the ultimate destination
28988 before the entire message has been received from the source.
28989 It is not supported for messages received with the SMTP PRDR
28990 or CHUNKING
28991 options in use.
28992
28993 Should the ultimate destination system positively accept or reject the mail,
28994 a corresponding indication is given to the source system and nothing is queued.
28995 If the item is successfully delivered in cutthrough mode
28996 the delivery log lines are tagged with ">>" rather than "=>" and appear
28997 before the acceptance "<=" line.
28998
28999 If there is a temporary error the item is queued for later delivery in the
29000 usual fashion.
29001 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
29002 to the control; the default value is &"spool"& and the alternate value
29003 &"pass"& copies an SMTP defer response from the target back to the initiator
29004 and does not queue the message.
29005 Note that this is independent of any recipient verify conditions in the ACL.
29006
29007 Delivery in this mode avoids the generation of a bounce mail to a
29008 (possibly faked)
29009 sender when the destination system is doing content-scan based rejection.
29010
29011
29012 .vitem &*control&~=&~debug/*&<&'options'&>
29013 .cindex "&ACL;" "enabling debug logging"
29014 .cindex "debugging" "enabling from an ACL"
29015 This control turns on debug logging, almost as though Exim had been invoked
29016 with &`-d`&, with the output going to a new logfile, by default called
29017 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
29018 may access any variables already defined.  The logging may be adjusted with
29019 the &'opts'& option, which takes the same values as the &`-d`& command-line
29020 option.
29021 Logging may be stopped, and the file removed, with the &'kill'& option.
29022 Some examples (which depend on variables that don't exist in all
29023 contexts):
29024 .code
29025       control = debug
29026       control = debug/tag=.$sender_host_address
29027       control = debug/opts=+expand+acl
29028       control = debug/tag=.$message_exim_id/opts=+expand
29029       control = debug/kill
29030 .endd
29031
29032
29033 .vitem &*control&~=&~dkim_disable_verify*&
29034 .cindex "disable DKIM verify"
29035 .cindex "DKIM" "disable verify"
29036 This control turns off DKIM verification processing entirely.  For details on
29037 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
29038
29039
29040 .vitem &*control&~=&~dscp/*&<&'value'&>
29041 .cindex "&ACL;" "setting DSCP value"
29042 .cindex "DSCP" "inbound"
29043 This option causes the DSCP value associated with the socket for the inbound
29044 connection to be adjusted to a given value, given as one of a number of fixed
29045 strings or to numeric value.
29046 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
29047 Common values include &`throughput`&, &`mincost`&, and on newer systems
29048 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
29049
29050 The outbound packets from Exim will be marked with this value in the header
29051 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
29052 that these values will have any effect, not be stripped by networking
29053 equipment, or do much of anything without cooperation with your Network
29054 Engineer and those of all network operators between the source and destination.
29055
29056
29057 .vitem &*control&~=&~enforce_sync*& &&&
29058        &*control&~=&~no_enforce_sync*&
29059 .cindex "SMTP" "synchronization checking"
29060 .cindex "synchronization checking in SMTP"
29061 These controls make it possible to be selective about when SMTP synchronization
29062 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
29063 state of the switch (it is true by default). See the description of this option
29064 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
29065
29066 The effect of these two controls lasts for the remainder of the SMTP
29067 connection. They can appear in any ACL except the one for the non-SMTP
29068 messages. The most straightforward place to put them is in the ACL defined by
29069 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
29070 before the first synchronization check. The expected use is to turn off the
29071 synchronization checks for badly-behaved hosts that you nevertheless need to
29072 work with.
29073
29074
29075 .vitem &*control&~=&~fakedefer/*&<&'message'&>
29076 .cindex "fake defer"
29077 .cindex "defer, fake"
29078 This control works in exactly the same way as &%fakereject%& (described below)
29079 except that it causes an SMTP 450 response after the message data instead of a
29080 550 response. You must take care when using &%fakedefer%& because it causes the
29081 messages to be duplicated when the sender retries. Therefore, you should not
29082 use &%fakedefer%& if the message is to be delivered normally.
29083
29084 .vitem &*control&~=&~fakereject/*&<&'message'&>
29085 .cindex "fake rejection"
29086 .cindex "rejection, fake"
29087 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
29088 words, only when an SMTP message is being received. If Exim accepts the
29089 message, instead the final 250 response, a 550 rejection message is sent.
29090 However, Exim proceeds to deliver the message as normal. The control applies
29091 only to the current message, not to any subsequent ones that may be received in
29092 the same SMTP connection.
29093
29094 The text for the 550 response is taken from the &%control%& modifier. If no
29095 message is supplied, the following is used:
29096 .code
29097 550-Your message has been rejected but is being
29098 550-kept for evaluation.
29099 550-If it was a legitimate message, it may still be
29100 550 delivered to the target recipient(s).
29101 .endd
29102 This facility should be used with extreme caution.
29103
29104 .vitem &*control&~=&~freeze*&
29105 .cindex "frozen messages" "forcing in ACL"
29106 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29107 other words, only when a message is being received. If the message is accepted,
29108 it is placed on Exim's queue and frozen. The control applies only to the
29109 current message, not to any subsequent ones that may be received in the same
29110 SMTP connection.
29111
29112 This modifier can optionally be followed by &`/no_tell`&. If the global option
29113 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
29114 is told about the freezing), provided all the &*control=freeze*& modifiers that
29115 are obeyed for the current message have the &`/no_tell`& option.
29116
29117 .vitem &*control&~=&~no_delay_flush*&
29118 .cindex "SMTP" "output flushing, disabling for delay"
29119 Exim normally flushes SMTP output before implementing a delay in an ACL, to
29120 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29121 use. This control, as long as it is encountered before the &%delay%& modifier,
29122 disables such output flushing.
29123
29124 .vitem &*control&~=&~no_callout_flush*&
29125 .cindex "SMTP" "output flushing, disabling for callout"
29126 Exim normally flushes SMTP output before performing a callout in an ACL, to
29127 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29128 use. This control, as long as it is encountered before the &%verify%& condition
29129 that causes the callout, disables such output flushing.
29130
29131 .vitem &*control&~=&~no_mbox_unspool*&
29132 This control is available when Exim is compiled with the content scanning
29133 extension. Content scanning may require a copy of the current message, or parts
29134 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
29135 or spam scanner. Normally, such copies are deleted when they are no longer
29136 needed. If this control is set, the copies are not deleted. The control applies
29137 only to the current message, not to any subsequent ones that may be received in
29138 the same SMTP connection. It is provided for debugging purposes and is unlikely
29139 to be useful in production.
29140
29141 .vitem &*control&~=&~no_multiline_responses*&
29142 .cindex "multiline responses, suppressing"
29143 This control is permitted for any ACL except the one for non-SMTP messages.
29144 It seems that there are broken clients in use that cannot handle multiline
29145 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
29146
29147 If this control is set, multiline SMTP responses from ACL rejections are
29148 suppressed. One way of doing this would have been to put out these responses as
29149 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
29150 (&"use multiline responses for more"& it says &-- ha!), and some of the
29151 responses might get close to that. So this facility, which is after all only a
29152 sop to broken clients, is implemented by doing two very easy things:
29153
29154 .ilist
29155 Extra information that is normally output as part of a rejection caused by
29156 sender verification failure is omitted. Only the final line (typically &"sender
29157 verification failed"&) is sent.
29158 .next
29159 If a &%message%& modifier supplies a multiline response, only the first
29160 line is output.
29161 .endlist
29162
29163 The setting of the switch can, of course, be made conditional on the
29164 calling host. Its effect lasts until the end of the SMTP connection.
29165
29166 .vitem &*control&~=&~no_pipelining*&
29167 .cindex "PIPELINING" "suppressing advertising"
29168 This control turns off the advertising of the PIPELINING extension to SMTP in
29169 the current session. To be useful, it must be obeyed before Exim sends its
29170 response to an EHLO command. Therefore, it should normally appear in an ACL
29171 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
29172 &%pipelining_advertise_hosts%&.
29173
29174 .vitem &*control&~=&~queue_only*&
29175 .oindex "&%queue_only%&"
29176 .cindex "queueing incoming messages"
29177 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29178 other words, only when a message is being received. If the message is accepted,
29179 it is placed on Exim's queue and left there for delivery by a subsequent queue
29180 runner. No immediate delivery process is started. In other words, it has the
29181 effect as the &%queue_only%& global option. However, the control applies only
29182 to the current message, not to any subsequent ones that may be received in the
29183 same SMTP connection.
29184
29185 .vitem &*control&~=&~submission/*&<&'options'&>
29186 .cindex "message" "submission"
29187 .cindex "submission mode"
29188 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
29189 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
29190 the current message is a submission from a local MUA. In this case, Exim
29191 operates in &"submission mode"&, and applies certain fixups to the message if
29192 necessary. For example, it adds a &'Date:'& header line if one is not present.
29193 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
29194 late (the message has already been created).
29195
29196 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
29197 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
29198 submission mode; the available options for this control are described there.
29199 The control applies only to the current message, not to any subsequent ones
29200 that may be received in the same SMTP connection.
29201
29202 .vitem &*control&~=&~suppress_local_fixups*&
29203 .cindex "submission fixups, suppressing"
29204 This control applies to locally submitted (non TCP/IP) messages, and is the
29205 complement of &`control = submission`&. It disables the fixups that are
29206 normally applied to locally-submitted messages. Specifically:
29207
29208 .ilist
29209 Any &'Sender:'& header line is left alone (in this respect, it is a
29210 dynamic version of &%local_sender_retain%&).
29211 .next
29212 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29213 .next
29214 There is no check that &'From:'& corresponds to the actual sender.
29215 .endlist ilist
29216
29217 This control may be useful when a remotely-originated message is accepted,
29218 passed to some scanning program, and then re-submitted for delivery. It can be
29219 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29220 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29221 data is read.
29222
29223 &*Note:*& This control applies only to the current message, not to any others
29224 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29225
29226 .vitem &*control&~=&~utf8_downconvert*&
29227 This control enables conversion of UTF-8 in message addresses
29228 to a-label form.
29229 For details see section &<<SECTi18nMTA>>&.
29230 .endlist vlist
29231
29232
29233 .section "Summary of message fixup control" "SECTsummesfix"
29234 All four possibilities for message fixups can be specified:
29235
29236 .ilist
29237 Locally submitted, fixups applied: the default.
29238 .next
29239 Locally submitted, no fixups applied: use
29240 &`control = suppress_local_fixups`&.
29241 .next
29242 Remotely submitted, no fixups applied: the default.
29243 .next
29244 Remotely submitted, fixups applied: use &`control = submission`&.
29245 .endlist
29246
29247
29248
29249 .section "Adding header lines in ACLs" "SECTaddheadacl"
29250 .cindex "header lines" "adding in an ACL"
29251 .cindex "header lines" "position of added lines"
29252 .cindex "&%add_header%& ACL modifier"
29253 The &%add_header%& modifier can be used to add one or more extra header lines
29254 to an incoming message, as in this example:
29255 .code
29256 warn dnslists = sbl.spamhaus.org : \
29257                 dialup.mail-abuse.org
29258      add_header = X-blacklisted-at: $dnslist_domain
29259 .endd
29260 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29261 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29262 receiving a message). The message must ultimately be accepted for
29263 &%add_header%& to have any significant effect. You can use &%add_header%& with
29264 any ACL verb, including &%deny%& (though this is potentially useful only in a
29265 RCPT ACL).
29266
29267 Headers will not be added to the message if the modifier is used in
29268 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29269
29270 Leading and trailing newlines are removed from
29271 the data for the &%add_header%& modifier; if it then
29272 contains one or more newlines that
29273 are not followed by a space or a tab, it is assumed to contain multiple header
29274 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29275 front of any line that is not a valid header line.
29276
29277 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29278 They are added to the message before processing the DATA and MIME ACLs.
29279 However, if an identical header line is requested more than once, only one copy
29280 is actually added to the message. Further header lines may be accumulated
29281 during the DATA and MIME ACLs, after which they are added to the message, again
29282 with duplicates suppressed. Thus, it is possible to add two identical header
29283 lines to an SMTP message, but only if one is added before DATA and one after.
29284 In the case of non-SMTP messages, new headers are accumulated during the
29285 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29286 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29287 are included in the entry that is written to the reject log.
29288
29289 .cindex "header lines" "added; visibility of"
29290 Header lines are not visible in string expansions
29291 of message headers
29292 until they are added to the
29293 message. It follows that header lines defined in the MAIL, RCPT, and predata
29294 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29295 header lines that are added by the DATA or MIME ACLs are not visible in those
29296 ACLs. Because of this restriction, you cannot use header lines as a way of
29297 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29298 this, you can use ACL variables, as described in section
29299 &<<SECTaclvariables>>&.
29300
29301 The list of headers yet to be added is given by the &%$headers_added%& variable.
29302
29303 The &%add_header%& modifier acts immediately as it is encountered during the
29304 processing of an ACL. Notice the difference between these two cases:
29305 .display
29306 &`accept add_header = ADDED: some text`&
29307 &`       `&<&'some condition'&>
29308
29309 &`accept `&<&'some condition'&>
29310 &`       add_header = ADDED: some text`&
29311 .endd
29312 In the first case, the header line is always added, whether or not the
29313 condition is true. In the second case, the header line is added only if the
29314 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29315 ACL statement. All those that are encountered before a condition fails are
29316 honoured.
29317
29318 .cindex "&%warn%& ACL verb"
29319 For compatibility with previous versions of Exim, a &%message%& modifier for a
29320 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29321 effect only if all the conditions are true, even if it appears before some of
29322 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29323 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29324 are present on a &%warn%& verb, both are processed according to their
29325 specifications.
29326
29327 By default, new header lines are added to a message at the end of the existing
29328 header lines. However, you can specify that any particular header line should
29329 be added right at the start (before all the &'Received:'& lines), immediately
29330 after the first block of &'Received:'& lines, or immediately before any line
29331 that is not a &'Received:'& or &'Resent-something:'& header.
29332
29333 This is done by specifying &":at_start:"&, &":after_received:"&, or
29334 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29335 header line, respectively. (Header text cannot start with a colon, as there has
29336 to be a header name first.) For example:
29337 .code
29338 warn add_header = \
29339        :after_received:X-My-Header: something or other...
29340 .endd
29341 If more than one header line is supplied in a single &%add_header%& modifier,
29342 each one is treated independently and can therefore be placed differently. If
29343 you add more than one line at the start, or after the Received: block, they end
29344 up in reverse order.
29345
29346 &*Warning*&: This facility currently applies only to header lines that are
29347 added in an ACL. It does NOT work for header lines that are added in a
29348 system filter or in a router or transport.
29349
29350
29351
29352 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29353 .cindex "header lines" "removing in an ACL"
29354 .cindex "header lines" "position of removed lines"
29355 .cindex "&%remove_header%& ACL modifier"
29356 The &%remove_header%& modifier can be used to remove one or more header lines
29357 from an incoming message, as in this example:
29358 .code
29359 warn   message        = Remove internal headers
29360        remove_header  = x-route-mail1 : x-route-mail2
29361 .endd
29362 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29363 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29364 receiving a message). The message must ultimately be accepted for
29365 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29366 with any ACL verb, including &%deny%&, though this is really not useful for
29367 any verb that doesn't result in a delivered message.
29368
29369 Headers will not be removed from the message if the modifier is used in
29370 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29371
29372 More than one header can be removed at the same time by using a colon separated
29373 list of header names. The header matching is case insensitive. Wildcards are
29374 not permitted, nor is list expansion performed, so you cannot use hostlists to
29375 create a list of headers, however both connection and message variable expansion
29376 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29377 .code
29378 warn   hosts           = +internal_hosts
29379        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29380 warn   message         = Remove internal headers
29381        remove_header   = $acl_c_ihdrs
29382 .endd
29383 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29384 They are removed from the message before processing the DATA and MIME ACLs.
29385 There is no harm in attempting to remove the same header twice nor is removing
29386 a non-existent header. Further header lines to be removed may be accumulated
29387 during the DATA and MIME ACLs, after which they are removed from the message,
29388 if present. In the case of non-SMTP messages, headers to be removed are
29389 accumulated during the non-SMTP ACLs, and are removed from the message after
29390 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29391 ACL, there really is no effect because there is no logging of what headers
29392 would have been removed.
29393
29394 .cindex "header lines" "removed; visibility of"
29395 Header lines are not visible in string expansions until the DATA phase when it
29396 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29397 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29398 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29399 this restriction, you cannot use header lines as a way of controlling data
29400 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29401 you should instead use ACL variables, as described in section
29402 &<<SECTaclvariables>>&.
29403
29404 The &%remove_header%& modifier acts immediately as it is encountered during the
29405 processing of an ACL. Notice the difference between these two cases:
29406 .display
29407 &`accept remove_header = X-Internal`&
29408 &`       `&<&'some condition'&>
29409
29410 &`accept `&<&'some condition'&>
29411 &`       remove_header = X-Internal`&
29412 .endd
29413 In the first case, the header line is always removed, whether or not the
29414 condition is true. In the second case, the header line is removed only if the
29415 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29416 same ACL statement. All those that are encountered before a condition fails
29417 are honoured.
29418
29419 &*Warning*&: This facility currently applies only to header lines that are
29420 present during ACL processing. It does NOT remove header lines that are added
29421 in a system filter or in a router or transport.
29422
29423
29424
29425
29426 .section "ACL conditions" "SECTaclconditions"
29427 .cindex "&ACL;" "conditions; list of"
29428 Some of the conditions listed in this section are available only when Exim is
29429 compiled with the content-scanning extension. They are included here briefly
29430 for completeness. More detailed descriptions can be found in the discussion on
29431 content scanning in chapter &<<CHAPexiscan>>&.
29432
29433 Not all conditions are relevant in all circumstances. For example, testing
29434 senders and recipients does not make sense in an ACL that is being run as the
29435 result of the arrival of an ETRN command, and checks on message headers can be
29436 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29437 can use the same condition (with different parameters) more than once in the
29438 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29439 The conditions are as follows:
29440
29441
29442 .vlist
29443 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29444 .cindex "&ACL;" "nested"
29445 .cindex "&ACL;" "indirect"
29446 .cindex "&ACL;" "arguments"
29447 .cindex "&%acl%& ACL condition"
29448 The possible values of the argument are the same as for the
29449 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29450 &"accept"& the condition is true; if it returns &"deny"& the condition is
29451 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29452 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29453 condition false. This means that further processing of the &%warn%& verb
29454 ceases, but processing of the ACL continues.
29455
29456 If the argument is a named ACL, up to nine space-separated optional values
29457 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29458 and $acl_narg is set to the count of values.
29459 Previous values of these variables are restored after the call returns.
29460 The name and values are expanded separately.
29461 Note that spaces in complex expansions which are used as arguments
29462 will act as argument separators.
29463
29464 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29465 the connection is dropped. If it returns &"discard"&, the verb must be
29466 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29467 conditions are tested.
29468
29469 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29470 loops. This condition allows you to use different ACLs in different
29471 circumstances. For example, different ACLs can be used to handle RCPT commands
29472 for different local users or different local domains.
29473
29474 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29475 .cindex "&%authenticated%& ACL condition"
29476 .cindex "authentication" "ACL checking"
29477 .cindex "&ACL;" "testing for authentication"
29478 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29479 the name of the authenticator is tested against the list. To test for
29480 authentication by any authenticator, you can set
29481 .code
29482 authenticated = *
29483 .endd
29484
29485 .vitem &*condition&~=&~*&<&'string'&>
29486 .cindex "&%condition%& ACL condition"
29487 .cindex "customizing" "ACL condition"
29488 .cindex "&ACL;" "customized test"
29489 .cindex "&ACL;" "testing, customized"
29490 This feature allows you to make up custom conditions. If the result of
29491 expanding the string is an empty string, the number zero, or one of the strings
29492 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29493 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29494 any other value, some error is assumed to have occurred, and the ACL returns
29495 &"defer"&. However, if the expansion is forced to fail, the condition is
29496 ignored. The effect is to treat it as true, whether it is positive or
29497 negative.
29498
29499 .vitem &*decode&~=&~*&<&'location'&>
29500 .cindex "&%decode%& ACL condition"
29501 This condition is available only when Exim is compiled with the
29502 content-scanning extension, and it is allowed only in the ACL defined by
29503 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29504 If all goes well, the condition is true. It is false only if there are
29505 problems such as a syntax error or a memory shortage. For more details, see
29506 chapter &<<CHAPexiscan>>&.
29507
29508 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29509 .cindex "&%dnslists%& ACL condition"
29510 .cindex "DNS list" "in ACL"
29511 .cindex "black list (DNS)"
29512 .cindex "&ACL;" "testing a DNS list"
29513 This condition checks for entries in DNS black lists. These are also known as
29514 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29515 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29516 different variants of this condition to describe briefly here. See sections
29517 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29518
29519 .vitem &*domains&~=&~*&<&'domain&~list'&>
29520 .cindex "&%domains%& ACL condition"
29521 .cindex "domain" "ACL checking"
29522 .cindex "&ACL;" "testing a recipient domain"
29523 .vindex "&$domain_data$&"
29524 This condition is relevant only after a RCPT command. It checks that the domain
29525 of the recipient address is in the domain list. If percent-hack processing is
29526 enabled, it is done before this test is done. If the check succeeds with a
29527 lookup, the result of the lookup is placed in &$domain_data$& until the next
29528 &%domains%& test.
29529
29530 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29531 use &%domains%& in a DATA ACL.
29532
29533
29534 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29535 .cindex "&%encrypted%& ACL condition"
29536 .cindex "encryption" "checking in an ACL"
29537 .cindex "&ACL;" "testing for encryption"
29538 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29539 name of the cipher suite in use is tested against the list. To test for
29540 encryption without testing for any specific cipher suite(s), set
29541 .code
29542 encrypted = *
29543 .endd
29544
29545
29546 .vitem &*hosts&~=&~*&<&'host&~list'&>
29547 .cindex "&%hosts%& ACL condition"
29548 .cindex "host" "ACL checking"
29549 .cindex "&ACL;" "testing the client host"
29550 This condition tests that the calling host matches the host list. If you have
29551 name lookups or wildcarded host names and IP addresses in the same host list,
29552 you should normally put the IP addresses first. For example, you could have:
29553 .code
29554 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29555 .endd
29556 The lookup in this example uses the host name for its key. This is implied by
29557 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29558 and it wouldn't matter which way round you had these two items.)
29559
29560 The reason for the problem with host names lies in the left-to-right way that
29561 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29562 but when it reaches an item that requires a host name, it fails if it cannot
29563 find a host name to compare with the pattern. If the above list is given in the
29564 opposite order, the &%accept%& statement fails for a host whose name cannot be
29565 found, even if its IP address is 10.9.8.7.
29566
29567 If you really do want to do the name check first, and still recognize the IP
29568 address even if the name lookup fails, you can rewrite the ACL like this:
29569 .code
29570 accept hosts = dbm;/etc/friendly/hosts
29571 accept hosts = 10.9.8.7
29572 .endd
29573 The default action on failing to find the host name is to assume that the host
29574 is not in the list, so the first &%accept%& statement fails. The second
29575 statement can then check the IP address.
29576
29577 .vindex "&$host_data$&"
29578 If a &%hosts%& condition is satisfied by means of a lookup, the result
29579 of the lookup is made available in the &$host_data$& variable. This
29580 allows you, for example, to set up a statement like this:
29581 .code
29582 deny  hosts = net-lsearch;/some/file
29583 message = $host_data
29584 .endd
29585 which gives a custom error message for each denied host.
29586
29587 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29588 .cindex "&%local_parts%& ACL condition"
29589 .cindex "local part" "ACL checking"
29590 .cindex "&ACL;" "testing a local part"
29591 .vindex "&$local_part_data$&"
29592 This condition is relevant only after a RCPT command. It checks that the local
29593 part of the recipient address is in the list. If percent-hack processing is
29594 enabled, it is done before this test. If the check succeeds with a lookup, the
29595 result of the lookup is placed in &$local_part_data$&, which remains set until
29596 the next &%local_parts%& test.
29597
29598 .vitem &*malware&~=&~*&<&'option'&>
29599 .cindex "&%malware%& ACL condition"
29600 .cindex "&ACL;" "virus scanning"
29601 .cindex "&ACL;" "scanning for viruses"
29602 This condition is available only when Exim is compiled with the
29603 content-scanning extension. It causes the incoming message to be scanned for
29604 viruses. For details, see chapter &<<CHAPexiscan>>&.
29605
29606 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29607 .cindex "&%mime_regex%& ACL condition"
29608 .cindex "&ACL;" "testing by regex matching"
29609 This condition is available only when Exim is compiled with the
29610 content-scanning extension, and it is allowed only in the ACL defined by
29611 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29612 with any of the regular expressions. For details, see chapter
29613 &<<CHAPexiscan>>&.
29614
29615 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29616 .cindex "rate limiting"
29617 This condition can be used to limit the rate at which a user or host submits
29618 messages. Details are given in section &<<SECTratelimiting>>&.
29619
29620 .vitem &*recipients&~=&~*&<&'address&~list'&>
29621 .cindex "&%recipients%& ACL condition"
29622 .cindex "recipient" "ACL checking"
29623 .cindex "&ACL;" "testing a recipient"
29624 This condition is relevant only after a RCPT command. It checks the entire
29625 recipient address against a list of recipients.
29626
29627 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29628 .cindex "&%regex%& ACL condition"
29629 .cindex "&ACL;" "testing by regex matching"
29630 This condition is available only when Exim is compiled with the
29631 content-scanning extension, and is available only in the DATA, MIME, and
29632 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29633 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29634
29635 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29636 .cindex "&%sender_domains%& ACL condition"
29637 .cindex "sender" "ACL checking"
29638 .cindex "&ACL;" "testing a sender domain"
29639 .vindex "&$domain$&"
29640 .vindex "&$sender_address_domain$&"
29641 This condition tests the domain of the sender of the message against the given
29642 domain list. &*Note*&: The domain of the sender address is in
29643 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29644 of this condition. This is an exception to the general rule for testing domain
29645 lists. It is done this way so that, if this condition is used in an ACL for a
29646 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29647 influence the sender checking.
29648
29649 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29650 relaying, because sender addresses are easily, and commonly, forged.
29651
29652 .vitem &*senders&~=&~*&<&'address&~list'&>
29653 .cindex "&%senders%& ACL condition"
29654 .cindex "sender" "ACL checking"
29655 .cindex "&ACL;" "testing a sender"
29656 This condition tests the sender of the message against the given list. To test
29657 for a bounce message, which has an empty sender, set
29658 .code
29659 senders = :
29660 .endd
29661 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29662 relaying, because sender addresses are easily, and commonly, forged.
29663
29664 .vitem &*spam&~=&~*&<&'username'&>
29665 .cindex "&%spam%& ACL condition"
29666 .cindex "&ACL;" "scanning for spam"
29667 This condition is available only when Exim is compiled with the
29668 content-scanning extension. It causes the incoming message to be scanned by
29669 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29670
29671 .vitem &*verify&~=&~certificate*&
29672 .cindex "&%verify%& ACL condition"
29673 .cindex "TLS" "client certificate verification"
29674 .cindex "certificate" "verification of client"
29675 .cindex "&ACL;" "certificate verification"
29676 .cindex "&ACL;" "testing a TLS certificate"
29677 This condition is true in an SMTP session if the session is encrypted, and a
29678 certificate was received from the client, and the certificate was verified. The
29679 server requests a certificate only if the client matches &%tls_verify_hosts%&
29680 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29681
29682 .vitem &*verify&~=&~csa*&
29683 .cindex "CSA verification"
29684 This condition checks whether the sending host (the client) is authorized to
29685 send email. Details of how this works are given in section
29686 &<<SECTverifyCSA>>&.
29687
29688 .vitem &*verify&~=&~header_names_ascii*&
29689 .cindex "&%verify%& ACL condition"
29690 .cindex "&ACL;" "verifying header names only ASCII"
29691 .cindex "header lines" "verifying header names only ASCII"
29692 .cindex "verifying" "header names only ASCII"
29693 This condition is relevant only in an ACL that is run after a message has been
29694 received, that is, in an ACL specified by &%acl_smtp_data%& or
29695 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29696 there are no non-ASCII characters, also excluding control characters.  The
29697 allowable characters are decimal ASCII values 33 through 126.
29698
29699 Exim itself will handle headers with non-ASCII characters, but it can cause
29700 problems for downstream applications, so this option will allow their
29701 detection and rejection in the DATA ACL's.
29702
29703 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29704 .cindex "&%verify%& ACL condition"
29705 .cindex "&ACL;" "verifying sender in the header"
29706 .cindex "header lines" "verifying the sender in"
29707 .cindex "sender" "verifying in header"
29708 .cindex "verifying" "sender in header"
29709 This condition is relevant only in an ACL that is run after a message has been
29710 received, that is, in an ACL specified by &%acl_smtp_data%& or
29711 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29712 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29713 is loosely thought of as a &"sender"& address (hence the name of the test).
29714 However, an address that appears in one of these headers need not be an address
29715 that accepts bounce messages; only sender addresses in envelopes are required
29716 to accept bounces. Therefore, if you use the callout option on this check, you
29717 might want to arrange for a non-empty address in the MAIL command.
29718
29719 Details of address verification and the options are given later, starting at
29720 section &<<SECTaddressverification>>& (callouts are described in section
29721 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29722 condition to restrict it to bounce messages only:
29723 .code
29724 deny    senders = :
29725         message = A valid sender header is required for bounces
29726        !verify  = header_sender
29727 .endd
29728
29729 .vitem &*verify&~=&~header_syntax*&
29730 .cindex "&%verify%& ACL condition"
29731 .cindex "&ACL;" "verifying header syntax"
29732 .cindex "header lines" "verifying syntax"
29733 .cindex "verifying" "header syntax"
29734 This condition is relevant only in an ACL that is run after a message has been
29735 received, that is, in an ACL specified by &%acl_smtp_data%& or
29736 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29737 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29738 and &'Bcc:'&), returning true if there are no problems.
29739 Unqualified addresses (local parts without domains) are
29740 permitted only in locally generated messages and from hosts that match
29741 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29742 appropriate.
29743
29744 Note that this condition is a syntax check only. However, a common spamming
29745 ploy used to be to send syntactically invalid headers such as
29746 .code
29747 To: @
29748 .endd
29749 and this condition can be used to reject such messages, though they are not as
29750 common as they used to be.
29751
29752 .vitem &*verify&~=&~helo*&
29753 .cindex "&%verify%& ACL condition"
29754 .cindex "&ACL;" "verifying HELO/EHLO"
29755 .cindex "HELO" "verifying"
29756 .cindex "EHLO" "verifying"
29757 .cindex "verifying" "EHLO"
29758 .cindex "verifying" "HELO"
29759 This condition is true if a HELO or EHLO command has been received from the
29760 client host, and its contents have been verified. If there has been no previous
29761 attempt to verify the HELO/EHLO contents, it is carried out when this
29762 condition is encountered. See the description of the &%helo_verify_hosts%& and
29763 &%helo_try_verify_hosts%& options for details of how to request verification
29764 independently of this condition.
29765
29766 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29767 option), this condition is always true.
29768
29769
29770 .vitem &*verify&~=&~not_blind*&
29771 .cindex "verifying" "not blind"
29772 .cindex "bcc recipients, verifying none"
29773 This condition checks that there are no blind (bcc) recipients in the message.
29774 Every envelope recipient must appear either in a &'To:'& header line or in a
29775 &'Cc:'& header line for this condition to be true. Local parts are checked
29776 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29777 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29778 used only in a DATA or non-SMTP ACL.
29779
29780 There are, of course, many legitimate messages that make use of blind (bcc)
29781 recipients. This check should not be used on its own for blocking messages.
29782
29783
29784 .vitem &*verify&~=&~recipient/*&<&'options'&>
29785 .cindex "&%verify%& ACL condition"
29786 .cindex "&ACL;" "verifying recipient"
29787 .cindex "recipient" "verifying"
29788 .cindex "verifying" "recipient"
29789 .vindex "&$address_data$&"
29790 This condition is relevant only after a RCPT command. It verifies the current
29791 recipient. Details of address verification are given later, starting at section
29792 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29793 of &$address_data$& is the last value that was set while routing the address.
29794 This applies even if the verification fails. When an address that is being
29795 verified is redirected to a single address, verification continues with the new
29796 address, and in that case, the subsequent value of &$address_data$& is the
29797 value for the child address.
29798
29799 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29800 .cindex "&%verify%& ACL condition"
29801 .cindex "&ACL;" "verifying host reverse lookup"
29802 .cindex "host" "verifying reverse lookup"
29803 This condition ensures that a verified host name has been looked up from the IP
29804 address of the client host. (This may have happened already if the host name
29805 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29806 Verification ensures that the host name obtained from a reverse DNS lookup, or
29807 one of its aliases, does, when it is itself looked up in the DNS, yield the
29808 original IP address.
29809
29810 There is one possible option, &`defer_ok`&.  If this is present and a
29811 DNS operation returns a temporary error, the verify condition succeeds.
29812
29813 If this condition is used for a locally generated message (that is, when there
29814 is no client host involved), it always succeeds.
29815
29816 .vitem &*verify&~=&~sender/*&<&'options'&>
29817 .cindex "&%verify%& ACL condition"
29818 .cindex "&ACL;" "verifying sender"
29819 .cindex "sender" "verifying"
29820 .cindex "verifying" "sender"
29821 This condition is relevant only after a MAIL or RCPT command, or after a
29822 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29823 the message's sender is empty (that is, this is a bounce message), the
29824 condition is true. Otherwise, the sender address is verified.
29825
29826 .vindex "&$address_data$&"
29827 .vindex "&$sender_address_data$&"
29828 If there is data in the &$address_data$& variable at the end of routing, its
29829 value is placed in &$sender_address_data$& at the end of verification. This
29830 value can be used in subsequent conditions and modifiers in the same ACL
29831 statement. It does not persist after the end of the current statement. If you
29832 want to preserve the value for longer, you can save it in an ACL variable.
29833
29834 Details of verification are given later, starting at section
29835 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29836 to avoid doing it more than once per message.
29837
29838 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29839 .cindex "&%verify%& ACL condition"
29840 This is a variation of the previous option, in which a modified address is
29841 verified as a sender.
29842
29843 Note that '/' is legal in local-parts; if the address may have such
29844 (eg. is generated from the received message)
29845 they must be protected from the options parsing by doubling:
29846 .code
29847 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
29848 .endd
29849 .endlist
29850
29851
29852
29853 .section "Using DNS lists" "SECTmorednslists"
29854 .cindex "DNS list" "in ACL"
29855 .cindex "black list (DNS)"
29856 .cindex "&ACL;" "testing a DNS list"
29857 In its simplest form, the &%dnslists%& condition tests whether the calling host
29858 is on at least one of a number of DNS lists by looking up the inverted IP
29859 address in one or more DNS domains. (Note that DNS list domains are not mail
29860 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29861 special options instead.) For example, if the calling host's IP
29862 address is 192.168.62.43, and the ACL statement is
29863 .code
29864 deny dnslists = blackholes.mail-abuse.org : \
29865                 dialups.mail-abuse.org
29866 .endd
29867 the following records are looked up:
29868 .code
29869 43.62.168.192.blackholes.mail-abuse.org
29870 43.62.168.192.dialups.mail-abuse.org
29871 .endd
29872 As soon as Exim finds an existing DNS record, processing of the list stops.
29873 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29874 to test that a host is on more than one list (an &"and"& conjunction), you can
29875 use two separate conditions:
29876 .code
29877 deny dnslists = blackholes.mail-abuse.org
29878      dnslists = dialups.mail-abuse.org
29879 .endd
29880 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29881 behaves as if the host does not match the list item, that is, as if the DNS
29882 record does not exist. If there are further items in the DNS list, they are
29883 processed.
29884
29885 This is usually the required action when &%dnslists%& is used with &%deny%&
29886 (which is the most common usage), because it prevents a DNS failure from
29887 blocking mail. However, you can change this behaviour by putting one of the
29888 following special items in the list:
29889 .display
29890 &`+include_unknown `&   behave as if the item is on the list
29891 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29892 &`+defer_unknown   `&   give a temporary error
29893 .endd
29894 .cindex "&`+include_unknown`&"
29895 .cindex "&`+exclude_unknown`&"
29896 .cindex "&`+defer_unknown`&"
29897 Each of these applies to any subsequent items on the list. For example:
29898 .code
29899 deny dnslists = +defer_unknown : foo.bar.example
29900 .endd
29901 Testing the list of domains stops as soon as a match is found. If you want to
29902 warn for one list and block for another, you can use two different statements:
29903 .code
29904 deny  dnslists = blackholes.mail-abuse.org
29905 warn  message  = X-Warn: sending host is on dialups list
29906       dnslists = dialups.mail-abuse.org
29907 .endd
29908 .cindex caching "of dns lookup"
29909 .cindex DNS TTL
29910 DNS list lookups are cached by Exim for the duration of the SMTP session
29911 (but limited by the DNS return TTL value),
29912 so a lookup based on the IP address is done at most once for any incoming
29913 connection (assuming long-enough TTL).
29914 Exim does not share information between multiple incoming
29915 connections (but your local name server cache should be active).
29916
29917
29918
29919 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29920 .cindex "DNS list" "keyed by explicit IP address"
29921 By default, the IP address that is used in a DNS list lookup is the IP address
29922 of the calling host. However, you can specify another IP address by listing it
29923 after the domain name, introduced by a slash. For example:
29924 .code
29925 deny dnslists = black.list.tld/192.168.1.2
29926 .endd
29927 This feature is not very helpful with explicit IP addresses; it is intended for
29928 use with IP addresses that are looked up, for example, the IP addresses of the
29929 MX hosts or nameservers of an email sender address. For an example, see section
29930 &<<SECTmulkeyfor>>& below.
29931
29932
29933
29934
29935 .section "DNS lists keyed on domain names" "SECID202"
29936 .cindex "DNS list" "keyed by domain name"
29937 There are some lists that are keyed on domain names rather than inverted IP
29938 addresses (see for example the &'domain based zones'& link at
29939 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29940 with these lists. You can change the name that is looked up in a DNS list by
29941 listing it after the domain name, introduced by a slash. For example,
29942 .code
29943 deny  message  = Sender's domain is listed at $dnslist_domain
29944       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29945 .endd
29946 This particular example is useful only in ACLs that are obeyed after the
29947 RCPT or DATA commands, when a sender address is available. If (for
29948 example) the message's sender is &'user@tld.example'& the name that is looked
29949 up by this example is
29950 .code
29951 tld.example.dsn.rfc-ignorant.org
29952 .endd
29953 A single &%dnslists%& condition can contain entries for both names and IP
29954 addresses. For example:
29955 .code
29956 deny dnslists = sbl.spamhaus.org : \
29957                 dsn.rfc-ignorant.org/$sender_address_domain
29958 .endd
29959 The first item checks the sending host's IP address; the second checks a domain
29960 name. The whole condition is true if either of the DNS lookups succeeds.
29961
29962
29963
29964
29965 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29966 .cindex "DNS list" "multiple keys for"
29967 The syntax described above for looking up explicitly-defined values (either
29968 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29969 name for the DNS list, what follows the slash can in fact be a list of items.
29970 As with all lists in Exim, the default separator is a colon. However, because
29971 this is a sublist within the list of DNS blacklist domains, it is necessary
29972 either to double the separators like this:
29973 .code
29974 dnslists = black.list.tld/name.1::name.2
29975 .endd
29976 or to change the separator character, like this:
29977 .code
29978 dnslists = black.list.tld/<;name.1;name.2
29979 .endd
29980 If an item in the list is an IP address, it is inverted before the DNS
29981 blacklist domain is appended. If it is not an IP address, no inversion
29982 occurs. Consider this condition:
29983 .code
29984 dnslists = black.list.tld/<;192.168.1.2;a.domain
29985 .endd
29986 The DNS lookups that occur are:
29987 .code
29988 2.1.168.192.black.list.tld
29989 a.domain.black.list.tld
29990 .endd
29991 Once a DNS record has been found (that matches a specific IP return
29992 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29993 are done. If there is a temporary DNS error, the rest of the sublist of domains
29994 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29995 only if no other DNS lookup in this sublist succeeds. In other words, a
29996 successful lookup for any of the items in the sublist overrides a temporary
29997 error for a previous item.
29998
29999 The ability to supply a list of items after the slash is in some sense just a
30000 syntactic convenience. These two examples have the same effect:
30001 .code
30002 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
30003 dnslists = black.list.tld/a.domain::b.domain
30004 .endd
30005 However, when the data for the list is obtained from a lookup, the second form
30006 is usually much more convenient. Consider this example:
30007 .code
30008 deny message  = The mail servers for the domain \
30009                 $sender_address_domain \
30010                 are listed at $dnslist_domain ($dnslist_value); \
30011                 see $dnslist_text.
30012      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
30013                                    ${lookup dnsdb {>|mxh=\
30014                                    $sender_address_domain} }} }
30015 .endd
30016 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
30017 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
30018 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
30019 of expanding the condition might be something like this:
30020 .code
30021 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
30022 .endd
30023 Thus, this example checks whether or not the IP addresses of the sender
30024 domain's mail servers are on the Spamhaus black list.
30025
30026 The key that was used for a successful DNS list lookup is put into the variable
30027 &$dnslist_matched$& (see section &<<SECID204>>&).
30028
30029
30030
30031
30032 .section "Data returned by DNS lists" "SECID203"
30033 .cindex "DNS list" "data returned from"
30034 DNS lists are constructed using address records in the DNS. The original RBL
30035 just used the address 127.0.0.1 on the right hand side of each record, but the
30036 RBL+ list and some other lists use a number of values with different meanings.
30037 The values used on the RBL+ list are:
30038 .display
30039 127.1.0.1  RBL
30040 127.1.0.2  DUL
30041 127.1.0.3  DUL and RBL
30042 127.1.0.4  RSS
30043 127.1.0.5  RSS and RBL
30044 127.1.0.6  RSS and DUL
30045 127.1.0.7  RSS and DUL and RBL
30046 .endd
30047 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
30048 different values. Some DNS lists may return more than one address record;
30049 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
30050
30051
30052 .section "Variables set from DNS lists" "SECID204"
30053 .cindex "expansion" "variables, set from DNS list"
30054 .cindex "DNS list" "variables set from"
30055 .vindex "&$dnslist_domain$&"
30056 .vindex "&$dnslist_matched$&"
30057 .vindex "&$dnslist_text$&"
30058 .vindex "&$dnslist_value$&"
30059 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
30060 the name of the overall domain that matched (for example,
30061 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
30062 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
30063 the DNS record. When the key is an IP address, it is not reversed in
30064 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
30065 cases, for example:
30066 .code
30067 deny dnslists = spamhaus.example
30068 .endd
30069 the key is also available in another variable (in this case,
30070 &$sender_host_address$&). In more complicated cases, however, this is not true.
30071 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
30072 might generate a dnslists lookup like this:
30073 .code
30074 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
30075 .endd
30076 If this condition succeeds, the value in &$dnslist_matched$& might be
30077 &`192.168.6.7`& (for example).
30078
30079 If more than one address record is returned by the DNS lookup, all the IP
30080 addresses are included in &$dnslist_value$&, separated by commas and spaces.
30081 The variable &$dnslist_text$& contains the contents of any associated TXT
30082 record. For lists such as RBL+ the TXT record for a merged entry is often not
30083 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
30084 information.
30085
30086 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
30087 &-- although these appear before the condition in the ACL, they are not
30088 expanded until after it has failed. For example:
30089 .code
30090 deny    hosts = !+local_networks
30091         message = $sender_host_address is listed \
30092                   at $dnslist_domain
30093         dnslists = rbl-plus.mail-abuse.example
30094 .endd
30095
30096
30097
30098 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
30099 .cindex "DNS list" "matching specific returned data"
30100 You can add an equals sign and an IP address after a &%dnslists%& domain name
30101 in order to restrict its action to DNS records with a matching right hand side.
30102 For example,
30103 .code
30104 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
30105 .endd
30106 rejects only those hosts that yield 127.0.0.2. Without this additional data,
30107 any address record is considered to be a match. For the moment, we assume
30108 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
30109 describes how multiple records are handled.
30110
30111 More than one IP address may be given for checking, using a comma as a
30112 separator. These are alternatives &-- if any one of them matches, the
30113 &%dnslists%& condition is true. For example:
30114 .code
30115 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30116 .endd
30117 If you want to specify a constraining address list and also specify names or IP
30118 addresses to be looked up, the constraining address list must be specified
30119 first. For example:
30120 .code
30121 deny dnslists = dsn.rfc-ignorant.org\
30122                 =127.0.0.2/$sender_address_domain
30123 .endd
30124
30125 If the character &`&&`& is used instead of &`=`&, the comparison for each
30126 listed IP address is done by a bitwise &"and"& instead of by an equality test.
30127 In other words, the listed addresses are used as bit masks. The comparison is
30128 true if all the bits in the mask are present in the address that is being
30129 tested. For example:
30130 .code
30131 dnslists = a.b.c&0.0.0.3
30132 .endd
30133 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
30134 want to test whether one bit or another bit is present (as opposed to both
30135 being present), you must use multiple values. For example:
30136 .code
30137 dnslists = a.b.c&0.0.0.1,0.0.0.2
30138 .endd
30139 matches if the final component of the address is an odd number or two times
30140 an odd number.
30141
30142
30143
30144 .section "Negated DNS matching conditions" "SECID205"
30145 You can supply a negative list of IP addresses as part of a &%dnslists%&
30146 condition. Whereas
30147 .code
30148 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30149 .endd
30150 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30151 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
30152 .code
30153 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
30154 .endd
30155 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30156 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
30157 words, the result of the test is inverted if an exclamation mark appears before
30158 the &`=`& (or the &`&&`&) sign.
30159
30160 &*Note*&: This kind of negation is not the same as negation in a domain,
30161 host, or address list (which is why the syntax is different).
30162
30163 If you are using just one list, the negation syntax does not gain you much. The
30164 previous example is precisely equivalent to
30165 .code
30166 deny  dnslists = a.b.c
30167      !dnslists = a.b.c=127.0.0.2,127.0.0.3
30168 .endd
30169 However, if you are using multiple lists, the negation syntax is clearer.
30170 Consider this example:
30171 .code
30172 deny  dnslists = sbl.spamhaus.org : \
30173                  list.dsbl.org : \
30174                  dnsbl.njabl.org!=127.0.0.3 : \
30175                  relays.ordb.org
30176 .endd
30177 Using only positive lists, this would have to be:
30178 .code
30179 deny  dnslists = sbl.spamhaus.org : \
30180                  list.dsbl.org
30181 deny  dnslists = dnsbl.njabl.org
30182      !dnslists = dnsbl.njabl.org=127.0.0.3
30183 deny  dnslists = relays.ordb.org
30184 .endd
30185 which is less clear, and harder to maintain.
30186
30187
30188
30189
30190 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
30191 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
30192 thereby providing more than one IP address. When an item in a &%dnslists%& list
30193 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
30194 the match to specific results from the DNS lookup, there are two ways in which
30195 the checking can be handled. For example, consider the condition:
30196 .code
30197 dnslists = a.b.c=127.0.0.1
30198 .endd
30199 What happens if the DNS lookup for the incoming IP address yields both
30200 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
30201 condition true because at least one given value was found, or is it false
30202 because at least one of the found values was not listed? And how does this
30203 affect negated conditions? Both possibilities are provided for with the help of
30204 additional separators &`==`& and &`=&&`&.
30205
30206 .ilist
30207 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30208 IP addresses matches one of the listed addresses. For the example above, the
30209 condition is true because 127.0.0.1 matches.
30210 .next
30211 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30212 looked up IP addresses matches one of the listed addresses. If the condition is
30213 changed to:
30214 .code
30215 dnslists = a.b.c==127.0.0.1
30216 .endd
30217 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30218 false because 127.0.0.2 is not listed. You would need to have:
30219 .code
30220 dnslists = a.b.c==127.0.0.1,127.0.0.2
30221 .endd
30222 for the condition to be true.
30223 .endlist
30224
30225 When &`!`& is used to negate IP address matching, it inverts the result, giving
30226 the precise opposite of the behaviour above. Thus:
30227 .ilist
30228 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30229 addresses matches one of the listed addresses. Consider:
30230 .code
30231 dnslists = a.b.c!&0.0.0.1
30232 .endd
30233 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30234 false because 127.0.0.1 matches.
30235 .next
30236 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30237 looked up IP address that does not match. Consider:
30238 .code
30239 dnslists = a.b.c!=&0.0.0.1
30240 .endd
30241 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30242 true, because 127.0.0.2 does not match. You would need to have:
30243 .code
30244 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30245 .endd
30246 for the condition to be false.
30247 .endlist
30248 When the DNS lookup yields only a single IP address, there is no difference
30249 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30250
30251
30252
30253
30254 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30255 .cindex "DNS list" "information from merged"
30256 When the facility for restricting the matching IP values in a DNS list is used,
30257 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30258 the true reason for rejection. This happens when lists are merged and the IP
30259 address in the A record is used to distinguish them; unfortunately there is
30260 only one TXT record. One way round this is not to use merged lists, but that
30261 can be inefficient because it requires multiple DNS lookups where one would do
30262 in the vast majority of cases when the host of interest is not on any of the
30263 lists.
30264
30265 A less inefficient way of solving this problem is available. If
30266 two domain names, comma-separated, are given, the second is used first to
30267 do an initial check, making use of any IP value restrictions that are set.
30268 If there is a match, the first domain is used, without any IP value
30269 restrictions, to get the TXT record. As a byproduct of this, there is also
30270 a check that the IP being tested is indeed on the first list. The first
30271 domain is the one that is put in &$dnslist_domain$&. For example:
30272 .code
30273 reject message  = \
30274          rejected because $sender_host_address is blacklisted \
30275          at $dnslist_domain\n$dnslist_text
30276        dnslists = \
30277          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30278          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30279 .endd
30280 For the first blacklist item, this starts by doing a lookup in
30281 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30282 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30283 value, and as long as something is found, it looks for the corresponding TXT
30284 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30285 The second blacklist item is processed similarly.
30286
30287 If you are interested in more than one merged list, the same list must be
30288 given several times, but because the results of the DNS lookups are cached,
30289 the DNS calls themselves are not repeated. For example:
30290 .code
30291 reject dnslists = \
30292          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30293          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30294          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30295          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30296 .endd
30297 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30298 values matches (or if no record is found), this is the only lookup that is
30299 done. Only if there is a match is one of the more specific lists consulted.
30300
30301
30302
30303 .section "DNS lists and IPv6" "SECTmorednslistslast"
30304 .cindex "IPv6" "DNS black lists"
30305 .cindex "DNS list" "IPv6 usage"
30306 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30307 nibble by nibble. For example, if the calling host's IP address is
30308 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30309 .code
30310 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30311   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30312 .endd
30313 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30314 lists contain wildcard records, intended for IPv4, that interact badly with
30315 IPv6. For example, the DNS entry
30316 .code
30317 *.3.some.list.example.    A    127.0.0.1
30318 .endd
30319 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30320 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30321
30322 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30323 &%condition%& condition, as in this example:
30324 .code
30325 deny   condition = ${if isip4{$sender_host_address}}
30326        dnslists  = some.list.example
30327 .endd
30328
30329 If an explicit key is being used for a DNS lookup and it may be an IPv6
30330 address you should specify alternate list separators for both the outer
30331 (DNS list name) list and inner (lookup keys) list:
30332 .code
30333        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30334 .endd
30335
30336 .section "Rate limiting incoming messages" "SECTratelimiting"
30337 .cindex "rate limiting" "client sending"
30338 .cindex "limiting client sending rates"
30339 .oindex "&%smtp_ratelimit_*%&"
30340 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30341 which clients can send email. This is more powerful than the
30342 &%smtp_ratelimit_*%& options, because those options control the rate of
30343 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30344 works across all connections (concurrent and sequential) from the same client
30345 host. The syntax of the &%ratelimit%& condition is:
30346 .display
30347 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30348 .endd
30349 If the average client sending rate is less than &'m'& messages per time
30350 period &'p'& then the condition is false; otherwise it is true.
30351
30352 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30353 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30354 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30355 of &'p'&.
30356
30357 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30358 time interval, for example, &`8h`& for eight hours. A larger time constant
30359 means that it takes Exim longer to forget a client's past behaviour. The
30360 parameter &'m'& is the maximum number of messages that a client is permitted to
30361 send in each time interval. It also specifies the number of messages permitted
30362 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30363 constant, you can allow a client to send more messages in a burst without
30364 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30365 both small, messages must be sent at an even rate.
30366
30367 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30368 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30369 when deploying the &%ratelimit%& ACL condition. The script prints usage
30370 instructions when it is run with no arguments.
30371
30372 The key is used to look up the data for calculating the client's average
30373 sending rate. This data is stored in Exim's spool directory, alongside the
30374 retry and other hints databases. The default key is &$sender_host_address$&,
30375 which means Exim computes the sending rate of each client host IP address.
30376 By changing the key you can change how Exim identifies clients for the purpose
30377 of ratelimiting. For example, to limit the sending rate of each authenticated
30378 user, independent of the computer they are sending from, set the key to
30379 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30380 example, &$authenticated_id$& is only meaningful if the client has
30381 authenticated (which you can check with the &%authenticated%& ACL condition).
30382
30383 The lookup key does not have to identify clients: If you want to limit the
30384 rate at which a recipient receives messages, you can use the key
30385 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30386 ACL.
30387
30388 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30389 specifies what Exim measures the rate of, for example messages or recipients
30390 or bytes. You can adjust the measurement using the &%unique=%& and/or
30391 &%count=%& options. You can also control when Exim updates the recorded rate
30392 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30393 separated by a slash, like the other parameters. They may appear in any order.
30394
30395 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30396 any options that alter the meaning of the stored data. The limit &'m'& is not
30397 stored, so you can alter the configured maximum rate and Exim will still
30398 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30399 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30400 behaviour. The lookup key is not affected by changes to the update mode and
30401 the &%count=%& option.
30402
30403
30404 .section "Ratelimit options for what is being measured" "ratoptmea"
30405 .cindex "rate limiting" "per_* options"
30406 The &%per_conn%& option limits the client's connection rate. It is not
30407 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30408 &%acl_not_smtp_start%& ACLs.
30409
30410 The &%per_mail%& option limits the client's rate of sending messages. This is
30411 the default if none of the &%per_*%& options is specified. It can be used in
30412 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30413 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30414
30415 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30416 the same ACLs as the &%per_mail%& option, though it is best to use this option
30417 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30418 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30419 in its MAIL command, which may be inaccurate or completely missing. You can
30420 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30421 in kilobytes, megabytes, or gigabytes, respectively.
30422
30423 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30424 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30425 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30426 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30427 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30428 in either case the rate limiting engine will see a message with many
30429 recipients as a large high-speed burst.
30430
30431 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30432 number of different recipients that the client has sent messages to in the
30433 last time period. That is, if the client repeatedly sends messages to the same
30434 recipient, its measured rate is not increased. This option can only be used in
30435 &%acl_smtp_rcpt%&.
30436
30437 The &%per_cmd%& option causes Exim to recompute the rate every time the
30438 condition is processed. This can be used to limit the rate of any SMTP
30439 command. If it is used in multiple ACLs it can limit the aggregate rate of
30440 multiple different commands.
30441
30442 The &%count=%& option can be used to alter how much Exim adds to the client's
30443 measured rate. For example, the &%per_byte%& option is equivalent to
30444 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30445 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30446 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30447
30448 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30449
30450
30451 .section "Ratelimit update modes" "ratoptupd"
30452 .cindex "rate limiting" "reading data without updating"
30453 You can specify one of three options with the &%ratelimit%& condition to
30454 control when its database is updated. This section describes the &%readonly%&
30455 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30456
30457 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30458 previously-computed rate to check against the limit.
30459
30460 For example, you can test the client's sending rate and deny it access (when
30461 it is too fast) in the connect ACL. If the client passes this check then it
30462 can go on to send a message, in which case its recorded rate will be updated
30463 in the MAIL ACL. Subsequent connections from the same client will check this
30464 new rate.
30465 .code
30466 acl_check_connect:
30467  deny ratelimit = 100 / 5m / readonly
30468     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30469                   (max $sender_rate_limit)
30470 # ...
30471 acl_check_mail:
30472  warn ratelimit = 100 / 5m / strict
30473     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30474                   (max $sender_rate_limit)
30475 .endd
30476
30477 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30478 processing a message then it may increase the client's measured rate more than
30479 it should. For example, this will happen if you check the &%per_rcpt%& option
30480 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30481 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30482 multiple update problems by using the &%readonly%& option on later ratelimit
30483 checks.
30484
30485 The &%per_*%& options described above do not make sense in some ACLs. If you
30486 use a &%per_*%& option in an ACL where it is not normally permitted then the
30487 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30488 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30489 next section) so you must specify the &%readonly%& option explicitly.
30490
30491
30492 .section "Ratelimit options for handling fast clients" "ratoptfast"
30493 .cindex "rate limiting" "strict and leaky modes"
30494 If a client's average rate is greater than the maximum, the rate limiting
30495 engine can react in two possible ways, depending on the presence of the
30496 &%strict%& or &%leaky%& update modes. This is independent of the other
30497 counter-measures (such as rejecting the message) that may be specified by the
30498 rest of the ACL.
30499
30500 The &%leaky%& (default) option means that the client's recorded rate is not
30501 updated if it is above the limit. The effect of this is that Exim measures the
30502 client's average rate of successfully sent email, which cannot be greater than
30503 the maximum allowed. If the client is over the limit it may suffer some
30504 counter-measures (as specified in the ACL), but it will still be able to send
30505 email at the configured maximum rate, whatever the rate of its attempts. This
30506 is generally the better choice if you have clients that retry automatically.
30507 For example, it does not prevent a sender with an over-aggressive retry rate
30508 from getting any email through.
30509
30510 The &%strict%& option means that the client's recorded rate is always
30511 updated. The effect of this is that Exim measures the client's average rate
30512 of attempts to send email, which can be much higher than the maximum it is
30513 actually allowed. If the client is over the limit it may be subjected to
30514 counter-measures by the ACL. It must slow down and allow sufficient time to
30515 pass that its computed rate falls below the maximum before it can send email
30516 again. The time (the number of smoothing periods) it must wait and not
30517 attempt to send mail can be calculated with this formula:
30518 .code
30519         ln(peakrate/maxrate)
30520 .endd
30521
30522
30523 .section "Limiting the rate of different events" "ratoptuniq"
30524 .cindex "rate limiting" "counting unique events"
30525 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30526 rate of different events. For example, the &%per_addr%& option uses this
30527 mechanism to count the number of different recipients that the client has
30528 sent messages to in the last time period; it is equivalent to
30529 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30530 measure the rate that a client uses different sender addresses with the
30531 options &`per_mail/unique=$sender_address`&.
30532
30533 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30534 has seen for that key. The whole set is thrown away when it is older than the
30535 rate smoothing period &'p'&, so each different event is counted at most once
30536 per period. In the &%leaky%& update mode, an event that causes the client to
30537 go over the limit is not added to the set, in the same way that the client's
30538 recorded rate is not updated in the same situation.
30539
30540 When you combine the &%unique=%& and &%readonly%& options, the specific
30541 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30542 rate.
30543
30544 The &%unique=%& mechanism needs more space in the ratelimit database than the
30545 other &%ratelimit%& options in order to store the event set. The number of
30546 unique values is potentially as large as the rate limit, so the extra space
30547 required increases with larger limits.
30548
30549 The uniqueification is not perfect: there is a small probability that Exim
30550 will think a new event has happened before. If the sender's rate is less than
30551 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30552 the measured rate can go above the limit, in which case Exim may under-count
30553 events by a significant margin. Fortunately, if the rate is high enough (2.7
30554 times the limit) that the false positive rate goes above 9%, then Exim will
30555 throw away the over-full event set before the measured rate falls below the
30556 limit. Therefore the only harm should be that exceptionally high sending rates
30557 are logged incorrectly; any countermeasures you configure will be as effective
30558 as intended.
30559
30560
30561 .section "Using rate limiting" "useratlim"
30562 Exim's other ACL facilities are used to define what counter-measures are taken
30563 when the rate limit is exceeded. This might be anything from logging a warning
30564 (for example, while measuring existing sending rates in order to define
30565 policy), through time delays to slow down fast senders, up to rejecting the
30566 message. For example:
30567 .code
30568 # Log all senders' rates
30569 warn ratelimit = 0 / 1h / strict
30570      log_message = Sender rate $sender_rate / $sender_rate_period
30571
30572 # Slow down fast senders; note the need to truncate $sender_rate
30573 # at the decimal point.
30574 warn ratelimit = 100 / 1h / per_rcpt / strict
30575      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30576                    $sender_rate_limit }s
30577
30578 # Keep authenticated users under control
30579 deny authenticated = *
30580      ratelimit = 100 / 1d / strict / $authenticated_id
30581
30582 # System-wide rate limit
30583 defer message = Sorry, too busy. Try again later.
30584      ratelimit = 10 / 1s / $primary_hostname
30585
30586 # Restrict incoming rate from each host, with a default
30587 # set using a macro and special cases looked up in a table.
30588 defer message = Sender rate exceeds $sender_rate_limit \
30589                messages per $sender_rate_period
30590      ratelimit = ${lookup {$sender_host_address} \
30591                    cdb {DB/ratelimits.cdb} \
30592                    {$value} {RATELIMIT} }
30593 .endd
30594 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30595 especially with the &%per_rcpt%& option, you may suffer from a performance
30596 bottleneck caused by locking on the ratelimit hints database. Apart from
30597 making your ACLs less complicated, you can reduce the problem by using a
30598 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30599 this means that Exim will lose its hints data after a reboot (including retry
30600 hints, the callout cache, and ratelimit data).
30601
30602
30603
30604 .section "Address verification" "SECTaddressverification"
30605 .cindex "verifying address" "options for"
30606 .cindex "policy control" "address verification"
30607 Several of the &%verify%& conditions described in section
30608 &<<SECTaclconditions>>& cause addresses to be verified. Section
30609 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30610 The verification conditions can be followed by options that modify the
30611 verification process. The options are separated from the keyword and from each
30612 other by slashes, and some of them contain parameters. For example:
30613 .code
30614 verify = sender/callout
30615 verify = recipient/defer_ok/callout=10s,defer_ok
30616 .endd
30617 The first stage of address verification, which always happens, is to run the
30618 address through the routers, in &"verify mode"&. Routers can detect the
30619 difference between verification and routing for delivery, and their actions can
30620 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30621 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30622 The available options are as follows:
30623
30624 .ilist
30625 If the &%callout%& option is specified, successful routing to one or more
30626 remote hosts is followed by a &"callout"& to those hosts as an additional
30627 check. Callouts and their sub-options are discussed in the next section.
30628 .next
30629 If there is a defer error while doing verification routing, the ACL
30630 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30631 options, the condition is forced to be true instead. Note that this is a main
30632 verification option as well as a suboption for callouts.
30633 .next
30634 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30635 discusses the reporting of sender address verification failures.
30636 .next
30637 The &%success_on_redirect%& option causes verification always to succeed
30638 immediately after a successful redirection. By default, if a redirection
30639 generates just one address, that address is also verified. See further
30640 discussion in section &<<SECTredirwhilveri>>&.
30641 .endlist
30642
30643 .cindex "verifying address" "differentiating failures"
30644 .vindex "&$recipient_verify_failure$&"
30645 .vindex "&$sender_verify_failure$&"
30646 .vindex "&$acl_verify_message$&"
30647 After an address verification failure, &$acl_verify_message$& contains the
30648 error message that is associated with the failure. It can be preserved by
30649 coding like this:
30650 .code
30651 warn  !verify = sender
30652        set acl_m0 = $acl_verify_message
30653 .endd
30654 If you are writing your own custom rejection message or log message when
30655 denying access, you can use this variable to include information about the
30656 verification failure.
30657
30658 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30659 appropriate) contains one of the following words:
30660
30661 .ilist
30662 &%qualify%&: The address was unqualified (no domain), and the message
30663 was neither local nor came from an exempted host.
30664 .next
30665 &%route%&: Routing failed.
30666 .next
30667 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30668 occurred at or before the MAIL command (that is, on initial
30669 connection, HELO, or MAIL).
30670 .next
30671 &%recipient%&: The RCPT command in a callout was rejected.
30672 .next
30673 &%postmaster%&: The postmaster check in a callout was rejected.
30674 .endlist
30675
30676 The main use of these variables is expected to be to distinguish between
30677 rejections of MAIL and rejections of RCPT in callouts.
30678
30679
30680
30681
30682 .section "Callout verification" "SECTcallver"
30683 .cindex "verifying address" "by callout"
30684 .cindex "callout" "verification"
30685 .cindex "SMTP" "callout verification"
30686 For non-local addresses, routing verifies the domain, but is unable to do any
30687 checking of the local part. There are situations where some means of verifying
30688 the local part is desirable. One way this can be done is to make an SMTP
30689 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30690 a subsequent host for a recipient address, to see if the host accepts the
30691 address. We use the term &'callout'& to cover both cases. Note that for a
30692 sender address, the callback is not to the client host that is trying to
30693 deliver the message, but to one of the hosts that accepts incoming mail for the
30694 sender's domain.
30695
30696 Exim does not do callouts by default. If you want them to happen, you must
30697 request them by setting appropriate options on the &%verify%& condition, as
30698 described below. This facility should be used with care, because it can add a
30699 lot of resource usage to the cost of verifying an address. However, Exim does
30700 cache the results of callouts, which helps to reduce the cost. Details of
30701 caching are in section &<<SECTcallvercache>>&.
30702
30703 Recipient callouts are usually used only between hosts that are controlled by
30704 the same administration. For example, a corporate gateway host could use
30705 callouts to check for valid recipients on an internal mailserver. A successful
30706 callout does not guarantee that a real delivery to the address would succeed;
30707 on the other hand, a failing callout does guarantee that a delivery would fail.
30708
30709 If the &%callout%& option is present on a condition that verifies an address, a
30710 second stage of verification occurs if the address is successfully routed to
30711 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30712 &(manualroute)& router, where the router specifies the hosts. However, if a
30713 router that does not set up hosts routes to an &(smtp)& transport with a
30714 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30715 &%hosts_override%& set, its hosts are always used, whether or not the router
30716 supplies a host list.
30717 Callouts are only supported on &(smtp)& transports.
30718
30719 The port that is used is taken from the transport, if it is specified and is a
30720 remote transport. (For routers that do verification only, no transport need be
30721 specified.) Otherwise, the default SMTP port is used. If a remote transport
30722 specifies an outgoing interface, this is used; otherwise the interface is not
30723 specified. Likewise, the text that is used for the HELO command is taken from
30724 the transport's &%helo_data%& option; if there is no transport, the value of
30725 &$smtp_active_hostname$& is used.
30726
30727 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30728 test whether a bounce message could be delivered to the sender address. The
30729 following SMTP commands are sent:
30730 .display
30731 &`HELO `&<&'local host name'&>
30732 &`MAIL FROM:<>`&
30733 &`RCPT TO:`&<&'the address to be tested'&>
30734 &`QUIT`&
30735 .endd
30736 LHLO is used instead of HELO if the transport's &%protocol%& option is
30737 set to &"lmtp"&.
30738
30739 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30740 settings.
30741
30742 A recipient callout check is similar. By default, it also uses an empty address
30743 for the sender. This default is chosen because most hosts do not make use of
30744 the sender address when verifying a recipient. Using the same address means
30745 that a single cache entry can be used for each recipient. Some sites, however,
30746 do make use of the sender address when verifying. These are catered for by the
30747 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30748
30749 If the response to the RCPT command is a 2&'xx'& code, the verification
30750 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30751 Exim tries the next host, if any. If there is a problem with all the remote
30752 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30753 &%callout%& option is given, in which case the condition is forced to succeed.
30754
30755 .cindex "SMTP" "output flushing, disabling for callout"
30756 A callout may take a little time. For this reason, Exim normally flushes SMTP
30757 output before performing a callout in an ACL, to avoid unexpected timeouts in
30758 clients when the SMTP PIPELINING extension is in use. The flushing can be
30759 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30760
30761
30762
30763
30764 .section "Additional parameters for callouts" "CALLaddparcall"
30765 .cindex "callout" "additional parameters for"
30766 The &%callout%& option can be followed by an equals sign and a number of
30767 optional parameters, separated by commas. For example:
30768 .code
30769 verify = recipient/callout=10s,defer_ok
30770 .endd
30771 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30772 separate verify options, is retained for backwards compatibility, but is now
30773 deprecated. The additional parameters for &%callout%& are as follows:
30774
30775
30776 .vlist
30777 .vitem <&'a&~time&~interval'&>
30778 .cindex "callout" "timeout, specifying"
30779 This specifies the timeout that applies for the callout attempt to each host.
30780 For example:
30781 .code
30782 verify = sender/callout=5s
30783 .endd
30784 The default is 30 seconds. The timeout is used for each response from the
30785 remote host. It is also used for the initial connection, unless overridden by
30786 the &%connect%& parameter.
30787
30788
30789 .vitem &*connect&~=&~*&<&'time&~interval'&>
30790 .cindex "callout" "connection timeout, specifying"
30791 This parameter makes it possible to set a different (usually smaller) timeout
30792 for making the SMTP connection. For example:
30793 .code
30794 verify = sender/callout=5s,connect=1s
30795 .endd
30796 If not specified, this timeout defaults to the general timeout value.
30797
30798 .vitem &*defer_ok*&
30799 .cindex "callout" "defer, action on"
30800 When this parameter is present, failure to contact any host, or any other kind
30801 of temporary error, is treated as success by the ACL. However, the cache is not
30802 updated in this circumstance.
30803
30804 .vitem &*fullpostmaster*&
30805 .cindex "callout" "full postmaster check"
30806 This operates like the &%postmaster%& option (see below), but if the check for
30807 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30808 accordance with the specification in RFC 2821. The RFC states that the
30809 unqualified address &'postmaster'& should be accepted.
30810
30811
30812 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30813 .cindex "callout" "sender when verifying header"
30814 When verifying addresses in header lines using the &%header_sender%&
30815 verification option, Exim behaves by default as if the addresses are envelope
30816 sender addresses from a message. Callout verification therefore tests to see
30817 whether a bounce message could be delivered, by using an empty address in the
30818 MAIL command. However, it is arguable that these addresses might never be used
30819 as envelope senders, and could therefore justifiably reject bounce messages
30820 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30821 address to use in the MAIL command. For example:
30822 .code
30823 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30824 .endd
30825 This parameter is available only for the &%header_sender%& verification option.
30826
30827
30828 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30829 .cindex "callout" "overall timeout, specifying"
30830 This parameter sets an overall timeout for performing a callout verification.
30831 For example:
30832 .code
30833 verify = sender/callout=5s,maxwait=30s
30834 .endd
30835 This timeout defaults to four times the callout timeout for individual SMTP
30836 commands. The overall timeout applies when there is more than one host that can
30837 be tried. The timeout is checked before trying the next host. This prevents
30838 very long delays if there are a large number of hosts and all are timing out
30839 (for example, when network connections are timing out).
30840
30841
30842 .vitem &*no_cache*&
30843 .cindex "callout" "cache, suppressing"
30844 .cindex "caching callout, suppressing"
30845 When this parameter is given, the callout cache is neither read nor updated.
30846
30847 .vitem &*postmaster*&
30848 .cindex "callout" "postmaster; checking"
30849 When this parameter is set, a successful callout check is followed by a similar
30850 check for the local part &'postmaster'& at the same domain. If this address is
30851 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30852 the postmaster check is recorded in a cache record; if it is a failure, this is
30853 used to fail subsequent callouts for the domain without a connection being
30854 made, until the cache record expires.
30855
30856 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30857 The postmaster check uses an empty sender in the MAIL command by default.
30858 You can use this parameter to do a postmaster check using a different address.
30859 For example:
30860 .code
30861 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30862 .endd
30863 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30864 one overrides. The &%postmaster%& parameter is equivalent to this example:
30865 .code
30866 require  verify = sender/callout=postmaster_mailfrom=
30867 .endd
30868 &*Warning*&: The caching arrangements for postmaster checking do not take
30869 account of the sender address. It is assumed that either the empty address or
30870 a fixed non-empty address will be used. All that Exim remembers is that the
30871 postmaster check for the domain succeeded or failed.
30872
30873
30874 .vitem &*random*&
30875 .cindex "callout" "&""random""& check"
30876 When this parameter is set, before doing the normal callout check, Exim does a
30877 check for a &"random"& local part at the same domain. The local part is not
30878 really random &-- it is defined by the expansion of the option
30879 &%callout_random_local_part%&, which defaults to
30880 .code
30881 $primary_hostname-$tod_epoch-testing
30882 .endd
30883 The idea here is to try to determine whether the remote host accepts all local
30884 parts without checking. If it does, there is no point in doing callouts for
30885 specific local parts. If the &"random"& check succeeds, the result is saved in
30886 a cache record, and used to force the current and subsequent callout checks to
30887 succeed without a connection being made, until the cache record expires.
30888
30889 .vitem &*use_postmaster*&
30890 .cindex "callout" "sender for recipient check"
30891 This parameter applies to recipient callouts only. For example:
30892 .code
30893 deny  !verify = recipient/callout=use_postmaster
30894 .endd
30895 .vindex "&$qualify_domain$&"
30896 It causes a non-empty postmaster address to be used in the MAIL command when
30897 performing the callout for the recipient, and also for a &"random"& check if
30898 that is configured. The local part of the address is &`postmaster`& and the
30899 domain is the contents of &$qualify_domain$&.
30900
30901 .vitem &*use_sender*&
30902 This option applies to recipient callouts only. For example:
30903 .code
30904 require  verify = recipient/callout=use_sender
30905 .endd
30906 It causes the message's actual sender address to be used in the MAIL
30907 command when performing the callout, instead of an empty address. There is no
30908 need to use this option unless you know that the called hosts make use of the
30909 sender when checking recipients. If used indiscriminately, it reduces the
30910 usefulness of callout caching.
30911
30912 .vitem &*hold*&
30913 This option applies to recipient callouts only. For example:
30914 .code
30915 require  verify = recipient/callout=use_sender,hold
30916 .endd
30917 It causes the connection to be helod open and used for any further recipients
30918 and for eventual delivery (should that be done quickly).
30919 Doing this saves on TCP and SMTP startup costs, and TLS costs also
30920 when that is used for the connections.
30921 The advantage is only gained if there are no callout cache hits
30922 (which could be enforced by the no_cache option),
30923 if the use_sender option is used,
30924 if neither the random nor the use_postmaster option is used,
30925 and if no other callouts intervene.
30926 .endlist
30927
30928 If you use any of the parameters that set a non-empty sender for the MAIL
30929 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30930 &%use_sender%&), you should think about possible loops. Recipient checking is
30931 usually done between two hosts that are under the same management, and the host
30932 that receives the callouts is not normally configured to do callouts itself.
30933 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30934 these circumstances.
30935
30936 However, if you use a non-empty sender address for a callout to an arbitrary
30937 host, there is the likelihood that the remote host will itself initiate a
30938 callout check back to your host. As it is checking what appears to be a message
30939 sender, it is likely to use an empty address in MAIL, thus avoiding a
30940 callout loop. However, to be on the safe side it would be best to set up your
30941 own ACLs so that they do not do sender verification checks when the recipient
30942 is the address you use for header sender or postmaster callout checking.
30943
30944 Another issue to think about when using non-empty senders for callouts is
30945 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30946 by the sender/recipient combination; thus, for any given recipient, many more
30947 actual callouts are performed than when an empty sender or postmaster is used.
30948
30949
30950
30951
30952 .section "Callout caching" "SECTcallvercache"
30953 .cindex "hints database" "callout cache"
30954 .cindex "callout" "cache, description of"
30955 .cindex "caching" "callout"
30956 Exim caches the results of callouts in order to reduce the amount of resources
30957 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30958 option. A hints database called &"callout"& is used for the cache. Two
30959 different record types are used: one records the result of a callout check for
30960 a specific address, and the other records information that applies to the
30961 entire domain (for example, that it accepts the local part &'postmaster'&).
30962
30963 When an original callout fails, a detailed SMTP error message is given about
30964 the failure. However, for subsequent failures use the cache data, this message
30965 is not available.
30966
30967 The expiry times for negative and positive address cache records are
30968 independent, and can be set by the global options &%callout_negative_expire%&
30969 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30970
30971 If a host gives a negative response to an SMTP connection, or rejects any
30972 commands up to and including
30973 .code
30974 MAIL FROM:<>
30975 .endd
30976 (but not including the MAIL command with a non-empty address),
30977 any callout attempt is bound to fail. Exim remembers such failures in a
30978 domain cache record, which it uses to fail callouts for the domain without
30979 making new connections, until the domain record times out. There are two
30980 separate expiry times for domain cache records:
30981 &%callout_domain_negative_expire%& (default 3h) and
30982 &%callout_domain_positive_expire%& (default 7d).
30983
30984 Domain records expire when the negative expiry time is reached if callouts
30985 cannot be made for the domain, or if the postmaster check failed.
30986 Otherwise, they expire when the positive expiry time is reached. This
30987 ensures that, for example, a host that stops accepting &"random"& local parts
30988 will eventually be noticed.
30989
30990 The callout caching mechanism is based on the domain of the address that is
30991 being tested. If the domain routes to several hosts, it is assumed that their
30992 behaviour will be the same.
30993
30994
30995
30996 .section "Sender address verification reporting" "SECTsenaddver"
30997 .cindex "verifying" "suppressing error details"
30998 See section &<<SECTaddressverification>>& for a general discussion of
30999 verification. When sender verification fails in an ACL, the details of the
31000 failure are given as additional output lines before the 550 response to the
31001 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
31002 you might see:
31003 .code
31004 MAIL FROM:<xyz@abc.example>
31005 250 OK
31006 RCPT TO:<pqr@def.example>
31007 550-Verification failed for <xyz@abc.example>
31008 550-Called:   192.168.34.43
31009 550-Sent:     RCPT TO:<xyz@abc.example>
31010 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
31011 550 Sender verification failed
31012 .endd
31013 If more than one RCPT command fails in the same way, the details are given
31014 only for the first of them. However, some administrators do not want to send
31015 out this much information. You can suppress the details by adding
31016 &`/no_details`& to the ACL statement that requests sender verification. For
31017 example:
31018 .code
31019 verify = sender/no_details
31020 .endd
31021
31022 .section "Redirection while verifying" "SECTredirwhilveri"
31023 .cindex "verifying" "redirection while"
31024 .cindex "address redirection" "while verifying"
31025 A dilemma arises when a local address is redirected by aliasing or forwarding
31026 during verification: should the generated addresses themselves be verified,
31027 or should the successful expansion of the original address be enough to verify
31028 it? By default, Exim takes the following pragmatic approach:
31029
31030 .ilist
31031 When an incoming address is redirected to just one child address, verification
31032 continues with the child address, and if that fails to verify, the original
31033 verification also fails.
31034 .next
31035 When an incoming address is redirected to more than one child address,
31036 verification does not continue. A success result is returned.
31037 .endlist
31038
31039 This seems the most reasonable behaviour for the common use of aliasing as a
31040 way of redirecting different local parts to the same mailbox. It means, for
31041 example, that a pair of alias entries of the form
31042 .code
31043 A.Wol:   aw123
31044 aw123:   :fail: Gone away, no forwarding address
31045 .endd
31046 work as expected, with both local parts causing verification failure. When a
31047 redirection generates more than one address, the behaviour is more like a
31048 mailing list, where the existence of the alias itself is sufficient for
31049 verification to succeed.
31050
31051 It is possible, however, to change the default behaviour so that all successful
31052 redirections count as successful verifications, however many new addresses are
31053 generated. This is specified by the &%success_on_redirect%& verification
31054 option. For example:
31055 .code
31056 require verify = recipient/success_on_redirect/callout=10s
31057 .endd
31058 In this example, verification succeeds if a router generates a new address, and
31059 the callout does not occur, because no address was routed to a remote host.
31060
31061 When verification is being tested via the &%-bv%& option, the treatment of
31062 redirections is as just described, unless the &%-v%& or any debugging option is
31063 also specified. In that case, full verification is done for every generated
31064 address and a report is output for each of them.
31065
31066
31067
31068 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
31069 .cindex "CSA" "verifying"
31070 Client SMTP Authorization is a system that allows a site to advertise
31071 which machines are and are not permitted to send email. This is done by placing
31072 special SRV records in the DNS; these are looked up using the client's HELO
31073 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
31074 Authorization checks in Exim are performed by the ACL condition:
31075 .code
31076 verify = csa
31077 .endd
31078 This fails if the client is not authorized. If there is a DNS problem, or if no
31079 valid CSA SRV record is found, or if the client is authorized, the condition
31080 succeeds. These three cases can be distinguished using the expansion variable
31081 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
31082 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
31083 be likely to cause problems for legitimate email.
31084
31085 The error messages produced by the CSA code include slightly more
31086 detail. If &$csa_status$& is &"defer"&, this may be because of problems
31087 looking up the CSA SRV record, or problems looking up the CSA target
31088 address record. There are four reasons for &$csa_status$& being &"fail"&:
31089
31090 .ilist
31091 The client's host name is explicitly not authorized.
31092 .next
31093 The client's IP address does not match any of the CSA target IP addresses.
31094 .next
31095 The client's host name is authorized but it has no valid target IP addresses
31096 (for example, the target's addresses are IPv6 and the client is using IPv4).
31097 .next
31098 The client's host name has no CSA SRV record but a parent domain has asserted
31099 that all subdomains must be explicitly authorized.
31100 .endlist
31101
31102 The &%csa%& verification condition can take an argument which is the domain to
31103 use for the DNS query. The default is:
31104 .code
31105 verify = csa/$sender_helo_name
31106 .endd
31107 This implementation includes an extension to CSA. If the query domain
31108 is an address literal such as [192.0.2.95], or if it is a bare IP
31109 address, Exim searches for CSA SRV records in the reverse DNS as if
31110 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
31111 meaningful to say:
31112 .code
31113 verify = csa/$sender_host_address
31114 .endd
31115 In fact, this is the check that Exim performs if the client does not say HELO.
31116 This extension can be turned off by setting the main configuration option
31117 &%dns_csa_use_reverse%& to be false.
31118
31119 If a CSA SRV record is not found for the domain itself, a search
31120 is performed through its parent domains for a record which might be
31121 making assertions about subdomains. The maximum depth of this search is limited
31122 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
31123 default. Exim does not look for CSA SRV records in a top level domain, so the
31124 default settings handle HELO domains as long as seven
31125 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
31126 of legitimate HELO domains.
31127
31128 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
31129 direct SRV lookups, this is not sufficient because of the extra parent domain
31130 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
31131 addresses into lookups in the reverse DNS space. The result of a successful
31132 lookup such as:
31133 .code
31134 ${lookup dnsdb {csa=$sender_helo_name}}
31135 .endd
31136 has two space-separated fields: an authorization code and a target host name.
31137 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
31138 authorization required but absent, or &"?"& for unknown.
31139
31140
31141
31142
31143 .section "Bounce address tag validation" "SECTverifyPRVS"
31144 .cindex "BATV, verifying"
31145 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
31146 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
31147 Genuine incoming bounce messages should therefore always be addressed to
31148 recipients that have a valid tag. This scheme is a way of detecting unwanted
31149 bounce messages caused by sender address forgeries (often called &"collateral
31150 spam"&), because the recipients of such messages do not include valid tags.
31151
31152 There are two expansion items to help with the implementation of the BATV
31153 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
31154 the original envelope sender address by using a simple key to add a hash of the
31155 address and some time-based randomizing information. The &%prvs%& expansion
31156 item creates a signed address, and the &%prvscheck%& expansion item checks one.
31157 The syntax of these expansion items is described in section
31158 &<<SECTexpansionitems>>&.
31159
31160 As an example, suppose the secret per-address keys are stored in an MySQL
31161 database. A query to look up the key for an address could be defined as a macro
31162 like this:
31163 .code
31164 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
31165                 WHERE sender='${quote_mysql:$prvscheck_address}'\
31166                 }{$value}}
31167 .endd
31168 Suppose also that the senders who make use of BATV are defined by an address
31169 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
31170 use this:
31171 .code
31172 # Bounces: drop unsigned addresses for BATV senders
31173 deny message = This address does not send an unsigned reverse path
31174      senders = :
31175      recipients = +batv_senders
31176
31177 # Bounces: In case of prvs-signed address, check signature.
31178 deny message = Invalid reverse path signature.
31179      senders = :
31180      condition  = ${prvscheck {$local_part@$domain}\
31181                   {PRVSCHECK_SQL}{1}}
31182      !condition = $prvscheck_result
31183 .endd
31184 The first statement rejects recipients for bounce messages that are addressed
31185 to plain BATV sender addresses, because it is known that BATV senders do not
31186 send out messages with plain sender addresses. The second statement rejects
31187 recipients that are prvs-signed, but with invalid signatures (either because
31188 the key is wrong, or the signature has timed out).
31189
31190 A non-prvs-signed address is not rejected by the second statement, because the
31191 &%prvscheck%& expansion yields an empty string if its first argument is not a
31192 prvs-signed address, thus causing the &%condition%& condition to be false. If
31193 the first argument is a syntactically valid prvs-signed address, the yield is
31194 the third string (in this case &"1"&), whether or not the cryptographic and
31195 timeout checks succeed. The &$prvscheck_result$& variable contains the result
31196 of the checks (empty for failure, &"1"& for success).
31197
31198 There is one more issue you must consider when implementing prvs-signing:
31199 you have to ensure that the routers accept prvs-signed addresses and
31200 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
31201 router to remove the signature with a configuration along these lines:
31202 .code
31203 batv_redirect:
31204   driver = redirect
31205   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
31206 .endd
31207 This works because, if the third argument of &%prvscheck%& is empty, the result
31208 of the expansion of a prvs-signed address is the decoded value of the original
31209 address. This router should probably be the first of your routers that handles
31210 local addresses.
31211
31212 To create BATV-signed addresses in the first place, a transport of this form
31213 can be used:
31214 .code
31215 external_smtp_batv:
31216   driver = smtp
31217   return_path = ${prvs {$return_path} \
31218                        {${lookup mysql{SELECT \
31219                        secret FROM batv_prvs WHERE \
31220                        sender='${quote_mysql:$sender_address}'} \
31221                        {$value}fail}}}
31222 .endd
31223 If no key can be found for the existing return path, no signing takes place.
31224
31225
31226
31227 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31228 .cindex "&ACL;" "relay control"
31229 .cindex "relaying" "control by ACL"
31230 .cindex "policy control" "relay control"
31231 An MTA is said to &'relay'& a message if it receives it from some host and
31232 delivers it directly to another host as a result of a remote address contained
31233 within it. Redirecting a local address via an alias or forward file and then
31234 passing the message on to another host is not relaying,
31235 .cindex "&""percent hack""&"
31236 but a redirection as a result of the &"percent hack"& is.
31237
31238 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31239 A host which is acting as a gateway or an MX backup is concerned with incoming
31240 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31241 a host which is acting as a smart host for a number of clients is concerned
31242 with outgoing relaying from those clients to the Internet at large. Often the
31243 same host is fulfilling both functions,
31244 . ///
31245 . as illustrated in the diagram below,
31246 . ///
31247 but in principle these two kinds of relaying are entirely independent. What is
31248 not wanted is the transmission of mail from arbitrary remote hosts through your
31249 system to arbitrary domains.
31250
31251
31252 You can implement relay control by means of suitable statements in the ACL that
31253 runs for each RCPT command. For convenience, it is often easiest to use
31254 Exim's named list facility to define the domains and hosts involved. For
31255 example, suppose you want to do the following:
31256
31257 .ilist
31258 Deliver a number of domains to mailboxes on the local host (or process them
31259 locally in some other way). Let's say these are &'my.dom1.example'& and
31260 &'my.dom2.example'&.
31261 .next
31262 Relay mail for a number of other domains for which you are the secondary MX.
31263 These might be &'friend1.example'& and &'friend2.example'&.
31264 .next
31265 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31266 Suppose your LAN is 192.168.45.0/24.
31267 .endlist
31268
31269
31270 In the main part of the configuration, you put the following definitions:
31271 .code
31272 domainlist local_domains    = my.dom1.example : my.dom2.example
31273 domainlist relay_to_domains = friend1.example : friend2.example
31274 hostlist   relay_from_hosts = 192.168.45.0/24
31275 .endd
31276 Now you can use these definitions in the ACL that is run for every RCPT
31277 command:
31278 .code
31279 acl_check_rcpt:
31280   accept domains = +local_domains : +relay_to_domains
31281   accept hosts   = +relay_from_hosts
31282 .endd
31283 The first statement accepts any RCPT command that contains an address in
31284 the local or relay domains. For any other domain, control passes to the second
31285 statement, which accepts the command only if it comes from one of the relay
31286 hosts. In practice, you will probably want to make your ACL more sophisticated
31287 than this, for example, by including sender and recipient verification. The
31288 default configuration includes a more comprehensive example, which is described
31289 in chapter &<<CHAPdefconfil>>&.
31290
31291
31292
31293 .section "Checking a relay configuration" "SECTcheralcon"
31294 .cindex "relaying" "checking control of"
31295 You can check the relay characteristics of your configuration in the same way
31296 that you can test any ACL behaviour for an incoming SMTP connection, by using
31297 the &%-bh%& option to run a fake SMTP session with which you interact.
31298 .ecindex IIDacl
31299
31300
31301
31302 . ////////////////////////////////////////////////////////////////////////////
31303 . ////////////////////////////////////////////////////////////////////////////
31304
31305 .chapter "Content scanning at ACL time" "CHAPexiscan"
31306 .scindex IIDcosca "content scanning" "at ACL time"
31307 The extension of Exim to include content scanning at ACL time, formerly known
31308 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31309 was integrated into the main source for Exim release 4.50, and Tom continues to
31310 maintain it. Most of the wording of this chapter is taken from Tom's
31311 specification.
31312
31313 It is also possible to scan the content of messages at other times. The
31314 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31315 scanning after all the ACLs have run. A transport filter can be used to scan
31316 messages at delivery time (see the &%transport_filter%& option, described in
31317 chapter &<<CHAPtransportgeneric>>&).
31318
31319 If you want to include the ACL-time content-scanning features when you compile
31320 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31321 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31322
31323 .ilist
31324 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31325 for all MIME parts for SMTP and non-SMTP messages, respectively.
31326 .next
31327 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31328 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31329 run at the end of message reception (the &%acl_smtp_data%& ACL).
31330 .next
31331 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31332 of messages, or parts of messages, for debugging purposes.
31333 .next
31334 Additional expansion variables that are set in the new ACL and by the new
31335 conditions.
31336 .next
31337 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31338 .endlist
31339
31340 Content-scanning is continually evolving, and new features are still being
31341 added. While such features are still unstable and liable to incompatible
31342 changes, they are made available in Exim by setting options whose names begin
31343 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31344 this manual. You can find out about them by reading the file called
31345 &_doc/experimental.txt_&.
31346
31347 All the content-scanning facilities work on a MBOX copy of the message that is
31348 temporarily created in a file called:
31349 .display
31350 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31351 .endd
31352 The &_.eml_& extension is a friendly hint to virus scanners that they can
31353 expect an MBOX-like structure inside that file. The file is created when the
31354 first content scanning facility is called. Subsequent calls to content
31355 scanning conditions open the same file again. The directory is recursively
31356 removed when the &%acl_smtp_data%& ACL has finished running, unless
31357 .code
31358 control = no_mbox_unspool
31359 .endd
31360 has been encountered. When the MIME ACL decodes files, they are put into the
31361 same directory by default.
31362
31363
31364
31365 .section "Scanning for viruses" "SECTscanvirus"
31366 .cindex "virus scanning"
31367 .cindex "content scanning" "for viruses"
31368 .cindex "content scanning" "the &%malware%& condition"
31369 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31370 It supports a &"generic"& interface to scanners called via the shell, and
31371 specialized interfaces for &"daemon"& type virus scanners, which are resident
31372 in memory and thus are much faster.
31373
31374 A timeout of 2 minutes is applied to a scanner call (by default);
31375 if it expires then a defer action is taken.
31376
31377 .oindex "&%av_scanner%&"
31378 You can set the &%av_scanner%& option in the main part of the configuration
31379 to specify which scanner to use, together with any additional options that
31380 are needed. The basic syntax is as follows:
31381 .display
31382 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31383 .endd
31384 If you do not set &%av_scanner%&, it defaults to
31385 .code
31386 av_scanner = sophie:/var/run/sophie
31387 .endd
31388 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31389 before use.
31390 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31391 The following scanner types are supported in this release:
31392
31393 .vlist
31394 .vitem &%avast%&
31395 .cindex "virus scanners" "avast"
31396 This is the scanner daemon of Avast. It has been tested with Avast Core
31397 Security (currently at version 1.1.7).
31398 You can get a trial version at &url(http://www.avast.com) or for Linux
31399 at &url(http://www.avast.com/linux-server-antivirus).
31400 This scanner type takes one option,
31401 which can be either a full path to a UNIX socket,
31402 or host and port specifiers separated by white space.
31403 The host may be a name or an IP address; the port is either a
31404 single number or a pair of numbers with a dash between.
31405 Any further options are given, on separate lines,
31406 to the daemon as options before the main scan command.
31407 For example:
31408 .code
31409 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31410 av_scanner = avast:192.168.2.22 5036
31411 .endd
31412 If you omit the argument, the default path
31413 &_/var/run/avast/scan.sock_&
31414 is used.
31415 If you use a remote host,
31416 you need to make Exim's spool directory available to it,
31417 as the scanner is passed a file path, not file contents.
31418 For information about available commands and their options you may use
31419 .code
31420 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31421     FLAGS
31422     SENSITIVITY
31423     PACK
31424 .endd
31425
31426
31427 .vitem &%aveserver%&
31428 .cindex "virus scanners" "Kaspersky"
31429 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31430 at &url(http://www.kaspersky.com). This scanner type takes one option,
31431 which is the path to the daemon's UNIX socket. The default is shown in this
31432 example:
31433 .code
31434 av_scanner = aveserver:/var/run/aveserver
31435 .endd
31436
31437
31438 .vitem &%clamd%&
31439 .cindex "virus scanners" "clamd"
31440 This daemon-type scanner is GPL and free. You can get it at
31441 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31442 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31443 in the MIME ACL. This is no longer believed to be necessary.
31444
31445 The options are a list of server specifiers, which may be
31446 a UNIX socket specification,
31447 a TCP socket specification,
31448 or a (global) option.
31449
31450 A socket specification consists of a space-separated list.
31451 For a Unix socket the first element is a full path for the socket,
31452 for a TCP socket the first element is the IP address
31453 and the second a port number,
31454 Any further elements are per-server (non-global) options.
31455 These per-server options are supported:
31456 .code
31457 retry=<timespec>        Retry on connect fail
31458 .endd
31459
31460 The &`retry`& option specifies a time after which a single retry for
31461 a failed connect is made.  The default is to not retry.
31462
31463 If a Unix socket file is specified, only one server is supported.
31464
31465 Examples:
31466 .code
31467 av_scanner = clamd:/opt/clamd/socket
31468 av_scanner = clamd:192.0.2.3 1234
31469 av_scanner = clamd:192.0.2.3 1234:local
31470 av_scanner = clamd:192.0.2.3 1234 retry=10s
31471 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31472 .endd
31473 If the value of av_scanner points to a UNIX socket file or contains the
31474 &`local`&
31475 option, then the ClamAV interface will pass a filename containing the data
31476 to be scanned, which will should normally result in less I/O happening and be
31477 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31478 Exim does not assume that there is a common filesystem with the remote host.
31479 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31480 you be running a version of ClamAV prior to 0.95.
31481
31482 The final example shows that multiple TCP targets can be specified.  Exim will
31483 randomly use one for each incoming email (i.e. it load balances them).  Note
31484 that only TCP targets may be used if specifying a list of scanners; a UNIX
31485 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31486 unavailable, Exim will try the remaining one(s) until it finds one that works.
31487 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31488 not keep track of scanner state between multiple messages, and the scanner
31489 selection is random, so the message will get logged in the mainlog for each
31490 email that the down scanner gets chosen first (message wrapped to be readable):
31491 .code
31492 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31493    clamd: connection to localhost, port 3310 failed
31494    (Connection refused)
31495 .endd
31496
31497 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31498 contributing the code for this scanner.
31499
31500 .vitem &%cmdline%&
31501 .cindex "virus scanners" "command line interface"
31502 This is the keyword for the generic command line scanner interface. It can be
31503 used to attach virus scanners that are invoked from the shell. This scanner
31504 type takes 3 mandatory options:
31505
31506 .olist
31507 The full path and name of the scanner binary, with all command line options,
31508 and a placeholder (&`%s`&) for the directory to scan.
31509
31510 .next
31511 A regular expression to match against the STDOUT and STDERR output of the
31512 virus scanner. If the expression matches, a virus was found. You must make
31513 absolutely sure that this expression matches on &"virus found"&. This is called
31514 the &"trigger"& expression.
31515
31516 .next
31517 Another regular expression, containing exactly one pair of parentheses, to
31518 match the name of the virus found in the scanners output. This is called the
31519 &"name"& expression.
31520 .endlist olist
31521
31522 For example, Sophos Sweep reports a virus on a line like this:
31523 .code
31524 Virus 'W32/Magistr-B' found in file ./those.bat
31525 .endd
31526 For the trigger expression, we can match the phrase &"found in file"&. For the
31527 name expression, we want to extract the W32/Magistr-B string, so we can match
31528 for the single quotes left and right of it. Altogether, this makes the
31529 configuration setting:
31530 .code
31531 av_scanner = cmdline:\
31532              /path/to/sweep -ss -all -rec -archive %s:\
31533              found in file:'(.+)'
31534 .endd
31535 .vitem &%drweb%&
31536 .cindex "virus scanners" "DrWeb"
31537 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31538 takes one option,
31539 either a full path to a UNIX socket,
31540 or host and port specifiers separated by white space.
31541 The host may be a name or an IP address; the port is either a
31542 single number or a pair of numbers with a dash between.
31543 For example:
31544 .code
31545 av_scanner = drweb:/var/run/drwebd.sock
31546 av_scanner = drweb:192.168.2.20 31337
31547 .endd
31548 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31549 is used. Thanks to Alex Miller for contributing the code for this scanner.
31550
31551 .vitem &%f-protd%&
31552 .cindex "virus scanners" "f-protd"
31553 The f-protd scanner is accessed via HTTP over TCP.
31554 One argument is taken, being a space-separated hostname and port number
31555 (or port-range).
31556 For example:
31557 .code
31558 av_scanner = f-protd:localhost 10200-10204
31559 .endd
31560 If you omit the argument, the default values show above are used.
31561
31562 .new
31563 .vitem &%f-prot6d%&
31564 .cindex "virus scanners" "f-prot6d"
31565 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
31566 One argument is taken, being a space-separated hostname and port number.
31567 For example:
31568 .code
31569 av_scanner = f-prot6d:localhost 10200
31570 .endd
31571 If you omit the argument, the default values show above are used.
31572 .wen
31573
31574 .vitem &%fsecure%&
31575 .cindex "virus scanners" "F-Secure"
31576 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31577 argument which is the path to a UNIX socket. For example:
31578 .code
31579 av_scanner = fsecure:/path/to/.fsav
31580 .endd
31581 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31582 Thelmen for contributing the code for this scanner.
31583
31584 .vitem &%kavdaemon%&
31585 .cindex "virus scanners" "Kaspersky"
31586 This is the scanner daemon of Kaspersky Version 4. This version of the
31587 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31588 scanner type takes one option, which is the path to the daemon's UNIX socket.
31589 For example:
31590 .code
31591 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31592 .endd
31593 The default path is &_/var/run/AvpCtl_&.
31594
31595 .vitem &%mksd%&
31596 .cindex "virus scanners" "mksd"
31597 This is a daemon type scanner that is aimed mainly at Polish users, though some
31598 parts of documentation are now available in English. You can get it at
31599 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31600 the maximum number of processes used simultaneously to scan the attachments,
31601 provided that mksd has
31602 been run with at least the same number of child processes. For example:
31603 .code
31604 av_scanner = mksd:2
31605 .endd
31606 You can safely omit this option (the default value is 1).
31607
31608 .vitem &%sock%&
31609 .cindex "virus scanners" "simple socket-connected"
31610 This is a general-purpose way of talking to simple scanner daemons
31611 running on the local machine.
31612 There are four options:
31613 an address (which may be an IP address and port, or the path of a Unix socket),
31614 a commandline to send (may include a single %s which will be replaced with
31615 the path to the mail file to be scanned),
31616 an RE to trigger on from the returned data,
31617 an RE to extract malware_name from the returned data.
31618 For example:
31619 .code
31620 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31621 .endd
31622 Default for the socket specifier is &_/tmp/malware.sock_&.
31623 Default for the commandline is &_%s\n_&.
31624 Both regular-expressions are required.
31625
31626 .vitem &%sophie%&
31627 .cindex "virus scanners" "Sophos and Sophie"
31628 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31629 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31630 for this scanner type is the path to the UNIX socket that Sophie uses for
31631 client communication. For example:
31632 .code
31633 av_scanner = sophie:/tmp/sophie
31634 .endd
31635 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31636 the option.
31637 .endlist
31638
31639 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31640 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31641 ACL.
31642
31643 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31644 makes it possible to use different scanners. See further below for an example.
31645 The &%malware%& condition caches its results, so when you use it multiple times
31646 for the same message, the actual scanning process is only carried out once.
31647 However, using expandable items in &%av_scanner%& disables this caching, in
31648 which case each use of the &%malware%& condition causes a new scan of the
31649 message.
31650
31651 The &%malware%& condition takes a right-hand argument that is expanded before
31652 use and taken as a list, slash-separated by default.
31653 The first element can then be one of
31654
31655 .ilist
31656 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31657 The condition succeeds if a virus was found, and fail otherwise. This is the
31658 recommended usage.
31659 .next
31660 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31661 the condition fails immediately.
31662 .next
31663 A regular expression, in which case the message is scanned for viruses. The
31664 condition succeeds if a virus is found and its name matches the regular
31665 expression. This allows you to take special actions on certain types of virus.
31666 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31667 unless the separator is changed (in the usual way).
31668 .endlist
31669
31670 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31671 messages even if there is a problem with the virus scanner.
31672 Otherwise, such a problem causes the ACL to defer.
31673
31674 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31675 specify a non-default timeout.  The default is two minutes.
31676 For example:
31677 .code
31678 malware = * / defer_ok / tmo=10s
31679 .endd
31680 A timeout causes the ACL to defer.
31681
31682 .vindex "&$callout_address$&"
31683 When a connection is made to the scanner the expansion variable &$callout_address$&
31684 is set to record the actual address used.
31685
31686 .vindex "&$malware_name$&"
31687 When a virus is found, the condition sets up an expansion variable called
31688 &$malware_name$& that contains the name of the virus. You can use it in a
31689 &%message%& modifier that specifies the error returned to the sender, and/or in
31690 logging data.
31691
31692 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31693 imposed by your anti-virus scanner.
31694
31695 Here is a very simple scanning example:
31696 .code
31697 deny message = This message contains malware ($malware_name)
31698      malware = *
31699 .endd
31700 The next example accepts messages when there is a problem with the scanner:
31701 .code
31702 deny message = This message contains malware ($malware_name)
31703      malware = */defer_ok
31704 .endd
31705 The next example shows how to use an ACL variable to scan with both sophie and
31706 aveserver. It assumes you have set:
31707 .code
31708 av_scanner = $acl_m0
31709 .endd
31710 in the main Exim configuration.
31711 .code
31712 deny message = This message contains malware ($malware_name)
31713      set acl_m0 = sophie
31714      malware = *
31715
31716 deny message = This message contains malware ($malware_name)
31717      set acl_m0 = aveserver
31718      malware = *
31719 .endd
31720
31721
31722 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31723 .cindex "content scanning" "for spam"
31724 .cindex "spam scanning"
31725 .cindex "SpamAssassin"
31726 .cindex "Rspamd"
31727 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31728 score and a report for the message.
31729 Support is also provided for Rspamd.
31730
31731 For more information about installation and configuration of SpamAssassin or
31732 Rspamd refer to their respective websites at
31733 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31734
31735 SpamAssassin can be installed with CPAN by running:
31736 .code
31737 perl -MCPAN -e 'install Mail::SpamAssassin'
31738 .endd
31739 SpamAssassin has its own set of configuration files. Please review its
31740 documentation to see how you can tweak it. The default installation should work
31741 nicely, however.
31742
31743 .oindex "&%spamd_address%&"
31744 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31745 intend to use an instance running on the local host you do not need to set
31746 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31747 you must set the &%spamd_address%& option in the global part of the Exim
31748 configuration as follows (example):
31749 .code
31750 spamd_address = 192.168.99.45 387
31751 .endd
31752 The SpamAssassin protocol relies on a TCP half-close from the client.
31753 If your SpamAssassin client side is running a Linux system with an
31754 iptables firewall, consider setting
31755 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
31756 timeout, Exim uses when waiting for a response from the SpamAssassin
31757 server (currently defaulting to 120s).  With a lower value the Linux
31758 connection tracking may consider your half-closed connection as dead too
31759 soon.
31760
31761
31762 To use Rspamd (which by default listens on all local addresses
31763 on TCP port 11333)
31764 you should add &%variant=rspamd%& after the address/port pair, for example:
31765 .code
31766 spamd_address = 127.0.0.1 11333 variant=rspamd
31767 .endd
31768
31769 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31770 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31771 file name instead of an address/port pair:
31772 .code
31773 spamd_address = /var/run/spamd_socket
31774 .endd
31775 You can have multiple &%spamd%& servers to improve scalability. These can
31776 reside on other hardware reachable over the network. To specify multiple
31777 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31778 option, separated with colons (the separator can be changed in the usual way):
31779 .code
31780 spamd_address = 192.168.2.10 783 : \
31781                 192.168.2.11 783 : \
31782                 192.168.2.12 783
31783 .endd
31784 Up to 32 &%spamd%& servers are supported.
31785 When a server fails to respond to the connection attempt, all other
31786 servers are tried until one succeeds. If no server responds, the &%spam%&
31787 condition defers.
31788
31789 Unix and TCP socket specifications may be mixed in any order.
31790 Each element of the list is a list itself, space-separated by default
31791 and changeable in the usual way; take care to not double the separator.
31792
31793 For TCP socket specifications a host name or IP (v4 or v6, but
31794 subject to list-separator quoting rules) address can be used,
31795 and the port can be one or a dash-separated pair.
31796 In the latter case, the range is tried in strict order.
31797
31798 Elements after the first for Unix sockets, or second for TCP socket,
31799 are options.
31800 The supported options are:
31801 .code
31802 pri=<priority>      Selection priority
31803 weight=<value>      Selection bias
31804 time=<start>-<end>  Use only between these times of day
31805 retry=<timespec>    Retry on connect fail
31806 tmo=<timespec>      Connection time limit
31807 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31808 .endd
31809
31810 The &`pri`& option specifies a priority for the server within the list,
31811 higher values being tried first.
31812 The default priority is 1.
31813
31814 The &`weight`& option specifies a selection bias.
31815 Within a priority set
31816 servers are queried in a random fashion, weighted by this value.
31817 The default value for selection bias is 1.
31818
31819 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31820 in the local time zone; each element being one or more digits.
31821 Either the seconds or both minutes and seconds, plus the leading &`.`&
31822 characters, may be omitted and will be taken as zero.
31823
31824 Timeout specifications for the &`retry`& and &`tmo`& options
31825 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31826
31827 The &`tmo`& option specifies an overall timeout for communication.
31828 The default value is two minutes.
31829
31830 The &`retry`& option specifies a time after which a single retry for
31831 a failed connect is made.
31832 The default is to not retry.
31833
31834 The &%spamd_address%& variable is expanded before use if it starts with
31835 a dollar sign. In this case, the expansion may return a string that is
31836 used as the list so that multiple spamd servers can be the result of an
31837 expansion.
31838
31839 .vindex "&$callout_address$&"
31840 When a connection is made to the server the expansion variable &$callout_address$&
31841 is set to record the actual address used.
31842
31843 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31844 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31845 .code
31846 deny message = This message was classified as SPAM
31847      spam = joe
31848 .endd
31849 The right-hand side of the &%spam%& condition specifies a name. This is
31850 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31851 to scan using a specific profile, but rather use the SpamAssassin system-wide
31852 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31853 Rspamd does not use this setting. However, you must put something on the
31854 right-hand side.
31855
31856 The name allows you to use per-domain or per-user antispam profiles in
31857 principle, but this is not straightforward in practice, because a message may
31858 have multiple recipients, not necessarily all in the same domain. Because the
31859 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31860 read the contents of the message, the variables &$local_part$& and &$domain$&
31861 are not set.
31862 Careful enforcement of single-recipient messages
31863 (e.g. by responding with defer in the recipient ACL for all recipients
31864 after the first),
31865 or the use of PRDR,
31866 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31867 are needed to use this feature.
31868
31869 The right-hand side of the &%spam%& condition is expanded before being used, so
31870 you can put lookups or conditions there. When the right-hand side evaluates to
31871 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31872
31873
31874 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31875 large ones may cause significant performance degradation. As most spam messages
31876 are quite small, it is recommended that you do not scan the big ones. For
31877 example:
31878 .code
31879 deny message = This message was classified as SPAM
31880      condition = ${if < {$message_size}{10K}}
31881      spam = nobody
31882 .endd
31883
31884 The &%spam%& condition returns true if the threshold specified in the user's
31885 SpamAssassin profile has been matched or exceeded. If you want to use the
31886 &%spam%& condition for its side effects (see the variables below), you can make
31887 it always return &"true"& by appending &`:true`& to the username.
31888
31889 .cindex "spam scanning" "returned variables"
31890 When the &%spam%& condition is run, it sets up a number of expansion
31891 variables.
31892 Except for &$spam_report$&,
31893 these variables are saved with the received message so are
31894 available for use at delivery time.
31895
31896 .vlist
31897 .vitem &$spam_score$&
31898 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31899 for inclusion in log or reject messages.
31900
31901 .vitem &$spam_score_int$&
31902 The spam score of the message, multiplied by ten, as an integer value. For
31903 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31904 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31905 The integer value is useful for numeric comparisons in conditions.
31906
31907 .vitem &$spam_bar$&
31908 A string consisting of a number of &"+"& or &"-"& characters, representing the
31909 integer part of the spam score value. A spam score of 4.4 would have a
31910 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31911 headers, since MUAs can match on such strings. The maximum length of the
31912 spam bar is 50 characters.
31913
31914 .vitem &$spam_report$&
31915 A multiline text table, containing the full SpamAssassin report for the
31916 message. Useful for inclusion in headers or reject messages.
31917 This variable is only usable in a DATA-time ACL.
31918 Beware that SpamAssassin may return non-ASCII characters, especially
31919 when running in country-specific locales, which are not legal
31920 unencoded in headers.
31921
31922 .vitem &$spam_action$&
31923 For SpamAssassin either 'reject' or 'no action' depending on the
31924 spam score versus threshold.
31925 For Rspamd, the recommended action.
31926
31927 .endlist
31928
31929 The &%spam%& condition caches its results unless expansion in
31930 spamd_address was used. If you call it again with the same user name, it
31931 does not scan again, but rather returns the same values as before.
31932
31933 The &%spam%& condition returns DEFER if there is any error while running
31934 the message through SpamAssassin or if the expansion of spamd_address
31935 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31936 statement block), append &`/defer_ok`& to the right-hand side of the
31937 spam condition, like this:
31938 .code
31939 deny message = This message was classified as SPAM
31940      spam    = joe/defer_ok
31941 .endd
31942 This causes messages to be accepted even if there is a problem with &%spamd%&.
31943
31944 Here is a longer, commented example of the use of the &%spam%&
31945 condition:
31946 .code
31947 # put headers in all messages (no matter if spam or not)
31948 warn  spam = nobody:true
31949       add_header = X-Spam-Score: $spam_score ($spam_bar)
31950       add_header = X-Spam-Report: $spam_report
31951
31952 # add second subject line with *SPAM* marker when message
31953 # is over threshold
31954 warn  spam = nobody
31955       add_header = Subject: *SPAM* $h_Subject:
31956
31957 # reject spam at high scores (> 12)
31958 deny  message = This message scored $spam_score spam points.
31959       spam = nobody:true
31960       condition = ${if >{$spam_score_int}{120}{1}{0}}
31961 .endd
31962
31963
31964
31965 .section "Scanning MIME parts" "SECTscanmimepart"
31966 .cindex "content scanning" "MIME parts"
31967 .cindex "MIME content scanning"
31968 .oindex "&%acl_smtp_mime%&"
31969 .oindex "&%acl_not_smtp_mime%&"
31970 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31971 each MIME part of an SMTP message, including multipart types, in the sequence
31972 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31973 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31974 options may both refer to the same ACL if you want the same processing in both
31975 cases.
31976
31977 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31978 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31979 the case of a non-SMTP message. However, a MIME ACL is called only if the
31980 message contains a &'Content-Type:'& header line. When a call to a MIME
31981 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31982 result code is sent to the client. In the case of an SMTP message, the
31983 &%acl_smtp_data%& ACL is not called when this happens.
31984
31985 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31986 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31987 condition to match against the raw MIME part. You can also use the
31988 &%mime_regex%& condition to match against the decoded MIME part (see section
31989 &<<SECTscanregex>>&).
31990
31991 At the start of a MIME ACL, a number of variables are set from the header
31992 information for the relevant MIME part. These are described below. The contents
31993 of the MIME part are not by default decoded into a disk file except for MIME
31994 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31995 part into a disk file, you can use the &%decode%& condition. The general
31996 syntax is:
31997 .display
31998 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31999 .endd
32000 The right hand side is expanded before use. After expansion,
32001 the value can be:
32002
32003 .olist
32004 &"0"& or &"false"&, in which case no decoding is done.
32005 .next
32006 The string &"default"&. In that case, the file is put in the temporary
32007 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
32008 a sequential file name consisting of the message id and a sequence number. The
32009 full path and name is available in &$mime_decoded_filename$& after decoding.
32010 .next
32011 A full path name starting with a slash. If the full name is an existing
32012 directory, it is used as a replacement for the default directory. The filename
32013 is then sequentially assigned. If the path does not exist, it is used as
32014 the full path and file name.
32015 .next
32016 If the string does not start with a slash, it is used as the
32017 filename, and the default path is then used.
32018 .endlist
32019 The &%decode%& condition normally succeeds. It is only false for syntax
32020 errors or unusual circumstances such as memory shortages. You can easily decode
32021 a file with its original, proposed filename using
32022 .code
32023 decode = $mime_filename
32024 .endd
32025 However, you should keep in mind that &$mime_filename$& might contain
32026 anything. If you place files outside of the default path, they are not
32027 automatically unlinked.
32028
32029 For RFC822 attachments (these are messages attached to messages, with a
32030 content-type of &"message/rfc822"&), the ACL is called again in the same manner
32031 as for the primary message, only that the &$mime_is_rfc822$& expansion
32032 variable is set (see below). Attached messages are always decoded to disk
32033 before being checked, and the files are unlinked once the check is done.
32034
32035 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
32036 used to match regular expressions against raw and decoded MIME parts,
32037 respectively. They are described in section &<<SECTscanregex>>&.
32038
32039 .cindex "MIME content scanning" "returned variables"
32040 The following list describes all expansion variables that are
32041 available in the MIME ACL:
32042
32043 .vlist
32044 .vitem &$mime_boundary$&
32045 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
32046 have a boundary string, which is stored in this variable. If the current part
32047 has no boundary parameter in the &'Content-Type:'& header, this variable
32048 contains the empty string.
32049
32050 .vitem &$mime_charset$&
32051 This variable contains the character set identifier, if one was found in the
32052 &'Content-Type:'& header. Examples for charset identifiers are:
32053 .code
32054 us-ascii
32055 gb2312 (Chinese)
32056 iso-8859-1
32057 .endd
32058 Please note that this value is not normalized, so you should do matches
32059 case-insensitively.
32060
32061 .vitem &$mime_content_description$&
32062 This variable contains the normalized content of the &'Content-Description:'&
32063 header. It can contain a human-readable description of the parts content. Some
32064 implementations repeat the filename for attachments here, but they are usually
32065 only used for display purposes.
32066
32067 .vitem &$mime_content_disposition$&
32068 This variable contains the normalized content of the &'Content-Disposition:'&
32069 header. You can expect strings like &"attachment"& or &"inline"& here.
32070
32071 .vitem &$mime_content_id$&
32072 This variable contains the normalized content of the &'Content-ID:'& header.
32073 This is a unique ID that can be used to reference a part from another part.
32074
32075 .vitem &$mime_content_size$&
32076 This variable is set only after the &%decode%& modifier (see above) has been
32077 successfully run. It contains the size of the decoded part in kilobytes. The
32078 size is always rounded up to full kilobytes, so only a completely empty part
32079 has a &$mime_content_size$& of zero.
32080
32081 .vitem &$mime_content_transfer_encoding$&
32082 This variable contains the normalized content of the
32083 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
32084 type. Typical values are &"base64"& and &"quoted-printable"&.
32085
32086 .vitem &$mime_content_type$&
32087 If the MIME part has a &'Content-Type:'& header, this variable contains its
32088 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
32089 are some examples of popular MIME types, as they may appear in this variable:
32090 .code
32091 text/plain
32092 text/html
32093 application/octet-stream
32094 image/jpeg
32095 audio/midi
32096 .endd
32097 If the MIME part has no &'Content-Type:'& header, this variable contains the
32098 empty string.
32099
32100 .vitem &$mime_decoded_filename$&
32101 This variable is set only after the &%decode%& modifier (see above) has been
32102 successfully run. It contains the full path and file name of the file
32103 containing the decoded data.
32104 .endlist
32105
32106 .cindex "RFC 2047"
32107 .vlist
32108 .vitem &$mime_filename$&
32109 This is perhaps the most important of the MIME variables. It contains a
32110 proposed filename for an attachment, if one was found in either the
32111 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
32112 RFC2047
32113 or RFC2231
32114 decoded, but no additional sanity checks are done.
32115  If no filename was
32116 found, this variable contains the empty string.
32117
32118 .vitem &$mime_is_coverletter$&
32119 This variable attempts to differentiate the &"cover letter"& of an e-mail from
32120 attached data. It can be used to clamp down on flashy or unnecessarily encoded
32121 content in the cover letter, while not restricting attachments at all.
32122
32123 The variable contains 1 (true) for a MIME part believed to be part of the
32124 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
32125 follows:
32126
32127 .olist
32128 The outermost MIME part of a message is always a cover letter.
32129
32130 .next
32131 If a multipart/alternative or multipart/related MIME part is a cover letter,
32132 so are all MIME subparts within that multipart.
32133
32134 .next
32135 If any other multipart is a cover letter, the first subpart is a cover letter,
32136 and the rest are attachments.
32137
32138 .next
32139 All parts contained within an attachment multipart are attachments.
32140 .endlist olist
32141
32142 As an example, the following will ban &"HTML mail"& (including that sent with
32143 alternative plain text), while allowing HTML files to be attached. HTML
32144 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
32145 .code
32146 deny message = HTML mail is not accepted here
32147 !condition = $mime_is_rfc822
32148 condition = $mime_is_coverletter
32149 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
32150 .endd
32151 .vitem &$mime_is_multipart$&
32152 This variable has the value 1 (true) when the current part has the main type
32153 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
32154 Since multipart entities only serve as containers for other parts, you may not
32155 want to carry out specific actions on them.
32156
32157 .vitem &$mime_is_rfc822$&
32158 This variable has the value 1 (true) if the current part is not a part of the
32159 checked message itself, but part of an attached message. Attached message
32160 decoding is fully recursive.
32161
32162 .vitem &$mime_part_count$&
32163 This variable is a counter that is raised for each processed MIME part. It
32164 starts at zero for the very first part (which is usually a multipart). The
32165 counter is per-message, so it is reset when processing RFC822 attachments (see
32166 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
32167 complete, so you can use it in the DATA ACL to determine the number of MIME
32168 parts of a message. For non-MIME messages, this variable contains the value -1.
32169 .endlist
32170
32171
32172
32173 .section "Scanning with regular expressions" "SECTscanregex"
32174 .cindex "content scanning" "with regular expressions"
32175 .cindex "regular expressions" "content scanning with"
32176 You can specify your own custom regular expression matches on the full body of
32177 the message, or on individual MIME parts.
32178
32179 The &%regex%& condition takes one or more regular expressions as arguments and
32180 matches them against the full message (when called in the DATA ACL) or a raw
32181 MIME part (when called in the MIME ACL). The &%regex%& condition matches
32182 linewise, with a maximum line length of 32K characters. That means you cannot
32183 have multiline matches with the &%regex%& condition.
32184
32185 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
32186 to 32K of decoded content (the whole content at once, not linewise). If the
32187 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
32188 is decoded automatically when &%mime_regex%& is executed (using default path
32189 and filename values). If the decoded data is larger than  32K, only the first
32190 32K characters are checked.
32191
32192 The regular expressions are passed as a colon-separated list. To include a
32193 literal colon, you must double it. Since the whole right-hand side string is
32194 expanded before being used, you must also escape dollar signs and backslashes
32195 with more backslashes, or use the &`\N`& facility to disable expansion.
32196 Here is a simple example that contains two regular expressions:
32197 .code
32198 deny message = contains blacklisted regex ($regex_match_string)
32199      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
32200 .endd
32201 The conditions returns true if any one of the regular expressions matches. The
32202 &$regex_match_string$& expansion variable is then set up and contains the
32203 matching regular expression.
32204 The expansion variables &$regex1$& &$regex2$& etc
32205 are set to any substrings captured by the regular expression.
32206
32207 &*Warning*&: With large messages, these conditions can be fairly
32208 CPU-intensive.
32209
32210 .ecindex IIDcosca
32211
32212
32213
32214
32215 . ////////////////////////////////////////////////////////////////////////////
32216 . ////////////////////////////////////////////////////////////////////////////
32217
32218 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32219          "Local scan function"
32220 .scindex IIDlosca "&[local_scan()]& function" "description of"
32221 .cindex "customizing" "input scan using C function"
32222 .cindex "policy control" "by local scan function"
32223 In these days of email worms, viruses, and ever-increasing spam, some sites
32224 want to apply a lot of checking to messages before accepting them.
32225
32226 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32227 passing messages to external virus and spam scanning software. You can also do
32228 a certain amount in Exim itself through string expansions and the &%condition%&
32229 condition in the ACL that runs after the SMTP DATA command or the ACL for
32230 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32231
32232 To allow for further customization to a site's own requirements, there is the
32233 possibility of linking Exim with a private message scanning function, written
32234 in C. If you want to run code that is written in something other than C, you
32235 can of course use a little C stub to call it.
32236
32237 The local scan function is run once for every incoming message, at the point
32238 when Exim is just about to accept the message.
32239 It can therefore be used to control non-SMTP messages from local processes as
32240 well as messages arriving via SMTP.
32241
32242 Exim applies a timeout to calls of the local scan function, and there is an
32243 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32244 Zero means &"no timeout"&.
32245 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32246 before calling the local scan function, so that the most common types of crash
32247 are caught. If the timeout is exceeded or one of those signals is caught, the
32248 incoming message is rejected with a temporary error if it is an SMTP message.
32249 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32250 code. The incident is logged on the main and reject logs.
32251
32252
32253
32254 .section "Building Exim to use a local scan function" "SECID207"
32255 .cindex "&[local_scan()]& function" "building Exim to use"
32256 To make use of the local scan function feature, you must tell Exim where your
32257 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32258 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32259 directory, so you might set
32260 .code
32261 LOCAL_SCAN_SOURCE=Local/local_scan.c
32262 .endd
32263 for example. The function must be called &[local_scan()]&. It is called by
32264 Exim after it has received a message, when the success return code is about to
32265 be sent. This is after all the ACLs have been run. The return code from your
32266 function controls whether the message is actually accepted or not. There is a
32267 commented template function (that just accepts the message) in the file
32268 _src/local_scan.c_.
32269
32270 If you want to make use of Exim's run time configuration file to set options
32271 for your &[local_scan()]& function, you must also set
32272 .code
32273 LOCAL_SCAN_HAS_OPTIONS=yes
32274 .endd
32275 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32276
32277
32278
32279
32280 .section "API for local_scan()" "SECTapiforloc"
32281 .cindex "&[local_scan()]& function" "API description"
32282 You must include this line near the start of your code:
32283 .code
32284 #include "local_scan.h"
32285 .endd
32286 This header file defines a number of variables and other values, and the
32287 prototype for the function itself. Exim is coded to use unsigned char values
32288 almost exclusively, and one of the things this header defines is a shorthand
32289 for &`unsigned char`& called &`uschar`&.
32290 It also contains the following macro definitions, to simplify casting character
32291 strings and pointers to character strings:
32292 .code
32293 #define CS   (char *)
32294 #define CCS  (const char *)
32295 #define CSS  (char **)
32296 #define US   (unsigned char *)
32297 #define CUS  (const unsigned char *)
32298 #define USS  (unsigned char **)
32299 .endd
32300 The function prototype for &[local_scan()]& is:
32301 .code
32302 extern int local_scan(int fd, uschar **return_text);
32303 .endd
32304 The arguments are as follows:
32305
32306 .ilist
32307 &%fd%& is a file descriptor for the file that contains the body of the message
32308 (the -D file). The file is open for reading and writing, but updating it is not
32309 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32310
32311 The descriptor is positioned at character 19 of the file, which is the first
32312 character of the body itself, because the first 19 characters are the message
32313 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32314 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32315 case this changes in some future version.
32316 .next
32317 &%return_text%& is an address which you can use to return a pointer to a text
32318 string at the end of the function. The value it points to on entry is NULL.
32319 .endlist
32320
32321 The function must return an &%int%& value which is one of the following macros:
32322
32323 .vlist
32324 .vitem &`LOCAL_SCAN_ACCEPT`&
32325 .vindex "&$local_scan_data$&"
32326 The message is accepted. If you pass back a string of text, it is saved with
32327 the message, and made available in the variable &$local_scan_data$&. No
32328 newlines are permitted (if there are any, they are turned into spaces) and the
32329 maximum length of text is 1000 characters.
32330
32331 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32332 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32333 queued without immediate delivery, and is frozen.
32334
32335 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32336 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32337 queued without immediate delivery.
32338
32339 .vitem &`LOCAL_SCAN_REJECT`&
32340 The message is rejected; the returned text is used as an error message which is
32341 passed back to the sender and which is also logged. Newlines are permitted &--
32342 they cause a multiline response for SMTP rejections, but are converted to
32343 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32344 used.
32345
32346 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32347 The message is temporarily rejected; the returned text is used as an error
32348 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32349 problem"& is used.
32350
32351 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32352 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32353 message is not written to the reject log. It has the effect of unsetting the
32354 &%rejected_header%& log selector for just this rejection. If
32355 &%rejected_header%& is already unset (see the discussion of the
32356 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32357 same as LOCAL_SCAN_REJECT.
32358
32359 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32360 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32361 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32362 .endlist
32363
32364 If the message is not being received by interactive SMTP, rejections are
32365 reported by writing to &%stderr%& or by sending an email, as configured by the
32366 &%-oe%& command line options.
32367
32368
32369
32370 .section "Configuration options for local_scan()" "SECTconoptloc"
32371 .cindex "&[local_scan()]& function" "configuration options"
32372 It is possible to have option settings in the main configuration file
32373 that set values in static variables in the &[local_scan()]& module. If you
32374 want to do this, you must have the line
32375 .code
32376 LOCAL_SCAN_HAS_OPTIONS=yes
32377 .endd
32378 in your &_Local/Makefile_& when you build Exim. (This line is in
32379 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32380 file, you must define static variables to hold the option values, and a table
32381 to define them.
32382
32383 The table must be a vector called &%local_scan_options%&, of type
32384 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32385 and a pointer to the variable that holds the value. The entries must appear in
32386 alphabetical order. Following &%local_scan_options%& you must also define a
32387 variable called &%local_scan_options_count%& that contains the number of
32388 entries in the table. Here is a short example, showing two kinds of option:
32389 .code
32390 static int my_integer_option = 42;
32391 static uschar *my_string_option = US"a default string";
32392
32393 optionlist local_scan_options[] = {
32394   { "my_integer", opt_int,       &my_integer_option },
32395   { "my_string",  opt_stringptr, &my_string_option }
32396 };
32397
32398 int local_scan_options_count =
32399   sizeof(local_scan_options)/sizeof(optionlist);
32400 .endd
32401 The values of the variables can now be changed from Exim's runtime
32402 configuration file by including a local scan section as in this example:
32403 .code
32404 begin local_scan
32405 my_integer = 99
32406 my_string = some string of text...
32407 .endd
32408 The available types of option data are as follows:
32409
32410 .vlist
32411 .vitem &*opt_bool*&
32412 This specifies a boolean (true/false) option. The address should point to a
32413 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32414 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32415 whether such a variable has been set at all, you can initialize it to
32416 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32417 values.)
32418
32419 .vitem &*opt_fixed*&
32420 This specifies a fixed point number, such as is used for load averages.
32421 The address should point to a variable of type &`int`&. The value is stored
32422 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32423
32424 .vitem &*opt_int*&
32425 This specifies an integer; the address should point to a variable of type
32426 &`int`&. The value may be specified in any of the integer formats accepted by
32427 Exim.
32428
32429 .vitem &*opt_mkint*&
32430 This is the same as &%opt_int%&, except that when such a value is output in a
32431 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32432 printed with the suffix K or M.
32433
32434 .vitem &*opt_octint*&
32435 This also specifies an integer, but the value is always interpreted as an
32436 octal integer, whether or not it starts with the digit zero, and it is
32437 always output in octal.
32438
32439 .vitem &*opt_stringptr*&
32440 This specifies a string value; the address must be a pointer to a
32441 variable that points to a string (for example, of type &`uschar *`&).
32442
32443 .vitem &*opt_time*&
32444 This specifies a time interval value. The address must point to a variable of
32445 type &`int`&. The value that is placed there is a number of seconds.
32446 .endlist
32447
32448 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32449 out the values of all the &[local_scan()]& options.
32450
32451
32452
32453 .section "Available Exim variables" "SECID208"
32454 .cindex "&[local_scan()]& function" "available Exim variables"
32455 The header &_local_scan.h_& gives you access to a number of C variables. These
32456 are the only ones that are guaranteed to be maintained from release to release.
32457 Note, however, that you can obtain the value of any Exim expansion variable,
32458 including &$recipients$&, by calling &'expand_string()'&. The exported
32459 C variables are as follows:
32460
32461 .vlist
32462 .vitem &*int&~body_linecount*&
32463 This variable contains the number of lines in the message's body.
32464
32465 .vitem &*int&~body_zerocount*&
32466 This variable contains the number of binary zero bytes in the message's body.
32467
32468 .vitem &*unsigned&~int&~debug_selector*&
32469 This variable is set to zero when no debugging is taking place. Otherwise, it
32470 is a bitmap of debugging selectors. Two bits are identified for use in
32471 &[local_scan()]&; they are defined as macros:
32472
32473 .ilist
32474 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32475 testing option that is not privileged &-- any caller may set it. All the
32476 other selector bits can be set only by admin users.
32477
32478 .next
32479 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32480 by the &`+local_scan`& debug selector. It is not included in the default set
32481 of debugging bits.
32482 .endlist ilist
32483
32484 Thus, to write to the debugging output only when &`+local_scan`& has been
32485 selected, you should use code like this:
32486 .code
32487 if ((debug_selector & D_local_scan) != 0)
32488   debug_printf("xxx", ...);
32489 .endd
32490 .vitem &*uschar&~*expand_string_message*&
32491 After a failing call to &'expand_string()'& (returned value NULL), the
32492 variable &%expand_string_message%& contains the error message, zero-terminated.
32493
32494 .vitem &*header_line&~*header_list*&
32495 A pointer to a chain of header lines. The &%header_line%& structure is
32496 discussed below.
32497
32498 .vitem &*header_line&~*header_last*&
32499 A pointer to the last of the header lines.
32500
32501 .vitem &*uschar&~*headers_charset*&
32502 The value of the &%headers_charset%& configuration option.
32503
32504 .vitem &*BOOL&~host_checking*&
32505 This variable is TRUE during a host checking session that is initiated by the
32506 &%-bh%& command line option.
32507
32508 .vitem &*uschar&~*interface_address*&
32509 The IP address of the interface that received the message, as a string. This
32510 is NULL for locally submitted messages.
32511
32512 .vitem &*int&~interface_port*&
32513 The port on which this message was received. When testing with the &%-bh%&
32514 command line option, the value of this variable is -1 unless a port has been
32515 specified via the &%-oMi%& option.
32516
32517 .vitem &*uschar&~*message_id*&
32518 This variable contains Exim's message id for the incoming message (the value of
32519 &$message_exim_id$&) as a zero-terminated string.
32520
32521 .vitem &*uschar&~*received_protocol*&
32522 The name of the protocol by which the message was received.
32523
32524 .vitem &*int&~recipients_count*&
32525 The number of accepted recipients.
32526
32527 .vitem &*recipient_item&~*recipients_list*&
32528 .cindex "recipient" "adding in local scan"
32529 .cindex "recipient" "removing in local scan"
32530 The list of accepted recipients, held in a vector of length
32531 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32532 can add additional recipients by calling &'receive_add_recipient()'& (see
32533 below). You can delete recipients by removing them from the vector and
32534 adjusting the value in &%recipients_count%&. In particular, by setting
32535 &%recipients_count%& to zero you remove all recipients. If you then return the
32536 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32537 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32538 and then call &'receive_add_recipient()'& as often as needed.
32539
32540 .vitem &*uschar&~*sender_address*&
32541 The envelope sender address. For bounce messages this is the empty string.
32542
32543 .vitem &*uschar&~*sender_host_address*&
32544 The IP address of the sending host, as a string. This is NULL for
32545 locally-submitted messages.
32546
32547 .vitem &*uschar&~*sender_host_authenticated*&
32548 The name of the authentication mechanism that was used, or NULL if the message
32549 was not received over an authenticated SMTP connection.
32550
32551 .vitem &*uschar&~*sender_host_name*&
32552 The name of the sending host, if known.
32553
32554 .vitem &*int&~sender_host_port*&
32555 The port on the sending host.
32556
32557 .vitem &*BOOL&~smtp_input*&
32558 This variable is TRUE for all SMTP input, including BSMTP.
32559
32560 .vitem &*BOOL&~smtp_batched_input*&
32561 This variable is TRUE for BSMTP input.
32562
32563 .vitem &*int&~store_pool*&
32564 The contents of this variable control which pool of memory is used for new
32565 requests. See section &<<SECTmemhanloc>>& for details.
32566 .endlist
32567
32568
32569 .section "Structure of header lines" "SECID209"
32570 The &%header_line%& structure contains the members listed below.
32571 You can add additional header lines by calling the &'header_add()'& function
32572 (see below). You can cause header lines to be ignored (deleted) by setting
32573 their type to *.
32574
32575
32576 .vlist
32577 .vitem &*struct&~header_line&~*next*&
32578 A pointer to the next header line, or NULL for the last line.
32579
32580 .vitem &*int&~type*&
32581 A code identifying certain headers that Exim recognizes. The codes are printing
32582 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32583 Notice in particular that any header line whose type is * is not transmitted
32584 with the message. This flagging is used for header lines that have been
32585 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32586 lines.) Effectively, * means &"deleted"&.
32587
32588 .vitem &*int&~slen*&
32589 The number of characters in the header line, including the terminating and any
32590 internal newlines.
32591
32592 .vitem &*uschar&~*text*&
32593 A pointer to the text of the header. It always ends with a newline, followed by
32594 a zero byte. Internal newlines are preserved.
32595 .endlist
32596
32597
32598
32599 .section "Structure of recipient items" "SECID210"
32600 The &%recipient_item%& structure contains these members:
32601
32602 .vlist
32603 .vitem &*uschar&~*address*&
32604 This is a pointer to the recipient address as it was received.
32605
32606 .vitem &*int&~pno*&
32607 This is used in later Exim processing when top level addresses are created by
32608 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32609 and must always contain -1 at this stage.
32610
32611 .vitem &*uschar&~*errors_to*&
32612 If this value is not NULL, bounce messages caused by failing to deliver to the
32613 recipient are sent to the address it contains. In other words, it overrides the
32614 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32615 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32616 an unqualified address, Exim qualifies it using the domain from
32617 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32618 is NULL for all recipients.
32619 .endlist
32620
32621
32622
32623 .section "Available Exim functions" "SECID211"
32624 .cindex "&[local_scan()]& function" "available Exim functions"
32625 The header &_local_scan.h_& gives you access to a number of Exim functions.
32626 These are the only ones that are guaranteed to be maintained from release to
32627 release:
32628
32629 .vlist
32630 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32631        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32632
32633 This function creates a child process that runs the command specified by
32634 &%argv%&. The environment for the process is specified by &%envp%&, which can
32635 be NULL if no environment variables are to be passed. A new umask is supplied
32636 for the process in &%newumask%&.
32637
32638 Pipes to the standard input and output of the new process are set up
32639 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32640 standard error is cloned to the standard output. If there are any file
32641 descriptors &"in the way"& in the new process, they are closed. If the final
32642 argument is TRUE, the new process is made into a process group leader.
32643
32644 The function returns the pid of the new process, or -1 if things go wrong.
32645
32646 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32647 This function waits for a child process to terminate, or for a timeout (in
32648 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32649 return value is as follows:
32650
32651 .ilist
32652 >= 0
32653
32654 The process terminated by a normal exit and the value is the process
32655 ending status.
32656
32657 .next
32658 < 0 and > &--256
32659
32660 The process was terminated by a signal and the value is the negation of the
32661 signal number.
32662
32663 .next
32664 &--256
32665
32666 The process timed out.
32667 .next
32668 &--257
32669
32670 The was some other error in wait(); &%errno%& is still set.
32671 .endlist
32672
32673 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32674 This function provide you with a means of submitting a new message to
32675 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32676 want, but this packages it all up for you.) The function creates a pipe,
32677 forks a subprocess that is running
32678 .code
32679 exim -t -oem -oi -f <>
32680 .endd
32681 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32682 that is connected to the standard input. The yield of the function is the PID
32683 of the subprocess. You can then write a message to the file descriptor, with
32684 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32685
32686 When you have finished, call &'child_close()'& to wait for the process to
32687 finish and to collect its ending status. A timeout value of zero is usually
32688 fine in this circumstance. Unless you have made a mistake with the recipient
32689 addresses, you should get a return code of zero.
32690
32691
32692 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32693        *sender_authentication)*&
32694 This function is a more sophisticated version of &'child_open()'&. The command
32695 that it runs is:
32696 .display
32697 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32698 .endd
32699 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32700
32701
32702 .vitem &*void&~debug_printf(char&~*,&~...)*&
32703 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32704 output is written to the standard error stream. If no debugging is selected,
32705 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32706 conditional on the &`local_scan`& debug selector by coding like this:
32707 .code
32708 if ((debug_selector & D_local_scan) != 0)
32709   debug_printf("xxx", ...);
32710 .endd
32711
32712 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32713 This is an interface to Exim's string expansion code. The return value is the
32714 expanded string, or NULL if there was an expansion failure.
32715 The C variable &%expand_string_message%& contains an error message after an
32716 expansion failure. If expansion does not change the string, the return value is
32717 the pointer to the input string. Otherwise, the return value points to a new
32718 block of memory that was obtained by a call to &'store_get()'&. See section
32719 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32720
32721 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32722 This function allows you to an add additional header line at the end of the
32723 existing ones. The first argument is the type, and should normally be a space
32724 character. The second argument is a format string and any number of
32725 substitution arguments as for &[sprintf()]&. You may include internal newlines
32726 if you want, and you must ensure that the string ends with a newline.
32727
32728 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32729         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32730 This function adds a new header line at a specified point in the header
32731 chain. The header itself is specified as for &'header_add()'&.
32732
32733 If &%name%& is NULL, the new header is added at the end of the chain if
32734 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32735 NULL, the header lines are searched for the first non-deleted header that
32736 matches the name. If one is found, the new header is added before it if
32737 &%after%& is false. If &%after%& is true, the new header is added after the
32738 found header and any adjacent subsequent ones with the same name (even if
32739 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32740 option controls where the header is added. If it is true, addition is at the
32741 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32742 headers, or at the top if there are no &'Received:'& headers, you could use
32743 .code
32744 header_add_at_position(TRUE, US"Received", TRUE,
32745   ' ', "X-xxx: ...");
32746 .endd
32747 Normally, there is always at least one non-deleted &'Received:'& header, but
32748 there may not be if &%received_header_text%& expands to an empty string.
32749
32750
32751 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32752 This function removes header lines. If &%occurrence%& is zero or negative, all
32753 occurrences of the header are removed. If occurrence is greater than zero, that
32754 particular instance of the header is removed. If no header(s) can be found that
32755 match the specification, the function does nothing.
32756
32757
32758 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32759         int&~length,&~BOOL&~notdel)*&"
32760 This function tests whether the given header has the given name. It is not just
32761 a string comparison, because white space is permitted between the name and the
32762 colon. If the &%notdel%& argument is true, a false return is forced for all
32763 &"deleted"& headers; otherwise they are not treated specially. For example:
32764 .code
32765 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32766 .endd
32767 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32768 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32769 This function base64-encodes a string, which is passed by address and length.
32770 The text may contain bytes of any value, including zero. The result is passed
32771 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32772 zero-terminated.
32773
32774 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32775 This function decodes a base64-encoded string. Its arguments are a
32776 zero-terminated base64-encoded string and the address of a variable that is set
32777 to point to the result, which is in dynamic memory. The length of the decoded
32778 string is the yield of the function. If the input is invalid base64 data, the
32779 yield is -1. A zero byte is added to the end of the output string to make it
32780 easy to interpret as a C string (assuming it contains no zeros of its own). The
32781 added zero byte is not included in the returned count.
32782
32783 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32784 This function checks for a match in a domain list. Domains are always
32785 matched caselessly. The return value is one of the following:
32786 .display
32787 &`OK     `& match succeeded
32788 &`FAIL   `& match failed
32789 &`DEFER  `& match deferred
32790 .endd
32791 DEFER is usually caused by some kind of lookup defer, such as the
32792 inability to contact a database.
32793
32794 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32795         BOOL&~caseless)*&"
32796 This function checks for a match in a local part list. The third argument
32797 controls case-sensitivity. The return values are as for
32798 &'lss_match_domain()'&.
32799
32800 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32801         BOOL&~caseless)*&"
32802 This function checks for a match in an address list. The third argument
32803 controls the case-sensitivity of the local part match. The domain is always
32804 matched caselessly. The return values are as for &'lss_match_domain()'&.
32805
32806 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32807         uschar&~*list)*&"
32808 This function checks for a match in a host list. The most common usage is
32809 expected to be
32810 .code
32811 lss_match_host(sender_host_name, sender_host_address, ...)
32812 .endd
32813 .vindex "&$sender_host_address$&"
32814 An empty address field matches an empty item in the host list. If the host name
32815 is NULL, the name corresponding to &$sender_host_address$& is automatically
32816 looked up if a host name is required to match an item in the list. The return
32817 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32818 returns ERROR in the case when it had to look up a host name, but the lookup
32819 failed.
32820
32821 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32822         *format,&~...)*&"
32823 This function writes to Exim's log files. The first argument should be zero (it
32824 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32825 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32826 them. It specifies to which log or logs the message is written. The remaining
32827 arguments are a format and relevant insertion arguments. The string should not
32828 contain any newlines, not even at the end.
32829
32830
32831 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32832 This function adds an additional recipient to the message. The first argument
32833 is the recipient address. If it is unqualified (has no domain), it is qualified
32834 with the &%qualify_recipient%& domain. The second argument must always be -1.
32835
32836 This function does not allow you to specify a private &%errors_to%& address (as
32837 described with the structure of &%recipient_item%& above), because it pre-dates
32838 the addition of that field to the structure. However, it is easy to add such a
32839 value afterwards. For example:
32840 .code
32841  receive_add_recipient(US"monitor@mydom.example", -1);
32842  recipients_list[recipients_count-1].errors_to =
32843    US"postmaster@mydom.example";
32844 .endd
32845
32846 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32847 This is a convenience function to remove a named recipient from the list of
32848 recipients. It returns true if a recipient was removed, and false if no
32849 matching recipient could be found. The argument must be a complete email
32850 address.
32851 .endlist
32852
32853
32854 .cindex "RFC 2047"
32855 .vlist
32856 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32857   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32858 This function decodes strings that are encoded according to RFC 2047. Typically
32859 these are the contents of header lines. First, each &"encoded word"& is decoded
32860 from the Q or B encoding into a byte-string. Then, if provided with the name of
32861 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32862 made  to translate the result to the named character set. If this fails, the
32863 binary string is returned with an error message.
32864
32865 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32866 maximum MIME word length is enforced. The third argument is the target
32867 encoding, or NULL if no translation is wanted.
32868
32869 .cindex "binary zero" "in RFC 2047 decoding"
32870 .cindex "RFC 2047" "binary zero in"
32871 If a binary zero is encountered in the decoded string, it is replaced by the
32872 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32873 not be 0 because header lines are handled as zero-terminated strings.
32874
32875 The function returns the result of processing the string, zero-terminated; if
32876 &%lenptr%& is not NULL, the length of the result is set in the variable to
32877 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32878
32879 If an error is encountered, the function returns NULL and uses the &%error%&
32880 argument to return an error message. The variable pointed to by &%error%& is
32881 set to NULL if there is no error; it may be set non-NULL even when the function
32882 returns a non-NULL value if decoding was successful, but there was a problem
32883 with translation.
32884
32885
32886 .vitem &*int&~smtp_fflush(void)*&
32887 This function is used in conjunction with &'smtp_printf()'&, as described
32888 below.
32889
32890 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32891 The arguments of this function are like &[printf()]&; it writes to the SMTP
32892 output stream. You should use this function only when there is an SMTP output
32893 stream, that is, when the incoming message is being received via interactive
32894 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32895 is FALSE. If you want to test for an incoming message from another host (as
32896 opposed to a local process that used the &%-bs%& command line option), you can
32897 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32898 is involved.
32899
32900 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32901 output function, so it can be used for all forms of SMTP connection.
32902
32903 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32904 must start with an appropriate response code: 550 if you are going to return
32905 LOCAL_SCAN_REJECT, 451 if you are going to return
32906 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32907 initial lines of a multi-line response, the code must be followed by a hyphen
32908 to indicate that the line is not the final response line. You must also ensure
32909 that the lines you write terminate with CRLF. For example:
32910 .code
32911 smtp_printf("550-this is some extra info\r\n");
32912 return LOCAL_SCAN_REJECT;
32913 .endd
32914 Note that you can also create multi-line responses by including newlines in
32915 the data returned via the &%return_text%& argument. The added value of using
32916 &'smtp_printf()'& is that, for instance, you could introduce delays between
32917 multiple output lines.
32918
32919 The &'smtp_printf()'& function does not return any error indication, because it
32920 does not automatically flush pending output, and therefore does not test
32921 the state of the stream. (In the main code of Exim, flushing and error
32922 detection is done when Exim is ready for the next SMTP input command.) If
32923 you want to flush the output and check for an error (for example, the
32924 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32925 arguments. It flushes the output stream, and returns a non-zero value if there
32926 is an error.
32927
32928 .vitem &*void&~*store_get(int)*&
32929 This function accesses Exim's internal store (memory) manager. It gets a new
32930 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32931 runs out of memory. See the next section for a discussion of memory handling.
32932
32933 .vitem &*void&~*store_get_perm(int)*&
32934 This function is like &'store_get()'&, but it always gets memory from the
32935 permanent pool. See the next section for a discussion of memory handling.
32936
32937 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32938 See below.
32939
32940 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32941 See below.
32942
32943 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32944 These three functions create strings using Exim's dynamic memory facilities.
32945 The first makes a copy of an entire string. The second copies up to a maximum
32946 number of characters, indicated by the second argument. The third uses a format
32947 and insertion arguments to create a new string. In each case, the result is a
32948 pointer to a new string in the current memory pool. See the next section for
32949 more discussion.
32950 .endlist
32951
32952
32953
32954 .section "More about Exim's memory handling" "SECTmemhanloc"
32955 .cindex "&[local_scan()]& function" "memory handling"
32956 No function is provided for freeing memory, because that is never needed.
32957 The dynamic memory that Exim uses when receiving a message is automatically
32958 recycled if another message is received by the same process (this applies only
32959 to incoming SMTP connections &-- other input methods can supply only one
32960 message at a time). After receiving the last message, a reception process
32961 terminates.
32962
32963 Because it is recycled, the normal dynamic memory cannot be used for holding
32964 data that must be preserved over a number of incoming messages on the same SMTP
32965 connection. However, Exim in fact uses two pools of dynamic memory; the second
32966 one is not recycled, and can be used for this purpose.
32967
32968 If you want to allocate memory that remains available for subsequent messages
32969 in the same SMTP connection, you should set
32970 .code
32971 store_pool = POOL_PERM
32972 .endd
32973 before calling the function that does the allocation. There is no need to
32974 restore the value if you do not need to; however, if you do want to revert to
32975 the normal pool, you can either restore the previous value of &%store_pool%& or
32976 set it explicitly to POOL_MAIN.
32977
32978 The pool setting applies to all functions that get dynamic memory, including
32979 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32980 There is also a convenience function called &'store_get_perm()'& that gets a
32981 block of memory from the permanent pool while preserving the value of
32982 &%store_pool%&.
32983 .ecindex IIDlosca
32984
32985
32986
32987
32988 . ////////////////////////////////////////////////////////////////////////////
32989 . ////////////////////////////////////////////////////////////////////////////
32990
32991 .chapter "System-wide message filtering" "CHAPsystemfilter"
32992 .scindex IIDsysfil1 "filter" "system filter"
32993 .scindex IIDsysfil2 "filtering all mail"
32994 .scindex IIDsysfil3 "system filter"
32995 The previous chapters (on ACLs and the local scan function) describe checks
32996 that can be applied to messages before they are accepted by a host. There is
32997 also a mechanism for checking messages once they have been received, but before
32998 they are delivered. This is called the &'system filter'&.
32999
33000 The system filter operates in a similar manner to users' filter files, but it
33001 is run just once per message (however many recipients the message has).
33002 It should not normally be used as a substitute for routing, because &%deliver%&
33003 commands in a system router provide new envelope recipient addresses.
33004 The system filter must be an Exim filter. It cannot be a Sieve filter.
33005
33006 The system filter is run at the start of a delivery attempt, before any routing
33007 is done. If a message fails to be completely delivered at the first attempt,
33008 the system filter is run again at the start of every retry.
33009 If you want your filter to do something only once per message, you can make use
33010 of the &%first_delivery%& condition in an &%if%& command in the filter to
33011 prevent it happening on retries.
33012
33013 .vindex "&$domain$&"
33014 .vindex "&$local_part$&"
33015 &*Warning*&: Because the system filter runs just once, variables that are
33016 specific to individual recipient addresses, such as &$local_part$& and
33017 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
33018 you want to run a centrally-specified filter for each recipient address
33019 independently, you can do so by setting up a suitable &(redirect)& router, as
33020 described in section &<<SECTperaddfil>>& below.
33021
33022
33023 .section "Specifying a system filter" "SECID212"
33024 .cindex "uid (user id)" "system filter"
33025 .cindex "gid (group id)" "system filter"
33026 The name of the file that contains the system filter must be specified by
33027 setting &%system_filter%&. If you want the filter to run under a uid and gid
33028 other than root, you must also set &%system_filter_user%& and
33029 &%system_filter_group%& as appropriate. For example:
33030 .code
33031 system_filter = /etc/mail/exim.filter
33032 system_filter_user = exim
33033 .endd
33034 If a system filter generates any deliveries directly to files or pipes (via the
33035 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
33036 specified by setting &%system_filter_file_transport%& and
33037 &%system_filter_pipe_transport%&, respectively. Similarly,
33038 &%system_filter_reply_transport%& must be set to handle any messages generated
33039 by the &%reply%& command.
33040
33041
33042 .section "Testing a system filter" "SECID213"
33043 You can run simple tests of a system filter in the same way as for a user
33044 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
33045 are permitted only in system filters are recognized.
33046
33047 If you want to test the combined effect of a system filter and a user filter,
33048 you can use both &%-bF%& and &%-bf%& on the same command line.
33049
33050
33051
33052 .section "Contents of a system filter" "SECID214"
33053 The language used to specify system filters is the same as for users' filter
33054 files. It is described in the separate end-user document &'Exim's interface to
33055 mail filtering'&. However, there are some additional features that are
33056 available only in system filters; these are described in subsequent sections.
33057 If they are encountered in a user's filter file or when testing with &%-bf%&,
33058 they cause errors.
33059
33060 .cindex "frozen messages" "manual thaw; testing in filter"
33061 There are two special conditions which, though available in users' filter
33062 files, are designed for use in system filters. The condition &%first_delivery%&
33063 is true only for the first attempt at delivering a message, and
33064 &%manually_thawed%& is true only if the message has been frozen, and
33065 subsequently thawed by an admin user. An explicit forced delivery counts as a
33066 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
33067
33068 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
33069 specify an &"unseen"& (non-significant) delivery, and that delivery does not
33070 succeed, it will not be tried again.
33071 If you want Exim to retry an unseen delivery until it succeeds, you should
33072 arrange to set it up every time the filter runs.
33073
33074 When a system filter finishes running, the values of the variables &$n0$& &--
33075 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
33076 users' filter files. Thus a system filter can, for example, set up &"scores"&
33077 to which users' filter files can refer.
33078
33079
33080
33081 .section "Additional variable for system filters" "SECID215"
33082 .vindex "&$recipients$&"
33083 The expansion variable &$recipients$&, containing a list of all the recipients
33084 of the message (separated by commas and white space), is available in system
33085 filters. It is not available in users' filters for privacy reasons.
33086
33087
33088
33089 .section "Defer, freeze, and fail commands for system filters" "SECID216"
33090 .cindex "freezing messages"
33091 .cindex "message" "freezing"
33092 .cindex "message" "forced failure"
33093 .cindex "&%fail%&" "in system filter"
33094 .cindex "&%freeze%& in system filter"
33095 .cindex "&%defer%& in system filter"
33096 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
33097 always available in system filters, but are not normally enabled in users'
33098 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
33099 for the &(redirect)& router.) These commands can optionally be followed by the
33100 word &%text%& and a string containing an error message, for example:
33101 .code
33102 fail text "this message looks like spam to me"
33103 .endd
33104 The keyword &%text%& is optional if the next character is a double quote.
33105
33106 The &%defer%& command defers delivery of the original recipients of the
33107 message. The &%fail%& command causes all the original recipients to be failed,
33108 and a bounce message to be created. The &%freeze%& command suspends all
33109 delivery attempts for the original recipients. In all cases, any new deliveries
33110 that are specified by the filter are attempted as normal after the filter has
33111 run.
33112
33113 The &%freeze%& command is ignored if the message has been manually unfrozen and
33114 not manually frozen since. This means that automatic freezing by a system
33115 filter can be used as a way of checking out suspicious messages. If a message
33116 is found to be all right, manually unfreezing it allows it to be delivered.
33117
33118 .cindex "log" "&%fail%& command log line"
33119 .cindex "&%fail%&" "log line; reducing"
33120 The text given with a fail command is used as part of the bounce message as
33121 well as being written to the log. If the message is quite long, this can fill
33122 up a lot of log space when such failures are common. To reduce the size of the
33123 log message, Exim interprets the text in a special way if it starts with the
33124 two characters &`<<`& and contains &`>>`& later. The text between these two
33125 strings is written to the log, and the rest of the text is used in the bounce
33126 message. For example:
33127 .code
33128 fail "<<filter test 1>>Your message is rejected \
33129      because it contains attachments that we are \
33130      not prepared to receive."
33131 .endd
33132
33133 .cindex "loop" "caused by &%fail%&"
33134 Take great care with the &%fail%& command when basing the decision to fail on
33135 the contents of the message, because the bounce message will of course include
33136 the contents of the original message and will therefore trigger the &%fail%&
33137 command again (causing a mail loop) unless steps are taken to prevent this.
33138 Testing the &%error_message%& condition is one way to prevent this. You could
33139 use, for example
33140 .code
33141 if $message_body contains "this is spam" and not error_message
33142 then fail text "spam is not wanted here" endif
33143 .endd
33144 though of course that might let through unwanted bounce messages. The
33145 alternative is clever checking of the body and/or headers to detect bounces
33146 generated by the filter.
33147
33148 The interpretation of a system filter file ceases after a
33149 &%defer%&,
33150 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
33151 set up earlier in the filter file are honoured, so you can use a sequence such
33152 as
33153 .code
33154 mail ...
33155 freeze
33156 .endd
33157 to send a specified message when the system filter is freezing (or deferring or
33158 failing) a message. The normal deliveries for the message do not, of course,
33159 take place.
33160
33161
33162
33163 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
33164 .cindex "header lines" "adding; in system filter"
33165 .cindex "header lines" "removing; in system filter"
33166 .cindex "filter" "header lines; adding/removing"
33167 Two filter commands that are available only in system filters are:
33168 .code
33169 headers add <string>
33170 headers remove <string>
33171 .endd
33172 The argument for the &%headers add%& is a string that is expanded and then
33173 added to the end of the message's headers. It is the responsibility of the
33174 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
33175 space is ignored, and if the string is otherwise empty, or if the expansion is
33176 forced to fail, the command has no effect.
33177
33178 You can use &"\n"& within the string, followed by white space, to specify
33179 continued header lines. More than one header may be added in one command by
33180 including &"\n"& within the string without any following white space. For
33181 example:
33182 .code
33183 headers add "X-header-1: ....\n  \
33184              continuation of X-header-1 ...\n\
33185              X-header-2: ...."
33186 .endd
33187 Note that the header line continuation white space after the first newline must
33188 be placed before the backslash that continues the input string, because white
33189 space after input continuations is ignored.
33190
33191 The argument for &%headers remove%& is a colon-separated list of header names.
33192 This command applies only to those headers that are stored with the message;
33193 those that are added at delivery time (such as &'Envelope-To:'& and
33194 &'Return-Path:'&) cannot be removed by this means. If there is more than one
33195 header with the same name, they are all removed.
33196
33197 The &%headers%& command in a system filter makes an immediate change to the set
33198 of header lines that was received with the message (with possible additions
33199 from ACL processing). Subsequent commands in the system filter operate on the
33200 modified set, which also forms the basis for subsequent message delivery.
33201 Unless further modified during routing or transporting, this set of headers is
33202 used for all recipients of the message.
33203
33204 During routing and transporting, the variables that refer to the contents of
33205 header lines refer only to those lines that are in this set. Thus, header lines
33206 that are added by a system filter are visible to users' filter files and to all
33207 routers and transports. This contrasts with the manipulation of header lines by
33208 routers and transports, which is not immediate, but which instead is saved up
33209 until the message is actually being written (see section
33210 &<<SECTheadersaddrem>>&).
33211
33212 If the message is not delivered at the first attempt, header lines that were
33213 added by the system filter are stored with the message, and so are still
33214 present at the next delivery attempt. Header lines that were removed are still
33215 present, but marked &"deleted"& so that they are not transported with the
33216 message. For this reason, it is usual to make the &%headers%& command
33217 conditional on &%first_delivery%& so that the set of header lines is not
33218 modified more than once.
33219
33220 Because header modification in a system filter acts immediately, you have to
33221 use an indirect approach if you want to modify the contents of a header line.
33222 For example:
33223 .code
33224 headers add "Old-Subject: $h_subject:"
33225 headers remove "Subject"
33226 headers add "Subject: new subject (was: $h_old-subject:)"
33227 headers remove "Old-Subject"
33228 .endd
33229
33230
33231
33232 .section "Setting an errors address in a system filter" "SECID217"
33233 .cindex "envelope sender"
33234 In a system filter, if a &%deliver%& command is followed by
33235 .code
33236 errors_to <some address>
33237 .endd
33238 in order to change the envelope sender (and hence the error reporting) for that
33239 delivery, any address may be specified. (In a user filter, only the current
33240 user's address can be set.) For example, if some mail is being monitored, you
33241 might use
33242 .code
33243 unseen deliver monitor@spying.example errors_to root@local.example
33244 .endd
33245 to take a copy which would not be sent back to the normal error reporting
33246 address if its delivery failed.
33247
33248
33249
33250 .section "Per-address filtering" "SECTperaddfil"
33251 .vindex "&$domain$&"
33252 .vindex "&$local_part$&"
33253 In contrast to the system filter, which is run just once per message for each
33254 delivery attempt, it is also possible to set up a system-wide filtering
33255 operation that runs once for each recipient address. In this case, variables
33256 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33257 filter file could be made dependent on them. This is an example of a router
33258 which implements such a filter:
33259 .code
33260 central_filter:
33261   check_local_user
33262   driver = redirect
33263   domains = +local_domains
33264   file = /central/filters/$local_part
33265   no_verify
33266   allow_filter
33267   allow_freeze
33268 .endd
33269 The filter is run in a separate process under its own uid. Therefore, either
33270 &%check_local_user%& must be set (as above), in which case the filter is run as
33271 the local user, or the &%user%& option must be used to specify which user to
33272 use. If both are set, &%user%& overrides.
33273
33274 Care should be taken to ensure that none of the commands in the filter file
33275 specify a significant delivery if the message is to go on to be delivered to
33276 its intended recipient. The router will not then claim to have dealt with the
33277 address, so it will be passed on to subsequent routers to be delivered in the
33278 normal way.
33279 .ecindex IIDsysfil1
33280 .ecindex IIDsysfil2
33281 .ecindex IIDsysfil3
33282
33283
33284
33285
33286
33287
33288 . ////////////////////////////////////////////////////////////////////////////
33289 . ////////////////////////////////////////////////////////////////////////////
33290
33291 .chapter "Message processing" "CHAPmsgproc"
33292 .scindex IIDmesproc "message" "general processing"
33293 Exim performs various transformations on the sender and recipient addresses of
33294 all messages that it handles, and also on the messages' header lines. Some of
33295 these are optional and configurable, while others always take place. All of
33296 this processing, except rewriting as a result of routing, and the addition or
33297 removal of header lines while delivering, happens when a message is received,
33298 before it is placed on Exim's queue.
33299
33300 Some of the automatic processing takes place by default only for
33301 &"locally-originated"& messages. This adjective is used to describe messages
33302 that are not received over TCP/IP, but instead are passed to an Exim process on
33303 its standard input. This includes the interactive &"local SMTP"& case that is
33304 set up by the &%-bs%& command line option.
33305
33306 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33307 or ::1) are not considered to be locally-originated. Exim does not treat the
33308 loopback interface specially in any way.
33309
33310 If you want the loopback interface to be treated specially, you must ensure
33311 that there are appropriate entries in your ACLs.
33312
33313
33314
33315
33316 .section "Submission mode for non-local messages" "SECTsubmodnon"
33317 .cindex "message" "submission"
33318 .cindex "submission mode"
33319 Processing that happens automatically for locally-originated messages (unless
33320 &%suppress_local_fixups%& is set) can also be requested for messages that are
33321 received over TCP/IP. The term &"submission mode"& is used to describe this
33322 state. Submission mode is set by the modifier
33323 .code
33324 control = submission
33325 .endd
33326 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33327 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33328 a local submission, and is normally used when the source of the message is
33329 known to be an MUA running on a client host (as opposed to an MTA). For
33330 example, to set submission mode for messages originating on the IPv4 loopback
33331 interface, you could include the following in the MAIL ACL:
33332 .code
33333 warn  hosts = 127.0.0.1
33334       control = submission
33335 .endd
33336 .cindex "&%sender_retain%& submission option"
33337 There are some options that can be used when setting submission mode. A slash
33338 is used to separate options. For example:
33339 .code
33340 control = submission/sender_retain
33341 .endd
33342 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33343 true and &%local_from_check%& false for the current incoming message. The first
33344 of these allows an existing &'Sender:'& header in the message to remain, and
33345 the second suppresses the check to ensure that &'From:'& matches the
33346 authenticated sender. With this setting, Exim still fixes up messages by adding
33347 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33348 attempt to check sender authenticity in header lines.
33349
33350 When &%sender_retain%& is not set, a submission mode setting may specify a
33351 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33352 example:
33353 .code
33354 control = submission/domain=some.domain
33355 .endd
33356 The domain may be empty. How this value is used is described in sections
33357 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33358 that allows you to specify the user's full name for inclusion in a created
33359 &'Sender:'& or &'From:'& header line. For example:
33360 .code
33361 accept authenticated = *
33362        control = submission/domain=wonderland.example/\
33363                             name=${lookup {$authenticated_id} \
33364                                    lsearch {/etc/exim/namelist}}
33365 .endd
33366 Because the name may contain any characters, including slashes, the &%name%&
33367 option must be given last. The remainder of the string is used as the name. For
33368 the example above, if &_/etc/exim/namelist_& contains:
33369 .code
33370 bigegg:  Humpty Dumpty
33371 .endd
33372 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33373 line would be:
33374 .code
33375 Sender: Humpty Dumpty <bigegg@wonderland.example>
33376 .endd
33377 .cindex "return path" "in submission mode"
33378 By default, submission mode forces the return path to the same address as is
33379 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33380 specified, the return path is also left unchanged.
33381
33382 &*Note*&: The changes caused by submission mode take effect after the predata
33383 ACL. This means that any sender checks performed before the fix-ups use the
33384 untrusted sender address specified by the user, not the trusted sender address
33385 specified by submission mode. Although this might be slightly unexpected, it
33386 does mean that you can configure ACL checks to spot that a user is trying to
33387 spoof another's address.
33388
33389 .section "Line endings" "SECTlineendings"
33390 .cindex "line endings"
33391 .cindex "carriage return"
33392 .cindex "linefeed"
33393 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33394 linefeed) is the line ending for messages transmitted over the Internet using
33395 SMTP over TCP/IP. However, within individual operating systems, different
33396 conventions are used. For example, Unix-like systems use just LF, but others
33397 use CRLF or just CR.
33398
33399 Exim was designed for Unix-like systems, and internally, it stores messages
33400 using the system's convention of a single LF as a line terminator. When
33401 receiving a message, all line endings are translated to this standard format.
33402 Originally, it was thought that programs that passed messages directly to an
33403 MTA within an operating system would use that system's convention. Experience
33404 has shown that this is not the case; for example, there are Unix applications
33405 that use CRLF in this circumstance. For this reason, and for compatibility with
33406 other MTAs, the way Exim handles line endings for all messages is now as
33407 follows:
33408
33409 .ilist
33410 LF not preceded by CR is treated as a line ending.
33411 .next
33412 CR is treated as a line ending; if it is immediately followed by LF, the LF
33413 is ignored.
33414 .next
33415 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33416 nor a local message in the state where a line containing only a dot is a
33417 terminator.
33418 .next
33419 If a bare CR is encountered within a header line, an extra space is added after
33420 the line terminator so as not to end the header line. The reasoning behind this
33421 is that bare CRs in header lines are most likely either to be mistakes, or
33422 people trying to play silly games.
33423 .next
33424 If the first header line received in a message ends with CRLF, a subsequent
33425 bare LF in a header line is treated in the same way as a bare CR in a header
33426 line.
33427 .endlist
33428
33429
33430
33431
33432
33433 .section "Unqualified addresses" "SECID218"
33434 .cindex "unqualified addresses"
33435 .cindex "address" "qualification"
33436 By default, Exim expects every envelope address it receives from an external
33437 host to be fully qualified. Unqualified addresses cause negative responses to
33438 SMTP commands. However, because SMTP is used as a means of transporting
33439 messages from MUAs running on personal workstations, there is sometimes a
33440 requirement to accept unqualified addresses from specific hosts or IP networks.
33441
33442 Exim has two options that separately control which hosts may send unqualified
33443 sender or recipient addresses in SMTP commands, namely
33444 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33445 cases, if an unqualified address is accepted, it is qualified by adding the
33446 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33447
33448 .oindex "&%qualify_domain%&"
33449 .oindex "&%qualify_recipient%&"
33450 Unqualified addresses in header lines are automatically qualified for messages
33451 that are locally originated, unless the &%-bnq%& option is given on the command
33452 line. For messages received over SMTP, unqualified addresses in header lines
33453 are qualified only if unqualified addresses are permitted in SMTP commands. In
33454 other words, such qualification is also controlled by
33455 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33456
33457
33458
33459
33460 .section "The UUCP From line" "SECID219"
33461 .cindex "&""From""& line"
33462 .cindex "UUCP" "&""From""& line"
33463 .cindex "sender" "address"
33464 .oindex "&%uucp_from_pattern%&"
33465 .oindex "&%uucp_from_sender%&"
33466 .cindex "envelope sender"
33467 .cindex "Sendmail compatibility" "&""From""& line"
33468 Messages that have come from UUCP (and some other applications) often begin
33469 with a line containing the envelope sender and a timestamp, following the word
33470 &"From"&. Examples of two common formats are:
33471 .code
33472 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33473 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33474 .endd
33475 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33476 Exim recognizes such lines at the start of messages that are submitted to it
33477 via the command line (that is, on the standard input). It does not recognize
33478 such lines in incoming SMTP messages, unless the sending host matches
33479 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33480 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33481 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33482 default value matches the two common cases shown above and puts the address
33483 that follows &"From"& into &$1$&.
33484
33485 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33486 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33487 a trusted user, the message's sender address is constructed by expanding the
33488 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33489 then parsed as an RFC 2822 address. If there is no domain, the local part is
33490 qualified with &%qualify_domain%& unless it is the empty string. However, if
33491 the command line &%-f%& option is used, it overrides the &"From"& line.
33492
33493 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33494 sender address is not changed. This is also the case for incoming SMTP messages
33495 that are permitted to contain &"From"& lines.
33496
33497 Only one &"From"& line is recognized. If there is more than one, the second is
33498 treated as a data line that starts the body of the message, as it is not valid
33499 as a header line. This also happens if a &"From"& line is present in an
33500 incoming SMTP message from a source that is not permitted to send them.
33501
33502
33503
33504 .section "Resent- header lines" "SECID220"
33505 .cindex "&%Resent-%& header lines"
33506 .cindex "header lines" "Resent-"
33507 RFC 2822 makes provision for sets of header lines starting with the string
33508 &`Resent-`& to be added to a message when it is resent by the original
33509 recipient to somebody else. These headers are &'Resent-Date:'&,
33510 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33511 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33512
33513 .blockquote
33514 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33515 processing of replies or other such automatic actions on messages.'&
33516 .endblockquote
33517
33518 This leaves things a bit vague as far as other processing actions such as
33519 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33520 follows:
33521
33522 .ilist
33523 A &'Resent-From:'& line that just contains the login id of the submitting user
33524 is automatically rewritten in the same way as &'From:'& (see below).
33525 .next
33526 If there's a rewriting rule for a particular header line, it is also applied to
33527 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33528 &'From:'& also rewrites &'Resent-From:'&.
33529 .next
33530 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33531 also removed.
33532 .next
33533 For a locally-submitted message,
33534 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33535 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33536 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33537 included in log lines in this case.
33538 .next
33539 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33540 &%Resent-%& header lines are present.
33541 .endlist
33542
33543
33544
33545
33546 .section "The Auto-Submitted: header line" "SECID221"
33547 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33548 includes the header line:
33549 .code
33550 Auto-Submitted: auto-replied
33551 .endd
33552
33553 .section "The Bcc: header line" "SECID222"
33554 .cindex "&'Bcc:'& header line"
33555 If Exim is called with the &%-t%& option, to take recipient addresses from a
33556 message's header, it removes any &'Bcc:'& header line that may exist (after
33557 extracting its addresses). If &%-t%& is not present on the command line, any
33558 existing &'Bcc:'& is not removed.
33559
33560
33561 .section "The Date: header line" "SECID223"
33562 .cindex "&'Date:'& header line"
33563 .cindex "header lines" "Date:"
33564 If a locally-generated or submission-mode message has no &'Date:'& header line,
33565 Exim adds one, using the current date and time, unless the
33566 &%suppress_local_fixups%& control has been specified.
33567
33568 .section "The Delivery-date: header line" "SECID224"
33569 .cindex "&'Delivery-date:'& header line"
33570 .oindex "&%delivery_date_remove%&"
33571 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33572 set. Exim can be configured to add them to the final delivery of messages. (See
33573 the generic &%delivery_date_add%& transport option.) They should not be present
33574 in messages in transit. If the &%delivery_date_remove%& configuration option is
33575 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33576 messages.
33577
33578
33579 .section "The Envelope-to: header line" "SECID225"
33580 .cindex "&'Envelope-to:'& header line"
33581 .cindex "header lines" "Envelope-to:"
33582 .oindex "&%envelope_to_remove%&"
33583 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33584 Exim can be configured to add them to the final delivery of messages. (See the
33585 generic &%envelope_to_add%& transport option.) They should not be present in
33586 messages in transit. If the &%envelope_to_remove%& configuration option is set
33587 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33588 messages.
33589
33590
33591 .section "The From: header line" "SECTthefrohea"
33592 .cindex "&'From:'& header line"
33593 .cindex "header lines" "From:"
33594 .cindex "Sendmail compatibility" "&""From""& line"
33595 .cindex "message" "submission"
33596 .cindex "submission mode"
33597 If a submission-mode message does not contain a &'From:'& header line, Exim
33598 adds one if either of the following conditions is true:
33599
33600 .ilist
33601 The envelope sender address is not empty (that is, this is not a bounce
33602 message). The added header line copies the envelope sender address.
33603 .next
33604 .vindex "&$authenticated_id$&"
33605 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33606 .olist
33607 .vindex "&$qualify_domain$&"
33608 If no domain is specified by the submission control, the local part is
33609 &$authenticated_id$& and the domain is &$qualify_domain$&.
33610 .next
33611 If a non-empty domain is specified by the submission control, the local
33612 part is &$authenticated_id$&, and the domain is the specified domain.
33613 .next
33614 If an empty domain is specified by the submission control,
33615 &$authenticated_id$& is assumed to be the complete address.
33616 .endlist
33617 .endlist
33618
33619 A non-empty envelope sender takes precedence.
33620
33621 If a locally-generated incoming message does not contain a &'From:'& header
33622 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33623 containing the sender's address. The calling user's login name and full name
33624 are used to construct the address, as described in section &<<SECTconstr>>&.
33625 They are obtained from the password data by calling &[getpwuid()]& (but see the
33626 &%unknown_login%& configuration option). The address is qualified with
33627 &%qualify_domain%&.
33628
33629 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33630 &'From:'& header line containing just the unqualified login name of the calling
33631 user, this is replaced by an address containing the user's login name and full
33632 name as described in section &<<SECTconstr>>&.
33633
33634
33635 .section "The Message-ID: header line" "SECID226"
33636 .cindex "&'Message-ID:'& header line"
33637 .cindex "header lines" "Message-ID:"
33638 .cindex "message" "submission"
33639 .oindex "&%message_id_header_text%&"
33640 If a locally-generated or submission-mode incoming message does not contain a
33641 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33642 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33643 to the message. If there are any &'Resent-:'& headers in the message, it
33644 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33645 message id, preceded by the letter E to ensure it starts with a letter, and
33646 followed by @ and the primary host name. Additional information can be included
33647 in this header line by setting the &%message_id_header_text%& and/or
33648 &%message_id_header_domain%& options.
33649
33650
33651 .section "The Received: header line" "SECID227"
33652 .cindex "&'Received:'& header line"
33653 .cindex "header lines" "Received:"
33654 A &'Received:'& header line is added at the start of every message. The
33655 contents are defined by the &%received_header_text%& configuration option, and
33656 Exim automatically adds a semicolon and a timestamp to the configured string.
33657
33658 The &'Received:'& header is generated as soon as the message's header lines
33659 have been received. At this stage, the timestamp in the &'Received:'& header
33660 line is the time that the message started to be received. This is the value
33661 that is seen by the DATA ACL and by the &[local_scan()]& function.
33662
33663 Once a message is accepted, the timestamp in the &'Received:'& header line is
33664 changed to the time of acceptance, which is (apart from a small delay while the
33665 -H spool file is written) the earliest time at which delivery could start.
33666
33667
33668 .section "The References: header line" "SECID228"
33669 .cindex "&'References:'& header line"
33670 .cindex "header lines" "References:"
33671 Messages created by the &(autoreply)& transport include a &'References:'&
33672 header line. This is constructed according to the rules that are described in
33673 section 3.64 of RFC 2822 (which states that replies should contain such a
33674 header line), and section 3.14 of RFC 3834 (which states that automatic
33675 responses are not different in this respect). However, because some mail
33676 processing software does not cope well with very long header lines, no more
33677 than 12 message IDs are copied from the &'References:'& header line in the
33678 incoming message. If there are more than 12, the first one and then the final
33679 11 are copied, before adding the message ID of the incoming message.
33680
33681
33682
33683 .section "The Return-path: header line" "SECID229"
33684 .cindex "&'Return-path:'& header line"
33685 .cindex "header lines" "Return-path:"
33686 .oindex "&%return_path_remove%&"
33687 &'Return-path:'& header lines are defined as something an MTA may insert when
33688 it does the final delivery of messages. (See the generic &%return_path_add%&
33689 transport option.) Therefore, they should not be present in messages in
33690 transit. If the &%return_path_remove%& configuration option is set (the
33691 default), Exim removes &'Return-path:'& header lines from incoming messages.
33692
33693
33694
33695 .section "The Sender: header line" "SECTthesenhea"
33696 .cindex "&'Sender:'& header line"
33697 .cindex "message" "submission"
33698 .cindex "header lines" "Sender:"
33699 For a locally-originated message from an untrusted user, Exim may remove an
33700 existing &'Sender:'& header line, and it may add a new one. You can modify
33701 these actions by setting the &%local_sender_retain%& option true, the
33702 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33703 control setting.
33704
33705 When a local message is received from an untrusted user and
33706 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33707 control has not been set, a check is made to see if the address given in the
33708 &'From:'& header line is the correct (local) sender of the message. The address
33709 that is expected has the login name as the local part and the value of
33710 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33711 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33712 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33713 line is added to the message.
33714
33715 If you set &%local_from_check%& false, this checking does not occur. However,
33716 the removal of an existing &'Sender:'& line still happens, unless you also set
33717 &%local_sender_retain%& to be true. It is not possible to set both of these
33718 options true at the same time.
33719
33720 .cindex "submission mode"
33721 By default, no processing of &'Sender:'& header lines is done for messages
33722 received over TCP/IP or for messages submitted by trusted users. However, when
33723 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33724 not specified on the submission control, the following processing takes place:
33725
33726 .vindex "&$authenticated_id$&"
33727 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33728 authenticated, and &$authenticated_id$& is not empty, a sender address is
33729 created as follows:
33730
33731 .ilist
33732 .vindex "&$qualify_domain$&"
33733 If no domain is specified by the submission control, the local part is
33734 &$authenticated_id$& and the domain is &$qualify_domain$&.
33735 .next
33736 If a non-empty domain is specified by the submission control, the local part
33737 is &$authenticated_id$&, and the domain is the specified domain.
33738 .next
33739 If an empty domain is specified by the submission control,
33740 &$authenticated_id$& is assumed to be the complete address.
33741 .endlist
33742
33743 This address is compared with the address in the &'From:'& header line. If they
33744 are different, a &'Sender:'& header line containing the created address is
33745 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33746 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33747
33748 .cindex "return path" "created from &'Sender:'&"
33749 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33750 the message (the envelope sender address) is changed to be the same address,
33751 except in the case of submission mode when &%sender_retain%& is specified.
33752
33753
33754
33755 .section "Adding and removing header lines in routers and transports" &&&
33756          "SECTheadersaddrem"
33757 .cindex "header lines" "adding; in router or transport"
33758 .cindex "header lines" "removing; in router or transport"
33759 When a message is delivered, the addition and removal of header lines can be
33760 specified in a system filter, or on any of the routers and transports that
33761 process the message. Section &<<SECTaddremheasys>>& contains details about
33762 modifying headers in a system filter. Header lines can also be added in an ACL
33763 as a message is received (see section &<<SECTaddheadacl>>&).
33764
33765 In contrast to what happens in a system filter, header modifications that are
33766 specified on routers and transports apply only to the particular recipient
33767 addresses that are being processed by those routers and transports. These
33768 changes do not actually take place until a copy of the message is being
33769 transported. Therefore, they do not affect the basic set of header lines, and
33770 they do not affect the values of the variables that refer to header lines.
33771
33772 &*Note*&: In particular, this means that any expansions in the configuration of
33773 the transport cannot refer to the modified header lines, because such
33774 expansions all occur before the message is actually transported.
33775
33776 For both routers and transports, the argument of a &%headers_add%&
33777 option must be in the form of one or more RFC 2822 header lines, separated by
33778 newlines (coded as &"\n"&). For example:
33779 .code
33780 headers_add = X-added-header: added by $primary_hostname\n\
33781               X-added-second: another added header line
33782 .endd
33783 Exim does not check the syntax of these added header lines.
33784
33785 Multiple &%headers_add%& options for a single router or transport can be
33786 specified; the values will append to a single list of header lines.
33787 Each header-line is separately expanded.
33788
33789 The argument of a &%headers_remove%& option must consist of a colon-separated
33790 list of header names. This is confusing, because header names themselves are
33791 often terminated by colons. In this case, the colons are the list separators,
33792 not part of the names. For example:
33793 .code
33794 headers_remove = return-receipt-to:acknowledge-to
33795 .endd
33796
33797 Multiple &%headers_remove%& options for a single router or transport can be
33798 specified; the arguments will append to a single header-names list.
33799 Each item is separately expanded.
33800 Note that colons in complex expansions which are used to
33801 form all or part of a &%headers_remove%& list
33802 will act as list separators.
33803
33804 When &%headers_add%& or &%headers_remove%& is specified on a router,
33805 items are expanded at routing time,
33806 and then associated with all addresses that are
33807 accepted by that router, and also with any new addresses that it generates. If
33808 an address passes through several routers as a result of aliasing or
33809 forwarding, the changes are cumulative.
33810
33811 .oindex "&%unseen%&"
33812 However, this does not apply to multiple routers that result from the use of
33813 the &%unseen%& option. Any header modifications that were specified by the
33814 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33815
33816 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33817 settings cannot be delivered together in a batch, so a transport is always
33818 dealing with a set of addresses that have the same header-processing
33819 requirements.
33820
33821 The transport starts by writing the original set of header lines that arrived
33822 with the message, possibly modified by the system filter. As it writes out
33823 these lines, it consults the list of header names that were attached to the
33824 recipient address(es) by &%headers_remove%& options in routers, and it also
33825 consults the transport's own &%headers_remove%& option. Header lines whose
33826 names are on either of these lists are not written out. If there are multiple
33827 instances of any listed header, they are all skipped.
33828
33829 After the remaining original header lines have been written, new header
33830 lines that were specified by routers' &%headers_add%& options are written, in
33831 the order in which they were attached to the address. These are followed by any
33832 header lines specified by the transport's &%headers_add%& option.
33833
33834 This way of handling header line modifications in routers and transports has
33835 the following consequences:
33836
33837 .ilist
33838 The original set of header lines, possibly modified by the system filter,
33839 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33840 to it, at all times.
33841 .next
33842 Header lines that are added by a router's
33843 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33844 expansion syntax in subsequent routers or the transport.
33845 .next
33846 Conversely, header lines that are specified for removal by &%headers_remove%&
33847 in a router remain visible to subsequent routers and the transport.
33848 .next
33849 Headers added to an address by &%headers_add%& in a router cannot be removed by
33850 a later router or by a transport.
33851 .next
33852 An added header can refer to the contents of an original header that is to be
33853 removed, even it has the same name as the added header. For example:
33854 .code
33855 headers_remove = subject
33856 headers_add = Subject: new subject (was: $h_subject:)
33857 .endd
33858 .endlist
33859
33860 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33861 for a &(redirect)& router that has the &%one_time%& option set.
33862
33863
33864
33865
33866
33867 .section "Constructed addresses" "SECTconstr"
33868 .cindex "address" "constructed"
33869 .cindex "constructed address"
33870 When Exim constructs a sender address for a locally-generated message, it uses
33871 the form
33872 .display
33873 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33874 .endd
33875 For example:
33876 .code
33877 Zaphod Beeblebrox <zaphod@end.univ.example>
33878 .endd
33879 The user name is obtained from the &%-F%& command line option if set, or
33880 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33881 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33882 ampersand character, this is replaced by the login name with the first letter
33883 upper cased, as is conventional in a number of operating systems. See the
33884 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33885 The &%unknown_username%& option can be used to specify user names in cases when
33886 there is no password file entry.
33887
33888 .cindex "RFC 2047"
33889 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33890 parts of it if necessary. In addition, if it contains any non-printing
33891 characters, it is encoded as described in RFC 2047, which defines a way of
33892 including non-ASCII characters in header lines. The value of the
33893 &%headers_charset%& option specifies the name of the encoding that is used (the
33894 characters are assumed to be in this encoding). The setting of
33895 &%print_topbitchars%& controls whether characters with the top bit set (that
33896 is, with codes greater than 127) count as printing characters or not.
33897
33898
33899
33900 .section "Case of local parts" "SECID230"
33901 .cindex "case of local parts"
33902 .cindex "local part" "case of"
33903 RFC 2822 states that the case of letters in the local parts of addresses cannot
33904 be assumed to be non-significant. Exim preserves the case of local parts of
33905 addresses, but by default it uses a lower-cased form when it is routing,
33906 because on most Unix systems, usernames are in lower case and case-insensitive
33907 routing is required. However, any particular router can be made to use the
33908 original case for local parts by setting the &%caseful_local_part%& generic
33909 router option.
33910
33911 .cindex "mixed-case login names"
33912 If you must have mixed-case user names on your system, the best way to proceed,
33913 assuming you want case-independent handling of incoming email, is to set up
33914 your first router to convert incoming local parts in your domains to the
33915 correct case by means of a file lookup. For example:
33916 .code
33917 correct_case:
33918   driver = redirect
33919   domains = +local_domains
33920   data = ${lookup{$local_part}cdb\
33921               {/etc/usercased.cdb}{$value}fail}\
33922               @$domain
33923 .endd
33924 For this router, the local part is forced to lower case by the default action
33925 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33926 up a new local part in the correct case. If you then set &%caseful_local_part%&
33927 on any subsequent routers which process your domains, they will operate on
33928 local parts with the correct case in a case-sensitive manner.
33929
33930
33931
33932 .section "Dots in local parts" "SECID231"
33933 .cindex "dot" "in local part"
33934 .cindex "local part" "dots in"
33935 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33936 part may not begin or end with a dot, nor have two consecutive dots in the
33937 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33938 empty components for compatibility.
33939
33940
33941
33942 .section "Rewriting addresses" "SECID232"
33943 .cindex "rewriting" "addresses"
33944 Rewriting of sender and recipient addresses, and addresses in headers, can
33945 happen automatically, or as the result of configuration options, as described
33946 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33947 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33948
33949 Automatic rewriting includes qualification, as mentioned above. The other case
33950 in which it can happen is when an incomplete non-local domain is given. The
33951 routing process may cause this to be expanded into the full domain name. For
33952 example, a header such as
33953 .code
33954 To: hare@teaparty
33955 .endd
33956 might get rewritten as
33957 .code
33958 To: hare@teaparty.wonderland.fict.example
33959 .endd
33960 Rewriting as a result of routing is the one kind of message processing that
33961 does not happen at input time, as it cannot be done until the address has
33962 been routed.
33963
33964 Strictly, one should not do &'any'& deliveries of a message until all its
33965 addresses have been routed, in case any of the headers get changed as a
33966 result of routing. However, doing this in practice would hold up many
33967 deliveries for unreasonable amounts of time, just because one address could not
33968 immediately be routed. Exim therefore does not delay other deliveries when
33969 routing of one or more addresses is deferred.
33970 .ecindex IIDmesproc
33971
33972
33973
33974 . ////////////////////////////////////////////////////////////////////////////
33975 . ////////////////////////////////////////////////////////////////////////////
33976
33977 .chapter "SMTP processing" "CHAPSMTP"
33978 .scindex IIDsmtpproc1 "SMTP" "processing details"
33979 .scindex IIDsmtpproc2 "LMTP" "processing details"
33980 Exim supports a number of different ways of using the SMTP protocol, and its
33981 LMTP variant, which is an interactive protocol for transferring messages into a
33982 closed mail store application. This chapter contains details of how SMTP is
33983 processed. For incoming mail, the following are available:
33984
33985 .ilist
33986 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33987 .next
33988 SMTP over the standard input and output (the &%-bs%& option);
33989 .next
33990 Batched SMTP on the standard input (the &%-bS%& option).
33991 .endlist
33992
33993 For mail delivery, the following are available:
33994
33995 .ilist
33996 SMTP over TCP/IP (the &(smtp)& transport);
33997 .next
33998 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33999 &"lmtp"&);
34000 .next
34001 LMTP over a pipe to a process running in the local host (the &(lmtp)&
34002 transport);
34003 .next
34004 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
34005 the &%use_bsmtp%& option set).
34006 .endlist
34007
34008 &'Batched SMTP'& is the name for a process in which batches of messages are
34009 stored in or read from files (or pipes), in a format in which SMTP commands are
34010 used to contain the envelope information.
34011
34012
34013
34014 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
34015 .cindex "SMTP" "outgoing over TCP/IP"
34016 .cindex "outgoing SMTP over TCP/IP"
34017 .cindex "LMTP" "over TCP/IP"
34018 .cindex "outgoing LMTP over TCP/IP"
34019 .cindex "EHLO"
34020 .cindex "HELO"
34021 .cindex "SIZE option on MAIL command"
34022 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
34023 The &%protocol%& option selects which protocol is to be used, but the actual
34024 processing is the same in both cases.
34025
34026 If, in response to its EHLO command, Exim is told that the SIZE
34027 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
34028 command. The value of <&'n'&> is the message size plus the value of the
34029 &%size_addition%& option (default 1024) to allow for additions to the message
34030 such as per-transport header lines, or changes made in a
34031 .cindex "transport" "filter"
34032 .cindex "filter" "transport filter"
34033 transport filter. If &%size_addition%& is set negative, the use of SIZE is
34034 suppressed.
34035
34036 If the remote server advertises support for PIPELINING, Exim uses the
34037 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
34038 required for the transaction.
34039
34040 If the remote server advertises support for the STARTTLS command, and Exim
34041 was built to support TLS encryption, it tries to start a TLS session unless the
34042 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
34043 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
34044 is called for verification.
34045
34046 If the remote server advertises support for the AUTH command, Exim scans
34047 the authenticators configuration for any suitable client settings, as described
34048 in chapter &<<CHAPSMTPAUTH>>&.
34049
34050 .cindex "carriage return"
34051 .cindex "linefeed"
34052 Responses from the remote host are supposed to be terminated by CR followed by
34053 LF. However, there are known to be hosts that do not send CR characters, so in
34054 order to be able to interwork with such hosts, Exim treats LF on its own as a
34055 line terminator.
34056
34057 If a message contains a number of different addresses, all those with the same
34058 characteristics (for example, the same envelope sender) that resolve to the
34059 same set of hosts, in the same order, are sent in a single SMTP transaction,
34060 even if they are for different domains, unless there are more than the setting
34061 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
34062 they are split into groups containing no more than &%max_rcpt%&s addresses
34063 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
34064 in parallel sessions. The order of hosts with identical MX values is not
34065 significant when checking whether addresses can be batched in this way.
34066
34067 When the &(smtp)& transport suffers a temporary failure that is not
34068 message-related, Exim updates its transport-specific database, which contains
34069 records indexed by host name that remember which messages are waiting for each
34070 particular host. It also updates the retry database with new retry times.
34071
34072 .cindex "hints database" "retry keys"
34073 Exim's retry hints are based on host name plus IP address, so if one address of
34074 a multi-homed host is broken, it will soon be skipped most of the time.
34075 See the next section for more detail about error handling.
34076
34077 .cindex "SMTP" "passed connection"
34078 .cindex "SMTP" "batching over TCP/IP"
34079 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
34080 looks in the hints database for the transport to see if there are any queued
34081 messages waiting for the host to which it is connected. If it finds one, it
34082 creates a new Exim process using the &%-MC%& option (which can only be used by
34083 a process running as root or the Exim user) and passes the TCP/IP socket to it
34084 so that it can deliver another message using the same socket. The new process
34085 does only those deliveries that are routed to the connected host, and may in
34086 turn pass the socket on to a third process, and so on.
34087
34088 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
34089 limit the number of messages sent down a single TCP/IP connection.
34090
34091 .cindex "asterisk" "after IP address"
34092 The second and subsequent messages delivered down an existing connection are
34093 identified in the main log by the addition of an asterisk after the closing
34094 square bracket of the IP address.
34095
34096
34097
34098
34099 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
34100 .cindex "error" "in outgoing SMTP"
34101 .cindex "SMTP" "errors in outgoing"
34102 .cindex "host" "error"
34103 Three different kinds of error are recognized for outgoing SMTP: host errors,
34104 message errors, and recipient errors.
34105
34106 .vlist
34107 .vitem "&*Host errors*&"
34108 A host error is not associated with a particular message or with a
34109 particular recipient of a message. The host errors are:
34110
34111 .ilist
34112 Connection refused or timed out,
34113 .next
34114 Any error response code on connection,
34115 .next
34116 Any error response code to EHLO or HELO,
34117 .next
34118 Loss of connection at any time, except after &"."&,
34119 .next
34120 I/O errors at any time,
34121 .next
34122 Timeouts during the session, other than in response to MAIL, RCPT or
34123 the &"."& at the end of the data.
34124 .endlist ilist
34125
34126 For a host error, a permanent error response on connection, or in response to
34127 EHLO, causes all addresses routed to the host to be failed. Any other host
34128 error causes all addresses to be deferred, and retry data to be created for the
34129 host. It is not tried again, for any message, until its retry time arrives. If
34130 the current set of addresses are not all delivered in this run (to some
34131 alternative host), the message is added to the list of those waiting for this
34132 host, so if it is still undelivered when a subsequent successful delivery is
34133 made to the host, it will be sent down the same SMTP connection.
34134
34135 .vitem "&*Message errors*&"
34136 .cindex "message" "error"
34137 A message error is associated with a particular message when sent to a
34138 particular host, but not with a particular recipient of the message. The
34139 message errors are:
34140
34141 .ilist
34142 Any error response code to MAIL, DATA, or the &"."& that terminates
34143 the data,
34144 .next
34145 Timeout after MAIL,
34146 .next
34147 Timeout or loss of connection after the &"."& that terminates the data. A
34148 timeout after the DATA command itself is treated as a host error, as is loss of
34149 connection at any other time.
34150 .endlist ilist
34151
34152 For a message error, a permanent error response (5&'xx'&) causes all addresses
34153 to be failed, and a delivery error report to be returned to the sender. A
34154 temporary error response (4&'xx'&), or one of the timeouts, causes all
34155 addresses to be deferred. Retry data is not created for the host, but instead,
34156 a retry record for the combination of host plus message id is created. The
34157 message is not added to the list of those waiting for this host. This ensures
34158 that the failing message will not be sent to this host again until the retry
34159 time arrives. However, other messages that are routed to the host are not
34160 affected, so if it is some property of the message that is causing the error,
34161 it will not stop the delivery of other mail.
34162
34163 If the remote host specified support for the SIZE parameter in its response
34164 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
34165 over-large message will cause a message error because the error arrives as a
34166 response to MAIL.
34167
34168 .vitem "&*Recipient errors*&"
34169 .cindex "recipient" "error"
34170 A recipient error is associated with a particular recipient of a message. The
34171 recipient errors are:
34172
34173 .ilist
34174 Any error response to RCPT,
34175 .next
34176 Timeout after RCPT.
34177 .endlist
34178
34179 For a recipient error, a permanent error response (5&'xx'&) causes the
34180 recipient address to be failed, and a bounce message to be returned to the
34181 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
34182 address to be deferred, and routing retry data to be created for it. This is
34183 used to delay processing of the address in subsequent queue runs, until its
34184 routing retry time arrives. This applies to all messages, but because it
34185 operates only in queue runs, one attempt will be made to deliver a new message
34186 to the failing address before the delay starts to operate. This ensures that,
34187 if the failure is really related to the message rather than the recipient
34188 (&"message too big for this recipient"& is a possible example), other messages
34189 have a chance of getting delivered. If a delivery to the address does succeed,
34190 the retry information gets cleared, so all stuck messages get tried again, and
34191 the retry clock is reset.
34192
34193 The message is not added to the list of those waiting for this host. Use of the
34194 host for other messages is unaffected, and except in the case of a timeout,
34195 other recipients are processed independently, and may be successfully delivered
34196 in the current SMTP session. After a timeout it is of course impossible to
34197 proceed with the session, so all addresses get deferred. However, those other
34198 than the one that failed do not suffer any subsequent retry delays. Therefore,
34199 if one recipient is causing trouble, the others have a chance of getting
34200 through when a subsequent delivery attempt occurs before the failing
34201 recipient's retry time.
34202 .endlist
34203
34204 In all cases, if there are other hosts (or IP addresses) available for the
34205 current set of addresses (for example, from multiple MX records), they are
34206 tried in this run for any undelivered addresses, subject of course to their
34207 own retry data. In other words, recipient error retry data does not take effect
34208 until the next delivery attempt.
34209
34210 Some hosts have been observed to give temporary error responses to every
34211 MAIL command at certain times (&"insufficient space"& has been seen). It
34212 would be nice if such circumstances could be recognized, and defer data for the
34213 host itself created, but this is not possible within the current Exim design.
34214 What actually happens is that retry data for every (host, message) combination
34215 is created.
34216
34217 The reason that timeouts after MAIL and RCPT are treated specially is that
34218 these can sometimes arise as a result of the remote host's verification
34219 procedures. Exim makes this assumption, and treats them as if a temporary error
34220 response had been received. A timeout after &"."& is treated specially because
34221 it is known that some broken implementations fail to recognize the end of the
34222 message if the last character of the last line is a binary zero. Thus, it is
34223 helpful to treat this case as a message error.
34224
34225 Timeouts at other times are treated as host errors, assuming a problem with the
34226 host, or the connection to it. If a timeout after MAIL, RCPT,
34227 or &"."& is really a connection problem, the assumption is that at the next try
34228 the timeout is likely to occur at some other point in the dialogue, causing it
34229 then to be treated as a host error.
34230
34231 There is experimental evidence that some MTAs drop the connection after the
34232 terminating &"."& if they do not like the contents of the message for some
34233 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34234 should be given. That is why Exim treats this case as a message rather than a
34235 host error, in order not to delay other messages to the same host.
34236
34237
34238
34239
34240 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34241 .cindex "SMTP" "incoming over TCP/IP"
34242 .cindex "incoming SMTP over TCP/IP"
34243 .cindex "inetd"
34244 .cindex "daemon"
34245 Incoming SMTP messages can be accepted in one of two ways: by running a
34246 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34247 &_/etc/inetd.conf_& should be like this:
34248 .code
34249 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34250 .endd
34251 Exim distinguishes between this case and the case of a locally running user
34252 agent using the &%-bs%& option by checking whether or not the standard input is
34253 a socket. When it is, either the port must be privileged (less than 1024), or
34254 the caller must be root or the Exim user. If any other user passes a socket
34255 with an unprivileged port number, Exim prints a message on the standard error
34256 stream and exits with an error code.
34257
34258 By default, Exim does not make a log entry when a remote host connects or
34259 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34260 unexpected. It can be made to write such log entries by setting the
34261 &%smtp_connection%& log selector.
34262
34263 .cindex "carriage return"
34264 .cindex "linefeed"
34265 Commands from the remote host are supposed to be terminated by CR followed by
34266 LF. However, there are known to be hosts that do not send CR characters. In
34267 order to be able to interwork with such hosts, Exim treats LF on its own as a
34268 line terminator.
34269 Furthermore, because common code is used for receiving messages from all
34270 sources, a CR on its own is also interpreted as a line terminator. However, the
34271 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34272
34273 .cindex "EHLO" "invalid data"
34274 .cindex "HELO" "invalid data"
34275 One area that sometimes gives rise to problems concerns the EHLO or
34276 HELO commands. Some clients send syntactically invalid versions of these
34277 commands, which Exim rejects by default. (This is nothing to do with verifying
34278 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34279 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34280 match the broken hosts that send invalid commands.
34281
34282 .cindex "SIZE option on MAIL command"
34283 .cindex "MAIL" "SIZE option"
34284 The amount of disk space available is checked whenever SIZE is received on
34285 a MAIL command, independently of whether &%message_size_limit%& or
34286 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34287 false. A temporary error is given if there is not enough space. If
34288 &%check_spool_space%& is set, the check is for that amount of space plus the
34289 value given with SIZE, that is, it checks that the addition of the incoming
34290 message will not reduce the space below the threshold.
34291
34292 When a message is successfully received, Exim includes the local message id in
34293 its response to the final &"."& that terminates the data. If the remote host
34294 logs this text it can help with tracing what has happened to a message.
34295
34296 The Exim daemon can limit the number of simultaneous incoming connections it is
34297 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34298 number of simultaneous incoming connections from a single remote host (see the
34299 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34300 rejected using the SMTP temporary error code 421.
34301
34302 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34303 subprocess has finished, as this can get lost at busy times. Instead, it looks
34304 for completed subprocesses every time it wakes up. Provided there are other
34305 things happening (new incoming calls, starts of queue runs), completed
34306 processes will be noticed and tidied away. On very quiet systems you may
34307 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34308 it will be noticed when the daemon next wakes up.
34309
34310 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34311 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34312 high system load &-- for details see the &%smtp_accept_reserve%&,
34313 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34314 applies in both the daemon and &'inetd'& cases.
34315
34316 Exim normally starts a delivery process for each message received, though this
34317 can be varied by means of the &%-odq%& command line option and the
34318 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34319 number of simultaneously running delivery processes started in this way from
34320 SMTP input can be limited by the &%smtp_accept_queue%& and
34321 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34322 subsequently received messages are just put on the input queue without starting
34323 a delivery process.
34324
34325 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34326 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34327 started up from the &'inetd'& daemon, because in that case each connection is
34328 handled by an entirely independent Exim process. Control by load average is,
34329 however, available with &'inetd'&.
34330
34331 Exim can be configured to verify addresses in incoming SMTP commands as they
34332 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34333 to rewrite addresses at this time &-- before any syntax checking is done. See
34334 section &<<SECTrewriteS>>&.
34335
34336 Exim can also be configured to limit the rate at which a client host submits
34337 MAIL and RCPT commands in a single SMTP session. See the
34338 &%smtp_ratelimit_hosts%& option.
34339
34340
34341
34342 .section "Unrecognized SMTP commands" "SECID234"
34343 .cindex "SMTP" "unrecognized commands"
34344 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34345 commands during a single SMTP connection, it drops the connection after sending
34346 the error response to the last command. The default value for
34347 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34348 abuse that subvert web servers into making connections to SMTP ports; in these
34349 circumstances, a number of non-SMTP lines are sent first.
34350
34351
34352 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34353 .cindex "SMTP" "syntax errors"
34354 .cindex "SMTP" "protocol errors"
34355 A syntax error is detected if an SMTP command is recognized, but there is
34356 something syntactically wrong with its data, for example, a malformed email
34357 address in a RCPT command. Protocol errors include invalid command
34358 sequencing such as RCPT before MAIL. If Exim receives more than
34359 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34360 drops the connection after sending the error response to the last command. The
34361 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34362 broken clients that loop sending bad commands (yes, it has been seen).
34363
34364
34365
34366 .section "Use of non-mail SMTP commands" "SECID236"
34367 .cindex "SMTP" "non-mail commands"
34368 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34369 DATA. Exim counts such commands, and drops the connection if there are too
34370 many of them in a single SMTP session. This action catches some
34371 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34372 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34373 defines what &"too many"& means. Its default value is 10.
34374
34375 When a new message is expected, one occurrence of RSET is not counted. This
34376 allows a client to send one RSET between messages (this is not necessary,
34377 but some clients do it). Exim also allows one uncounted occurrence of HELO
34378 or EHLO, and one occurrence of STARTTLS between messages. After
34379 starting up a TLS session, another EHLO is expected, and so it too is not
34380 counted.
34381
34382 The first occurrence of AUTH in a connection, or immediately following
34383 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34384 RCPT, DATA, and QUIT are counted.
34385
34386 You can control which hosts are subject to the limit set by
34387 &%smtp_accept_max_nonmail%& by setting
34388 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34389 the limit apply to all hosts. This option means that you can exclude any
34390 specific badly-behaved hosts that you have to live with.
34391
34392
34393
34394
34395 .section "The VRFY and EXPN commands" "SECID237"
34396 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34397 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34398 appropriate) in order to decide whether the command should be accepted or not.
34399
34400 .cindex "VRFY" "processing"
34401 When no ACL is defined for VRFY, or if it rejects without
34402 setting an explicit response code, the command is accepted
34403 (with a 252 SMTP response code)
34404 in order to support awkward clients that do a VRFY before every RCPT.
34405 When VRFY is accepted, it runs exactly the same code as when Exim is
34406 called with the &%-bv%& option, and returns 250/451/550
34407 SMTP response codes.
34408
34409 .cindex "EXPN" "processing"
34410 If no ACL for EXPN is defined, the command is rejected.
34411 When EXPN is accepted, a single-level expansion of the address is done.
34412 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34413 than a verification (the &%-bv%& option). If an unqualified local part is given
34414 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34415 of VRFY and EXPN commands are logged on the main and reject logs, and
34416 VRFY verification failures are logged on the main log for consistency with
34417 RCPT failures.
34418
34419
34420
34421 .section "The ETRN command" "SECTETRN"
34422 .cindex "ETRN" "processing"
34423 RFC 1985 describes an SMTP command called ETRN that is designed to
34424 overcome the security problems of the TURN command (which has fallen into
34425 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34426 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34427 should be accepted or not. If no ACL is defined, the command is rejected.
34428
34429 The ETRN command is concerned with &"releasing"& messages that are awaiting
34430 delivery to certain hosts. As Exim does not organize its message queue by host,
34431 the only form of ETRN that is supported by default is the one where the
34432 text starts with the &"#"& prefix, in which case the remainder of the text is
34433 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34434 the &%-R%& option to happen, with the remainder of the ETRN text as its
34435 argument. For example,
34436 .code
34437 ETRN #brigadoon
34438 .endd
34439 runs the command
34440 .code
34441 exim -R brigadoon
34442 .endd
34443 which causes a delivery attempt on all messages with undelivered addresses
34444 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34445 default), Exim prevents the simultaneous execution of more than one queue run
34446 for the same argument string as a result of an ETRN command. This stops
34447 a misbehaving client from starting more than one queue runner at once.
34448
34449 .cindex "hints database" "ETRN serialization"
34450 Exim implements the serialization by means of a hints database in which a
34451 record is written whenever a process is started by ETRN, and deleted when
34452 the process completes. However, Exim does not keep the SMTP session waiting for
34453 the ETRN process to complete. Once ETRN is accepted, the client is sent
34454 a &"success"& return code. Obviously there is scope for hints records to get
34455 left lying around if there is a system or program crash. To guard against this,
34456 Exim ignores any records that are more than six hours old.
34457
34458 .oindex "&%smtp_etrn_command%&"
34459 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34460 used. This specifies a command that is run whenever ETRN is received,
34461 whatever the form of its argument. For
34462 example:
34463 .code
34464 smtp_etrn_command = /etc/etrn_command $domain \
34465                     $sender_host_address
34466 .endd
34467 .vindex "&$domain$&"
34468 The string is split up into arguments which are independently expanded. The
34469 expansion variable &$domain$& is set to the argument of the ETRN command,
34470 and no syntax checking is done on the contents of this argument. Exim does not
34471 wait for the command to complete, so its status code is not checked. Exim runs
34472 under its own uid and gid when receiving incoming SMTP, so it is not possible
34473 for it to change them before running the command.
34474
34475
34476
34477 .section "Incoming local SMTP" "SECID238"
34478 .cindex "SMTP" "local incoming"
34479 Some user agents use SMTP to pass messages to their local MTA using the
34480 standard input and output, as opposed to passing the envelope on the command
34481 line and writing the message to the standard input. This is supported by the
34482 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34483 messages over TCP/IP (including the use of ACLs), except that the envelope
34484 sender given in a MAIL command is ignored unless the caller is trusted. In
34485 an ACL you can detect this form of SMTP input by testing for an empty host
34486 identification. It is common to have this as the first line in the ACL that
34487 runs for RCPT commands:
34488 .code
34489 accept hosts = :
34490 .endd
34491 This accepts SMTP messages from local processes without doing any other tests.
34492
34493
34494
34495 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34496 .cindex "SMTP" "batched outgoing"
34497 .cindex "batched SMTP output"
34498 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34499 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34500 be output in BSMTP format. No SMTP responses are possible for this form of
34501 delivery. All it is doing is using SMTP commands as a way of transmitting the
34502 envelope along with the message.
34503
34504 The message is written to the file or pipe preceded by the SMTP commands
34505 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34506 the message that start with a dot have an extra dot added. The SMTP command
34507 HELO is not normally used. If it is required, the &%message_prefix%& option
34508 can be used to specify it.
34509
34510 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34511 one recipient address at a time by default. However, you can arrange for them
34512 to handle several addresses at once by setting the &%batch_max%& option. When
34513 this is done for BSMTP, messages may contain multiple RCPT commands. See
34514 chapter &<<CHAPbatching>>& for more details.
34515
34516 .vindex "&$host$&"
34517 When one or more addresses are routed to a BSMTP transport by a router that
34518 sets up a host list, the name of the first host on the list is available to the
34519 transport in the variable &$host$&. Here is an example of such a transport and
34520 router:
34521 .code
34522 begin routers
34523 route_append:
34524   driver = manualroute
34525   transport = smtp_appendfile
34526   route_list = domain.example  batch.host.example
34527
34528 begin transports
34529 smtp_appendfile:
34530   driver = appendfile
34531   directory = /var/bsmtp/$host
34532   batch_max = 1000
34533   use_bsmtp
34534   user = exim
34535 .endd
34536 This causes messages addressed to &'domain.example'& to be written in BSMTP
34537 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34538 message (unless there are more than 1000 recipients).
34539
34540
34541
34542 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34543 .cindex "SMTP" "batched incoming"
34544 .cindex "batched SMTP input"
34545 The &%-bS%& command line option causes Exim to accept one or more messages by
34546 reading SMTP on the standard input, but to generate no responses. If the caller
34547 is trusted, the senders in the MAIL commands are believed; otherwise the
34548 sender is always the caller of Exim. Unqualified senders and receivers are not
34549 rejected (there seems little point) but instead just get qualified. HELO
34550 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34551 as NOOP; QUIT quits.
34552
34553 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34554 ACL is run in the same way as for non-SMTP local input.
34555
34556 If an error is detected while reading a message, including a missing &"."& at
34557 the end, Exim gives up immediately. It writes details of the error to the
34558 standard output in a stylized way that the calling program should be able to
34559 make some use of automatically, for example:
34560 .code
34561 554 Unexpected end of file
34562 Transaction started in line 10
34563 Error detected in line 14
34564 .endd
34565 It writes a more verbose version, for human consumption, to the standard error
34566 file, for example:
34567 .code
34568 An error was detected while processing a file of BSMTP input.
34569 The error message was:
34570
34571 501 '>' missing at end of address
34572
34573 The SMTP transaction started in line 10.
34574 The error was detected in line 12.
34575 The SMTP command at fault was:
34576
34577 rcpt to:<malformed@in.com.plete
34578
34579 1 previous message was successfully processed.
34580 The rest of the batch was abandoned.
34581 .endd
34582 The return code from Exim is zero only if there were no errors. It is 1 if some
34583 messages were accepted before an error was detected, and 2 if no messages were
34584 accepted.
34585 .ecindex IIDsmtpproc1
34586 .ecindex IIDsmtpproc2
34587
34588
34589
34590 . ////////////////////////////////////////////////////////////////////////////
34591 . ////////////////////////////////////////////////////////////////////////////
34592
34593 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34594          "Customizing messages"
34595 When a message fails to be delivered, or remains on the queue for more than a
34596 configured amount of time, Exim sends a message to the original sender, or
34597 to an alternative configured address. The text of these messages is built into
34598 the code of Exim, but it is possible to change it, either by adding a single
34599 string, or by replacing each of the paragraphs by text supplied in a file.
34600
34601 The &'From:'& and &'To:'& header lines are automatically generated; you can
34602 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34603 option. Exim also adds the line
34604 .code
34605 Auto-Submitted: auto-generated
34606 .endd
34607 to all warning and bounce messages,
34608
34609
34610 .section "Customizing bounce messages" "SECID239"
34611 .cindex "customizing" "bounce message"
34612 .cindex "bounce message" "customizing"
34613 If &%bounce_message_text%& is set, its contents are included in the default
34614 message immediately after &"This message was created automatically by mail
34615 delivery software."& The string is not expanded. It is not used if
34616 &%bounce_message_file%& is set.
34617
34618 When &%bounce_message_file%& is set, it must point to a template file for
34619 constructing error messages. The file consists of a series of text items,
34620 separated by lines consisting of exactly four asterisks. If the file cannot be
34621 opened, default text is used and a message is written to the main and panic
34622 logs. If any text item in the file is empty, default text is used for that
34623 item.
34624
34625 .vindex "&$bounce_recipient$&"
34626 .vindex "&$bounce_return_size_limit$&"
34627 Each item of text that is read from the file is expanded, and there are two
34628 expansion variables which can be of use here: &$bounce_recipient$& is set to
34629 the recipient of an error message while it is being created, and
34630 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34631 option, rounded to a whole number.
34632
34633 The items must appear in the file in the following order:
34634
34635 .ilist
34636 The first item is included in the headers, and should include at least a
34637 &'Subject:'& header. Exim does not check the syntax of these headers.
34638 .next
34639 The second item forms the start of the error message. After it, Exim lists the
34640 failing addresses with their error messages.
34641 .next
34642 The third item is used to introduce any text from pipe transports that is to be
34643 returned to the sender. It is omitted if there is no such text.
34644 .next
34645 The fourth, fifth and sixth items will be ignored and may be empty.
34646 The fields exist for back-compatibility
34647 .endlist
34648
34649 The default state (&%bounce_message_file%& unset) is equivalent to the
34650 following file, in which the sixth item is empty. The &'Subject:'& and some
34651 other lines have been split in order to fit them on the page:
34652 .code
34653 Subject: Mail delivery failed
34654   ${if eq{$sender_address}{$bounce_recipient}
34655   {: returning message to sender}}
34656 ****
34657 This message was created automatically by mail delivery software.
34658
34659 A message ${if eq{$sender_address}{$bounce_recipient}
34660   {that you sent }{sent by
34661
34662 <$sender_address>
34663
34664 }}could not be delivered to all of its recipients.
34665 This is a permanent error. The following address(es) failed:
34666 ****
34667 The following text was generated during the delivery attempt(s):
34668 ****
34669 ------ This is a copy of the message, including all the headers.
34670   ------
34671 ****
34672 ------ The body of the message is $message_size characters long;
34673   only the first
34674 ------ $bounce_return_size_limit or so are included here.
34675 ****
34676 .endd
34677 .section "Customizing warning messages" "SECTcustwarn"
34678 .cindex "customizing" "warning message"
34679 .cindex "warning of delay" "customizing the message"
34680 The option &%warn_message_file%& can be pointed at a template file for use when
34681 warnings about message delays are created. In this case there are only three
34682 text sections:
34683
34684 .ilist
34685 The first item is included in the headers, and should include at least a
34686 &'Subject:'& header. Exim does not check the syntax of these headers.
34687 .next
34688 The second item forms the start of the warning message. After it, Exim lists
34689 the delayed addresses.
34690 .next
34691 The third item then ends the message.
34692 .endlist
34693
34694 The default state is equivalent to the following file, except that some lines
34695 have been split here, in order to fit them on the page:
34696 .code
34697 Subject: Warning: message $message_exim_id delayed
34698   $warn_message_delay
34699 ****
34700 This message was created automatically by mail delivery software.
34701
34702 A message ${if eq{$sender_address}{$warn_message_recipients}
34703 {that you sent }{sent by
34704
34705 <$sender_address>
34706
34707 }}has not been delivered to all of its recipients after
34708 more than $warn_message_delay on the queue on $primary_hostname.
34709
34710 The message identifier is:     $message_exim_id
34711 The subject of the message is: $h_subject
34712 The date of the message is:    $h_date
34713
34714 The following address(es) have not yet been delivered:
34715 ****
34716 No action is required on your part. Delivery attempts will
34717 continue for some time, and this warning may be repeated at
34718 intervals if the message remains undelivered. Eventually the
34719 mail delivery software will give up, and when that happens,
34720 the message will be returned to you.
34721 .endd
34722 .vindex "&$warn_message_delay$&"
34723 .vindex "&$warn_message_recipients$&"
34724 However, in the default state the subject and date lines are omitted if no
34725 appropriate headers exist. During the expansion of this file,
34726 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34727 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34728 of recipients for the warning message. There may be more than one if there are
34729 multiple addresses with different &%errors_to%& settings on the routers that
34730 handled them.
34731
34732
34733
34734
34735 . ////////////////////////////////////////////////////////////////////////////
34736 . ////////////////////////////////////////////////////////////////////////////
34737
34738 .chapter "Some common configuration settings" "CHAPcomconreq"
34739 This chapter discusses some configuration settings that seem to be fairly
34740 common. More examples and discussion can be found in the Exim book.
34741
34742
34743
34744 .section "Sending mail to a smart host" "SECID240"
34745 .cindex "smart host" "example router"
34746 If you want to send all mail for non-local domains to a &"smart host"&, you
34747 should replace the default &(dnslookup)& router with a router which does the
34748 routing explicitly:
34749 .code
34750 send_to_smart_host:
34751   driver = manualroute
34752   route_list = !+local_domains smart.host.name
34753   transport = remote_smtp
34754 .endd
34755 You can use the smart host's IP address instead of the name if you wish.
34756 If you are using Exim only to submit messages to a smart host, and not for
34757 receiving incoming messages, you can arrange for it to do the submission
34758 synchronously by setting the &%mua_wrapper%& option (see chapter
34759 &<<CHAPnonqueueing>>&).
34760
34761
34762
34763
34764 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34765 .cindex "mailing lists"
34766 Exim can be used to run simple mailing lists, but for large and/or complicated
34767 requirements, the use of additional specialized mailing list software such as
34768 Majordomo or Mailman is recommended.
34769
34770 The &(redirect)& router can be used to handle mailing lists where each list
34771 is maintained in a separate file, which can therefore be managed by an
34772 independent manager. The &%domains%& router option can be used to run these
34773 lists in a separate domain from normal mail. For example:
34774 .code
34775 lists:
34776   driver = redirect
34777   domains = lists.example
34778   file = /usr/lists/$local_part
34779   forbid_pipe
34780   forbid_file
34781   errors_to = $local_part-request@lists.example
34782   no_more
34783 .endd
34784 This router is skipped for domains other than &'lists.example'&. For addresses
34785 in that domain, it looks for a file that matches the local part. If there is no
34786 such file, the router declines, but because &%no_more%& is set, no subsequent
34787 routers are tried, and so the whole delivery fails.
34788
34789 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34790 expanded into a file name or a pipe delivery, which is usually inappropriate in
34791 a mailing list.
34792
34793 .oindex "&%errors_to%&"
34794 The &%errors_to%& option specifies that any delivery errors caused by addresses
34795 taken from a mailing list are to be sent to the given address rather than the
34796 original sender of the message. However, before acting on this, Exim verifies
34797 the error address, and ignores it if verification fails.
34798
34799 For example, using the configuration above, mail sent to
34800 &'dicts@lists.example'& is passed on to those addresses contained in
34801 &_/usr/lists/dicts_&, with error reports directed to
34802 &'dicts-request@lists.example'&, provided that this address can be verified.
34803 There could be a file called &_/usr/lists/dicts-request_& containing
34804 the address(es) of this particular list's manager(s), but other approaches,
34805 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34806 or &%local_part_suffix%& options) to handle addresses of the form
34807 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34808
34809
34810
34811 .section "Syntax errors in mailing lists" "SECID241"
34812 .cindex "mailing lists" "syntax errors in"
34813 If an entry in redirection data contains a syntax error, Exim normally defers
34814 delivery of the original address. That means that a syntax error in a mailing
34815 list holds up all deliveries to the list. This may not be appropriate when a
34816 list is being maintained automatically from data supplied by users, and the
34817 addresses are not rigorously checked.
34818
34819 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34820 entries that fail to parse, noting the incident in the log. If in addition
34821 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34822 whenever a broken address is skipped. It is usually appropriate to set
34823 &%syntax_errors_to%& to the same address as &%errors_to%&.
34824
34825
34826
34827 .section "Re-expansion of mailing lists" "SECID242"
34828 .cindex "mailing lists" "re-expansion of"
34829 Exim remembers every individual address to which a message has been delivered,
34830 in order to avoid duplication, but it normally stores only the original
34831 recipient addresses with a message. If all the deliveries to a mailing list
34832 cannot be done at the first attempt, the mailing list is re-expanded when the
34833 delivery is next tried. This means that alterations to the list are taken into
34834 account at each delivery attempt, so addresses that have been added to
34835 the list since the message arrived will therefore receive a copy of the
34836 message, even though it pre-dates their subscription.
34837
34838 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34839 on the &(redirect)& router. If this is done, any addresses generated by the
34840 router that fail to deliver at the first attempt are added to the message as
34841 &"top level"& addresses, and the parent address that generated them is marked
34842 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34843 subsequent delivery attempts. The disadvantage of this is that if any of the
34844 failing addresses are incorrect, correcting them in the file has no effect on
34845 pre-existing messages.
34846
34847 The original top-level address is remembered with each of the generated
34848 addresses, and is output in any log messages. However, any intermediate parent
34849 addresses are not recorded. This makes a difference to the log only if the
34850 &%all_parents%& selector is set, but for mailing lists there is normally only
34851 one level of expansion anyway.
34852
34853
34854
34855 .section "Closed mailing lists" "SECID243"
34856 .cindex "mailing lists" "closed"
34857 The examples so far have assumed open mailing lists, to which anybody may
34858 send mail. It is also possible to set up closed lists, where mail is accepted
34859 from specified senders only. This is done by making use of the generic
34860 &%senders%& option to restrict the router that handles the list.
34861
34862 The following example uses the same file as a list of recipients and as a list
34863 of permitted senders. It requires three routers:
34864 .code
34865 lists_request:
34866   driver = redirect
34867   domains = lists.example
34868   local_part_suffix = -request
34869   file = /usr/lists/$local_part$local_part_suffix
34870   no_more
34871
34872 lists_post:
34873   driver = redirect
34874   domains = lists.example
34875   senders = ${if exists {/usr/lists/$local_part}\
34876              {lsearch;/usr/lists/$local_part}{*}}
34877   file = /usr/lists/$local_part
34878   forbid_pipe
34879   forbid_file
34880   errors_to = $local_part-request@lists.example
34881   no_more
34882
34883 lists_closed:
34884   driver = redirect
34885   domains = lists.example
34886   allow_fail
34887   data = :fail: $local_part@lists.example is a closed mailing list
34888 .endd
34889 All three routers have the same &%domains%& setting, so for any other domains,
34890 they are all skipped. The first router runs only if the local part ends in
34891 &%-request%&. It handles messages to the list manager(s) by means of an open
34892 mailing list.
34893
34894 The second router runs only if the &%senders%& precondition is satisfied. It
34895 checks for the existence of a list that corresponds to the local part, and then
34896 checks that the sender is on the list by means of a linear search. It is
34897 necessary to check for the existence of the file before trying to search it,
34898 because otherwise Exim thinks there is a configuration error. If the file does
34899 not exist, the expansion of &%senders%& is *, which matches all senders. This
34900 means that the router runs, but because there is no list, declines, and
34901 &%no_more%& ensures that no further routers are run. The address fails with an
34902 &"unrouteable address"& error.
34903
34904 The third router runs only if the second router is skipped, which happens when
34905 a mailing list exists, but the sender is not on it. This router forcibly fails
34906 the address, giving a suitable error message.
34907
34908
34909
34910
34911 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34912 .cindex "VERP"
34913 .cindex "Variable Envelope Return Paths"
34914 .cindex "envelope sender"
34915 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34916 are a way of helping mailing list administrators discover which subscription
34917 address is the cause of a particular delivery failure. The idea is to encode
34918 the original recipient address in the outgoing envelope sender address, so that
34919 if the message is forwarded by another host and then subsequently bounces, the
34920 original recipient can be extracted from the recipient address of the bounce.
34921
34922 .oindex &%errors_to%&
34923 .oindex &%return_path%&
34924 Envelope sender addresses can be modified by Exim using two different
34925 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34926 list examples), or the &%return_path%& option on a transport. The second of
34927 these is effective only if the message is successfully delivered to another
34928 host; it is not used for errors detected on the local host (see the description
34929 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34930 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34931 .code
34932 verp_smtp:
34933   driver = smtp
34934   max_rcpt = 1
34935   return_path = \
34936     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34937       {$1-request+$local_part=$domain@your.dom.example}fail}
34938 .endd
34939 This has the effect of rewriting the return path (envelope sender) on outgoing
34940 SMTP messages, if the local part of the original return path ends in
34941 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34942 local part and domain of the recipient into the return path. Suppose, for
34943 example, that a message whose return path has been set to
34944 &'somelist-request@your.dom.example'& is sent to
34945 &'subscriber@other.dom.example'&. In the transport, the return path is
34946 rewritten as
34947 .code
34948 somelist-request+subscriber=other.dom.example@your.dom.example
34949 .endd
34950 .vindex "&$local_part$&"
34951 For this to work, you must tell Exim to send multiple copies of messages that
34952 have more than one recipient, so that each copy has just one recipient. This is
34953 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34954 might be sent to several different recipients in the same domain, in which case
34955 &$local_part$& is not available in the transport, because it is not unique.
34956
34957 Unless your host is doing nothing but mailing list deliveries, you should
34958 probably use a separate transport for the VERP deliveries, so as not to use
34959 extra resources in making one-per-recipient copies for other deliveries. This
34960 can easily be done by expanding the &%transport%& option in the router:
34961 .code
34962 dnslookup:
34963   driver = dnslookup
34964   domains = ! +local_domains
34965   transport = \
34966     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34967       {verp_smtp}{remote_smtp}}
34968   no_more
34969 .endd
34970 If you want to change the return path using &%errors_to%& in a router instead
34971 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34972 routers that handle mailing list addresses. This will ensure that all delivery
34973 errors, including those detected on the local host, are sent to the VERP
34974 address.
34975
34976 On a host that does no local deliveries and has no manual routing, only the
34977 &(dnslookup)& router needs to be changed. A special transport is not needed for
34978 SMTP deliveries. Every mailing list recipient has its own return path value,
34979 and so Exim must hand them to the transport one at a time. Here is an example
34980 of a &(dnslookup)& router that implements VERP:
34981 .code
34982 verp_dnslookup:
34983   driver = dnslookup
34984   domains = ! +local_domains
34985   transport = remote_smtp
34986   errors_to = \
34987     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34988      {$1-request+$local_part=$domain@your.dom.example}fail}
34989   no_more
34990 .endd
34991 Before you start sending out messages with VERPed return paths, you must also
34992 configure Exim to accept the bounce messages that come back to those paths.
34993 Typically this is done by setting a &%local_part_suffix%& option for a
34994 router, and using this to route the messages to wherever you want to handle
34995 them.
34996
34997 The overhead incurred in using VERP depends very much on the size of the
34998 message, the number of recipient addresses that resolve to the same remote
34999 host, and the speed of the connection over which the message is being sent. If
35000 a lot of addresses resolve to the same host and the connection is slow, sending
35001 a separate copy of the message for each address may take substantially longer
35002 than sending a single copy with many recipients (for which VERP cannot be
35003 used).
35004
35005
35006
35007
35008
35009
35010 .section "Virtual domains" "SECTvirtualdomains"
35011 .cindex "virtual domains"
35012 .cindex "domain" "virtual"
35013 The phrase &'virtual domain'& is unfortunately used with two rather different
35014 meanings:
35015
35016 .ilist
35017 A domain for which there are no real mailboxes; all valid local parts are
35018 aliases for other email addresses. Common examples are organizational
35019 top-level domains and &"vanity"& domains.
35020 .next
35021 One of a number of independent domains that are all handled by the same host,
35022 with mailboxes on that host, but where the mailbox owners do not necessarily
35023 have login accounts on that host.
35024 .endlist
35025
35026 The first usage is probably more common, and does seem more &"virtual"& than
35027 the second. This kind of domain can be handled in Exim with a straightforward
35028 aliasing router. One approach is to create a separate alias file for each
35029 virtual domain. Exim can test for the existence of the alias file to determine
35030 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
35031 to a router of this form:
35032 .code
35033 virtual:
35034   driver = redirect
35035   domains = dsearch;/etc/mail/virtual
35036   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
35037   no_more
35038 .endd
35039 The &%domains%& option specifies that the router is to be skipped, unless there
35040 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
35041 domain that is being processed. When the router runs, it looks up the local
35042 part in the file to find a new address (or list of addresses). The &%no_more%&
35043 setting ensures that if the lookup fails (leading to &%data%& being an empty
35044 string), Exim gives up on the address without trying any subsequent routers.
35045
35046 This one router can handle all the virtual domains because the alias file names
35047 follow a fixed pattern. Permissions can be arranged so that appropriate people
35048 can edit the different alias files. A successful aliasing operation results in
35049 a new envelope recipient address, which is then routed from scratch.
35050
35051 The other kind of &"virtual"& domain can also be handled in a straightforward
35052 way. One approach is to create a file for each domain containing a list of
35053 valid local parts, and use it in a router like this:
35054 .code
35055 my_domains:
35056   driver = accept
35057   domains = dsearch;/etc/mail/domains
35058   local_parts = lsearch;/etc/mail/domains/$domain
35059   transport = my_mailboxes
35060 .endd
35061 The address is accepted if there is a file for the domain, and the local part
35062 can be found in the file. The &%domains%& option is used to check for the
35063 file's existence because &%domains%& is tested before the &%local_parts%&
35064 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
35065 because that option is tested after &%local_parts%&. The transport is as
35066 follows:
35067 .code
35068 my_mailboxes:
35069   driver = appendfile
35070   file = /var/mail/$domain/$local_part
35071   user = mail
35072 .endd
35073 This uses a directory of mailboxes for each domain. The &%user%& setting is
35074 required, to specify which uid is to be used for writing to the mailboxes.
35075
35076 The configuration shown here is just one example of how you might support this
35077 requirement. There are many other ways this kind of configuration can be set
35078 up, for example, by using a database instead of separate files to hold all the
35079 information about the domains.
35080
35081
35082
35083 .section "Multiple user mailboxes" "SECTmulbox"
35084 .cindex "multiple mailboxes"
35085 .cindex "mailbox" "multiple"
35086 .cindex "local part" "prefix"
35087 .cindex "local part" "suffix"
35088 Heavy email users often want to operate with multiple mailboxes, into which
35089 incoming mail is automatically sorted. A popular way of handling this is to
35090 allow users to use multiple sender addresses, so that replies can easily be
35091 identified. Users are permitted to add prefixes or suffixes to their local
35092 parts for this purpose. The wildcard facility of the generic router options
35093 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
35094 example, consider this router:
35095 .code
35096 userforward:
35097   driver = redirect
35098   check_local_user
35099   file = $home/.forward
35100   local_part_suffix = -*
35101   local_part_suffix_optional
35102   allow_filter
35103 .endd
35104 .vindex "&$local_part_suffix$&"
35105 It runs a user's &_.forward_& file for all local parts of the form
35106 &'username-*'&. Within the filter file the user can distinguish different
35107 cases by testing the variable &$local_part_suffix$&. For example:
35108 .code
35109 if $local_part_suffix contains -special then
35110 save /home/$local_part/Mail/special
35111 endif
35112 .endd
35113 If the filter file does not exist, or does not deal with such addresses, they
35114 fall through to subsequent routers, and, assuming no subsequent use of the
35115 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
35116 control over which suffixes are valid.
35117
35118 Alternatively, a suffix can be used to trigger the use of a different
35119 &_.forward_& file &-- which is the way a similar facility is implemented in
35120 another MTA:
35121 .code
35122 userforward:
35123   driver = redirect
35124   check_local_user
35125   file = $home/.forward$local_part_suffix
35126   local_part_suffix = -*
35127   local_part_suffix_optional
35128   allow_filter
35129 .endd
35130 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
35131 example, &_.forward-special_& is used. Once again, if the appropriate file
35132 does not exist, or does not deal with the address, it is passed on to
35133 subsequent routers, which could, if required, look for an unqualified
35134 &_.forward_& file to use as a default.
35135
35136
35137
35138 .section "Simplified vacation processing" "SECID244"
35139 .cindex "vacation processing"
35140 The traditional way of running the &'vacation'& program is for a user to set up
35141 a pipe command in a &_.forward_& file
35142 (see section &<<SECTspecitredli>>& for syntax details).
35143 This is prone to error by inexperienced users. There are two features of Exim
35144 that can be used to make this process simpler for users:
35145
35146 .ilist
35147 A local part prefix such as &"vacation-"& can be specified on a router which
35148 can cause the message to be delivered directly to the &'vacation'& program, or
35149 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
35150 &_.forward_& file are then much simpler. For example:
35151 .code
35152 spqr, vacation-spqr
35153 .endd
35154 .next
35155 The &%require_files%& generic router option can be used to trigger a
35156 vacation delivery by checking for the existence of a certain file in the
35157 user's home directory. The &%unseen%& generic option should also be used, to
35158 ensure that the original delivery also proceeds. In this case, all the user has
35159 to do is to create a file called, say, &_.vacation_&, containing a vacation
35160 message.
35161 .endlist
35162
35163 Another advantage of both these methods is that they both work even when the
35164 use of arbitrary pipes by users is locked out.
35165
35166
35167
35168 .section "Taking copies of mail" "SECID245"
35169 .cindex "message" "copying every"
35170 Some installations have policies that require archive copies of all messages to
35171 be made. A single copy of each message can easily be taken by an appropriate
35172 command in a system filter, which could, for example, use a different file for
35173 each day's messages.
35174
35175 There is also a shadow transport mechanism that can be used to take copies of
35176 messages that are successfully delivered by local transports, one copy per
35177 delivery. This could be used, &'inter alia'&, to implement automatic
35178 notification of delivery by sites that insist on doing such things.
35179
35180
35181
35182 .section "Intermittently connected hosts" "SECID246"
35183 .cindex "intermittently connected hosts"
35184 It has become quite common (because it is cheaper) for hosts to connect to the
35185 Internet periodically rather than remain connected all the time. The normal
35186 arrangement is that mail for such hosts accumulates on a system that is
35187 permanently connected.
35188
35189 Exim was designed for use on permanently connected hosts, and so it is not
35190 particularly well-suited to use in an intermittently connected environment.
35191 Nevertheless there are some features that can be used.
35192
35193
35194 .section "Exim on the upstream server host" "SECID247"
35195 It is tempting to arrange for incoming mail for the intermittently connected
35196 host to remain on Exim's queue until the client connects. However, this
35197 approach does not scale very well. Two different kinds of waiting message are
35198 being mixed up in the same queue &-- those that cannot be delivered because of
35199 some temporary problem, and those that are waiting for their destination host
35200 to connect. This makes it hard to manage the queue, as well as wasting
35201 resources, because each queue runner scans the entire queue.
35202
35203 A better approach is to separate off those messages that are waiting for an
35204 intermittently connected host. This can be done by delivering these messages
35205 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
35206 format, from where they are transmitted by other software when their
35207 destination connects. This makes it easy to collect all the mail for one host
35208 in a single directory, and to apply local timeout rules on a per-message basis
35209 if required.
35210
35211 On a very small scale, leaving the mail on Exim's queue can be made to work. If
35212 you are doing this, you should configure Exim with a long retry period for the
35213 intermittent host. For example:
35214 .code
35215 cheshire.wonderland.fict.example    *   F,5d,24h
35216 .endd
35217 This stops a lot of failed delivery attempts from occurring, but Exim remembers
35218 which messages it has queued up for that host. Once the intermittent host comes
35219 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
35220 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
35221 causes all the queued up messages to be delivered, often down a single SMTP
35222 connection. While the host remains connected, any new messages get delivered
35223 immediately.
35224
35225 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35226 issued with a different IP address each time it connects, Exim's retry
35227 mechanisms on the holding host get confused, because the IP address is normally
35228 used as part of the key string for holding retry information. This can be
35229 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35230 Since this has disadvantages for permanently connected hosts, it is best to
35231 arrange a separate transport for the intermittently connected ones.
35232
35233
35234
35235 .section "Exim on the intermittently connected client host" "SECID248"
35236 The value of &%smtp_accept_queue_per_connection%& should probably be
35237 increased, or even set to zero (that is, disabled) on the intermittently
35238 connected host, so that all incoming messages down a single connection get
35239 delivered immediately.
35240
35241 .cindex "SMTP" "passed connection"
35242 .cindex "SMTP" "multiple deliveries"
35243 .cindex "multiple SMTP deliveries"
35244 Mail waiting to be sent from an intermittently connected host will probably
35245 not have been routed, because without a connection DNS lookups are not
35246 possible. This means that if a normal queue run is done at connection time,
35247 each message is likely to be sent in a separate SMTP session. This can be
35248 avoided by starting the queue run with a command line option beginning with
35249 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35250 first pass, routing is done but no deliveries take place. The second pass is a
35251 normal queue run; since all the messages have been previously routed, those
35252 destined for the same host are likely to get sent as multiple deliveries in a
35253 single SMTP connection.
35254
35255
35256
35257 . ////////////////////////////////////////////////////////////////////////////
35258 . ////////////////////////////////////////////////////////////////////////////
35259
35260 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35261          "Exim as a non-queueing client"
35262 .cindex "client, non-queueing"
35263 .cindex "smart host" "suppressing queueing"
35264 On a personal computer, it is a common requirement for all
35265 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35266 configured to operate that way, for all the popular operating systems.
35267 However, there are some MUAs for Unix-like systems that cannot be so
35268 configured: they submit messages using the command line interface of
35269 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35270 messages this way.
35271
35272 If the personal computer runs continuously, there is no problem, because it can
35273 run a conventional MTA that handles delivery to the smart host, and deal with
35274 any delays via its queueing mechanism. However, if the computer does not run
35275 continuously or runs different operating systems at different times, queueing
35276 email is not desirable.
35277
35278 There is therefore a requirement for something that can provide the
35279 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35280 any queueing or retrying facilities. Furthermore, the delivery to the smart
35281 host should be synchronous, so that if it fails, the sending MUA is immediately
35282 informed. In other words, we want something that extends an MUA that submits
35283 to a local MTA via the command line so that it behaves like one that submits
35284 to a remote smart host using TCP/SMTP.
35285
35286 There are a number of applications (for example, there is one called &'ssmtp'&)
35287 that do this job. However, people have found them to be lacking in various
35288 ways. For instance, you might want to allow aliasing and forwarding to be done
35289 before sending a message to the smart host.
35290
35291 Exim already had the necessary infrastructure for doing this job. Just a few
35292 tweaks were needed to make it behave as required, though it is somewhat of an
35293 overkill to use a fully-featured MTA for this purpose.
35294
35295 .oindex "&%mua_wrapper%&"
35296 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35297 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35298 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35299 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35300 compatible router and transport configuration. Typically there will be just one
35301 router and one transport, sending everything to a smart host.
35302
35303 When run in MUA wrapping mode, the behaviour of Exim changes in the
35304 following ways:
35305
35306 .ilist
35307 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35308 In other words, the only way to submit messages is via the command line.
35309 .next
35310 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35311 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35312 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35313 does not finish until the delivery attempt is complete. If the delivery is
35314 successful, a zero return code is given.
35315 .next
35316 Address redirection is permitted, but the final routing for all addresses must
35317 be to the same remote transport, and to the same list of hosts. Furthermore,
35318 the return address (envelope sender) must be the same for all recipients, as
35319 must any added or deleted header lines. In other words, it must be possible to
35320 deliver the message in a single SMTP transaction, however many recipients there
35321 are.
35322 .next
35323 If these conditions are not met, or if routing any address results in a
35324 failure or defer status, or if Exim is unable to deliver all the recipients
35325 successfully to one of the smart hosts, delivery of the entire message fails.
35326 .next
35327 Because no queueing is allowed, all failures are treated as permanent; there
35328 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35329 smart host. Furthermore, because only a single yes/no response can be given to
35330 the caller, it is not possible to deliver to some recipients and not others. If
35331 there is an error (temporary or permanent) for any recipient, all are failed.
35332 .next
35333 If more than one smart host is listed, Exim will try another host after a
35334 connection failure or a timeout, in the normal way. However, if this kind of
35335 failure happens for all the hosts, the delivery fails.
35336 .next
35337 When delivery fails, an error message is written to the standard error stream
35338 (as well as to Exim's log), and Exim exits to the caller with a return code
35339 value 1. The message is expunged from Exim's spool files. No bounce messages
35340 are ever generated.
35341 .next
35342 No retry data is maintained, and any retry rules are ignored.
35343 .next
35344 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35345 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35346 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35347 .endlist
35348
35349 The overall effect is that Exim makes a single synchronous attempt to deliver
35350 the message, failing if there is any kind of problem. Because no local
35351 deliveries are done and no daemon can be run, Exim does not need root
35352 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35353 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35354 the advantages and disadvantages of running without root privilege.
35355
35356
35357
35358
35359 . ////////////////////////////////////////////////////////////////////////////
35360 . ////////////////////////////////////////////////////////////////////////////
35361
35362 .chapter "Log files" "CHAPlog"
35363 .scindex IIDloggen "log" "general description"
35364 .cindex "log" "types of"
35365 Exim writes three different logs, referred to as the main log, the reject log,
35366 and the panic log:
35367
35368 .ilist
35369 .cindex "main log"
35370 The main log records the arrival of each message and each delivery in a single
35371 line in each case. The format is as compact as possible, in an attempt to keep
35372 down the size of log files. Two-character flag sequences make it easy to pick
35373 out these lines. A number of other events are recorded in the main log. Some of
35374 them are optional, in which case the &%log_selector%& option controls whether
35375 they are included or not. A Perl script called &'eximstats'&, which does simple
35376 analysis of main log files, is provided in the Exim distribution (see section
35377 &<<SECTmailstat>>&).
35378 .next
35379 .cindex "reject log"
35380 The reject log records information from messages that are rejected as a result
35381 of a configuration option (that is, for policy reasons).
35382 The first line of each rejection is a copy of the line that is also written to
35383 the main log. Then, if the message's header has been read at the time the log
35384 is written, its contents are written to this log. Only the original header
35385 lines are available; header lines added by ACLs are not logged. You can use the
35386 reject log to check that your policy controls are working correctly; on a busy
35387 host this may be easier than scanning the main log for rejection messages. You
35388 can suppress the writing of the reject log by setting &%write_rejectlog%&
35389 false.
35390 .next
35391 .cindex "panic log"
35392 .cindex "system log"
35393 When certain serious errors occur, Exim writes entries to its panic log. If the
35394 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35395 are usually written to the main log as well, but can get lost amid the mass of
35396 other entries. The panic log should be empty under normal circumstances. It is
35397 therefore a good idea to check it (or to have a &'cron'& script check it)
35398 regularly, in order to become aware of any problems. When Exim cannot open its
35399 panic log, it tries as a last resort to write to the system log (syslog). This
35400 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35401 message itself is written at priority LOG_CRIT.
35402 .endlist
35403
35404 Every log line starts with a timestamp, in the format shown in the following
35405 example. Note that many of the examples shown in this chapter are line-wrapped.
35406 In the log file, this would be all on one line:
35407 .code
35408 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35409   by QUIT
35410 .endd
35411 By default, the timestamps are in the local timezone. There are two
35412 ways of changing this:
35413
35414 .ilist
35415 You can set the &%timezone%& option to a different time zone; in particular, if
35416 you set
35417 .code
35418 timezone = UTC
35419 .endd
35420 the timestamps will be in UTC (aka GMT).
35421 .next
35422 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35423 example:
35424 .code
35425 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35426 .endd
35427 .endlist
35428
35429 .cindex "log" "process ids in"
35430 .cindex "pid (process id)" "in log lines"
35431 Exim does not include its process id in log lines by default, but you can
35432 request that it does so by specifying the &`pid`& log selector (see section
35433 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35434 brackets, immediately after the time and date.
35435
35436
35437
35438
35439 .section "Where the logs are written" "SECTwhelogwri"
35440 .cindex "log" "destination"
35441 .cindex "log" "to file"
35442 .cindex "log" "to syslog"
35443 .cindex "syslog"
35444 The logs may be written to local files, or to syslog, or both. However, it
35445 should be noted that many syslog implementations use UDP as a transport, and
35446 are therefore unreliable in the sense that messages are not guaranteed to
35447 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35448 It has also been reported that on large log files (tens of megabytes) you may
35449 need to tweak syslog to prevent it syncing the file with each write &-- on
35450 Linux this has been seen to make syslog take 90% plus of CPU time.
35451
35452 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35453 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35454 configuration. This latter string is expanded, so it can contain, for example,
35455 references to the host name:
35456 .code
35457 log_file_path = /var/log/$primary_hostname/exim_%slog
35458 .endd
35459 It is generally advisable, however, to set the string in &_Local/Makefile_&
35460 rather than at run time, because then the setting is available right from the
35461 start of Exim's execution. Otherwise, if there's something it wants to log
35462 before it has read the configuration file (for example, an error in the
35463 configuration file) it will not use the path you want, and may not be able to
35464 log at all.
35465
35466 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35467 list, currently limited to at most two items. This is one option where the
35468 facility for changing a list separator may not be used. The list must always be
35469 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35470 otherwise the item must either be an absolute path, containing &`%s`& at the
35471 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35472 implying the use of a default path.
35473
35474 When Exim encounters an empty item in the list, it searches the list defined by
35475 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35476 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35477 mean &"use the path specified at build time"&. It no such item exists, log
35478 files are written in the &_log_& subdirectory of the spool directory. This is
35479 equivalent to the setting:
35480 .code
35481 log_file_path = $spool_directory/log/%slog
35482 .endd
35483 If you do not specify anything at build time or run time,
35484 or if you unset the option at run time (i.e. &`log_file_path = `&),
35485 that is where the logs are written.
35486
35487 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35488 are in use &-- see section &<<SECTdatlogfil>>& below.
35489
35490 Here are some examples of possible settings:
35491 .display
35492 &`LOG_FILE_PATH=syslog                    `& syslog only
35493 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35494 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35495 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35496 .endd
35497 If there are more than two paths in the list, the first is used and a panic
35498 error is logged.
35499
35500
35501
35502 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35503 .cindex "log" "cycling local files"
35504 .cindex "cycling logs"
35505 .cindex "&'exicyclog'&"
35506 .cindex "log" "local files; writing to"
35507 Some operating systems provide centralized and standardized methods for cycling
35508 log files. For those that do not, a utility script called &'exicyclog'& is
35509 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35510 main and reject logs each time it is called. The maximum number of old logs to
35511 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35512
35513 An Exim delivery process opens the main log when it first needs to write to it,
35514 and it keeps the file open in case subsequent entries are required &-- for
35515 example, if a number of different deliveries are being done for the same
35516 message. However, remote SMTP deliveries can take a long time, and this means
35517 that the file may be kept open long after it is renamed if &'exicyclog'& or
35518 something similar is being used to rename log files on a regular basis. To
35519 ensure that a switch of log files is noticed as soon as possible, Exim calls
35520 &[stat()]& on the main log's name before reusing an open file, and if the file
35521 does not exist, or its inode has changed, the old file is closed and Exim
35522 tries to open the main log from scratch. Thus, an old log file may remain open
35523 for quite some time, but no Exim processes should write to it once it has been
35524 renamed.
35525
35526
35527
35528 .section "Datestamped log files" "SECTdatlogfil"
35529 .cindex "log" "datestamped files"
35530 Instead of cycling the main and reject log files by renaming them
35531 periodically, some sites like to use files whose names contain a datestamp,
35532 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35533 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35534 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35535 point where the datestamp is required. For example:
35536 .code
35537 log_file_path = /var/spool/exim/log/%slog-%D
35538 log_file_path = /var/log/exim-%s-%D.log
35539 log_file_path = /var/spool/exim/log/%D-%slog
35540 log_file_path = /var/log/exim/%s.%M
35541 .endd
35542 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35543 examples of names generated by the above examples:
35544 .code
35545 /var/spool/exim/log/mainlog-20021225
35546 /var/log/exim-reject-20021225.log
35547 /var/spool/exim/log/20021225-mainlog
35548 /var/log/exim/main.200212
35549 .endd
35550 When this form of log file is specified, Exim automatically switches to new
35551 files at midnight. It does not make any attempt to compress old logs; you
35552 will need to write your own script if you require this. You should not
35553 run &'exicyclog'& with this form of logging.
35554
35555 The location of the panic log is also determined by &%log_file_path%&, but it
35556 is not datestamped, because rotation of the panic log does not make sense.
35557 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35558 the string. In addition, if it immediately follows a slash, a following
35559 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35560 character is removed. Thus, the four examples above would give these panic
35561 log names:
35562 .code
35563 /var/spool/exim/log/paniclog
35564 /var/log/exim-panic.log
35565 /var/spool/exim/log/paniclog
35566 /var/log/exim/panic
35567 .endd
35568
35569
35570 .section "Logging to syslog" "SECID249"
35571 .cindex "log" "syslog; writing to"
35572 The use of syslog does not change what Exim logs or the format of its messages,
35573 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35574 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35575 that, the same strings are written to syslog as to log files. The syslog
35576 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35577 by default, but you can change these by setting the &%syslog_facility%& and
35578 &%syslog_processname%& options, respectively. If Exim was compiled with
35579 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35580 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35581 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35582 the time and host name to each line.
35583 The three log streams are mapped onto syslog priorities as follows:
35584
35585 .ilist
35586 &'mainlog'& is mapped to LOG_INFO
35587 .next
35588 &'rejectlog'& is mapped to LOG_NOTICE
35589 .next
35590 &'paniclog'& is mapped to LOG_ALERT
35591 .endlist
35592
35593 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35594 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35595 these are routed by syslog to the same place. You can suppress this duplication
35596 by setting &%syslog_duplication%& false.
35597
35598 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35599 entries contain multiple lines when headers are included. To cope with both
35600 these cases, entries written to syslog are split into separate &[syslog()]&
35601 calls at each internal newline, and also after a maximum of
35602 870 data characters. (This allows for a total syslog line length of 1024, when
35603 additions such as timestamps are added.) If you are running a syslog
35604 replacement that can handle lines longer than the 1024 characters allowed by
35605 RFC 3164, you should set
35606 .code
35607 SYSLOG_LONG_LINES=yes
35608 .endd
35609 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35610 lines, but it still splits at internal newlines in &'reject'& log entries.
35611
35612 To make it easy to re-assemble split lines later, each component of a split
35613 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35614 where <&'n'&> is the component number and <&'m'&> is the total number of
35615 components in the entry. The / delimiter is used when the line was split
35616 because it was too long; if it was split because of an internal newline, the \
35617 delimiter is used. For example, supposing the length limit to be 50 instead of
35618 870, the following would be the result of a typical rejection message to
35619 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35620 name, and pid as added by syslog:
35621 .code
35622 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35623 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35624 [3/5]  when scanning for sender: missing or malformed lo
35625 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35626 [5/5] mple>)
35627 .endd
35628 The same error might cause the following lines to be written to &"rejectlog"&
35629 (LOG_NOTICE):
35630 .code
35631 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35632 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35633 [3/18] er when scanning for sender: missing or malformed
35634 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35635 [5\18] .example>)
35636 [6\18] Recipients: ph10@some.domain.cam.example
35637 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35638 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35639 [9\18]        id 16RdAL-0006pc-00
35640 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35641 [11\18] 09:43 +0100
35642 [12\18] F From: <>
35643 [13\18]   Subject: this is a test header
35644 [18\18]   X-something: this is another header
35645 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35646 [16\18] le>
35647 [17\18] B Bcc:
35648 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35649 .endd
35650 Log lines that are neither too long nor contain newlines are written to syslog
35651 without modification.
35652
35653 If only syslog is being used, the Exim monitor is unable to provide a log tail
35654 display, unless syslog is routing &'mainlog'& to a file on the local host and
35655 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35656 where it is.
35657
35658
35659
35660 .section "Log line flags" "SECID250"
35661 One line is written to the main log for each message received, and for each
35662 successful, unsuccessful, and delayed delivery. These lines can readily be
35663 picked out by the distinctive two-character flags that immediately follow the
35664 timestamp. The flags are:
35665 .display
35666 &`<=`&     message arrival
35667 &`(=`&     message fakereject
35668 &`=>`&     normal message delivery
35669 &`->`&     additional address in same delivery
35670 &`>>`&     cutthrough message delivery
35671 &`*>`&     delivery suppressed by &%-N%&
35672 &`**`&     delivery failed; address bounced
35673 &`==`&     delivery deferred; temporary problem
35674 .endd
35675
35676
35677 .section "Logging message reception" "SECID251"
35678 .cindex "log" "reception line"
35679 The format of the single-line entry in the main log that is written for every
35680 message received is shown in the basic example below, which is split over
35681 several lines in order to fit it on the page:
35682 .code
35683 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35684   H=mailer.fict.example [192.168.123.123] U=exim
35685   P=smtp S=5678 id=<incoming message id>
35686 .endd
35687 The address immediately following &"<="& is the envelope sender address. A
35688 bounce message is shown with the sender address &"<>"&, and if it is locally
35689 generated, this is followed by an item of the form
35690 .code
35691 R=<message id>
35692 .endd
35693 which is a reference to the message that caused the bounce to be sent.
35694
35695 .cindex "HELO"
35696 .cindex "EHLO"
35697 For messages from other hosts, the H and U fields identify the remote host and
35698 record the RFC 1413 identity of the user that sent the message, if one was
35699 received. The number given in square brackets is the IP address of the sending
35700 host. If there is a single, unparenthesized  host name in the H field, as
35701 above, it has been verified to correspond to the IP address (see the
35702 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35703 by the remote host in the SMTP HELO or EHLO command, and has not been
35704 verified. If verification yields a different name to that given for HELO or
35705 EHLO, the verified name appears first, followed by the HELO or EHLO
35706 name in parentheses.
35707
35708 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35709 without brackets, in the HELO or EHLO command, leading to entries in
35710 the log containing text like these examples:
35711 .code
35712 H=(10.21.32.43) [192.168.8.34]
35713 H=([10.21.32.43]) [192.168.8.34]
35714 .endd
35715 This can be confusing. Only the final address in square brackets can be relied
35716 on.
35717
35718 For locally generated messages (that is, messages not received over TCP/IP),
35719 the H field is omitted, and the U field contains the login name of the caller
35720 of Exim.
35721
35722 .cindex "authentication" "logging"
35723 .cindex "AUTH" "logging"
35724 For all messages, the P field specifies the protocol used to receive the
35725 message. This is the value that is stored in &$received_protocol$&. In the case
35726 of incoming SMTP messages, the value indicates whether or not any SMTP
35727 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35728 session was encrypted, there is an additional X field that records the cipher
35729 suite that was used.
35730
35731 .cindex log protocol
35732 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35733 hosts that have authenticated themselves using the SMTP AUTH command. The first
35734 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35735 there is an additional item A= followed by the name of the authenticator that
35736 was used. If an authenticated identification was set up by the authenticator's
35737 &%server_set_id%& option, this is logged too, separated by a colon from the
35738 authenticator name.
35739
35740 .cindex "size" "of message"
35741 The id field records the existing message id, if present. The size of the
35742 received message is given by the S field. When the message is delivered,
35743 headers may be removed or added, so that the size of delivered copies of the
35744 message may not correspond with this value (and indeed may be different to each
35745 other).
35746
35747 The &%log_selector%& option can be used to request the logging of additional
35748 data when a message is received. See section &<<SECTlogselector>>& below.
35749
35750
35751
35752 .section "Logging deliveries" "SECID252"
35753 .cindex "log" "delivery line"
35754 The format of the single-line entry in the main log that is written for every
35755 delivery is shown in one of the examples below, for local and remote
35756 deliveries, respectively. Each example has been split into multiple lines in order
35757 to fit it on the page:
35758 .code
35759 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35760   <marv@hitch.fict.example> R=localuser T=local_delivery
35761 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35762   monk@holistic.fict.example R=dnslookup T=remote_smtp
35763   H=holistic.fict.example [192.168.234.234]
35764 .endd
35765 For ordinary local deliveries, the original address is given in angle brackets
35766 after the final delivery address, which might be a pipe or a file. If
35767 intermediate address(es) exist between the original and the final address, the
35768 last of these is given in parentheses after the final address. The R and T
35769 fields record the router and transport that were used to process the address.
35770
35771 If SMTP AUTH was used for the delivery there is an additional item A=
35772 followed by the name of the authenticator that was used.
35773 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35774 option, this is logged too, separated by a colon from the authenticator name.
35775
35776 If a shadow transport was run after a successful local delivery, the log line
35777 for the successful delivery has an item added on the end, of the form
35778 .display
35779 &`ST=<`&&'shadow transport name'&&`>`&
35780 .endd
35781 If the shadow transport did not succeed, the error message is put in
35782 parentheses afterwards.
35783
35784 .cindex "asterisk" "after IP address"
35785 When more than one address is included in a single delivery (for example, two
35786 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35787 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35788 down a single SMTP connection, an asterisk follows the IP address in the log
35789 lines for the second and subsequent messages.
35790 .new
35791 When two or more messages are delivered down a single TLS connection, the
35792 DNS and some TLS-related information logged for the first message delivered
35793 will not be present in the log lines for the second and subsequent messages.
35794 TLS cipher information is still available.
35795 .wen
35796
35797 .cindex "delivery" "cutthrough; logging"
35798 .cindex "cutthrough" "logging"
35799 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35800 line precedes the reception line, since cutthrough waits for a possible
35801 rejection from the destination in case it can reject the sourced item.
35802
35803 The generation of a reply message by a filter file gets logged as a
35804 &"delivery"& to the addressee, preceded by &">"&.
35805
35806 The &%log_selector%& option can be used to request the logging of additional
35807 data when a message is delivered. See section &<<SECTlogselector>>& below.
35808
35809
35810 .section "Discarded deliveries" "SECID253"
35811 .cindex "discarded messages"
35812 .cindex "message" "discarded"
35813 .cindex "delivery" "discarded; logging"
35814 When a message is discarded as a result of the command &"seen finish"& being
35815 obeyed in a filter file which generates no deliveries, a log entry of the form
35816 .code
35817 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35818   <low.club@bridge.example> R=userforward
35819 .endd
35820 is written, to record why no deliveries are logged. When a message is discarded
35821 because it is aliased to &":blackhole:"& the log line is like this:
35822 .code
35823 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35824   <hole@nowhere.example> R=blackhole_router
35825 .endd
35826
35827
35828 .section "Deferred deliveries" "SECID254"
35829 When a delivery is deferred, a line of the following form is logged:
35830 .code
35831 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35832   R=dnslookup T=smtp defer (146): Connection refused
35833 .endd
35834 In the case of remote deliveries, the error is the one that was given for the
35835 last IP address that was tried. Details of individual SMTP failures are also
35836 written to the log, so the above line would be preceded by something like
35837 .code
35838 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35839   mail1.endrest.example [192.168.239.239]: Connection refused
35840 .endd
35841 When a deferred address is skipped because its retry time has not been reached,
35842 a message is written to the log, but this can be suppressed by setting an
35843 appropriate value in &%log_selector%&.
35844
35845
35846
35847 .section "Delivery failures" "SECID255"
35848 .cindex "delivery" "failure; logging"
35849 If a delivery fails because an address cannot be routed, a line of the
35850 following form is logged:
35851 .code
35852 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35853   <jim@trek99.example>: unknown mail domain
35854 .endd
35855 If a delivery fails at transport time, the router and transport are shown, and
35856 the response from the remote host is included, as in this example:
35857 .code
35858 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35859   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35860   after pipelined RCPT TO:<ace400@pb.example>: host
35861   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35862   <ace400@pb.example>...Addressee unknown
35863 .endd
35864 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35865 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35866 disabling PIPELINING. The log lines for all forms of delivery failure are
35867 flagged with &`**`&.
35868
35869
35870
35871 .section "Fake deliveries" "SECID256"
35872 .cindex "delivery" "fake; logging"
35873 If a delivery does not actually take place because the &%-N%& option has been
35874 used to suppress it, a normal delivery line is written to the log, except that
35875 &"=>"& is replaced by &"*>"&.
35876
35877
35878
35879 .section "Completion" "SECID257"
35880 A line of the form
35881 .code
35882 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35883 .endd
35884 is written to the main log when a message is about to be removed from the spool
35885 at the end of its processing.
35886
35887
35888
35889
35890 .section "Summary of Fields in Log Lines" "SECID258"
35891 .cindex "log" "summary of fields"
35892 A summary of the field identifiers that are used in log lines is shown in
35893 the following table:
35894 .display
35895 &`A   `&        authenticator name (and optional id and sender)
35896 &`C   `&        SMTP confirmation on delivery
35897 &`    `&        command list for &"no mail in SMTP session"&
35898 &`CV  `&        certificate verification status
35899 &`D   `&        duration of &"no mail in SMTP session"&
35900 &`DN  `&        distinguished name from peer certificate
35901 &`DS  `&        DNSSEC secured lookups
35902 &`DT  `&        on &`=>`& lines: time taken for a delivery
35903 &`F   `&        sender address (on delivery lines)
35904 &`H   `&        host name and IP address
35905 &`I   `&        local interface used
35906 &`K   `&        CHUNKING extension used
35907 &`id  `&        message id for incoming message
35908 &`P   `&        on &`<=`& lines: protocol used
35909 &`    `&        on &`=>`& and &`**`& lines: return path
35910 &`PRDR`&        PRDR extension used
35911 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
35912 &`Q   `&        alternate queue name
35913 &`QT  `&        on &`=>`& lines: time spent on queue so far
35914 &`    `&        on &"Completed"& lines: time spent on queue
35915 &`R   `&        on &`<=`& lines: reference for local bounce
35916 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
35917 &`S   `&        size of message in bytes
35918 &`SNI `&        server name indication from TLS client hello
35919 &`ST  `&        shadow transport name
35920 &`T   `&        on &`<=`& lines: message subject (topic)
35921 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35922 &`U   `&        local user or RFC 1413 identity
35923 &`X   `&        TLS cipher suite
35924 .endd
35925
35926
35927 .section "Other log entries" "SECID259"
35928 Various other types of log entry are written from time to time. Most should be
35929 self-explanatory. Among the more common are:
35930
35931 .ilist
35932 .cindex "retry" "time not reached"
35933 &'retry time not reached'&&~&~An address previously suffered a temporary error
35934 during routing or local delivery, and the time to retry has not yet arrived.
35935 This message is not written to an individual message log file unless it happens
35936 during the first delivery attempt.
35937 .next
35938 &'retry time not reached for any host'&&~&~An address previously suffered
35939 temporary errors during remote delivery, and the retry time has not yet arrived
35940 for any of the hosts to which it is routed.
35941 .next
35942 .cindex "spool directory" "file locked"
35943 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35944 some other Exim process is already working on the message. This can be quite
35945 common if queue running processes are started at frequent intervals. The
35946 &'exiwhat'& utility script can be used to find out what Exim processes are
35947 doing.
35948 .next
35949 .cindex "error" "ignored"
35950 &'error ignored'&&~&~There are several circumstances that give rise to this
35951 message:
35952 .olist
35953 Exim failed to deliver a bounce message whose age was greater than
35954 &%ignore_bounce_errors_after%&. The bounce was discarded.
35955 .next
35956 A filter file set up a delivery using the &"noerror"& option, and the delivery
35957 failed. The delivery was discarded.
35958 .next
35959 A delivery set up by a router configured with
35960 . ==== As this is a nested list, any displays it contains must be indented
35961 . ==== as otherwise they are too far to the left.
35962 .code
35963     errors_to = <>
35964 .endd
35965 failed. The delivery was discarded.
35966 .endlist olist
35967 .endlist ilist
35968
35969
35970
35971
35972
35973 .section "Reducing or increasing what is logged" "SECTlogselector"
35974 .cindex "log" "selectors"
35975 By setting the &%log_selector%& global option, you can disable some of Exim's
35976 default logging, or you can request additional logging. The value of
35977 &%log_selector%& is made up of names preceded by plus or minus characters. For
35978 example:
35979 .code
35980 log_selector = +arguments -retry_defer
35981 .endd
35982 The list of optional log items is in the following table, with the default
35983 selection marked by asterisks:
35984 .display
35985 &` 8bitmime                   `&  received 8BITMIME status
35986 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35987 &` address_rewrite            `&  address rewriting
35988 &` all_parents                `&  all parents in => lines
35989 &` arguments                  `&  command line arguments
35990 &`*connection_reject          `&  connection rejections
35991 &`*delay_delivery             `&  immediate delivery delayed
35992 &` deliver_time               `&  time taken to perform delivery
35993 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35994 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35995 &` dnssec                     `&  DNSSEC secured lookups
35996 &`*etrn                       `&  ETRN commands
35997 &`*host_lookup_failed         `&  as it says
35998 &` ident_timeout              `&  timeout for ident connection
35999 &` incoming_interface         `&  local interface on <= and => lines
36000 &` incoming_port              `&  remote port on <= lines
36001 &`*lost_incoming_connection   `&  as it says (includes timeouts)
36002 &` outgoing_interface         `&  local interface on => lines
36003 &` outgoing_port              `&  add remote port to => lines
36004 &`*queue_run                  `&  start and end queue runs
36005 &` queue_time                 `&  time on queue for one recipient
36006 &` queue_time_overall         `&  time on queue for whole message
36007 &` pid                        `&  Exim process id
36008 &` proxy                      `&  proxy address on <= and => lines
36009 &` received_recipients        `&  recipients on <= lines
36010 &` received_sender            `&  sender on <= lines
36011 &`*rejected_header            `&  header contents on reject log
36012 &`*retry_defer                `&  &"retry time not reached"&
36013 &` return_path_on_delivery    `&  put return path on => and ** lines
36014 &` sender_on_delivery         `&  add sender to => lines
36015 &`*sender_verify_fail         `&  sender verification failures
36016 &`*size_reject                `&  rejection because too big
36017 &`*skip_delivery              `&  delivery skipped in a queue run
36018 &`*smtp_confirmation          `&  SMTP confirmation on => lines
36019 &` smtp_connection            `&  incoming SMTP connections
36020 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
36021 &` smtp_mailauth              `&  AUTH argument to MAIL commands
36022 &` smtp_no_mail               `&  session with no MAIL commands
36023 &` smtp_protocol_error        `&  SMTP protocol errors
36024 &` smtp_syntax_error          `&  SMTP syntax errors
36025 &` subject                    `&  contents of &'Subject:'& on <= lines
36026 &`*tls_certificate_verified   `&  certificate verification status
36027 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
36028 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
36029 &` tls_sni                    `&  TLS SNI on <= lines
36030 &` unknown_in_list            `&  DNS lookup failed in list match
36031
36032 &` all                        `&  all of the above
36033 .endd
36034 See also the &%slow_lookup_log%& main configuration option,
36035 section &<<SECID99>>&
36036
36037 More details on each of these items follows:
36038
36039 .ilist
36040 .cindex "8BITMIME"
36041 .cindex "log" "8BITMIME"
36042 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
36043 which may help in tracking down interoperability issues with ancient MTAs
36044 that are not 8bit clean.  This is added to the &"<="& line, tagged with
36045 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
36046 &`7BIT`& and &`8BITMIME`& respectively.
36047 .next
36048 .cindex "&%warn%& ACL verb" "log when skipping"
36049 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
36050 its conditions cannot be evaluated, a log line to this effect is written if
36051 this log selector is set.
36052 .next
36053 .cindex "log" "rewriting"
36054 .cindex "rewriting" "logging"
36055 &%address_rewrite%&: This applies both to global rewrites and per-transport
36056 rewrites, but not to rewrites in filters run as an unprivileged user (because
36057 such users cannot access the log).
36058 .next
36059 .cindex "log" "full parentage"
36060 &%all_parents%&: Normally only the original and final addresses are logged on
36061 delivery lines; with this selector, intermediate parents are given in
36062 parentheses between them.
36063 .next
36064 .cindex "log" "Exim arguments"
36065 .cindex "Exim arguments, logging"
36066 &%arguments%&: This causes Exim to write the arguments with which it was called
36067 to the main log, preceded by the current working directory. This is a debugging
36068 feature, added to make it easier to find out how certain MUAs call
36069 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
36070 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
36071 that are empty or that contain white space are quoted. Non-printing characters
36072 are shown as escape sequences. This facility cannot log unrecognized arguments,
36073 because the arguments are checked before the configuration file is read. The
36074 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
36075 between the caller and Exim.
36076 .next
36077 .cindex "log" "connection rejections"
36078 &%connection_reject%&: A log entry is written whenever an incoming SMTP
36079 connection is rejected, for whatever reason.
36080 .next
36081 .cindex "log" "delayed delivery"
36082 .cindex "delayed delivery, logging"
36083 &%delay_delivery%&: A log entry is written whenever a delivery process is not
36084 started for an incoming message because the load is too high or too many
36085 messages were received on one connection. Logging does not occur if no delivery
36086 process is started because &%queue_only%& is set or &%-odq%& was used.
36087 .next
36088 .cindex "log" "delivery duration"
36089 &%deliver_time%&: For each delivery, the amount of real time it has taken to
36090 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
36091 .next
36092 .cindex "log" "message size on delivery"
36093 .cindex "size" "of message"
36094 &%delivery_size%&: For each delivery, the size of message delivered is added to
36095 the &"=>"& line, tagged with S=.
36096 .next
36097 .cindex "log" "dnslist defer"
36098 .cindex "DNS list" "logging defer"
36099 .cindex "black list (DNS)"
36100 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
36101 DNS black list suffers a temporary error.
36102 .next
36103 .cindex log dnssec
36104 .cindex dnssec logging
36105 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
36106 dns lookups gave secure results a tag of DS is added.
36107 For acceptance this covers the reverse and forward lookups for host name verification.
36108 It does not cover helo-name verification.
36109 For delivery this covers the SRV, MX, A and/or AAAA lookups.
36110 .next
36111 .cindex "log" "ETRN commands"
36112 .cindex "ETRN" "logging"
36113 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
36114 is run to determine whether or not it is actually accepted. An invalid ETRN
36115 command, or one received within a message transaction is not logged by this
36116 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
36117 .next
36118 .cindex "log" "host lookup failure"
36119 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
36120 any addresses, or when a lookup of an IP address fails to find a host name, a
36121 log line is written. This logging does not apply to direct DNS lookups when
36122 routing email addresses, but it does apply to &"byname"& lookups.
36123 .next
36124 .cindex "log" "ident timeout"
36125 .cindex "RFC 1413" "logging timeout"
36126 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
36127 client's ident port times out.
36128 .next
36129 .cindex "log" "incoming interface"
36130 .cindex "log" "local interface"
36131 .cindex "log" "local address and port"
36132 .cindex "TCP/IP" "logging local address and port"
36133 .cindex "interface" "logging"
36134 &%incoming_interface%&: The interface on which a message was received is added
36135 to the &"<="& line as an IP address in square brackets, tagged by I= and
36136 followed by a colon and the port number. The local interface and port are also
36137 added to other SMTP log lines, for example &"SMTP connection from"&, to
36138 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
36139 The latter can be disabled by turning off the &%outgoing_interface%& option.
36140 .next
36141 .cindex log "incoming proxy address"
36142 .cindex proxy "logging proxy address"
36143 .cindex "TCP/IP" "logging proxy address"
36144 &%proxy%&: The internal (closest to the system running Exim) IP address
36145 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
36146 on a proxied connection
36147 or the &"=>"& line for a message delivered on a proxied connection.
36148 See &<<SECTproxyInbound>>& for more information.
36149 .next
36150 .cindex "log" "incoming remote port"
36151 .cindex "port" "logging remote"
36152 .cindex "TCP/IP" "logging incoming remote port"
36153 .vindex "&$sender_fullhost$&"
36154 .vindex "&$sender_rcvhost$&"
36155 &%incoming_port%&: The remote port number from which a message was received is
36156 added to log entries and &'Received:'& header lines, following the IP address
36157 in square brackets, and separated from it by a colon. This is implemented by
36158 changing the value that is put in the &$sender_fullhost$& and
36159 &$sender_rcvhost$& variables. Recording the remote port number has become more
36160 important with the widening use of NAT (see RFC 2505).
36161 .next
36162 .cindex "log" "dropped connection"
36163 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
36164 connection is unexpectedly dropped.
36165 .next
36166 .cindex "log" "outgoing interface"
36167 .cindex "log" "local interface"
36168 .cindex "log" "local address and port"
36169 .cindex "TCP/IP" "logging local address and port"
36170 .cindex "interface" "logging"
36171 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
36172 interface on which a message was sent is added to delivery lines as an I= tag
36173 followed by IP address in square brackets. You can disable this by turning
36174 off the &%outgoing_interface%& option.
36175 .next
36176 .cindex "log" "outgoing remote port"
36177 .cindex "port" "logging outgoint remote"
36178 .cindex "TCP/IP" "logging outgoing remote port"
36179 &%outgoing_port%&: The remote port number is added to delivery log lines (those
36180 containing => tags) following the IP address.
36181 The local port is also added if &%incoming_interface%& and
36182 &%outgoing_interface%& are both enabled.
36183 This option is not included in the default setting, because for most ordinary
36184 configurations, the remote port number is always 25 (the SMTP port), and the
36185 local port is a random ephemeral port.
36186 .next
36187 .cindex "log" "process ids in"
36188 .cindex "pid (process id)" "in log lines"
36189 &%pid%&: The current process id is added to every log line, in square brackets,
36190 immediately after the time and date.
36191 .next
36192 .cindex "log" "queue run"
36193 .cindex "queue runner" "logging"
36194 &%queue_run%&: The start and end of every queue run are logged.
36195 .next
36196 .cindex "log" "queue time"
36197 &%queue_time%&: The amount of time the message has been in the queue on the
36198 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
36199 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
36200 includes reception time as well as the delivery time for the current address.
36201 This means that it may be longer than the difference between the arrival and
36202 delivery log line times, because the arrival log line is not written until the
36203 message has been successfully received.
36204 .next
36205 &%queue_time_overall%&: The amount of time the message has been in the queue on
36206 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
36207 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
36208 message, so it includes reception time as well as the total delivery time.
36209 .next
36210 .cindex "log" "recipients"
36211 &%received_recipients%&: The recipients of a message are listed in the main log
36212 as soon as the message is received. The list appears at the end of the log line
36213 that is written when a message is received, preceded by the word &"for"&. The
36214 addresses are listed after they have been qualified, but before any rewriting
36215 has taken place.
36216 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
36217 in the list.
36218 .next
36219 .cindex "log" "sender reception"
36220 &%received_sender%&: The unrewritten original sender of a message is added to
36221 the end of the log line that records the message's arrival, after the word
36222 &"from"& (before the recipients if &%received_recipients%& is also set).
36223 .next
36224 .cindex "log" "header lines for rejection"
36225 &%rejected_header%&: If a message's header has been received at the time a
36226 rejection is written to the reject log, the complete header is added to the
36227 log. Header logging can be turned off individually for messages that are
36228 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
36229 .next
36230 .cindex "log" "retry defer"
36231 &%retry_defer%&: A log line is written if a delivery is deferred because a
36232 retry time has not yet been reached. However, this &"retry time not reached"&
36233 message is always omitted from individual message logs after the first delivery
36234 attempt.
36235 .next
36236 .cindex "log" "return path"
36237 &%return_path_on_delivery%&: The return path that is being transmitted with
36238 the message is included in delivery and bounce lines, using the tag P=.
36239 This is omitted if no delivery actually happens, for example, if routing fails,
36240 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36241 .next
36242 .cindex "log" "sender on delivery"
36243 &%sender_on_delivery%&: The message's sender address is added to every delivery
36244 and bounce line, tagged by F= (for &"from"&).
36245 This is the original sender that was received with the message; it is not
36246 necessarily the same as the outgoing return path.
36247 .next
36248 .cindex "log" "sender verify failure"
36249 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36250 gives details of a sender verification failure is not written. Log lines for
36251 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36252 detail is lost.
36253 .next
36254 .cindex "log" "size rejection"
36255 &%size_reject%&: A log line is written whenever a message is rejected because
36256 it is too big.
36257 .next
36258 .cindex "log" "frozen messages; skipped"
36259 .cindex "frozen messages" "logging skipping"
36260 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36261 queue run because it is frozen or because another process is already delivering
36262 it.
36263 .cindex "&""spool file is locked""&"
36264 The message that is written is &"spool file is locked"&.
36265 .next
36266 .cindex "log" "smtp confirmation"
36267 .cindex "SMTP" "logging confirmation"
36268 .cindex "LMTP" "logging confirmation"
36269 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36270 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36271 A number of MTAs (including Exim) return an identifying string in this
36272 response.
36273 .next
36274 .cindex "log" "SMTP connections"
36275 .cindex "SMTP" "logging connections"
36276 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36277 established or closed, unless the connection is from a host that matches
36278 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36279 only when the closure is unexpected.) This applies to connections from local
36280 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36281 dropped in the middle of a message, a log line is always written, whether or
36282 not this selector is set, but otherwise nothing is written at the start and end
36283 of connections unless this selector is enabled.
36284
36285 For TCP/IP connections to an Exim daemon, the current number of connections is
36286 included in the log message for each new connection, but note that the count is
36287 reset if the daemon is restarted.
36288 Also, because connections are closed (and the closure is logged) in
36289 subprocesses, the count may not include connections that have been closed but
36290 whose termination the daemon has not yet noticed. Thus, while it is possible to
36291 match up the opening and closing of connections in the log, the value of the
36292 logged counts may not be entirely accurate.
36293 .next
36294 .cindex "log" "SMTP transaction; incomplete"
36295 .cindex "SMTP" "logging incomplete transactions"
36296 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36297 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36298 and the message sender plus any accepted recipients are included in the log
36299 line. This can provide evidence of dictionary attacks.
36300 .next
36301 .cindex "log" "non-MAIL SMTP sessions"
36302 .cindex "MAIL" "logging session without"
36303 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36304 connection terminates without having issued a MAIL command. This includes both
36305 the case when the connection is dropped, and the case when QUIT is used. It
36306 does not include cases where the connection is rejected right at the start (by
36307 an ACL, or because there are too many connections, or whatever). These cases
36308 already have their own log lines.
36309
36310 The log line that is written contains the identity of the client in the usual
36311 way, followed by D= and a time, which records the duration of the connection.
36312 If the connection was authenticated, this fact is logged exactly as it is for
36313 an incoming message, with an A= item. If the connection was encrypted, CV=,
36314 DN=, and X= items may appear as they do for an incoming message, controlled by
36315 the same logging options.
36316
36317 Finally, if any SMTP commands were issued during the connection, a C= item
36318 is added to the line, listing the commands that were used. For example,
36319 .code
36320 C=EHLO,QUIT
36321 .endd
36322 shows that the client issued QUIT straight after EHLO. If there were fewer
36323 than 20 commands, they are all listed. If there were more than 20 commands,
36324 the last 20 are listed, preceded by &"..."&. However, with the default
36325 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36326 have been aborted before 20 non-mail commands are processed.
36327 .next
36328 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36329 colon-separated, is appended to the A= item for a message arrival or delivery
36330 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36331 was accepted or used.
36332 .next
36333 .cindex "log" "SMTP protocol error"
36334 .cindex "SMTP" "logging protocol error"
36335 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36336 encountered. Exim does not have perfect detection of all protocol errors
36337 because of transmission delays and the use of pipelining. If PIPELINING has
36338 been advertised to a client, an Exim server assumes that the client will use
36339 it, and therefore it does not count &"expected"& errors (for example, RCPT
36340 received after rejecting MAIL) as protocol errors.
36341 .next
36342 .cindex "SMTP" "logging syntax errors"
36343 .cindex "SMTP" "syntax errors; logging"
36344 .cindex "SMTP" "unknown command; logging"
36345 .cindex "log" "unknown SMTP command"
36346 .cindex "log" "SMTP syntax error"
36347 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36348 encountered. An unrecognized command is treated as a syntax error. For an
36349 external connection, the host identity is given; for an internal connection
36350 using &%-bs%& the sender identification (normally the calling user) is given.
36351 .next
36352 .cindex "log" "subject"
36353 .cindex "subject, logging"
36354 &%subject%&: The subject of the message is added to the arrival log line,
36355 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36356 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36357 specifies whether characters with values greater than 127 should be logged
36358 unchanged, or whether they should be rendered as escape sequences.
36359 .next
36360 .cindex "log" "certificate verification"
36361 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36362 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36363 verified, and &`CV=no`& if not.
36364 .next
36365 .cindex "log" "TLS cipher"
36366 .cindex "TLS" "logging cipher"
36367 &%tls_cipher%&: When a message is sent or received over an encrypted
36368 connection, the cipher suite used is added to the log line, preceded by X=.
36369 .next
36370 .cindex "log" "TLS peer DN"
36371 .cindex "TLS" "logging peer DN"
36372 &%tls_peerdn%&: When a message is sent or received over an encrypted
36373 connection, and a certificate is supplied by the remote host, the peer DN is
36374 added to the log line, preceded by DN=.
36375 .next
36376 .cindex "log" "TLS SNI"
36377 .cindex "TLS" "logging SNI"
36378 &%tls_sni%&: When a message is received over an encrypted connection, and
36379 the remote host provided the Server Name Indication extension, the SNI is
36380 added to the log line, preceded by SNI=.
36381 .next
36382 .cindex "log" "DNS failure in list"
36383 &%unknown_in_list%&: This setting causes a log entry to be written when the
36384 result of a list match is failure because a DNS lookup failed.
36385 .endlist
36386
36387
36388 .section "Message log" "SECID260"
36389 .cindex "message" "log file for"
36390 .cindex "log" "message log; description of"
36391 .cindex "&_msglog_& directory"
36392 .oindex "&%preserve_message_logs%&"
36393 In addition to the general log files, Exim writes a log file for each message
36394 that it handles. The names of these per-message logs are the message ids, and
36395 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36396 message log contains copies of the log lines that apply to the message. This
36397 makes it easier to inspect the status of an individual message without having
36398 to search the main log. A message log is deleted when processing of the message
36399 is complete, unless &%preserve_message_logs%& is set, but this should be used
36400 only with great care because they can fill up your disk very quickly.
36401
36402 On a heavily loaded system, it may be desirable to disable the use of
36403 per-message logs, in order to reduce disk I/O. This can be done by setting the
36404 &%message_logs%& option false.
36405 .ecindex IIDloggen
36406
36407
36408
36409
36410 . ////////////////////////////////////////////////////////////////////////////
36411 . ////////////////////////////////////////////////////////////////////////////
36412
36413 .chapter "Exim utilities" "CHAPutils"
36414 .scindex IIDutils "utilities"
36415 A number of utility scripts and programs are supplied with Exim and are
36416 described in this chapter. There is also the Exim Monitor, which is covered in
36417 the next chapter. The utilities described here are:
36418
36419 .itable none 0 0 3  7* left  15* left  40* left
36420 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36421   "list what Exim processes are doing"
36422 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36423 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36424 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36425 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36426                                                 various criteria"
36427 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36428 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36429   "extract statistics from the log"
36430 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36431   "check address acceptance from given IP"
36432 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36433 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36434 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36435 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36436 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36437 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36438 .endtable
36439
36440 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36441 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36442 &url(http://duncanthrax.net/exilog/) for details.
36443
36444
36445
36446
36447 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36448 .cindex "&'exiwhat'&"
36449 .cindex "process, querying"
36450 .cindex "SIGUSR1"
36451 On operating systems that can restart a system call after receiving a signal
36452 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36453 a line describing what it is doing to the file &_exim-process.info_& in the
36454 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36455 processes it can find, having first emptied the file. It then waits for one
36456 second to allow the Exim processes to react before displaying the results. In
36457 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36458 send the signal to the Exim processes, so it is normally run as root.
36459
36460 &*Warning*&: This is not an efficient process. It is intended for occasional
36461 use by system administrators. It is not sensible, for example, to set up a
36462 script that sends SIGUSR1 signals to Exim processes at short intervals.
36463
36464
36465 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36466 varies in different operating systems. Not only are different options used,
36467 but the format of the output is different. For this reason, there are some
36468 system configuration options that configure exactly how &'exiwhat'& works. If
36469 it doesn't seem to be working for you, check the following compile-time
36470 options:
36471 .display
36472 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36473 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36474 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36475 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36476 .endd
36477 An example of typical output from &'exiwhat'& is
36478 .code
36479 164 daemon: -q1h, listening on port 25
36480 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36481 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36482   [10.19.42.42] (editor@ref.example)
36483 10592 handling incoming call from [192.168.243.242]
36484 10628 accepting a local non-SMTP message
36485 .endd
36486 The first number in the output line is the process number. The third line has
36487 been split here, in order to fit it on the page.
36488
36489
36490
36491 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36492 .cindex "&'exiqgrep'&"
36493 .cindex "queue" "grepping"
36494 This utility is a Perl script contributed by Matt Hubbard. It runs
36495 .code
36496 exim -bpu
36497 .endd
36498 or (in case &*-a*& switch is specified)
36499 .code
36500 exim -bp
36501 .endd
36502 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36503 contain alternate exim configuration the queue management might be using.
36504
36505 to obtain a queue listing, and then greps the output to select messages
36506 that match given criteria. The following selection options are available:
36507
36508 .vlist
36509 .vitem &*-f*&&~<&'regex'&>
36510 Match the sender address using a case-insensitive search. The field that is
36511 tested is enclosed in angle brackets, so you can test for bounce messages with
36512 .code
36513 exiqgrep -f '^<>$'
36514 .endd
36515 .vitem &*-r*&&~<&'regex'&>
36516 Match a recipient address using a case-insensitive search. The field that is
36517 tested is not enclosed in angle brackets.
36518
36519 .vitem &*-s*&&~<&'regex'&>
36520 Match against the size field.
36521
36522 .vitem &*-y*&&~<&'seconds'&>
36523 Match messages that are younger than the given time.
36524
36525 .vitem &*-o*&&~<&'seconds'&>
36526 Match messages that are older than the given time.
36527
36528 .vitem &*-z*&
36529 Match only frozen messages.
36530
36531 .vitem &*-x*&
36532 Match only non-frozen messages.
36533 .endlist
36534
36535 The following options control the format of the output:
36536
36537 .vlist
36538 .vitem &*-c*&
36539 Display only the count of matching messages.
36540
36541 .vitem &*-l*&
36542 Long format &-- display the full message information as output by Exim. This is
36543 the default.
36544
36545 .vitem &*-i*&
36546 Display message ids only.
36547
36548 .vitem &*-b*&
36549 Brief format &-- one line per message.
36550
36551 .vitem &*-R*&
36552 Display messages in reverse order.
36553
36554 .vitem &*-a*&
36555 Include delivered recipients in queue listing.
36556 .endlist
36557
36558 There is one more option, &%-h%&, which outputs a list of options.
36559
36560
36561
36562 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36563 .cindex "&'exiqsumm'&"
36564 .cindex "queue" "summary"
36565 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36566 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36567 running a command such as
36568 .code
36569 exim -bp | exiqsumm
36570 .endd
36571 The output consists of one line for each domain that has messages waiting for
36572 it, as in the following example:
36573 .code
36574 3   2322   74m   66m  msn.com.example
36575 .endd
36576 Each line lists the number of pending deliveries for a domain, their total
36577 volume, and the length of time that the oldest and the newest messages have
36578 been waiting. Note that the number of pending deliveries is greater than the
36579 number of messages when messages have more than one recipient.
36580
36581 A summary line is output at the end. By default the output is sorted on the
36582 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36583 the output to be sorted by oldest message and by count of messages,
36584 respectively. There are also three options that split the messages for each
36585 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36586 separates frozen messages, and &%-s%& separates messages according to their
36587 sender.
36588
36589 The output of &'exim -bp'& contains the original addresses in the message, so
36590 this also applies to the output from &'exiqsumm'&. No domains from addresses
36591 generated by aliasing or forwarding are included (unless the &%one_time%&
36592 option of the &(redirect)& router has been used to convert them into &"top
36593 level"& addresses).
36594
36595
36596
36597
36598 .section "Extracting specific information from the log (exigrep)" &&&
36599          "SECTextspeinf"
36600 .cindex "&'exigrep'&"
36601 .cindex "log" "extracts; grepping for"
36602 The &'exigrep'& utility is a Perl script that searches one or more main log
36603 files for entries that match a given pattern. When it finds a match, it
36604 extracts all the log entries for the relevant message, not just those that
36605 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36606 given message, or all mail for a given user, or for a given host, for example.
36607 The input files can be in Exim log format or syslog format.
36608 If a matching log line is not associated with a specific message, it is
36609 included in &'exigrep'&'s output without any additional lines. The usage is:
36610 .display
36611 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36612 .endd
36613 If no log file names are given on the command line, the standard input is read.
36614
36615 The &%-t%& argument specifies a number of seconds. It adds an additional
36616 condition for message selection. Messages that are complete are shown only if
36617 they spent more than <&'n'&> seconds on the queue.
36618
36619 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36620 makes it case-sensitive. This may give a performance improvement when searching
36621 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36622 option; with &%-I%& they do not. In both cases it is possible to change the
36623 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36624
36625 The &%-l%& option means &"literal"&, that is, treat all characters in the
36626 pattern as standing for themselves. Otherwise the pattern must be a Perl
36627 regular expression.
36628
36629 The &%-v%& option inverts the matching condition. That is, a line is selected
36630 if it does &'not'& match the pattern.
36631
36632 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36633 that are generated as a result/response to a message that &'exigrep'& matched
36634 normally.
36635
36636 Example of &%-M%&:
36637 user_a sends a message to user_b, which generates a bounce back to user_b. If
36638 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36639 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36640 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36641 when searching for &"user_a"& will show both messages since the bounce is
36642 &"related"& to or a &"result"& of the first message that was found by the
36643 search term.
36644
36645 If the location of a &'zcat'& command is known from the definition of
36646 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36647 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36648 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36649 autodetection of some well known compression extensions.
36650
36651
36652 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36653 .cindex "&'exipick'&"
36654 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36655 lists messages from the queue according to a variety of criteria. For details
36656 of &'exipick'&'s facilities, visit the web page at
36657 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36658 the &%--help%& option.
36659
36660
36661 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36662 .cindex "log" "cycling local files"
36663 .cindex "cycling logs"
36664 .cindex "&'exicyclog'&"
36665 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36666 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36667 you are using log files with datestamps in their names (see section
36668 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36669 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36670 There are two command line options for &'exicyclog'&:
36671 .ilist
36672 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36673 default that is set when Exim is built. The default default is 10.
36674 .next
36675 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36676 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36677 overriding the script's default, which is to find the setting from Exim's
36678 configuration.
36679 .endlist
36680
36681 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36682 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36683 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36684 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36685 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36686 logs are handled similarly.
36687
36688 If the limit is greater than 99, the script uses 3-digit numbers such as
36689 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36690 to one that is greater, or &'vice versa'&, you will have to fix the names of
36691 any existing log files.
36692
36693 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36694 the end are deleted. All files with numbers greater than 01 are compressed,
36695 using a compression command which is configured by the COMPRESS_COMMAND
36696 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36697 root &%crontab%& entry of the form
36698 .code
36699 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36700 .endd
36701 assuming you have used the name &"exim"& for the Exim user. You can run
36702 &'exicyclog'& as root if you wish, but there is no need.
36703
36704
36705
36706 .section "Mail statistics (eximstats)" "SECTmailstat"
36707 .cindex "statistics"
36708 .cindex "&'eximstats'&"
36709 A Perl script called &'eximstats'& is provided for extracting statistical
36710 information from log files. The output is either plain text, or HTML.
36711 Exim log files are also supported by the &'Lire'& system produced by the
36712 LogReport Foundation &url(http://www.logreport.org).
36713
36714 The &'eximstats'& script has been hacked about quite a bit over time. The
36715 latest version is the result of some extensive revision by Steve Campbell. A
36716 lot of information is given by default, but there are options for suppressing
36717 various parts of it. Following any options, the arguments to the script are a
36718 list of files, which should be main log files. For example:
36719 .code
36720 eximstats -nr /var/spool/exim/log/mainlog.01
36721 .endd
36722 By default, &'eximstats'& extracts information about the number and volume of
36723 messages received from or delivered to various hosts. The information is sorted
36724 both by message count and by volume, and the top fifty hosts in each category
36725 are listed on the standard output. Similar information, based on email
36726 addresses or domains instead of hosts can be requested by means of various
36727 options. For messages delivered and received locally, similar statistics are
36728 also produced per user.
36729
36730 The output also includes total counts and statistics about delivery errors, and
36731 histograms showing the number of messages received and deliveries made in each
36732 hour of the day. A delivery with more than one address in its envelope (for
36733 example, an SMTP transaction with more than one RCPT command) is counted
36734 as a single delivery by &'eximstats'&.
36735
36736 Though normally more deliveries than receipts are reported (as messages may
36737 have multiple recipients), it is possible for &'eximstats'& to report more
36738 messages received than delivered, even though the queue is empty at the start
36739 and end of the period in question. If an incoming message contains no valid
36740 recipients, no deliveries are recorded for it. A bounce message is handled as
36741 an entirely separate message.
36742
36743 &'eximstats'& always outputs a grand total summary giving the volume and number
36744 of messages received and deliveries made, and the number of hosts involved in
36745 each case. It also outputs the number of messages that were delayed (that is,
36746 not completely delivered at the first attempt), and the number that had at
36747 least one address that failed.
36748
36749 The remainder of the output is in sections that can be independently disabled
36750 or modified by various options. It consists of a summary of deliveries by
36751 transport, histograms of messages received and delivered per time interval
36752 (default per hour), information about the time messages spent on the queue,
36753 a list of relayed messages, lists of the top fifty sending hosts, local
36754 senders, destination hosts, and destination local users by count and by volume,
36755 and a list of delivery errors that occurred.
36756
36757 The relay information lists messages that were actually relayed, that is, they
36758 came from a remote host and were directly delivered to some other remote host,
36759 without being processed (for example, for aliasing or forwarding) locally.
36760
36761 There are quite a few options for &'eximstats'& to control exactly what it
36762 outputs. These are documented in the Perl script itself, and can be extracted
36763 by running the command &(perldoc)& on the script. For example:
36764 .code
36765 perldoc /usr/exim/bin/eximstats
36766 .endd
36767
36768 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36769 .cindex "&'exim_checkaccess'&"
36770 .cindex "policy control" "checking access"
36771 .cindex "checking access"
36772 The &%-bh%& command line argument allows you to run a fake SMTP session with
36773 debugging output, in order to check what Exim is doing when it is applying
36774 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36775 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36776 sometimes you just want to answer the question &"Does this address have
36777 access?"& without bothering with any further details.
36778
36779 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36780 two arguments, an IP address and an email address:
36781 .code
36782 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36783 .endd
36784 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36785 given email address would be accepted in a RCPT command in a TCP/IP
36786 connection from the host with the given IP address. The output of the utility
36787 is either the word &"accepted"&, or the SMTP error response, for example:
36788 .code
36789 Rejected:
36790 550 Relay not permitted
36791 .endd
36792 When running this test, the utility uses &`<>`& as the envelope sender address
36793 for the MAIL command, but you can change this by providing additional
36794 options. These are passed directly to the Exim command. For example, to specify
36795 that the test is to be run with the sender address &'himself@there.example'&
36796 you can use:
36797 .code
36798 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36799                  -f himself@there.example
36800 .endd
36801 Note that these additional Exim command line items must be given after the two
36802 mandatory arguments.
36803
36804 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36805 while running its checks. You can run checks that include callouts by using
36806 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36807
36808
36809
36810 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36811 .cindex "DBM" "building dbm files"
36812 .cindex "building DBM files"
36813 .cindex "&'exim_dbmbuild'&"
36814 .cindex "lower casing"
36815 .cindex "binary zero" "in lookup key"
36816 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36817 the format used by the &(lsearch)& lookup (see section
36818 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36819 names as keys and the remainder of the information as data. The lower-casing
36820 can be prevented by calling the program with the &%-nolc%& option.
36821
36822 A terminating zero is included as part of the key string. This is expected by
36823 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36824 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36825 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36826 files.
36827
36828 The program requires two arguments: the name of the input file (which can be a
36829 single hyphen to indicate the standard input), and the name of the output file.
36830 It creates the output under a temporary name, and then renames it if all went
36831 well.
36832
36833 .cindex "USE_DB"
36834 If the native DB interface is in use (USE_DB is set in a compile-time
36835 configuration file &-- this is common in free versions of Unix) the two file
36836 names must be different, because in this mode the Berkeley DB functions create
36837 a single output file using exactly the name given. For example,
36838 .code
36839 exim_dbmbuild /etc/aliases /etc/aliases.db
36840 .endd
36841 reads the system alias file and creates a DBM version of it in
36842 &_/etc/aliases.db_&.
36843
36844 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36845 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36846 environment, the suffixes are added to the second argument of
36847 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36848 when the Berkeley functions are used in compatibility mode (though this is not
36849 recommended), because in that case it adds a &_.db_& suffix to the file name.
36850
36851 If a duplicate key is encountered, the program outputs a warning, and when it
36852 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36853 option is used. By default, only the first of a set of duplicates is used &--
36854 this makes it compatible with &(lsearch)& lookups. There is an option
36855 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36856 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36857 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36858 return code is 2.
36859
36860
36861
36862
36863 .section "Finding individual retry times (exinext)" "SECTfinindret"
36864 .cindex "retry" "times"
36865 .cindex "&'exinext'&"
36866 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36867 fish specific information out of the retry database. Given a mail domain (or a
36868 complete address), it looks up the hosts for that domain, and outputs any retry
36869 information for the hosts or for the domain. At present, the retry information
36870 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36871 output. For example:
36872 .code
36873 $ exinext piglet@milne.fict.example
36874 kanga.milne.example:192.168.8.1 error 146: Connection refused
36875   first failed: 21-Feb-1996 14:57:34
36876   last tried:   21-Feb-1996 14:57:34
36877   next try at:  21-Feb-1996 15:02:34
36878 roo.milne.example:192.168.8.3 error 146: Connection refused
36879   first failed: 20-Jan-1996 13:12:08
36880   last tried:   21-Feb-1996 11:42:03
36881   next try at:  21-Feb-1996 19:42:03
36882   past final cutoff time
36883 .endd
36884 You can also give &'exinext'& a local part, without a domain, and it
36885 will give any retry information for that local part in your default domain.
36886 A message id can be used to obtain retry information pertaining to a specific
36887 message. This exists only when an attempt to deliver a message to a remote host
36888 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36889 &'exinext'& is not particularly efficient, but then it is not expected to be
36890 run very often.
36891
36892 The &'exinext'& utility calls Exim to find out information such as the location
36893 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36894 passed on to the &'exim'& commands. The first specifies an alternate Exim
36895 configuration file, and the second sets macros for use within the configuration
36896 file. These features are mainly to help in testing, but might also be useful in
36897 environments where more than one configuration file is in use.
36898
36899
36900
36901 .section "Hints database maintenance" "SECThindatmai"
36902 .cindex "hints database" "maintenance"
36903 .cindex "maintaining Exim's hints database"
36904 Three utility programs are provided for maintaining the DBM files that Exim
36905 uses to contain its delivery hint information. Each program requires two
36906 arguments. The first specifies the name of Exim's spool directory, and the
36907 second is the name of the database it is to operate on. These are as follows:
36908
36909 .ilist
36910 &'retry'&: the database of retry information
36911 .next
36912 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36913 for remote hosts
36914 .next
36915 &'callout'&: the callout cache
36916 .next
36917 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36918 .next
36919 &'misc'&: other hints data
36920 .endlist
36921
36922 The &'misc'& database is used for
36923
36924 .ilist
36925 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36926 .next
36927 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36928 &(smtp)& transport)
36929 .next
36930 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36931 in a transport)
36932 .endlist
36933
36934
36935
36936 .section "exim_dumpdb" "SECID261"
36937 .cindex "&'exim_dumpdb'&"
36938 The entire contents of a database are written to the standard output by the
36939 &'exim_dumpdb'& program, which has no options or arguments other than the
36940 spool and database names. For example, to dump the retry database:
36941 .code
36942 exim_dumpdb /var/spool/exim retry
36943 .endd
36944 Two lines of output are produced for each entry:
36945 .code
36946 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36947 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36948 .endd
36949 The first item on the first line is the key of the record. It starts with one
36950 of the letters R, or T, depending on whether it refers to a routing or
36951 transport retry. For a local delivery, the next part is the local address; for
36952 a remote delivery it is the name of the remote host, followed by its failing IP
36953 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36954 transport). If the remote port is not the standard one (port 25), it is added
36955 to the IP address. Then there follows an error code, an additional error code,
36956 and a textual description of the error.
36957
36958 The three times on the second line are the time of first failure, the time of
36959 the last delivery attempt, and the computed time for the next attempt. The line
36960 ends with an asterisk if the cutoff time for the last retry rule has been
36961 exceeded.
36962
36963 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36964 consists of a host name followed by a list of ids for messages that are or were
36965 waiting to be delivered to that host. If there are a very large number for any
36966 one host, continuation records, with a sequence number added to the host name,
36967 may be seen. The data in these records is often out of date, because a message
36968 may be routed to several alternative hosts, and Exim makes no effort to keep
36969 cross-references.
36970
36971
36972
36973 .section "exim_tidydb" "SECID262"
36974 .cindex "&'exim_tidydb'&"
36975 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36976 database. If run with no options, it removes all records that are more than 30
36977 days old. The age is calculated from the date and time that the record was last
36978 updated. Note that, in the case of the retry database, it is &'not'& the time
36979 since the first delivery failure. Information about a host that has been down
36980 for more than 30 days will remain in the database, provided that the record is
36981 updated sufficiently often.
36982
36983 The cutoff date can be altered by means of the &%-t%& option, which must be
36984 followed by a time. For example, to remove all records older than a week from
36985 the retry database:
36986 .code
36987 exim_tidydb -t 7d /var/spool/exim retry
36988 .endd
36989 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36990 message ids. In the former these appear as data in records keyed by host &--
36991 they were messages that were waiting for that host &-- and in the latter they
36992 are the keys for retry information for messages that have suffered certain
36993 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36994 message ids in database records are those of messages that are still on the
36995 queue. Message ids for messages that no longer exist are removed from
36996 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36997 For the &'retry'& database, records whose keys are non-existent message ids are
36998 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36999 whenever it removes information from the database.
37000
37001 Certain records are automatically removed by Exim when they are no longer
37002 needed, but others are not. For example, if all the MX hosts for a domain are
37003 down, a retry record is created for each one. If the primary MX host comes back
37004 first, its record is removed when Exim successfully delivers to it, but the
37005 records for the others remain because Exim has not tried to use those hosts.
37006
37007 It is important, therefore, to run &'exim_tidydb'& periodically on all the
37008 hints databases. You should do this at a quiet time of day, because it requires
37009 a database to be locked (and therefore inaccessible to Exim) while it does its
37010 work. Removing records from a DBM file does not normally make the file smaller,
37011 but all the common DBM libraries are able to re-use the space that is released.
37012 After an initial phase of increasing in size, the databases normally reach a
37013 point at which they no longer get any bigger, as long as they are regularly
37014 tidied.
37015
37016 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
37017 databases is likely to keep on increasing.
37018
37019
37020
37021
37022 .section "exim_fixdb" "SECID263"
37023 .cindex "&'exim_fixdb'&"
37024 The &'exim_fixdb'& program is a utility for interactively modifying databases.
37025 Its main use is for testing Exim, but it might also be occasionally useful for
37026 getting round problems in a live system. It has no options, and its interface
37027 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
37028 key of a database record can then be entered, and the data for that record is
37029 displayed.
37030
37031 If &"d"& is typed at the next prompt, the entire record is deleted. For all
37032 except the &'retry'& database, that is the only operation that can be carried
37033 out. For the &'retry'& database, each field is output preceded by a number, and
37034 data for individual fields can be changed by typing the field number followed
37035 by new data, for example:
37036 .code
37037 > 4 951102:1000
37038 .endd
37039 resets the time of the next delivery attempt. Time values are given as a
37040 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
37041 used as optional separators.
37042
37043
37044
37045
37046 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
37047 .cindex "mailbox" "maintenance"
37048 .cindex "&'exim_lock'&"
37049 .cindex "locking mailboxes"
37050 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
37051 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
37052 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
37053 a user agent while investigating a problem. The utility requires the name of
37054 the file as its first argument. If the locking is successful, the second
37055 argument is run as a command (using C's &[system()]& function); if there is no
37056 second argument, the value of the SHELL environment variable is used; if this
37057 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
37058 is unlocked and the utility ends. The following options are available:
37059
37060 .vlist
37061 .vitem &%-fcntl%&
37062 Use &[fcntl()]& locking on the open mailbox.
37063
37064 .vitem &%-flock%&
37065 Use &[flock()]& locking on the open mailbox, provided the operating system
37066 supports it.
37067
37068 .vitem &%-interval%&
37069 This must be followed by a number, which is a number of seconds; it sets the
37070 interval to sleep between retries (default 3).
37071
37072 .vitem &%-lockfile%&
37073 Create a lock file before opening the mailbox.
37074
37075 .vitem &%-mbx%&
37076 Lock the mailbox using MBX rules.
37077
37078 .vitem &%-q%&
37079 Suppress verification output.
37080
37081 .vitem &%-retries%&
37082 This must be followed by a number; it sets the number of times to try to get
37083 the lock (default 10).
37084
37085 .vitem &%-restore_time%&
37086 This option causes &%exim_lock%& to restore the modified and read times to the
37087 locked file before exiting. This allows you to access a locked mailbox (for
37088 example, to take a backup copy) without disturbing the times that the user
37089 subsequently sees.
37090
37091 .vitem &%-timeout%&
37092 This must be followed by a number, which is a number of seconds; it sets a
37093 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
37094 default), a non-blocking call is used.
37095
37096 .vitem &%-v%&
37097 Generate verbose output.
37098 .endlist
37099
37100 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
37101 default is to create a lock file and also to use &[fcntl()]& locking on the
37102 mailbox, which is the same as Exim's default. The use of &%-flock%& or
37103 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
37104 requires that the directory containing the file be writeable. Locking by lock
37105 file does not last for ever; Exim assumes that a lock file is expired if it is
37106 more than 30 minutes old.
37107
37108 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
37109 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
37110 to be taken out on the open mailbox, and an exclusive lock on the file
37111 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
37112 number of the mailbox file. When the locking is released, if an exclusive lock
37113 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
37114
37115 The default output contains verification of the locking that takes place. The
37116 &%-v%& option causes some additional information to be given. The &%-q%& option
37117 suppresses all output except error messages.
37118
37119 A command such as
37120 .code
37121 exim_lock /var/spool/mail/spqr
37122 .endd
37123 runs an interactive shell while the file is locked, whereas
37124 .display
37125 &`exim_lock -q /var/spool/mail/spqr <<End`&
37126 <&'some commands'&>
37127 &`End`&
37128 .endd
37129 runs a specific non-interactive sequence of commands while the file is locked,
37130 suppressing all verification output. A single command can be run by a command
37131 such as
37132 .code
37133 exim_lock -q /var/spool/mail/spqr \
37134   "cp /var/spool/mail/spqr /some/where"
37135 .endd
37136 Note that if a command is supplied, it must be entirely contained within the
37137 second argument &-- hence the quotes.
37138 .ecindex IIDutils
37139
37140
37141 . ////////////////////////////////////////////////////////////////////////////
37142 . ////////////////////////////////////////////////////////////////////////////
37143
37144 .chapter "The Exim monitor" "CHAPeximon"
37145 .scindex IIDeximon "Exim monitor" "description"
37146 .cindex "X-windows"
37147 .cindex "&'eximon'&"
37148 .cindex "Local/eximon.conf"
37149 .cindex "&_exim_monitor/EDITME_&"
37150 The Exim monitor is an application which displays in an X window information
37151 about the state of Exim's queue and what Exim is doing. An admin user can
37152 perform certain operations on messages from this GUI interface; however all
37153 such facilities are also available from the command line, and indeed, the
37154 monitor itself makes use of the command line to perform any actions requested.
37155
37156
37157
37158 .section "Running the monitor" "SECID264"
37159 The monitor is started by running the script called &'eximon'&. This is a shell
37160 script that sets up a number of environment variables, and then runs the
37161 binary called &_eximon.bin_&. The default appearance of the monitor window can
37162 be changed by editing the &_Local/eximon.conf_& file created by editing
37163 &_exim_monitor/EDITME_&. Comments in that file describe what the various
37164 parameters are for.
37165
37166 The parameters that get built into the &'eximon'& script can be overridden for
37167 a particular invocation by setting up environment variables of the same names,
37168 preceded by &`EXIMON_`&. For example, a shell command such as
37169 .code
37170 EXIMON_LOG_DEPTH=400 eximon
37171 .endd
37172 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
37173 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
37174 overrides the Exim log file configuration. This makes it possible to have
37175 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
37176 syslog messages are routed to a file on the local host.
37177
37178 X resources can be used to change the appearance of the window in the normal
37179 way. For example, a resource setting of the form
37180 .code
37181 Eximon*background: gray94
37182 .endd
37183 changes the colour of the background to light grey rather than white. The
37184 stripcharts are drawn with both the data lines and the reference lines in
37185 black. This means that the reference lines are not visible when on top of the
37186 data. However, their colour can be changed by setting a resource called
37187 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
37188 For example, if your X server is running Unix, you could set up lighter
37189 reference lines in the stripcharts by obeying
37190 .code
37191 xrdb -merge <<End
37192 Eximon*highlight: gray
37193 End
37194 .endd
37195 .cindex "admin user"
37196 In order to see the contents of messages on the queue, and to operate on them,
37197 &'eximon'& must either be run as root or by an admin user.
37198
37199 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
37200 contain X11 resource parameters interpreted by the X11 library.  In addition,
37201 if the first parameter starts with the string "gdb" then it is removed and the
37202 binary is invoked under gdb (the parameter is used as the gdb command-name, so
37203 versioned variants of gdb can be invoked).
37204
37205 The monitor's window is divided into three parts. The first contains one or
37206 more stripcharts and two action buttons, the second contains a &"tail"& of the
37207 main log file, and the third is a display of the queue of messages awaiting
37208 delivery, with two more action buttons. The following sections describe these
37209 different parts of the display.
37210
37211
37212
37213
37214 .section "The stripcharts" "SECID265"
37215 .cindex "stripchart"
37216 The first stripchart is always a count of messages on the queue. Its name can
37217 be configured by setting QUEUE_STRIPCHART_NAME in the
37218 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
37219 configuration script by regular expression matches on log file entries, making
37220 it possible to display, for example, counts of messages delivered to certain
37221 hosts or using certain transports. The supplied defaults display counts of
37222 received and delivered messages, and of local and SMTP deliveries. The default
37223 period between stripchart updates is one minute; this can be adjusted by a
37224 parameter in the &_Local/eximon.conf_& file.
37225
37226 The stripchart displays rescale themselves automatically as the value they are
37227 displaying changes. There are always 10 horizontal lines in each chart; the
37228 title string indicates the value of each division when it is greater than one.
37229 For example, &"x2"& means that each division represents a value of 2.
37230
37231 It is also possible to have a stripchart which shows the percentage fullness of
37232 a particular disk partition, which is useful when local deliveries are confined
37233 to a single partition.
37234
37235 .cindex "&%statvfs%& function"
37236 This relies on the availability of the &[statvfs()]& function or equivalent in
37237 the operating system. Most, but not all versions of Unix that support Exim have
37238 this. For this particular stripchart, the top of the chart always represents
37239 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37240 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37241 &_Local/eximon.conf_& file.
37242
37243
37244
37245
37246 .section "Main action buttons" "SECID266"
37247 .cindex "size" "of monitor window"
37248 .cindex "Exim monitor" "window size"
37249 .cindex "window size"
37250 Below the stripcharts there is an action button for quitting the monitor. Next
37251 to this is another button marked &"Size"&. They are placed here so that
37252 shrinking the window to its default minimum size leaves just the queue count
37253 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37254 the window to expand to its maximum size, unless it is already at the maximum,
37255 in which case it is reduced to its minimum.
37256
37257 When expanding to the maximum, if the window cannot be fully seen where it
37258 currently is, it is moved back to where it was the last time it was at full
37259 size. When it is expanding from its minimum size, the old position is
37260 remembered, and next time it is reduced to the minimum it is moved back there.
37261
37262 The idea is that you can keep a reduced window just showing one or two
37263 stripcharts at a convenient place on your screen, easily expand it to show
37264 the full window when required, and just as easily put it back to what it was.
37265 The idea is copied from what the &'twm'& window manager does for its
37266 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37267 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37268
37269 Normally, the monitor starts up with the window at its full size, but it can be
37270 built so that it starts up with the window at its smallest size, by setting
37271 START_SMALL=yes in &_Local/eximon.conf_&.
37272
37273
37274
37275 .section "The log display" "SECID267"
37276 .cindex "log" "tail of; in monitor"
37277 The second section of the window is an area in which a display of the tail of
37278 the main log is maintained.
37279 To save space on the screen, the timestamp on each log line is shortened by
37280 removing the date and, if &%log_timezone%& is set, the timezone.
37281 The log tail is not available when the only destination for logging data is
37282 syslog, unless the syslog lines are routed to a local file whose name is passed
37283 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37284
37285 The log sub-window has a scroll bar at its lefthand side which can be used to
37286 move back to look at earlier text, and the up and down arrow keys also have a
37287 scrolling effect. The amount of log that is kept depends on the setting of
37288 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37289 to use. When this is full, the earlier 50% of data is discarded &-- this is
37290 much more efficient than throwing it away line by line. The sub-window also has
37291 a horizontal scroll bar for accessing the ends of long log lines. This is the
37292 only means of horizontal scrolling; the right and left arrow keys are not
37293 available. Text can be cut from this part of the window using the mouse in the
37294 normal way. The size of this subwindow is controlled by parameters in the
37295 configuration file &_Local/eximon.conf_&.
37296
37297 Searches of the text in the log window can be carried out by means of the ^R
37298 and ^S keystrokes, which default to a reverse and a forward search,
37299 respectively. The search covers only the text that is displayed in the window.
37300 It cannot go further back up the log.
37301
37302 The point from which the search starts is indicated by a caret marker. This is
37303 normally at the end of the text in the window, but can be positioned explicitly
37304 by pointing and clicking with the left mouse button, and is moved automatically
37305 by a successful search. If new text arrives in the window when it is scrolled
37306 back, the caret remains where it is, but if the window is not scrolled back,
37307 the caret is moved to the end of the new text.
37308
37309 Pressing ^R or ^S pops up a window into which the search text can be typed.
37310 There are buttons for selecting forward or reverse searching, for carrying out
37311 the search, and for cancelling. If the &"Search"& button is pressed, the search
37312 happens and the window remains so that further searches can be done. If the
37313 &"Return"& key is pressed, a single search is done and the window is closed. If
37314 ^C is typed the search is cancelled.
37315
37316 The searching facility is implemented using the facilities of the Athena text
37317 widget. By default this pops up a window containing both &"search"& and
37318 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37319 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37320 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37321 provided version of &%TextPop%& when the remaining parts of the text widget
37322 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37323 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37324 on these systems, at the expense of having unwanted items in the search popup
37325 window.
37326
37327
37328
37329 .section "The queue display" "SECID268"
37330 .cindex "queue" "display in monitor"
37331 The bottom section of the monitor window contains a list of all messages that
37332 are on the queue, which includes those currently being received or delivered,
37333 as well as those awaiting delivery. The size of this subwindow is controlled by
37334 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37335 at which it is updated is controlled by another parameter in the same file &--
37336 the default is 5 minutes, since queue scans can be quite expensive. However,
37337 there is an &"Update"& action button just above the display which can be used
37338 to force an update of the queue display at any time.
37339
37340 When a host is down for some time, a lot of pending mail can build up for it,
37341 and this can make it hard to deal with other messages on the queue. To help
37342 with this situation there is a button next to &"Update"& called &"Hide"&. If
37343 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37344 type anything in here and press &"Return"&, the text is added to a chain of
37345 such texts, and if every undelivered address in a message matches at least one
37346 of the texts, the message is not displayed.
37347
37348 If there is an address that does not match any of the texts, all the addresses
37349 are displayed as normal. The matching happens on the ends of addresses so, for
37350 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37351 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37352 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37353 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37354 a hide request is automatically cancelled after one hour.
37355
37356 While the dialogue box is displayed, you can't press any buttons or do anything
37357 else to the monitor window. For this reason, if you want to cut text from the
37358 queue display to use in the dialogue box, you have to do the cutting before
37359 pressing the &"Hide"& button.
37360
37361 The queue display contains, for each unhidden queued message, the length of
37362 time it has been on the queue, the size of the message, the message id, the
37363 message sender, and the first undelivered recipient, all on one line. If it is
37364 a bounce message, the sender is shown as &"<>"&. If there is more than one
37365 recipient to which the message has not yet been delivered, subsequent ones are
37366 listed on additional lines, up to a maximum configured number, following which
37367 an ellipsis is displayed. Recipients that have already received the message are
37368 not shown.
37369
37370 .cindex "frozen messages" "display"
37371 If a message is frozen, an asterisk is displayed at the left-hand side.
37372
37373 The queue display has a vertical scroll bar, and can also be scrolled by means
37374 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37375 The text searching facilities, as described above for the log window, are also
37376 available, but the caret is always moved to the end of the text when the queue
37377 display is updated.
37378
37379
37380
37381 .section "The queue menu" "SECID269"
37382 .cindex "queue" "menu in monitor"
37383 If the &%shift%& key is held down and the left button is clicked when the mouse
37384 pointer is over the text for any message, an action menu pops up, and the first
37385 line of the queue display for the message is highlighted. This does not affect
37386 any selected text.
37387
37388 If you want to use some other event for popping up the menu, you can set the
37389 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37390 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37391 value set in this parameter is a standard X event description. For example, to
37392 run eximon using &%ctrl%& rather than &%shift%& you could use
37393 .code
37394 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37395 .endd
37396 The title of the menu is the message id, and it contains entries which act as
37397 follows:
37398
37399 .ilist
37400 &'message log'&: The contents of the message log for the message are displayed
37401 in a new text window.
37402 .next
37403 &'headers'&: Information from the spool file that contains the envelope
37404 information and headers is displayed in a new text window. See chapter
37405 &<<CHAPspool>>& for a description of the format of spool files.
37406 .next
37407 &'body'&: The contents of the spool file containing the body of the message are
37408 displayed in a new text window. There is a default limit of 20,000 bytes to the
37409 amount of data displayed. This can be changed by setting the BODY_MAX
37410 option at compile time, or the EXIMON_BODY_MAX option at run time.
37411 .next
37412 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37413 delivery of the message. This causes an automatic thaw if the message is
37414 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37415 a new text window. The delivery is run in a separate process, to avoid holding
37416 up the monitor while the delivery proceeds.
37417 .next
37418 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37419 that the message be frozen.
37420 .next
37421 .cindex "thawing messages"
37422 .cindex "unfreezing messages"
37423 .cindex "frozen messages" "thawing"
37424 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37425 that the message be thawed.
37426 .next
37427 .cindex "delivery" "forcing failure"
37428 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37429 that Exim gives up trying to deliver the message. A bounce message is generated
37430 for any remaining undelivered addresses.
37431 .next
37432 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37433 that the message be deleted from the system without generating a bounce
37434 message.
37435 .next
37436 &'add recipient'&: A dialog box is displayed into which a recipient address can
37437 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37438 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37439 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37440 causes a call to Exim to be made using the &%-Mar%& option to request that an
37441 additional recipient be added to the message, unless the entry box is empty, in
37442 which case no action is taken.
37443 .next
37444 &'mark delivered'&: A dialog box is displayed into which a recipient address
37445 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37446 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37447 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37448 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37449 recipient address as already delivered, unless the entry box is empty, in which
37450 case no action is taken.
37451 .next
37452 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37453 mark all recipient addresses as already delivered.
37454 .next
37455 &'edit sender'&: A dialog box is displayed initialized with the current
37456 sender's address. Pressing RETURN causes a call to Exim to be made using the
37457 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37458 in which case no action is taken. If you want to set an empty sender (as in
37459 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37460 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37461 the address is qualified with that domain.
37462 .endlist
37463
37464 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37465 other cases when a call to Exim is made, if there is any output from Exim (in
37466 particular, if the command fails) a window containing the command and the
37467 output is displayed. Otherwise, the results of the action are normally apparent
37468 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37469 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37470 if no output is generated.
37471
37472 The queue display is automatically updated for actions such as freezing and
37473 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37474 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37475 force an update of the display after one of these actions.
37476
37477 In any text window that is displayed as result of a menu action, the normal
37478 cut-and-paste facility is available, and searching can be carried out using ^R
37479 and ^S, as described above for the log tail window.
37480 .ecindex IIDeximon
37481
37482
37483
37484
37485
37486 . ////////////////////////////////////////////////////////////////////////////
37487 . ////////////////////////////////////////////////////////////////////////////
37488
37489 .chapter "Security considerations" "CHAPsecurity"
37490 .scindex IIDsecurcon "security" "discussion of"
37491 This chapter discusses a number of issues concerned with security, some of
37492 which are also covered in other parts of this manual.
37493
37494 For reasons that this author does not understand, some people have promoted
37495 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37496 existence of this chapter in the documentation. However, the intent of the
37497 chapter is simply to describe the way Exim works in relation to certain
37498 security concerns, not to make any specific claims about the effectiveness of
37499 its security as compared with other MTAs.
37500
37501 What follows is a description of the way Exim is supposed to be. Best efforts
37502 have been made to try to ensure that the code agrees with the theory, but an
37503 absence of bugs can never be guaranteed. Any that are reported will get fixed
37504 as soon as possible.
37505
37506
37507 .section "Building a more &""hardened""& Exim" "SECID286"
37508 .cindex "security" "build-time features"
37509 There are a number of build-time options that can be set in &_Local/Makefile_&
37510 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37511 Exim administrator who does not have the root password, or by someone who has
37512 penetrated the Exim (but not the root) account. These options are as follows:
37513
37514 .ilist
37515 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37516 start of any file names used with the &%-C%& option. When it is set, these file
37517 names are also not allowed to contain the sequence &"/../"&. (However, if the
37518 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37519 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37520 default setting for &%ALT_CONFIG_PREFIX%&.
37521
37522 If the permitted configuration files are confined to a directory to
37523 which only root has access, this guards against someone who has broken
37524 into the Exim account from running a privileged Exim with an arbitrary
37525 configuration file, and using it to break into other accounts.
37526 .next
37527
37528 If a non-trusted configuration file (i.e. not the default configuration file
37529 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37530 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37531 the next item), then root privilege is retained only if the caller of Exim is
37532 root. This locks out the possibility of testing a configuration using &%-C%&
37533 right through message reception and delivery, even if the caller is root. The
37534 reception works, but by that time, Exim is running as the Exim user, so when
37535 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37536 privilege to be lost. However, root can test reception and delivery using two
37537 separate commands.
37538
37539 .next
37540 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37541 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37542 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37543 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37544 the restrictive side.  Requiring build-time selection of safe macros is onerous
37545 but this option is intended solely as a transition mechanism to permit
37546 previously-working configurations to continue to work after release 4.73.
37547 .next
37548 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37549 is disabled.
37550 .next
37551 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37552 never to be used for any deliveries. This is like the &%never_users%& runtime
37553 option, but it cannot be overridden; the runtime option adds additional users
37554 to the list. The default setting is &"root"&; this prevents a non-root user who
37555 is permitted to modify the runtime file from using Exim as a way to get root.
37556 .endlist
37557
37558
37559
37560 .section "Root privilege" "SECID270"
37561 .cindex "setuid"
37562 .cindex "root privilege"
37563 The Exim binary is normally setuid to root, which means that it gains root
37564 privilege (runs as root) when it starts execution. In some special cases (for
37565 example, when the daemon is not in use and there are no local deliveries), it
37566 may be possible to run Exim setuid to some user other than root. This is
37567 discussed in the next section. However, in most installations, root privilege
37568 is required for two things:
37569
37570 .ilist
37571 To set up a socket connected to the standard SMTP port (25) when initialising
37572 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37573 not required.
37574 .next
37575 To be able to change uid and gid in order to read users' &_.forward_& files and
37576 perform local deliveries as the receiving user or as specified in the
37577 configuration.
37578 .endlist
37579
37580 It is not necessary to be root to do any of the other things Exim does, such as
37581 receiving messages and delivering them externally over SMTP, and it is
37582 obviously more secure if Exim does not run as root except when necessary.
37583 For this reason, a user and group for Exim to use must be defined in
37584 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37585 group"&. Their values can be changed by the run time configuration, though this
37586 is not recommended. Often a user called &'exim'& is used, but some sites use
37587 &'mail'& or another user name altogether.
37588
37589 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37590 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37591 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37592
37593 After a new Exim process has interpreted its command line options, it changes
37594 uid and gid in the following cases:
37595
37596 .ilist
37597 .oindex "&%-C%&"
37598 .oindex "&%-D%&"
37599 If the &%-C%& option is used to specify an alternate configuration file, or if
37600 the &%-D%& option is used to define macro values for the configuration, and the
37601 calling process is not running as root, the uid and gid are changed to those of
37602 the calling process.
37603 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37604 option may not be used at all.
37605 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37606 can be supplied if the calling process is running as root, the Exim run-time
37607 user or CONFIGURE_OWNER, if defined.
37608 .next
37609 .oindex "&%-be%&"
37610 .oindex "&%-bf%&"
37611 .oindex "&%-bF%&"
37612 If the expansion test option (&%-be%&) or one of the filter testing options
37613 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37614 calling process.
37615 .next
37616 If the process is not a daemon process or a queue runner process or a delivery
37617 process or a process for testing address routing (started with &%-bt%&), the
37618 uid and gid are changed to the Exim user and group. This means that Exim always
37619 runs under its own uid and gid when receiving messages. This also applies when
37620 testing address verification
37621 .oindex "&%-bv%&"
37622 .oindex "&%-bh%&"
37623 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37624 option).
37625 .next
37626 For a daemon, queue runner, delivery, or address testing process, the uid
37627 remains as root at this stage, but the gid is changed to the Exim group.
37628 .endlist
37629
37630 The processes that initially retain root privilege behave as follows:
37631
37632 .ilist
37633 A daemon process changes the gid to the Exim group and the uid to the Exim
37634 user after setting up one or more listening sockets. The &[initgroups()]&
37635 function is called, so that if the Exim user is in any additional groups, they
37636 will be used during message reception.
37637 .next
37638 A queue runner process retains root privilege throughout its execution. Its
37639 job is to fork a controlled sequence of delivery processes.
37640 .next
37641 A delivery process retains root privilege throughout most of its execution,
37642 but any actual deliveries (that is, the transports themselves) are run in
37643 subprocesses which always change to a non-root uid and gid. For local
37644 deliveries this is typically the uid and gid of the owner of the mailbox; for
37645 remote deliveries, the Exim uid and gid are used. Once all the delivery
37646 subprocesses have been run, a delivery process changes to the Exim uid and gid
37647 while doing post-delivery tidying up such as updating the retry database and
37648 generating bounce and warning messages.
37649
37650 While the recipient addresses in a message are being routed, the delivery
37651 process runs as root. However, if a user's filter file has to be processed,
37652 this is done in a subprocess that runs under the individual user's uid and
37653 gid. A system filter is run as root unless &%system_filter_user%& is set.
37654 .next
37655 A process that is testing addresses (the &%-bt%& option) runs as root so that
37656 the routing is done in the same environment as a message delivery.
37657 .endlist
37658
37659
37660
37661
37662 .section "Running Exim without privilege" "SECTrunexiwitpri"
37663 .cindex "privilege, running without"
37664 .cindex "unprivileged running"
37665 .cindex "root privilege" "running without"
37666 Some installations like to run Exim in an unprivileged state for more of its
37667 operation, for added security. Support for this mode of operation is provided
37668 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37669 gid are changed to the Exim user and group at the start of a delivery process
37670 (and also queue runner and address testing processes). This means that address
37671 routing is no longer run as root, and the deliveries themselves cannot change
37672 to any other uid.
37673
37674 .cindex SIGHUP
37675 .cindex "daemon" "restarting"
37676 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37677 that the daemon can still be started in the usual way, and it can respond
37678 correctly to SIGHUP because the re-invocation regains root privilege.
37679
37680 An alternative approach is to make Exim setuid to the Exim user and also setgid
37681 to the Exim group. If you do this, the daemon must be started from a root
37682 process. (Calling Exim from a root process makes it behave in the way it does
37683 when it is setuid root.) However, the daemon cannot restart itself after a
37684 SIGHUP signal because it cannot regain privilege.
37685
37686 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37687 stops Exim from trying to re-invoke itself to do a delivery after a message has
37688 been received. Such a re-invocation is a waste of resources because it has no
37689 effect.
37690
37691 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37692 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37693 to the Exim user seems a clean approach, but there is one complication:
37694
37695 In this style of operation, Exim is running with the real uid and gid set to
37696 those of the calling process, and the effective uid/gid set to Exim's values.
37697 Ideally, any association with the calling process' uid/gid should be dropped,
37698 that is, the real uid/gid should be reset to the effective values so as to
37699 discard any privileges that the caller may have. While some operating systems
37700 have a function that permits this action for a non-root effective uid, quite a
37701 number of them do not. Because of this lack of standardization, Exim does not
37702 address this problem at this time.
37703
37704 For this reason, the recommended approach for &"mostly unprivileged"& running
37705 is to keep the Exim binary setuid to root, and to set
37706 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37707 be used in the most straightforward way.
37708
37709 If you configure Exim not to run delivery processes as root, there are a
37710 number of restrictions on what you can do:
37711
37712 .ilist
37713 You can deliver only as the Exim user/group. You should  explicitly use the
37714 &%user%& and &%group%& options to override routers or local transports that
37715 normally deliver as the recipient. This makes sure that configurations that
37716 work in this mode function the same way in normal mode. Any implicit or
37717 explicit specification of another user causes an error.
37718 .next
37719 Use of &_.forward_& files is severely restricted, such that it is usually
37720 not worthwhile to include them in the configuration.
37721 .next
37722 Users who wish to use &_.forward_& would have to make their home directory and
37723 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37724 and their equivalents in Exim filters, cannot be used. While they could be
37725 enabled in the Exim user's name, that would be insecure and not very useful.
37726 .next
37727 Unless the local user mailboxes are all owned by the Exim user (possible in
37728 some POP3 or IMAP-only environments):
37729
37730 .olist
37731 They must be owned by the Exim group and be writeable by that group. This
37732 implies you must set &%mode%& in the appendfile configuration, as well as the
37733 mode of the mailbox files themselves.
37734 .next
37735 You must set &%no_check_owner%&, since most or all of the files will not be
37736 owned by the Exim user.
37737 .next
37738 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37739 on a newly created mailbox when unprivileged. This also implies that new
37740 mailboxes need to be created manually.
37741 .endlist olist
37742 .endlist ilist
37743
37744
37745 These restrictions severely restrict what can be done in local deliveries.
37746 However, there are no restrictions on remote deliveries. If you are running a
37747 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37748 gives more security at essentially no cost.
37749
37750 If you are using the &%mua_wrapper%& facility (see chapter
37751 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37752
37753
37754
37755
37756 .section "Delivering to local files" "SECID271"
37757 Full details of the checks applied by &(appendfile)& before it writes to a file
37758 are given in chapter &<<CHAPappendfile>>&.
37759
37760
37761
37762 .section "Running local commands" "SECTsecconslocalcmds"
37763 .cindex "security" "local commands"
37764 .cindex "security" "command injection attacks"
37765 There are a number of ways in which an administrator can configure Exim to run
37766 commands based upon received, untrustworthy, data. Further, in some
37767 configurations a user who can control a &_.forward_& file can also arrange to
37768 run commands. Configuration to check includes, but is not limited to:
37769
37770 .ilist
37771 Use of &%use_shell%& in the pipe transport: various forms of shell command
37772 injection may be possible with this option present. It is dangerous and should
37773 be used only with considerable caution. Consider constraints which whitelist
37774 allowed characters in a variable which is to be used in a pipe transport that
37775 has &%use_shell%& enabled.
37776 .next
37777 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37778 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37779 &_.forward_& files in a redirect router. If Exim is running on a central mail
37780 hub to which ordinary users do not have shell access, but home directories are
37781 NFS mounted (for instance) then administrators should review the list of these
37782 forbid options available, and should bear in mind that the options that may
37783 need forbidding can change as new features are added between releases.
37784 .next
37785 The &%${run...}%& expansion item does not use a shell by default, but
37786 administrators can configure use of &_/bin/sh_& as part of the command.
37787 Such invocations should be viewed with prejudicial suspicion.
37788 .next
37789 Administrators who use embedded Perl are advised to explore how Perl's
37790 taint checking might apply to their usage.
37791 .next
37792 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37793 administrators are well advised to view its use with suspicion, in case (for
37794 instance) it allows a local-part to contain embedded Exim directives.
37795 .next
37796 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37797 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37798 each can reference arbitrary lists and files, rather than just being a list
37799 of opaque strings.
37800 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37801 real-world security vulnerabilities caused by its use with untrustworthy data
37802 injected in, for SQL injection attacks.
37803 Consider the use of the &%inlisti%& expansion condition instead.
37804 .endlist
37805
37806
37807
37808
37809 .section "Trust in configuration data" "SECTsecconfdata"
37810 .cindex "security" "data sources"
37811 .cindex "security" "regular expressions"
37812 .cindex "regular expressions" "security"
37813 .cindex "PCRE" "security"
37814 If configuration data for Exim can come from untrustworthy sources, there
37815 are some issues to be aware of:
37816
37817 .ilist
37818 Use of &%${expand...}%& may provide a path for shell injection attacks.
37819 .next
37820 Letting untrusted data provide a regular expression is unwise.
37821 .next
37822 Using &%${match...}%& to apply a fixed regular expression against untrusted
37823 data may result in pathological behaviour within PCRE.  Be aware of what
37824 "backtracking" means and consider options for being more strict with a regular
37825 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37826 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37827 possessive quantifiers or just not using regular expressions against untrusted
37828 data.
37829 .next
37830 It can be important to correctly use &%${quote:...}%&,
37831 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37832 items to ensure that data is correctly constructed.
37833 .next
37834 Some lookups might return multiple results, even though normal usage is only
37835 expected to yield one result.
37836 .endlist
37837
37838
37839
37840
37841 .section "IPv4 source routing" "SECID272"
37842 .cindex "source routing" "in IP packets"
37843 .cindex "IP source routing"
37844 Many operating systems suppress IP source-routed packets in the kernel, but
37845 some cannot be made to do this, so Exim does its own check. It logs incoming
37846 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37847 IPv6. No special checking is currently done.
37848
37849
37850
37851 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37852 Support for these SMTP commands is disabled by default. If required, they can
37853 be enabled by defining suitable ACLs.
37854
37855
37856
37857
37858 .section "Privileged users" "SECID274"
37859 .cindex "trusted users"
37860 .cindex "admin user"
37861 .cindex "privileged user"
37862 .cindex "user" "trusted"
37863 .cindex "user" "admin"
37864 Exim recognizes two sets of users with special privileges. Trusted users are
37865 able to submit new messages to Exim locally, but supply their own sender
37866 addresses and information about a sending host. For other users submitting
37867 local messages, Exim sets up the sender address from the uid, and doesn't
37868 permit a remote host to be specified.
37869
37870 .oindex "&%-f%&"
37871 However, an untrusted user is permitted to use the &%-f%& command line option
37872 in the special form &%-f <>%& to indicate that a delivery failure for the
37873 message should not cause an error report. This affects the message's envelope,
37874 but it does not affect the &'Sender:'& header. Untrusted users may also be
37875 permitted to use specific forms of address with the &%-f%& option by setting
37876 the &%untrusted_set_sender%& option.
37877
37878 Trusted users are used to run processes that receive mail messages from some
37879 other mail domain and pass them on to Exim for delivery either locally, or over
37880 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37881 as any user listed in the &%trusted_users%& configuration option, or under any
37882 group listed in the &%trusted_groups%& option.
37883
37884 Admin users are permitted to do things to the messages on Exim's queue. They
37885 can freeze or thaw messages, cause them to be returned to their senders, remove
37886 them entirely, or modify them in various ways. In addition, admin users can run
37887 the Exim monitor and see all the information it is capable of providing, which
37888 includes the contents of files on the spool.
37889
37890 .oindex "&%-M%&"
37891 .oindex "&%-q%&"
37892 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37893 delivery of messages on its queue is restricted to admin users. This
37894 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37895 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37896 queue is also restricted to admin users. This restriction can be relaxed by
37897 setting &%no_queue_list_requires_admin%&.
37898
37899 Exim recognizes an admin user if the calling process is running as root or as
37900 the Exim user or if any of the groups associated with the calling process is
37901 the Exim group. It is not necessary actually to be running under the Exim
37902 group. However, if admin users who are not root or the Exim user are to access
37903 the contents of files on the spool via the Exim monitor (which runs
37904 unprivileged), Exim must be built to allow group read access to its spool
37905 files.
37906
37907
37908
37909 .section "Spool files" "SECID275"
37910 .cindex "spool directory" "files"
37911 Exim's spool directory and everything it contains is owned by the Exim user and
37912 set to the Exim group. The mode for spool files is defined in the
37913 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37914 any user who is a member of the Exim group can access these files.
37915
37916
37917
37918 .section "Use of argv[0]" "SECID276"
37919 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37920 of specific strings, Exim assumes certain options. For example, calling Exim
37921 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37922 to calling it with the option &%-bS%&. There are no security implications in
37923 this.
37924
37925
37926
37927 .section "Use of %f formatting" "SECID277"
37928 The only use made of &"%f"& by Exim is in formatting load average values. These
37929 are actually stored in integer variables as 1000 times the load average.
37930 Consequently, their range is limited and so therefore is the length of the
37931 converted output.
37932
37933
37934
37935 .section "Embedded Exim path" "SECID278"
37936 Exim uses its own path name, which is embedded in the code, only when it needs
37937 to re-exec in order to regain root privilege. Therefore, it is not root when it
37938 does so. If some bug allowed the path to get overwritten, it would lead to an
37939 arbitrary program's being run as exim, not as root.
37940
37941
37942
37943 .section "Dynamic module directory" "SECTdynmoddir"
37944 Any dynamically loadable modules must be installed into the directory
37945 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37946 loading it.
37947
37948
37949 .section "Use of sprintf()" "SECID279"
37950 .cindex "&[sprintf()]&"
37951 A large number of occurrences of &"sprintf"& in the code are actually calls to
37952 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37953 The intermediate formatting is done into a large fixed buffer by a function
37954 that runs through the format string itself, and checks the length of each
37955 conversion before performing it, thus preventing buffer overruns.
37956
37957 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37958 the output buffer is known to be sufficiently long to contain the converted
37959 string.
37960
37961
37962
37963 .section "Use of debug_printf() and log_write()" "SECID280"
37964 Arbitrary strings are passed to both these functions, but they do their
37965 formatting by calling the function &'string_vformat()'&, which runs through
37966 the format string itself, and checks the length of each conversion.
37967
37968
37969
37970 .section "Use of strcat() and strcpy()" "SECID281"
37971 These are used only in cases where the output buffer is known to be large
37972 enough to hold the result.
37973 .ecindex IIDsecurcon
37974
37975
37976
37977
37978 . ////////////////////////////////////////////////////////////////////////////
37979 . ////////////////////////////////////////////////////////////////////////////
37980
37981 .chapter "Format of spool files" "CHAPspool"
37982 .scindex IIDforspo1 "format" "spool files"
37983 .scindex IIDforspo2 "spool directory" "format of files"
37984 .scindex IIDforspo3 "spool files" "format of"
37985 .cindex "spool files" "editing"
37986 A message on Exim's queue consists of two files, whose names are the message id
37987 followed by -D and -H, respectively. The data portion of the message is kept in
37988 the -D file on its own. The message's envelope, status, and headers are all
37989 kept in the -H file, whose format is described in this chapter. Each of these
37990 two files contains the final component of its own name as its first line. This
37991 is insurance against disk crashes where the directory is lost but the files
37992 themselves are recoverable.
37993
37994 Some people are tempted into editing -D files in order to modify messages. You
37995 need to be extremely careful if you do this; it is not recommended and you are
37996 on your own if you do it. Here are some of the pitfalls:
37997
37998 .ilist
37999 You must ensure that Exim does not try to deliver the message while you are
38000 fiddling with it. The safest way is to take out a write lock on the -D file,
38001 which is what Exim itself does, using &[fcntl()]&. If you update the file in
38002 place, the lock will be retained. If you write a new file and rename it, the
38003 lock will be lost at the instant of rename.
38004 .next
38005 .vindex "&$body_linecount$&"
38006 If you change the number of lines in the file, the value of
38007 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
38008 cause incomplete transmission of messages or undeliverable messages.
38009 .next
38010 If the message is in MIME format, you must take care not to break it.
38011 .next
38012 If the message is cryptographically signed, any change will invalidate the
38013 signature.
38014 .endlist
38015 All in all, modifying -D files is fraught with danger.
38016
38017 Files whose names end with -J may also be seen in the &_input_& directory (or
38018 its subdirectories when &%split_spool_directory%& is set). These are journal
38019 files, used to record addresses to which the message has been delivered during
38020 the course of a delivery attempt. If there are still undelivered recipients at
38021 the end, the -H file is updated, and the -J file is deleted. If, however, there
38022 is some kind of crash (for example, a power outage) before this happens, the -J
38023 file remains in existence. When Exim next processes the message, it notices the
38024 -J file and uses it to update the -H file before starting the next delivery
38025 attempt.
38026
38027 .section "Format of the -H file" "SECID282"
38028 .cindex "uid (user id)" "in spool file"
38029 .cindex "gid (group id)" "in spool file"
38030 The second line of the -H file contains the login name for the uid of the
38031 process that called Exim to read the message, followed by the numerical uid and
38032 gid. For a locally generated message, this is normally the user who sent the
38033 message. For a message received over TCP/IP via the daemon, it is
38034 normally the Exim user.
38035
38036 The third line of the file contains the address of the message's sender as
38037 transmitted in the envelope, contained in angle brackets. The sender address is
38038 empty for bounce messages. For incoming SMTP mail, the sender address is given
38039 in the MAIL command. For locally generated mail, the sender address is
38040 created by Exim from the login name of the current user and the configured
38041 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
38042 leading &"From&~"& line if the caller is trusted, or if the supplied address is
38043 &"<>"& or an address that matches &%untrusted_set_senders%&.
38044
38045 The fourth line contains two numbers. The first is the time that the message
38046 was received, in the conventional Unix form &-- the number of seconds since the
38047 start of the epoch. The second number is a count of the number of messages
38048 warning of delayed delivery that have been sent to the sender.
38049
38050 There follow a number of lines starting with a hyphen. These can appear in any
38051 order, and are omitted when not relevant:
38052
38053 .vlist
38054 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
38055 This item is obsolete, and is not generated from Exim release 4.61 onwards;
38056 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
38057 recognized, to provide backward compatibility. In the old format, a line of
38058 this form is present for every ACL variable that is not empty. The number
38059 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
38060 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
38061 the data string for the variable. The string itself starts at the beginning of
38062 the next line, and is followed by a newline character. It may contain internal
38063 newlines.
38064
38065 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
38066 A line of this form is present for every ACL connection variable that is
38067 defined. Note that there is a space between &%-aclc%& and the rest of the name.
38068 The length is the length of the data string for the variable. The string itself
38069 starts at the beginning of the next line, and is followed by a newline
38070 character. It may contain internal newlines.
38071
38072 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
38073 A line of this form is present for every ACL message variable that is defined.
38074 Note that there is a space between &%-aclm%& and the rest of the name. The
38075 length is the length of the data string for the variable. The string itself
38076 starts at the beginning of the next line, and is followed by a newline
38077 character. It may contain internal newlines.
38078
38079 .vitem "&%-active_hostname%&&~<&'hostname'&>"
38080 This is present if, when the message was received over SMTP, the value of
38081 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
38082
38083 .vitem &%-allow_unqualified_recipient%&
38084 This is present if unqualified recipient addresses are permitted in header
38085 lines (to stop such addresses from being qualified if rewriting occurs at
38086 transport time). Local messages that were input using &%-bnq%& and remote
38087 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
38088
38089 .vitem &%-allow_unqualified_sender%&
38090 This is present if unqualified sender addresses are permitted in header lines
38091 (to stop such addresses from being qualified if rewriting occurs at transport
38092 time). Local messages that were input using &%-bnq%& and remote messages from
38093 hosts that match &%sender_unqualified_hosts%& set this flag.
38094
38095 .vitem "&%-auth_id%&&~<&'text'&>"
38096 The id information for a message received on an authenticated SMTP connection
38097 &-- the value of the &$authenticated_id$& variable.
38098
38099 .vitem "&%-auth_sender%&&~<&'address'&>"
38100 The address of an authenticated sender &-- the value of the
38101 &$authenticated_sender$& variable.
38102
38103 .vitem "&%-body_linecount%&&~<&'number'&>"
38104 This records the number of lines in the body of the message, and is always
38105 present.
38106
38107 .vitem "&%-body_zerocount%&&~<&'number'&>"
38108 This records the number of binary zero bytes in the body of the message, and is
38109 present if the number is greater than zero.
38110
38111 .vitem &%-deliver_firsttime%&
38112 This is written when a new message is first added to the spool. When the spool
38113 file is updated after a deferral, it is omitted.
38114
38115 .vitem "&%-frozen%&&~<&'time'&>"
38116 .cindex "frozen messages" "spool data"
38117 The message is frozen, and the freezing happened at <&'time'&>.
38118
38119 .vitem "&%-helo_name%&&~<&'text'&>"
38120 This records the host name as specified by a remote host in a HELO or EHLO
38121 command.
38122
38123 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
38124 This records the IP address of the host from which the message was received and
38125 the remote port number that was used. It is omitted for locally generated
38126 messages.
38127
38128 .vitem "&%-host_auth%&&~<&'text'&>"
38129 If the message was received on an authenticated SMTP connection, this records
38130 the name of the authenticator &-- the value of the
38131 &$sender_host_authenticated$& variable.
38132
38133 .vitem &%-host_lookup_failed%&
38134 This is present if an attempt to look up the sending host's name from its IP
38135 address failed. It corresponds to the &$host_lookup_failed$& variable.
38136
38137 .vitem "&%-host_name%&&~<&'text'&>"
38138 .cindex "reverse DNS lookup"
38139 .cindex "DNS" "reverse lookup"
38140 This records the name of the remote host from which the message was received,
38141 if the host name was looked up from the IP address when the message was being
38142 received. It is not present if no reverse lookup was done.
38143
38144 .vitem "&%-ident%&&~<&'text'&>"
38145 For locally submitted messages, this records the login of the originating user,
38146 unless it was a trusted user and the &%-oMt%& option was used to specify an
38147 ident value. For messages received over TCP/IP, this records the ident string
38148 supplied by the remote host, if any.
38149
38150 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
38151 This records the IP address of the local interface and the port number through
38152 which a message was received from a remote host. It is omitted for locally
38153 generated messages.
38154
38155 .vitem &%-local%&
38156 The message is from a local sender.
38157
38158 .vitem &%-localerror%&
38159 The message is a locally-generated bounce message.
38160
38161 .vitem "&%-local_scan%&&~<&'string'&>"
38162 This records the data string that was returned by the &[local_scan()]& function
38163 when the message was received &-- the value of the &$local_scan_data$&
38164 variable. It is omitted if no data was returned.
38165
38166 .vitem &%-manual_thaw%&
38167 The message was frozen but has been thawed manually, that is, by an explicit
38168 Exim command rather than via the auto-thaw process.
38169
38170 .vitem &%-N%&
38171 A testing delivery process was started using the &%-N%& option to suppress any
38172 actual deliveries, but delivery was deferred. At any further delivery attempts,
38173 &%-N%& is assumed.
38174
38175 .vitem &%-received_protocol%&
38176 This records the value of the &$received_protocol$& variable, which contains
38177 the name of the protocol by which the message was received.
38178
38179 .vitem &%-sender_set_untrusted%&
38180 The envelope sender of this message was set by an untrusted local caller (used
38181 to ensure that the caller is displayed in queue listings).
38182
38183 .vitem "&%-spam_score_int%&&~<&'number'&>"
38184 If a message was scanned by SpamAssassin, this is present. It records the value
38185 of &$spam_score_int$&.
38186
38187 .vitem &%-tls_certificate_verified%&
38188 A TLS certificate was received from the client that sent this message, and the
38189 certificate was verified by the server.
38190
38191 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
38192 When the message was received over an encrypted connection, this records the
38193 name of the cipher suite that was used.
38194
38195 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
38196 When the message was received over an encrypted connection, and a certificate
38197 was received from the client, this records the Distinguished Name from that
38198 certificate.
38199 .endlist
38200
38201 Following the options there is a list of those addresses to which the message
38202 is not to be delivered. This set of addresses is initialized from the command
38203 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
38204 is set; otherwise it starts out empty. Whenever a successful delivery is made,
38205 the address is added to this set. The addresses are kept internally as a
38206 balanced binary tree, and it is a representation of that tree which is written
38207 to the spool file. If an address is expanded via an alias or forward file, the
38208 original address is added to the tree when deliveries to all its child
38209 addresses are complete.
38210
38211 If the tree is empty, there is a single line in the spool file containing just
38212 the text &"XX"&. Otherwise, each line consists of two letters, which are either
38213 Y or N, followed by an address. The address is the value for the node of the
38214 tree, and the letters indicate whether the node has a left branch and/or a
38215 right branch attached to it, respectively. If branches exist, they immediately
38216 follow. Here is an example of a three-node tree:
38217 .code
38218 YY darcy@austen.fict.example
38219 NN alice@wonderland.fict.example
38220 NN editor@thesaurus.ref.example
38221 .endd
38222 After the non-recipients tree, there is a list of the message's recipients.
38223 This is a simple list, preceded by a count. It includes all the original
38224 recipients of the message, including those to whom the message has already been
38225 delivered. In the simplest case, the list contains one address per line. For
38226 example:
38227 .code
38228 4
38229 editor@thesaurus.ref.example
38230 darcy@austen.fict.example
38231 rdo@foundation
38232 alice@wonderland.fict.example
38233 .endd
38234 However, when a child address has been added to the top-level addresses as a
38235 result of the use of the &%one_time%& option on a &(redirect)& router, each
38236 line is of the following form:
38237 .display
38238 <&'top-level address'&> <&'errors_to address'&> &&&
38239   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38240 .endd
38241 The 01 flag bit indicates the presence of the three other fields that follow
38242 the top-level address. Other bits may be used in future to support additional
38243 fields. The <&'parent number'&> is the offset in the recipients list of the
38244 original parent of the &"one time"& address. The first two fields are the
38245 envelope sender that is associated with this address and its length. If the
38246 length is zero, there is no special envelope sender (there are then two space
38247 characters in the line). A non-empty field can arise from a &(redirect)& router
38248 that has an &%errors_to%& setting.
38249
38250
38251 A blank line separates the envelope and status information from the headers
38252 which follow. A header may occupy several lines of the file, and to save effort
38253 when reading it in, each header is preceded by a number and an identifying
38254 character. The number is the number of characters in the header, including any
38255 embedded newlines and the terminating newline. The character is one of the
38256 following:
38257
38258 .table2 50pt
38259 .row <&'blank'&>         "header in which Exim has no special interest"
38260 .row &`B`&               "&'Bcc:'& header"
38261 .row &`C`&               "&'Cc:'& header"
38262 .row &`F`&               "&'From:'& header"
38263 .row &`I`&               "&'Message-id:'& header"
38264 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38265 .row &`R`&               "&'Reply-To:'& header"
38266 .row &`S`&               "&'Sender:'& header"
38267 .row &`T`&               "&'To:'& header"
38268 .row &`*`&               "replaced or deleted header"
38269 .endtable
38270
38271 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38272 purposes. They are not transmitted when the message is delivered. Here is a
38273 typical set of headers:
38274 .code
38275 111P Received: by hobbit.fict.example with local (Exim 4.00)
38276 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38277 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38278 038* X-rewrote-sender: bb@hobbit.fict.example
38279 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38280 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38281 099* To: alice@wonderland.fict.example, rdo@foundation,
38282 darcy@austen.fict.example, editor@thesaurus.ref.example
38283 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38284 darcy@austen.fict.example, editor@thesaurus.ref.example
38285 038  Date: Fri, 11 May 2001 10:28:59 +0100
38286 .endd
38287 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38288 &'To:'& header have been rewritten, the last one because routing expanded the
38289 unqualified domain &'foundation'&.
38290 .ecindex IIDforspo1
38291 .ecindex IIDforspo2
38292 .ecindex IIDforspo3
38293
38294 . ////////////////////////////////////////////////////////////////////////////
38295 . ////////////////////////////////////////////////////////////////////////////
38296
38297 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38298          "DKIM Support"
38299 .cindex "DKIM"
38300
38301 DKIM is a mechanism by which messages sent by some entity can be provably
38302 linked to a domain which that entity controls.  It permits reputation to
38303 be tracked on a per-domain basis, rather than merely upon source IP address.
38304 DKIM is documented in RFC 4871.
38305
38306 DKIM support is compiled into Exim by default if TLS support is present.
38307 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38308
38309 Exim's DKIM implementation allows for
38310 .olist
38311 Signing outgoing messages: This function is implemented in the SMTP transport.
38312 It can co-exist with all other Exim features
38313 (including transport filters)
38314 except cutthrough delivery.
38315 .next
38316 Verifying signatures in incoming messages: This is implemented by an additional
38317 ACL (acl_smtp_dkim), which can be called several times per message, with
38318 different signature contexts.
38319 .endlist
38320
38321 In typical Exim style, the verification implementation does not include any
38322 default "policy". Instead it enables you to build your own policy using
38323 Exim's standard controls.
38324
38325 Please note that verification of DKIM signatures in incoming mail is turned
38326 on by default for logging purposes. For each signature in incoming email,
38327 exim will log a line displaying the most important signature details, and the
38328 signature status. Here is an example (with line-breaks added for clarity):
38329 .code
38330 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38331     d=facebookmail.com s=q1-2009b
38332     c=relaxed/relaxed a=rsa-sha1
38333     i=@facebookmail.com t=1252484542 [verification succeeded]
38334 .endd
38335 You might want to turn off DKIM verification processing entirely for internal
38336 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38337 control modifier. This should typically be done in the RCPT ACL, at points
38338 where you accept mail from relay sources (internal hosts or authenticated
38339 senders).
38340
38341
38342 .section "Signing outgoing messages" "SECDKIMSIGN"
38343 .cindex "DKIM" "signing"
38344
38345 Signing is enabled by setting private options on the SMTP transport.
38346 These options take (expandable) strings as arguments.
38347
38348 .option dkim_domain smtp string&!! unset
38349 MANDATORY:
38350 The domain you want to sign with. The result of this expanded
38351 option is put into the &%$dkim_domain%& expansion variable.
38352 If it is empty after expansion, DKIM signing is not done.
38353
38354 .option dkim_selector smtp string&!! unset
38355 MANDATORY:
38356 This sets the key selector string. You can use the &%$dkim_domain%& expansion
38357 variable to look up a matching selector. The result is put in the expansion
38358 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38359 option along with &%$dkim_domain%&.
38360
38361 .option dkim_private_key smtp string&!! unset
38362 MANDATORY:
38363 This sets the private key to use. You can use the &%$dkim_domain%& and
38364 &%$dkim_selector%& expansion variables to determine the private key to use.
38365 The result can either
38366 .ilist
38367 be a valid RSA private key in ASCII armor, including line breaks.
38368 .next
38369 start with a slash, in which case it is treated as a file that contains
38370 the private key.
38371 .next
38372 be "0", "false" or the empty string, in which case the message will not
38373 be signed. This case will not result in an error, even if &%dkim_strict%&
38374 is set.
38375 .endlist
38376
38377 .option dkim_canon smtp string&!! unset
38378 OPTIONAL:
38379 This option sets the canonicalization method used when signing a message.
38380 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38381 The option defaults to "relaxed" when unset. Note: the current implementation
38382 only supports using the same canonicalization method for both headers and body.
38383
38384 .option dkim_strict smtp string&!! unset
38385 OPTIONAL:
38386 This  option  defines  how  Exim  behaves  when  signing a message that
38387 should be signed fails for some reason.  When the expansion evaluates to
38388 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38389 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38390 variables here.
38391
38392 .option dkim_sign_headers smtp string&!! unset
38393 OPTIONAL:
38394 When set, this option must expand to (or be specified as) a colon-separated
38395 list of header names. Headers with these names will be included in the message
38396 signature. When unspecified, the header names recommended in RFC4871 will be
38397 used.
38398
38399
38400 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38401 .cindex "DKIM" "verification"
38402
38403 Verification of DKIM signatures in SMTP incoming email is implemented via the
38404 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38405 syntactically(!) correct signature in the incoming message.
38406 A missing ACL definition defaults to accept.
38407 If any ACL call does not accept, the message is not accepted.
38408 If a cutthrough delivery was in progress for the message it is
38409 summarily dropped (having wasted the transmission effort).
38410
38411 To evaluate the signature in the ACL a large number of expansion variables
38412 containing the signature status and its details are set up during the
38413 runtime of the ACL.
38414
38415 Calling the ACL only for existing signatures is not sufficient to build
38416 more advanced policies. For that reason, the global option
38417 &%dkim_verify_signers%&, and a global expansion variable
38418 &%$dkim_signers%& exist.
38419
38420 The global option &%dkim_verify_signers%& can be set to a colon-separated
38421 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38422 called. It is expanded when the message has been received. At this point,
38423 the expansion variable &%$dkim_signers%& already contains a colon-separated
38424 list of signer domains and identities for the message. When
38425 &%dkim_verify_signers%& is not specified in the main configuration,
38426 it defaults as:
38427 .code
38428 dkim_verify_signers = $dkim_signers
38429 .endd
38430 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38431 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38432 call the ACL for known domains or identities. This would be achieved as follows:
38433 .code
38434 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38435 .endd
38436 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38437 and "ebay.com", plus all domains and identities that have signatures in the message.
38438 You can also be more creative in constructing your policy. For example:
38439 .code
38440 dkim_verify_signers = $sender_address_domain:$dkim_signers
38441 .endd
38442
38443 If a domain or identity is listed several times in the (expanded) value of
38444 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38445
38446
38447 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38448 available (from most to least important):
38449
38450
38451 .vlist
38452 .vitem &%$dkim_cur_signer%&
38453 The signer that is being evaluated in this ACL run. This can be a domain or
38454 an identity. This is one of the list items from the expanded main option
38455 &%dkim_verify_signers%& (see above).
38456
38457 .vitem &%$dkim_verify_status%&
38458 A string describing the general status of the signature. One of
38459 .ilist
38460 &%none%&: There is no signature in the message for the current domain or
38461 identity (as reflected by &%$dkim_cur_signer%&).
38462 .next
38463 &%invalid%&: The signature could not be verified due to a processing error.
38464 More detail is available in &%$dkim_verify_reason%&.
38465 .next
38466 &%fail%&: Verification of the signature failed.  More detail is
38467 available in &%$dkim_verify_reason%&.
38468 .next
38469 &%pass%&: The signature passed verification. It is valid.
38470 .endlist
38471
38472 .vitem &%$dkim_verify_reason%&
38473 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38474 "fail" or "invalid". One of
38475 .ilist
38476 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38477 key for the domain could not be retrieved. This may be a temporary problem.
38478 .next
38479 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38480 record for the domain is syntactically invalid.
38481 .next
38482 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38483 body hash does not match the one specified in the signature header. This
38484 means that the message body was modified in transit.
38485 .next
38486 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38487 could not be verified. This may mean that headers were modified,
38488 re-written or otherwise changed in a way which is incompatible with
38489 DKIM verification. It may of course also mean that the signature is forged.
38490 .endlist
38491
38492 .vitem &%$dkim_domain%&
38493 The signing domain. IMPORTANT: This variable is only populated if there is
38494 an actual signature in the message for the current domain or identity (as
38495 reflected by &%$dkim_cur_signer%&).
38496
38497 .vitem &%$dkim_identity%&
38498 The signing identity, if present. IMPORTANT: This variable is only populated
38499 if there is an actual signature in the message for the current domain or
38500 identity (as reflected by &%$dkim_cur_signer%&).
38501
38502 .vitem &%$dkim_selector%&
38503 The key record selector string.
38504
38505 .vitem &%$dkim_algo%&
38506 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38507
38508 .vitem &%$dkim_canon_body%&
38509 The body canonicalization method. One of 'relaxed' or 'simple'.
38510
38511 .vitem &%dkim_canon_headers%&
38512 The header canonicalization method. One of 'relaxed' or 'simple'.
38513
38514 .vitem &%$dkim_copiedheaders%&
38515 A transcript of headers and their values which are included in the signature
38516 (copied from the 'z=' tag of the signature).
38517 Note that RFC6376 requires that verification fail if the From: header is
38518 not included in the signature.  Exim does not enforce this; sites wishing
38519 strict enforcement should code the check explicitly.
38520
38521 .vitem &%$dkim_bodylength%&
38522 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38523 limit was set by the signer, "9999999999999" is returned. This makes sure
38524 that this variable always expands to an integer value.
38525
38526 .vitem &%$dkim_created%&
38527 UNIX timestamp reflecting the date and time when the signature was created.
38528 When this was not specified by the signer, "0" is returned.
38529
38530 .vitem &%$dkim_expires%&
38531 UNIX timestamp reflecting the date and time when the signer wants the
38532 signature to be treated as "expired". When this was not specified by the
38533 signer, "9999999999999" is returned. This makes it possible to do useful
38534 integer size comparisons against this value.
38535
38536 .vitem &%$dkim_headernames%&
38537 A colon-separated list of names of headers included in the signature.
38538
38539 .vitem &%$dkim_key_testing%&
38540 "1" if the key record has the "testing" flag set, "0" if not.
38541
38542 .vitem &%$dkim_key_nosubdomains%&
38543 "1" if the key record forbids subdomaining, "0" otherwise.
38544
38545 .vitem &%$dkim_key_srvtype%&
38546 Service type (tag s=) from the key record. Defaults to "*" if not specified
38547 in the key record.
38548
38549 .vitem &%$dkim_key_granularity%&
38550 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38551 in the key record.
38552
38553 .vitem &%$dkim_key_notes%&
38554 Notes from the key record (tag n=).
38555
38556 .vitem &%$dkim_key_length%&
38557 Number of bits in the key.
38558 .endlist
38559
38560 In addition, two ACL conditions are provided:
38561
38562 .vlist
38563 .vitem &%dkim_signers%&
38564 ACL condition that checks a colon-separated list of domains or identities
38565 for a match against the domain or identity that the ACL is currently verifying
38566 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38567 verb to a group of domains or identities. For example:
38568
38569 .code
38570 # Warn when Mail purportedly from GMail has no gmail signature
38571 warn log_message = GMail sender without gmail.com DKIM signature
38572      sender_domains = gmail.com
38573      dkim_signers = gmail.com
38574      dkim_status = none
38575 .endd
38576
38577 Note that the above does not check for a total lack of DKIM signing;
38578 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
38579
38580 .vitem &%dkim_status%&
38581 ACL condition that checks a colon-separated list of possible DKIM verification
38582 results against the actual result of verification. This is typically used
38583 to restrict an ACL verb to a list of verification outcomes, for example:
38584
38585 .code
38586 deny message = Mail from Paypal with invalid/missing signature
38587      sender_domains = paypal.com:paypal.de
38588      dkim_signers = paypal.com:paypal.de
38589      dkim_status = none:invalid:fail
38590 .endd
38591
38592 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38593 see the documentation of the &%$dkim_verify_status%& expansion variable above
38594 for more information of what they mean.
38595 .endlist
38596
38597 . ////////////////////////////////////////////////////////////////////////////
38598 . ////////////////////////////////////////////////////////////////////////////
38599
38600 .chapter "Proxies" "CHAPproxies" &&&
38601          "Proxy support"
38602 .cindex "proxy support"
38603 .cindex "proxy" "access via"
38604
38605 A proxy is an intermediate system through which communication is passed.
38606 Proxies may provide a security, availability or load-distribution function.
38607
38608
38609 .section "Inbound proxies" SECTproxyInbound
38610 .cindex proxy inbound
38611 .cindex proxy "server side"
38612 .cindex proxy "Proxy protocol"
38613 .cindex "Proxy protocol" proxy
38614
38615 Exim has support for receiving inbound SMTP connections via a proxy
38616 that uses &"Proxy Protocol"& to speak to it.
38617 To include this support, include &"SUPPORT_PROXY=yes"&
38618 in Local/Makefile.
38619
38620 It was built on specifications from:
38621 (&url(http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt)).
38622 That URL was revised in May 2014 to version 2 spec:
38623 (&url(http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e)).
38624
38625 The purpose of this facility is so that an application load balancer,
38626 such as HAProxy, can sit in front of several Exim servers
38627 to distribute load.
38628 Exim uses the local protocol communication with the proxy to obtain
38629 the remote SMTP system IP address and port information.
38630 There is no logging if a host passes or
38631 fails Proxy Protocol negotiation, but it can easily be determined and
38632 recorded in an ACL (example is below).
38633
38634 Use of a proxy is enabled by setting the &%hosts_proxy%&
38635 main configuration option to a hostlist; connections from these
38636 hosts will use Proxy Protocol.
38637 Exim supports both version 1 and version 2 of the Proxy Protocol and
38638 automatically determines which version is in use.
38639
38640 The Proxy Protocol header is the first data received on a TCP connection
38641 and is inserted before any TLS-on-connect handshake from the client; Exim
38642 negotiates TLS between Exim-as-server and the remote client, not between
38643 Exim and the proxy server.
38644
38645 The following expansion variables are usable
38646 (&"internal"& and &"external"& here refer to the interfaces
38647 of the proxy):
38648 .display
38649 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38650 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38651 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
38652 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
38653 &'proxy_session            '& boolean: SMTP connection via proxy
38654 .endd
38655 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38656 there was a protocol error.
38657
38658 Since the real connections are all coming from the proxy, and the
38659 per host connection tracking is done before Proxy Protocol is
38660 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38661 handle all of the parallel volume you expect per inbound proxy.
38662 With the option set so high, you lose the ability
38663 to protect your server from many connections from one IP.
38664 In order to prevent your server from overload, you
38665 need to add a per connection ratelimit to your connect ACL.
38666 A possible solution is:
38667 .display
38668   # Set max number of connections per host
38669   LIMIT   = 5
38670   # Or do some kind of IP lookup in a flat file or database
38671   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38672
38673   defer   message        = Too many connections from this IP right now
38674           ratelimit      = LIMIT / 5s / per_conn / strict
38675 .endd
38676
38677
38678
38679 .section "Outbound proxies" SECTproxySOCKS
38680 .cindex proxy outbound
38681 .cindex proxy "client side"
38682 .cindex proxy SOCKS
38683 .cindex SOCKS proxy
38684 Exim has support for sending outbound SMTP via a proxy
38685 using a protocol called SOCKS5 (defined by RFC1928).
38686 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38687 Local/Makefile.
38688
38689 Use of a proxy is enabled by setting the &%socks_proxy%& option
38690 on an smtp transport.
38691 The option value is expanded and should then be a list
38692 (colon-separated by default) of proxy specifiers.
38693 Each proxy specifier is a list
38694 (space-separated by default) where the initial element
38695 is an IP address and any subsequent elements are options.
38696
38697 Options are a string <name>=<value>.
38698 The list of options is in the following table:
38699 .display
38700 &'auth   '& authentication method
38701 &'name   '& authentication username
38702 &'pass   '& authentication password
38703 &'port   '& tcp port
38704 &'tmo    '& connection timeout
38705 &'pri    '& priority
38706 &'weight '& selection bias
38707 .endd
38708
38709 More details on each of these options follows:
38710
38711 .ilist
38712 .cindex authentication "to proxy"
38713 .cindex proxy authentication
38714 &%auth%&: Either &"none"& (default) or &"name"&.
38715 Using &"name"& selects username/password authentication per RFC 1929
38716 for access to the proxy.
38717 Default is &"none"&.
38718 .next
38719 &%name%&: sets the username for the &"name"& authentication method.
38720 Default is empty.
38721 .next
38722 &%pass%&: sets the password for the &"name"& authentication method.
38723 Default is empty.
38724 .next
38725 &%port%&: the TCP port number to use for the connection to the proxy.
38726 Default is 1080.
38727 .next
38728 &%tmo%&: sets a connection timeout in seconds for this proxy.
38729 Default is 5.
38730 .next
38731 &%pri%&: specifies a priority for the proxy within the list,
38732 higher values being tried first.
38733 The default priority is 1.
38734 .next
38735 &%weight%&: specifies a selection bias.
38736 Within a priority set servers are queried in a random fashion,
38737 weighted by this value.
38738 The default value for selection bias is 1.
38739 .endlist
38740
38741 Proxies from the list are tried according to their priority
38742 and weight settings until one responds.  The timeout for the
38743 overall connection applies to the set of proxied attempts.
38744
38745 .section Logging SECTproxyLog
38746 To log the (local) IP of a proxy in the incoming or delivery logline,
38747 add &"+proxy"& to the &%log_selector%& option.
38748 This will add a component tagged with &"PRX="& to the line.
38749
38750 . ////////////////////////////////////////////////////////////////////////////
38751 . ////////////////////////////////////////////////////////////////////////////
38752
38753 .chapter "Internationalisation" "CHAPi18n" &&&
38754          "Internationalisation""
38755 .cindex internationalisation "email address"
38756 .cindex EAI
38757 .cindex i18n
38758 .cindex UTF-8 "mail name handling"
38759
38760 Exim has support for Internationalised mail names.
38761 To include this it must be built with SUPPORT_I18N and the libidn library.
38762 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38763
38764 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
38765 instead of it) then IDNA2008 is supported; this adds an extra library
38766 requirement, upon libidn2.
38767
38768 .section "MTA operations" SECTi18nMTA
38769 .cindex SMTPUTF8 "ESMTP option"
38770 The main configuration option &%smtputf8_advertise_hosts%& specifies
38771 a host list.  If this matches the sending host and
38772 accept_8bitmime is true (the default) then the ESMTP option
38773 SMTPUTF8 will be advertised.
38774
38775 If the sender specifies the SMTPUTF8 option on a MAIL command
38776 international handling for the message is enabled and
38777 the expansion variable &$message_smtputf8$& will have value TRUE.
38778
38779 The option &%allow_utf8_domains%& is set to true for this
38780 message. All DNS lookups are converted to a-label form
38781 whatever the setting of &%allow_utf8_domains%&
38782 when Exim is built with SUPPORT_I18N.
38783
38784 Both localparts and domain are maintained as the original
38785 UTF-8 form internally; any comparison or regular-expression use will
38786 require appropriate care.  Filenames created, eg. by
38787 the appendfile transport, will have UTF-8 names.
38788
38789 HELO names sent by the smtp transport will have any UTF-8
38790 components expanded to a-label form,
38791 and any certificate name checks will be done using the a-label
38792 form of the name.
38793
38794 .cindex log protocol
38795 .cindex SMTPUTF8 logging
38796 Log lines and Received-by: header lines will acquire a "utf8"
38797 prefix on the protocol element, eg. utf8esmtp.
38798
38799 The following expansion operators can be used:
38800 .code
38801 ${utf8_domain_to_alabel:str}
38802 ${utf8_domain_from_alabel:str}
38803 ${utf8_localpart_to_alabel:str}
38804 ${utf8_localpart_from_alabel:str}
38805 .endd
38806
38807 ACLs may use the following modifier:
38808 .display
38809 control = utf8_downconvert
38810 control = utf8_downconvert/<value>
38811 .endd
38812 This sets a flag requiring that addresses are converted to
38813 a-label form before smtp delivery, for use in a
38814 Message Submission Agent context.
38815 If a value is appended it may be:
38816 .display
38817 &`1  `& (default) mandatory downconversion
38818 &`0  `& no downconversion
38819 &`-1 `& if SMTPUTF8 not supported by destination host
38820 .endd
38821
38822 If mua_wrapper is set, the utf8_downconvert control
38823 is initially set to -1.
38824
38825
38826 There is no explicit support for VRFY and EXPN.
38827 Configurations supporting these should inspect
38828 &$smtp_command_argument$& for an SMTPUTF8 argument.
38829
38830 There is no support for LMTP on Unix sockets.
38831 Using the "lmtp" protocol option on an smtp transport,
38832 for LMTP over TCP, should work as expected.
38833
38834 There is no support for DSN unitext handling,
38835 and no provision for converting logging from or to UTF-8.
38836
38837
38838
38839 .section "MDA operations" SECTi18nMDA
38840 To aid in constructing names suitable for IMAP folders
38841 the following expansion operator can be used:
38842 .code
38843 ${imapfolder {<string>} {<sep>} {<specials>}}
38844 .endd
38845
38846 The string is converted from the charset specified by
38847 the "headers charset" command (in a filter file)
38848 or &%headers_charset%& main configuration option (otherwise),
38849 to the
38850 modified UTF-7 encoding specified by RFC 2060,
38851 with the following exception: All occurences of <sep>
38852 (which has to be a single character)
38853 are replaced with periods ("."), and all periods and slashes that are not
38854 <sep> and are not in the <specials> string are BASE64 encoded.
38855
38856 The third argument can be omitted, defaulting to an empty string.
38857 The second argument can be omitted, defaulting to "/".
38858
38859 This is the encoding used by Courier for Maildir names on disk, and followed
38860 by many other IMAP servers.
38861
38862 Examples:
38863 .display
38864 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38865 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38866 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38867 .endd
38868
38869 Note that the source charset setting is vital, and also that characters
38870 must be representable in UTF-16.
38871
38872
38873 . ////////////////////////////////////////////////////////////////////////////
38874 . ////////////////////////////////////////////////////////////////////////////
38875
38876 .chapter "Events" "CHAPevents" &&&
38877          "Events"
38878 .cindex events
38879
38880 The events mechanism in Exim can be used to intercept processing at a number
38881 of points.  It was originally invented to give a way to do customised logging
38882 actions (for example, to a database) but can also be used to modify some
38883 processing actions.
38884
38885 Most installations will never need to use Events.
38886 The support can be left out of a build by defining DISABLE_EVENT=yes
38887 in &_Local/Makefile_&.
38888
38889 There are two major classes of events: main and transport.
38890 The main configuration option &%event_action%& controls reception events;
38891 a transport option &%event_action%& controls delivery events.
38892
38893 Both options are a string which is expanded when the event fires.
38894 An example might look like:
38895 .cindex logging custom
38896 .code
38897 event_action = ${if eq {msg:delivery}{$event_name} \
38898 {${lookup pgsql {SELECT * FROM record_Delivery( \
38899     '${quote_pgsql:$sender_address_domain}',\
38900     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38901     '${quote_pgsql:$domain}', \
38902     '${quote_pgsql:${lc:$local_part}}', \
38903     '${quote_pgsql:$host_address}', \
38904     '${quote_pgsql:${lc:$host}}', \
38905     '${quote_pgsql:$message_exim_id}')}} \
38906 } {}}
38907 .endd
38908
38909 Events have names which correspond to the point in process at which they fire.
38910 The name is placed in the variable &$event_name$& and the event action
38911 expansion must check this, as it will be called for every possible event type.
38912
38913 The current list of events is:
38914 .display
38915 &`msg:complete           after    main       `& per message
38916 &`msg:delivery           after    transport  `& per recipient
38917 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38918 &`msg:rcpt:defer         after    transport  `& per recipient
38919 &`msg:host:defer         after    transport  `& per attempt
38920 &`msg:fail:delivery      after    main       `& per recipient
38921 &`msg:fail:internal      after    main       `& per recipient
38922 &`tcp:connect            before   transport  `& per connection
38923 &`tcp:close              after    transport  `& per connection
38924 &`tls:cert               before   both       `& per certificate in verification chain
38925 &`smtp:connect           after    transport  `& per connection
38926 .endd
38927 New event types may be added in future.
38928
38929 The event name is a colon-separated list, defining the type of
38930 event in a tree of possibilities.  It may be used as a list
38931 or just matched on as a whole.  There will be no spaces in the name.
38932
38933 The second column in the table above describes whether the event fires
38934 before or after the action is associates with.  Those which fire before
38935 can be used to affect that action (more on this below).
38936
38937 An additional variable, &$event_data$&, is filled with information varying
38938 with the event type:
38939 .display
38940 &`msg:delivery         `& smtp confirmation message
38941 &`msg:rcpt:host:defer  `& error string
38942 &`msg:rcpt:defer       `& error string
38943 &`msg:host:defer       `& error string
38944 &`tls:cert             `& verification chain depth
38945 &`smtp:connect         `& smtp banner
38946 .endd
38947
38948 The :defer events populate one extra variable: &$event_defer_errno$&.
38949
38950 For complex operations an ACL expansion can be used in &%event_action%&
38951 however due to the multiple contexts that Exim operates in during
38952 the course of its processing:
38953 .ilist
38954 variables set in transport events will not be visible outside that
38955 transport call
38956 .next
38957 acl_m variables in a server context are lost on a new connection,
38958 and after smtp helo/ehlo/mail/starttls/rset commands
38959 .endlist
38960 Using an ACL expansion with the logwrite modifier can be
38961 a useful way of writing to the main log.
38962
38963 The expansion of the event_action option should normally
38964 return an empty string.  Should it return anything else the
38965 following will be forced:
38966 .display
38967 &`msg:delivery     `&  (ignored)
38968 &`msg:host:defer   `&  (ignored)
38969 &`msg:fail:delivery`&  (ignored)
38970 &`tcp:connect      `&  do not connect
38971 &`tcp:close        `&  (ignored)
38972 &`tls:cert         `&  refuse verification
38973 &`smtp:connect     `&  close connection
38974 .endd
38975 No other use is made of the result string.
38976
38977 For a tcp:connect event, if the connection is being made to a proxy
38978 then the address and port variables will be that of the proxy and not
38979 the target system.
38980
38981 For tls:cert events, if GnuTLS is in use this will trigger only per
38982 chain element received on the connection.
38983 For OpenSSL it will trigger for every chain element including those
38984 loaded locally.
38985
38986 . ////////////////////////////////////////////////////////////////////////////
38987 . ////////////////////////////////////////////////////////////////////////////
38988
38989 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38990          "Adding drivers or lookups"
38991 .cindex "adding drivers"
38992 .cindex "new drivers, adding"
38993 .cindex "drivers" "adding new"
38994 The following actions have to be taken in order to add a new router, transport,
38995 authenticator, or lookup type to Exim:
38996
38997 .olist
38998 Choose a name for the driver or lookup type that does not conflict with any
38999 existing name; I will use &"newdriver"& in what follows.
39000 .next
39001 Add to &_src/EDITME_& the line:
39002 .display
39003 <&'type'&>&`_NEWDRIVER=yes`&
39004 .endd
39005 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
39006 code is not to be included in the binary by default, comment this line out. You
39007 should also add any relevant comments about the driver or lookup type.
39008 .next
39009 Add to &_src/config.h.defaults_& the line:
39010 .code
39011 #define <type>_NEWDRIVER
39012 .endd
39013 .next
39014 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
39015 and create a table entry as is done for all the other drivers and lookup types.
39016 .next
39017 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
39018 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
39019 Add your &`NEWDRIVER`& to that list.
39020 As long as the dynamic module would be named &_newdriver.so_&, you can use the
39021 simple form that most lookups have.
39022 .next
39023 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
39024 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
39025 driver or lookup type and add it to the definition of OBJ.
39026 .next
39027 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
39028 &_src_&.
39029 .next
39030 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
39031 as for other drivers and lookups.
39032 .endlist
39033
39034 Then all you need to do is write the code! A good way to start is to make a
39035 proforma by copying an existing module of the same type, globally changing all
39036 occurrences of the name, and cutting out most of the code. Note that any
39037 options you create must be listed in alphabetical order, because the tables are
39038 searched using a binary chop procedure.
39039
39040 There is a &_README_& file in each of the sub-directories of &_src_& describing
39041 the interface that is expected.
39042
39043
39044
39045
39046 . ////////////////////////////////////////////////////////////////////////////
39047 . ////////////////////////////////////////////////////////////////////////////
39048
39049 . /////////////////////////////////////////////////////////////////////////////
39050 . These lines are processing instructions for the Simple DocBook Processor that
39051 . Philip Hazel has developed as a less cumbersome way of making PostScript and
39052 . PDFs than using xmlto and fop. They will be ignored by all other XML
39053 . processors.
39054 . /////////////////////////////////////////////////////////////////////////////
39055
39056 .literal xml
39057 <?sdop
39058   format="newpage"
39059   foot_right_recto="&chaptertitle;"
39060   foot_right_verso="&chaptertitle;"
39061 ?>
39062 .literal off
39063
39064 .makeindex "Options index"   "option"
39065 .makeindex "Variables index" "variable"
39066 .makeindex "Concept index"   "concept"
39067
39068
39069 . /////////////////////////////////////////////////////////////////////////////
39070 . /////////////////////////////////////////////////////////////////////////////