Certificate variables and field-extractor expansions. Bug 1358
[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.80"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2014
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 .endtable
440
441 The main specification and the specification of the filtering language are also
442 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
443 &<<SECTavail>>& below tells you how to get hold of these.
444
445
446
447 .section "FTP and web sites" "SECID2"
448 .cindex "web site"
449 .cindex "FTP site"
450 The primary site for Exim source distributions is currently the University of
451 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
452 distribution'& below. In addition, there is a web site and an FTP site at
453 &%exim.org%&. These are now also hosted at the University of Cambridge. The
454 &%exim.org%& site was previously hosted for a number of years by Energis
455 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
456
457 .cindex "wiki"
458 .cindex "FAQ"
459 As well as Exim distribution tar files, the Exim web site contains a number of
460 differently formatted versions of the documentation. A recent addition to the
461 online information is the Exim wiki (&url(http://wiki.exim.org)),
462 which contains what used to be a separate FAQ, as well as various other
463 examples, tips, and know-how that have been contributed by Exim users.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on this list and not on the general Exim
493 lists.
494
495 .section "Exim training" "SECID4"
496 .cindex "training courses"
497 Training courses in Cambridge (UK) used to be run annually by the author of
498 Exim, before he retired. At the time of writing, there are no plans to run
499 further Exim courses in Cambridge. However, if that changes, relevant
500 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
501
502 .section "Bug reports" "SECID5"
503 .cindex "bug reports"
504 .cindex "reporting bugs"
505 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
506 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
507 whether some behaviour is a bug or not, the best thing to do is to post a
508 message to the &'exim-dev'& mailing list and have it discussed.
509
510
511
512 .section "Where to find the Exim distribution" "SECTavail"
513 .cindex "FTP site"
514 .cindex "distribution" "ftp site"
515 The master ftp site for the Exim distribution is
516 .display
517 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
518 .endd
519 This is mirrored by
520 .display
521 &*ftp://ftp.exim.org/pub/exim*&
522 .endd
523 The file references that follow are relative to the &_exim_& directories at
524 these sites. There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.gz_&
533 &_exim-n.nn.tar.bz2_&
534 .endd
535 where &'n.nn'& is the highest such version number in the directory. The two
536 files contain identical data; the only difference is the type of compression.
537 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
538
539 .cindex "distribution" "signing details"
540 .cindex "distribution" "public key"
541 .cindex "public key for signed distribution"
542 The distributions will be PGP signed by an individual key of the Release
543 Coordinator.  This key will have a uid containing an email address in the
544 &'exim.org'& domain and will have signatures from other people, including
545 other Exim maintainers.  We expect that the key will be in the "strong set" of
546 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
547 PGP key, a version of which can be found in the release directory in the file
548 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
549 such as &'pool.sks-keyservers.net'&.
550
551 At time of last update, releases were being made by Phil Pennock and signed with
552 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
553 A trust path from Nigel's key to Phil's can be observed at
554 &url(https://www.security.spodhuis.org/exim-trustpath).
555
556 Releases have also been authorized to be performed by Todd Lyons who signs with
557 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
558 Pennock and Todd Lyons through a common associate.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.gz.asc_&
563 &_exim-n.nn.tar.bz2.asc_&
564 .endd
565 For each released version, the log of changes is made separately available in a
566 separate file in the directory &_ChangeLogs_& so that it is possible to
567 find out what has changed without having to download the entire distribution.
568
569 .cindex "documentation" "available formats"
570 The main distribution contains ASCII versions of this specification and other
571 documentation; other formats of the documents are available in separate files
572 inside the &_exim4_& directory of the FTP site:
573 .display
574 &_exim-html-n.nn.tar.gz_&
575 &_exim-pdf-n.nn.tar.gz_&
576 &_exim-postscript-n.nn.tar.gz_&
577 &_exim-texinfo-n.nn.tar.gz_&
578 .endd
579 These tar files contain only the &_doc_& directory, not the complete
580 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
581
582
583 .section "Limitations" "SECID6"
584 .ilist
585 .cindex "limitations of Exim"
586 .cindex "bang paths" "not handled by Exim"
587 Exim is designed for use as an Internet MTA, and therefore handles addresses in
588 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
589 simple two-component bang paths can be converted by a straightforward rewriting
590 configuration. This restriction does not prevent Exim from being interfaced to
591 UUCP as a transport mechanism, provided that domain addresses are used.
592 .next
593 .cindex "domainless addresses"
594 .cindex "address" "without domain"
595 Exim insists that every address it handles has a domain attached. For incoming
596 local messages, domainless addresses are automatically qualified with a
597 configured domain value. Configuration options specify from which remote
598 systems unqualified addresses are acceptable. These are then qualified on
599 arrival.
600 .next
601 .cindex "transport" "external"
602 .cindex "external transports"
603 The only external transport mechanisms that are currently implemented are SMTP
604 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
605 transport is available, and there are facilities for writing messages to files
606 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
607 to send messages to other transport mechanisms such as UUCP, provided they can
608 handle domain-style addresses. Batched SMTP input is also catered for.
609 .next
610 Exim is not designed for storing mail for dial-in hosts. When the volumes of
611 such mail are large, it is better to get the messages &"delivered"& into files
612 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
613 other means.
614 .next
615 Although Exim does have basic facilities for scanning incoming messages, these
616 are not comprehensive enough to do full virus or spam scanning. Such operations
617 are best carried out using additional specialized software packages. If you
618 compile Exim with the content-scanning extension, straightforward interfaces to
619 a number of common scanners are provided.
620 .endlist
621
622
623 .section "Run time configuration" "SECID7"
624 Exim's run time configuration is held in a single text file that is divided
625 into a number of sections. The entries in this file consist of keywords and
626 values, in the style of Smail 3 configuration files. A default configuration
627 file which is suitable for simple online installations is provided in the
628 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
629
630
631 .section "Calling interface" "SECID8"
632 .cindex "Sendmail compatibility" "command line interface"
633 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
634 can be a straight replacement for &_/usr/lib/sendmail_& or
635 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
636 about Sendmail in order to run Exim. For actions other than sending messages,
637 Sendmail-compatible options also exist, but those that produce output (for
638 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
639 format. There are also some additional options that are compatible with Smail
640 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
641 documents all Exim's command line options. This information is automatically
642 made into the man page that forms part of the Exim distribution.
643
644 Control of messages on the queue can be done via certain privileged command
645 line options. There is also an optional monitor program called &'eximon'&,
646 which displays current information in an X window, and which contains a menu
647 interface to Exim's command line administration options.
648
649
650
651 .section "Terminology" "SECID9"
652 .cindex "terminology definitions"
653 .cindex "body of message" "definition of"
654 The &'body'& of a message is the actual data that the sender wants to transmit.
655 It is the last part of a message, and is separated from the &'header'& (see
656 below) by a blank line.
657
658 .cindex "bounce message" "definition of"
659 When a message cannot be delivered, it is normally returned to the sender in a
660 delivery failure message or a &"non-delivery report"& (NDR). The term
661 &'bounce'& is commonly used for this action, and the error reports are often
662 called &'bounce messages'&. This is a convenient shorthand for &"delivery
663 failure error report"&. Such messages have an empty sender address in the
664 message's &'envelope'& (see below) to ensure that they cannot themselves give
665 rise to further bounce messages.
666
667 The term &'default'& appears frequently in this manual. It is used to qualify a
668 value which is used in the absence of any setting in the configuration. It may
669 also qualify an action which is taken unless a configuration setting specifies
670 otherwise.
671
672 The term &'defer'& is used when the delivery of a message to a specific
673 destination cannot immediately take place for some reason (a remote host may be
674 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
675 until a later time.
676
677 The word &'domain'& is sometimes used to mean all but the first component of a
678 host's name. It is &'not'& used in that sense here, where it normally refers to
679 the part of an email address following the @ sign.
680
681 .cindex "envelope, definition of"
682 .cindex "sender" "definition of"
683 A message in transit has an associated &'envelope'&, as well as a header and a
684 body. The envelope contains a sender address (to which bounce messages should
685 be delivered), and any number of recipient addresses. References to the
686 sender or the recipients of a message usually mean the addresses in the
687 envelope. An MTA uses these addresses for delivery, and for returning bounce
688 messages, not the addresses that appear in the header lines.
689
690 .cindex "message" "header, definition of"
691 .cindex "header section" "definition of"
692 The &'header'& of a message is the first part of a message's text, consisting
693 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
694 &'Subject:'&, etc. Long header lines can be split over several text lines by
695 indenting the continuations. The header is separated from the body by a blank
696 line.
697
698 .cindex "local part" "definition of"
699 .cindex "domain" "definition of"
700 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
701 part of an email address that precedes the @ sign. The part that follows the
702 @ sign is called the &'domain'& or &'mail domain'&.
703
704 .cindex "local delivery" "definition of"
705 .cindex "remote delivery, definition of"
706 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
707 delivery to a file or a pipe on the local host from delivery by SMTP over
708 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
709 host it is running on are &'remote'&.
710
711 .cindex "return path" "definition of"
712 &'Return path'& is another name that is used for the sender address in a
713 message's envelope.
714
715 .cindex "queue" "definition of"
716 The term &'queue'& is used to refer to the set of messages awaiting delivery,
717 because this term is in widespread use in the context of MTAs. However, in
718 Exim's case the reality is more like a pool than a queue, because there is
719 normally no ordering of waiting messages.
720
721 .cindex "queue runner" "definition of"
722 The term &'queue runner'& is used to describe a process that scans the queue
723 and attempts to deliver those messages whose retry times have come. This term
724 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
725 the waiting messages are normally processed in an unpredictable order.
726
727 .cindex "spool directory" "definition of"
728 The term &'spool directory'& is used for a directory in which Exim keeps the
729 messages on its queue &-- that is, those that it is in the process of
730 delivering. This should not be confused with the directory in which local
731 mailboxes are stored, which is called a &"spool directory"& by some people. In
732 the Exim documentation, &"spool"& is always used in the first sense.
733
734
735
736
737
738
739 . ////////////////////////////////////////////////////////////////////////////
740 . ////////////////////////////////////////////////////////////////////////////
741
742 .chapter "Incorporated code" "CHID2"
743 .cindex "incorporated code"
744 .cindex "regular expressions" "library"
745 .cindex "PCRE"
746 .cindex "OpenDMARC"
747 A number of pieces of external code are included in the Exim distribution.
748
749 .ilist
750 Regular expressions are supported in the main Exim program and in the
751 Exim monitor using the freely-distributable PCRE library, copyright
752 &copy; University of Cambridge. The source to PCRE is no longer shipped with
753 Exim, so you will need to use the version of PCRE shipped with your system,
754 or obtain and install the full version of the library from
755 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
756 .next
757 .cindex "cdb" "acknowledgment"
758 Support for the cdb (Constant DataBase) lookup method is provided by code
759 contributed by Nigel Metheringham of (at the time he contributed it) Planet
760 Online Ltd. The implementation is completely contained within the code of Exim.
761 It does not link against an external cdb library. The code contains the
762 following statements:
763
764 .blockquote
765 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
766
767 This program is free software; you can redistribute it and/or modify it under
768 the terms of the GNU General Public License as published by the Free Software
769 Foundation; either version 2 of the License, or (at your option) any later
770 version.
771 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
772 the spec and sample code for cdb can be obtained from
773 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
774 some code from Dan Bernstein's implementation (which has no license
775 restrictions applied to it).
776 .endblockquote
777 .next
778 .cindex "SPA authentication"
779 .cindex "Samba project"
780 .cindex "Microsoft Secure Password Authentication"
781 Client support for Microsoft's &'Secure Password Authentication'& is provided
782 by code contributed by Marc Prud'hommeaux. Server support was contributed by
783 Tom Kistner. This includes code taken from the Samba project, which is released
784 under the Gnu GPL.
785 .next
786 .cindex "Cyrus"
787 .cindex "&'pwcheck'& daemon"
788 .cindex "&'pwauthd'& daemon"
789 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
790 by code taken from the Cyrus-SASL library and adapted by Alexander S.
791 Sabourenkov. The permission notice appears below, in accordance with the
792 conditions expressed therein.
793
794 .blockquote
795 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
796
797 Redistribution and use in source and binary forms, with or without
798 modification, are permitted provided that the following conditions
799 are met:
800
801 .olist
802 Redistributions of source code must retain the above copyright
803 notice, this list of conditions and the following disclaimer.
804 .next
805 Redistributions in binary form must reproduce the above copyright
806 notice, this list of conditions and the following disclaimer in
807 the documentation and/or other materials provided with the
808 distribution.
809 .next
810 The name &"Carnegie Mellon University"& must not be used to
811 endorse or promote products derived from this software without
812 prior written permission. For permission or any other legal
813 details, please contact
814 .display
815               Office of Technology Transfer
816               Carnegie Mellon University
817               5000 Forbes Avenue
818               Pittsburgh, PA  15213-3890
819               (412) 268-4387, fax: (412) 268-7395
820               tech-transfer@andrew.cmu.edu
821 .endd
822 .next
823 Redistributions of any form whatsoever must retain the following
824 acknowledgment:
825
826 &"This product includes software developed by Computing Services
827 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
828
829 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
830 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
831 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
832 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
833 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
834 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
835 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
836 .endlist
837 .endblockquote
838
839 .next
840 .cindex "Exim monitor" "acknowledgment"
841 .cindex "X-windows"
842 .cindex "Athena"
843 The Exim Monitor program, which is an X-Window application, includes
844 modified versions of the Athena StripChart and TextPop widgets.
845 This code is copyright by DEC and MIT, and their permission notice appears
846 below, in accordance with the conditions expressed therein.
847
848 .blockquote
849 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
850 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
851
852 All Rights Reserved
853
854 Permission to use, copy, modify, and distribute this software and its
855 documentation for any purpose and without fee is hereby granted,
856 provided that the above copyright notice appear in all copies and that
857 both that copyright notice and this permission notice appear in
858 supporting documentation, and that the names of Digital or MIT not be
859 used in advertising or publicity pertaining to distribution of the
860 software without specific, written prior permission.
861
862 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
863 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
864 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
865 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
866 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
867 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
868 SOFTWARE.
869 .endblockquote
870
871 .next
872 .cindex "opendmarc" "acknowledgment"
873 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
874 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
875 derived code are indicated in the respective source files. The full OpenDMARC
876 license is provided in the LICENSE.opendmarc file contained in the distributed
877 source code.
878
879 .next
880 Many people have contributed code fragments, some large, some small, that were
881 not covered by any specific licence requirements. It is assumed that the
882 contributors are happy to see their code incorporated into Exim under the GPL.
883 .endlist
884
885
886
887
888
889 . ////////////////////////////////////////////////////////////////////////////
890 . ////////////////////////////////////////////////////////////////////////////
891
892 .chapter "How Exim receives and delivers mail" "CHID11" &&&
893          "Receiving and delivering mail"
894
895
896 .section "Overall philosophy" "SECID10"
897 .cindex "design philosophy"
898 Exim is designed to work efficiently on systems that are permanently connected
899 to the Internet and are handling a general mix of mail. In such circumstances,
900 most messages can be delivered immediately. Consequently, Exim does not
901 maintain independent queues of messages for specific domains or hosts, though
902 it does try to send several messages in a single SMTP connection after a host
903 has been down, and it also maintains per-host retry information.
904
905
906 .section "Policy control" "SECID11"
907 .cindex "policy control" "overview"
908 Policy controls are now an important feature of MTAs that are connected to the
909 Internet. Perhaps their most important job is to stop MTAs being abused as
910 &"open relays"& by misguided individuals who send out vast amounts of
911 unsolicited junk, and want to disguise its source. Exim provides flexible
912 facilities for specifying policy controls on incoming mail:
913
914 .ilist
915 .cindex "&ACL;" "introduction"
916 Exim 4 (unlike previous versions of Exim) implements policy controls on
917 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
918 series of statements that may either grant or deny access. ACLs can be used at
919 several places in the SMTP dialogue while receiving a message from a remote
920 host. However, the most common places are after each RCPT command, and at the
921 very end of the message. The sysadmin can specify conditions for accepting or
922 rejecting individual recipients or the entire message, respectively, at these
923 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
924 error code.
925 .next
926 An ACL is also available for locally generated, non-SMTP messages. In this
927 case, the only available actions are to accept or deny the entire message.
928 .next
929 When Exim is compiled with the content-scanning extension, facilities are
930 provided in the ACL mechanism for passing the message to external virus and/or
931 spam scanning software. The result of such a scan is passed back to the ACL,
932 which can then use it to decide what to do with the message.
933 .next
934 When a message has been received, either from a remote host or from the local
935 host, but before the final acknowledgment has been sent, a locally supplied C
936 function called &[local_scan()]& can be run to inspect the message and decide
937 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
938 is accepted, the list of recipients can be modified by the function.
939 .next
940 Using the &[local_scan()]& mechanism is another way of calling external scanner
941 software. The &%SA-Exim%& add-on package works this way. It does not require
942 Exim to be compiled with the content-scanning extension.
943 .next
944 After a message has been accepted, a further checking mechanism is available in
945 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
946 runs at the start of every delivery process.
947 .endlist
948
949
950
951 .section "User filters" "SECID12"
952 .cindex "filter" "introduction"
953 .cindex "Sieve filter"
954 In a conventional Exim configuration, users are able to run private filters by
955 setting up appropriate &_.forward_& files in their home directories. See
956 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
957 configuration needed to support this, and the separate document entitled
958 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
959 of filtering are available:
960
961 .ilist
962 Sieve filters are written in the standard filtering language that is defined
963 by RFC 3028.
964 .next
965 Exim filters are written in a syntax that is unique to Exim, but which is more
966 powerful than Sieve, which it pre-dates.
967 .endlist
968
969 User filters are run as part of the routing process, described below.
970
971
972
973 .section "Message identification" "SECTmessiden"
974 .cindex "message ids" "details of format"
975 .cindex "format" "of message id"
976 .cindex "id of message"
977 .cindex "base62"
978 .cindex "base36"
979 .cindex "Darwin"
980 .cindex "Cygwin"
981 Every message handled by Exim is given a &'message id'& which is sixteen
982 characters long. It is divided into three parts, separated by hyphens, for
983 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
984 normally encoding numbers in base 62. However, in the Darwin operating
985 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
986 (avoiding the use of lower case letters) is used instead, because the message
987 id is used to construct file names, and the names of files in those systems are
988 not always case-sensitive.
989
990 .cindex "pid (process id)" "re-use of"
991 The detail of the contents of the message id have changed as Exim has evolved.
992 Earlier versions relied on the operating system not re-using a process id (pid)
993 within one second. On modern operating systems, this assumption can no longer
994 be made, so the algorithm had to be changed. To retain backward compatibility,
995 the format of the message id was retained, which is why the following rules are
996 somewhat eccentric:
997
998 .ilist
999 The first six characters of the message id are the time at which the message
1000 started to be received, to a granularity of one second. That is, this field
1001 contains the number of seconds since the start of the epoch (the normal Unix
1002 way of representing the date and time of day).
1003 .next
1004 After the first hyphen, the next six characters are the id of the process that
1005 received the message.
1006 .next
1007 There are two different possibilities for the final two characters:
1008 .olist
1009 .oindex "&%localhost_number%&"
1010 If &%localhost_number%& is not set, this value is the fractional part of the
1011 time of reception, normally in units of 1/2000 of a second, but for systems
1012 that must use base 36 instead of base 62 (because of case-insensitive file
1013 systems), the units are 1/1000 of a second.
1014 .next
1015 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1016 the fractional part of the time, which in this case is in units of 1/200
1017 (1/100) of a second.
1018 .endlist
1019 .endlist
1020
1021 After a message has been received, Exim waits for the clock to tick at the
1022 appropriate resolution before proceeding, so that if another message is
1023 received by the same process, or by another process with the same (re-used)
1024 pid, it is guaranteed that the time will be different. In most cases, the clock
1025 will already have ticked while the message was being received.
1026
1027
1028 .section "Receiving mail" "SECID13"
1029 .cindex "receiving mail"
1030 .cindex "message" "reception"
1031 The only way Exim can receive mail from another host is using SMTP over
1032 TCP/IP, in which case the sender and recipient addresses are transferred using
1033 SMTP commands. However, from a locally running process (such as a user's MUA),
1034 there are several possibilities:
1035
1036 .ilist
1037 If the process runs Exim with the &%-bm%& option, the message is read
1038 non-interactively (usually via a pipe), with the recipients taken from the
1039 command line, or from the body of the message if &%-t%& is also used.
1040 .next
1041 If the process runs Exim with the &%-bS%& option, the message is also read
1042 non-interactively, but in this case the recipients are listed at the start of
1043 the message in a series of SMTP RCPT commands, terminated by a DATA
1044 command. This is so-called &"batch SMTP"& format,
1045 but it isn't really SMTP. The SMTP commands are just another way of passing
1046 envelope addresses in a non-interactive submission.
1047 .next
1048 If the process runs Exim with the &%-bs%& option, the message is read
1049 interactively, using the SMTP protocol. A two-way pipe is normally used for
1050 passing data between the local process and the Exim process.
1051 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1052 example, the ACLs for SMTP commands are used for this form of submission.
1053 .next
1054 A local process may also make a TCP/IP call to the host's loopback address
1055 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1056 does not treat the loopback address specially. It treats all such connections
1057 in the same way as connections from other hosts.
1058 .endlist
1059
1060
1061 .cindex "message sender, constructed by Exim"
1062 .cindex "sender" "constructed by Exim"
1063 In the three cases that do not involve TCP/IP, the sender address is
1064 constructed from the login name of the user that called Exim and a default
1065 qualification domain (which can be set by the &%qualify_domain%& configuration
1066 option). For local or batch SMTP, a sender address that is passed using the
1067 SMTP MAIL command is ignored. However, the system administrator may allow
1068 certain users (&"trusted users"&) to specify a different sender address
1069 unconditionally, or all users to specify certain forms of different sender
1070 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1071 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1072 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1073 users to change sender addresses.
1074
1075 Messages received by either of the non-interactive mechanisms are subject to
1076 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1077 (either over TCP/IP, or interacting with a local process) can be checked by a
1078 number of ACLs that operate at different times during the SMTP session. Either
1079 individual recipients, or the entire message, can be rejected if local policy
1080 requirements are not met. The &[local_scan()]& function (see chapter
1081 &<<CHAPlocalscan>>&) is run for all incoming messages.
1082
1083 Exim can be configured not to start a delivery process when a message is
1084 received; this can be unconditional, or depend on the number of incoming SMTP
1085 connections or the system load. In these situations, new messages wait on the
1086 queue until a queue runner process picks them up. However, in standard
1087 configurations under normal conditions, delivery is started as soon as a
1088 message is received.
1089
1090
1091
1092
1093
1094 .section "Handling an incoming message" "SECID14"
1095 .cindex "spool directory" "files that hold a message"
1096 .cindex "file" "how a message is held"
1097 When Exim accepts a message, it writes two files in its spool directory. The
1098 first contains the envelope information, the current status of the message, and
1099 the header lines, and the second contains the body of the message. The names of
1100 the two spool files consist of the message id, followed by &`-H`& for the
1101 file containing the envelope and header, and &`-D`& for the data file.
1102
1103 .cindex "spool directory" "&_input_& sub-directory"
1104 By default all these message files are held in a single directory called
1105 &_input_& inside the general Exim spool directory. Some operating systems do
1106 not perform very well if the number of files in a directory gets large; to
1107 improve performance in such cases, the &%split_spool_directory%& option can be
1108 used. This causes Exim to split up the input files into 62 sub-directories
1109 whose names are single letters or digits. When this is done, the queue is
1110 processed one sub-directory at a time instead of all at once, which can improve
1111 overall performance even when there are not enough files in each directory to
1112 affect file system performance.
1113
1114 The envelope information consists of the address of the message's sender and
1115 the addresses of the recipients. This information is entirely separate from
1116 any addresses contained in the header lines. The status of the message includes
1117 a list of recipients who have already received the message. The format of the
1118 first spool file is described in chapter &<<CHAPspool>>&.
1119
1120 .cindex "rewriting" "addresses"
1121 Address rewriting that is specified in the rewrite section of the configuration
1122 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1123 both in the header lines and the envelope, at the time the message is accepted.
1124 If during the course of delivery additional addresses are generated (for
1125 example, via aliasing), these new addresses are rewritten as soon as they are
1126 generated. At the time a message is actually delivered (transported) further
1127 rewriting can take place; because this is a transport option, it can be
1128 different for different forms of delivery. It is also possible to specify the
1129 addition or removal of certain header lines at the time the message is
1130 delivered (see chapters &<<CHAProutergeneric>>& and
1131 &<<CHAPtransportgeneric>>&).
1132
1133
1134
1135 .section "Life of a message" "SECID15"
1136 .cindex "message" "life of"
1137 .cindex "message" "frozen"
1138 A message remains in the spool directory until it is completely delivered to
1139 its recipients or to an error address, or until it is deleted by an
1140 administrator or by the user who originally created it. In cases when delivery
1141 cannot proceed &-- for example, when a message can neither be delivered to its
1142 recipients nor returned to its sender, the message is marked &"frozen"& on the
1143 spool, and no more deliveries are attempted.
1144
1145 .cindex "frozen messages" "thawing"
1146 .cindex "message" "thawing frozen"
1147 An administrator can &"thaw"& such messages when the problem has been
1148 corrected, and can also freeze individual messages by hand if necessary. In
1149 addition, an administrator can force a delivery error, causing a bounce message
1150 to be sent.
1151
1152 .oindex "&%timeout_frozen_after%&"
1153 .oindex "&%ignore_bounce_errors_after%&"
1154 There are options called &%ignore_bounce_errors_after%& and
1155 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1156 The first applies only to frozen bounces, the second to any frozen messages.
1157
1158 .cindex "message" "log file for"
1159 .cindex "log" "file for each message"
1160 While Exim is working on a message, it writes information about each delivery
1161 attempt to its main log file. This includes successful, unsuccessful, and
1162 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1163 lines are also written to a separate &'message log'& file for each message.
1164 These logs are solely for the benefit of the administrator, and are normally
1165 deleted along with the spool files when processing of a message is complete.
1166 The use of individual message logs can be disabled by setting
1167 &%no_message_logs%&; this might give an improvement in performance on very busy
1168 systems.
1169
1170 .cindex "journal file"
1171 .cindex "file" "journal"
1172 All the information Exim itself needs to set up a delivery is kept in the first
1173 spool file, along with the header lines. When a successful delivery occurs, the
1174 address is immediately written at the end of a journal file, whose name is the
1175 message id followed by &`-J`&. At the end of a delivery run, if there are some
1176 addresses left to be tried again later, the first spool file (the &`-H`& file)
1177 is updated to indicate which these are, and the journal file is then deleted.
1178 Updating the spool file is done by writing a new file and renaming it, to
1179 minimize the possibility of data loss.
1180
1181 Should the system or the program crash after a successful delivery but before
1182 the spool file has been updated, the journal is left lying around. The next
1183 time Exim attempts to deliver the message, it reads the journal file and
1184 updates the spool file before proceeding. This minimizes the chances of double
1185 deliveries caused by crashes.
1186
1187
1188
1189 .section "Processing an address for delivery" "SECTprocaddress"
1190 .cindex "drivers" "definition of"
1191 .cindex "router" "definition of"
1192 .cindex "transport" "definition of"
1193 The main delivery processing elements of Exim are called &'routers'& and
1194 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1195 number of them is provided in the source distribution, and compile-time options
1196 specify which ones are included in the binary. Run time options specify which
1197 ones are actually used for delivering messages.
1198
1199 .cindex "drivers" "instance definition"
1200 Each driver that is specified in the run time configuration is an &'instance'&
1201 of that particular driver type. Multiple instances are allowed; for example,
1202 you can set up several different &(smtp)& transports, each with different
1203 option values that might specify different ports or different timeouts. Each
1204 instance has its own identifying name. In what follows we will normally use the
1205 instance name when discussing one particular instance (that is, one specific
1206 configuration of the driver), and the generic driver name when discussing
1207 the driver's features in general.
1208
1209 A &'router'& is a driver that operates on an address, either determining how
1210 its delivery should happen, by assigning it to a specific transport, or
1211 converting the address into one or more new addresses (for example, via an
1212 alias file). A router may also explicitly choose to fail an address, causing it
1213 to be bounced.
1214
1215 A &'transport'& is a driver that transmits a copy of the message from Exim's
1216 spool to some destination. There are two kinds of transport: for a &'local'&
1217 transport, the destination is a file or a pipe on the local host, whereas for a
1218 &'remote'& transport the destination is some other host. A message is passed
1219 to a specific transport as a result of successful routing. If a message has
1220 several recipients, it may be passed to a number of different transports.
1221
1222 .cindex "preconditions" "definition of"
1223 An address is processed by passing it to each configured router instance in
1224 turn, subject to certain preconditions, until a router accepts the address or
1225 specifies that it should be bounced. We will describe this process in more
1226 detail shortly. First, as a simple example, we consider how each recipient
1227 address in a message is processed in a small configuration of three routers.
1228
1229 To make this a more concrete example, it is described in terms of some actual
1230 routers, but remember, this is only an example. You can configure Exim's
1231 routers in many different ways, and there may be any number of routers in a
1232 configuration.
1233
1234 The first router that is specified in a configuration is often one that handles
1235 addresses in domains that are not recognized specially by the local host. These
1236 are typically addresses for arbitrary domains on the Internet. A precondition
1237 is set up which looks for the special domains known to the host (for example,
1238 its own domain name), and the router is run for addresses that do &'not'&
1239 match. Typically, this is a router that looks up domains in the DNS in order to
1240 find the hosts to which this address routes. If it succeeds, the address is
1241 assigned to a suitable SMTP transport; if it does not succeed, the router is
1242 configured to fail the address.
1243
1244 The second router is reached only when the domain is recognized as one that
1245 &"belongs"& to the local host. This router does redirection &-- also known as
1246 aliasing and forwarding. When it generates one or more new addresses from the
1247 original, each of them is routed independently from the start. Otherwise, the
1248 router may cause an address to fail, or it may simply decline to handle the
1249 address, in which case the address is passed to the next router.
1250
1251 The final router in many configurations is one that checks to see if the
1252 address belongs to a local mailbox. The precondition may involve a check to
1253 see if the local part is the name of a login account, or it may look up the
1254 local part in a file or a database. If its preconditions are not met, or if
1255 the router declines, we have reached the end of the routers. When this happens,
1256 the address is bounced.
1257
1258
1259
1260 .section "Processing an address for verification" "SECID16"
1261 .cindex "router" "for verification"
1262 .cindex "verifying address" "overview"
1263 As well as being used to decide how to deliver to an address, Exim's routers
1264 are also used for &'address verification'&. Verification can be requested as
1265 one of the checks to be performed in an ACL for incoming messages, on both
1266 sender and recipient addresses, and it can be tested using the &%-bv%& and
1267 &%-bvs%& command line options.
1268
1269 When an address is being verified, the routers are run in &"verify mode"&. This
1270 does not affect the way the routers work, but it is a state that can be
1271 detected. By this means, a router can be skipped or made to behave differently
1272 when verifying. A common example is a configuration in which the first router
1273 sends all messages to a message-scanning program, unless they have been
1274 previously scanned. Thus, the first router accepts all addresses without any
1275 checking, making it useless for verifying. Normally, the &%no_verify%& option
1276 would be set for such a router, causing it to be skipped in verify mode.
1277
1278
1279
1280
1281 .section "Running an individual router" "SECTrunindrou"
1282 .cindex "router" "running details"
1283 .cindex "preconditions" "checking"
1284 .cindex "router" "result of running"
1285 As explained in the example above, a number of preconditions are checked before
1286 running a router. If any are not met, the router is skipped, and the address is
1287 passed to the next router. When all the preconditions on a router &'are'& met,
1288 the router is run. What happens next depends on the outcome, which is one of
1289 the following:
1290
1291 .ilist
1292 &'accept'&: The router accepts the address, and either assigns it to a
1293 transport, or generates one or more &"child"& addresses. Processing the
1294 original address ceases,
1295 .oindex "&%unseen%&"
1296 unless the &%unseen%& option is set on the router. This option
1297 can be used to set up multiple deliveries with different routing (for example,
1298 for keeping archive copies of messages). When &%unseen%& is set, the address is
1299 passed to the next router. Normally, however, an &'accept'& return marks the
1300 end of routing.
1301
1302 Any child addresses generated by the router are processed independently,
1303 starting with the first router by default. It is possible to change this by
1304 setting the &%redirect_router%& option to specify which router to start at for
1305 child addresses. Unlike &%pass_router%& (see below) the router specified by
1306 &%redirect_router%& may be anywhere in the router configuration.
1307 .next
1308 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1309 requests that the address be passed to another router. By default the address
1310 is passed to the next router, but this can be changed by setting the
1311 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1312 must be below the current router (to avoid loops).
1313 .next
1314 &'decline'&: The router declines to accept the address because it does not
1315 recognize it at all. By default, the address is passed to the next router, but
1316 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1317 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1318 &'decline'& into &'fail'&.
1319 .next
1320 &'fail'&: The router determines that the address should fail, and queues it for
1321 the generation of a bounce message. There is no further processing of the
1322 original address unless &%unseen%& is set on the router.
1323 .next
1324 &'defer'&: The router cannot handle the address at the present time. (A
1325 database may be offline, or a DNS lookup may have timed out.) No further
1326 processing of the address happens in this delivery attempt. It is tried again
1327 next time the message is considered for delivery.
1328 .next
1329 &'error'&: There is some error in the router (for example, a syntax error in
1330 its configuration). The action is as for defer.
1331 .endlist
1332
1333 If an address reaches the end of the routers without having been accepted by
1334 any of them, it is bounced as unrouteable. The default error message in this
1335 situation is &"unrouteable address"&, but you can set your own message by
1336 making use of the &%cannot_route_message%& option. This can be set for any
1337 router; the value from the last router that &"saw"& the address is used.
1338
1339 Sometimes while routing you want to fail a delivery when some conditions are
1340 met but others are not, instead of passing the address on for further routing.
1341 You can do this by having a second router that explicitly fails the delivery
1342 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1343 facility for this purpose.
1344
1345
1346 .section "Duplicate addresses" "SECID17"
1347 .cindex "case of local parts"
1348 .cindex "address duplicate, discarding"
1349 .cindex "duplicate addresses"
1350 Once routing is complete, Exim scans the addresses that are assigned to local
1351 and remote transports, and discards any duplicates that it finds. During this
1352 check, local parts are treated as case-sensitive. This happens only when
1353 actually delivering a message; when testing routers with &%-bt%&, all the
1354 routed addresses are shown.
1355
1356
1357
1358 .section "Router preconditions" "SECTrouprecon"
1359 .cindex "router" "preconditions, order of processing"
1360 .cindex "preconditions" "order of processing"
1361 The preconditions that are tested for each router are listed below, in the
1362 order in which they are tested. The individual configuration options are
1363 described in more detail in chapter &<<CHAProutergeneric>>&.
1364
1365 .ilist
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 If the &%local_parts%& option is set, the local part of the address must be in
1403 the set of local parts that it defines. If &%local_part_prefix%& or
1404 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1405 part before this check. If you want to do precondition tests on local parts
1406 that include affixes, you can do so by using a &%condition%& option (see below)
1407 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1408 &$local_part_suffix$& as necessary.
1409 .next
1410 .vindex "&$local_user_uid$&"
1411 .vindex "&$local_user_gid$&"
1412 .vindex "&$home$&"
1413 If the &%check_local_user%& option is set, the local part must be the name of
1414 an account on the local host. If this check succeeds, the uid and gid of the
1415 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1416 user's home directory is placed in &$home$&; these values can be used in the
1417 remaining preconditions.
1418 .next
1419 If the &%router_home_directory%& option is set, it is expanded at this point,
1420 because it overrides the value of &$home$&. If this expansion were left till
1421 later, the value of &$home$& as set by &%check_local_user%& would be used in
1422 subsequent tests. Having two different values of &$home$& in the same router
1423 could lead to confusion.
1424 .next
1425 If the &%senders%& option is set, the envelope sender address must be in the
1426 set of addresses that it defines.
1427 .next
1428 If the &%require_files%& option is set, the existence or non-existence of
1429 specified files is tested.
1430 .next
1431 .cindex "customizing" "precondition"
1432 If the &%condition%& option is set, it is evaluated and tested. This option
1433 uses an expanded string to allow you to set up your own custom preconditions.
1434 Expanded strings are described in chapter &<<CHAPexpand>>&.
1435 .endlist
1436
1437
1438 Note that &%require_files%& comes near the end of the list, so you cannot use
1439 it to check for the existence of a file in which to lookup up a domain, local
1440 part, or sender. However, as these options are all expanded, you can use the
1441 &%exists%& expansion condition to make such tests within each condition. The
1442 &%require_files%& option is intended for checking files that the router may be
1443 going to use internally, or which are needed by a specific transport (for
1444 example, &_.procmailrc_&).
1445
1446
1447
1448 .section "Delivery in detail" "SECID18"
1449 .cindex "delivery" "in detail"
1450 When a message is to be delivered, the sequence of events is as follows:
1451
1452 .ilist
1453 If a system-wide filter file is specified, the message is passed to it. The
1454 filter may add recipients to the message, replace the recipients, discard the
1455 message, cause a new message to be generated, or cause the message delivery to
1456 fail. The format of the system filter file is the same as for Exim user filter
1457 files, described in the separate document entitled &'Exim's interfaces to mail
1458 filtering'&.
1459 .cindex "Sieve filter" "not available for system filter"
1460 (&*Note*&: Sieve cannot be used for system filter files.)
1461
1462 Some additional features are available in system filters &-- see chapter
1463 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1464 filter only once per delivery attempt, however many recipients it has. However,
1465 if there are several delivery attempts because one or more addresses could not
1466 be immediately delivered, the system filter is run each time. The filter
1467 condition &%first_delivery%& can be used to detect the first run of the system
1468 filter.
1469 .next
1470 Each recipient address is offered to each configured router in turn, subject to
1471 its preconditions, until one is able to handle it. If no router can handle the
1472 address, that is, if they all decline, the address is failed. Because routers
1473 can be targeted at particular domains, several locally handled domains can be
1474 processed entirely independently of each other.
1475 .next
1476 .cindex "routing" "loops in"
1477 .cindex "loop" "while routing"
1478 A router that accepts an address may assign it to a local or a remote
1479 transport. However, the transport is not run at this time. Instead, the address
1480 is placed on a list for the particular transport, which will be run later.
1481 Alternatively, the router may generate one or more new addresses (typically
1482 from alias, forward, or filter files). New addresses are fed back into this
1483 process from the top, but in order to avoid loops, a router ignores any address
1484 which has an identically-named ancestor that was processed by itself.
1485 .next
1486 When all the routing has been done, addresses that have been successfully
1487 handled are passed to their assigned transports. When local transports are
1488 doing real local deliveries, they handle only one address at a time, but if a
1489 local transport is being used as a pseudo-remote transport (for example, to
1490 collect batched SMTP messages for transmission by some other means) multiple
1491 addresses can be handled. Remote transports can always handle more than one
1492 address at a time, but can be configured not to do so, or to restrict multiple
1493 addresses to the same domain.
1494 .next
1495 Each local delivery to a file or a pipe runs in a separate process under a
1496 non-privileged uid, and these deliveries are run one at a time. Remote
1497 deliveries also run in separate processes, normally under a uid that is private
1498 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1499 run in parallel. The maximum number of simultaneous remote deliveries for any
1500 one message is set by the &%remote_max_parallel%& option.
1501 The order in which deliveries are done is not defined, except that all local
1502 deliveries happen before any remote deliveries.
1503 .next
1504 .cindex "queue runner"
1505 When it encounters a local delivery during a queue run, Exim checks its retry
1506 database to see if there has been a previous temporary delivery failure for the
1507 address before running the local transport. If there was a previous failure,
1508 Exim does not attempt a new delivery until the retry time for the address is
1509 reached. However, this happens only for delivery attempts that are part of a
1510 queue run. Local deliveries are always attempted when delivery immediately
1511 follows message reception, even if retry times are set for them. This makes for
1512 better behaviour if one particular message is causing problems (for example,
1513 causing quota overflow, or provoking an error in a filter file).
1514 .next
1515 .cindex "delivery" "retry in remote transports"
1516 Remote transports do their own retry handling, since an address may be
1517 deliverable to one of a number of hosts, each of which may have a different
1518 retry time. If there have been previous temporary failures and no host has
1519 reached its retry time, no delivery is attempted, whether in a queue run or
1520 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1521 .next
1522 If there were any permanent errors, a bounce message is returned to an
1523 appropriate address (the sender in the common case), with details of the error
1524 for each failing address. Exim can be configured to send copies of bounce
1525 messages to other addresses.
1526 .next
1527 .cindex "delivery" "deferral"
1528 If one or more addresses suffered a temporary failure, the message is left on
1529 the queue, to be tried again later. Delivery of these addresses is said to be
1530 &'deferred'&.
1531 .next
1532 When all the recipient addresses have either been delivered or bounced,
1533 handling of the message is complete. The spool files and message log are
1534 deleted, though the message log can optionally be preserved if required.
1535 .endlist
1536
1537
1538
1539
1540 .section "Retry mechanism" "SECID19"
1541 .cindex "delivery" "retry mechanism"
1542 .cindex "retry" "description of mechanism"
1543 .cindex "queue runner"
1544 Exim's mechanism for retrying messages that fail to get delivered at the first
1545 attempt is the queue runner process. You must either run an Exim daemon that
1546 uses the &%-q%& option with a time interval to start queue runners at regular
1547 intervals, or use some other means (such as &'cron'&) to start them. If you do
1548 not arrange for queue runners to be run, messages that fail temporarily at the
1549 first attempt will remain on your queue for ever. A queue runner process works
1550 its way through the queue, one message at a time, trying each delivery that has
1551 passed its retry time.
1552 You can run several queue runners at once.
1553
1554 Exim uses a set of configured rules to determine when next to retry the failing
1555 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1556 should give up trying to deliver to the address, at which point it generates a
1557 bounce message. If no retry rules are set for a particular host, address, and
1558 error combination, no retries are attempted, and temporary errors are treated
1559 as permanent.
1560
1561
1562
1563 .section "Temporary delivery failure" "SECID20"
1564 .cindex "delivery" "temporary failure"
1565 There are many reasons why a message may not be immediately deliverable to a
1566 particular address. Failure to connect to a remote machine (because it, or the
1567 connection to it, is down) is one of the most common. Temporary failures may be
1568 detected during routing as well as during the transport stage of delivery.
1569 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1570 is on a file system where the user is over quota. Exim can be configured to
1571 impose its own quotas on local mailboxes; where system quotas are set they will
1572 also apply.
1573
1574 If a host is unreachable for a period of time, a number of messages may be
1575 waiting for it by the time it recovers, and sending them in a single SMTP
1576 connection is clearly beneficial. Whenever a delivery to a remote host is
1577 deferred,
1578 .cindex "hints database"
1579 Exim makes a note in its hints database, and whenever a successful
1580 SMTP delivery has happened, it looks to see if any other messages are waiting
1581 for the same host. If any are found, they are sent over the same SMTP
1582 connection, subject to a configuration limit as to the maximum number in any
1583 one connection.
1584
1585
1586
1587 .section "Permanent delivery failure" "SECID21"
1588 .cindex "delivery" "permanent failure"
1589 .cindex "bounce message" "when generated"
1590 When a message cannot be delivered to some or all of its intended recipients, a
1591 bounce message is generated. Temporary delivery failures turn into permanent
1592 errors when their timeout expires. All the addresses that fail in a given
1593 delivery attempt are listed in a single message. If the original message has
1594 many recipients, it is possible for some addresses to fail in one delivery
1595 attempt and others to fail subsequently, giving rise to more than one bounce
1596 message. The wording of bounce messages can be customized by the administrator.
1597 See chapter &<<CHAPemsgcust>>& for details.
1598
1599 .cindex "&'X-Failed-Recipients:'& header line"
1600 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1601 failed addresses, for the benefit of programs that try to analyse such messages
1602 automatically.
1603
1604 .cindex "bounce message" "recipient of"
1605 A bounce message is normally sent to the sender of the original message, as
1606 obtained from the message's envelope. For incoming SMTP messages, this is the
1607 address given in the MAIL command. However, when an address is expanded via a
1608 forward or alias file, an alternative address can be specified for delivery
1609 failures of the generated addresses. For a mailing list expansion (see section
1610 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1611 of the list.
1612
1613
1614
1615 .section "Failures to deliver bounce messages" "SECID22"
1616 .cindex "bounce message" "failure to deliver"
1617 If a bounce message (either locally generated or received from a remote host)
1618 itself suffers a permanent delivery failure, the message is left on the queue,
1619 but it is frozen, awaiting the attention of an administrator. There are options
1620 that can be used to make Exim discard such failed messages, or to keep them
1621 for only a short time (see &%timeout_frozen_after%& and
1622 &%ignore_bounce_errors_after%&).
1623
1624
1625
1626
1627
1628 . ////////////////////////////////////////////////////////////////////////////
1629 . ////////////////////////////////////////////////////////////////////////////
1630
1631 .chapter "Building and installing Exim" "CHID3"
1632 .scindex IIDbuex "building Exim"
1633
1634 .section "Unpacking" "SECID23"
1635 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1636 creates a directory with the name of the current release (for example,
1637 &_exim-&version()_&) into which the following files are placed:
1638
1639 .table2 140pt
1640 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1641 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1642   documented"
1643 .irow &_LICENCE_&         "the GNU General Public Licence"
1644 .irow &_Makefile_&        "top-level make file"
1645 .irow &_NOTICE_&          "conditions for the use of Exim"
1646 .irow &_README_&          "list of files, directories and simple build &&&
1647   instructions"
1648 .endtable
1649
1650 Other files whose names begin with &_README_& may also be present. The
1651 following subdirectories are created:
1652
1653 .table2 140pt
1654 .irow &_Local_&           "an empty directory for local configuration files"
1655 .irow &_OS_&              "OS-specific files"
1656 .irow &_doc_&             "documentation files"
1657 .irow &_exim_monitor_&    "source files for the Exim monitor"
1658 .irow &_scripts_&         "scripts used in the build process"
1659 .irow &_src_&             "remaining source files"
1660 .irow &_util_&            "independent utilities"
1661 .endtable
1662
1663 The main utility programs are contained in the &_src_& directory, and are built
1664 with the Exim binary. The &_util_& directory contains a few optional scripts
1665 that may be useful to some sites.
1666
1667
1668 .section "Multiple machine architectures and operating systems" "SECID24"
1669 .cindex "building Exim" "multiple OS/architectures"
1670 The building process for Exim is arranged to make it easy to build binaries for
1671 a number of different architectures and operating systems from the same set of
1672 source files. Compilation does not take place in the &_src_& directory.
1673 Instead, a &'build directory'& is created for each architecture and operating
1674 system.
1675 .cindex "symbolic link" "to build directory"
1676 Symbolic links to the sources are installed in this directory, which is where
1677 the actual building takes place. In most cases, Exim can discover the machine
1678 architecture and operating system for itself, but the defaults can be
1679 overridden if necessary.
1680
1681
1682 .section "PCRE library" "SECTpcre"
1683 .cindex "PCRE library"
1684 Exim no longer has an embedded PCRE library as the vast majority of
1685 modern systems include PCRE as a system library, although you may need
1686 to install the PCRE or PCRE development package for your operating
1687 system. If your system has a normal PCRE installation the Exim build
1688 process will need no further configuration. If the library or the
1689 headers are in an unusual location you will need to either set the PCRE_LIBS
1690 and INCLUDE directives appropriately,
1691 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1692 If your operating system has no
1693 PCRE support then you will need to obtain and build the current PCRE
1694 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1695 More information on PCRE is available at &url(http://www.pcre.org/).
1696
1697 .section "DBM libraries" "SECTdb"
1698 .cindex "DBM libraries" "discussion of"
1699 .cindex "hints database" "DBM files used for"
1700 Even if you do not use any DBM files in your configuration, Exim still needs a
1701 DBM library in order to operate, because it uses indexed files for its hints
1702 databases. Unfortunately, there are a number of DBM libraries in existence, and
1703 different operating systems often have different ones installed.
1704
1705 .cindex "Solaris" "DBM library for"
1706 .cindex "IRIX, DBM library for"
1707 .cindex "BSD, DBM library for"
1708 .cindex "Linux, DBM library for"
1709 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1710 Linux distribution, the DBM configuration should happen automatically, and you
1711 may be able to ignore this section. Otherwise, you may have to learn more than
1712 you would like about DBM libraries from what follows.
1713
1714 .cindex "&'ndbm'& DBM library"
1715 Licensed versions of Unix normally contain a library of DBM functions operating
1716 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1717 versions of Unix seem to vary in what they contain as standard. In particular,
1718 some early versions of Linux have no default DBM library, and different
1719 distributors have chosen to bundle different libraries with their packaged
1720 versions. However, the more recent releases seem to have standardized on the
1721 Berkeley DB library.
1722
1723 Different DBM libraries have different conventions for naming the files they
1724 use. When a program opens a file called &_dbmfile_&, there are several
1725 possibilities:
1726
1727 .olist
1728 A traditional &'ndbm'& implementation, such as that supplied as part of
1729 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1730 .next
1731 .cindex "&'gdbm'& DBM library"
1732 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1733 compatibility interface it makes two different hard links to it with names
1734 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1735 file name is used unmodified.
1736 .next
1737 .cindex "Berkeley DB library"
1738 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1739 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1740 programmer exactly the same as the traditional &'ndbm'& implementation.
1741 .next
1742 If the Berkeley package is used in its native mode, it operates on a single
1743 file called &_dbmfile_&; the programmer's interface is somewhat different to
1744 the traditional &'ndbm'& interface.
1745 .next
1746 To complicate things further, there are several very different versions of the
1747 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1748 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1749 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1750 versions of Berkeley DB can be obtained from
1751 &url(http://www.sleepycat.com/).
1752 .next
1753 .cindex "&'tdb'& DBM library"
1754 Yet another DBM library, called &'tdb'&, is available from
1755 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1756 operates on a single file.
1757 .endlist
1758
1759 .cindex "USE_DB"
1760 .cindex "DBM libraries" "configuration for building"
1761 Exim and its utilities can be compiled to use any of these interfaces. In order
1762 to use any version of the Berkeley DB package in native mode, you must set
1763 USE_DB in an appropriate configuration file (typically
1764 &_Local/Makefile_&). For example:
1765 .code
1766 USE_DB=yes
1767 .endd
1768 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1769 error is diagnosed if you set more than one of these.
1770
1771 At the lowest level, the build-time configuration sets none of these options,
1772 thereby assuming an interface of type (1). However, some operating system
1773 configuration files (for example, those for the BSD operating systems and
1774 Linux) assume type (4) by setting USE_DB as their default, and the
1775 configuration files for Cygwin set USE_GDBM. Anything you set in
1776 &_Local/Makefile_&, however, overrides these system defaults.
1777
1778 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1779 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1780 in one of these lines:
1781 .code
1782 DBMLIB = -ldb
1783 DBMLIB = -ltdb
1784 .endd
1785 Settings like that will work if the DBM library is installed in the standard
1786 place. Sometimes it is not, and the library's header file may also not be in
1787 the default path. You may need to set INCLUDE to specify where the header
1788 file is, and to specify the path to the library more fully in DBMLIB, as in
1789 this example:
1790 .code
1791 INCLUDE=-I/usr/local/include/db-4.1
1792 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1793 .endd
1794 There is further detailed discussion about the various DBM libraries in the
1795 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1796
1797
1798
1799 .section "Pre-building configuration" "SECID25"
1800 .cindex "building Exim" "pre-building configuration"
1801 .cindex "configuration for building Exim"
1802 .cindex "&_Local/Makefile_&"
1803 .cindex "&_src/EDITME_&"
1804 Before building Exim, a local configuration file that specifies options
1805 independent of any operating system has to be created with the name
1806 &_Local/Makefile_&. A template for this file is supplied as the file
1807 &_src/EDITME_&, and it contains full descriptions of all the option settings
1808 therein. These descriptions are therefore not repeated here. If you are
1809 building Exim for the first time, the simplest thing to do is to copy
1810 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1811
1812 There are three settings that you must supply, because Exim will not build
1813 without them. They are the location of the run time configuration file
1814 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1815 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1816 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1817 a colon-separated list of file names; Exim uses the first of them that exists.
1818
1819 There are a few other parameters that can be specified either at build time or
1820 at run time, to enable the same binary to be used on a number of different
1821 machines. However, if the locations of Exim's spool directory and log file
1822 directory (if not within the spool directory) are fixed, it is recommended that
1823 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1824 detected early in Exim's execution (such as a malformed configuration file) can
1825 be logged.
1826
1827 .cindex "content scanning" "specifying at build time"
1828 Exim's interfaces for calling virus and spam scanning software directly from
1829 access control lists are not compiled by default. If you want to include these
1830 facilities, you need to set
1831 .code
1832 WITH_CONTENT_SCAN=yes
1833 .endd
1834 in your &_Local/Makefile_&. For details of the facilities themselves, see
1835 chapter &<<CHAPexiscan>>&.
1836
1837
1838 .cindex "&_Local/eximon.conf_&"
1839 .cindex "&_exim_monitor/EDITME_&"
1840 If you are going to build the Exim monitor, a similar configuration process is
1841 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1842 your installation and saved under the name &_Local/eximon.conf_&. If you are
1843 happy with the default settings described in &_exim_monitor/EDITME_&,
1844 &_Local/eximon.conf_& can be empty, but it must exist.
1845
1846 This is all the configuration that is needed in straightforward cases for known
1847 operating systems. However, the building process is set up so that it is easy
1848 to override options that are set by default or by operating-system-specific
1849 configuration files, for example to change the name of the C compiler, which
1850 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1851 do this.
1852
1853
1854
1855 .section "Support for iconv()" "SECID26"
1856 .cindex "&[iconv()]& support"
1857 .cindex "RFC 2047"
1858 The contents of header lines in messages may be encoded according to the rules
1859 described RFC 2047. This makes it possible to transmit characters that are not
1860 in the ASCII character set, and to label them as being in a particular
1861 character set. When Exim is inspecting header lines by means of the &%$h_%&
1862 mechanism, it decodes them, and translates them into a specified character set
1863 (default ISO-8859-1). The translation is possible only if the operating system
1864 supports the &[iconv()]& function.
1865
1866 However, some of the operating systems that supply &[iconv()]& do not support
1867 very many conversions. The GNU &%libiconv%& library (available from
1868 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1869 systems to remedy this deficiency, as well as on systems that do not supply
1870 &[iconv()]& at all. After installing &%libiconv%&, you should add
1871 .code
1872 HAVE_ICONV=yes
1873 .endd
1874 to your &_Local/Makefile_& and rebuild Exim.
1875
1876
1877
1878 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1879 .cindex "TLS" "including support for TLS"
1880 .cindex "encryption" "including support for"
1881 .cindex "SUPPORT_TLS"
1882 .cindex "OpenSSL" "building Exim with"
1883 .cindex "GnuTLS" "building Exim with"
1884 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1885 command as per RFC 2487. It can also support legacy clients that expect to
1886 start a TLS session immediately on connection to a non-standard port (see the
1887 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1888 line option).
1889
1890 If you want to build Exim with TLS support, you must first install either the
1891 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1892 implementing SSL.
1893
1894 If OpenSSL is installed, you should set
1895 .code
1896 SUPPORT_TLS=yes
1897 TLS_LIBS=-lssl -lcrypto
1898 .endd
1899 in &_Local/Makefile_&. You may also need to specify the locations of the
1900 OpenSSL library and include files. For example:
1901 .code
1902 SUPPORT_TLS=yes
1903 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1904 TLS_INCLUDE=-I/usr/local/openssl/include/
1905 .endd
1906 .cindex "pkg-config" "OpenSSL"
1907 If you have &'pkg-config'& available, then instead you can just use:
1908 .code
1909 SUPPORT_TLS=yes
1910 USE_OPENSSL_PC=openssl
1911 .endd
1912 .cindex "USE_GNUTLS"
1913 If GnuTLS is installed, you should set
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1918 .endd
1919 in &_Local/Makefile_&, and again you may need to specify the locations of the
1920 library and include files. For example:
1921 .code
1922 SUPPORT_TLS=yes
1923 USE_GNUTLS=yes
1924 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1925 TLS_INCLUDE=-I/usr/gnu/include
1926 .endd
1927 .cindex "pkg-config" "GnuTLS"
1928 If you have &'pkg-config'& available, then instead you can just use:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 USE_GNUTLS_PC=gnutls
1933 .endd
1934
1935 You do not need to set TLS_INCLUDE if the relevant directory is already
1936 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1937 given in chapter &<<CHAPTLS>>&.
1938
1939
1940
1941
1942 .section "Use of tcpwrappers" "SECID27"
1943
1944 .cindex "tcpwrappers, building Exim to support"
1945 .cindex "USE_TCP_WRAPPERS"
1946 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1947 .cindex "tcp_wrappers_daemon_name"
1948 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1949 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1950 alternative to Exim's own checking facilities for installations that are
1951 already making use of &'tcpwrappers'& for other purposes. To do this, you
1952 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1953 &_tcpd.h_& to be available at compile time, and also ensure that the library
1954 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1955 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1956 you might have
1957 .code
1958 USE_TCP_WRAPPERS=yes
1959 CFLAGS=-O -I/usr/local/include
1960 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1961 .endd
1962 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1963 files is &"exim"&. For example, the line
1964 .code
1965 exim : LOCAL  192.168.1.  .friendly.domain.example
1966 .endd
1967 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1968 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1969 All other connections are denied. The daemon name used by &'tcpwrappers'&
1970 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1971 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1972 configure file. Consult the &'tcpwrappers'& documentation for
1973 further details.
1974
1975
1976 .section "Including support for IPv6" "SECID28"
1977 .cindex "IPv6" "including support for"
1978 Exim contains code for use on systems that have IPv6 support. Setting
1979 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1980 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1981 where the IPv6 support is not fully integrated into the normal include and
1982 library files.
1983
1984 Two different types of DNS record for handling IPv6 addresses have been
1985 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1986 currently seen as the mainstream. Another record type called A6 was proposed
1987 as better than AAAA because it had more flexibility. However, it was felt to be
1988 over-complex, and its status was reduced to &"experimental"&. It is not known
1989 if anyone is actually using A6 records. Exim has support for A6 records, but
1990 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1991 support has not been tested for some time.
1992
1993
1994
1995 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1996 .cindex "lookup modules"
1997 .cindex "dynamic modules"
1998 .cindex ".so building"
1999 On some platforms, Exim supports not compiling all lookup types directly into
2000 the main binary, instead putting some into external modules which can be loaded
2001 on demand.
2002 This permits packagers to build Exim with support for lookups with extensive
2003 library dependencies without requiring all users to install all of those
2004 dependencies.
2005 Most, but not all, lookup types can be built this way.
2006
2007 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2008 installed; Exim will only load modules from that directory, as a security
2009 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2010 for your OS; see &_OS/Makefile-Linux_& for an example.
2011 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2012 see &_src/EDITME_& for details.
2013
2014 Then, for each module to be loaded dynamically, define the relevant
2015 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2016 For example, this will build in lsearch but load sqlite and mysql support
2017 on demand:
2018 .code
2019 LOOKUP_LSEARCH=yes
2020 LOOKUP_SQLITE=2
2021 LOOKUP_MYSQL=2
2022 .endd
2023
2024
2025 .section "The building process" "SECID29"
2026 .cindex "build directory"
2027 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2028 created, run &'make'& at the top level. It determines the architecture and
2029 operating system types, and creates a build directory if one does not exist.
2030 For example, on a Sun system running Solaris 8, the directory
2031 &_build-SunOS5-5.8-sparc_& is created.
2032 .cindex "symbolic link" "to source files"
2033 Symbolic links to relevant source files are installed in the build directory.
2034
2035 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2036 building process fails if it is set.
2037
2038 If this is the first time &'make'& has been run, it calls a script that builds
2039 a make file inside the build directory, using the configuration files from the
2040 &_Local_& directory. The new make file is then passed to another instance of
2041 &'make'&. This does the real work, building a number of utility scripts, and
2042 then compiling and linking the binaries for the Exim monitor (if configured), a
2043 number of utility programs, and finally Exim itself. The command &`make
2044 makefile`& can be used to force a rebuild of the make file in the build
2045 directory, should this ever be necessary.
2046
2047 If you have problems building Exim, check for any comments there may be in the
2048 &_README_& file concerning your operating system, and also take a look at the
2049 FAQ, where some common problems are covered.
2050
2051
2052
2053 .section 'Output from &"make"&' "SECID283"
2054 The output produced by the &'make'& process for compile lines is often very
2055 unreadable, because these lines can be very long. For this reason, the normal
2056 output is suppressed by default, and instead output similar to that which
2057 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2058 each module that is being compiled or linked. However, it is still possible to
2059 get the full output, by calling &'make'& like this:
2060 .code
2061 FULLECHO='' make -e
2062 .endd
2063 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2064 command reflection in &'make'&. When you ask for the full output, it is
2065 given in addition to the short output.
2066
2067
2068
2069 .section "Overriding build-time options for Exim" "SECToverride"
2070 .cindex "build-time options, overriding"
2071 The main make file that is created at the beginning of the building process
2072 consists of the concatenation of a number of files which set configuration
2073 values, followed by a fixed set of &'make'& instructions. If a value is set
2074 more than once, the last setting overrides any previous ones. This provides a
2075 convenient way of overriding defaults. The files that are concatenated are, in
2076 order:
2077 .display
2078 &_OS/Makefile-Default_&
2079 &_OS/Makefile-_&<&'ostype'&>
2080 &_Local/Makefile_&
2081 &_Local/Makefile-_&<&'ostype'&>
2082 &_Local/Makefile-_&<&'archtype'&>
2083 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2084 &_OS/Makefile-Base_&
2085 .endd
2086 .cindex "&_Local/Makefile_&"
2087 .cindex "building Exim" "operating system type"
2088 .cindex "building Exim" "architecture type"
2089 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2090 architecture type. &_Local/Makefile_& is required to exist, and the building
2091 process fails if it is absent. The other three &_Local_& files are optional,
2092 and are often not needed.
2093
2094 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2095 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2096 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2097 values are used, thereby providing a means of forcing particular settings.
2098 Otherwise, the scripts try to get values from the &%uname%& command. If this
2099 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2100 of &'ad hoc'& transformations are then applied, to produce the standard names
2101 that Exim expects. You can run these scripts directly from the shell in order
2102 to find out what values are being used on your system.
2103
2104
2105 &_OS/Makefile-Default_& contains comments about the variables that are set
2106 therein. Some (but not all) are mentioned below. If there is something that
2107 needs changing, review the contents of this file and the contents of the make
2108 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2109 default values are.
2110
2111
2112 .cindex "building Exim" "overriding default settings"
2113 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2114 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2115 need to change the original files. Instead, you should make the changes by
2116 putting the new values in an appropriate &_Local_& file. For example,
2117 .cindex "Tru64-Unix build-time settings"
2118 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2119 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2120 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2121 called with the option &%-std1%&, to make it recognize some of the features of
2122 Standard C that Exim uses. (Most other compilers recognize Standard C by
2123 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2124 containing the lines
2125 .code
2126 CC=cc
2127 CFLAGS=-std1
2128 .endd
2129 If you are compiling for just one operating system, it may be easier to put
2130 these lines directly into &_Local/Makefile_&.
2131
2132 Keeping all your local configuration settings separate from the distributed
2133 files makes it easy to transfer them to new versions of Exim simply by copying
2134 the contents of the &_Local_& directory.
2135
2136
2137 .cindex "NIS lookup type" "including support for"
2138 .cindex "NIS+ lookup type" "including support for"
2139 .cindex "LDAP" "including support for"
2140 .cindex "lookup" "inclusion in binary"
2141 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2142 lookup, but not all systems have these components installed, so the default is
2143 not to include the relevant code in the binary. All the different kinds of file
2144 and database lookup that Exim supports are implemented as separate code modules
2145 which are included only if the relevant compile-time options are set. In the
2146 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2147 .code
2148 LOOKUP_LDAP=yes
2149 LOOKUP_NIS=yes
2150 LOOKUP_NISPLUS=yes
2151 .endd
2152 and similar settings apply to the other lookup types. They are all listed in
2153 &_src/EDITME_&. In many cases the relevant include files and interface
2154 libraries need to be installed before compiling Exim.
2155 .cindex "cdb" "including support for"
2156 However, there are some optional lookup types (such as cdb) for which
2157 the code is entirely contained within Exim, and no external include
2158 files or libraries are required. When a lookup type is not included in the
2159 binary, attempts to configure Exim to use it cause run time configuration
2160 errors.
2161
2162 .cindex "pkg-config" "lookups"
2163 .cindex "pkg-config" "authenticators"
2164 Many systems now use a tool called &'pkg-config'& to encapsulate information
2165 about how to compile against a library; Exim has some initial support for
2166 being able to use pkg-config for lookups and authenticators.  For any given
2167 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2168 variable with the &`_PC`& suffix in the name and assign as the value the
2169 name of the package to be queried.  The results of querying via the
2170 &'pkg-config'& command will be added to the appropriate Makefile variables
2171 with &`+=`& directives, so your version of &'make'& will need to support that
2172 syntax.  For instance:
2173 .code
2174 LOOKUP_SQLITE=yes
2175 LOOKUP_SQLITE_PC=sqlite3
2176 AUTH_GSASL=yes
2177 AUTH_GSASL_PC=libgsasl
2178 AUTH_HEIMDAL_GSSAPI=yes
2179 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2180 .endd
2181
2182 .cindex "Perl" "including support for"
2183 Exim can be linked with an embedded Perl interpreter, allowing Perl
2184 subroutines to be called during string expansion. To enable this facility,
2185 .code
2186 EXIM_PERL=perl.o
2187 .endd
2188 must be defined in &_Local/Makefile_&. Details of this facility are given in
2189 chapter &<<CHAPperl>>&.
2190
2191 .cindex "X11 libraries, location of"
2192 The location of the X11 libraries is something that varies a lot between
2193 operating systems, and there may be different versions of X11 to cope
2194 with. Exim itself makes no use of X11, but if you are compiling the Exim
2195 monitor, the X11 libraries must be available.
2196 The following three variables are set in &_OS/Makefile-Default_&:
2197 .code
2198 X11=/usr/X11R6
2199 XINCLUDE=-I$(X11)/include
2200 XLFLAGS=-L$(X11)/lib
2201 .endd
2202 These are overridden in some of the operating-system configuration files. For
2203 example, in &_OS/Makefile-SunOS5_& there is
2204 .code
2205 X11=/usr/openwin
2206 XINCLUDE=-I$(X11)/include
2207 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2208 .endd
2209 If you need to override the default setting for your operating system, place a
2210 definition of all three of these variables into your
2211 &_Local/Makefile-<ostype>_& file.
2212
2213 .cindex "EXTRALIBS"
2214 If you need to add any extra libraries to the link steps, these can be put in a
2215 variable called EXTRALIBS, which appears in all the link commands, but by
2216 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2217 command for linking the main Exim binary, and not for any associated utilities.
2218
2219 .cindex "DBM libraries" "configuration for building"
2220 There is also DBMLIB, which appears in the link commands for binaries that
2221 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2222 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2223 binary, and which can be used, for example, to include additional X11
2224 libraries.
2225
2226 .cindex "configuration file" "editing"
2227 The make file copes with rebuilding Exim correctly if any of the configuration
2228 files are edited. However, if an optional configuration file is deleted, it is
2229 necessary to touch the associated non-optional file (that is,
2230 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2231
2232
2233 .section "OS-specific header files" "SECID30"
2234 .cindex "&_os.h_&"
2235 .cindex "building Exim" "OS-specific C header files"
2236 The &_OS_& directory contains a number of files with names of the form
2237 &_os.h-<ostype>_&. These are system-specific C header files that should not
2238 normally need to be changed. There is a list of macro settings that are
2239 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2240 are porting Exim to a new operating system.
2241
2242
2243
2244 .section "Overriding build-time options for the monitor" "SECID31"
2245 .cindex "building Eximon"
2246 A similar process is used for overriding things when building the Exim monitor,
2247 where the files that are involved are
2248 .display
2249 &_OS/eximon.conf-Default_&
2250 &_OS/eximon.conf-_&<&'ostype'&>
2251 &_Local/eximon.conf_&
2252 &_Local/eximon.conf-_&<&'ostype'&>
2253 &_Local/eximon.conf-_&<&'archtype'&>
2254 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2255 .endd
2256 .cindex "&_Local/eximon.conf_&"
2257 As with Exim itself, the final three files need not exist, and in this case the
2258 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2259 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2260 variables of the same name, preceded by EXIMON_. For example, setting
2261 EXIMON_LOG_DEPTH in the environment overrides the value of
2262 LOG_DEPTH at run time.
2263 .ecindex IIDbuex
2264
2265
2266 .section "Installing Exim binaries and scripts" "SECID32"
2267 .cindex "installing Exim"
2268 .cindex "BIN_DIRECTORY"
2269 The command &`make install`& runs the &(exim_install)& script with no
2270 arguments. The script copies binaries and utility scripts into the directory
2271 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2272 .cindex "setuid" "installing Exim with"
2273 The install script copies files only if they are newer than the files they are
2274 going to replace. The Exim binary is required to be owned by root and have the
2275 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2276 install`& as root so that it can set up the Exim binary in this way. However, in
2277 some special situations (for example, if a host is doing no local deliveries)
2278 it may be possible to run Exim without making the binary setuid root (see
2279 chapter &<<CHAPsecurity>>& for details).
2280
2281 .cindex "CONFIGURE_FILE"
2282 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2283 in &_Local/Makefile_&. If this names a single file, and the file does not
2284 exist, the default configuration file &_src/configure.default_& is copied there
2285 by the installation script. If a run time configuration file already exists, it
2286 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2287 alternative files, no default is installed.
2288
2289 .cindex "system aliases file"
2290 .cindex "&_/etc/aliases_&"
2291 One change is made to the default configuration file when it is installed: the
2292 default configuration contains a router that references a system aliases file.
2293 The path to this file is set to the value specified by
2294 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2295 If the system aliases file does not exist, the installation script creates it,
2296 and outputs a comment to the user.
2297
2298 The created file contains no aliases, but it does contain comments about the
2299 aliases a site should normally have. Mail aliases have traditionally been
2300 kept in &_/etc/aliases_&. However, some operating systems are now using
2301 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2302 Exim's configuration if necessary.
2303
2304 The default configuration uses the local host's name as the only local domain,
2305 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2306 running as the local user. System aliases and &_.forward_& files in users' home
2307 directories are supported, but no NIS or NIS+ support is configured. Domains
2308 other than the name of the local host are routed using the DNS, with delivery
2309 over SMTP.
2310
2311 It is possible to install Exim for special purposes (such as building a binary
2312 distribution) in a private part of the file system. You can do this by a
2313 command such as
2314 .code
2315 make DESTDIR=/some/directory/ install
2316 .endd
2317 This has the effect of pre-pending the specified directory to all the file
2318 paths, except the name of the system aliases file that appears in the default
2319 configuration. (If a default alias file is created, its name &'is'& modified.)
2320 For backwards compatibility, ROOT is used if DESTDIR is not set,
2321 but this usage is deprecated.
2322
2323 .cindex "installing Exim" "what is not installed"
2324 Running &'make install'& does not copy the Exim 4 conversion script
2325 &'convert4r4'&. You will probably run this only once if you are
2326 upgrading from Exim 3. None of the documentation files in the &_doc_&
2327 directory are copied, except for the info files when you have set
2328 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2329
2330 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2331 to their names. The Exim binary itself, however, is handled differently. It is
2332 installed under a name that includes the version number and the compile number,
2333 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2334 called &_exim_& to point to the binary. If you are updating a previous version
2335 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2336 from the directory (as seen by other processes).
2337
2338 .cindex "installing Exim" "testing the script"
2339 If you want to see what the &'make install'& will do before running it for
2340 real, you can pass the &%-n%& option to the installation script by this
2341 command:
2342 .code
2343 make INSTALL_ARG=-n install
2344 .endd
2345 The contents of the variable INSTALL_ARG are passed to the installation
2346 script. You do not need to be root to run this test. Alternatively, you can run
2347 the installation script directly, but this must be from within the build
2348 directory. For example, from the top-level Exim directory you could use this
2349 command:
2350 .code
2351 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2352 .endd
2353 .cindex "installing Exim" "install script options"
2354 There are two other options that can be supplied to the installation script.
2355
2356 .ilist
2357 &%-no_chown%& bypasses the call to change the owner of the installed binary
2358 to root, and the call to make it a setuid binary.
2359 .next
2360 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2361 installed binary.
2362 .endlist
2363
2364 INSTALL_ARG can be used to pass these options to the script. For example:
2365 .code
2366 make INSTALL_ARG=-no_symlink install
2367 .endd
2368 The installation script can also be given arguments specifying which files are
2369 to be copied. For example, to install just the Exim binary, and nothing else,
2370 without creating the symbolic link, you could use:
2371 .code
2372 make INSTALL_ARG='-no_symlink exim' install
2373 .endd
2374
2375
2376
2377 .section "Installing info documentation" "SECTinsinfdoc"
2378 .cindex "installing Exim" "&'info'& documentation"
2379 Not all systems use the GNU &'info'& system for documentation, and for this
2380 reason, the Texinfo source of Exim's documentation is not included in the main
2381 distribution. Instead it is available separately from the ftp site (see section
2382 &<<SECTavail>>&).
2383
2384 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2385 source of the documentation is found in the source tree, running &`make
2386 install`& automatically builds the info files and installs them.
2387
2388
2389
2390 .section "Setting up the spool directory" "SECID33"
2391 .cindex "spool directory" "creating"
2392 When it starts up, Exim tries to create its spool directory if it does not
2393 exist. The Exim uid and gid are used for the owner and group of the spool
2394 directory. Sub-directories are automatically created in the spool directory as
2395 necessary.
2396
2397
2398
2399
2400 .section "Testing" "SECID34"
2401 .cindex "testing" "installation"
2402 Having installed Exim, you can check that the run time configuration file is
2403 syntactically valid by running the following command, which assumes that the
2404 Exim binary directory is within your PATH environment variable:
2405 .code
2406 exim -bV
2407 .endd
2408 If there are any errors in the configuration file, Exim outputs error messages.
2409 Otherwise it outputs the version number and build date,
2410 the DBM library that is being used, and information about which drivers and
2411 other optional code modules are included in the binary.
2412 Some simple routing tests can be done by using the address testing option. For
2413 example,
2414 .display
2415 &`exim -bt`& <&'local username'&>
2416 .endd
2417 should verify that it recognizes a local mailbox, and
2418 .display
2419 &`exim -bt`& <&'remote address'&>
2420 .endd
2421 a remote one. Then try getting it to deliver mail, both locally and remotely.
2422 This can be done by passing messages directly to Exim, without going through a
2423 user agent. For example:
2424 .code
2425 exim -v postmaster@your.domain.example
2426 From: user@your.domain.example
2427 To: postmaster@your.domain.example
2428 Subject: Testing Exim
2429
2430 This is a test message.
2431 ^D
2432 .endd
2433 The &%-v%& option causes Exim to output some verification of what it is doing.
2434 In this case you should see copies of three log lines, one for the message's
2435 arrival, one for its delivery, and one containing &"Completed"&.
2436
2437 .cindex "delivery" "problems with"
2438 If you encounter problems, look at Exim's log files (&'mainlog'& and
2439 &'paniclog'&) to see if there is any relevant information there. Another source
2440 of information is running Exim with debugging turned on, by specifying the
2441 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2442 with debugging turned on by a command of the form
2443 .display
2444 &`exim -d -M`& <&'exim-message-id'&>
2445 .endd
2446 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2447 produces rather a lot of output, but you can cut this down to specific areas.
2448 For example, if you use &%-d-all+route%& only the debugging information
2449 relevant to routing is included. (See the &%-d%& option in chapter
2450 &<<CHAPcommandline>>& for more details.)
2451
2452 .cindex '&"sticky"& bit'
2453 .cindex "lock files"
2454 One specific problem that has shown up on some sites is the inability to do
2455 local deliveries into a shared mailbox directory, because it does not have the
2456 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2457 writing to a mailbox file, and if it cannot create the lock file, the delivery
2458 is deferred. You can get round this either by setting the &"sticky bit"& on the
2459 directory, or by setting a specific group for local deliveries and allowing
2460 that group to create files in the directory (see the comments above the
2461 &(local_delivery)& transport in the default configuration file). Another
2462 approach is to configure Exim not to use lock files, but just to rely on
2463 &[fcntl()]& locking instead. However, you should do this only if all user
2464 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2465 see chapter &<<CHAPappendfile>>&.
2466
2467 One thing that cannot be tested on a system that is already running an MTA is
2468 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2469 &%-oX%& option can be used to run an Exim daemon that listens on some other
2470 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2471 &'exim_checkaccess'& utility can be used to check out policy controls on
2472 incoming SMTP mail.
2473
2474 Testing a new version on a system that is already running Exim can most easily
2475 be done by building a binary with a different CONFIGURE_FILE setting. From
2476 within the run time configuration, all other file and directory names
2477 that Exim uses can be altered, in order to keep it entirely clear of the
2478 production version.
2479
2480
2481 .section "Replacing another MTA with Exim" "SECID35"
2482 .cindex "replacing another MTA"
2483 Building and installing Exim for the first time does not of itself put it in
2484 general use. The name by which the system's MTA is called by mail user agents
2485 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2486 operating system), and it is necessary to make this name point to the &'exim'&
2487 binary in order to get the user agents to pass messages to Exim. This is
2488 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2489 or &_/usr/lib/sendmail_&
2490 .cindex "symbolic link" "to &'exim'& binary"
2491 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2492 privilege and executable status from the old MTA. It is then necessary to stop
2493 and restart the mailer daemon, if one is running.
2494
2495 .cindex "FreeBSD, MTA indirection"
2496 .cindex "&_/etc/mail/mailer.conf_&"
2497 Some operating systems have introduced alternative ways of switching MTAs. For
2498 example, if you are running FreeBSD, you need to edit the file
2499 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2500 described. A typical example of the contents of this file for running Exim is
2501 as follows:
2502 .code
2503 sendmail            /usr/exim/bin/exim
2504 send-mail           /usr/exim/bin/exim
2505 mailq               /usr/exim/bin/exim -bp
2506 newaliases          /usr/bin/true
2507 .endd
2508 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2509 your Exim installation is &"live"&. Check it by sending a message from your
2510 favourite user agent.
2511
2512 You should consider what to tell your users about the change of MTA. Exim may
2513 have different capabilities to what was previously running, and there are
2514 various operational differences such as the text of messages produced by
2515 command line options and in bounce messages. If you allow your users to make
2516 use of Exim's filtering capabilities, you should make the document entitled
2517 &'Exim's interface to mail filtering'& available to them.
2518
2519
2520
2521 .section "Upgrading Exim" "SECID36"
2522 .cindex "upgrading Exim"
2523 If you are already running Exim on your host, building and installing a new
2524 version automatically makes it available to MUAs, or any other programs that
2525 call the MTA directly. However, if you are running an Exim daemon, you do need
2526 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2527 new binary. You do not need to stop processing mail in order to install a new
2528 version of Exim. The install script does not modify an existing runtime
2529 configuration file.
2530
2531
2532
2533
2534 .section "Stopping the Exim daemon on Solaris" "SECID37"
2535 .cindex "Solaris" "stopping Exim on"
2536 The standard command for stopping the mailer daemon on Solaris is
2537 .code
2538 /etc/init.d/sendmail stop
2539 .endd
2540 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2541 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2542 for the text &"sendmail"&; this is not present because the actual program name
2543 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2544 solution is to replace the line that finds the process id with something like
2545 .code
2546 pid=`cat /var/spool/exim/exim-daemon.pid`
2547 .endd
2548 to obtain the daemon's pid directly from the file that Exim saves it in.
2549
2550 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2551 still be received from local processes, and if automatic delivery is configured
2552 (the normal case), deliveries will still occur.
2553
2554
2555
2556
2557 . ////////////////////////////////////////////////////////////////////////////
2558 . ////////////////////////////////////////////////////////////////////////////
2559
2560 .chapter "The Exim command line" "CHAPcommandline"
2561 .scindex IIDclo1 "command line" "options"
2562 .scindex IIDclo2 "options" "command line"
2563 Exim's command line takes the standard Unix form of a sequence of options,
2564 each starting with a hyphen character, followed by a number of arguments. The
2565 options are compatible with the main options of Sendmail, and there are also
2566 some additional options, some of which are compatible with Smail 3. Certain
2567 combinations of options do not make sense, and provoke an error if used.
2568 The form of the arguments depends on which options are set.
2569
2570
2571 .section "Setting options by program name" "SECID38"
2572 .cindex "&'mailq'&"
2573 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2574 were present before any other options.
2575 The &%-bp%& option requests a listing of the contents of the mail queue on the
2576 standard output.
2577 This feature is for compatibility with some systems that contain a command of
2578 that name in one of the standard libraries, symbolically linked to
2579 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2580
2581 .cindex "&'rsmtp'&"
2582 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2583 were present before any other options, for compatibility with Smail. The
2584 &%-bS%& option is used for reading in a number of messages in batched SMTP
2585 format.
2586
2587 .cindex "&'rmail'&"
2588 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2589 &%-oee%& options were present before any other options, for compatibility with
2590 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2591
2592 .cindex "&'runq'&"
2593 .cindex "queue runner"
2594 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2595 were present before any other options, for compatibility with Smail. The &%-q%&
2596 option causes a single queue runner process to be started.
2597
2598 .cindex "&'newaliases'&"
2599 .cindex "alias file" "building"
2600 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2601 If Exim is called under the name &'newaliases'& it behaves as if the option
2602 &%-bi%& were present before any other options, for compatibility with Sendmail.
2603 This option is used for rebuilding Sendmail's alias file. Exim does not have
2604 the concept of a single alias file, but can be configured to run a given
2605 command if called with the &%-bi%& option.
2606
2607
2608 .section "Trusted and admin users" "SECTtrustedadmin"
2609 Some Exim options are available only to &'trusted users'& and others are
2610 available only to &'admin users'&. In the description below, the phrases &"Exim
2611 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2612 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2613 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2614
2615 .ilist
2616 .cindex "trusted users" "definition of"
2617 .cindex "user" "trusted definition of"
2618 The trusted users are root, the Exim user, any user listed in the
2619 &%trusted_users%& configuration option, and any user whose current group or any
2620 supplementary group is one of those listed in the &%trusted_groups%&
2621 configuration option. Note that the Exim group is not automatically trusted.
2622
2623 .cindex '&"From"& line'
2624 .cindex "envelope sender"
2625 Trusted users are always permitted to use the &%-f%& option or a leading
2626 &"From&~"& line to specify the envelope sender of a message that is passed to
2627 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2628 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2629 users to set envelope senders.
2630
2631 .cindex "&'From:'& header line"
2632 .cindex "&'Sender:'& header line"
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 &$sender_domain$&) 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,
3056 using the malware scanning framework.  The option of &%av_scanner%& influences
3057 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3058 the expansion should have defaults which apply to this invocation.  ACLs are
3059 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3060 will never be populated and &%-bmalware%& will fail.
3061
3062 Exim will have changed working directory before resolving the filename, so
3063 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3064 user when it tries to open the file, rather than as the invoking user.
3065 This option requires admin privileges.
3066
3067 The &%-bmalware%& option will not be extended to be more generally useful,
3068 there are better tools for file-scanning.  This option exists to help
3069 administrators verify their Exim and AV scanner configuration.
3070
3071 .vitem &%-bnq%&
3072 .oindex "&%-bnq%&"
3073 .cindex "address qualification, suppressing"
3074 By default, Exim automatically qualifies unqualified addresses (those
3075 without domains) that appear in messages that are submitted locally (that
3076 is, not over TCP/IP). This qualification applies both to addresses in
3077 envelopes, and addresses in header lines. Sender addresses are qualified using
3078 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3079 defaults to the value of &%qualify_domain%&).
3080
3081 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3082 being used to re-submit messages that originally came from remote hosts after
3083 content scanning, you probably do not want to qualify unqualified addresses in
3084 header lines. (Such lines will be present only if you have not enabled a header
3085 syntax check in the appropriate ACL.)
3086
3087 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3088 messages that originate on the local host. When this is used, unqualified
3089 addresses in the envelope provoke errors (causing message rejection) and
3090 unqualified addresses in header lines are left alone.
3091
3092
3093 .vitem &%-bP%&
3094 .oindex "&%-bP%&"
3095 .cindex "configuration options" "extracting"
3096 .cindex "options" "configuration &-- extracting"
3097 If this option is given with no arguments, it causes the values of all Exim's
3098 main configuration options to be written to the standard output. The values
3099 of one or more specific options can be requested by giving their names as
3100 arguments, for example:
3101 .code
3102 exim -bP qualify_domain hold_domains
3103 .endd
3104 .cindex "hiding configuration option values"
3105 .cindex "configuration options" "hiding value of"
3106 .cindex "options" "hiding value of"
3107 However, any option setting that is preceded by the word &"hide"& in the
3108 configuration file is not shown in full, except to an admin user. For other
3109 users, the output is as in this example:
3110 .code
3111 mysql_servers = <value not displayable>
3112 .endd
3113 If &%configure_file%& is given as an argument, the name of the run time
3114 configuration file is output.
3115 If a list of configuration files was supplied, the value that is output here
3116 is the name of the file that was actually used.
3117
3118 .cindex "options" "hiding name of"
3119 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3120 name will not be output.
3121
3122 .cindex "daemon" "process id (pid)"
3123 .cindex "pid (process id)" "of daemon"
3124 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3125 directories where log files and daemon pid files are written are output,
3126 respectively. If these values are unset, log files are written in a
3127 sub-directory of the spool directory called &%log%&, and the pid file is
3128 written directly into the spool directory.
3129
3130 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3131 .code
3132 exim -bP +local_domains
3133 .endd
3134 it searches for a matching named list of any type (domain, host, address, or
3135 local part) and outputs what it finds.
3136
3137 .cindex "options" "router &-- extracting"
3138 .cindex "options" "transport &-- extracting"
3139 .cindex "options" "authenticator &-- extracting"
3140 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3141 followed by the name of an appropriate driver instance, the option settings for
3142 that driver are output. For example:
3143 .code
3144 exim -bP transport local_delivery
3145 .endd
3146 The generic driver options are output first, followed by the driver's private
3147 options. A list of the names of drivers of a particular type can be obtained by
3148 using one of the words &%router_list%&, &%transport_list%&, or
3149 &%authenticator_list%&, and a complete list of all drivers with their option
3150 settings can be obtained by using &%routers%&, &%transports%&, or
3151 &%authenticators%&.
3152
3153 .cindex "options" "macro &-- extracting"
3154 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3155 are available, similarly to the drivers.  Because macros are sometimes used
3156 for storing passwords, this option is restricted.
3157 The output format is one item per line.
3158
3159 .vitem &%-bp%&
3160 .oindex "&%-bp%&"
3161 .cindex "queue" "listing messages on"
3162 .cindex "listing" "messages on the queue"
3163 This option requests a listing of the contents of the mail queue on the
3164 standard output. If the &%-bp%& option is followed by a list of message ids,
3165 just those messages are listed. By default, this option can be used only by an
3166 admin user. However, the &%queue_list_requires_admin%& option can be set false
3167 to allow any user to see the queue.
3168
3169 Each message on the queue is displayed as in the following example:
3170 .code
3171 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3172           red.king@looking-glass.fict.example
3173           <other addresses>
3174 .endd
3175 .cindex "message" "size in queue listing"
3176 .cindex "size" "of message"
3177 The first line contains the length of time the message has been on the queue
3178 (in this case 25 minutes), the size of the message (2.9K), the unique local
3179 identifier for the message, and the message sender, as contained in the
3180 envelope. For bounce messages, the sender address is empty, and appears as
3181 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3182 the default sender address, the user's login name is shown in parentheses
3183 before the sender address.
3184
3185 .cindex "frozen messages" "in queue listing"
3186 If the message is frozen (attempts to deliver it are suspended) then the text
3187 &"*** frozen ***"& is displayed at the end of this line.
3188
3189 The recipients of the message (taken from the envelope, not the headers) are
3190 displayed on subsequent lines. Those addresses to which the message has already
3191 been delivered are marked with the letter D. If an original address gets
3192 expanded into several addresses via an alias or forward file, the original is
3193 displayed with a D only when deliveries for all of its child addresses are
3194 complete.
3195
3196
3197 .vitem &%-bpa%&
3198 .oindex "&%-bpa%&"
3199 This option operates like &%-bp%&, but in addition it shows delivered addresses
3200 that were generated from the original top level address(es) in each message by
3201 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3202 of just &"D"&.
3203
3204
3205 .vitem &%-bpc%&
3206 .oindex "&%-bpc%&"
3207 .cindex "queue" "count of messages on"
3208 This option counts the number of messages on the queue, and writes the total
3209 to the standard output. It is restricted to admin users, unless
3210 &%queue_list_requires_admin%& is set false.
3211
3212
3213 .vitem &%-bpr%&
3214 .oindex "&%-bpr%&"
3215 This option operates like &%-bp%&, but the output is not sorted into
3216 chronological order of message arrival. This can speed it up when there are
3217 lots of messages on the queue, and is particularly useful if the output is
3218 going to be post-processed in a way that doesn't need the sorting.
3219
3220 .vitem &%-bpra%&
3221 .oindex "&%-bpra%&"
3222 This option is a combination of &%-bpr%& and &%-bpa%&.
3223
3224 .vitem &%-bpru%&
3225 .oindex "&%-bpru%&"
3226 This option is a combination of &%-bpr%& and &%-bpu%&.
3227
3228
3229 .vitem &%-bpu%&
3230 .oindex "&%-bpu%&"
3231 This option operates like &%-bp%& but shows only undelivered top-level
3232 addresses for each message displayed. Addresses generated by aliasing or
3233 forwarding are not shown, unless the message was deferred after processing by a
3234 router with the &%one_time%& option set.
3235
3236
3237 .vitem &%-brt%&
3238 .oindex "&%-brt%&"
3239 .cindex "testing" "retry configuration"
3240 .cindex "retry" "configuration testing"
3241 This option is for testing retry rules, and it must be followed by up to three
3242 arguments. It causes Exim to look for a retry rule that matches the values
3243 and to write it to the standard output. For example:
3244 .code
3245 exim -brt bach.comp.mus.example
3246 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3247 .endd
3248 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3249 argument, which is required, can be a complete address in the form
3250 &'local_part@domain'&, or it can be just a domain name. If the second argument
3251 contains a dot, it is interpreted as an optional second domain name; if no
3252 retry rule is found for the first argument, the second is tried. This ties in
3253 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3254 rule is found that matches the host, one that matches the mail domain is
3255 sought. Finally, an argument that is the name of a specific delivery error, as
3256 used in setting up retry rules, can be given. For example:
3257 .code
3258 exim -brt haydn.comp.mus.example quota_3d
3259 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3260 .endd
3261
3262 .vitem &%-brw%&
3263 .oindex "&%-brw%&"
3264 .cindex "testing" "rewriting"
3265 .cindex "rewriting" "testing"
3266 This option is for testing address rewriting rules, and it must be followed by
3267 a single argument, consisting of either a local part without a domain, or a
3268 complete address with a fully qualified domain. Exim outputs how this address
3269 would be rewritten for each possible place it might appear. See chapter
3270 &<<CHAPrewrite>>& for further details.
3271
3272 .vitem &%-bS%&
3273 .oindex "&%-bS%&"
3274 .cindex "SMTP" "batched incoming"
3275 .cindex "batched SMTP input"
3276 This option is used for batched SMTP input, which is an alternative interface
3277 for non-interactive local message submission. A number of messages can be
3278 submitted in a single run. However, despite its name, this is not really SMTP
3279 input. Exim reads each message's envelope from SMTP commands on the standard
3280 input, but generates no responses. If the caller is trusted, or
3281 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3282 believed; otherwise the sender is always the caller of Exim.
3283
3284 The message itself is read from the standard input, in SMTP format (leading
3285 dots doubled), terminated by a line containing just a single dot. An error is
3286 provoked if the terminating dot is missing. A further message may then follow.
3287
3288 As for other local message submissions, the contents of incoming batch SMTP
3289 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3290 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3291 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3292
3293 Some other SMTP commands are recognized in the input. HELO and EHLO act
3294 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3295 QUIT quits, ignoring the rest of the standard input.
3296
3297 .cindex "return code" "for &%-bS%&"
3298 If any error is encountered, reports are written to the standard output and
3299 error streams, and Exim gives up immediately. The return code is 0 if no error
3300 was detected; it is 1 if one or more messages were accepted before the error
3301 was detected; otherwise it is 2.
3302
3303 More details of input using batched SMTP are given in section
3304 &<<SECTincomingbatchedSMTP>>&.
3305
3306 .vitem &%-bs%&
3307 .oindex "&%-bs%&"
3308 .cindex "SMTP" "local input"
3309 .cindex "local SMTP input"
3310 This option causes Exim to accept one or more messages by reading SMTP commands
3311 on the standard input, and producing SMTP replies on the standard output. SMTP
3312 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3313 Some user agents use this interface as a way of passing locally-generated
3314 messages to the MTA.
3315
3316 In
3317 .cindex "sender" "source of"
3318 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3319 set, the senders of messages are taken from the SMTP MAIL commands.
3320 Otherwise the content of these commands is ignored and the sender is set up as
3321 the calling user. Unqualified addresses are automatically qualified using
3322 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3323 &%-bnq%& option is used.
3324
3325 .cindex "inetd"
3326 The
3327 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3328 using a listening daemon. Exim can distinguish the two cases by checking
3329 whether the standard input is a TCP/IP socket. When Exim is called from
3330 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3331 above concerning senders and qualification do not apply. In this situation,
3332 Exim behaves in exactly the same way as it does when receiving a message via
3333 the listening daemon.
3334
3335 .vitem &%-bt%&
3336 .oindex "&%-bt%&"
3337 .cindex "testing" "addresses"
3338 .cindex "address" "testing"
3339 This option runs Exim in address testing mode, in which each argument is taken
3340 as a recipient address to be tested for deliverability. The results are
3341 written to the standard output. If a test fails, and the caller is not an admin
3342 user, no details of the failure are output, because these might contain
3343 sensitive information such as usernames and passwords for database lookups.
3344
3345 If no arguments are given, Exim runs in an interactive manner, prompting with a
3346 right angle bracket for addresses to be tested.
3347
3348 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3349 &[readline()]& function, because it is running as &'root'& and there are
3350 security issues.
3351
3352 Each address is handled as if it were the recipient address of a message
3353 (compare the &%-bv%& option). It is passed to the routers and the result is
3354 written to the standard output. However, any router that has
3355 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3356 genuine routing tests if your first router passes everything to a scanner
3357 program.
3358
3359 .cindex "return code" "for &%-bt%&"
3360 The return code is 2 if any address failed outright; it is 1 if no address
3361 failed outright but at least one could not be resolved for some reason. Return
3362 code 0 is given only when all addresses succeed.
3363
3364 .cindex "duplicate addresses"
3365 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3366 addresses after routing is complete, so that only one delivery takes place.
3367 This does not happen when testing with &%-bt%&; the full results of routing are
3368 always shown.
3369
3370 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3371 routers in the configuration makes any tests on the sender address of a
3372 message,
3373 .oindex "&%-f%&" "for address testing"
3374 you can use the &%-f%& option to set an appropriate sender when running
3375 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3376 default qualifying domain. However, if you have set up (for example) routers
3377 whose behaviour depends on the contents of an incoming message, you cannot test
3378 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3379 doing such tests.
3380
3381 .vitem &%-bV%&
3382 .oindex "&%-bV%&"
3383 .cindex "version number of Exim"
3384 This option causes Exim to write the current version number, compilation
3385 number, and compilation date of the &'exim'& binary to the standard output.
3386 It also lists the DBM library that is being used, the optional modules (such as
3387 specific lookup types), the drivers that are included in the binary, and the
3388 name of the run time configuration file that is in use.
3389
3390 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3391 configuration file. However, this is a static check only. It cannot check
3392 values that are to be expanded. For example, although a misspelt ACL verb is
3393 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3394 alone to discover (for example) all the typos in the configuration; some
3395 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3396 dynamic testing facilities.
3397
3398 .vitem &%-bv%&
3399 .oindex "&%-bv%&"
3400 .cindex "verifying address" "using &%-bv%&"
3401 .cindex "address" "verification"
3402 This option runs Exim in address verification mode, in which each argument is
3403 taken as a recipient address to be verified by the routers. (This does
3404 not involve any verification callouts). During normal operation, verification
3405 happens mostly as a consequence processing a &%verify%& condition in an ACL
3406 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3407 including callouts, see the &%-bh%& and &%-bhc%& options.
3408
3409 If verification fails, and the caller is not an admin user, no details of the
3410 failure are output, because these might contain sensitive information such as
3411 usernames and passwords for database lookups.
3412
3413 If no arguments are given, Exim runs in an interactive manner, prompting with a
3414 right angle bracket for addresses to be verified.
3415
3416 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3417 &[readline()]& function, because it is running as &'exim'& and there are
3418 security issues.
3419
3420 Verification differs from address testing (the &%-bt%& option) in that routers
3421 that have &%no_verify%& set are skipped, and if the address is accepted by a
3422 router that has &%fail_verify%& set, verification fails. The address is
3423 verified as a recipient if &%-bv%& is used; to test verification for a sender
3424 address, &%-bvs%& should be used.
3425
3426 If the &%-v%& option is not set, the output consists of a single line for each
3427 address, stating whether it was verified or not, and giving a reason in the
3428 latter case. Without &%-v%&, generating more than one address by redirection
3429 causes verification to end successfully, without considering the generated
3430 addresses. However, if just one address is generated, processing continues,
3431 and the generated address must verify successfully for the overall verification
3432 to succeed.
3433
3434 When &%-v%& is set, more details are given of how the address has been handled,
3435 and in the case of address redirection, all the generated addresses are also
3436 considered. Verification may succeed for some and fail for others.
3437
3438 The
3439 .cindex "return code" "for &%-bv%&"
3440 return code is 2 if any address failed outright; it is 1 if no address
3441 failed outright but at least one could not be resolved for some reason. Return
3442 code 0 is given only when all addresses succeed.
3443
3444 If any of the routers in the configuration makes any tests on the sender
3445 address of a message, you should use the &%-f%& option to set an appropriate
3446 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3447 calling user at the default qualifying domain.
3448
3449 .vitem &%-bvs%&
3450 .oindex "&%-bvs%&"
3451 This option acts like &%-bv%&, but verifies the address as a sender rather
3452 than a recipient address. This affects any rewriting and qualification that
3453 might happen.
3454
3455 .vitem &%-bw%&
3456 .oindex "&%-bw%&"
3457 .cindex "daemon"
3458 .cindex "inetd"
3459 .cindex "inetd" "wait mode"
3460 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3461 similarly to the &%-bd%& option.  All port specifications on the command-line
3462 and in the configuration file are ignored.  Queue-running may not be specified.
3463
3464 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3465 listening for connections.  This permits the system to start up and have
3466 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3467 each port only when the first connection is received.
3468
3469 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3470 which the daemon will exit, which should cause inetd to listen once more.
3471
3472 .vitem &%-C%&&~<&'filelist'&>
3473 .oindex "&%-C%&"
3474 .cindex "configuration file" "alternate"
3475 .cindex "CONFIGURE_FILE"
3476 .cindex "alternate configuration file"
3477 This option causes Exim to find the run time configuration file from the given
3478 list instead of from the list specified by the CONFIGURE_FILE
3479 compile-time setting. Usually, the list will consist of just a single file
3480 name, but it can be a colon-separated list of names. In this case, the first
3481 file that exists is used. Failure to open an existing file stops Exim from
3482 proceeding any further along the list, and an error is generated.
3483
3484 When this option is used by a caller other than root, and the list is different
3485 from the compiled-in list, Exim gives up its root privilege immediately, and
3486 runs with the real and effective uid and gid set to those of the caller.
3487 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3488 file contains a list of full pathnames, one per line, for configuration files
3489 which are trusted. Root privilege is retained for any configuration file so
3490 listed, as long as the caller is the Exim user (or the user specified in the
3491 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3492 not writeable by inappropriate users or groups.
3493
3494 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3495 configuration using &%-C%& right through message reception and delivery,
3496 even if the caller is root. The reception works, but by that time, Exim is
3497 running as the Exim user, so when it re-executes to regain privilege for the
3498 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3499 test reception and delivery using two separate commands (one to put a message
3500 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3501
3502 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3503 prefix string with which any file named in a &%-C%& command line option
3504 must start. In addition, the file name must not contain the sequence &`/../`&.
3505 However, if the value of the &%-C%& option is identical to the value of
3506 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3507 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3508 unset, any file name can be used with &%-C%&.
3509
3510 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3511 to a directory to which only root has access. This prevents someone who has
3512 broken into the Exim account from running a privileged Exim with an arbitrary
3513 configuration file.
3514
3515 The &%-C%& facility is useful for ensuring that configuration files are
3516 syntactically correct, but cannot be used for test deliveries, unless the
3517 caller is privileged, or unless it is an exotic configuration that does not
3518 require privilege. No check is made on the owner or group of the files
3519 specified by this option.
3520
3521
3522 .vitem &%-D%&<&'macro'&>=<&'value'&>
3523 .oindex "&%-D%&"
3524 .cindex "macro" "setting on command line"
3525 This option can be used to override macro definitions in the configuration file
3526 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3527 unprivileged caller, it causes Exim to give up its root privilege.
3528 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3529 completely disabled, and its use causes an immediate error exit.
3530
3531 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3532 colon-separated list of macros which are considered safe and, if &%-D%& only
3533 supplies macros from this list, and the values are acceptable, then Exim will
3534 not give up root privilege if the caller is root, the Exim run-time user, or
3535 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3536 to be removed in the future.  Acceptable values for the macros satisfy the
3537 regexp: &`^[A-Za-z0-9_/.-]*$`&
3538
3539 The entire option (including equals sign if present) must all be within one
3540 command line item. &%-D%& can be used to set the value of a macro to the empty
3541 string, in which case the equals sign is optional. These two commands are
3542 synonymous:
3543 .code
3544 exim -DABC  ...
3545 exim -DABC= ...
3546 .endd
3547 To include spaces in a macro definition item, quotes must be used. If you use
3548 quotes, spaces are permitted around the macro name and the equals sign. For
3549 example:
3550 .code
3551 exim '-D ABC = something' ...
3552 .endd
3553 &%-D%& may be repeated up to 10 times on a command line.
3554
3555
3556 .vitem &%-d%&<&'debug&~options'&>
3557 .oindex "&%-d%&"
3558 .cindex "debugging" "list of selectors"
3559 .cindex "debugging" "&%-d%& option"
3560 This option causes debugging information to be written to the standard
3561 error stream. It is restricted to admin users because debugging output may show
3562 database queries that contain password information. Also, the details of users'
3563 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3564 writes an error message to the standard error stream and exits with a non-zero
3565 return code.
3566
3567 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3568 standard debugging data is output. This can be reduced, or increased to include
3569 some more rarely needed information, by directly following &%-d%& with a string
3570 made up of names preceded by plus or minus characters. These add or remove sets
3571 of debugging data, respectively. For example, &%-d+filter%& adds filter
3572 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3573 no spaces are allowed in the debug setting. The available debugging categories
3574 are:
3575 .display
3576 &`acl            `& ACL interpretation
3577 &`auth           `& authenticators
3578 &`deliver        `& general delivery logic
3579 &`dns            `& DNS lookups (see also resolver)
3580 &`dnsbl          `& DNS black list (aka RBL) code
3581 &`exec           `& arguments for &[execv()]& calls
3582 &`expand         `& detailed debugging for string expansions
3583 &`filter         `& filter handling
3584 &`hints_lookup   `& hints data lookups
3585 &`host_lookup    `& all types of name-to-IP address handling
3586 &`ident          `& ident lookup
3587 &`interface      `& lists of local interfaces
3588 &`lists          `& matching things in lists
3589 &`load           `& system load checks
3590 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3591                     &<<CHAPlocalscan>>&)
3592 &`lookup         `& general lookup code and all lookups
3593 &`memory         `& memory handling
3594 &`pid            `& add pid to debug output lines
3595 &`process_info   `& setting info for the process log
3596 &`queue_run      `& queue runs
3597 &`receive        `& general message reception logic
3598 &`resolver       `& turn on the DNS resolver's debugging output
3599 &`retry          `& retry handling
3600 &`rewrite        `& address rewriting
3601 &`route          `& address routing
3602 &`timestamp      `& add timestamp to debug output lines
3603 &`tls            `& TLS logic
3604 &`transport      `& transports
3605 &`uid            `& changes of uid/gid and looking up uid/gid
3606 &`verify         `& address verification logic
3607 &`all            `& almost all of the above (see below), and also &%-v%&
3608 .endd
3609 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3610 for &`-all`&. The reason for this is that &`+all`& is something that people
3611 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3612 is included, an awful lot of output that is very rarely of interest is
3613 generated, so it now has to be explicitly requested. However, &`-all`& does
3614 turn everything off.
3615
3616 .cindex "resolver, debugging output"
3617 .cindex "DNS resolver, debugging output"
3618 The &`resolver`& option produces output only if the DNS resolver was compiled
3619 with DEBUG enabled. This is not the case in some operating systems. Also,
3620 unfortunately, debugging output from the DNS resolver is written to stdout
3621 rather than stderr.
3622
3623 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3624 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3625 However, the &`pid`& selector is forced when debugging is turned on for a
3626 daemon, which then passes it on to any re-executed Exims. Exim also
3627 automatically adds the pid to debug lines when several remote deliveries are
3628 run in parallel.
3629
3630 The &`timestamp`& selector causes the current time to be inserted at the start
3631 of all debug output lines. This can be useful when trying to track down delays
3632 in processing.
3633
3634 If the &%debug_print%& option is set in any driver, it produces output whenever
3635 any debugging is selected, or if &%-v%& is used.
3636
3637 .vitem &%-dd%&<&'debug&~options'&>
3638 .oindex "&%-dd%&"
3639 This option behaves exactly like &%-d%& except when used on a command that
3640 starts a daemon process. In that case, debugging is turned off for the
3641 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3642 behaviour of the daemon without creating as much output as full debugging does.
3643
3644 .vitem &%-dropcr%&
3645 .oindex "&%-dropcr%&"
3646 This is an obsolete option that is now a no-op. It used to affect the way Exim
3647 handled CR and LF characters in incoming messages. What happens now is
3648 described in section &<<SECTlineendings>>&.
3649
3650 .vitem &%-E%&
3651 .oindex "&%-E%&"
3652 .cindex "bounce message" "generating"
3653 This option specifies that an incoming message is a locally-generated delivery
3654 failure report. It is used internally by Exim when handling delivery failures
3655 and is not intended for external use. Its only effect is to stop Exim
3656 generating certain messages to the postmaster, as otherwise message cascades
3657 could occur in some situations. As part of the same option, a message id may
3658 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3659 new message contains the id, following &"R="&, as a cross-reference.
3660
3661 .vitem &%-e%&&'x'&
3662 .oindex "&%-e%&&'x'&"
3663 There are a number of Sendmail options starting with &%-oe%& which seem to be
3664 called by various programs without the leading &%o%& in the option. For
3665 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3666 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3667
3668 .vitem &%-F%&&~<&'string'&>
3669 .oindex "&%-F%&"
3670 .cindex "sender" "name"
3671 .cindex "name" "of sender"
3672 This option sets the sender's full name for use when a locally-generated
3673 message is being accepted. In the absence of this option, the user's &'gecos'&
3674 entry from the password data is used. As users are generally permitted to alter
3675 their &'gecos'& entries, no security considerations are involved. White space
3676 between &%-F%& and the <&'string'&> is optional.
3677
3678 .vitem &%-f%&&~<&'address'&>
3679 .oindex "&%-f%&"
3680 .cindex "sender" "address"
3681 .cindex "address" "sender"
3682 .cindex "trusted users"
3683 .cindex "envelope sender"
3684 .cindex "user" "trusted"
3685 This option sets the address of the envelope sender of a locally-generated
3686 message (also known as the return path). The option can normally be used only
3687 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3688 users to use it.
3689
3690 Processes running as root or the Exim user are always trusted. Other
3691 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3692 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3693 of a local message is set to the caller's login name at the default qualify
3694 domain.
3695
3696 There is one exception to the restriction on the use of &%-f%&: an empty sender
3697 can be specified by any user, trusted or not, to create a message that can
3698 never provoke a bounce. An empty sender can be specified either as an empty
3699 string, or as a pair of angle brackets with nothing between them, as in these
3700 examples of shell commands:
3701 .code
3702 exim -f '<>' user@domain
3703 exim -f "" user@domain
3704 .endd
3705 In addition, the use of &%-f%& is not restricted when testing a filter file
3706 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3707 &%-bv%& options.
3708
3709 Allowing untrusted users to change the sender address does not of itself make
3710 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3711 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3712 though this can be overridden by setting &%no_local_from_check%&.
3713
3714 White
3715 .cindex "&""From""& line"
3716 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3717 given as two arguments or one combined argument). The sender of a
3718 locally-generated message can also be set (when permitted) by an initial
3719 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3720 if &%-f%& is also present, it overrides &"From&~"&.
3721
3722 .vitem &%-G%&
3723 .oindex "&%-G%&"
3724 .cindex "submission fixups, suppressing (command-line)"
3725 This option is equivalent to an ACL applying:
3726 .code
3727 control = suppress_local_fixups
3728 .endd
3729 for every message received.  Note that Sendmail will complain about such
3730 bad formatting, where Exim silently just does not fix it up.  This may change
3731 in future.
3732
3733 As this affects audit information, the caller must be a trusted user to use
3734 this option.
3735
3736 .vitem &%-h%&&~<&'number'&>
3737 .oindex "&%-h%&"
3738 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3739 This option is accepted for compatibility with Sendmail, but has no effect. (In
3740 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3741 headers.)
3742
3743 .vitem &%-i%&
3744 .oindex "&%-i%&"
3745 .cindex "Solaris" "&'mail'& command"
3746 .cindex "dot" "in incoming non-SMTP message"
3747 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3748 line by itself should not terminate an incoming, non-SMTP message. I can find
3749 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3750 command in Solaris 2.4 uses it. See also &%-ti%&.
3751
3752 .vitem &%-L%&&~<&'tag'&>
3753 .oindex "&%-L%&"
3754 .cindex "syslog" "process name; set with flag"
3755 This option is equivalent to setting &%syslog_processname%& in the config
3756 file and setting &%log_file_path%& to &`syslog`&.
3757 Its use is restricted to administrators.  The configuration file has to be
3758 read and parsed, to determine access rights, before this is set and takes
3759 effect, so early configuration file errors will not honour this flag.
3760
3761 The tag should not be longer than 32 characters.
3762
3763 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3764 .oindex "&%-M%&"
3765 .cindex "forcing delivery"
3766 .cindex "delivery" "forcing attempt"
3767 .cindex "frozen messages" "forcing delivery"
3768 This option requests Exim to run a delivery attempt on each message in turn. If
3769 any of the messages are frozen, they are automatically thawed before the
3770 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3771 and &%hold_domains%& are ignored.
3772
3773 Retry
3774 .cindex "hints database" "overriding retry hints"
3775 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3776 the normal retry time has not yet been reached. This option requires the caller
3777 to be an admin user. However, there is an option called &%prod_requires_admin%&
3778 which can be set false to relax this restriction (and also the same requirement
3779 for the &%-q%&, &%-R%&, and &%-S%& options).
3780
3781 The deliveries happen synchronously, that is, the original Exim process does
3782 not terminate until all the delivery attempts have finished. No output is
3783 produced unless there is a serious error. If you want to see what is happening,
3784 use the &%-v%& option as well, or inspect Exim's main log.
3785
3786 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3787 .oindex "&%-Mar%&"
3788 .cindex "message" "adding recipients"
3789 .cindex "recipient" "adding"
3790 This option requests Exim to add the addresses to the list of recipients of the
3791 message (&"ar"& for &"add recipients"&). The first argument must be a message
3792 id, and the remaining ones must be email addresses. However, if the message is
3793 active (in the middle of a delivery attempt), it is not altered. This option
3794 can be used only by an admin user.
3795
3796 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3797         &~<&'message&~id'&>"
3798 .oindex "&%-MC%&"
3799 .cindex "SMTP" "passed connection"
3800 .cindex "SMTP" "multiple deliveries"
3801 .cindex "multiple SMTP deliveries"
3802 This option is not intended for use by external callers. It is used internally
3803 by Exim to invoke another instance of itself to deliver a waiting message using
3804 an existing SMTP connection, which is passed as the standard input. Details are
3805 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3806 must be root or the Exim user in order to use it.
3807
3808 .vitem &%-MCA%&
3809 .oindex "&%-MCA%&"
3810 This option is not intended for use by external callers. It is used internally
3811 by Exim in conjunction with the &%-MC%& option. It signifies that the
3812 connection to the remote host has been authenticated.
3813
3814 .vitem &%-MCP%&
3815 .oindex "&%-MCP%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3818 which Exim is connected supports pipelining.
3819
3820 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3821 .oindex "&%-MCQ%&"
3822 This option is not intended for use by external callers. It is used internally
3823 by Exim in conjunction with the &%-MC%& option when the original delivery was
3824 started by a queue runner. It passes on the process id of the queue runner,
3825 together with the file descriptor number of an open pipe. Closure of the pipe
3826 signals the final completion of the sequence of processes that are passing
3827 messages through the same SMTP connection.
3828
3829 .vitem &%-MCS%&
3830 .oindex "&%-MCS%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3833 SMTP SIZE option should be used on messages delivered down the existing
3834 connection.
3835
3836 .vitem &%-MCT%&
3837 .oindex "&%-MCT%&"
3838 This option is not intended for use by external callers. It is used internally
3839 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3840 host to which Exim is connected supports TLS encryption.
3841
3842 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3843 .oindex "&%-Mc%&"
3844 .cindex "hints database" "not overridden by &%-Mc%&"
3845 .cindex "delivery" "manually started &-- not forced"
3846 This option requests Exim to run a delivery attempt on each message in turn,
3847 but unlike the &%-M%& option, it does check for retry hints, and respects any
3848 that are found. This option is not very useful to external callers. It is
3849 provided mainly for internal use by Exim when it needs to re-invoke itself in
3850 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3851 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3852 respects retry times and other options such as &%hold_domains%& that are
3853 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3854 If you want to run a specific delivery as if in a queue run, you should use
3855 &%-q%& with a message id argument. A distinction between queue run deliveries
3856 and other deliveries is made in one or two places.
3857
3858 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3859 .oindex "&%-Mes%&"
3860 .cindex "message" "changing sender"
3861 .cindex "sender" "changing"
3862 This option requests Exim to change the sender address in the message to the
3863 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3864 &"edit sender"&). There must be exactly two arguments. The first argument must
3865 be a message id, and the second one an email address. However, if the message
3866 is active (in the middle of a delivery attempt), its status is not altered.
3867 This option can be used only by an admin user.
3868
3869 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3870 .oindex "&%-Mf%&"
3871 .cindex "freezing messages"
3872 .cindex "message" "manually freezing"
3873 This option requests Exim to mark each listed message as &"frozen"&. This
3874 prevents any delivery attempts taking place until the message is &"thawed"&,
3875 either manually or as a result of the &%auto_thaw%& configuration option.
3876 However, if any of the messages are active (in the middle of a delivery
3877 attempt), their status is not altered. This option can be used only by an admin
3878 user.
3879
3880 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3881 .oindex "&%-Mg%&"
3882 .cindex "giving up on messages"
3883 .cindex "message" "abandoning delivery attempts"
3884 .cindex "delivery" "abandoning further attempts"
3885 This option requests Exim to give up trying to deliver the listed messages,
3886 including any that are frozen. However, if any of the messages are active,
3887 their status is not altered. For non-bounce messages, a delivery error message
3888 is sent to the sender, containing the text &"cancelled by administrator"&.
3889 Bounce messages are just discarded. This option can be used only by an admin
3890 user.
3891
3892 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3893 .oindex "&%-Mmad%&"
3894 .cindex "delivery" "cancelling all"
3895 This option requests Exim to mark all the recipient addresses in the messages
3896 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3897 message is active (in the middle of a delivery attempt), its status is not
3898 altered. This option can be used only by an admin user.
3899
3900 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3901 .oindex "&%-Mmd%&"
3902 .cindex "delivery" "cancelling by address"
3903 .cindex "recipient" "removing"
3904 .cindex "removing recipients"
3905 This option requests Exim to mark the given addresses as already delivered
3906 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3907 the remaining ones must be email addresses. These are matched to recipient
3908 addresses in the message in a case-sensitive manner. If the message is active
3909 (in the middle of a delivery attempt), its status is not altered. This option
3910 can be used only by an admin user.
3911
3912 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3913 .oindex "&%-Mrm%&"
3914 .cindex "removing messages"
3915 .cindex "abandoning mail"
3916 .cindex "message" "manually discarding"
3917 This option requests Exim to remove the given messages from the queue. No
3918 bounce messages are sent; each message is simply forgotten. However, if any of
3919 the messages are active, their status is not altered. This option can be used
3920 only by an admin user or by the user who originally caused the message to be
3921 placed on the queue.
3922
3923 .vitem &%-Mset%&&~<&'message&~id'&>
3924 .oindex "&%-Mset%&
3925 .cindex "testing" "string expansion"
3926 .cindex "expansion" "testing"
3927 This option is useful only in conjunction with &%-be%& (that is, when testing
3928 string expansions). Exim loads the given message from its spool before doing
3929 the test expansions, thus setting message-specific variables such as
3930 &$message_size$& and the header variables. The &$recipients$& variable is made
3931 available. This feature is provided to make it easier to test expansions that
3932 make use of these variables. However, this option can be used only by an admin
3933 user. See also &%-bem%&.
3934
3935 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3936 .oindex "&%-Mt%&"
3937 .cindex "thawing messages"
3938 .cindex "unfreezing messages"
3939 .cindex "frozen messages" "thawing"
3940 .cindex "message" "thawing frozen"
3941 This option requests Exim to &"thaw"& any of the listed messages that are
3942 &"frozen"&, so that delivery attempts can resume. However, if any of the
3943 messages are active, their status is not altered. This option can be used only
3944 by an admin user.
3945
3946 .vitem &%-Mvb%&&~<&'message&~id'&>
3947 .oindex "&%-Mvb%&"
3948 .cindex "listing" "message body"
3949 .cindex "message" "listing body of"
3950 This option causes the contents of the message body (-D) spool file to be
3951 written to the standard output. This option can be used only by an admin user.
3952
3953 .vitem &%-Mvc%&&~<&'message&~id'&>
3954 .oindex "&%-Mvc%&"
3955 .cindex "message" "listing in RFC 2822 format"
3956 .cindex "listing" "message in RFC 2822 format"
3957 This option causes a copy of the complete message (header lines plus body) to
3958 be written to the standard output in RFC 2822 format. This option can be used
3959 only by an admin user.
3960
3961 .vitem &%-Mvh%&&~<&'message&~id'&>
3962 .oindex "&%-Mvh%&"
3963 .cindex "listing" "message headers"
3964 .cindex "header lines" "listing"
3965 .cindex "message" "listing header lines"
3966 This option causes the contents of the message headers (-H) spool file to be
3967 written to the standard output. This option can be used only by an admin user.
3968
3969 .vitem &%-Mvl%&&~<&'message&~id'&>
3970 .oindex "&%-Mvl%&"
3971 .cindex "listing" "message log"
3972 .cindex "message" "listing message log"
3973 This option causes the contents of the message log spool file to be written to
3974 the standard output. This option can be used only by an admin user.
3975
3976 .vitem &%-m%&
3977 .oindex "&%-m%&"
3978 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3979 treats it that way too.
3980
3981 .vitem &%-N%&
3982 .oindex "&%-N%&"
3983 .cindex "debugging" "&%-N%& option"
3984 .cindex "debugging" "suppressing delivery"
3985 This is a debugging option that inhibits delivery of a message at the transport
3986 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3987 it just doesn't actually transport the message, but instead behaves as if it
3988 had successfully done so. However, it does not make any updates to the retry
3989 database, and the log entries for deliveries are flagged with &"*>"& rather
3990 than &"=>"&.
3991
3992 Because &%-N%& discards any message to which it applies, only root or the Exim
3993 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3994 words, an ordinary user can use it only when supplying an incoming message to
3995 which it will apply. Although transportation never fails when &%-N%& is set, an
3996 address may be deferred because of a configuration problem on a transport, or a
3997 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3998 the message, and applies to any subsequent delivery attempts that may happen
3999 for that message.
4000
4001 .vitem &%-n%&
4002 .oindex "&%-n%&"
4003 This option is interpreted by Sendmail to mean &"no aliasing"&.
4004 For normal modes of operation, it is ignored by Exim.
4005 When combined with &%-bP%& it suppresses the name of an option from being output.
4006
4007 .vitem &%-O%&&~<&'data'&>
4008 .oindex "&%-O%&"
4009 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4010 Exim.
4011
4012 .vitem &%-oA%&&~<&'file&~name'&>
4013 .oindex "&%-oA%&"
4014 .cindex "Sendmail compatibility" "&%-oA%& option"
4015 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4016 alternative alias file name. Exim handles &%-bi%& differently; see the
4017 description above.
4018
4019 .vitem &%-oB%&&~<&'n'&>
4020 .oindex "&%-oB%&"
4021 .cindex "SMTP" "passed connection"
4022 .cindex "SMTP" "multiple deliveries"
4023 .cindex "multiple SMTP deliveries"
4024 This is a debugging option which limits the maximum number of messages that can
4025 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4026 transport. If <&'n'&> is omitted, the limit is set to 1.
4027
4028 .vitem &%-odb%&
4029 .oindex "&%-odb%&"
4030 .cindex "background delivery"
4031 .cindex "delivery" "in the background"
4032 This option applies to all modes in which Exim accepts incoming messages,
4033 including the listening daemon. It requests &"background"& delivery of such
4034 messages, which means that the accepting process automatically starts a
4035 delivery process for each message received, but does not wait for the delivery
4036 processes to finish.
4037
4038 When all the messages have been received, the reception process exits,
4039 leaving the delivery processes to finish in their own time. The standard output
4040 and error streams are closed at the start of each delivery process.
4041 This is the default action if none of the &%-od%& options are present.
4042
4043 If one of the queueing options in the configuration file
4044 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4045 overrides it if &%queue_only_override%& is set true, which is the default
4046 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4047
4048 .vitem &%-odf%&
4049 .oindex "&%-odf%&"
4050 .cindex "foreground delivery"
4051 .cindex "delivery" "in the foreground"
4052 This option requests &"foreground"& (synchronous) delivery when Exim has
4053 accepted a locally-generated message. (For the daemon it is exactly the same as
4054 &%-odb%&.) A delivery process is automatically started to deliver the message,
4055 and Exim waits for it to complete before proceeding.
4056
4057 The original Exim reception process does not finish until the delivery
4058 process for the final message has ended. The standard error stream is left open
4059 during deliveries.
4060
4061 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4062 false and one of the queueing options in the configuration file is in effect.
4063
4064 If there is a temporary delivery error during foreground delivery, the
4065 message is left on the queue for later delivery, and the original reception
4066 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4067 restricted configuration that never queues messages.
4068
4069
4070 .vitem &%-odi%&
4071 .oindex "&%-odi%&"
4072 This option is synonymous with &%-odf%&. It is provided for compatibility with
4073 Sendmail.
4074
4075 .vitem &%-odq%&
4076 .oindex "&%-odq%&"
4077 .cindex "non-immediate delivery"
4078 .cindex "delivery" "suppressing immediate"
4079 .cindex "queueing incoming messages"
4080 This option applies to all modes in which Exim accepts incoming messages,
4081 including the listening daemon. It specifies that the accepting process should
4082 not automatically start a delivery process for each message received. Messages
4083 are placed on the queue, and remain there until a subsequent queue runner
4084 process encounters them. There are several configuration options (such as
4085 &%queue_only%&) that can be used to queue incoming messages under certain
4086 conditions. This option overrides all of them and also &%-odqs%&. It always
4087 forces queueing.
4088
4089 .vitem &%-odqs%&
4090 .oindex "&%-odqs%&"
4091 .cindex "SMTP" "delaying delivery"
4092 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4093 However, like &%-odb%& and &%-odi%&, this option has no effect if
4094 &%queue_only_override%& is false and one of the queueing options in the
4095 configuration file is in effect.
4096
4097 When &%-odqs%& does operate, a delivery process is started for each incoming
4098 message, in the background by default, but in the foreground if &%-odi%& is
4099 also present. The recipient addresses are routed, and local deliveries are done
4100 in the normal way. However, if any SMTP deliveries are required, they are not
4101 done at this time, so the message remains on the queue until a subsequent queue
4102 runner process encounters it. Because routing was done, Exim knows which
4103 messages are waiting for which hosts, and so a number of messages for the same
4104 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4105 configuration option has the same effect for specific domains. See also the
4106 &%-qq%& option.
4107
4108 .vitem &%-oee%&
4109 .oindex "&%-oee%&"
4110 .cindex "error" "reporting"
4111 If an error is detected while a non-SMTP message is being received (for
4112 example, a malformed address), the error is reported to the sender in a mail
4113 message.
4114
4115 .cindex "return code" "for &%-oee%&"
4116 Provided
4117 this error message is successfully sent, the Exim receiving process
4118 exits with a return code of zero. If not, the return code is 2 if the problem
4119 is that the original message has no recipients, or 1 for any other error.
4120 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4121
4122 .vitem &%-oem%&
4123 .oindex "&%-oem%&"
4124 .cindex "error" "reporting"
4125 .cindex "return code" "for &%-oem%&"
4126 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4127 return code, whether or not the error message was successfully sent.
4128 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4129
4130 .vitem &%-oep%&
4131 .oindex "&%-oep%&"
4132 .cindex "error" "reporting"
4133 If an error is detected while a non-SMTP message is being received, the
4134 error is reported by writing a message to the standard error file (stderr).
4135 .cindex "return code" "for &%-oep%&"
4136 The return code is 1 for all errors.
4137
4138 .vitem &%-oeq%&
4139 .oindex "&%-oeq%&"
4140 .cindex "error" "reporting"
4141 This option is supported for compatibility with Sendmail, but has the same
4142 effect as &%-oep%&.
4143
4144 .vitem &%-oew%&
4145 .oindex "&%-oew%&"
4146 .cindex "error" "reporting"
4147 This option is supported for compatibility with Sendmail, but has the same
4148 effect as &%-oem%&.
4149
4150 .vitem &%-oi%&
4151 .oindex "&%-oi%&"
4152 .cindex "dot" "in incoming non-SMTP message"
4153 This option, which has the same effect as &%-i%&, specifies that a dot on a
4154 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4155 single dot does terminate, though Exim does no special processing for other
4156 lines that start with a dot. This option is set by default if Exim is called as
4157 &'rmail'&. See also &%-ti%&.
4158
4159 .vitem &%-oitrue%&
4160 .oindex "&%-oitrue%&"
4161 This option is treated as synonymous with &%-oi%&.
4162
4163 .vitem &%-oMa%&&~<&'host&~address'&>
4164 .oindex "&%-oMa%&"
4165 .cindex "sender" "host address, specifying for local message"
4166 A number of options starting with &%-oM%& can be used to set values associated
4167 with remote hosts on locally-submitted messages (that is, messages not received
4168 over TCP/IP). These options can be used by any caller in conjunction with the
4169 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4170 other circumstances, they are ignored unless the caller is trusted.
4171
4172 The &%-oMa%& option sets the sender host address. This may include a port
4173 number at the end, after a full stop (period). For example:
4174 .code
4175 exim -bs -oMa 10.9.8.7.1234
4176 .endd
4177 An alternative syntax is to enclose the IP address in square brackets,
4178 followed by a colon and the port number:
4179 .code
4180 exim -bs -oMa [10.9.8.7]:1234
4181 .endd
4182 The IP address is placed in the &$sender_host_address$& variable, and the
4183 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4184 are present on the command line, the sender host IP address is taken from
4185 whichever one is last.
4186
4187 .vitem &%-oMaa%&&~<&'name'&>
4188 .oindex "&%-oMaa%&"
4189 .cindex "authentication" "name, specifying for local message"
4190 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4191 option sets the value of &$sender_host_authenticated$& (the authenticator
4192 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4193 This option can be used with &%-bh%& and &%-bs%& to set up an
4194 authenticated SMTP session without actually using the SMTP AUTH command.
4195
4196 .vitem &%-oMai%&&~<&'string'&>
4197 .oindex "&%-oMai%&"
4198 .cindex "authentication" "id, specifying for local message"
4199 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4200 option sets the value of &$authenticated_id$& (the id that was authenticated).
4201 This overrides the default value (the caller's login id, except with &%-bh%&,
4202 where there is no default) for messages from local sources. See chapter
4203 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4204
4205 .vitem &%-oMas%&&~<&'address'&>
4206 .oindex "&%-oMas%&"
4207 .cindex "authentication" "sender, specifying for local message"
4208 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4209 option sets the authenticated sender value in &$authenticated_sender$&. It
4210 overrides the sender address that is created from the caller's login id for
4211 messages from local sources, except when &%-bh%& is used, when there is no
4212 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4213 specified on a MAIL command overrides this value. See chapter
4214 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4215
4216 .vitem &%-oMi%&&~<&'interface&~address'&>
4217 .oindex "&%-oMi%&"
4218 .cindex "interface" "address, specifying for local message"
4219 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4220 option sets the IP interface address value. A port number may be included,
4221 using the same syntax as for &%-oMa%&. The interface address is placed in
4222 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4223
4224 .vitem &%-oMm%&&~<&'message&~reference'&>
4225 .oindex "&%-oMm%&"
4226 .cindex "message reference" "message reference, specifying for local message"
4227 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4228 option sets the message reference, e.g. message-id, and is logged during
4229 delivery. This is useful when some kind of audit trail is required to tie
4230 messages together. The format of the message reference is checked and will
4231 abort if the format is invalid. The option will only be accepted if exim is
4232 running in trusted mode, not as any regular user.
4233
4234 The best example of a message reference is when Exim sends a bounce message.
4235 The message reference is the message-id of the original message for which Exim
4236 is sending the bounce.
4237
4238 .vitem &%-oMr%&&~<&'protocol&~name'&>
4239 .oindex "&%-oMr%&"
4240 .cindex "protocol, specifying for local message"
4241 .vindex "&$received_protocol$&"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4243 option sets the received protocol value that is stored in
4244 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4245 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4246 SMTP protocol names (see the description of &$received_protocol$& in section
4247 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4248 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4249 be set by &%-oMr%&.
4250
4251 .vitem &%-oMs%&&~<&'host&~name'&>
4252 .oindex "&%-oMs%&"
4253 .cindex "sender" "host name, specifying for local message"
4254 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4255 option sets the sender host name in &$sender_host_name$&. When this option is
4256 present, Exim does not attempt to look up a host name from an IP address; it
4257 uses the name it is given.
4258
4259 .vitem &%-oMt%&&~<&'ident&~string'&>
4260 .oindex "&%-oMt%&"
4261 .cindex "sender" "ident string, specifying for local message"
4262 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4263 option sets the sender ident value in &$sender_ident$&. The default setting for
4264 local callers is the login id of the calling process, except when &%-bh%& is
4265 used, when there is no default.
4266
4267 .vitem &%-om%&
4268 .oindex "&%-om%&"
4269 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4270 In Sendmail, this option means &"me too"&, indicating that the sender of a
4271 message should receive a copy of the message if the sender appears in an alias
4272 expansion. Exim always does this, so the option does nothing.
4273
4274 .vitem &%-oo%&
4275 .oindex "&%-oo%&"
4276 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4277 This option is ignored. In Sendmail it specifies &"old style headers"&,
4278 whatever that means.
4279
4280 .vitem &%-oP%&&~<&'path'&>
4281 .oindex "&%-oP%&"
4282 .cindex "pid (process id)" "of daemon"
4283 .cindex "daemon" "process id (pid)"
4284 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4285 value. The option specifies the file to which the process id of the daemon is
4286 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4287 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4288 because in those cases, the normal pid file is not used.
4289
4290 .vitem &%-or%&&~<&'time'&>
4291 .oindex "&%-or%&"
4292 .cindex "timeout" "for non-SMTP input"
4293 This option sets a timeout value for incoming non-SMTP messages. If it is not
4294 set, Exim will wait forever for the standard input. The value can also be set
4295 by the &%receive_timeout%& option. The format used for specifying times is
4296 described in section &<<SECTtimeformat>>&.
4297
4298 .vitem &%-os%&&~<&'time'&>
4299 .oindex "&%-os%&"
4300 .cindex "timeout" "for SMTP input"
4301 .cindex "SMTP" "input timeout"
4302 This option sets a timeout value for incoming SMTP messages. The timeout
4303 applies to each SMTP command and block of data. The value can also be set by
4304 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4305 for specifying times is described in section &<<SECTtimeformat>>&.
4306
4307 .vitem &%-ov%&
4308 .oindex "&%-ov%&"
4309 This option has exactly the same effect as &%-v%&.
4310
4311 .vitem &%-oX%&&~<&'number&~or&~string'&>
4312 .oindex "&%-oX%&"
4313 .cindex "TCP/IP" "setting listening ports"
4314 .cindex "TCP/IP" "setting listening interfaces"
4315 .cindex "port" "receiving TCP/IP"
4316 This option is relevant only when the &%-bd%& (start listening daemon) option
4317 is also given. It controls which ports and interfaces the daemon uses. Details
4318 of the syntax, and how it interacts with configuration file options, are given
4319 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4320 file is written unless &%-oP%& is also present to specify a pid file name.
4321
4322 .vitem &%-pd%&
4323 .oindex "&%-pd%&"
4324 .cindex "Perl" "starting the interpreter"
4325 This option applies when an embedded Perl interpreter is linked with Exim (see
4326 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4327 option, forcing the starting of the interpreter to be delayed until it is
4328 needed.
4329
4330 .vitem &%-ps%&
4331 .oindex "&%-ps%&"
4332 .cindex "Perl" "starting the interpreter"
4333 This option applies when an embedded Perl interpreter is linked with Exim (see
4334 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4335 option, forcing the starting of the interpreter to occur as soon as Exim is
4336 started.
4337
4338 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4339 .oindex "&%-p%&"
4340 For compatibility with Sendmail, this option is equivalent to
4341 .display
4342 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4343 .endd
4344 It sets the incoming protocol and host name (for trusted callers). The
4345 host name and its colon can be omitted when only the protocol is to be set.
4346 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4347 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4348 or &`s`& using this option (but that does not seem a real limitation).
4349
4350 .vitem &%-q%&
4351 .oindex "&%-q%&"
4352 .cindex "queue runner" "starting manually"
4353 This option is normally restricted to admin users. However, there is a
4354 configuration option called &%prod_requires_admin%& which can be set false to
4355 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4356 and &%-S%& options).
4357
4358 .cindex "queue runner" "description of operation"
4359 The &%-q%& option starts one queue runner process. This scans the queue of
4360 waiting messages, and runs a delivery process for each one in turn. It waits
4361 for each delivery process to finish before starting the next one. A delivery
4362 process may not actually do any deliveries if the retry times for the addresses
4363 have not been reached. Use &%-qf%& (see below) if you want to override this.
4364
4365 If
4366 .cindex "SMTP" "passed connection"
4367 .cindex "SMTP" "multiple deliveries"
4368 .cindex "multiple SMTP deliveries"
4369 the delivery process spawns other processes to deliver other messages down
4370 passed SMTP connections, the queue runner waits for these to finish before
4371 proceeding.
4372
4373 When all the queued messages have been considered, the original queue runner
4374 process terminates. In other words, a single pass is made over the waiting
4375 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4376 this to be repeated periodically.
4377
4378 Exim processes the waiting messages in an unpredictable order. It isn't very
4379 random, but it is likely to be different each time, which is all that matters.
4380 If one particular message screws up a remote MTA, other messages to the same
4381 MTA have a chance of getting through if they get tried first.
4382
4383 It is possible to cause the messages to be processed in lexical message id
4384 order, which is essentially the order in which they arrived, by setting the
4385 &%queue_run_in_order%& option, but this is not recommended for normal use.
4386
4387 .vitem &%-q%&<&'qflags'&>
4388 The &%-q%& option may be followed by one or more flag letters that change its
4389 behaviour. They are all optional, but if more than one is present, they must
4390 appear in the correct order. Each flag is described in a separate item below.
4391
4392 .vitem &%-qq...%&
4393 .oindex "&%-qq%&"
4394 .cindex "queue" "double scanning"
4395 .cindex "queue" "routing"
4396 .cindex "routing" "whole queue before delivery"
4397 An option starting with &%-qq%& requests a two-stage queue run. In the first
4398 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4399 every domain. Addresses are routed, local deliveries happen, but no remote
4400 transports are run.
4401
4402 .cindex "hints database" "remembering routing"
4403 The hints database that remembers which messages are waiting for specific hosts
4404 is updated, as if delivery to those hosts had been deferred. After this is
4405 complete, a second, normal queue scan happens, with routing and delivery taking
4406 place as normal. Messages that are routed to the same host should mostly be
4407 delivered down a single SMTP
4408 .cindex "SMTP" "passed connection"
4409 .cindex "SMTP" "multiple deliveries"
4410 .cindex "multiple SMTP deliveries"
4411 connection because of the hints that were set up during the first queue scan.
4412 This option may be useful for hosts that are connected to the Internet
4413 intermittently.
4414
4415 .vitem &%-q[q]i...%&
4416 .oindex "&%-qi%&"
4417 .cindex "queue" "initial delivery"
4418 If the &'i'& flag is present, the queue runner runs delivery processes only for
4419 those messages that haven't previously been tried. (&'i'& stands for &"initial
4420 delivery"&.) This can be helpful if you are putting messages on the queue using
4421 &%-odq%& and want a queue runner just to process the new messages.
4422
4423 .vitem &%-q[q][i]f...%&
4424 .oindex "&%-qf%&"
4425 .cindex "queue" "forcing delivery"
4426 .cindex "delivery" "forcing in queue run"
4427 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4428 message, whereas without &'f'& only those non-frozen addresses that have passed
4429 their retry times are tried.
4430
4431 .vitem &%-q[q][i]ff...%&
4432 .oindex "&%-qff%&"
4433 .cindex "frozen messages" "forcing delivery"
4434 If &'ff'& is present, a delivery attempt is forced for every message, whether
4435 frozen or not.
4436
4437 .vitem &%-q[q][i][f[f]]l%&
4438 .oindex "&%-ql%&"
4439 .cindex "queue" "local deliveries only"
4440 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4441 be done. If a message requires any remote deliveries, it remains on the queue
4442 for later delivery.
4443
4444 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4445 .cindex "queue" "delivering specific messages"
4446 When scanning the queue, Exim can be made to skip over messages whose ids are
4447 lexically less than a given value by following the &%-q%& option with a
4448 starting message id. For example:
4449 .code
4450 exim -q 0t5C6f-0000c8-00
4451 .endd
4452 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4453 second message id is given, messages whose ids are lexically greater than it
4454 are also skipped. If the same id is given twice, for example,
4455 .code
4456 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4457 .endd
4458 just one delivery process is started, for that message. This differs from
4459 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4460 that it counts as a delivery from a queue run. Note that the selection
4461 mechanism does not affect the order in which the messages are scanned. There
4462 are also other ways of selecting specific sets of messages for delivery in a
4463 queue run &-- see &%-R%& and &%-S%&.
4464
4465 .vitem &%-q%&<&'qflags'&><&'time'&>
4466 .cindex "queue runner" "starting periodically"
4467 .cindex "periodic queue running"
4468 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4469 starting a queue runner process at intervals specified by the given time value
4470 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4471 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4472 single daemon process handles both functions. A common way of starting up a
4473 combined daemon at system boot time is to use a command such as
4474 .code
4475 /usr/exim/bin/exim -bd -q30m
4476 .endd
4477 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4478 process every 30 minutes.
4479
4480 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4481 pid file is written unless one is explicitly requested by the &%-oP%& option.
4482
4483 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4484 .oindex "&%-qR%&"
4485 This option is synonymous with &%-R%&. It is provided for Sendmail
4486 compatibility.
4487
4488 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4489 .oindex "&%-qS%&"
4490 This option is synonymous with &%-S%&.
4491
4492 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4493 .oindex "&%-R%&"
4494 .cindex "queue runner" "for specific recipients"
4495 .cindex "delivery" "to given domain"
4496 .cindex "domain" "delivery to"
4497 The <&'rsflags'&> may be empty, in which case the white space before the string
4498 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4499 which are the possible values for <&'rsflags'&>. White space is required if
4500 <&'rsflags'&> is not empty.
4501
4502 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4503 perform a single queue run, except that, when scanning the messages on the
4504 queue, Exim processes only those that have at least one undelivered recipient
4505 address containing the given string, which is checked in a case-independent
4506 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4507 regular expression; otherwise it is a literal string.
4508
4509 If you want to do periodic queue runs for messages with specific recipients,
4510 you can combine &%-R%& with &%-q%& and a time value. For example:
4511 .code
4512 exim -q25m -R @special.domain.example
4513 .endd
4514 This example does a queue run for messages with recipients in the given domain
4515 every 25 minutes. Any additional flags that are specified with &%-q%& are
4516 applied to each queue run.
4517
4518 Once a message is selected for delivery by this mechanism, all its addresses
4519 are processed. For the first selected message, Exim overrides any retry
4520 information and forces a delivery attempt for each undelivered address. This
4521 means that if delivery of any address in the first message is successful, any
4522 existing retry information is deleted, and so delivery attempts for that
4523 address in subsequently selected messages (which are processed without forcing)
4524 will run. However, if delivery of any address does not succeed, the retry
4525 information is updated, and in subsequently selected messages, the failing
4526 address will be skipped.
4527
4528 .cindex "frozen messages" "forcing delivery"
4529 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4530 all selected messages, not just the first; frozen messages are included when
4531 &'ff'& is present.
4532
4533 The &%-R%& option makes it straightforward to initiate delivery of all messages
4534 to a given domain after a host has been down for some time. When the SMTP
4535 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4536 effect is to run Exim with the &%-R%& option, but it can be configured to run
4537 an arbitrary command instead.
4538
4539 .vitem &%-r%&
4540 .oindex "&%-r%&"
4541 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4542
4543 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4544 .oindex "&%-S%&"
4545 .cindex "delivery" "from given sender"
4546 .cindex "queue runner" "for specific senders"
4547 This option acts like &%-R%& except that it checks the string against each
4548 message's sender instead of against the recipients. If &%-R%& is also set, both
4549 conditions must be met for a message to be selected. If either of the options
4550 has &'f'& or &'ff'& in its flags, the associated action is taken.
4551
4552 .vitem &%-Tqt%&&~<&'times'&>
4553 .oindex "&%-Tqt%&"
4554 This is an option that is exclusively for use by the Exim testing suite. It is not
4555 recognized when Exim is run normally. It allows for the setting up of explicit
4556 &"queue times"& so that various warning/retry features can be tested.
4557
4558 .vitem &%-t%&
4559 .oindex "&%-t%&"
4560 .cindex "recipient" "extracting from header lines"
4561 .cindex "&'Bcc:'& header line"
4562 .cindex "&'Cc:'& header line"
4563 .cindex "&'To:'& header line"
4564 When Exim is receiving a locally-generated, non-SMTP message on its standard
4565 input, the &%-t%& option causes the recipients of the message to be obtained
4566 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4567 from the command arguments. The addresses are extracted before any rewriting
4568 takes place and the &'Bcc:'& header line, if present, is then removed.
4569
4570 .cindex "Sendmail compatibility" "&%-t%& option"
4571 If the command has any arguments, they specify addresses to which the message
4572 is &'not'& to be delivered. That is, the argument addresses are removed from
4573 the recipients list obtained from the headers. This is compatible with Smail 3
4574 and in accordance with the documented behaviour of several versions of
4575 Sendmail, as described in man pages on a number of operating systems (e.g.
4576 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4577 argument addresses to those obtained from the headers, and the O'Reilly
4578 Sendmail book documents it that way. Exim can be made to add argument addresses
4579 instead of subtracting them by setting the option
4580 &%extract_addresses_remove_arguments%& false.
4581
4582 .cindex "&%Resent-%& header lines" "with &%-t%&"
4583 If there are any &%Resent-%& header lines in the message, Exim extracts
4584 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4585 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4586 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4587 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4588
4589 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4590 message is resent several times). The RFC also specifies that they should be
4591 added at the front of the message, and separated by &'Received:'& lines. It is
4592 not at all clear how &%-t%& should operate in the present of multiple sets,
4593 nor indeed exactly what constitutes a &"set"&.
4594 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4595 are often added at the end of the header, and if a message is resent more than
4596 once, it is common for the original set of &%Resent-%& headers to be renamed as
4597 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4598
4599 .vitem &%-ti%&
4600 .oindex "&%-ti%&"
4601 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4602 compatibility with Sendmail.
4603
4604 .vitem &%-tls-on-connect%&
4605 .oindex "&%-tls-on-connect%&"
4606 .cindex "TLS" "use without STARTTLS"
4607 .cindex "TLS" "automatic start"
4608 This option is available when Exim is compiled with TLS support. It forces all
4609 incoming SMTP connections to behave as if the incoming port is listed in the
4610 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4611 &<<CHAPTLS>>& for further details.
4612
4613
4614 .vitem &%-U%&
4615 .oindex "&%-U%&"
4616 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4617 Sendmail uses this option for &"initial message submission"&, and its
4618 documentation states that in future releases, it may complain about
4619 syntactically invalid messages rather than fixing them when this flag is not
4620 set. Exim ignores this option.
4621
4622 .vitem &%-v%&
4623 .oindex "&%-v%&"
4624 This option causes Exim to write information to the standard error stream,
4625 describing what it is doing. In particular, it shows the log lines for
4626 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4627 dialogue is shown. Some of the log lines shown may not actually be written to
4628 the log if the setting of &%log_selector%& discards them. Any relevant
4629 selectors are shown with each log line. If none are shown, the logging is
4630 unconditional.
4631
4632 .vitem &%-x%&
4633 .oindex "&%-x%&"
4634 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4635 National Language Support extended characters in the body of the mail item"&).
4636 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4637 this option.
4638
4639 .vitem &%-X%&&~<&'logfile'&>
4640 .oindex "&%-X%&"
4641 This option is interpreted by Sendmail to cause debug information to be sent
4642 to the named file.  It is ignored by Exim.
4643 .endlist
4644
4645 .ecindex IIDclo1
4646 .ecindex IIDclo2
4647
4648
4649 . ////////////////////////////////////////////////////////////////////////////
4650 . Insert a stylized DocBook comment here, to identify the end of the command
4651 . line options. This is for the benefit of the Perl script that automatically
4652 . creates a man page for the options.
4653 . ////////////////////////////////////////////////////////////////////////////
4654
4655 .literal xml
4656 <!-- === End of command line options === -->
4657 .literal off
4658
4659
4660
4661
4662
4663 . ////////////////////////////////////////////////////////////////////////////
4664 . ////////////////////////////////////////////////////////////////////////////
4665
4666
4667 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4668          "The runtime configuration file"
4669
4670 .cindex "run time configuration"
4671 .cindex "configuration file" "general description"
4672 .cindex "CONFIGURE_FILE"
4673 .cindex "configuration file" "errors in"
4674 .cindex "error" "in configuration file"
4675 .cindex "return code" "for bad configuration"
4676 Exim uses a single run time configuration file that is read whenever an Exim
4677 binary is executed. Note that in normal operation, this happens frequently,
4678 because Exim is designed to operate in a distributed manner, without central
4679 control.
4680
4681 If a syntax error is detected while reading the configuration file, Exim
4682 writes a message on the standard error, and exits with a non-zero return code.
4683 The message is also written to the panic log. &*Note*&: Only simple syntax
4684 errors can be detected at this time. The values of any expanded options are
4685 not checked until the expansion happens, even when the expansion does not
4686 actually alter the string.
4687
4688 The name of the configuration file is compiled into the binary for security
4689 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4690 most configurations, this specifies a single file. However, it is permitted to
4691 give a colon-separated list of file names, in which case Exim uses the first
4692 existing file in the list.
4693
4694 .cindex "EXIM_USER"
4695 .cindex "EXIM_GROUP"
4696 .cindex "CONFIGURE_OWNER"
4697 .cindex "CONFIGURE_GROUP"
4698 .cindex "configuration file" "ownership"
4699 .cindex "ownership" "configuration file"
4700 The run time configuration file must be owned by root or by the user that is
4701 specified at compile time by the CONFIGURE_OWNER option (if set). The
4702 configuration file must not be world-writeable, or group-writeable unless its
4703 group is the root group or the one specified at compile time by the
4704 CONFIGURE_GROUP option.
4705
4706 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4707 to root, anybody who is able to edit the run time configuration file has an
4708 easy way to run commands as root. If you specify a user or group in the
4709 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4710 who are members of that group will trivially be able to obtain root privileges.
4711
4712 Up to Exim version 4.72, the run time configuration file was also permitted to
4713 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4714 since it offered a simple privilege escalation for any attacker who managed to
4715 compromise the Exim user account.
4716
4717 A default configuration file, which will work correctly in simple situations,
4718 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4719 defines just one file name, the installation process copies the default
4720 configuration to a new file of that name if it did not previously exist. If
4721 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4722 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4723 configuration.
4724
4725
4726
4727 .section "Using a different configuration file" "SECID40"
4728 .cindex "configuration file" "alternate"
4729 A one-off alternate configuration can be specified by the &%-C%& command line
4730 option, which may specify a single file or a list of files. However, when
4731 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4732 unless the argument for &%-C%& is identical to the built-in value from
4733 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4734 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4735 is useful mainly for checking the syntax of configuration files before
4736 installing them. No owner or group checks are done on a configuration file
4737 specified by &%-C%&, if root privilege has been dropped.
4738
4739 Even the Exim user is not trusted to specify an arbitrary configuration file
4740 with the &%-C%& option to be used with root privileges, unless that file is
4741 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4742 testing a configuration using &%-C%& right through message reception and
4743 delivery, even if the caller is root. The reception works, but by that time,
4744 Exim is running as the Exim user, so when it re-execs to regain privilege for
4745 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4746 can test reception and delivery using two separate commands (one to put a
4747 message on the queue, using &%-odq%&, and another to do the delivery, using
4748 &%-M%&).
4749
4750 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4751 prefix string with which any file named in a &%-C%& command line option must
4752 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4753 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4754 name can be used with &%-C%&.
4755
4756 One-off changes to a configuration can be specified by the &%-D%& command line
4757 option, which defines and overrides values for macros used inside the
4758 configuration file. However, like &%-C%&, the use of this option by a
4759 non-privileged user causes Exim to discard its root privilege.
4760 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4761 completely disabled, and its use causes an immediate error exit.
4762
4763 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4764 to declare certain macro names trusted, such that root privilege will not
4765 necessarily be discarded.
4766 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4767 considered safe and, if &%-D%& only supplies macros from this list, and the
4768 values are acceptable, then Exim will not give up root privilege if the caller
4769 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4770 transition mechanism and is expected to be removed in the future.  Acceptable
4771 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4772
4773 Some sites may wish to use the same Exim binary on different machines that
4774 share a file system, but to use different configuration files on each machine.
4775 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4776 looks for a file whose name is the configuration file name followed by a dot
4777 and the machine's node name, as obtained from the &[uname()]& function. If this
4778 file does not exist, the standard name is tried. This processing occurs for
4779 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4780
4781 In some esoteric situations different versions of Exim may be run under
4782 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4783 help with this. See the comments in &_src/EDITME_& for details.
4784
4785
4786
4787 .section "Configuration file format" "SECTconffilfor"
4788 .cindex "configuration file" "format of"
4789 .cindex "format" "configuration file"
4790 Exim's configuration file is divided into a number of different parts. General
4791 option settings must always appear at the start of the file. The other parts
4792 are all optional, and may appear in any order. Each part other than the first
4793 is introduced by the word &"begin"& followed by the name of the part. The
4794 optional parts are:
4795
4796 .ilist
4797 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4798 &<<CHAPACL>>&).
4799 .next
4800 .cindex "AUTH" "configuration"
4801 &'authenticators'&: Configuration settings for the authenticator drivers. These
4802 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4803 .next
4804 &'routers'&: Configuration settings for the router drivers. Routers process
4805 addresses and determine how the message is to be delivered (see chapters
4806 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4807 .next
4808 &'transports'&: Configuration settings for the transport drivers. Transports
4809 define mechanisms for copying messages to destinations (see chapters
4810 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4811 .next
4812 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4813 If there is no retry section, or if it is empty (that is, no retry rules are
4814 defined), Exim will not retry deliveries. In this situation, temporary errors
4815 are treated the same as permanent errors. Retry rules are discussed in chapter
4816 &<<CHAPretry>>&.
4817 .next
4818 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4819 when new addresses are generated during delivery. Rewriting is discussed in
4820 chapter &<<CHAPrewrite>>&.
4821 .next
4822 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4823 want to use this feature, you must set
4824 .code
4825 LOCAL_SCAN_HAS_OPTIONS=yes
4826 .endd
4827 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4828 facility are given in chapter &<<CHAPlocalscan>>&.
4829 .endlist
4830
4831 .cindex "configuration file" "leading white space in"
4832 .cindex "configuration file" "trailing white space in"
4833 .cindex "white space" "in configuration file"
4834 Leading and trailing white space in configuration lines is always ignored.
4835
4836 Blank lines in the file, and lines starting with a # character (ignoring
4837 leading white space) are treated as comments and are ignored. &*Note*&: A
4838 # character other than at the beginning of a line is not treated specially,
4839 and does not introduce a comment.
4840
4841 Any non-comment line can be continued by ending it with a backslash. Note that
4842 the general rule for white space means that trailing white space after the
4843 backslash and leading white space at the start of continuation
4844 lines is ignored. Comment lines beginning with # (but not empty lines) may
4845 appear in the middle of a sequence of continuation lines.
4846
4847 A convenient way to create a configuration file is to start from the
4848 default, which is supplied in &_src/configure.default_&, and add, delete, or
4849 change settings as required.
4850
4851 The ACLs, retry rules, and rewriting rules have their own syntax which is
4852 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4853 respectively. The other parts of the configuration file have some syntactic
4854 items in common, and these are described below, from section &<<SECTcos>>&
4855 onwards. Before that, the inclusion, macro, and conditional facilities are
4856 described.
4857
4858
4859
4860 .section "File inclusions in the configuration file" "SECID41"
4861 .cindex "inclusions in configuration file"
4862 .cindex "configuration file" "including other files"
4863 .cindex "&`.include`& in configuration file"
4864 .cindex "&`.include_if_exists`& in configuration file"
4865 You can include other files inside Exim's run time configuration file by
4866 using this syntax:
4867 .display
4868 &`.include`& <&'file name'&>
4869 &`.include_if_exists`& <&'file name'&>
4870 .endd
4871 on a line by itself. Double quotes round the file name are optional. If you use
4872 the first form, a configuration error occurs if the file does not exist; the
4873 second form does nothing for non-existent files. In all cases, an absolute file
4874 name is required.
4875
4876 Includes may be nested to any depth, but remember that Exim reads its
4877 configuration file often, so it is a good idea to keep them to a minimum.
4878 If you change the contents of an included file, you must HUP the daemon,
4879 because an included file is read only when the configuration itself is read.
4880
4881 The processing of inclusions happens early, at a physical line level, so, like
4882 comment lines, an inclusion can be used in the middle of an option setting,
4883 for example:
4884 .code
4885 hosts_lookup = a.b.c \
4886                .include /some/file
4887 .endd
4888 Include processing happens after macro processing (see below). Its effect is to
4889 process the lines of the included file as if they occurred inline where the
4890 inclusion appears.
4891
4892
4893
4894 .section "Macros in the configuration file" "SECTmacrodefs"
4895 .cindex "macro" "description of"
4896 .cindex "configuration file" "macros"
4897 If a line in the main part of the configuration (that is, before the first
4898 &"begin"& line) begins with an upper case letter, it is taken as a macro
4899 definition, and must be of the form
4900 .display
4901 <&'name'&> = <&'rest of line'&>
4902 .endd
4903 The name must consist of letters, digits, and underscores, and need not all be
4904 in upper case, though that is recommended. The rest of the line, including any
4905 continuations, is the replacement text, and has leading and trailing white
4906 space removed. Quotes are not removed. The replacement text can never end with
4907 a backslash character, but this doesn't seem to be a serious limitation.
4908
4909 Macros may also be defined between router, transport, authenticator, or ACL
4910 definitions. They may not, however, be defined within an individual driver or
4911 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4912
4913 .section "Macro substitution" "SECID42"
4914 Once a macro is defined, all subsequent lines in the file (and any included
4915 files) are scanned for the macro name; if there are several macros, the line is
4916 scanned for each in turn, in the order in which the macros are defined. The
4917 replacement text is not re-scanned for the current macro, though it is scanned
4918 for subsequently defined macros. For this reason, a macro name may not contain
4919 the name of a previously defined macro as a substring. You could, for example,
4920 define
4921 .display
4922 &`ABCD_XYZ = `&<&'something'&>
4923 &`ABCD = `&<&'something else'&>
4924 .endd
4925 but putting the definitions in the opposite order would provoke a configuration
4926 error. Macro expansion is applied to individual physical lines from the file,
4927 before checking for line continuation or file inclusion (see above). If a line
4928 consists solely of a macro name, and the expansion of the macro is empty, the
4929 line is ignored. A macro at the start of a line may turn the line into a
4930 comment line or a &`.include`& line.
4931
4932
4933 .section "Redefining macros" "SECID43"
4934 Once defined, the value of a macro can be redefined later in the configuration
4935 (or in an included file). Redefinition is specified by using &'=='& instead of
4936 &'='&. For example:
4937 .code
4938 MAC =  initial value
4939 ...
4940 MAC == updated value
4941 .endd
4942 Redefinition does not alter the order in which the macros are applied to the
4943 subsequent lines of the configuration file. It is still the same order in which
4944 the macros were originally defined. All that changes is the macro's value.
4945 Redefinition makes it possible to accumulate values. For example:
4946 .code
4947 MAC =  initial value
4948 ...
4949 MAC == MAC and something added
4950 .endd
4951 This can be helpful in situations where the configuration file is built
4952 from a number of other files.
4953
4954 .section "Overriding macro values" "SECID44"
4955 The values set for macros in the configuration file can be overridden by the
4956 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4957 used, unless called by root or the Exim user. A definition on the command line
4958 using the &%-D%& option causes all definitions and redefinitions within the
4959 file to be ignored.
4960
4961
4962
4963 .section "Example of macro usage" "SECID45"
4964 As an example of macro usage, consider a configuration where aliases are looked
4965 up in a MySQL database. It helps to keep the file less cluttered if long
4966 strings such as SQL statements are defined separately as macros, for example:
4967 .code
4968 ALIAS_QUERY = select mailbox from user where \
4969               login='${quote_mysql:$local_part}';
4970 .endd
4971 This can then be used in a &(redirect)& router setting like this:
4972 .code
4973 data = ${lookup mysql{ALIAS_QUERY}}
4974 .endd
4975 In earlier versions of Exim macros were sometimes used for domain, host, or
4976 address lists. In Exim 4 these are handled better by named lists &-- see
4977 section &<<SECTnamedlists>>&.
4978
4979
4980 .section "Conditional skips in the configuration file" "SECID46"
4981 .cindex "configuration file" "conditional skips"
4982 .cindex "&`.ifdef`&"
4983 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4984 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4985 portions of the configuration file. The processing happens whenever the file is
4986 read (that is, when an Exim binary starts to run).
4987
4988 The implementation is very simple. Instances of the first four directives must
4989 be followed by text that includes the names of one or macros. The condition
4990 that is tested is whether or not any macro substitution has taken place in the
4991 line. Thus:
4992 .code
4993 .ifdef AAA
4994 message_size_limit = 50M
4995 .else
4996 message_size_limit = 100M
4997 .endif
4998 .endd
4999 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5000 otherwise. If there is more than one macro named on the line, the condition
5001 is true if any of them are defined. That is, it is an &"or"& condition. To
5002 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5003
5004 Although you can use a macro expansion to generate one of these directives,
5005 it is not very useful, because the condition &"there was a macro substitution
5006 in this line"& will always be true.
5007
5008 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5009 to clarify complicated nestings.
5010
5011
5012
5013 .section "Common option syntax" "SECTcos"
5014 .cindex "common option syntax"
5015 .cindex "syntax of common options"
5016 .cindex "configuration file" "common option syntax"
5017 For the main set of options, driver options, and &[local_scan()]& options,
5018 each setting is on a line by itself, and starts with a name consisting of
5019 lower-case letters and underscores. Many options require a data value, and in
5020 these cases the name must be followed by an equals sign (with optional white
5021 space) and then the value. For example:
5022 .code
5023 qualify_domain = mydomain.example.com
5024 .endd
5025 .cindex "hiding configuration option values"
5026 .cindex "configuration options" "hiding value of"
5027 .cindex "options" "hiding value of"
5028 Some option settings may contain sensitive data, for example, passwords for
5029 accessing databases. To stop non-admin users from using the &%-bP%& command
5030 line option to read these values, you can precede the option settings with the
5031 word &"hide"&. For example:
5032 .code
5033 hide mysql_servers = localhost/users/admin/secret-password
5034 .endd
5035 For non-admin users, such options are displayed like this:
5036 .code
5037 mysql_servers = <value not displayable>
5038 .endd
5039 If &"hide"& is used on a driver option, it hides the value of that option on
5040 all instances of the same driver.
5041
5042 The following sections describe the syntax used for the different data types
5043 that are found in option settings.
5044
5045
5046 .section "Boolean options" "SECID47"
5047 .cindex "format" "boolean"
5048 .cindex "boolean configuration values"
5049 .oindex "&%no_%&&'xxx'&"
5050 .oindex "&%not_%&&'xxx'&"
5051 Options whose type is given as boolean are on/off switches. There are two
5052 different ways of specifying such options: with and without a data value. If
5053 the option name is specified on its own without data, the switch is turned on;
5054 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5055 boolean options may be followed by an equals sign and one of the words
5056 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5057 the following two settings have exactly the same effect:
5058 .code
5059 queue_only
5060 queue_only = true
5061 .endd
5062 The following two lines also have the same (opposite) effect:
5063 .code
5064 no_queue_only
5065 queue_only = false
5066 .endd
5067 You can use whichever syntax you prefer.
5068
5069
5070
5071
5072 .section "Integer values" "SECID48"
5073 .cindex "integer configuration values"
5074 .cindex "format" "integer"
5075 If an option's type is given as &"integer"&, the value can be given in decimal,
5076 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5077 number is assumed. Otherwise, it is treated as an octal number unless it starts
5078 with the characters &"0x"&, in which case the remainder is interpreted as a
5079 hexadecimal number.
5080
5081 If an integer value is followed by the letter K, it is multiplied by 1024; if
5082 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5083 of integer option settings are output, values which are an exact multiple of
5084 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5085 and M. The printing style is independent of the actual input format that was
5086 used.
5087
5088
5089 .section "Octal integer values" "SECID49"
5090 .cindex "integer format"
5091 .cindex "format" "octal integer"
5092 If an option's type is given as &"octal integer"&, its value is always
5093 interpreted as an octal number, whether or not it starts with the digit zero.
5094 Such options are always output in octal.
5095
5096
5097 .section "Fixed point numbers" "SECID50"
5098 .cindex "fixed point configuration values"
5099 .cindex "format" "fixed point"
5100 If an option's type is given as &"fixed-point"&, its value must be a decimal
5101 integer, optionally followed by a decimal point and up to three further digits.
5102
5103
5104
5105 .section "Time intervals" "SECTtimeformat"
5106 .cindex "time interval" "specifying in configuration"
5107 .cindex "format" "time interval"
5108 A time interval is specified as a sequence of numbers, each followed by one of
5109 the following letters, with no intervening white space:
5110
5111 .table2 30pt
5112 .irow &%s%& seconds
5113 .irow &%m%& minutes
5114 .irow &%h%& hours
5115 .irow &%d%& days
5116 .irow &%w%& weeks
5117 .endtable
5118
5119 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5120 intervals are output in the same format. Exim does not restrict the values; it
5121 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5122
5123
5124
5125 .section "String values" "SECTstrings"
5126 .cindex "string" "format of configuration values"
5127 .cindex "format" "string"
5128 If an option's type is specified as &"string"&, the value can be specified with
5129 or without double-quotes. If it does not start with a double-quote, the value
5130 consists of the remainder of the line plus any continuation lines, starting at
5131 the first character after any leading white space, with trailing white space
5132 removed, and with no interpretation of the characters in the string. Because
5133 Exim removes comment lines (those beginning with #) at an early stage, they can
5134 appear in the middle of a multi-line string. The following two settings are
5135 therefore equivalent:
5136 .code
5137 trusted_users = uucp:mail
5138 trusted_users = uucp:\
5139                 # This comment line is ignored
5140                 mail
5141 .endd
5142 .cindex "string" "quoted"
5143 .cindex "escape characters in quoted strings"
5144 If a string does start with a double-quote, it must end with a closing
5145 double-quote, and any backslash characters other than those used for line
5146 continuation are interpreted as escape characters, as follows:
5147
5148 .table2 100pt
5149 .irow &`\\`&                     "single backslash"
5150 .irow &`\n`&                     "newline"
5151 .irow &`\r`&                     "carriage return"
5152 .irow &`\t`&                     "tab"
5153 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5154 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5155                                    character"
5156 .endtable
5157
5158 If a backslash is followed by some other character, including a double-quote
5159 character, that character replaces the pair.
5160
5161 Quoting is necessary only if you want to make use of the backslash escapes to
5162 insert special characters, or if you need to specify a value with leading or
5163 trailing spaces. These cases are rare, so quoting is almost never needed in
5164 current versions of Exim. In versions of Exim before 3.14, quoting was required
5165 in order to continue lines, so you may come across older configuration files
5166 and examples that apparently quote unnecessarily.
5167
5168
5169 .section "Expanded strings" "SECID51"
5170 .cindex "expansion" "definition of"
5171 Some strings in the configuration file are subjected to &'string expansion'&,
5172 by which means various parts of the string may be changed according to the
5173 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5174 is as just described; in particular, the handling of backslashes in quoted
5175 strings is done as part of the input process, before expansion takes place.
5176 However, backslash is also an escape character for the expander, so any
5177 backslashes that are required for that reason must be doubled if they are
5178 within a quoted configuration string.
5179
5180
5181 .section "User and group names" "SECID52"
5182 .cindex "user name" "format of"
5183 .cindex "format" "user name"
5184 .cindex "groups" "name format"
5185 .cindex "format" "group name"
5186 User and group names are specified as strings, using the syntax described
5187 above, but the strings are interpreted specially. A user or group name must
5188 either consist entirely of digits, or be a name that can be looked up using the
5189 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5190
5191
5192 .section "List construction" "SECTlistconstruct"
5193 .cindex "list" "syntax of in configuration"
5194 .cindex "format" "list item in configuration"
5195 .cindex "string" "list, definition of"
5196 The data for some configuration options is a list of items, with colon as the
5197 default separator. Many of these options are shown with type &"string list"& in
5198 the descriptions later in this document. Others are listed as &"domain list"&,
5199 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5200 are all the same; however, those other than &"string list"& are subject to
5201 particular kinds of interpretation, as described in chapter
5202 &<<CHAPdomhosaddlists>>&.
5203
5204 In all these cases, the entire list is treated as a single string as far as the
5205 input syntax is concerned. The &%trusted_users%& setting in section
5206 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5207 in a list, it must be entered as two colons. Leading and trailing white space
5208 on each item in a list is ignored. This makes it possible to include items that
5209 start with a colon, and in particular, certain forms of IPv6 address. For
5210 example, the list
5211 .code
5212 local_interfaces = 127.0.0.1 : ::::1
5213 .endd
5214 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5215
5216 &*Note*&: Although leading and trailing white space is ignored in individual
5217 list items, it is not ignored when parsing the list. The space after the first
5218 colon in the example above is necessary. If it were not there, the list would
5219 be interpreted as the two items 127.0.0.1:: and 1.
5220
5221 .section "Changing list separators" "SECID53"
5222 .cindex "list separator" "changing"
5223 .cindex "IPv6" "addresses in lists"
5224 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5225 introduced to allow the separator character to be changed. If a list begins
5226 with a left angle bracket, followed by any punctuation character, that
5227 character is used instead of colon as the list separator. For example, the list
5228 above can be rewritten to use a semicolon separator like this:
5229 .code
5230 local_interfaces = <; 127.0.0.1 ; ::1
5231 .endd
5232 This facility applies to all lists, with the exception of the list in
5233 &%log_file_path%&. It is recommended that the use of non-colon separators be
5234 confined to circumstances where they really are needed.
5235
5236 .cindex "list separator" "newline as"
5237 .cindex "newline" "as list separator"
5238 It is also possible to use newline and other control characters (those with
5239 code values less than 32, plus DEL) as separators in lists. Such separators
5240 must be provided literally at the time the list is processed. For options that
5241 are string-expanded, you can write the separator using a normal escape
5242 sequence. This will be processed by the expander before the string is
5243 interpreted as a list. For example, if a newline-separated list of domains is
5244 generated by a lookup, you can process it directly by a line such as this:
5245 .code
5246 domains = <\n ${lookup mysql{.....}}
5247 .endd
5248 This avoids having to change the list separator in such data. You are unlikely
5249 to want to use a control character as a separator in an option that is not
5250 expanded, because the value is literal text. However, it can be done by giving
5251 the value in quotes. For example:
5252 .code
5253 local_interfaces = "<\n 127.0.0.1 \n ::1"
5254 .endd
5255 Unlike printing character separators, which can be included in list items by
5256 doubling, it is not possible to include a control character as data when it is
5257 set as the separator. Two such characters in succession are interpreted as
5258 enclosing an empty list item.
5259
5260
5261
5262 .section "Empty items in lists" "SECTempitelis"
5263 .cindex "list" "empty item in"
5264 An empty item at the end of a list is always ignored. In other words, trailing
5265 separator characters are ignored. Thus, the list in
5266 .code
5267 senders = user@domain :
5268 .endd
5269 contains only a single item. If you want to include an empty string as one item
5270 in a list, it must not be the last item. For example, this list contains three
5271 items, the second of which is empty:
5272 .code
5273 senders = user1@domain : : user2@domain
5274 .endd
5275 &*Note*&: There must be white space between the two colons, as otherwise they
5276 are interpreted as representing a single colon data character (and the list
5277 would then contain just one item). If you want to specify a list that contains
5278 just one, empty item, you can do it as in this example:
5279 .code
5280 senders = :
5281 .endd
5282 In this case, the first item is empty, and the second is discarded because it
5283 is at the end of the list.
5284
5285
5286
5287
5288 .section "Format of driver configurations" "SECTfordricon"
5289 .cindex "drivers" "configuration format"
5290 There are separate parts in the configuration for defining routers, transports,
5291 and authenticators. In each part, you are defining a number of driver
5292 instances, each with its own set of options. Each driver instance is defined by
5293 a sequence of lines like this:
5294 .display
5295 <&'instance name'&>:
5296   <&'option'&>
5297   ...
5298   <&'option'&>
5299 .endd
5300 In the following example, the instance name is &(localuser)&, and it is
5301 followed by three options settings:
5302 .code
5303 localuser:
5304   driver = accept
5305   check_local_user
5306   transport = local_delivery
5307 .endd
5308 For each driver instance, you specify which Exim code module it uses &-- by the
5309 setting of the &%driver%& option &-- and (optionally) some configuration
5310 settings. For example, in the case of transports, if you want a transport to
5311 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5312 a local file you would use the &(appendfile)& driver. Each of the drivers is
5313 described in detail in its own separate chapter later in this manual.
5314
5315 You can have several routers, transports, or authenticators that are based on
5316 the same underlying driver (each must have a different instance name).
5317
5318 The order in which routers are defined is important, because addresses are
5319 passed to individual routers one by one, in order. The order in which
5320 transports are defined does not matter at all. The order in which
5321 authenticators are defined is used only when Exim, as a client, is searching
5322 them to find one that matches an authentication mechanism offered by the
5323 server.
5324
5325 .cindex "generic options"
5326 .cindex "options" "generic &-- definition of"
5327 Within a driver instance definition, there are two kinds of option: &'generic'&
5328 and &'private'&. The generic options are those that apply to all drivers of the
5329 same type (that is, all routers, all transports or all authenticators). The
5330 &%driver%& option is a generic option that must appear in every definition.
5331 .cindex "private options"
5332 The private options are special for each driver, and none need appear, because
5333 they all have default values.
5334
5335 The options may appear in any order, except that the &%driver%& option must
5336 precede any private options, since these depend on the particular driver. For
5337 this reason, it is recommended that &%driver%& always be the first option.
5338
5339 Driver instance names, which are used for reference in log entries and
5340 elsewhere, can be any sequence of letters, digits, and underscores (starting
5341 with a letter) and must be unique among drivers of the same type. A router and
5342 a transport (for example) can each have the same name, but no two router
5343 instances can have the same name. The name of a driver instance should not be
5344 confused with the name of the underlying driver module. For example, the
5345 configuration lines:
5346 .code
5347 remote_smtp:
5348   driver = smtp
5349 .endd
5350 create an instance of the &(smtp)& transport driver whose name is
5351 &(remote_smtp)&. The same driver code can be used more than once, with
5352 different instance names and different option settings each time. A second
5353 instance of the &(smtp)& transport, with different options, might be defined
5354 thus:
5355 .code
5356 special_smtp:
5357   driver = smtp
5358   port = 1234
5359   command_timeout = 10s
5360 .endd
5361 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5362 these transport instances from routers, and these names would appear in log
5363 lines.
5364
5365 Comment lines may be present in the middle of driver specifications. The full
5366 list of option settings for any particular driver instance, including all the
5367 defaulted values, can be extracted by making use of the &%-bP%& command line
5368 option.
5369
5370
5371
5372
5373
5374
5375 . ////////////////////////////////////////////////////////////////////////////
5376 . ////////////////////////////////////////////////////////////////////////////
5377
5378 .chapter "The default configuration file" "CHAPdefconfil"
5379 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5380 .cindex "default" "configuration file &""walk through""&"
5381 The default configuration file supplied with Exim as &_src/configure.default_&
5382 is sufficient for a host with simple mail requirements. As an introduction to
5383 the way Exim is configured, this chapter &"walks through"& the default
5384 configuration, giving brief explanations of the settings. Detailed descriptions
5385 of the options are given in subsequent chapters. The default configuration file
5386 itself contains extensive comments about ways you might want to modify the
5387 initial settings. However, note that there are many options that are not
5388 mentioned at all in the default configuration.
5389
5390
5391
5392 .section "Main configuration settings" "SECTdefconfmain"
5393 The main (global) configuration option settings must always come first in the
5394 file. The first thing you'll see in the file, after some initial comments, is
5395 the line
5396 .code
5397 # primary_hostname =
5398 .endd
5399 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5400 to know the official, fully qualified name of your host, and this is where you
5401 can specify it. However, in most cases you do not need to set this option. When
5402 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5403
5404 The first three non-comment configuration lines are as follows:
5405 .code
5406 domainlist local_domains    = @
5407 domainlist relay_to_domains =
5408 hostlist   relay_from_hosts = 127.0.0.1
5409 .endd
5410 These are not, in fact, option settings. They are definitions of two named
5411 domain lists and one named host list. Exim allows you to give names to lists of
5412 domains, hosts, and email addresses, in order to make it easier to manage the
5413 configuration file (see section &<<SECTnamedlists>>&).
5414
5415 The first line defines a domain list called &'local_domains'&; this is used
5416 later in the configuration to identify domains that are to be delivered
5417 on the local host.
5418
5419 .cindex "@ in a domain list"
5420 There is just one item in this list, the string &"@"&. This is a special form
5421 of entry which means &"the name of the local host"&. Thus, if the local host is
5422 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5423 be delivered locally. Because the local host's name is referenced indirectly,
5424 the same configuration file can be used on different hosts.
5425
5426 The second line defines a domain list called &'relay_to_domains'&, but the
5427 list itself is empty. Later in the configuration we will come to the part that
5428 controls mail relaying through the local host; it allows relaying to any
5429 domains in this list. By default, therefore, no relaying on the basis of a mail
5430 domain is permitted.
5431
5432 The third line defines a host list called &'relay_from_hosts'&. This list is
5433 used later in the configuration to permit relaying from any host or IP address
5434 that matches the list. The default contains just the IP address of the IPv4
5435 loopback interface, which means that processes on the local host are able to
5436 submit mail for relaying by sending it over TCP/IP to that interface. No other
5437 hosts are permitted to submit messages for relaying.
5438
5439 Just to be sure there's no misunderstanding: at this point in the configuration
5440 we aren't actually setting up any controls. We are just defining some domains
5441 and hosts that will be used in the controls that are specified later.
5442
5443 The next two configuration lines are genuine option settings:
5444 .code
5445 acl_smtp_rcpt = acl_check_rcpt
5446 acl_smtp_data = acl_check_data
5447 .endd
5448 These options specify &'Access Control Lists'& (ACLs) that are to be used
5449 during an incoming SMTP session for every recipient of a message (every RCPT
5450 command), and after the contents of the message have been received,
5451 respectively. The names of the lists are &'acl_check_rcpt'& and
5452 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5453 section of the configuration. The RCPT ACL controls which recipients are
5454 accepted for an incoming message &-- if a configuration does not provide an ACL
5455 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5456 contents of a message to be checked.
5457
5458 Two commented-out option settings are next:
5459 .code
5460 # av_scanner = clamd:/tmp/clamd
5461 # spamd_address = 127.0.0.1 783
5462 .endd
5463 These are example settings that can be used when Exim is compiled with the
5464 content-scanning extension. The first specifies the interface to the virus
5465 scanner, and the second specifies the interface to SpamAssassin. Further
5466 details are given in chapter &<<CHAPexiscan>>&.
5467
5468 Three more commented-out option settings follow:
5469 .code
5470 # tls_advertise_hosts = *
5471 # tls_certificate = /etc/ssl/exim.crt
5472 # tls_privatekey = /etc/ssl/exim.pem
5473 .endd
5474 These are example settings that can be used when Exim is compiled with
5475 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5476 first one specifies the list of clients that are allowed to use TLS when
5477 connecting to this server; in this case the wildcard means all clients. The
5478 other options specify where Exim should find its TLS certificate and private
5479 key, which together prove the server's identity to any clients that connect.
5480 More details are given in chapter &<<CHAPTLS>>&.
5481
5482 Another two commented-out option settings follow:
5483 .code
5484 # daemon_smtp_ports = 25 : 465 : 587
5485 # tls_on_connect_ports = 465
5486 .endd
5487 .cindex "port" "465 and 587"
5488 .cindex "port" "for message submission"
5489 .cindex "message" "submission, ports for"
5490 .cindex "ssmtp protocol"
5491 .cindex "smtps protocol"
5492 .cindex "SMTP" "ssmtp protocol"
5493 .cindex "SMTP" "smtps protocol"
5494 These options provide better support for roaming users who wish to use this
5495 server for message submission. They are not much use unless you have turned on
5496 TLS (as described in the previous paragraph) and authentication (about which
5497 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5498 on end-user networks, so RFC 4409 specifies that message submission should use
5499 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5500 configured to use port 587 correctly, so these settings also enable the
5501 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5502 &<<SECTsupobssmt>>&).
5503
5504 Two more commented-out options settings follow:
5505 .code
5506 # qualify_domain =
5507 # qualify_recipient =
5508 .endd
5509 The first of these specifies a domain that Exim uses when it constructs a
5510 complete email address from a local login name. This is often needed when Exim
5511 receives a message from a local process. If you do not set &%qualify_domain%&,
5512 the value of &%primary_hostname%& is used. If you set both of these options,
5513 you can have different qualification domains for sender and recipient
5514 addresses. If you set only the first one, its value is used in both cases.
5515
5516 .cindex "domain literal" "recognizing format"
5517 The following line must be uncommented if you want Exim to recognize
5518 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5519 (an IP address within square brackets) instead of a named domain.
5520 .code
5521 # allow_domain_literals
5522 .endd
5523 The RFCs still require this form, but many people think that in the modern
5524 Internet it makes little sense to permit mail to be sent to specific hosts by
5525 quoting their IP addresses. This ancient format has been used by people who
5526 try to abuse hosts by using them for unwanted relaying. However, some
5527 people believe there are circumstances (for example, messages addressed to
5528 &'postmaster'&) where domain literals are still useful.
5529
5530 The next configuration line is a kind of trigger guard:
5531 .code
5532 never_users = root
5533 .endd
5534 It specifies that no delivery must ever be run as the root user. The normal
5535 convention is to set up &'root'& as an alias for the system administrator. This
5536 setting is a guard against slips in the configuration.
5537 The list of users specified by &%never_users%& is not, however, the complete
5538 list; the build-time configuration in &_Local/Makefile_& has an option called
5539 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5540 contents of &%never_users%& are added to this list. By default
5541 FIXED_NEVER_USERS also specifies root.
5542
5543 When a remote host connects to Exim in order to send mail, the only information
5544 Exim has about the host's identity is its IP address. The next configuration
5545 line,
5546 .code
5547 host_lookup = *
5548 .endd
5549 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5550 in order to get a host name. This improves the quality of the logging
5551 information, but if you feel it is too expensive, you can remove it entirely,
5552 or restrict the lookup to hosts on &"nearby"& networks.
5553 Note that it is not always possible to find a host name from an IP address,
5554 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5555 unreachable.
5556
5557 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5558 1413 (hence their names):
5559 .code
5560 rfc1413_hosts = *
5561 rfc1413_query_timeout = 5s
5562 .endd
5563 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5564 You can limit the hosts to which these calls are made, or change the timeout
5565 that is used. If you set the timeout to zero, all ident calls are disabled.
5566 Although they are cheap and can provide useful information for tracing problem
5567 messages, some hosts and firewalls have problems with ident calls. This can
5568 result in a timeout instead of an immediate refused connection, leading to
5569 delays on starting up an incoming SMTP session.
5570
5571 When Exim receives messages over SMTP connections, it expects all addresses to
5572 be fully qualified with a domain, as required by the SMTP definition. However,
5573 if you are running a server to which simple clients submit messages, you may
5574 find that they send unqualified addresses. The two commented-out options:
5575 .code
5576 # sender_unqualified_hosts =
5577 # recipient_unqualified_hosts =
5578 .endd
5579 show how you can specify hosts that are permitted to send unqualified sender
5580 and recipient addresses, respectively.
5581
5582 The &%percent_hack_domains%& option is also commented out:
5583 .code
5584 # percent_hack_domains =
5585 .endd
5586 It provides a list of domains for which the &"percent hack"& is to operate.
5587 This is an almost obsolete form of explicit email routing. If you do not know
5588 anything about it, you can safely ignore this topic.
5589
5590 The last two settings in the main part of the default configuration are
5591 concerned with messages that have been &"frozen"& on Exim's queue. When a
5592 message is frozen, Exim no longer continues to try to deliver it. Freezing
5593 occurs when a bounce message encounters a permanent failure because the sender
5594 address of the original message that caused the bounce is invalid, so the
5595 bounce cannot be delivered. This is probably the most common case, but there
5596 are also other conditions that cause freezing, and frozen messages are not
5597 always bounce messages.
5598 .code
5599 ignore_bounce_errors_after = 2d
5600 timeout_frozen_after = 7d
5601 .endd
5602 The first of these options specifies that failing bounce messages are to be
5603 discarded after 2 days on the queue. The second specifies that any frozen
5604 message (whether a bounce message or not) is to be timed out (and discarded)
5605 after a week. In this configuration, the first setting ensures that no failing
5606 bounce message ever lasts a week.
5607
5608
5609
5610 .section "ACL configuration" "SECID54"
5611 .cindex "default" "ACLs"
5612 .cindex "&ACL;" "default configuration"
5613 In the default configuration, the ACL section follows the main configuration.
5614 It starts with the line
5615 .code
5616 begin acl
5617 .endd
5618 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5619 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5620 and &%acl_smtp_data%& above.
5621
5622 .cindex "RCPT" "ACL for"
5623 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5624 RCPT command specifies one of the message's recipients. The ACL statements
5625 are considered in order, until the recipient address is either accepted or
5626 rejected. The RCPT command is then accepted or rejected, according to the
5627 result of the ACL processing.
5628 .code
5629 acl_check_rcpt:
5630 .endd
5631 This line, consisting of a name terminated by a colon, marks the start of the
5632 ACL, and names it.
5633 .code
5634 accept  hosts = :
5635 .endd
5636 This ACL statement accepts the recipient if the sending host matches the list.
5637 But what does that strange list mean? It doesn't actually contain any host
5638 names or IP addresses. The presence of the colon puts an empty item in the
5639 list; Exim matches this only if the incoming message did not come from a remote
5640 host, because in that case, the remote hostname is empty. The colon is
5641 important. Without it, the list itself is empty, and can never match anything.
5642
5643 What this statement is doing is to accept unconditionally all recipients in
5644 messages that are submitted by SMTP from local processes using the standard
5645 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5646 manner.
5647 .code
5648 deny    message       = Restricted characters in address
5649         domains       = +local_domains
5650         local_parts   = ^[.] : ^.*[@%!/|]
5651
5652 deny    message       = Restricted characters in address
5653         domains       = !+local_domains
5654         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5655 .endd
5656 These statements are concerned with local parts that contain any of the
5657 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5658 Although these characters are entirely legal in local parts (in the case of
5659 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5660 in Internet mail addresses.
5661
5662 The first three have in the past been associated with explicitly routed
5663 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5664 option). Addresses containing these characters are regularly tried by spammers
5665 in an attempt to bypass relaying restrictions, and also by open relay testing
5666 programs. Unless you really need them it is safest to reject these characters
5667 at this early stage. This configuration is heavy-handed in rejecting these
5668 characters for all messages it accepts from remote hosts. This is a deliberate
5669 policy of being as safe as possible.
5670
5671 The first rule above is stricter, and is applied to messages that are addressed
5672 to one of the local domains handled by this host. This is implemented by the
5673 first condition, which restricts it to domains that are listed in the
5674 &'local_domains'& domain list. The &"+"& character is used to indicate a
5675 reference to a named list. In this configuration, there is just one domain in
5676 &'local_domains'&, but in general there may be many.
5677
5678 The second condition on the first statement uses two regular expressions to
5679 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5680 or &"|"&. If you have local accounts that include these characters, you will
5681 have to modify this rule.
5682
5683 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5684 allows them because they have been encountered in practice. (Consider the
5685 common convention of local parts constructed as
5686 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5687 the author of Exim, who has no second initial.) However, a local part starting
5688 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5689 file name (for example, for a mailing list). This is also true for local parts
5690 that contain slashes. A pipe symbol can also be troublesome if the local part
5691 is incorporated unthinkingly into a shell command line.
5692
5693 The second rule above applies to all other domains, and is less strict. This
5694 allows your own users to send outgoing messages to sites that use slashes
5695 and vertical bars in their local parts. It blocks local parts that begin
5696 with a dot, slash, or vertical bar, but allows these characters within the
5697 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5698 and &"!"& is blocked, as before. The motivation here is to prevent your users
5699 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5700 .code
5701 accept  local_parts   = postmaster
5702         domains       = +local_domains
5703 .endd
5704 This statement, which has two conditions, accepts an incoming address if the
5705 local part is &'postmaster'& and the domain is one of those listed in the
5706 &'local_domains'& domain list. The &"+"& character is used to indicate a
5707 reference to a named list. In this configuration, there is just one domain in
5708 &'local_domains'&, but in general there may be many.
5709
5710 The presence of this statement means that mail to postmaster is never blocked
5711 by any of the subsequent tests. This can be helpful while sorting out problems
5712 in cases where the subsequent tests are incorrectly denying access.
5713 .code
5714 require verify        = sender
5715 .endd
5716 This statement requires the sender address to be verified before any subsequent
5717 ACL statement can be used. If verification fails, the incoming recipient
5718 address is refused. Verification consists of trying to route the address, to
5719 see if a bounce message could be delivered to it. In the case of remote
5720 addresses, basic verification checks only the domain, but &'callouts'& can be
5721 used for more verification if required. Section &<<SECTaddressverification>>&
5722 discusses the details of address verification.
5723 .code
5724 accept  hosts         = +relay_from_hosts
5725         control       = submission
5726 .endd
5727 This statement accepts the address if the message is coming from one of the
5728 hosts that are defined as being allowed to relay through this host. Recipient
5729 verification is omitted here, because in many cases the clients are dumb MUAs
5730 that do not cope well with SMTP error responses. For the same reason, the
5731 second line specifies &"submission mode"& for messages that are accepted. This
5732 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5733 messages that are deficient in some way, for example, because they lack a
5734 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5735 probably add recipient verification here, and disable submission mode.
5736 .code
5737 accept  authenticated = *
5738         control       = submission
5739 .endd
5740 This statement accepts the address if the client host has authenticated itself.
5741 Submission mode is again specified, on the grounds that such messages are most
5742 likely to come from MUAs. The default configuration does not define any
5743 authenticators, though it does include some nearly complete commented-out
5744 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5745 fact authenticate until you complete the authenticator definitions.
5746 .code
5747 require message = relay not permitted
5748         domains = +local_domains : +relay_to_domains
5749 .endd
5750 This statement rejects the address if its domain is neither a local domain nor
5751 one of the domains for which this host is a relay.
5752 .code
5753 require verify = recipient
5754 .endd
5755 This statement requires the recipient address to be verified; if verification
5756 fails, the address is rejected.
5757 .code
5758 # deny    message     = rejected because $sender_host_address \
5759 #                       is in a black list at $dnslist_domain\n\
5760 #                       $dnslist_text
5761 #         dnslists    = black.list.example
5762 #
5763 # warn    dnslists    = black.list.example
5764 #         add_header  = X-Warning: $sender_host_address is in \
5765 #                       a black list at $dnslist_domain
5766 #         log_message = found in $dnslist_domain
5767 .endd
5768 These commented-out lines are examples of how you could configure Exim to check
5769 sending hosts against a DNS black list. The first statement rejects messages
5770 from blacklisted hosts, whereas the second just inserts a warning header
5771 line.
5772 .code
5773 # require verify = csa
5774 .endd
5775 This commented-out line is an example of how you could turn on client SMTP
5776 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5777 records.
5778 .code
5779 accept
5780 .endd
5781 The final statement in the first ACL unconditionally accepts any recipient
5782 address that has successfully passed all the previous tests.
5783 .code
5784 acl_check_data:
5785 .endd
5786 This line marks the start of the second ACL, and names it. Most of the contents
5787 of this ACL are commented out:
5788 .code
5789 # deny    malware   = *
5790 #         message   = This message contains a virus \
5791 #                     ($malware_name).
5792 .endd
5793 These lines are examples of how to arrange for messages to be scanned for
5794 viruses when Exim has been compiled with the content-scanning extension, and a
5795 suitable virus scanner is installed. If the message is found to contain a
5796 virus, it is rejected with the given custom error message.
5797 .code
5798 # warn    spam      = nobody
5799 #         message   = X-Spam_score: $spam_score\n\
5800 #                     X-Spam_score_int: $spam_score_int\n\
5801 #                     X-Spam_bar: $spam_bar\n\
5802 #                     X-Spam_report: $spam_report
5803 .endd
5804 These lines are an example of how to arrange for messages to be scanned by
5805 SpamAssassin when Exim has been compiled with the content-scanning extension,
5806 and SpamAssassin has been installed. The SpamAssassin check is run with
5807 &`nobody`& as its user parameter, and the results are added to the message as a
5808 series of extra header line. In this case, the message is not rejected,
5809 whatever the spam score.
5810 .code
5811 accept
5812 .endd
5813 This final line in the DATA ACL accepts the message unconditionally.
5814
5815
5816 .section "Router configuration" "SECID55"
5817 .cindex "default" "routers"
5818 .cindex "routers" "default"
5819 The router configuration comes next in the default configuration, introduced
5820 by the line
5821 .code
5822 begin routers
5823 .endd
5824 Routers are the modules in Exim that make decisions about where to send
5825 messages. An address is passed to each router in turn, until it is either
5826 accepted, or failed. This means that the order in which you define the routers
5827 matters. Each router is fully described in its own chapter later in this
5828 manual. Here we give only brief overviews.
5829 .code
5830 # domain_literal:
5831 #   driver = ipliteral
5832 #   domains = !+local_domains
5833 #   transport = remote_smtp
5834 .endd
5835 .cindex "domain literal" "default router"
5836 This router is commented out because the majority of sites do not want to
5837 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5838 you uncomment this router, you also need to uncomment the setting of
5839 &%allow_domain_literals%& in the main part of the configuration.
5840 .code
5841 dnslookup:
5842   driver = dnslookup
5843   domains = ! +local_domains
5844   transport = remote_smtp
5845   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5846   no_more
5847 .endd
5848 The first uncommented router handles addresses that do not involve any local
5849 domains. This is specified by the line
5850 .code
5851 domains = ! +local_domains
5852 .endd
5853 The &%domains%& option lists the domains to which this router applies, but the
5854 exclamation mark is a negation sign, so the router is used only for domains
5855 that are not in the domain list called &'local_domains'& (which was defined at
5856 the start of the configuration). The plus sign before &'local_domains'&
5857 indicates that it is referring to a named list. Addresses in other domains are
5858 passed on to the following routers.
5859
5860 The name of the router driver is &(dnslookup)&,
5861 and is specified by the &%driver%& option. Do not be confused by the fact that
5862 the name of this router instance is the same as the name of the driver. The
5863 instance name is arbitrary, but the name set in the &%driver%& option must be
5864 one of the driver modules that is in the Exim binary.
5865
5866 The &(dnslookup)& router routes addresses by looking up their domains in the
5867 DNS in order to obtain a list of hosts to which the address is routed. If the
5868 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5869 specified by the &%transport%& option. If the router does not find the domain
5870 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5871 the address fails and is bounced.
5872
5873 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5874 be entirely ignored. This option is present because a number of cases have been
5875 encountered where MX records in the DNS point to host names
5876 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5877 Completely ignoring these IP addresses causes Exim to fail to route the
5878 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5879 continue to try to deliver the message periodically until the address timed
5880 out.
5881 .code
5882 system_aliases:
5883   driver = redirect
5884   allow_fail
5885   allow_defer
5886   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5887 # user = exim
5888   file_transport = address_file
5889   pipe_transport = address_pipe
5890 .endd
5891 Control reaches this and subsequent routers only for addresses in the local
5892 domains. This router checks to see whether the local part is defined as an
5893 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5894 data that it looks up from that file. If no data is found for the local part,
5895 the value of the &%data%& option is empty, causing the address to be passed to
5896 the next router.
5897
5898 &_/etc/aliases_& is a conventional name for the system aliases file that is
5899 often used. That is why it is referenced by from the default configuration
5900 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5901 &_Local/Makefile_& before building Exim.
5902 .code
5903 userforward:
5904   driver = redirect
5905   check_local_user
5906 # local_part_suffix = +* : -*
5907 # local_part_suffix_optional
5908   file = $home/.forward
5909 # allow_filter
5910   no_verify
5911   no_expn
5912   check_ancestor
5913   file_transport = address_file
5914   pipe_transport = address_pipe
5915   reply_transport = address_reply
5916 .endd
5917 This is the most complicated router in the default configuration. It is another
5918 redirection router, but this time it is looking for forwarding data set up by
5919 individual users. The &%check_local_user%& setting specifies a check that the
5920 local part of the address is the login name of a local user. If it is not, the
5921 router is skipped. The two commented options that follow &%check_local_user%&,
5922 namely:
5923 .code
5924 # local_part_suffix = +* : -*
5925 # local_part_suffix_optional
5926 .endd
5927 .vindex "&$local_part_suffix$&"
5928 show how you can specify the recognition of local part suffixes. If the first
5929 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5930 by any sequence of characters, is removed from the local part and placed in the
5931 variable &$local_part_suffix$&. The second suffix option specifies that the
5932 presence of a suffix in the local part is optional. When a suffix is present,
5933 the check for a local login uses the local part with the suffix removed.
5934
5935 When a local user account is found, the file called &_.forward_& in the user's
5936 home directory is consulted. If it does not exist, or is empty, the router
5937 declines. Otherwise, the contents of &_.forward_& are interpreted as
5938 redirection data (see chapter &<<CHAPredirect>>& for more details).
5939
5940 .cindex "Sieve filter" "enabling in default router"
5941 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5942 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5943 is commented out by default), the contents of the file are interpreted as a set
5944 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5945 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5946 separate document entitled &'Exim's interfaces to mail filtering'&.
5947
5948 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5949 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5950 There are two reasons for doing this:
5951
5952 .olist
5953 Whether or not a local user has a &_.forward_& file is not really relevant when
5954 checking an address for validity; it makes sense not to waste resources doing
5955 unnecessary work.
5956 .next
5957 More importantly, when Exim is verifying addresses or handling an EXPN
5958 command during an SMTP session, it is running as the Exim user, not as root.
5959 The group is the Exim group, and no additional groups are set up.
5960 It may therefore not be possible for Exim to read users' &_.forward_& files at
5961 this time.
5962 .endlist
5963
5964 The setting of &%check_ancestor%& prevents the router from generating a new
5965 address that is the same as any previous address that was redirected. (This
5966 works round a problem concerning a bad interaction between aliasing and
5967 forwarding &-- see section &<<SECTredlocmai>>&).
5968
5969 The final three option settings specify the transports that are to be used when
5970 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5971 auto-reply, respectively. For example, if a &_.forward_& file contains
5972 .code
5973 a.nother@elsewhere.example, /home/spqr/archive
5974 .endd
5975 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5976 transport.
5977 .code
5978 localuser:
5979   driver = accept
5980   check_local_user
5981 # local_part_suffix = +* : -*
5982 # local_part_suffix_optional
5983   transport = local_delivery
5984 .endd
5985 The final router sets up delivery into local mailboxes, provided that the local
5986 part is the name of a local login, by accepting the address and assigning it to
5987 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5988 routers, so the address is bounced. The commented suffix settings fulfil the
5989 same purpose as they do for the &(userforward)& router.
5990
5991
5992 .section "Transport configuration" "SECID56"
5993 .cindex "default" "transports"
5994 .cindex "transports" "default"
5995 Transports define mechanisms for actually delivering messages. They operate
5996 only when referenced from routers, so the order in which they are defined does
5997 not matter. The transports section of the configuration starts with
5998 .code
5999 begin transports
6000 .endd
6001 One remote transport and four local transports are defined.
6002 .code
6003 remote_smtp:
6004   driver = smtp
6005 .endd
6006 This transport is used for delivering messages over SMTP connections. All its
6007 options are defaulted. The list of remote hosts comes from the router.
6008 .code
6009 local_delivery:
6010   driver = appendfile
6011   file = /var/mail/$local_part
6012   delivery_date_add
6013   envelope_to_add
6014   return_path_add
6015 # group = mail
6016 # mode = 0660
6017 .endd
6018 This &(appendfile)& transport is used for local delivery to user mailboxes in
6019 traditional BSD mailbox format. By default it runs under the uid and gid of the
6020 local user, which requires the sticky bit to be set on the &_/var/mail_&
6021 directory. Some systems use the alternative approach of running mail deliveries
6022 under a particular group instead of using the sticky bit. The commented options
6023 show how this can be done.
6024
6025 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6026 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6027 similarly-named options above.
6028 .code
6029 address_pipe:
6030   driver = pipe
6031   return_output
6032 .endd
6033 This transport is used for handling deliveries to pipes that are generated by
6034 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6035 option specifies that any output generated by the pipe is to be returned to the
6036 sender.
6037 .code
6038 address_file:
6039   driver = appendfile
6040   delivery_date_add
6041   envelope_to_add
6042   return_path_add
6043 .endd
6044 This transport is used for handling deliveries to files that are generated by
6045 redirection. The name of the file is not specified in this instance of
6046 &(appendfile)&, because it comes from the &(redirect)& router.
6047 .code
6048 address_reply:
6049   driver = autoreply
6050 .endd
6051 This transport is used for handling automatic replies generated by users'
6052 filter files.
6053
6054
6055
6056 .section "Default retry rule" "SECID57"
6057 .cindex "retry" "default rule"
6058 .cindex "default" "retry rule"
6059 The retry section of the configuration file contains rules which affect the way
6060 Exim retries deliveries that cannot be completed at the first attempt. It is
6061 introduced by the line
6062 .code
6063 begin retry
6064 .endd
6065 In the default configuration, there is just one rule, which applies to all
6066 errors:
6067 .code
6068 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6069 .endd
6070 This causes any temporarily failing address to be retried every 15 minutes for
6071 2 hours, then at intervals starting at one hour and increasing by a factor of
6072 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6073 is not delivered after 4 days of temporary failure, it is bounced.
6074
6075 If the retry section is removed from the configuration, or is empty (that is,
6076 if no retry rules are defined), Exim will not retry deliveries. This turns
6077 temporary errors into permanent errors.
6078
6079
6080 .section "Rewriting configuration" "SECID58"
6081 The rewriting section of the configuration, introduced by
6082 .code
6083 begin rewrite
6084 .endd
6085 contains rules for rewriting addresses in messages as they arrive. There are no
6086 rewriting rules in the default configuration file.
6087
6088
6089
6090 .section "Authenticators configuration" "SECTdefconfauth"
6091 .cindex "AUTH" "configuration"
6092 The authenticators section of the configuration, introduced by
6093 .code
6094 begin authenticators
6095 .endd
6096 defines mechanisms for the use of the SMTP AUTH command. The default
6097 configuration file contains two commented-out example authenticators
6098 which support plaintext username/password authentication using the
6099 standard PLAIN mechanism and the traditional but non-standard LOGIN
6100 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6101 to support most MUA software.
6102
6103 The example PLAIN authenticator looks like this:
6104 .code
6105 #PLAIN:
6106 #  driver                  = plaintext
6107 #  server_set_id           = $auth2
6108 #  server_prompts          = :
6109 #  server_condition        = Authentication is not yet configured
6110 #  server_advertise_condition = ${if def:tls_in_cipher }
6111 .endd
6112 And the example LOGIN authenticator looks like this:
6113 .code
6114 #LOGIN:
6115 #  driver                  = plaintext
6116 #  server_set_id           = $auth1
6117 #  server_prompts          = <| Username: | Password:
6118 #  server_condition        = Authentication is not yet configured
6119 #  server_advertise_condition = ${if def:tls_in_cipher }
6120 .endd
6121
6122 The &%server_set_id%& option makes Exim remember the authenticated username
6123 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6124 &%server_prompts%& option configures the &(plaintext)& authenticator so
6125 that it implements the details of the specific authentication mechanism,
6126 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6127 when Exim offers authentication to clients; in the examples, this is only
6128 when TLS or SSL has been started, so to enable the authenticators you also
6129 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6130
6131 The &%server_condition%& setting defines how to verify that the username and
6132 password are correct. In the examples it just produces an error message.
6133 To make the authenticators work, you can use a string expansion
6134 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6135
6136 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6137 usercode and password are in different positions.
6138 Chapter &<<CHAPplaintext>>& covers both.
6139
6140 .ecindex IIDconfiwal
6141
6142
6143
6144 . ////////////////////////////////////////////////////////////////////////////
6145 . ////////////////////////////////////////////////////////////////////////////
6146
6147 .chapter "Regular expressions" "CHAPregexp"
6148
6149 .cindex "regular expressions" "library"
6150 .cindex "PCRE"
6151 Exim supports the use of regular expressions in many of its options. It
6152 uses the PCRE regular expression library; this provides regular expression
6153 matching that is compatible with Perl 5. The syntax and semantics of
6154 regular expressions is discussed in many Perl reference books, and also in
6155 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6156 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6157
6158 The documentation for the syntax and semantics of the regular expressions that
6159 are supported by PCRE is included in the PCRE distribution, and no further
6160 description is included here. The PCRE functions are called from Exim using
6161 the default option settings (that is, with no PCRE options set), except that
6162 the PCRE_CASELESS option is set when the matching is required to be
6163 case-insensitive.
6164
6165 In most cases, when a regular expression is required in an Exim configuration,
6166 it has to start with a circumflex, in order to distinguish it from plain text
6167 or an &"ends with"& wildcard. In this example of a configuration setting, the
6168 second item in the colon-separated list is a regular expression.
6169 .code
6170 domains = a.b.c : ^\\d{3} : *.y.z : ...
6171 .endd
6172 The doubling of the backslash is required because of string expansion that
6173 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6174 of this issue, and a way of avoiding the need for doubling backslashes. The
6175 regular expression that is eventually used in this example contains just one
6176 backslash. The circumflex is included in the regular expression, and has the
6177 normal effect of &"anchoring"& it to the start of the string that is being
6178 matched.
6179
6180 There are, however, two cases where a circumflex is not required for the
6181 recognition of a regular expression: these are the &%match%& condition in a
6182 string expansion, and the &%matches%& condition in an Exim filter file. In
6183 these cases, the relevant string is always treated as a regular expression; if
6184 it does not start with a circumflex, the expression is not anchored, and can
6185 match anywhere in the subject string.
6186
6187 In all cases, if you want a regular expression to match at the end of a string,
6188 you must code the $ metacharacter to indicate this. For example:
6189 .code
6190 domains = ^\\d{3}\\.example
6191 .endd
6192 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6193 You need to use:
6194 .code
6195 domains = ^\\d{3}\\.example\$
6196 .endd
6197 if you want &'example'& to be the top-level domain. The backslash before the
6198 $ is needed because string expansion also interprets dollar characters.
6199
6200
6201
6202 . ////////////////////////////////////////////////////////////////////////////
6203 . ////////////////////////////////////////////////////////////////////////////
6204
6205 .chapter "File and database lookups" "CHAPfdlookup"
6206 .scindex IIDfidalo1 "file" "lookups"
6207 .scindex IIDfidalo2 "database" "lookups"
6208 .cindex "lookup" "description of"
6209 Exim can be configured to look up data in files or databases as it processes
6210 messages. Two different kinds of syntax are used:
6211
6212 .olist
6213 A string that is to be expanded may contain explicit lookup requests. These
6214 cause parts of the string to be replaced by data that is obtained from the
6215 lookup. Lookups of this type are conditional expansion items. Different results
6216 can be defined for the cases of lookup success and failure. See chapter
6217 &<<CHAPexpand>>&, where string expansions are described in detail.
6218 .next
6219 Lists of domains, hosts, and email addresses can contain lookup requests as a
6220 way of avoiding excessively long linear lists. In this case, the data that is
6221 returned by the lookup is often (but not always) discarded; whether the lookup
6222 succeeds or fails is what really counts. These kinds of list are described in
6223 chapter &<<CHAPdomhosaddlists>>&.
6224 .endlist
6225
6226 String expansions, lists, and lookups interact with each other in such a way
6227 that there is no order in which to describe any one of them that does not
6228 involve references to the others. Each of these three chapters makes more sense
6229 if you have read the other two first. If you are reading this for the first
6230 time, be aware that some of it will make a lot more sense after you have read
6231 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6232
6233 .section "Examples of different lookup syntax" "SECID60"
6234 It is easy to confuse the two different kinds of lookup, especially as the
6235 lists that may contain the second kind are always expanded before being
6236 processed as lists. Therefore, they may also contain lookups of the first kind.
6237 Be careful to distinguish between the following two examples:
6238 .code
6239 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6240 domains = lsearch;/some/file
6241 .endd
6242 The first uses a string expansion, the result of which must be a domain list.
6243 No strings have been specified for a successful or a failing lookup; the
6244 defaults in this case are the looked-up data and an empty string, respectively.
6245 The expansion takes place before the string is processed as a list, and the
6246 file that is searched could contain lines like this:
6247 .code
6248 192.168.3.4: domain1:domain2:...
6249 192.168.1.9: domain3:domain4:...
6250 .endd
6251 When the lookup succeeds, the result of the expansion is a list of domains (and
6252 possibly other types of item that are allowed in domain lists).
6253
6254 In the second example, the lookup is a single item in a domain list. It causes
6255 Exim to use a lookup to see if the domain that is being processed can be found
6256 in the file. The file could contains lines like this:
6257 .code
6258 domain1:
6259 domain2:
6260 .endd
6261 Any data that follows the keys is not relevant when checking that the domain
6262 matches the list item.
6263
6264 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6265 Consider a file containing lines like this:
6266 .code
6267 192.168.5.6: lsearch;/another/file
6268 .endd
6269 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6270 first &%domains%& setting above generates the second setting, which therefore
6271 causes a second lookup to occur.
6272
6273 The rest of this chapter describes the different lookup types that are
6274 available. Any of them can be used in any part of the configuration where a
6275 lookup is permitted.
6276
6277
6278 .section "Lookup types" "SECID61"
6279 .cindex "lookup" "types of"
6280 .cindex "single-key lookup" "definition of"
6281 Two different types of data lookup are implemented:
6282
6283 .ilist
6284 The &'single-key'& type requires the specification of a file in which to look,
6285 and a single key to search for. The key must be a non-empty string for the
6286 lookup to succeed. The lookup type determines how the file is searched.
6287 .next
6288 .cindex "query-style lookup" "definition of"
6289 The &'query-style'& type accepts a generalized database query. No particular
6290 key value is assumed by Exim for query-style lookups. You can use whichever
6291 Exim variables you need to construct the database query.
6292 .endlist
6293
6294 The code for each lookup type is in a separate source file that is included in
6295 the binary of Exim only if the corresponding compile-time option is set. The
6296 default settings in &_src/EDITME_& are:
6297 .code
6298 LOOKUP_DBM=yes
6299 LOOKUP_LSEARCH=yes
6300 .endd
6301 which means that only linear searching and DBM lookups are included by default.
6302 For some types of lookup (e.g. SQL databases), you need to install appropriate
6303 libraries and header files before building Exim.
6304
6305
6306
6307
6308 .section "Single-key lookup types" "SECTsinglekeylookups"
6309 .cindex "lookup" "single-key types"
6310 .cindex "single-key lookup" "list of types"
6311 The following single-key lookup types are implemented:
6312
6313 .ilist
6314 .cindex "cdb" "description of"
6315 .cindex "lookup" "cdb"
6316 .cindex "binary zero" "in lookup key"
6317 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6318 string without a terminating binary zero. The cdb format is designed for
6319 indexed files that are read frequently and never updated, except by total
6320 re-creation. As such, it is particularly suitable for large files containing
6321 aliases or other indexed data referenced by an MTA. Information about cdb can
6322 be found in several places:
6323 .display
6324 &url(http://www.pobox.com/~djb/cdb.html)
6325 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6326 &url(http://packages.debian.org/stable/utils/freecdb.html)
6327 .endd
6328 A cdb distribution is not needed in order to build Exim with cdb support,
6329 because the code for reading cdb files is included directly in Exim itself.
6330 However, no means of building or testing cdb files is provided with Exim, so
6331 you need to obtain a cdb distribution in order to do this.
6332 .next
6333 .cindex "DBM" "lookup type"
6334 .cindex "lookup" "dbm"
6335 .cindex "binary zero" "in lookup key"
6336 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6337 DBM file by looking up the record with the given key. A terminating binary
6338 zero is included in the key that is passed to the DBM library. See section
6339 &<<SECTdb>>& for a discussion of DBM libraries.
6340
6341 .cindex "Berkeley DB library" "file format"
6342 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6343 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6344 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6345 the DB_UNKNOWN option. This enables it to handle any of the types of database
6346 that the library supports, and can be useful for accessing DBM files created by
6347 other applications. (For earlier DB versions, DB_HASH is always used.)
6348 .next
6349 .cindex "lookup" "dbmjz"
6350 .cindex "lookup" "dbm &-- embedded NULs"
6351 .cindex "sasldb2"
6352 .cindex "dbmjz lookup type"
6353 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6354 interpreted as an Exim list; the elements of the list are joined together with
6355 ASCII NUL characters to form the lookup key.  An example usage would be to
6356 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6357 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6358 &(cram_md5)& authenticator.
6359 .next
6360 .cindex "lookup" "dbmnz"
6361 .cindex "lookup" "dbm &-- terminating zero"
6362 .cindex "binary zero" "in lookup key"
6363 .cindex "Courier"
6364 .cindex "&_/etc/userdbshadow.dat_&"
6365 .cindex "dbmnz lookup type"
6366 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6367 is not included in the key that is passed to the DBM library. You may need this
6368 if you want to look up data in files that are created by or shared with some
6369 other application that does not use terminating zeros. For example, you need to
6370 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6371 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6372 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6373 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6374 .next
6375 .cindex "lookup" "dsearch"
6376 .cindex "dsearch lookup type"
6377 &(dsearch)&: The given file must be a directory; this is searched for an entry
6378 whose name is the key by calling the &[lstat()]& function. The key may not
6379 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6380 the lookup is the name of the entry, which may be a file, directory,
6381 symbolic link, or any other kind of directory entry. An example of how this
6382 lookup can be used to support virtual domains is given in section
6383 &<<SECTvirtualdomains>>&.
6384 .next
6385 .cindex "lookup" "iplsearch"
6386 .cindex "iplsearch lookup type"
6387 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6388 terminated by a colon or white space or the end of the line. The keys in the
6389 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6390 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6391 being interpreted as a key terminator. For example:
6392 .code
6393 1.2.3.4:           data for 1.2.3.4
6394 192.168.0.0/16:    data for 192.168.0.0/16
6395 "abcd::cdab":      data for abcd::cdab
6396 "abcd:abcd::/32"   data for abcd:abcd::/32
6397 .endd
6398 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6399 file is searched linearly, using the CIDR masks where present, until a matching
6400 key is found. The first key that matches is used; there is no attempt to find a
6401 &"best"& match. Apart from the way the keys are matched, the processing for
6402 &(iplsearch)& is the same as for &(lsearch)&.
6403
6404 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6405 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6406 lookup types support only literal keys.
6407
6408 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6409 the implicit key is the host's IP address rather than its name (see section
6410 &<<SECThoslispatsikey>>&).
6411 .next
6412 .cindex "linear search"
6413 .cindex "lookup" "lsearch"
6414 .cindex "lsearch lookup type"
6415 .cindex "case sensitivity" "in lsearch lookup"
6416 &(lsearch)&: The given file is a text file that is searched linearly for a
6417 line beginning with the search key, terminated by a colon or white space or the
6418 end of the line. The search is case-insensitive; that is, upper and lower case
6419 letters are treated as the same. The first occurrence of the key that is found
6420 in the file is used.
6421
6422 White space between the key and the colon is permitted. The remainder of the
6423 line, with leading and trailing white space removed, is the data. This can be
6424 continued onto subsequent lines by starting them with any amount of white
6425 space, but only a single space character is included in the data at such a
6426 junction. If the data begins with a colon, the key must be terminated by a
6427 colon, for example:
6428 .code
6429 baduser:  :fail:
6430 .endd
6431 Empty lines and lines beginning with # are ignored, even if they occur in the
6432 middle of an item. This is the traditional textual format of alias files. Note
6433 that the keys in an &(lsearch)& file are literal strings. There is no
6434 wildcarding of any kind.
6435
6436 .cindex "lookup" "lsearch &-- colons in keys"
6437 .cindex "white space" "in lsearch key"
6438 In most &(lsearch)& files, keys are not required to contain colons or #
6439 characters, or white space. However, if you need this feature, it is available.
6440 If a key begins with a doublequote character, it is terminated only by a
6441 matching quote (or end of line), and the normal escaping rules apply to its
6442 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6443 quoted keys (exactly as for unquoted keys). There is no special handling of
6444 quotes for the data part of an &(lsearch)& line.
6445
6446 .next
6447 .cindex "NIS lookup type"
6448 .cindex "lookup" "NIS"
6449 .cindex "binary zero" "in lookup key"
6450 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6451 the given key, without a terminating binary zero. There is a variant called
6452 &(nis0)& which does include the terminating binary zero in the key. This is
6453 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6454 aliases; the full map names must be used.
6455
6456 .next
6457 .cindex "wildlsearch lookup type"
6458 .cindex "lookup" "wildlsearch"
6459 .cindex "nwildlsearch lookup type"
6460 .cindex "lookup" "nwildlsearch"
6461 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6462 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6463 the file may be wildcarded. The difference between these two lookup types is
6464 that for &(wildlsearch)&, each key in the file is string-expanded before being
6465 used, whereas for &(nwildlsearch)&, no expansion takes place.
6466
6467 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6468 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6469 file that are regular expressions can be made case-sensitive by the use of
6470 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6471
6472 . ==== As this is a nested list, any displays it contains must be indented
6473 . ==== as otherwise they are too far to the left.
6474
6475 .olist
6476 The string may begin with an asterisk to mean &"ends with"&. For example:
6477 .code
6478     *.a.b.c       data for anything.a.b.c
6479     *fish         data for anythingfish
6480 .endd
6481 .next
6482 The string may begin with a circumflex to indicate a regular expression. For
6483 example, for &(wildlsearch)&:
6484 .code
6485     ^\N\d+\.a\.b\N    data for <digits>.a.b
6486 .endd
6487 Note the use of &`\N`& to disable expansion of the contents of the regular
6488 expression. If you are using &(nwildlsearch)&, where the keys are not
6489 string-expanded, the equivalent entry is:
6490 .code
6491     ^\d+\.a\.b        data for <digits>.a.b
6492 .endd
6493 The case-insensitive flag is set at the start of compiling the regular
6494 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6495 For example, to make the entire pattern case-sensitive:
6496 .code
6497     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6498 .endd
6499
6500 If the regular expression contains white space or colon characters, you must
6501 either quote it (see &(lsearch)& above), or represent these characters in other
6502 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6503 colon. This may be easier than quoting, because if you quote, you have to
6504 escape all the backslashes inside the quotes.
6505
6506 &*Note*&: It is not possible to capture substrings in a regular expression
6507 match for later use, because the results of all lookups are cached. If a lookup
6508 is repeated, the result is taken from the cache, and no actual pattern matching
6509 takes place. The values of all the numeric variables are unset after a
6510 &((n)wildlsearch)& match.
6511
6512 .next
6513 Although I cannot see it being of much use, the general matching function that
6514 is used to implement &((n)wildlsearch)& means that the string may begin with a
6515 lookup name terminated by a semicolon, and followed by lookup data. For
6516 example:
6517 .code
6518     cdb;/some/file  data for keys that match the file
6519 .endd
6520 The data that is obtained from the nested lookup is discarded.
6521 .endlist olist
6522
6523 Keys that do not match any of these patterns are interpreted literally. The
6524 continuation rules for the data are the same as for &(lsearch)&, and keys may
6525 be followed by optional colons.
6526
6527 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6528 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6529 lookup types support only literal keys.
6530 .endlist ilist
6531
6532
6533 .section "Query-style lookup types" "SECID62"
6534 .cindex "lookup" "query-style types"
6535 .cindex "query-style lookup" "list of types"
6536 The supported query-style lookup types are listed below. Further details about
6537 many of them are given in later sections.
6538
6539 .ilist
6540 .cindex "DNS" "as a lookup type"
6541 .cindex "lookup" "DNS"
6542 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6543 are given in the supplied query. The resulting data is the contents of the
6544 records. See section &<<SECTdnsdb>>&.
6545 .next
6546 .cindex "InterBase lookup type"
6547 .cindex "lookup" "InterBase"
6548 &(ibase)&: This does a lookup in an InterBase database.
6549 .next
6550 .cindex "LDAP" "lookup type"
6551 .cindex "lookup" "LDAP"
6552 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6553 returns attributes from a single entry. There is a variant called &(ldapm)&
6554 that permits values from multiple entries to be returned. A third variant
6555 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6556 any attribute values. See section &<<SECTldap>>&.
6557 .next
6558 .cindex "MySQL" "lookup type"
6559 .cindex "lookup" "MySQL"
6560 &(mysql)&: The format of the query is an SQL statement that is passed to a
6561 MySQL database. See section &<<SECTsql>>&.
6562 .next
6563 .cindex "NIS+ lookup type"
6564 .cindex "lookup" "NIS+"
6565 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6566 the field to be returned. See section &<<SECTnisplus>>&.
6567 .next
6568 .cindex "Oracle" "lookup type"
6569 .cindex "lookup" "Oracle"
6570 &(oracle)&: The format of the query is an SQL statement that is passed to an
6571 Oracle database. See section &<<SECTsql>>&.
6572 .next
6573 .cindex "lookup" "passwd"
6574 .cindex "passwd lookup type"
6575 .cindex "&_/etc/passwd_&"
6576 &(passwd)& is a query-style lookup with queries that are just user names. The
6577 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6578 success, the result string is the same as you would get from an &(lsearch)&
6579 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6580 password value. For example:
6581 .code
6582 *:42:42:King Rat:/home/kr:/bin/bash
6583 .endd
6584 .next
6585 .cindex "PostgreSQL lookup type"
6586 .cindex "lookup" "PostgreSQL"
6587 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6588 PostgreSQL database. See section &<<SECTsql>>&.
6589
6590 .next
6591 .cindex "sqlite lookup type"
6592 .cindex "lookup" "sqlite"
6593 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6594 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6595
6596 .next
6597 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6598 not likely to be useful in normal operation.
6599 .next
6600 .cindex "whoson lookup type"
6601 .cindex "lookup" "whoson"
6602 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6603 allows a server to check whether a particular (dynamically allocated) IP
6604 address is currently allocated to a known (trusted) user and, optionally, to
6605 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6606 at one time for &"POP before SMTP"& authentication, but that approach has been
6607 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6608 &"POP before SMTP"& checking using ACL statements such as
6609 .code
6610 require condition = \
6611   ${lookup whoson {$sender_host_address}{yes}{no}}
6612 .endd
6613 The query consists of a single IP address. The value returned is the name of
6614 the authenticated user, which is stored in the variable &$value$&. However, in
6615 this example, the data in &$value$& is not used; the result of the lookup is
6616 one of the fixed strings &"yes"& or &"no"&.
6617 .endlist
6618
6619
6620
6621 .section "Temporary errors in lookups" "SECID63"
6622 .cindex "lookup" "temporary error in"
6623 Lookup functions can return temporary error codes if the lookup cannot be
6624 completed. For example, an SQL or LDAP database might be unavailable. For this
6625 reason, it is not advisable to use a lookup that might do this for critical
6626 options such as a list of local domains.
6627
6628 When a lookup cannot be completed in a router or transport, delivery
6629 of the message (to the relevant address) is deferred, as for any other
6630 temporary error. In other circumstances Exim may assume the lookup has failed,
6631 or may give up altogether.
6632
6633
6634
6635 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6636 .cindex "wildcard lookups"
6637 .cindex "lookup" "default values"
6638 .cindex "lookup" "wildcard"
6639 .cindex "lookup" "* added to type"
6640 .cindex "default" "in single-key lookups"
6641 In this context, a &"default value"& is a value specified by the administrator
6642 that is to be used if a lookup fails.
6643
6644 &*Note:*& This section applies only to single-key lookups. For query-style
6645 lookups, the facilities of the query language must be used. An attempt to
6646 specify a default for a query-style lookup provokes an error.
6647
6648 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6649 and the initial lookup fails, the key &"*"& is looked up in the file to
6650 provide a default value. See also the section on partial matching below.
6651
6652 .cindex "*@ with single-key lookup"
6653 .cindex "lookup" "*@ added to type"
6654 .cindex "alias file" "per-domain default"
6655 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6656 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6657 character, a second lookup is done with everything before the last @ replaced
6658 by *. This makes it possible to provide per-domain defaults in alias files
6659 that include the domains in the keys. If the second lookup fails (or doesn't
6660 take place because there is no @ in the key), &"*"& is looked up.
6661 For example, a &(redirect)& router might contain:
6662 .code
6663 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6664 .endd
6665 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6666 looks up these keys, in this order:
6667 .code
6668 jane@eyre.example
6669 *@eyre.example
6670 *
6671 .endd
6672 The data is taken from whichever key it finds first. &*Note*&: In an
6673 &(lsearch)& file, this does not mean the first of these keys in the file. A
6674 complete scan is done for each key, and only if it is not found at all does
6675 Exim move on to try the next key.
6676
6677
6678
6679 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6680 .cindex "partial matching"
6681 .cindex "wildcard lookups"
6682 .cindex "lookup" "partial matching"
6683 .cindex "lookup" "wildcard"
6684 .cindex "asterisk" "in search type"
6685 The normal operation of a single-key lookup is to search the file for an exact
6686 match with the given key. However, in a number of situations where domains are
6687 being looked up, it is useful to be able to do partial matching. In this case,
6688 information in the file that has a key starting with &"*."& is matched by any
6689 domain that ends with the components that follow the full stop. For example, if
6690 a key in a DBM file is
6691 .code
6692 *.dates.fict.example
6693 .endd
6694 then when partial matching is enabled this is matched by (amongst others)
6695 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6696 by &'dates.fict.example'&, if that does not appear as a separate key in the
6697 file.
6698
6699 &*Note*&: Partial matching is not available for query-style lookups. It is
6700 also not available for any lookup items in address lists (see section
6701 &<<SECTaddresslist>>&).
6702
6703 Partial matching is implemented by doing a series of separate lookups using
6704 keys constructed by modifying the original subject key. This means that it can
6705 be used with any of the single-key lookup types, provided that
6706 partial matching keys
6707 beginning with a special prefix (default &"*."&) are included in the data file.
6708 Keys in the file that do not begin with the prefix are matched only by
6709 unmodified subject keys when partial matching is in use.
6710
6711 Partial matching is requested by adding the string &"partial-"& to the front of
6712 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6713 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6714 is added at the start of the subject key, and it is looked up again. If that
6715 fails, further lookups are tried with dot-separated components removed from the
6716 start of the subject key, one-by-one, and &"*."& added on the front of what
6717 remains.
6718
6719 A minimum number of two non-* components are required. This can be adjusted
6720 by including a number before the hyphen in the search type. For example,
6721 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6722 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6723 subject key is &'2250.dates.fict.example'& then the following keys are looked
6724 up when the minimum number of non-* components is two:
6725 .code
6726 2250.dates.fict.example
6727 *.2250.dates.fict.example
6728 *.dates.fict.example
6729 *.fict.example
6730 .endd
6731 As soon as one key in the sequence is successfully looked up, the lookup
6732 finishes.
6733
6734 .cindex "lookup" "partial matching &-- changing prefix"
6735 .cindex "prefix" "for partial matching"
6736 The use of &"*."& as the partial matching prefix is a default that can be
6737 changed. The motivation for this feature is to allow Exim to operate with file
6738 formats that are used by other MTAs. A different prefix can be supplied in
6739 parentheses instead of the hyphen after &"partial"&. For example:
6740 .code
6741 domains = partial(.)lsearch;/some/file
6742 .endd
6743 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6744 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6745 components is unchanged). The prefix may consist of any punctuation characters
6746 other than a closing parenthesis. It may be empty, for example:
6747 .code
6748 domains = partial1()cdb;/some/file
6749 .endd
6750 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6751 &`a.b.c`&, &`b.c`&, and &`c`&.
6752
6753 If &"partial0"& is specified, what happens at the end (when the lookup with
6754 just one non-wild component has failed, and the original key is shortened right
6755 down to the null string) depends on the prefix:
6756
6757 .ilist
6758 If the prefix has zero length, the whole lookup fails.
6759 .next
6760 If the prefix has length 1, a lookup for just the prefix is done. For
6761 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6762 .next
6763 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6764 remainder is looked up. With the default prefix, therefore, the final lookup is
6765 for &"*"& on its own.
6766 .next
6767 Otherwise, the whole prefix is looked up.
6768 .endlist
6769
6770
6771 If the search type ends in &"*"& or &"*@"& (see section
6772 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6773 this implies happens after all partial lookups have failed. If &"partial0"& is
6774 specified, adding &"*"& to the search type has no effect with the default
6775 prefix, because the &"*"& key is already included in the sequence of partial
6776 lookups. However, there might be a use for lookup types such as
6777 &"partial0(.)lsearch*"&.
6778
6779 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6780 in domain lists and the like. Partial matching works only in terms of
6781 dot-separated components; a key such as &`*fict.example`&
6782 in a database file is useless, because the asterisk in a partial matching
6783 subject key is always followed by a dot.
6784
6785
6786
6787
6788 .section "Lookup caching" "SECID64"
6789 .cindex "lookup" "caching"
6790 .cindex "caching" "lookup data"
6791 Exim caches all lookup results in order to avoid needless repetition of
6792 lookups. However, because (apart from the daemon) Exim operates as a collection
6793 of independent, short-lived processes, this caching applies only within a
6794 single Exim process. There is no inter-process lookup caching facility.
6795
6796 For single-key lookups, Exim keeps the relevant files open in case there is
6797 another lookup that needs them. In some types of configuration this can lead to
6798 many files being kept open for messages with many recipients. To avoid hitting
6799 the operating system limit on the number of simultaneously open files, Exim
6800 closes the least recently used file when it needs to open more files than its
6801 own internal limit, which can be changed via the &%lookup_open_max%& option.
6802
6803 The single-key lookup files are closed and the lookup caches are flushed at
6804 strategic points during delivery &-- for example, after all routing is
6805 complete.
6806
6807
6808
6809
6810 .section "Quoting lookup data" "SECID65"
6811 .cindex "lookup" "quoting"
6812 .cindex "quoting" "in lookups"
6813 When data from an incoming message is included in a query-style lookup, there
6814 is the possibility of special characters in the data messing up the syntax of
6815 the query. For example, a NIS+ query that contains
6816 .code
6817 [name=$local_part]
6818 .endd
6819 will be broken if the local part happens to contain a closing square bracket.
6820 For NIS+, data can be enclosed in double quotes like this:
6821 .code
6822 [name="$local_part"]
6823 .endd
6824 but this still leaves the problem of a double quote in the data. The rule for
6825 NIS+ is that double quotes must be doubled. Other lookup types have different
6826 rules, and to cope with the differing requirements, an expansion operator
6827 of the following form is provided:
6828 .code
6829 ${quote_<lookup-type>:<string>}
6830 .endd
6831 For example, the safest way to write the NIS+ query is
6832 .code
6833 [name="${quote_nisplus:$local_part}"]
6834 .endd
6835 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6836 operator can be used for all lookup types, but has no effect for single-key
6837 lookups, since no quoting is ever needed in their key strings.
6838
6839
6840
6841
6842 .section "More about dnsdb" "SECTdnsdb"
6843 .cindex "dnsdb lookup"
6844 .cindex "lookup" "dnsdb"
6845 .cindex "DNS" "as a lookup type"
6846 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6847 of a record type and a domain name, separated by an equals sign. For example,
6848 an expansion string could contain:
6849 .code
6850 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6851 .endd
6852 If the lookup succeeds, the result is placed in &$value$&, which in this case
6853 is used on its own as the result. If the lookup does not succeed, the
6854 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6855 &<<SECTforexpfai>>& for an explanation of what this means.
6856
6857 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,
6858 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6859 configured). If no type is given, TXT is assumed. When the type is PTR,
6860 the data can be an IP address, written as normal; inversion and the addition of
6861 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6862 .code
6863 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6864 .endd
6865 If the data for a PTR record is not a syntactically valid IP address, it is not
6866 altered and nothing is added.
6867
6868 .cindex "MX record" "in &(dnsdb)& lookup"
6869 .cindex "SRV record" "in &(dnsdb)& lookup"
6870 For an MX lookup, both the preference value and the host name are returned for
6871 each record, separated by a space. For an SRV lookup, the priority, weight,
6872 port, and host name are returned for each record, separated by spaces.
6873
6874 For any record type, if multiple records are found (or, for A6 lookups, if a
6875 single record leads to multiple addresses), the data is returned as a
6876 concatenation, with newline as the default separator. The order, of course,
6877 depends on the DNS resolver. You can specify a different separator character
6878 between multiple records by putting a right angle-bracket followed immediately
6879 by the new separator at the start of the query. For example:
6880 .code
6881 ${lookup dnsdb{>: a=host1.example}}
6882 .endd
6883 It is permitted to specify a space as the separator character. Further
6884 white space is ignored.
6885
6886 .cindex "TXT record" "in &(dnsdb)& lookup"
6887 .cindex "SPF record" "in &(dnsdb)& lookup"
6888 For TXT records with multiple items of data, only the first item is returned,
6889 unless a separator for them is specified using a comma after the separator
6890 character followed immediately by the TXT record item separator. To concatenate
6891 items without a separator, use a semicolon instead. For SPF records the
6892 default behaviour is to concatenate multiple items without using a separator.
6893 .code
6894 ${lookup dnsdb{>\n,: txt=a.b.example}}
6895 ${lookup dnsdb{>\n; txt=a.b.example}}
6896 ${lookup dnsdb{spf=example.org}}
6897 .endd
6898 It is permitted to specify a space as the separator character. Further
6899 white space is ignored.
6900
6901 .section "Pseudo dnsdb record types" "SECID66"
6902 .cindex "MX record" "in &(dnsdb)& lookup"
6903 By default, both the preference value and the host name are returned for
6904 each MX record, separated by a space. If you want only host names, you can use
6905 the pseudo-type MXH:
6906 .code
6907 ${lookup dnsdb{mxh=a.b.example}}
6908 .endd
6909 In this case, the preference values are omitted, and just the host names are
6910 returned.
6911
6912 .cindex "name server for enclosing domain"
6913 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6914 records on the given domain, but if none are found, it removes the first
6915 component of the domain name, and tries again. This process continues until NS
6916 records are found or there are no more components left (or there is a DNS
6917 error). In other words, it may return the name servers for a top-level domain,
6918 but it never returns the root name servers. If there are no NS records for the
6919 top-level domain, the lookup fails. Consider these examples:
6920 .code
6921 ${lookup dnsdb{zns=xxx.quercite.com}}
6922 ${lookup dnsdb{zns=xxx.edu}}
6923 .endd
6924 Assuming that in each case there are no NS records for the full domain name,
6925 the first returns the name servers for &%quercite.com%&, and the second returns
6926 the name servers for &%edu%&.
6927
6928 You should be careful about how you use this lookup because, unless the
6929 top-level domain does not exist, the lookup always returns some host names. The
6930 sort of use to which this might be put is for seeing if the name servers for a
6931 given domain are on a blacklist. You can probably assume that the name servers
6932 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6933 such a list.
6934
6935 .cindex "CSA" "in &(dnsdb)& lookup"
6936 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6937 records according to the CSA rules, which are described in section
6938 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6939 not sufficient because of the extra parent domain search behaviour of CSA. The
6940 result of a successful lookup such as:
6941 .code
6942 ${lookup dnsdb {csa=$sender_helo_name}}
6943 .endd
6944 has two space-separated fields: an authorization code and a target host name.
6945 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6946 authorization required but absent, or &"?"& for unknown.
6947
6948 .cindex "A+" "in &(dnsdb)& lookup"
6949 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6950 and then an A lookup.  All results are returned; defer processing
6951 (see below) is handled separately for each lookup.  Example:
6952 .code
6953 ${lookup dnsdb {>; a+=$sender_helo_name}}
6954 .endd
6955
6956
6957 .section "Multiple dnsdb lookups" "SECID67"
6958 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6959 However, you can specify a list of domains or IP addresses in a single
6960 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6961 the default separator, but with the ability to change this. For example:
6962 .code
6963 ${lookup dnsdb{one.domain.com:two.domain.com}}
6964 ${lookup dnsdb{a=one.host.com:two.host.com}}
6965 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6966 .endd
6967 In order to retain backwards compatibility, there is one special case: if
6968 the lookup type is PTR and no change of separator is specified, Exim looks
6969 to see if the rest of the string is precisely one IPv6 address. In this
6970 case, it does not treat it as a list.
6971
6972 The data from each lookup is concatenated, with newline separators by default,
6973 in the same way that multiple DNS records for a single item are handled. A
6974 different separator can be specified, as described above.
6975
6976 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6977 each followed by a comma,
6978 that may appear before the record type.
6979
6980 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6981 temporary DNS error for any of them, the behaviour is controlled by
6982 a defer-option modifier.
6983 The possible keywords are
6984 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6985 With &"strict"& behaviour, any temporary DNS error causes the
6986 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6987 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6988 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6989 error causes the whole lookup to defer only if none of the other lookups
6990 succeed. The default is &"lax"&, so the following lookups are equivalent:
6991 .code
6992 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6993 ${lookup dnsdb{a=one.host.com:two.host.com}}
6994 .endd
6995 Thus, in the default case, as long as at least one of the DNS lookups
6996 yields some data, the lookup succeeds.
6997
6998 .new
6999 .cindex "DNSSEC" "dns lookup"
7000 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7001 The possible keywords are
7002 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7003 With &"strict"& or &"lax"& DNSSEC information is requested
7004 with the lookup.
7005 With &"strict"& a response from the DNS resolver that
7006 is not labelled as authenticated data
7007 is treated as equivalent to a temporary DNS error.
7008 The default is &"never"&.
7009
7010 See also the &$lookup_dnssec_authenticated$& variable.
7011 .wen
7012
7013
7014
7015
7016 .section "More about LDAP" "SECTldap"
7017 .cindex "LDAP" "lookup, more about"
7018 .cindex "lookup" "LDAP"
7019 .cindex "Solaris" "LDAP"
7020 The original LDAP implementation came from the University of Michigan; this has
7021 become &"Open LDAP"&, and there are now two different releases. Another
7022 implementation comes from Netscape, and Solaris 7 and subsequent releases
7023 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7024 the lookup function level, their error handling is different. For this reason
7025 it is necessary to set a compile-time variable when building Exim with LDAP, to
7026 indicate which LDAP library is in use. One of the following should appear in
7027 your &_Local/Makefile_&:
7028 .code
7029 LDAP_LIB_TYPE=UMICHIGAN
7030 LDAP_LIB_TYPE=OPENLDAP1
7031 LDAP_LIB_TYPE=OPENLDAP2
7032 LDAP_LIB_TYPE=NETSCAPE
7033 LDAP_LIB_TYPE=SOLARIS
7034 .endd
7035 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7036 same interface as the University of Michigan version.
7037
7038 There are three LDAP lookup types in Exim. These behave slightly differently in
7039 the way they handle the results of a query:
7040
7041 .ilist
7042 &(ldap)& requires the result to contain just one entry; if there are more, it
7043 gives an error.
7044 .next
7045 &(ldapdn)& also requires the result to contain just one entry, but it is the
7046 Distinguished Name that is returned rather than any attribute values.
7047 .next
7048 &(ldapm)& permits the result to contain more than one entry; the attributes
7049 from all of them are returned.
7050 .endlist
7051
7052
7053 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7054 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7055 the data returned by a successful lookup is described in the next section.
7056 First we explain how LDAP queries are coded.
7057
7058
7059 .section "Format of LDAP queries" "SECTforldaque"
7060 .cindex "LDAP" "query format"
7061 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7062 the configuration of a &(redirect)& router one might have this setting:
7063 .code
7064 data = ${lookup ldap \
7065   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7066   c=UK?mailbox?base?}}
7067 .endd
7068 .cindex "LDAP" "with TLS"
7069 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7070 secure (encrypted) LDAP connections. The second of these ensures that an
7071 encrypted TLS connection is used.
7072
7073 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7074 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7075 See the &%ldap_start_tls%& option.
7076
7077 .new
7078 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7079 controlled. Every part of the TLS configuration can be configured by settings in
7080 &_exim.conf_&. Depending on the version of the client libraries installed on
7081 your system, some of the initialization may have required setting options in
7082 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7083 certificates. This revealed a nuance where the current UID that exim was
7084 running as could affect which config files it read. With Exim 4.83, these
7085 methods become optional, only taking effect if not specifically set in
7086 &_exim.conf_&.
7087 .wen
7088
7089
7090 .section "LDAP quoting" "SECID68"
7091 .cindex "LDAP" "quoting"
7092 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7093 and the second because the LDAP query is represented as a URL. Furthermore,
7094 within an LDAP query, two different kinds of quoting are required. For this
7095 reason, there are two different LDAP-specific quoting operators.
7096
7097 The &%quote_ldap%& operator is designed for use on strings that are part of
7098 filter specifications. Conceptually, it first does the following conversions on
7099 the string:
7100 .code
7101 *   =>   \2A
7102 (   =>   \28
7103 )   =>   \29
7104 \   =>   \5C
7105 .endd
7106 in accordance with RFC 2254. The resulting string is then quoted according
7107 to the rules for URLs, that is, all non-alphanumeric characters except
7108 .code
7109 ! $ ' - . _ ( ) * +
7110 .endd
7111 are converted to their hex values, preceded by a percent sign. For example:
7112 .code
7113 ${quote_ldap: a(bc)*, a<yz>; }
7114 .endd
7115 yields
7116 .code
7117 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7118 .endd
7119 Removing the URL quoting, this is (with a leading and a trailing space):
7120 .code
7121 a\28bc\29\2A, a<yz>;
7122 .endd
7123 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7124 base DN specifications in queries. Conceptually, it first converts the string
7125 by inserting a backslash in front of any of the following characters:
7126 .code
7127 , + " \ < > ;
7128 .endd
7129 It also inserts a backslash before any leading spaces or # characters, and
7130 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7131 is then quoted according to the rules for URLs. For example:
7132 .code
7133 ${quote_ldap_dn: a(bc)*, a<yz>; }
7134 .endd
7135 yields
7136 .code
7137 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7138 .endd
7139 Removing the URL quoting, this is (with a trailing space):
7140 .code
7141 \ a(bc)*\, a\<yz\>\;\
7142 .endd
7143 There are some further comments about quoting in the section on LDAP
7144 authentication below.
7145
7146
7147 .section "LDAP connections" "SECID69"
7148 .cindex "LDAP" "connections"
7149 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7150 is in use, via a Unix domain socket. The example given above does not specify
7151 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7152 by starting it with
7153 .code
7154 ldap://<hostname>:<port>/...
7155 .endd
7156 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7157 used. When no server is specified in a query, a list of default servers is
7158 taken from the &%ldap_default_servers%& configuration option. This supplies a
7159 colon-separated list of servers which are tried in turn until one successfully
7160 handles a query, or there is a serious error. Successful handling either
7161 returns the requested data, or indicates that it does not exist. Serious errors
7162 are syntactical, or multiple values when only a single value is expected.
7163 Errors which cause the next server to be tried are connection failures, bind
7164 failures, and timeouts.
7165
7166 For each server name in the list, a port number can be given. The standard way
7167 of specifying a host and port is to use a colon separator (RFC 1738). Because
7168 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7169 doubled. For example
7170 .code
7171 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7172 .endd
7173 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7174 to the LDAP library with no server name, and the library's default (normally
7175 the local host) is used.
7176
7177 If you are using the OpenLDAP library, you can connect to an LDAP server using
7178 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7179 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7180 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7181 not available.
7182
7183 For this type of connection, instead of a host name for the server, a pathname
7184 for the socket is required, and the port number is not relevant. The pathname
7185 can be specified either as an item in &%ldap_default_servers%&, or inline in
7186 the query. In the former case, you can have settings such as
7187 .code
7188 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7189 .endd
7190 When the pathname is given in the query, you have to escape the slashes as
7191 &`%2F`& to fit in with the LDAP URL syntax. For example:
7192 .code
7193 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7194 .endd
7195 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7196 a pathname, it uses the Unix domain socket code, even if the query actually
7197 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7198 socket connection. This behaviour means that you can use a setting of
7199 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7200 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7201 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7202 backup host.
7203
7204 If an explicit &`ldapi`& type is given in a query when a host name is
7205 specified, an error is diagnosed. However, if there are more items in
7206 &%ldap_default_servers%&, they are tried. In other words:
7207
7208 .ilist
7209 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7210 interface.
7211 .next
7212 Using &`ldapi`& with a host name causes an error.
7213 .endlist
7214
7215
7216 Using &`ldapi`& with no host or path in the query, and no setting of
7217 &%ldap_default_servers%&, does whatever the library does by default.
7218
7219
7220
7221 .section "LDAP authentication and control information" "SECID70"
7222 .cindex "LDAP" "authentication"
7223 The LDAP URL syntax provides no way of passing authentication and other control
7224 information to the server. To make this possible, the URL in an LDAP query may
7225 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7226 spaces. If a value contains spaces it must be enclosed in double quotes, and
7227 when double quotes are used, backslash is interpreted in the usual way inside
7228 them. The following names are recognized:
7229 .display
7230 &`DEREFERENCE`&  set the dereferencing parameter
7231 &`NETTIME    `&  set a timeout for a network operation
7232 &`USER       `&  set the DN, for authenticating the LDAP bind
7233 &`PASS       `&  set the password, likewise
7234 &`REFERRALS  `&  set the referrals parameter
7235 .new
7236 &`SERVERS    `&  set alternate server list for this query only
7237 .wen
7238 &`SIZE       `&  set the limit for the number of entries returned
7239 &`TIME       `&  set the maximum waiting time for a query
7240 .endd
7241 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7242 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7243 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7244 library from trying to follow referrals issued by the LDAP server.
7245
7246 The name CONNECT is an obsolete name for NETTIME, retained for
7247 backwards compatibility. This timeout (specified as a number of seconds) is
7248 enforced from the client end for operations that can be carried out over a
7249 network. Specifically, it applies to network connections and calls to the
7250 &'ldap_result()'& function. If the value is greater than zero, it is used if
7251 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7252 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7253 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7254 Netscape SDK; for OpenLDAP no action is taken.
7255
7256 The TIME parameter (also a number of seconds) is passed to the server to
7257 set a server-side limit on the time taken to complete a search.
7258
7259 .new
7260 The SERVERS parameter allows you to specify an alternate list of ldap servers
7261 to use for an individual lookup.  The global ldap_servers option provides a
7262 default list of ldap servers, and a single lookup can specify a single ldap
7263 server to use.  But when you need to do a lookup with a list of servers that is
7264 different than the default list (maybe different order, maybe a completely
7265 different set of servers), the SERVERS parameter allows you to specify this
7266 alternate list.
7267 .wen
7268
7269 Here is an example of an LDAP query in an Exim lookup that uses some of these
7270 values. This is a single line, folded to fit on the page:
7271 .code
7272 ${lookup ldap
7273   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7274   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7275   {$value}fail}
7276 .endd
7277 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7278 any of the auxiliary data. Exim configuration settings that include lookups
7279 which contain password information should be preceded by &"hide"& to prevent
7280 non-admin users from using the &%-bP%& option to see their values.
7281
7282 The auxiliary data items may be given in any order. The default is no
7283 connection timeout (the system timeout is used), no user or password, no limit
7284 on the number of entries returned, and no time limit on queries.
7285
7286 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7287 removes any URL quoting that it may contain before passing it LDAP. Apparently
7288 some libraries do this for themselves, but some do not. Removing the URL
7289 quoting has two advantages:
7290
7291 .ilist
7292 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7293 DNs as with DNs inside actual queries.
7294 .next
7295 It permits spaces inside USER= DNs.
7296 .endlist
7297
7298 For example, a setting such as
7299 .code
7300 USER=cn=${quote_ldap_dn:$1}
7301 .endd
7302 should work even if &$1$& contains spaces.
7303
7304 Expanded data for the PASS= value should be quoted using the &%quote%&
7305 expansion operator, rather than the LDAP quote operators. The only reason this
7306 field needs quoting is to ensure that it conforms to the Exim syntax, which
7307 does not allow unquoted spaces. For example:
7308 .code
7309 PASS=${quote:$3}
7310 .endd
7311 The LDAP authentication mechanism can be used to check passwords as part of
7312 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7313 &<<CHAPexpand>>&.
7314
7315
7316
7317 .section "Format of data returned by LDAP" "SECID71"
7318 .cindex "LDAP" "returned data formats"
7319 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7320 as a sequence of values, for example
7321 .code
7322 cn=manager, o=University of Cambridge, c=UK
7323 .endd
7324 The &(ldap)& lookup type generates an error if more than one entry matches the
7325 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7326 the result between the data from different entries. It is possible for multiple
7327 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7328 you know that whatever values are returned all came from a single entry in the
7329 directory.
7330
7331 In the common case where you specify a single attribute in your LDAP query, the
7332 result is not quoted, and does not contain the attribute name. If the attribute
7333 has multiple values, they are separated by commas.
7334
7335 If you specify multiple attributes, the result contains space-separated, quoted
7336 strings, each preceded by the attribute name and an equals sign. Within the
7337 quotes, the quote character, backslash, and newline are escaped with
7338 backslashes, and commas are used to separate multiple values for the attribute.
7339 Apart from the escaping, the string within quotes takes the same form as the
7340 output when a single attribute is requested. Specifying no attributes is the
7341 same as specifying all of an entry's attributes.
7342
7343 Here are some examples of the output format. The first line of each pair is an
7344 LDAP query, and the second is the data that is returned. The attribute called
7345 &%attr1%& has two values, whereas &%attr2%& has only one value:
7346 .code
7347 ldap:///o=base?attr1?sub?(uid=fred)
7348 value1.1, value1.2
7349
7350 ldap:///o=base?attr2?sub?(uid=fred)
7351 value two
7352
7353 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7354 attr1="value1.1, value1.2" attr2="value two"
7355
7356 ldap:///o=base??sub?(uid=fred)
7357 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7358 .endd
7359 The &%extract%& operator in string expansions can be used to pick out
7360 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7361 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7362 results of LDAP lookups.
7363
7364
7365
7366
7367 .section "More about NIS+" "SECTnisplus"
7368 .cindex "NIS+ lookup type"
7369 .cindex "lookup" "NIS+"
7370 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7371 and field name. If this is given, the result of a successful query is the
7372 contents of the named field; otherwise the result consists of a concatenation
7373 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7374 values containing spaces are quoted. For example, the query
7375 .code
7376 [name=mg1456],passwd.org_dir
7377 .endd
7378 might return the string
7379 .code
7380 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7381 home=/home/mg1456 shell=/bin/bash shadow=""
7382 .endd
7383 (split over two lines here to fit on the page), whereas
7384 .code
7385 [name=mg1456],passwd.org_dir:gcos
7386 .endd
7387 would just return
7388 .code
7389 Martin Guerre
7390 .endd
7391 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7392 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7393 operator is to double any quote characters within the text.
7394
7395
7396
7397 .section "SQL lookups" "SECTsql"
7398 .cindex "SQL lookup types"
7399 .cindex "MySQL" "lookup type"
7400 .cindex "PostgreSQL lookup type"
7401 .cindex "lookup" "MySQL"
7402 .cindex "lookup" "PostgreSQL"
7403 .cindex "Oracle" "lookup type"
7404 .cindex "lookup" "Oracle"
7405 .cindex "InterBase lookup type"
7406 .cindex "lookup" "InterBase"
7407 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7408 databases. Queries for these databases contain SQL statements, so an example
7409 might be
7410 .code
7411 ${lookup mysql{select mailbox from users where id='userx'}\
7412   {$value}fail}
7413 .endd
7414 If the result of the query contains more than one field, the data for each
7415 field in the row is returned, preceded by its name, so the result of
7416 .code
7417 ${lookup pgsql{select home,name from users where id='userx'}\
7418   {$value}}
7419 .endd
7420 might be
7421 .code
7422 home=/home/userx name="Mister X"
7423 .endd
7424 Empty values and values containing spaces are double quoted, with embedded
7425 quotes escaped by a backslash. If the result of the query contains just one
7426 field, the value is passed back verbatim, without a field name, for example:
7427 .code
7428 Mister X
7429 .endd
7430 If the result of the query yields more than one row, it is all concatenated,
7431 with a newline between the data for each row.
7432
7433
7434 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7435 .cindex "MySQL" "lookup type"
7436 .cindex "PostgreSQL lookup type"
7437 .cindex "lookup" "MySQL"
7438 .cindex "lookup" "PostgreSQL"
7439 .cindex "Oracle" "lookup type"
7440 .cindex "lookup" "Oracle"
7441 .cindex "InterBase lookup type"
7442 .cindex "lookup" "InterBase"
7443 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7444 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7445 option (as appropriate) must be set to a colon-separated list of server
7446 information.
7447 (For MySQL and PostgreSQL only, the global option need not be set if all
7448 queries contain their own server information &-- see section
7449 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7450 items: host name, database name, user name, and password. In the case of
7451 Oracle, the host name field is used for the &"service name"&, and the database
7452 name field is not used and should be empty. For example:
7453 .code
7454 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7455 .endd
7456 Because password data is sensitive, you should always precede the setting with
7457 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7458 option. Here is an example where two MySQL servers are listed:
7459 .code
7460 hide mysql_servers = localhost/users/root/secret:\
7461                      otherhost/users/root/othersecret
7462 .endd
7463 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7464 because this is a colon-separated list, the colon has to be doubled. For each
7465 query, these parameter groups are tried in order until a connection is made and
7466 a query is successfully processed. The result of a query may be that no data is
7467 found, but that is still a successful query. In other words, the list of
7468 servers provides a backup facility, not a list of different places to look.
7469
7470 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7471 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7472 respectively, and the characters single-quote, double-quote, and backslash
7473 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7474 addition, escapes the percent and underscore characters. This cannot be done
7475 for MySQL because these escapes are not recognized in contexts where these
7476 characters are not special.
7477
7478 .section "Specifying the server in the query" "SECTspeserque"
7479 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7480 it is possible to specify a list of servers with an individual query. This is
7481 done by starting the query with
7482 .display
7483 &`servers=`&&'server1:server2:server3:...'&&`;`&
7484 .endd
7485 Each item in the list may take one of two forms:
7486 .olist
7487 If it contains no slashes it is assumed to be just a host name. The appropriate
7488 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7489 of the same name, and the remaining parameters (database, user, password) are
7490 taken from there.
7491 .next
7492 If it contains any slashes, it is taken as a complete parameter set.
7493 .endlist
7494 The list of servers is used in exactly the same way as the global list.
7495 Once a connection to a server has happened and a query has been
7496 successfully executed, processing of the lookup ceases.
7497
7498 This feature is intended for use in master/slave situations where updates
7499 are occurring and you want to update the master rather than a slave. If the
7500 master is in the list as a backup for reading, you might have a global setting
7501 like this:
7502 .code
7503 mysql_servers = slave1/db/name/pw:\
7504                 slave2/db/name/pw:\
7505                 master/db/name/pw
7506 .endd
7507 In an updating lookup, you could then write:
7508 .code
7509 ${lookup mysql{servers=master; UPDATE ...} }
7510 .endd
7511 That query would then be sent only to the master server. If, on the other hand,
7512 the master is not to be used for reading, and so is not present in the global
7513 option, you can still update it by a query of this form:
7514 .code
7515 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7516 .endd
7517
7518
7519 .section "Special MySQL features" "SECID73"
7520 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7521 causes a connection to the server on the local host by means of a Unix domain
7522 socket. An alternate socket can be specified in parentheses. The full syntax of
7523 each item in &%mysql_servers%& is:
7524 .display
7525 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7526   <&'user'&>/<&'password'&>
7527 .endd
7528 Any of the three sub-parts of the first field can be omitted. For normal use on
7529 the local host it can be left blank or set to just &"localhost"&.
7530
7531 No database need be supplied &-- but if it is absent here, it must be given in
7532 the queries.
7533
7534 If a MySQL query is issued that does not request any data (an insert, update,
7535 or delete command), the result of the lookup is the number of rows affected.
7536
7537 &*Warning*&: This can be misleading. If an update does not actually change
7538 anything (for example, setting a field to the value it already has), the result
7539 is zero because no rows are affected.
7540
7541
7542 .section "Special PostgreSQL features" "SECID74"
7543 PostgreSQL lookups can also use Unix domain socket connections to the database.
7544 This is usually faster and costs less CPU time than a TCP/IP connection.
7545 However it can be used only if the mail server runs on the same machine as the
7546 database server. A configuration line for PostgreSQL via Unix domain sockets
7547 looks like this:
7548 .code
7549 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7550 .endd
7551 In other words, instead of supplying a host name, a path to the socket is
7552 given. The path name is enclosed in parentheses so that its slashes aren't
7553 visually confused with the delimiters for the other server parameters.
7554
7555 If a PostgreSQL query is issued that does not request any data (an insert,
7556 update, or delete command), the result of the lookup is the number of rows
7557 affected.
7558
7559 .section "More about SQLite" "SECTsqlite"
7560 .cindex "lookup" "SQLite"
7561 .cindex "sqlite lookup type"
7562 SQLite is different to the other SQL lookups because a file name is required in
7563 addition to the SQL query. An SQLite database is a single file, and there is no
7564 daemon as in the other SQL databases. The interface to Exim requires the name
7565 of the file, as an absolute path, to be given at the start of the query. It is
7566 separated from the query by white space. This means that the path name cannot
7567 contain white space. Here is a lookup expansion example:
7568 .code
7569 ${lookup sqlite {/some/thing/sqlitedb \
7570   select name from aliases where id='userx';}}
7571 .endd
7572 In a list, the syntax is similar. For example:
7573 .code
7574 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7575    select * from relays where ip='$sender_host_address';
7576 .endd
7577 The only character affected by the &%quote_sqlite%& operator is a single
7578 quote, which it doubles.
7579
7580 The SQLite library handles multiple simultaneous accesses to the database
7581 internally. Multiple readers are permitted, but only one process can
7582 update at once. Attempts to access the database while it is being updated
7583 are rejected after a timeout period, during which the SQLite library
7584 waits for the lock to be released. In Exim, the default timeout is set
7585 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7586 option.
7587 .ecindex IIDfidalo1
7588 .ecindex IIDfidalo2
7589
7590
7591 . ////////////////////////////////////////////////////////////////////////////
7592 . ////////////////////////////////////////////////////////////////////////////
7593
7594 .chapter "Domain, host, address, and local part lists" &&&
7595          "CHAPdomhosaddlists" &&&
7596          "Domain, host, and address lists"
7597 .scindex IIDdohoadli "lists of domains; hosts; etc."
7598 A number of Exim configuration options contain lists of domains, hosts,
7599 email addresses, or local parts. For example, the &%hold_domains%& option
7600 contains a list of domains whose delivery is currently suspended. These lists
7601 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7602 arguments to expansion conditions such as &%match_domain%&.
7603
7604 Each item in one of these lists is a pattern to be matched against a domain,
7605 host, email address, or local part, respectively. In the sections below, the
7606 different types of pattern for each case are described, but first we cover some
7607 general facilities that apply to all four kinds of list.
7608
7609
7610
7611 .section "Expansion of lists" "SECID75"
7612 .cindex "expansion" "of lists"
7613 Each list is expanded as a single string before it is used. The result of
7614 expansion must be a list, possibly containing empty items, which is split up
7615 into separate items for matching. By default, colon is the separator character,
7616 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7617 &<<SECTempitelis>>& for details of the list syntax; the second of these
7618 discusses the way to specify empty list items.
7619
7620
7621 If the string expansion is forced to fail, Exim behaves as if the item it is
7622 testing (domain, host, address, or local part) is not in the list. Other
7623 expansion failures cause temporary errors.
7624
7625 If an item in a list is a regular expression, backslashes, dollars and possibly
7626 other special characters in the expression must be protected against
7627 misinterpretation by the string expander. The easiest way to do this is to use
7628 the &`\N`& expansion feature to indicate that the contents of the regular
7629 expression should not be expanded. For example, in an ACL you might have:
7630 .code
7631 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7632                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7633 .endd
7634 The first item is a regular expression that is protected from expansion by
7635 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7636 senders based on the receiving domain.
7637
7638
7639
7640
7641 .section "Negated items in lists" "SECID76"
7642 .cindex "list" "negation"
7643 .cindex "negation" "in lists"
7644 Items in a list may be positive or negative. Negative items are indicated by a
7645 leading exclamation mark, which may be followed by optional white space. A list
7646 defines a set of items (domains, etc). When Exim processes one of these lists,
7647 it is trying to find out whether a domain, host, address, or local part
7648 (respectively) is in the set that is defined by the list. It works like this:
7649
7650 The list is scanned from left to right. If a positive item is matched, the
7651 subject that is being checked is in the set; if a negative item is matched, the
7652 subject is not in the set. If the end of the list is reached without the
7653 subject having matched any of the patterns, it is in the set if the last item
7654 was a negative one, but not if it was a positive one. For example, the list in
7655 .code
7656 domainlist relay_to_domains = !a.b.c : *.b.c
7657 .endd
7658 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7659 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7660 list is positive. However, if the setting were
7661 .code
7662 domainlist relay_to_domains = !a.b.c
7663 .endd
7664 then all domains other than &'a.b.c'& would match because the last item in the
7665 list is negative. In other words, a list that ends with a negative item behaves
7666 as if it had an extra item &`:*`& on the end.
7667
7668 Another way of thinking about positive and negative items in lists is to read
7669 the connector as &"or"& after a positive item and as &"and"& after a negative
7670 item.
7671
7672
7673
7674 .section "File names in lists" "SECTfilnamlis"
7675 .cindex "list" "file name in"
7676 If an item in a domain, host, address, or local part list is an absolute file
7677 name (beginning with a slash character), each line of the file is read and
7678 processed as if it were an independent item in the list, except that further
7679 file names are not allowed,
7680 and no expansion of the data from the file takes place.
7681 Empty lines in the file are ignored, and the file may also contain comment
7682 lines:
7683
7684 .ilist
7685 For domain and host lists, if a # character appears anywhere in a line of the
7686 file, it and all following characters are ignored.
7687 .next
7688 Because local parts may legitimately contain # characters, a comment in an
7689 address list or local part list file is recognized only if # is preceded by
7690 white space or the start of the line. For example:
7691 .code
7692 not#comment@x.y.z   # but this is a comment
7693 .endd
7694 .endlist
7695
7696 Putting a file name in a list has the same effect as inserting each line of the
7697 file as an item in the list (blank lines and comments excepted). However, there
7698 is one important difference: the file is read each time the list is processed,
7699 so if its contents vary over time, Exim's behaviour changes.
7700
7701 If a file name is preceded by an exclamation mark, the sense of any match
7702 within the file is inverted. For example, if
7703 .code
7704 hold_domains = !/etc/nohold-domains
7705 .endd
7706 and the file contains the lines
7707 .code
7708 !a.b.c
7709 *.b.c
7710 .endd
7711 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7712 any domain matching &`*.b.c`& is not.
7713
7714
7715
7716 .section "An lsearch file is not an out-of-line list" "SECID77"
7717 As will be described in the sections that follow, lookups can be used in lists
7718 to provide indexed methods of checking list membership. There has been some
7719 confusion about the way &(lsearch)& lookups work in lists. Because
7720 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7721 sometimes thought that it is allowed to contain wild cards and other kinds of
7722 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7723 always fixed strings, just as for any other single-key lookup type.
7724
7725 If you want to use a file to contain wild-card patterns that form part of a
7726 list, just give the file name on its own, without a search type, as described
7727 in the previous section. You could also use the &(wildlsearch)& or
7728 &(nwildlsearch)&, but there is no advantage in doing this.
7729
7730
7731
7732
7733 .section "Named lists" "SECTnamedlists"
7734 .cindex "named lists"
7735 .cindex "list" "named"
7736 A list of domains, hosts, email addresses, or local parts can be given a name
7737 which is then used to refer to the list elsewhere in the configuration. This is
7738 particularly convenient if the same list is required in several different
7739 places. It also allows lists to be given meaningful names, which can improve
7740 the readability of the configuration. For example, it is conventional to define
7741 a domain list called &'local_domains'& for all the domains that are handled
7742 locally on a host, using a configuration line such as
7743 .code
7744 domainlist local_domains = localhost:my.dom.example
7745 .endd
7746 Named lists are referenced by giving their name preceded by a plus sign, so,
7747 for example, a router that is intended to handle local domains would be
7748 configured with the line
7749 .code
7750 domains = +local_domains
7751 .endd
7752 The first router in a configuration is often one that handles all domains
7753 except the local ones, using a configuration with a negated item like this:
7754 .code
7755 dnslookup:
7756   driver = dnslookup
7757   domains = ! +local_domains
7758   transport = remote_smtp
7759   no_more
7760 .endd
7761 The four kinds of named list are created by configuration lines starting with
7762 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7763 respectively. Then there follows the name that you are defining, followed by an
7764 equals sign and the list itself. For example:
7765 .code
7766 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7767 addresslist bad_senders = cdb;/etc/badsenders
7768 .endd
7769 A named list may refer to other named lists:
7770 .code
7771 domainlist  dom1 = first.example : second.example
7772 domainlist  dom2 = +dom1 : third.example
7773 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7774 .endd
7775 &*Warning*&: If the last item in a referenced list is a negative one, the
7776 effect may not be what you intended, because the negation does not propagate
7777 out to the higher level. For example, consider:
7778 .code
7779 domainlist  dom1 = !a.b
7780 domainlist  dom2 = +dom1 : *.b
7781 .endd
7782 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7783 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7784 means it matches the second list as well. The effect is not the same as
7785 .code
7786 domainlist  dom2 = !a.b : *.b
7787 .endd
7788 where &'x.y'& does not match. It's best to avoid negation altogether in
7789 referenced lists if you can.
7790
7791 Named lists may have a performance advantage. When Exim is routing an
7792 address or checking an incoming message, it caches the result of tests on named
7793 lists. So, if you have a setting such as
7794 .code
7795 domains = +local_domains
7796 .endd
7797 on several of your routers
7798 or in several ACL statements,
7799 the actual test is done only for the first one. However, the caching works only
7800 if there are no expansions within the list itself or any sublists that it
7801 references. In other words, caching happens only for lists that are known to be
7802 the same each time they are referenced.
7803
7804 By default, there may be up to 16 named lists of each type. This limit can be
7805 extended by changing a compile-time variable. The use of domain and host lists
7806 is recommended for concepts such as local domains, relay domains, and relay
7807 hosts. The default configuration is set up like this.
7808
7809
7810
7811 .section "Named lists compared with macros" "SECID78"
7812 .cindex "list" "named compared with macro"
7813 .cindex "macro" "compared with named list"
7814 At first sight, named lists might seem to be no different from macros in the
7815 configuration file. However, macros are just textual substitutions. If you
7816 write
7817 .code
7818 ALIST = host1 : host2
7819 auth_advertise_hosts = !ALIST
7820 .endd
7821 it probably won't do what you want, because that is exactly the same as
7822 .code
7823 auth_advertise_hosts = !host1 : host2
7824 .endd
7825 Notice that the second host name is not negated. However, if you use a host
7826 list, and write
7827 .code
7828 hostlist alist = host1 : host2
7829 auth_advertise_hosts = ! +alist
7830 .endd
7831 the negation applies to the whole list, and so that is equivalent to
7832 .code
7833 auth_advertise_hosts = !host1 : !host2
7834 .endd
7835
7836
7837 .section "Named list caching" "SECID79"
7838 .cindex "list" "caching of named"
7839 .cindex "caching" "named lists"
7840 While processing a message, Exim caches the result of checking a named list if
7841 it is sure that the list is the same each time. In practice, this means that
7842 the cache operates only if the list contains no $ characters, which guarantees
7843 that it will not change when it is expanded. Sometimes, however, you may have
7844 an expanded list that you know will be the same each time within a given
7845 message. For example:
7846 .code
7847 domainlist special_domains = \
7848            ${lookup{$sender_host_address}cdb{/some/file}}
7849 .endd
7850 This provides a list of domains that depends only on the sending host's IP
7851 address. If this domain list is referenced a number of times (for example,
7852 in several ACL lines, or in several routers) the result of the check is not
7853 cached by default, because Exim does not know that it is going to be the
7854 same list each time.
7855
7856 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7857 cache the result anyway. For example:
7858 .code
7859 domainlist_cache special_domains = ${lookup{...
7860 .endd
7861 If you do this, you should be absolutely sure that caching is going to do
7862 the right thing in all cases. When in doubt, leave it out.
7863
7864
7865
7866 .section "Domain lists" "SECTdomainlist"
7867 .cindex "domain list" "patterns for"
7868 .cindex "list" "domain list"
7869 Domain lists contain patterns that are to be matched against a mail domain.
7870 The following types of item may appear in domain lists:
7871
7872 .ilist
7873 .cindex "primary host name"
7874 .cindex "host name" "matched in domain list"
7875 .oindex "&%primary_hostname%&"
7876 .cindex "domain list" "matching primary host name"
7877 .cindex "@ in a domain list"
7878 If a pattern consists of a single @ character, it matches the local host name,
7879 as set by the &%primary_hostname%& option (or defaulted). This makes it
7880 possible to use the same configuration file on several different hosts that
7881 differ only in their names.
7882 .next
7883 .cindex "@[] in a domain list"
7884 .cindex "domain list" "matching local IP interfaces"
7885 .cindex "domain literal"
7886 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7887 in square brackets (as in an email address that contains a domain literal), but
7888 only if that IP address is recognized as local for email routing purposes. The
7889 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7890 control which of a host's several IP addresses are treated as local.
7891 In today's Internet, the use of domain literals is controversial.
7892 .next
7893 .cindex "@mx_any"
7894 .cindex "@mx_primary"
7895 .cindex "@mx_secondary"
7896 .cindex "domain list" "matching MX pointers to local host"
7897 If a pattern consists of the string &`@mx_any`& it matches any domain that
7898 has an MX record pointing to the local host or to any host that is listed in
7899 .oindex "&%hosts_treat_as_local%&"
7900 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7901 are similar, except that the first matches only when a primary MX target is the
7902 local host, and the second only when no primary MX target is the local host,
7903 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7904 preference value &-- there may of course be more than one of them.
7905
7906 The MX lookup that takes place when matching a pattern of this type is
7907 performed with the resolver options for widening names turned off. Thus, for
7908 example, a single-component domain will &'not'& be expanded by adding the
7909 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7910 options of the &(dnslookup)& router for a discussion of domain widening.
7911
7912 Sometimes you may want to ignore certain IP addresses when using one of these
7913 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7914 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7915 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7916 on a router). For example:
7917 .code
7918 domains = @mx_any/ignore=127.0.0.1
7919 .endd
7920 This example matches any domain that has an MX record pointing to one of
7921 the local host's IP addresses other than 127.0.0.1.
7922
7923 The list of IP addresses is in fact processed by the same code that processes
7924 host lists, so it may contain CIDR-coded network specifications and it may also
7925 contain negative items.
7926
7927 Because the list of IP addresses is a sublist within a domain list, you have to
7928 be careful about delimiters if there is more than one address. Like any other
7929 list, the default delimiter can be changed. Thus, you might have:
7930 .code
7931 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7932           an.other.domain : ...
7933 .endd
7934 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7935 involved, it is easiest to change the delimiter for the main list as well:
7936 .code
7937 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7938           an.other.domain ? ...
7939 .endd
7940 .next
7941 .cindex "asterisk" "in domain list"
7942 .cindex "domain list" "asterisk in"
7943 .cindex "domain list" "matching &""ends with""&"
7944 If a pattern starts with an asterisk, the remaining characters of the pattern
7945 are compared with the terminating characters of the domain. The use of &"*"& in
7946 domain lists differs from its use in partial matching lookups. In a domain
7947 list, the character following the asterisk need not be a dot, whereas partial
7948 matching works only in terms of dot-separated components. For example, a domain
7949 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7950 &'cipher.key.ex'&.
7951
7952 .next
7953 .cindex "regular expressions" "in domain list"
7954 .cindex "domain list" "matching regular expression"
7955 If a pattern starts with a circumflex character, it is treated as a regular
7956 expression, and matched against the domain using a regular expression matching
7957 function. The circumflex is treated as part of the regular expression.
7958 Email domains are case-independent, so this regular expression match is by
7959 default case-independent, but you can make it case-dependent by starting it
7960 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7961 are given in chapter &<<CHAPregexp>>&.
7962
7963 &*Warning*&: Because domain lists are expanded before being processed, you
7964 must escape any backslash and dollar characters in the regular expression, or
7965 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7966 it is not to be expanded (unless you really do want to build a regular
7967 expression by expansion, of course).
7968 .next
7969 .cindex "lookup" "in domain list"
7970 .cindex "domain list" "matching by lookup"
7971 If a pattern starts with the name of a single-key lookup type followed by a
7972 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7973 must be a file name in a suitable format for the lookup type. For example, for
7974 &"cdb;"& it must be an absolute path:
7975 .code
7976 domains = cdb;/etc/mail/local_domains.cdb
7977 .endd
7978 The appropriate type of lookup is done on the file using the domain name as the
7979 key. In most cases, the data that is looked up is not used; Exim is interested
7980 only in whether or not the key is present in the file. However, when a lookup
7981 is used for the &%domains%& option on a router
7982 or a &%domains%& condition in an ACL statement, the data is preserved in the
7983 &$domain_data$& variable and can be referred to in other router options or
7984 other statements in the same ACL.
7985
7986 .next
7987 Any of the single-key lookup type names may be preceded by
7988 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7989 .code
7990 domains = partial-dbm;/partial/domains
7991 .endd
7992 This causes partial matching logic to be invoked; a description of how this
7993 works is given in section &<<SECTpartiallookup>>&.
7994
7995 .next
7996 .cindex "asterisk" "in lookup type"
7997 Any of the single-key lookup types may be followed by an asterisk. This causes
7998 a default lookup for a key consisting of a single asterisk to be done if the
7999 original lookup fails. This is not a useful feature when using a domain list to
8000 select particular domains (because any domain would match), but it might have
8001 value if the result of the lookup is being used via the &$domain_data$&
8002 expansion variable.
8003 .next
8004 If the pattern starts with the name of a query-style lookup type followed by a
8005 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8006 pattern must be an appropriate query for the lookup type, as described in
8007 chapter &<<CHAPfdlookup>>&. For example:
8008 .code
8009 hold_domains = mysql;select domain from holdlist \
8010   where domain = '${quote_mysql:$domain}';
8011 .endd
8012 In most cases, the data that is looked up is not used (so for an SQL query, for
8013 example, it doesn't matter what field you select). Exim is interested only in
8014 whether or not the query succeeds. However, when a lookup is used for the
8015 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8016 variable and can be referred to in other options.
8017 .next
8018 .cindex "domain list" "matching literal domain name"
8019 If none of the above cases apply, a caseless textual comparison is made
8020 between the pattern and the domain.
8021 .endlist
8022
8023 Here is an example that uses several different kinds of pattern:
8024 .code
8025 domainlist funny_domains = \
8026   @ : \
8027   lib.unseen.edu : \
8028   *.foundation.fict.example : \
8029   \N^[1-2]\d{3}\.fict\.example$\N : \
8030   partial-dbm;/opt/data/penguin/book : \
8031   nis;domains.byname : \
8032   nisplus;[name=$domain,status=local],domains.org_dir
8033 .endd
8034 There are obvious processing trade-offs among the various matching modes. Using
8035 an asterisk is faster than a regular expression, and listing a few names
8036 explicitly probably is too. The use of a file or database lookup is expensive,
8037 but may be the only option if hundreds of names are required. Because the
8038 patterns are tested in order, it makes sense to put the most commonly matched
8039 patterns earlier.
8040
8041
8042
8043 .section "Host lists" "SECThostlist"
8044 .cindex "host list" "patterns in"
8045 .cindex "list" "host list"
8046 Host lists are used to control what remote hosts are allowed to do. For
8047 example, some hosts may be allowed to use the local host as a relay, and some
8048 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8049 two different ways, by name or by IP address. In a host list, some types of
8050 pattern are matched to a host name, and some are matched to an IP address.
8051 You need to be particularly careful with this when single-key lookups are
8052 involved, to ensure that the right value is being used as the key.
8053
8054
8055 .section "Special host list patterns" "SECID80"
8056 .cindex "empty item in hosts list"
8057 .cindex "host list" "empty string in"
8058 If a host list item is the empty string, it matches only when no remote host is
8059 involved. This is the case when a message is being received from a local
8060 process using SMTP on the standard input, that is, when a TCP/IP connection is
8061 not used.
8062
8063 .cindex "asterisk" "in host list"
8064 The special pattern &"*"& in a host list matches any host or no host. Neither
8065 the IP address nor the name is actually inspected.
8066
8067
8068
8069 .section "Host list patterns that match by IP address" "SECThoslispatip"
8070 .cindex "host list" "matching IP addresses"
8071 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8072 the incoming address actually appears in the IPv6 host as
8073 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8074 list, it is converted into a traditional IPv4 address first. (Not all operating
8075 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8076 concerns.)
8077
8078 The following types of pattern in a host list check the remote host by
8079 inspecting its IP address:
8080
8081 .ilist
8082 If the pattern is a plain domain name (not a regular expression, not starting
8083 with *, not a lookup of any kind), Exim calls the operating system function
8084 to find the associated IP address(es). Exim uses the newer
8085 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8086 This typically causes a forward DNS lookup of the name. The result is compared
8087 with the IP address of the subject host.
8088
8089 If there is a temporary problem (such as a DNS timeout) with the host name
8090 lookup, a temporary error occurs. For example, if the list is being used in an
8091 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8092 temporary SMTP error code. If no IP address can be found for the host name,
8093 what happens is described in section &<<SECTbehipnot>>& below.
8094
8095 .next
8096 .cindex "@ in a host list"
8097 If the pattern is &"@"&, the primary host name is substituted and used as a
8098 domain name, as just described.
8099
8100 .next
8101 If the pattern is an IP address, it is matched against the IP address of the
8102 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8103 IPv6 addresses can be given in colon-separated format, but the colons have to
8104 be doubled so as not to be taken as item separators when the default list
8105 separator is used. IPv6 addresses are recognized even when Exim is compiled
8106 without IPv6 support. This means that if they appear in a host list on an
8107 IPv4-only host, Exim will not treat them as host names. They are just addresses
8108 that can never match a client host.
8109
8110 .next
8111 .cindex "@[] in a host list"
8112 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8113 the local host. For example, if the local host is an IPv4 host with one
8114 interface address 10.45.23.56, these two ACL statements have the same effect:
8115 .code
8116 accept hosts = 127.0.0.1 : 10.45.23.56
8117 accept hosts = @[]
8118 .endd
8119 .next
8120 .cindex "CIDR notation"
8121 If the pattern is an IP address followed by a slash and a mask length (for
8122 example 10.11.42.0/24), it is matched against the IP address of the subject
8123 host under the given mask. This allows, an entire network of hosts to be
8124 included (or excluded) by a single item. The mask uses CIDR notation; it
8125 specifies the number of address bits that must match, starting from the most
8126 significant end of the address.
8127
8128 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8129 of a range of addresses. It is the number of bits in the network portion of the
8130 address. The above example specifies a 24-bit netmask, so it matches all 256
8131 addresses in the 10.11.42.0 network. An item such as
8132 .code
8133 192.168.23.236/31
8134 .endd
8135 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8136 32 for an IPv4 address is the same as no mask at all; just a single address
8137 matches.
8138
8139 Here is another example which shows an IPv4 and an IPv6 network:
8140 .code
8141 recipient_unqualified_hosts = 192.168.0.0/16: \
8142                               3ffe::ffff::836f::::/48
8143 .endd
8144 The doubling of list separator characters applies only when these items
8145 appear inline in a host list. It is not required when indirecting via a file.
8146 For example:
8147 .code
8148 recipient_unqualified_hosts = /opt/exim/unqualnets
8149 .endd
8150 could make use of a file containing
8151 .code
8152 172.16.0.0/12
8153 3ffe:ffff:836f::/48
8154 .endd
8155 to have exactly the same effect as the previous example. When listing IPv6
8156 addresses inline, it is usually more convenient to use the facility for
8157 changing separator characters. This list contains the same two networks:
8158 .code
8159 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8160                                  3ffe:ffff:836f::/48
8161 .endd
8162 The separator is changed to semicolon by the leading &"<;"& at the start of the
8163 list.
8164 .endlist
8165
8166
8167
8168 .section "Host list patterns for single-key lookups by host address" &&&
8169          "SECThoslispatsikey"
8170 .cindex "host list" "lookup of IP address"
8171 When a host is to be identified by a single-key lookup of its complete IP
8172 address, the pattern takes this form:
8173 .display
8174 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8175 .endd
8176 For example:
8177 .code
8178 hosts_lookup = net-cdb;/hosts-by-ip.db
8179 .endd
8180 The text form of the IP address of the subject host is used as the lookup key.
8181 IPv6 addresses are converted to an unabbreviated form, using lower case
8182 letters, with dots as separators because colon is the key terminator in
8183 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8184 quoting the keys, but this is a facility that was added later.] The data
8185 returned by the lookup is not used.
8186
8187 .cindex "IP address" "masking"
8188 .cindex "host list" "masked IP address"
8189 Single-key lookups can also be performed using masked IP addresses, using
8190 patterns of this form:
8191 .display
8192 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8193 .endd
8194 For example:
8195 .code
8196 net24-dbm;/networks.db
8197 .endd
8198 The IP address of the subject host is masked using <&'number'&> as the mask
8199 length. A textual string is constructed from the masked value, followed by the
8200 mask, and this is used as the lookup key. For example, if the host's IP address
8201 is 192.168.34.6, the key that is looked up for the above example is
8202 &"192.168.34.0/24"&.
8203
8204 When an IPv6 address is converted to a string, dots are normally used instead
8205 of colons, so that keys in &(lsearch)& files need not contain colons (which
8206 terminate &(lsearch)& keys). This was implemented some time before the ability
8207 to quote keys was made available in &(lsearch)& files. However, the more
8208 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8209 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8210 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8211 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8212 addresses are always used.
8213
8214 Ideally, it would be nice to tidy up this anomalous situation by changing to
8215 colons in all cases, given that quoting is now available for &(lsearch)&.
8216 However, this would be an incompatible change that might break some existing
8217 configurations.
8218
8219 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8220 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8221 the former case the key strings include the mask value, whereas in the latter
8222 case the IP address is used on its own.
8223
8224
8225
8226 .section "Host list patterns that match by host name" "SECThoslispatnam"
8227 .cindex "host" "lookup failures"
8228 .cindex "unknown host name"
8229 .cindex "host list" "matching host name"
8230 There are several types of pattern that require Exim to know the name of the
8231 remote host. These are either wildcard patterns or lookups by name. (If a
8232 complete hostname is given without any wildcarding, it is used to find an IP
8233 address to match against, as described in section &<<SECThoslispatip>>&
8234 above.)
8235
8236 If the remote host name is not already known when Exim encounters one of these
8237 patterns, it has to be found from the IP address.
8238 Although many sites on the Internet are conscientious about maintaining reverse
8239 DNS data for their hosts, there are also many that do not do this.
8240 Consequently, a name cannot always be found, and this may lead to unwanted
8241 effects. Take care when configuring host lists with wildcarded name patterns.
8242 Consider what will happen if a name cannot be found.
8243
8244 Because of the problems of determining host names from IP addresses, matching
8245 against host names is not as common as matching against IP addresses.
8246
8247 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8248 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8249 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8250 are done can be changed by setting the &%host_lookup_order%& option. For
8251 security, once Exim has found one or more names, it looks up the IP addresses
8252 for these names and compares them with the IP address that it started with.
8253 Only those names whose IP addresses match are accepted. Any other names are
8254 discarded. If no names are left, Exim behaves as if the host name cannot be
8255 found. In the most common case there is only one name and one IP address.
8256
8257 There are some options that control what happens if a host name cannot be
8258 found. These are described in section &<<SECTbehipnot>>& below.
8259
8260 .cindex "host" "alias for"
8261 .cindex "alias for host"
8262 As a result of aliasing, hosts may have more than one name. When processing any
8263 of the following types of pattern, all the host's names are checked:
8264
8265 .ilist
8266 .cindex "asterisk" "in host list"
8267 If a pattern starts with &"*"& the remainder of the item must match the end of
8268 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8269 &'.b.c'&. This special simple form is provided because this is a very common
8270 requirement. Other kinds of wildcarding require the use of a regular
8271 expression.
8272 .next
8273 .cindex "regular expressions" "in host list"
8274 .cindex "host list" "regular expression in"
8275 If the item starts with &"^"& it is taken to be a regular expression which is
8276 matched against the host name. Host names are case-independent, so this regular
8277 expression match is by default case-independent, but you can make it
8278 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8279 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8280 example,
8281 .code
8282 ^(a|b)\.c\.d$
8283 .endd
8284 is a regular expression that matches either of the two hosts &'a.c.d'& or
8285 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8286 that backslash and dollar characters are not misinterpreted as part of the
8287 string expansion. The simplest way to do this is to use &`\N`& to mark that
8288 part of the string as non-expandable. For example:
8289 .code
8290 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8291 .endd
8292 &*Warning*&: If you want to match a complete host name, you must include the
8293 &`$`& terminating metacharacter in the regular expression, as in the above
8294 example. Without it, a match at the start of the host name is all that is
8295 required.
8296 .endlist
8297
8298
8299
8300
8301 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8302 .cindex "host" "lookup failures, permanent"
8303 While processing a host list, Exim may need to look up an IP address from a
8304 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8305 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8306 behaviour when it fails to find the information it is seeking is the same.
8307
8308 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8309 apply to temporary DNS errors, whose handling is described in the next section.
8310
8311 .cindex "&`+include_unknown`&"
8312 .cindex "&`+ignore_unknown`&"
8313 Exim parses a host list from left to right. If it encounters a permanent
8314 lookup failure in any item in the host list before it has found a match,
8315 Exim treats it as a failure and the default behavior is as if the host
8316 does not match the list. This may not always be what you want to happen.
8317 To change Exim's behaviour, the special items &`+include_unknown`& or
8318 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8319 not recognized in an indirected file).
8320
8321 .ilist
8322 If any item that follows &`+include_unknown`& requires information that
8323 cannot found, Exim behaves as if the host does match the list. For example,
8324 .code
8325 host_reject_connection = +include_unknown:*.enemy.ex
8326 .endd
8327 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8328 any hosts whose name it cannot find.
8329
8330 .next
8331 If any item that follows &`+ignore_unknown`& requires information that cannot
8332 be found, Exim ignores that item and proceeds to the rest of the list. For
8333 example:
8334 .code
8335 accept hosts = +ignore_unknown : friend.example : \
8336                192.168.4.5
8337 .endd
8338 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8339 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8340 name can be found for 192.168.4.5, it is rejected.
8341 .endlist
8342
8343 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8344 list. The effect of each one lasts until the next, or until the end of the
8345 list.
8346
8347 .new
8348 .section "Mixing wildcarded host names and addresses in host lists" &&&
8349          "SECTmixwilhos"
8350 .cindex "host list" "mixing names and addresses in"
8351
8352 This section explains the host/ip processing logic with the same concepts
8353 as the previous section, but specifically addresses what happens when a
8354 wildcarded hostname is one of the items in the hostlist.
8355
8356 .ilist
8357 If you have name lookups or wildcarded host names and
8358 IP addresses in the same host list, you should normally put the IP
8359 addresses first. For example, in an ACL you could have:
8360 .code
8361 accept hosts = 10.9.8.7 : *.friend.example
8362 .endd
8363 The reason you normally would order it this way lies in the
8364 left-to-right way that Exim processes lists.  It can test IP addresses
8365 without doing any DNS lookups, but when it reaches an item that requires
8366 a host name, it fails if it cannot find a host name to compare with the
8367 pattern. If the above list is given in the opposite order, the
8368 &%accept%& statement fails for a host whose name cannot be found, even
8369 if its IP address is 10.9.8.7.
8370
8371 .next
8372 If you really do want to do the name check first, and still recognize the IP
8373 address, you can rewrite the ACL like this:
8374 .code
8375 accept hosts = *.friend.example
8376 accept hosts = 10.9.8.7
8377 .endd
8378 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8379 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8380 &`+ignore_unknown`&, which was discussed in depth in the first example in
8381 this section.
8382 .endlist
8383 .wen
8384
8385
8386 .section "Temporary DNS errors when looking up host information" &&&
8387          "SECTtemdnserr"
8388 .cindex "host" "lookup failures, temporary"
8389 .cindex "&`+include_defer`&"
8390 .cindex "&`+ignore_defer`&"
8391 A temporary DNS lookup failure normally causes a defer action (except when
8392 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8393 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8394 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8395 section. These options should be used with care, probably only in non-critical
8396 host lists such as whitelists.
8397
8398
8399
8400 .section "Host list patterns for single-key lookups by host name" &&&
8401          "SECThoslispatnamsk"
8402 .cindex "unknown host name"
8403 .cindex "host list" "matching host name"
8404 If a pattern is of the form
8405 .display
8406 <&'single-key-search-type'&>;<&'search-data'&>
8407 .endd
8408 for example
8409 .code
8410 dbm;/host/accept/list
8411 .endd
8412 a single-key lookup is performed, using the host name as its key. If the
8413 lookup succeeds, the host matches the item. The actual data that is looked up
8414 is not used.
8415
8416 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8417 keys in the file, not IP addresses. If you want to do lookups based on IP
8418 addresses, you must precede the search type with &"net-"& (see section
8419 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8420 two items in the same list, one doing an address lookup and one doing a name
8421 lookup, both using the same file.
8422
8423
8424
8425 .section "Host list patterns for query-style lookups" "SECID81"
8426 If a pattern is of the form
8427 .display
8428 <&'query-style-search-type'&>;<&'query'&>
8429 .endd
8430 the query is obeyed, and if it succeeds, the host matches the item. The actual
8431 data that is looked up is not used. The variables &$sender_host_address$& and
8432 &$sender_host_name$& can be used in the query. For example:
8433 .code
8434 hosts_lookup = pgsql;\
8435   select ip from hostlist where ip='$sender_host_address'
8436 .endd
8437 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8438 can use the &%sg%& expansion item to change this if you need to. If you want to
8439 use masked IP addresses in database queries, you can use the &%mask%& expansion
8440 operator.
8441
8442 If the query contains a reference to &$sender_host_name$&, Exim automatically
8443 looks up the host name if it has not already done so. (See section
8444 &<<SECThoslispatnam>>& for comments on finding host names.)
8445
8446 Historical note: prior to release 4.30, Exim would always attempt to find a
8447 host name before running the query, unless the search type was preceded by
8448 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8449 still recognized for query-style lookups, but its presence or absence has no
8450 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8451 See section &<<SECThoslispatsikey>>&.)
8452
8453
8454
8455
8456
8457 .section "Address lists" "SECTaddresslist"
8458 .cindex "list" "address list"
8459 .cindex "address list" "empty item"
8460 .cindex "address list" "patterns"
8461 Address lists contain patterns that are matched against mail addresses. There
8462 is one special case to be considered: the sender address of a bounce message is
8463 always empty. You can test for this by providing an empty item in an address
8464 list. For example, you can set up a router to process bounce messages by
8465 using this option setting:
8466 .code
8467 senders = :
8468 .endd
8469 The presence of the colon creates an empty item. If you do not provide any
8470 data, the list is empty and matches nothing. The empty sender can also be
8471 detected by a regular expression that matches an empty string,
8472 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8473
8474 Non-empty items in an address list can be straightforward email addresses. For
8475 example:
8476 .code
8477 senders = jbc@askone.example : hs@anacreon.example
8478 .endd
8479 A certain amount of wildcarding is permitted. If a pattern contains an @
8480 character, but is not a regular expression and does not begin with a
8481 semicolon-terminated lookup type (described below), the local part of the
8482 subject address is compared with the local part of the pattern, which may start
8483 with an asterisk. If the local parts match, the domain is checked in exactly
8484 the same way as for a pattern in a domain list. For example, the domain can be
8485 wildcarded, refer to a named list, or be a lookup:
8486 .code
8487 deny senders = *@*.spamming.site:\
8488                *@+hostile_domains:\
8489                bozo@partial-lsearch;/list/of/dodgy/sites:\
8490                *@dbm;/bad/domains.db
8491 .endd
8492 .cindex "local part" "starting with !"
8493 .cindex "address list" "local part starting with !"
8494 If a local part that begins with an exclamation mark is required, it has to be
8495 specified using a regular expression, because otherwise the exclamation mark is
8496 treated as a sign of negation, as is standard in lists.
8497
8498 If a non-empty pattern that is not a regular expression or a lookup does not
8499 contain an @ character, it is matched against the domain part of the subject
8500 address. The only two formats that are recognized this way are a literal
8501 domain, or a domain pattern that starts with *. In both these cases, the effect
8502 is the same as if &`*@`& preceded the pattern. For example:
8503 .code
8504 deny senders = enemy.domain : *.enemy.domain
8505 .endd
8506
8507 The following kinds of more complicated address list pattern can match any
8508 address, including the empty address that is characteristic of bounce message
8509 senders:
8510
8511 .ilist
8512 .cindex "regular expressions" "in address list"
8513 .cindex "address list" "regular expression in"
8514 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8515 done against the complete address, with the pattern as the regular expression.
8516 You must take care that backslash and dollar characters are not misinterpreted
8517 as part of the string expansion. The simplest way to do this is to use &`\N`&
8518 to mark that part of the string as non-expandable. For example:
8519 .code
8520 deny senders = \N^.*this.*@example\.com$\N : \
8521                \N^\d{8}.+@spamhaus.example$\N : ...
8522 .endd
8523 The &`\N`& sequences are removed by the expansion, so these items do indeed
8524 start with &"^"& by the time they are being interpreted as address patterns.
8525
8526 .next
8527 .cindex "address list" "lookup for complete address"
8528 Complete addresses can be looked up by using a pattern that starts with a
8529 lookup type terminated by a semicolon, followed by the data for the lookup. For
8530 example:
8531 .code
8532 deny senders = cdb;/etc/blocked.senders : \
8533   mysql;select address from blocked where \
8534   address='${quote_mysql:$sender_address}'
8535 .endd
8536 Both query-style and single-key lookup types can be used. For a single-key
8537 lookup type, Exim uses the complete address as the key. However, empty keys are
8538 not supported for single-key lookups, so a match against the empty address
8539 always fails. This restriction does not apply to query-style lookups.
8540
8541 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8542 cannot be used, and is ignored if specified, with an entry being written to the
8543 panic log.
8544 .cindex "*@ with single-key lookup"
8545 However, you can configure lookup defaults, as described in section
8546 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8547 default. For example, with this lookup:
8548 .code
8549 accept senders = lsearch*@;/some/file
8550 .endd
8551 the file could contains lines like this:
8552 .code
8553 user1@domain1.example
8554 *@domain2.example
8555 .endd
8556 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8557 that are tried is:
8558 .code
8559 nimrod@jaeger.example
8560 *@jaeger.example
8561 *
8562 .endd
8563 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8564 would mean that every address matches, thus rendering the test useless.
8565
8566 &*Warning 2*&: Do not confuse these two kinds of item:
8567 .code
8568 deny recipients = dbm*@;/some/file
8569 deny recipients = *@dbm;/some/file
8570 .endd
8571 The first does a whole address lookup, with defaulting, as just described,
8572 because it starts with a lookup type. The second matches the local part and
8573 domain independently, as described in a bullet point below.
8574 .endlist
8575
8576
8577 The following kinds of address list pattern can match only non-empty addresses.
8578 If the subject address is empty, a match against any of these pattern types
8579 always fails.
8580
8581
8582 .ilist
8583 .cindex "@@ with single-key lookup"
8584 .cindex "address list" "@@ lookup type"
8585 .cindex "address list" "split local part and domain"
8586 If a pattern starts with &"@@"& followed by a single-key lookup item
8587 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8588 split into a local part and a domain. The domain is looked up in the file. If
8589 it is not found, there is no match. If it is found, the data that is looked up
8590 from the file is treated as a colon-separated list of local part patterns, each
8591 of which is matched against the subject local part in turn.
8592
8593 .cindex "asterisk" "in address list"
8594 The lookup may be a partial one, and/or one involving a search for a default
8595 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8596 patterns that are looked up can be regular expressions or begin with &"*"&, or
8597 even be further lookups. They may also be independently negated. For example,
8598 with
8599 .code
8600 deny senders = @@dbm;/etc/reject-by-domain
8601 .endd
8602 the data from which the DBM file is built could contain lines like
8603 .code
8604 baddomain.com:  !postmaster : *
8605 .endd
8606 to reject all senders except &%postmaster%& from that domain.
8607
8608 .cindex "local part" "starting with !"
8609 If a local part that actually begins with an exclamation mark is required, it
8610 has to be specified using a regular expression. In &(lsearch)& files, an entry
8611 may be split over several lines by indenting the second and subsequent lines,
8612 but the separating colon must still be included at line breaks. White space
8613 surrounding the colons is ignored. For example:
8614 .code
8615 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8616   spammer3 : spammer4
8617 .endd
8618 As in all colon-separated lists in Exim, a colon can be included in an item by
8619 doubling.
8620
8621 If the last item in the list starts with a right angle-bracket, the remainder
8622 of the item is taken as a new key to look up in order to obtain a continuation
8623 list of local parts. The new key can be any sequence of characters. Thus one
8624 might have entries like
8625 .code
8626 aol.com: spammer1 : spammer 2 : >*
8627 xyz.com: spammer3 : >*
8628 *:       ^\d{8}$
8629 .endd
8630 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8631 local parts for all domains, in addition to the specific local parts listed for
8632 each domain. Of course, using this feature costs another lookup each time a
8633 chain is followed, but the effort needed to maintain the data is reduced.
8634
8635 .cindex "loop" "in lookups"
8636 It is possible to construct loops using this facility, and in order to catch
8637 them, the chains may be no more than fifty items long.
8638
8639 .next
8640 The @@<&'lookup'&> style of item can also be used with a query-style
8641 lookup, but in this case, the chaining facility is not available. The lookup
8642 can only return a single list of local parts.
8643 .endlist
8644
8645 &*Warning*&: There is an important difference between the address list items
8646 in these two examples:
8647 .code
8648 senders = +my_list
8649 senders = *@+my_list
8650 .endd
8651 In the first one, &`my_list`& is a named address list, whereas in the second
8652 example it is a named domain list.
8653
8654
8655
8656
8657 .section "Case of letters in address lists" "SECTcasletadd"
8658 .cindex "case of local parts"
8659 .cindex "address list" "case forcing"
8660 .cindex "case forcing in address lists"
8661 Domains in email addresses are always handled caselessly, but for local parts
8662 case may be significant on some systems (see &%caseful_local_part%& for how
8663 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8664 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8665 blocking lists should be done in a case-independent manner. Since most address
8666 lists in Exim are used for this kind of control, Exim attempts to do this by
8667 default.
8668
8669 The domain portion of an address is always lowercased before matching it to an
8670 address list. The local part is lowercased by default, and any string
8671 comparisons that take place are done caselessly. This means that the data in
8672 the address list itself, in files included as plain file names, and in any file
8673 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8674 keys in files that are looked up by a search type other than &(lsearch)& (which
8675 works caselessly) must be in lower case, because these lookups are not
8676 case-independent.
8677
8678 .cindex "&`+caseful`&"
8679 To allow for the possibility of caseful address list matching, if an item in
8680 an address list is the string &"+caseful"&, the original case of the local
8681 part is restored for any comparisons that follow, and string comparisons are no
8682 longer case-independent. This does not affect the domain, which remains in
8683 lower case. However, although independent matches on the domain alone are still
8684 performed caselessly, regular expressions that match against an entire address
8685 become case-sensitive after &"+caseful"& has been seen.
8686
8687
8688
8689 .section "Local part lists" "SECTlocparlis"
8690 .cindex "list" "local part list"
8691 .cindex "local part" "list"
8692 Case-sensitivity in local part lists is handled in the same way as for address
8693 lists, as just described. The &"+caseful"& item can be used if required. In a
8694 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8695 set false, the subject is lowercased and the matching is initially
8696 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8697 matching in the local part list, but not elsewhere in the router. If
8698 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8699 option is case-sensitive from the start.
8700
8701 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8702 comments are handled in the same way as address lists &-- they are recognized
8703 only if the # is preceded by white space or the start of the line.
8704 Otherwise, local part lists are matched in the same way as domain lists, except
8705 that the special items that refer to the local host (&`@`&, &`@[]`&,
8706 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8707 Refer to section &<<SECTdomainlist>>& for details of the other available item
8708 types.
8709 .ecindex IIDdohoadli
8710
8711
8712
8713
8714 . ////////////////////////////////////////////////////////////////////////////
8715 . ////////////////////////////////////////////////////////////////////////////
8716
8717 .chapter "String expansions" "CHAPexpand"
8718 .scindex IIDstrexp "expansion" "of strings"
8719 Many strings in Exim's run time configuration are expanded before use. Some of
8720 them are expanded every time they are used; others are expanded only once.
8721
8722 When a string is being expanded it is copied verbatim from left to right except
8723 when a dollar or backslash character is encountered. A dollar specifies the
8724 start of a portion of the string that is interpreted and replaced as described
8725 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8726 escape character, as described in the following section.
8727
8728 Whether a string is expanded depends upon the context.  Usually this is solely
8729 dependent upon the option for which a value is sought; in this documentation,
8730 options for which string expansion is performed are marked with &dagger; after
8731 the data type.  ACL rules always expand strings.  A couple of expansion
8732 conditions do not expand some of the brace-delimited branches, for security
8733 reasons.
8734
8735
8736
8737 .section "Literal text in expanded strings" "SECTlittext"
8738 .cindex "expansion" "including literal text"
8739 An uninterpreted dollar can be included in an expanded string by putting a
8740 backslash in front of it. A backslash can be used to prevent any special
8741 character being treated specially in an expansion, including backslash itself.
8742 If the string appears in quotes in the configuration file, two backslashes are
8743 required because the quotes themselves cause interpretation of backslashes when
8744 the string is read in (see section &<<SECTstrings>>&).
8745
8746 .cindex "expansion" "non-expandable substrings"
8747 A portion of the string can specified as non-expandable by placing it between
8748 two occurrences of &`\N`&. This is particularly useful for protecting regular
8749 expressions, which often contain backslashes and dollar signs. For example:
8750 .code
8751 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8752 .endd
8753 On encountering the first &`\N`&, the expander copies subsequent characters
8754 without interpretation until it reaches the next &`\N`& or the end of the
8755 string.
8756
8757
8758
8759 .section "Character escape sequences in expanded strings" "SECID82"
8760 .cindex "expansion" "escape sequences"
8761 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8762 expanded string is recognized as an escape sequence for the character newline,
8763 carriage return, or tab, respectively. A backslash followed by up to three
8764 octal digits is recognized as an octal encoding for a single character, and a
8765 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8766 encoding.
8767
8768 These escape sequences are also recognized in quoted strings when they are read
8769 in. Their interpretation in expansions as well is useful for unquoted strings,
8770 and for other cases such as looked-up strings that are then expanded.
8771
8772
8773 .section "Testing string expansions" "SECID83"
8774 .cindex "expansion" "testing"
8775 .cindex "testing" "string expansion"
8776 .oindex "&%-be%&"
8777 Many expansions can be tested by calling Exim with the &%-be%& option. This
8778 takes the command arguments, or lines from the standard input if there are no
8779 arguments, runs them through the string expansion code, and writes the results
8780 to the standard output. Variables based on configuration values are set up, but
8781 since no message is being processed, variables such as &$local_part$& have no
8782 value. Nevertheless the &%-be%& option can be useful for checking out file and
8783 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8784 and &%nhash%&.
8785
8786 Exim gives up its root privilege when it is called with the &%-be%& option, and
8787 instead runs under the uid and gid it was called with, to prevent users from
8788 using &%-be%& for reading files to which they do not have access.
8789
8790 .oindex "&%-bem%&"
8791 If you want to test expansions that include variables whose values are taken
8792 from a message, there are two other options that can be used. The &%-bem%&
8793 option is like &%-be%& except that it is followed by a file name. The file is
8794 read as a message before doing the test expansions. For example:
8795 .code
8796 exim -bem /tmp/test.message '$h_subject:'
8797 .endd
8798 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8799 Exim message identifier. For example:
8800 .code
8801 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8802 .endd
8803 This loads the message from Exim's spool before doing the test expansions, and
8804 is therefore restricted to admin users.
8805
8806
8807 .section "Forced expansion failure" "SECTforexpfai"
8808 .cindex "expansion" "forced failure"
8809 A number of expansions that are described in the following section have
8810 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8811 (which are sometimes called &"curly brackets"&). Which of the two strings is
8812 used depends on some condition that is evaluated as part of the expansion. If,
8813 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8814 the entire string expansion fails in a way that can be detected by the code
8815 that requested the expansion. This is called &"forced expansion failure"&, and
8816 its consequences depend on the circumstances. In some cases it is no different
8817 from any other expansion failure, but in others a different action may be
8818 taken. Such variations are mentioned in the documentation of the option that is
8819 being expanded.
8820
8821
8822
8823
8824 .section "Expansion items" "SECTexpansionitems"
8825 The following items are recognized in expanded strings. White space may be used
8826 between sub-items that are keywords or substrings enclosed in braces inside an
8827 outer set of braces, to improve readability. &*Warning*&: Within braces,
8828 white space is significant.
8829
8830 .vlist
8831 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8832 .cindex "expansion" "variables"
8833 Substitute the contents of the named variable, for example:
8834 .code
8835 $local_part
8836 ${domain}
8837 .endd
8838 The second form can be used to separate the name from subsequent alphanumeric
8839 characters. This form (using braces) is available only for variables; it does
8840 &'not'& apply to message headers. The names of the variables are given in
8841 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8842 given, the expansion fails.
8843
8844 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8845 .cindex "expansion" "operators"
8846 The string is first itself expanded, and then the operation specified by
8847 <&'op'&> is applied to it. For example:
8848 .code
8849 ${lc:$local_part}
8850 .endd
8851 The string starts with the first character after the colon, which may be
8852 leading white space. A list of operators is given in section &<<SECTexpop>>&
8853 below. The operator notation is used for simple expansion items that have just
8854 one argument, because it reduces the number of braces and therefore makes the
8855 string easier to understand.
8856
8857 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8858 This item inserts &"basic"& header lines. It is described with the &%header%&
8859 expansion item below.
8860
8861
8862 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8863 .cindex "expansion" "calling an acl"
8864 .cindex "&%acl%&" "call from expansion"
8865 The name and zero to nine argument strings are first expanded separately.  The expanded
8866 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8867 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8868 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8869 and may use the variables; if another acl expansion is used the values
8870 are restored after it returns.  If the ACL sets
8871 a value using a "message =" modifier and returns accept or deny, the value becomes
8872 the result of the expansion.
8873 If no message is set and the ACL returns accept or deny
8874 the expansion result is an empty string.
8875 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8876
8877
8878 .new
8879 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8880        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8881 .cindex "expansion" "extracting cerificate fields"
8882 .cindex "&%certextract%&" "certificate fields"
8883 .cindex "certificate" "extracting fields"
8884 The <&'certificate'&> must be a variable of type certificate.
8885 The field name is expanded and used to retrive the relevant field from
8886 the certificate.  Supported fields are:
8887 .display
8888 version
8889 serial_number
8890 subject
8891 issuer
8892 notbefore
8893 notafter
8894 signature_algorithm
8895 signature
8896 subject_altname
8897 ocsp_uri
8898 crl_uri
8899 .endd
8900 If the field is found,
8901 <&'string2'&> is expanded, and replaces the whole item;
8902 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8903 variable &$value$& contains the value that has been extracted. Afterwards, it
8904 is restored to any previous value it might have had.
8905
8906 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8907 key is not found. If {<&'string2'&>} is also omitted, the value that was
8908 extracted is used.
8909
8910 Field values are presented in human-readable form.
8911 .wen
8912
8913 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8914        {*&<&'arg'&>&*}...}*&"
8915 .cindex &%dlfunc%&
8916 This expansion dynamically loads and then calls a locally-written C function.
8917 This functionality is available only if Exim is compiled with
8918 .code
8919 EXPAND_DLFUNC=yes
8920 .endd
8921 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8922 object so that it doesn't reload the same object file in the same Exim process
8923 (but of course Exim does start new processes frequently).
8924
8925 There may be from zero to eight arguments to the function. When compiling
8926 a local function that is to be called in this way, &_local_scan.h_& should be
8927 included. The Exim variables and functions that are defined by that API
8928 are also available for dynamically loaded functions. The function itself
8929 must have the following type:
8930 .code
8931 int dlfunction(uschar **yield, int argc, uschar *argv[])
8932 .endd
8933 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8934 function should return one of the following values:
8935
8936 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8937 into the expanded string that is being built.
8938
8939 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8940 from &'yield'&, if it is set.
8941
8942 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8943 taken from &'yield'& if it is set.
8944
8945 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8946
8947 When compiling a function that is to be used in this way with gcc,
8948 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8949 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8950
8951 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8952        {*&<&'string3'&>&*}}*&"
8953 .cindex "expansion" "extracting substrings by key"
8954 .cindex "&%extract%&" "substrings by key"
8955 The key and <&'string1'&> are first expanded separately. Leading and trailing
8956 white space is removed from the key (but not from any of the strings). The key
8957 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8958 form:
8959 .display
8960 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8961 .endd
8962 .vindex "&$value$&"
8963 where the equals signs and spaces (but not both) are optional. If any of the
8964 values contain white space, they must be enclosed in double quotes, and any
8965 values that are enclosed in double quotes are subject to escape processing as
8966 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8967 for the value that corresponds to the key. The search is case-insensitive. If
8968 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8969 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8970 variable &$value$& contains the value that has been extracted. Afterwards, it
8971 is restored to any previous value it might have had.
8972
8973 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8974 key is not found. If {<&'string2'&>} is also omitted, the value that was
8975 extracted is used. Thus, for example, these two expansions are identical, and
8976 yield &"2001"&:
8977 .code
8978 ${extract{gid}{uid=1984 gid=2001}}
8979 ${extract{gid}{uid=1984 gid=2001}{$value}}
8980 .endd
8981 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8982 appear, for example:
8983 .code
8984 ${extract{Z}{A=... B=...}{$value} fail }
8985 .endd
8986 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8987 {<&'string2'&>} must be present for &"fail"& to be recognized.
8988
8989
8990 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8991         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8992 .cindex "expansion" "extracting substrings by number"
8993 .cindex "&%extract%&" "substrings by number"
8994 The <&'number'&> argument must consist entirely of decimal digits,
8995 apart from leading and trailing white space, which is ignored.
8996 This is what distinguishes this form of &%extract%& from the previous kind. It
8997 behaves in the same way, except that, instead of extracting a named field, it
8998 extracts from <&'string1'&> the field whose number is given as the first
8999 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9000 <&'string3'&> as before.
9001
9002 The fields in the string are separated by any one of the characters in the
9003 separator string. These may include space or tab characters.
9004 The first field is numbered one. If the number is negative, the fields are
9005 counted from the end of the string, with the rightmost one numbered -1. If the
9006 number given is zero, the entire string is returned. If the modulus of the
9007 number is greater than the number of fields in the string, the result is the
9008 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9009 provided. For example:
9010 .code
9011 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9012 .endd
9013 yields &"42"&, and
9014 .code
9015 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9016 .endd
9017 yields &"99"&. Two successive separators mean that the field between them is
9018 empty (for example, the fifth field above).
9019
9020
9021 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9022 .cindex "list" "selecting by condition"
9023 .cindex "expansion" "selecting from list by condition"
9024 .vindex "&$item$&"
9025 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9026 default, but the separator can be changed in the usual way. For each item
9027 in this list, its value is place in &$item$&, and then the condition is
9028 evaluated. If the condition is true, &$item$& is added to the output as an
9029 item in a new list; if the condition is false, the item is discarded. The
9030 separator used for the output list is the same as the one used for the
9031 input, but a separator setting is not included in the output. For example:
9032 .code
9033 ${filter{a:b:c}{!eq{$item}{b}}
9034 .endd
9035 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9036 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9037
9038
9039 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9040 .cindex "hash function" "textual"
9041 .cindex "expansion" "textual hash"
9042 This is a textual hashing function, and was the first to be implemented in
9043 early versions of Exim. In current releases, there are other hashing functions
9044 (numeric, MD5, and SHA-1), which are described below.
9045
9046 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9047 <&'n'&>. If you are using fixed values for these numbers, that is, if
9048 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9049 use the simpler operator notation that avoids some of the braces:
9050 .code
9051 ${hash_<n>_<m>:<string>}
9052 .endd
9053 The second number is optional (in both notations). If <&'n'&> is greater than
9054 or equal to the length of the string, the expansion item returns the string.
9055 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9056 function to the string. The new string consists of characters taken from the
9057 first <&'m'&> characters of the string
9058 .code
9059 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9060 .endd
9061 If <&'m'&> is not present the value 26 is used, so that only lower case
9062 letters appear. For example:
9063 .display
9064 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9065 &`$hash{5}{monty}}           `&   yields  &`monty`&
9066 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9067 .endd
9068
9069 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9070         &*$h_*&<&'header&~name'&>&*:*&" &&&
9071        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9072         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9073        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9074         &*$rh_*&<&'header&~name'&>&*:*&"
9075 .cindex "expansion" "header insertion"
9076 .vindex "&$header_$&"
9077 .vindex "&$bheader_$&"
9078 .vindex "&$rheader_$&"
9079 .cindex "header lines" "in expansion strings"
9080 .cindex "header lines" "character sets"
9081 .cindex "header lines" "decoding"
9082 Substitute the contents of the named message header line, for example
9083 .code
9084 $header_reply-to:
9085 .endd
9086 The newline that terminates a header line is not included in the expansion, but
9087 internal newlines (caused by splitting the header line over several physical
9088 lines) may be present.
9089
9090 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9091 the data in the header line is interpreted.
9092
9093 .ilist
9094 .cindex "white space" "in header lines"
9095 &%rheader%& gives the original &"raw"& content of the header line, with no
9096 processing at all, and without the removal of leading and trailing white space.
9097
9098 .next
9099 .cindex "base64 encoding" "in header lines"
9100 &%bheader%& removes leading and trailing white space, and then decodes base64
9101 or quoted-printable MIME &"words"& within the header text, but does no
9102 character set translation. If decoding of what looks superficially like a MIME
9103 &"word"& fails, the raw string is returned. If decoding
9104 .cindex "binary zero" "in header line"
9105 produces a binary zero character, it is replaced by a question mark &-- this is
9106 what Exim does for binary zeros that are actually received in header lines.
9107
9108 .next
9109 &%header%& tries to translate the string as decoded by &%bheader%& to a
9110 standard character set. This is an attempt to produce the same string as would
9111 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9112 returned. Translation is attempted only on operating systems that support the
9113 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9114 a system Makefile or in &_Local/Makefile_&.
9115 .endlist ilist
9116
9117 In a filter file, the target character set for &%header%& can be specified by a
9118 command of the following form:
9119 .code
9120 headers charset "UTF-8"
9121 .endd
9122 This command affects all references to &$h_$& (or &$header_$&) expansions in
9123 subsequently obeyed filter commands. In the absence of this command, the target
9124 character set in a filter is taken from the setting of the &%headers_charset%&
9125 option in the runtime configuration. The value of this option defaults to the
9126 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9127 ISO-8859-1.
9128
9129 Header names follow the syntax of RFC 2822, which states that they may contain
9130 any printing characters except space and colon. Consequently, curly brackets
9131 &'do not'& terminate header names, and should not be used to enclose them as
9132 if they were variables. Attempting to do so causes a syntax error.
9133
9134 Only header lines that are common to all copies of a message are visible to
9135 this mechanism. These are the original header lines that are received with the
9136 message, and any that are added by an ACL statement or by a system
9137 filter. Header lines that are added to a particular copy of a message by a
9138 router or transport are not accessible.
9139
9140 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9141 before the DATA ACL, because the header structure is not set up until the
9142 message is received. Header lines that are added in a RCPT ACL (for example)
9143 are saved until the message's incoming header lines are available, at which
9144 point they are added. When a DATA ACL is running, however, header lines added
9145 by earlier ACLs are visible.
9146
9147 Upper case and lower case letters are synonymous in header names. If the
9148 following character is white space, the terminating colon may be omitted, but
9149 this is not recommended, because you may then forget it when it is needed. When
9150 white space terminates the header name, it is included in the expanded string.
9151 If the message does not contain the given header, the expansion item is
9152 replaced by an empty string. (See the &%def%& condition in section
9153 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9154
9155 If there is more than one header with the same name, they are all concatenated
9156 to form the substitution string, up to a maximum length of 64K. Unless
9157 &%rheader%& is being used, leading and trailing white space is removed from
9158 each header before concatenation, and a completely empty header is ignored. A
9159 newline character is then inserted between non-empty headers, but there is no
9160 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9161 those headers that contain lists of addresses, a comma is also inserted at the
9162 junctions between headers. This does not happen for the &%rheader%& expansion.
9163
9164
9165 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9166 .cindex "expansion" "hmac hashing"
9167 .cindex &%hmac%&
9168 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9169 shared secret and some text into a message authentication code, as specified in
9170 RFC 2104. This differs from &`${md5:secret_text...}`& or
9171 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9172 cryptographic hash, allowing for authentication that is not possible with MD5
9173 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9174 present. For example:
9175 .code
9176 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9177 .endd
9178 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9179 produces:
9180 .code
9181 dd97e3ba5d1a61b5006108f8c8252953
9182 .endd
9183 As an example of how this might be used, you might put in the main part of
9184 an Exim configuration:
9185 .code
9186 SPAMSCAN_SECRET=cohgheeLei2thahw
9187 .endd
9188 In a router or a transport you could then have:
9189 .code
9190 headers_add = \
9191   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9192   ${hmac{md5}{SPAMSCAN_SECRET}\
9193   {${primary_hostname},${message_exim_id},$h_message-id:}}
9194 .endd
9195 Then given a message, you can check where it was scanned by looking at the
9196 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9197 this header line is authentic by recomputing the authentication code from the
9198 host name, message ID and the &'Message-id:'& header line. This can be done
9199 using Exim's &%-be%& option, or by other means, for example by using the
9200 &'hmac_md5_hex()'& function in Perl.
9201
9202
9203 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9204 .cindex "expansion" "conditional"
9205 .cindex "&%if%&, expansion item"
9206 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9207 item; otherwise <&'string2'&> is used. The available conditions are described
9208 in section &<<SECTexpcond>>& below. For example:
9209 .code
9210 ${if eq {$local_part}{postmaster} {yes}{no} }
9211 .endd
9212 The second string need not be present; if it is not and the condition is not
9213 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9214 be present instead of the second string (without any curly brackets). In this
9215 case, the expansion is forced to fail if the condition is not true (see section
9216 &<<SECTforexpfai>>&).
9217
9218 If both strings are omitted, the result is the string &`true`& if the condition
9219 is true, and the empty string if the condition is false. This makes it less
9220 cumbersome to write custom ACL and router conditions. For example, instead of
9221 .code
9222 condition = ${if >{$acl_m4}{3}{true}{false}}
9223 .endd
9224 you can use
9225 .code
9226 condition = ${if >{$acl_m4}{3}}
9227 .endd
9228
9229 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9230 .cindex "expansion" "string truncation"
9231 .cindex "&%length%& expansion item"
9232 The &%length%& item is used to extract the initial portion of a string. Both
9233 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9234 you are using a fixed value for the number, that is, if <&'string1'&> does not
9235 change when expanded, you can use the simpler operator notation that avoids
9236 some of the braces:
9237 .code
9238 ${length_<n>:<string>}
9239 .endd
9240 The result of this item is either the first <&'n'&> characters or the whole
9241 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9242 &%strlen%&, which gives the length of a string.
9243
9244
9245 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9246         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9247 .cindex "expansion" "extracting list elements by number"
9248 .cindex "&%listextract%&" "extract list elements by number"
9249 .cindex "list" "extracting elements by number"
9250 The <&'number'&> argument must consist entirely of decimal digits,
9251 apart from an optional leading minus,
9252 and leading and trailing white space (which is ignored).
9253
9254 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9255 default, but the separator can be changed in the usual way.
9256
9257 The first field of the list is numbered one.
9258 If the number is negative, the fields are
9259 counted from the end of the list, with the rightmost one numbered -1.
9260 The numbered element of the list is extracted and placed in &$value$&,
9261 then <&'string2'&> is expanded as the result.
9262
9263 If the modulus of the
9264 number is zero or greater than the number of fields in the string,
9265 the result is the expansion of <&'string3'&>.
9266
9267 For example:
9268 .code
9269 ${listextract{2}{x:42:99}}
9270 .endd
9271 yields &"42"&, and
9272 .code
9273 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9274 .endd
9275 yields &"result: 99"&.
9276
9277 If {<&'string3'&>} is omitted, an empty string is used for string3.
9278 If {<&'string2'&>} is also omitted, the value that was
9279 extracted is used.
9280 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9281
9282
9283 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9284         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9285 This is the first of one of two different types of lookup item, which are both
9286 described in the next item.
9287
9288 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9289         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9290 .cindex "expansion" "lookup in"
9291 .cindex "file" "lookups"
9292 .cindex "lookup" "in expanded string"
9293 The two forms of lookup item specify data lookups in files and databases, as
9294 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9295 lookups, and the second is used for query-style lookups. The <&'key'&>,
9296 <&'file'&>, and <&'query'&> strings are expanded before use.
9297
9298 If there is any white space in a lookup item which is part of a filter command,
9299 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9300 other place where white space is significant, the lookup item must be enclosed
9301 in double quotes. The use of data lookups in users' filter files may be locked
9302 out by the system administrator.
9303
9304 .vindex "&$value$&"
9305 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9306 During its expansion, the variable &$value$& contains the data returned by the
9307 lookup. Afterwards it reverts to the value it had previously (at the outer
9308 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9309 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9310 string on failure. If <&'string2'&> is provided, it can itself be a nested
9311 lookup, thus providing a mechanism for looking up a default value when the
9312 original lookup fails.
9313
9314 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9315 data for the outer lookup while the parameters of the second lookup are
9316 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9317 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9318 appear, and in this case, if the lookup fails, the entire expansion is forced
9319 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9320 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9321 successful lookup, and nothing in the case of failure.
9322
9323 For single-key lookups, the string &"partial"& is permitted to precede the
9324 search type in order to do partial matching, and * or *@ may follow a search
9325 type to request default lookups if the key does not match (see sections
9326 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9327
9328 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9329 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9330 and non-wild parts of the key during the expansion of the replacement text.
9331 They return to their previous values at the end of the lookup item.
9332
9333 This example looks up the postmaster alias in the conventional alias file:
9334 .code
9335 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9336 .endd
9337 This example uses NIS+ to look up the full name of the user corresponding to
9338 the local part of an address, forcing the expansion to fail if it is not found:
9339 .code
9340 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9341   {$value}fail}
9342 .endd
9343
9344
9345 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9346 .cindex "expansion" "list creation"
9347 .vindex "&$item$&"
9348 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9349 default, but the separator can be changed in the usual way. For each item
9350 in this list, its value is place in &$item$&, and then <&'string2'&> is
9351 expanded and added to the output as an item in a new list. The separator used
9352 for the output list is the same as the one used for the input, but a separator
9353 setting is not included in the output. For example:
9354 .code
9355 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9356 .endd
9357 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9358 value of &$item$& is restored to what it was before. See also the &*filter*&
9359 and &*reduce*& expansion items.
9360
9361 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9362 .cindex "expansion" "numeric hash"
9363 .cindex "hash function" "numeric"
9364 The three strings are expanded; the first two must yield numbers. Call them
9365 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9366 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9367 can use the simpler operator notation that avoids some of the braces:
9368 .code
9369 ${nhash_<n>_<m>:<string>}
9370 .endd
9371 The second number is optional (in both notations). If there is only one number,
9372 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9373 processed by a div/mod hash function that returns two numbers, separated by a
9374 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9375 example,
9376 .code
9377 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9378 .endd
9379 returns the string &"6/33"&.
9380
9381
9382
9383 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9384 .cindex "Perl" "use in expanded string"
9385 .cindex "expansion" "calling Perl from"
9386 This item is available only if Exim has been built to include an embedded Perl
9387 interpreter. The subroutine name and the arguments are first separately
9388 expanded, and then the Perl subroutine is called with those arguments. No
9389 additional arguments need be given; the maximum number permitted, including the
9390 name of the subroutine, is nine.
9391
9392 The return value of the subroutine is inserted into the expanded string, unless
9393 the return value is &%undef%&. In that case, the expansion fails in the same
9394 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9395 Whatever you return is evaluated in a scalar context. For example, if you
9396 return the name of a Perl vector, the return value is the size of the vector,
9397 not its contents.
9398
9399 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9400 with the error message that was passed to &%die%&. More details of the embedded
9401 Perl facility are given in chapter &<<CHAPperl>>&.
9402
9403 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9404 out the use of this expansion item in filter files.
9405
9406
9407 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9408 .cindex "&%prvs%& expansion item"
9409 The first argument is a complete email address and the second is secret
9410 keystring. The third argument, specifying a key number, is optional. If absent,
9411 it defaults to 0. The result of the expansion is a prvs-signed email address,
9412 to be typically used with the &%return_path%& option on an &(smtp)& transport
9413 as part of a bounce address tag validation (BATV) scheme. For more discussion
9414 and an example, see section &<<SECTverifyPRVS>>&.
9415
9416 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9417         {*&<&'string'&>&*}}*&"
9418 .cindex "&%prvscheck%& expansion item"
9419 This expansion item is the complement of the &%prvs%& item. It is used for
9420 checking prvs-signed addresses. If the expansion of the first argument does not
9421 yield a syntactically valid prvs-signed address, the whole item expands to the
9422 empty string. When the first argument does expand to a syntactically valid
9423 prvs-signed address, the second argument is expanded, with the prvs-decoded
9424 version of the address and the key number extracted from the address in the
9425 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9426
9427 These two variables can be used in the expansion of the second argument to
9428 retrieve the secret. The validity of the prvs-signed address is then checked
9429 against the secret. The result is stored in the variable &$prvscheck_result$&,
9430 which is empty for failure or &"1"& for success.
9431
9432 The third argument is optional; if it is missing, it defaults to an empty
9433 string. This argument is now expanded. If the result is an empty string, the
9434 result of the expansion is the decoded version of the address. This is the case
9435 whether or not the signature was valid. Otherwise, the result of the expansion
9436 is the expansion of the third argument.
9437
9438 All three variables can be used in the expansion of the third argument.
9439 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9440 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9441
9442 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9443 .cindex "expansion" "inserting an entire file"
9444 .cindex "file" "inserting into expansion"
9445 .cindex "&%readfile%& expansion item"
9446 The file name and end-of-line string are first expanded separately. The file is
9447 then read, and its contents replace the entire item. All newline characters in
9448 the file are replaced by the end-of-line string if it is present. Otherwise,
9449 newlines are left in the string.
9450 String expansion is not applied to the contents of the file. If you want this,
9451 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9452 the string expansion fails.
9453
9454 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9455 locks out the use of this expansion item in filter files.
9456
9457
9458
9459 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9460         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9461 .cindex "expansion" "inserting from a socket"
9462 .cindex "socket, use of in expansion"
9463 .cindex "&%readsocket%& expansion item"
9464 This item inserts data from a Unix domain or Internet socket into the expanded
9465 string. The minimal way of using it uses just two arguments, as in these
9466 examples:
9467 .code
9468 ${readsocket{/socket/name}{request string}}
9469 ${readsocket{inet:some.host:1234}{request string}}
9470 .endd
9471 For a Unix domain socket, the first substring must be the path to the socket.
9472 For an Internet socket, the first substring must contain &`inet:`& followed by
9473 a host name or IP address, followed by a colon and a port, which can be a
9474 number or the name of a TCP port in &_/etc/services_&. An IP address may
9475 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9476 example:
9477 .code
9478 ${readsocket{inet:[::1]:1234}{request string}}
9479 .endd
9480 Only a single host name may be given, but if looking it up yields more than
9481 one IP address, they are each tried in turn until a connection is made. For
9482 both kinds of socket, Exim makes a connection, writes the request string
9483 (unless it is an empty string) and reads from the socket until an end-of-file
9484 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9485 extend what can be done. Firstly, you can vary the timeout. For example:
9486 .code
9487 ${readsocket{/socket/name}{request string}{3s}}
9488 .endd
9489 A fourth argument allows you to change any newlines that are in the data
9490 that is read, in the same way as for &%readfile%& (see above). This example
9491 turns them into spaces:
9492 .code
9493 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9494 .endd
9495 As with all expansions, the substrings are expanded before the processing
9496 happens. Errors in these sub-expansions cause the expansion to fail. In
9497 addition, the following errors can occur:
9498
9499 .ilist
9500 Failure to create a socket file descriptor;
9501 .next
9502 Failure to connect the socket;
9503 .next
9504 Failure to write the request string;
9505 .next
9506 Timeout on reading from the socket.
9507 .endlist
9508
9509 By default, any of these errors causes the expansion to fail. However, if
9510 you supply a fifth substring, it is expanded and used when any of the above
9511 errors occurs. For example:
9512 .code
9513 ${readsocket{/socket/name}{request string}{3s}{\n}\
9514   {socket failure}}
9515 .endd
9516 You can test for the existence of a Unix domain socket by wrapping this
9517 expansion in &`${if exists`&, but there is a race condition between that test
9518 and the actual opening of the socket, so it is safer to use the fifth argument
9519 if you want to be absolutely sure of avoiding an expansion error for a
9520 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9521
9522 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9523 locks out the use of this expansion item in filter files.
9524
9525
9526 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9527 .cindex "expansion" "reducing a list to a scalar"
9528 .cindex "list" "reducing to a scalar"
9529 .vindex "&$value$&"
9530 .vindex "&$item$&"
9531 This operation reduces a list to a single, scalar string. After expansion,
9532 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9533 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9534 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9535 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9536 them. The result of that expansion is assigned to &$value$& before the next
9537 iteration. When the end of the list is reached, the final value of &$value$& is
9538 added to the expansion output. The &*reduce*& expansion item can be used in a
9539 number of ways. For example, to add up a list of numbers:
9540 .code
9541 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9542 .endd
9543 The result of that expansion would be &`6`&. The maximum of a list of numbers
9544 can be found:
9545 .code
9546 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9547 .endd
9548 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9549 restored to what they were before. See also the &*filter*& and &*map*&
9550 expansion items.
9551
9552 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9553 This item inserts &"raw"& header lines. It is described with the &%header%&
9554 expansion item above.
9555
9556 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9557         {*&<&'string2'&>&*}}*&"
9558 .cindex "expansion" "running a command"
9559 .cindex "&%run%& expansion item"
9560 The command and its arguments are first expanded separately, and then the
9561 command is run in a separate process, but under the same uid and gid. As in
9562 other command executions from Exim, a shell is not used by default. If you want
9563 a shell, you must explicitly code it.
9564
9565 The standard input for the command exists, but is empty. The standard output
9566 and standard error are set to the same file descriptor.
9567 .cindex "return code" "from &%run%& expansion"
9568 .vindex "&$value$&"
9569 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9570 and replaces the entire item; during this expansion, the standard output/error
9571 from the command is in the variable &$value$&. If the command fails,
9572 <&'string2'&>, if present, is expanded and used. Once again, during the
9573 expansion, the standard output/error from the command is in the variable
9574 &$value$&.
9575
9576 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9577 can be the word &"fail"& (not in braces) to force expansion failure if the
9578 command does not succeed. If both strings are omitted, the result is contents
9579 of the standard output/error on success, and nothing on failure.
9580
9581 .vindex "&$run_in_acl$&"
9582 The standard output/error of the command is put in the variable &$value$&.
9583 In this ACL example, the output of a command is logged for the admin to
9584 troubleshoot:
9585 .code
9586 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9587       log_message  = Output of id: $value
9588 .endd
9589 If the command requires shell idioms, such as the > redirect operator, the
9590 shell must be invoked directly, such as with:
9591 .code
9592 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9593 .endd
9594
9595 .vindex "&$runrc$&"
9596 The return code from the command is put in the variable &$runrc$&, and this
9597 remains set afterwards, so in a filter file you can do things like this:
9598 .code
9599 if "${run{x y z}{}}$runrc" is 1 then ...
9600   elif $runrc is 2 then ...
9601   ...
9602 endif
9603 .endd
9604 If execution of the command fails (for example, the command does not exist),
9605 the return code is 127 &-- the same code that shells use for non-existent
9606 commands.
9607
9608 &*Warning*&: In a router or transport, you cannot assume the order in which
9609 option values are expanded, except for those preconditions whose order of
9610 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9611 by the expansion of one option, and use it in another.
9612
9613 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9614 out the use of this expansion item in filter files.
9615
9616
9617 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9618 .cindex "expansion" "string substitution"
9619 .cindex "&%sg%& expansion item"
9620 This item works like Perl's substitution operator (s) with the global (/g)
9621 option; hence its name. However, unlike the Perl equivalent, Exim does not
9622 modify the subject string; instead it returns the modified string for insertion
9623 into the overall expansion. The item takes three arguments: the subject string,
9624 a regular expression, and a substitution string. For example:
9625 .code
9626 ${sg{abcdefabcdef}{abc}{xyz}}
9627 .endd
9628 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9629 if any $ or \ characters are required in the regular expression or in the
9630 substitution string, they have to be escaped. For example:
9631 .code
9632 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9633 .endd
9634 yields &"defabc"&, and
9635 .code
9636 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9637 .endd
9638 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9639 the regular expression from string expansion.
9640
9641
9642
9643 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9644 .cindex "&%substr%& expansion item"
9645 .cindex "substring extraction"
9646 .cindex "expansion" "substring extraction"
9647 The three strings are expanded; the first two must yield numbers. Call them
9648 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9649 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9650 can use the simpler operator notation that avoids some of the braces:
9651 .code
9652 ${substr_<n>_<m>:<string>}
9653 .endd
9654 The second number is optional (in both notations).
9655 If it is absent in the simpler format, the preceding underscore must also be
9656 omitted.
9657
9658 The &%substr%& item can be used to extract more general substrings than
9659 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9660 length required. For example
9661 .code
9662 ${substr{3}{2}{$local_part}}
9663 .endd
9664 If the starting offset is greater than the string length the result is the
9665 null string; if the length plus starting offset is greater than the string
9666 length, the result is the right-hand part of the string, starting from the
9667 given offset. The first character in the string has offset zero.
9668
9669 The &%substr%& expansion item can take negative offset values to count
9670 from the right-hand end of its operand. The last character is offset -1, the
9671 second-last is offset -2, and so on. Thus, for example,
9672 .code
9673 ${substr{-5}{2}{1234567}}
9674 .endd
9675 yields &"34"&. If the absolute value of a negative offset is greater than the
9676 length of the string, the substring starts at the beginning of the string, and
9677 the length is reduced by the amount of overshoot. Thus, for example,
9678 .code
9679 ${substr{-5}{2}{12}}
9680 .endd
9681 yields an empty string, but
9682 .code
9683 ${substr{-3}{2}{12}}
9684 .endd
9685 yields &"1"&.
9686
9687 When the second number is omitted from &%substr%&, the remainder of the string
9688 is taken if the offset is positive. If it is negative, all characters in the
9689 string preceding the offset point are taken. For example, an offset of -1 and
9690 no length, as in these semantically identical examples:
9691 .code
9692 ${substr_-1:abcde}
9693 ${substr{-1}{abcde}}
9694 .endd
9695 yields all but the last character of the string, that is, &"abcd"&.
9696
9697
9698
9699 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9700         {*&<&'replacements'&>&*}}*&"
9701 .cindex "expansion" "character translation"
9702 .cindex "&%tr%& expansion item"
9703 This item does single-character translation on its subject string. The second
9704 argument is a list of characters to be translated in the subject string. Each
9705 matching character is replaced by the corresponding character from the
9706 replacement list. For example
9707 .code
9708 ${tr{abcdea}{ac}{13}}
9709 .endd
9710 yields &`1b3de1`&. If there are duplicates in the second character string, the
9711 last occurrence is used. If the third string is shorter than the second, its
9712 last character is replicated. However, if it is empty, no translation takes
9713 place.
9714 .endlist
9715
9716
9717
9718 .section "Expansion operators" "SECTexpop"
9719 .cindex "expansion" "operators"
9720 For expansion items that perform transformations on a single argument string,
9721 the &"operator"& notation is used because it is simpler and uses fewer braces.
9722 The substring is first expanded before the operation is applied to it. The
9723 following operations can be performed:
9724
9725 .vlist
9726 .vitem &*${address:*&<&'string'&>&*}*&
9727 .cindex "expansion" "RFC 2822 address handling"
9728 .cindex "&%address%& expansion item"
9729 The string is interpreted as an RFC 2822 address, as it might appear in a
9730 header line, and the effective address is extracted from it. If the string does
9731 not parse successfully, the result is empty.
9732
9733
9734 .vitem &*${addresses:*&<&'string'&>&*}*&
9735 .cindex "expansion" "RFC 2822 address handling"
9736 .cindex "&%addresses%& expansion item"
9737 The string (after expansion) is interpreted as a list of addresses in RFC
9738 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9739 operative address (&'local-part@domain'&) is extracted from each item, and the
9740 result of the expansion is a colon-separated list, with appropriate
9741 doubling of colons should any happen to be present in the email addresses.
9742 Syntactically invalid RFC2822 address items are omitted from the output.
9743
9744 It is possible to specify a character other than colon for the output
9745 separator by starting the string with > followed by the new separator
9746 character. For example:
9747 .code
9748 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9749 .endd
9750 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9751 expansion item, which extracts the working address from a single RFC2822
9752 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9753 processing lists.
9754
9755 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9756 a strict interpretation of header line formatting.  Exim parses the bare,
9757 unquoted portion of an email address and if it finds a comma, treats it as an
9758 email address seperator. For the example header line:
9759 .code
9760 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9761 .endd
9762 The first example below demonstrates that Q-encoded email addresses are parsed
9763 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9764 It does not see the comma because it's still encoded as "=2C".  The second
9765 example below is passed the contents of &`$header_from:`&, meaning it gets
9766 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9767 The third example shows that the presence of a comma is skipped when it is
9768 quoted.
9769 .code
9770 # exim -be '${addresses:From: \
9771 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9772 user@example.com
9773 # exim -be '${addresses:From: Last, First <user@example.com>}'
9774 Last:user@example.com
9775 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9776 user@example.com
9777 .endd
9778
9779 .vitem &*${base62:*&<&'digits'&>&*}*&
9780 .cindex "&%base62%& expansion item"
9781 .cindex "expansion" "conversion to base 62"
9782 The string must consist entirely of decimal digits. The number is converted to
9783 base 62 and output as a string of six characters, including leading zeros. In
9784 the few operating environments where Exim uses base 36 instead of base 62 for
9785 its message identifiers (because those systems do not have case-sensitive file
9786 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9787 be absolutely clear: this is &'not'& base64 encoding.
9788
9789 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9790 .cindex "&%base62d%& expansion item"
9791 .cindex "expansion" "conversion to base 62"
9792 The string must consist entirely of base-62 digits, or, in operating
9793 environments where Exim uses base 36 instead of base 62 for its message
9794 identifiers, base-36 digits. The number is converted to decimal and output as a
9795 string.
9796
9797
9798 .vitem &*${domain:*&<&'string'&>&*}*&
9799 .cindex "domain" "extraction"
9800 .cindex "expansion" "domain extraction"
9801 The string is interpreted as an RFC 2822 address and the domain is extracted
9802 from it. If the string does not parse successfully, the result is empty.
9803
9804
9805 .vitem &*${escape:*&<&'string'&>&*}*&
9806 .cindex "expansion" "escaping non-printing characters"
9807 .cindex "&%escape%& expansion item"
9808 If the string contains any non-printing characters, they are converted to
9809 escape sequences starting with a backslash. Whether characters with the most
9810 significant bit set (so-called &"8-bit characters"&) count as printing or not
9811 is controlled by the &%print_topbitchars%& option.
9812
9813
9814 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9815 .cindex "expansion" "expression evaluation"
9816 .cindex "expansion" "arithmetic expression"
9817 .cindex "&%eval%& expansion item"
9818 These items supports simple arithmetic and bitwise logical operations in
9819 expansion strings. The string (after expansion) must be a conventional
9820 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9821 logical operators, and parentheses. All operations are carried out using
9822 integer arithmetic. The operator priorities are as follows (the same as in the
9823 C programming language):
9824 .table2 70pt 300pt
9825 .irow &'highest:'& "not (~), negate (-)"
9826 .irow ""   "multiply (*), divide (/), remainder (%)"
9827 .irow ""   "plus (+), minus (-)"
9828 .irow ""   "shift-left (<<), shift-right (>>)"
9829 .irow ""   "and (&&)"
9830 .irow ""   "xor (^)"
9831 .irow &'lowest:'&  "or (|)"
9832 .endtable
9833 Binary operators with the same priority are evaluated from left to right. White
9834 space is permitted before or after operators.
9835
9836 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9837 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9838 decimal, even if they start with a leading zero; hexadecimal numbers are not
9839 permitted. This can be useful when processing numbers extracted from dates or
9840 times, which often do have leading zeros.
9841
9842 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9843 or 1024*1024*1024,
9844 respectively. Negative numbers are supported. The result of the computation is
9845 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9846
9847 .display
9848 &`${eval:1+1}            `&  yields 2
9849 &`${eval:1+2*3}          `&  yields 7
9850 &`${eval:(1+2)*3}        `&  yields 9
9851 &`${eval:2+42%5}         `&  yields 4
9852 &`${eval:0xc&amp;5}          `&  yields 4
9853 &`${eval:0xc|5}          `&  yields 13
9854 &`${eval:0xc^5}          `&  yields 9
9855 &`${eval:0xc>>1}         `&  yields 6
9856 &`${eval:0xc<<1}         `&  yields 24
9857 &`${eval:~255&amp;0x1234}    `&  yields 4608
9858 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9859 .endd
9860
9861 As a more realistic example, in an ACL you might have
9862 .code
9863 deny   message = Too many bad recipients
9864        condition =                    \
9865          ${if and {                   \
9866            {>{$rcpt_count}{10}}       \
9867            {                          \
9868            <                          \
9869              {$recipients_count}      \
9870              {${eval:$rcpt_count/2}}  \
9871            }                          \
9872          }{yes}{no}}
9873 .endd
9874 The condition is true if there have been more than 10 RCPT commands and
9875 fewer than half of them have resulted in a valid recipient.
9876
9877
9878 .vitem &*${expand:*&<&'string'&>&*}*&
9879 .cindex "expansion" "re-expansion of substring"
9880 The &%expand%& operator causes a string to be expanded for a second time. For
9881 example,
9882 .code
9883 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9884 .endd
9885 first looks up a string in a file while expanding the operand for &%expand%&,
9886 and then re-expands what it has found.
9887
9888
9889 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9890 .cindex "Unicode"
9891 .cindex "UTF-8" "conversion from"
9892 .cindex "expansion" "UTF-8 conversion"
9893 .cindex "&%from_utf8%& expansion item"
9894 The world is slowly moving towards Unicode, although there are no standards for
9895 email yet. However, other applications (including some databases) are starting
9896 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9897 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9898 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9899 the result is an undefined sequence of bytes.
9900
9901 Unicode code points with values less than 256 are compatible with ASCII and
9902 ISO-8859-1 (also known as Latin-1).
9903 For example, character 169 is the copyright symbol in both cases, though the
9904 way it is encoded is different. In UTF-8, more than one byte is needed for
9905 characters with code values greater than 127, whereas ISO-8859-1 is a
9906 single-byte encoding (but thereby limited to 256 characters). This makes
9907 translation from UTF-8 to ISO-8859-1 straightforward.
9908
9909
9910 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9911 .cindex "hash function" "textual"
9912 .cindex "expansion" "textual hash"
9913 The &%hash%& operator is a simpler interface to the hashing function that can
9914 be used when the two parameters are fixed numbers (as opposed to strings that
9915 change when expanded). The effect is the same as
9916 .code
9917 ${hash{<n>}{<m>}{<string>}}
9918 .endd
9919 See the description of the general &%hash%& item above for details. The
9920 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9921
9922
9923
9924 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9925 .cindex "base64 encoding" "conversion from hex"
9926 .cindex "expansion" "hex to base64"
9927 .cindex "&%hex2b64%& expansion item"
9928 This operator converts a hex string into one that is base64 encoded. This can
9929 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9930
9931
9932
9933 .vitem &*${hexquote:*&<&'string'&>&*}*&
9934 .cindex "quoting" "hex-encoded unprintable characters"
9935 .cindex "&%hexquote%& expansion item"
9936 This operator converts non-printable characters in a string into a hex
9937 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
9938 as is, and other byte values are converted to &`\xNN`&, for example a
9939 byte value 127 is converted to &`\x7f`&.
9940
9941
9942 .vitem &*${lc:*&<&'string'&>&*}*&
9943 .cindex "case forcing in strings"
9944 .cindex "string" "case forcing"
9945 .cindex "lower casing"
9946 .cindex "expansion" "case forcing"
9947 .cindex "&%lc%& expansion item"
9948 This forces the letters in the string into lower-case, for example:
9949 .code
9950 ${lc:$local_part}
9951 .endd
9952
9953 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9954 .cindex "expansion" "string truncation"
9955 .cindex "&%length%& expansion item"
9956 The &%length%& operator is a simpler interface to the &%length%& function that
9957 can be used when the parameter is a fixed number (as opposed to a string that
9958 changes when expanded). The effect is the same as
9959 .code
9960 ${length{<number>}{<string>}}
9961 .endd
9962 See the description of the general &%length%& item above for details. Note that
9963 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9964 when &%length%& is used as an operator.
9965
9966
9967 .vitem &*${listcount:*&<&'string'&>&*}*&
9968 .cindex "expansion" "list item count"
9969 .cindex "list" "item count"
9970 .cindex "list" "count of items"
9971 .cindex "&%listcount%& expansion item"
9972 The string is interpreted as a list and the number of items is returned.
9973
9974
9975 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
9976 .cindex "expansion" "named list"
9977 .cindex "&%listnamed%& expansion item"
9978 The name is interpreted as a named list and the content of the list is returned,
9979 expanding any referenced lists, re-quoting as needed for colon-separation.
9980 If the optional type is given it must be one of "a", "d", "h" or "l"
9981 and selects address-, domain-, host- or localpart- lists to search among respectively.
9982 Otherwise all types are searched in an undefined order and the first
9983 matching list is returned.
9984
9985
9986 .vitem &*${local_part:*&<&'string'&>&*}*&
9987 .cindex "expansion" "local part extraction"
9988 .cindex "&%local_part%& expansion item"
9989 The string is interpreted as an RFC 2822 address and the local part is
9990 extracted from it. If the string does not parse successfully, the result is
9991 empty.
9992
9993
9994 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9995 .cindex "masked IP address"
9996 .cindex "IP address" "masking"
9997 .cindex "CIDR notation"
9998 .cindex "expansion" "IP address masking"
9999 .cindex "&%mask%& expansion item"
10000 If the form of the string to be operated on is not an IP address followed by a
10001 slash and an integer (that is, a network address in CIDR notation), the
10002 expansion fails. Otherwise, this operator converts the IP address to binary,
10003 masks off the least significant bits according to the bit count, and converts
10004 the result back to text, with mask appended. For example,
10005 .code
10006 ${mask:10.111.131.206/28}
10007 .endd
10008 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10009 be mostly used for looking up masked addresses in files, the result for an IPv6
10010 address uses dots to separate components instead of colons, because colon
10011 terminates a key string in lsearch files. So, for example,
10012 .code
10013 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10014 .endd
10015 returns the string
10016 .code
10017 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10018 .endd
10019 Letters in IPv6 addresses are always output in lower case.
10020
10021
10022 .vitem &*${md5:*&<&'string'&>&*}*&
10023 .cindex "MD5 hash"
10024 .cindex "expansion" "MD5 hash"
10025 .cindex "&%md5%& expansion item"
10026 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10027 as a 32-digit hexadecimal number, in which any letters are in lower case.
10028
10029
10030 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10031 .cindex "expansion" "numeric hash"
10032 .cindex "hash function" "numeric"
10033 The &%nhash%& operator is a simpler interface to the numeric hashing function
10034 that can be used when the two parameters are fixed numbers (as opposed to
10035 strings that change when expanded). The effect is the same as
10036 .code
10037 ${nhash{<n>}{<m>}{<string>}}
10038 .endd
10039 See the description of the general &%nhash%& item above for details.
10040
10041
10042 .vitem &*${quote:*&<&'string'&>&*}*&
10043 .cindex "quoting" "in string expansions"
10044 .cindex "expansion" "quoting"
10045 .cindex "&%quote%& expansion item"
10046 The &%quote%& operator puts its argument into double quotes if it
10047 is an empty string or
10048 contains anything other than letters, digits, underscores, dots, and hyphens.
10049 Any occurrences of double quotes and backslashes are escaped with a backslash.
10050 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10051 respectively For example,
10052 .code
10053 ${quote:ab"*"cd}
10054 .endd
10055 becomes
10056 .code
10057 "ab\"*\"cd"
10058 .endd
10059 The place where this is useful is when the argument is a substitution from a
10060 variable or a message header.
10061
10062 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10063 .cindex "&%quote_local_part%& expansion item"
10064 This operator is like &%quote%&, except that it quotes the string only if
10065 required to do so by the rules of RFC 2822 for quoting local parts. For
10066 example, a plus sign would not cause quoting (but it would for &%quote%&).
10067 If you are creating a new email address from the contents of &$local_part$&
10068 (or any other unknown data), you should always use this operator.
10069
10070
10071 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10072 .cindex "quoting" "lookup-specific"
10073 This operator applies lookup-specific quoting rules to the string. Each
10074 query-style lookup type has its own quoting rules which are described with
10075 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10076 .code
10077 ${quote_ldap:two * two}
10078 .endd
10079 returns
10080 .code
10081 two%20%5C2A%20two
10082 .endd
10083 For single-key lookup types, no quoting is ever necessary and this operator
10084 yields an unchanged string.
10085
10086
10087 .vitem &*${randint:*&<&'n'&>&*}*&
10088 .cindex "random number"
10089 This operator returns a somewhat random number which is less than the
10090 supplied number and is at least 0.  The quality of this randomness depends
10091 on how Exim was built; the values are not suitable for keying material.
10092 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10093 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10094 for versions of GnuTLS with that function.
10095 Otherwise, the implementation may be arc4random(), random() seeded by
10096 srandomdev() or srandom(), or a custom implementation even weaker than
10097 random().
10098
10099
10100 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10101 .cindex "expansion" "IP address"
10102 This operator reverses an IP address; for IPv4 addresses, the result is in
10103 dotted-quad decimal form, while for IPv6 addreses the result is in
10104 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10105 for DNS.  For example,
10106 .code
10107 ${reverse_ip:192.0.2.4}
10108 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10109 .endd
10110 returns
10111 .code
10112 4.2.0.192
10113 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
10114 .endd
10115
10116
10117 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10118 .cindex "expansion" "RFC 2047"
10119 .cindex "RFC 2047" "expansion operator"
10120 .cindex "&%rfc2047%& expansion item"
10121 This operator encodes text according to the rules of RFC 2047. This is an
10122 encoding that is used in header lines to encode non-ASCII characters. It is
10123 assumed that the input string is in the encoding specified by the
10124 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10125 contains only characters in the range 33&--126, and no instances of the
10126 characters
10127 .code
10128 ? = ( ) < > @ , ; : \ " . [ ] _
10129 .endd
10130 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10131 string, using as many &"encoded words"& as necessary to encode all the
10132 characters.
10133
10134
10135 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10136 .cindex "expansion" "RFC 2047"
10137 .cindex "RFC 2047" "decoding"
10138 .cindex "&%rfc2047d%& expansion item"
10139 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10140 bytes are replaced by question marks. Characters are converted into the
10141 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10142 not recognized unless &%check_rfc2047_length%& is set false.
10143
10144 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10145 access a header line, RFC 2047 decoding is done automatically. You do not need
10146 to use this operator as well.
10147
10148
10149
10150 .vitem &*${rxquote:*&<&'string'&>&*}*&
10151 .cindex "quoting" "in regular expressions"
10152 .cindex "regular expressions" "quoting"
10153 .cindex "&%rxquote%& expansion item"
10154 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10155 characters in its argument. This is useful when substituting the values of
10156 variables or headers inside regular expressions.
10157
10158
10159 .vitem &*${sha1:*&<&'string'&>&*}*&
10160 .cindex "SHA-1 hash"
10161 .cindex "expansion" "SHA-1 hashing"
10162 .cindex "&%sha2%& expansion item"
10163 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10164 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10165
10166
10167 .vitem &*${stat:*&<&'string'&>&*}*&
10168 .cindex "expansion" "statting a file"
10169 .cindex "file" "extracting characteristics"
10170 .cindex "&%stat%& expansion item"
10171 The string, after expansion, must be a file path. A call to the &[stat()]&
10172 function is made for this path. If &[stat()]& fails, an error occurs and the
10173 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10174 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10175 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10176 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10177 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10178 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10179 can extract individual fields using the &%extract%& expansion item.
10180
10181 The use of the &%stat%& expansion in users' filter files can be locked out by
10182 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10183 systems for files larger than 2GB.
10184
10185 .vitem &*${str2b64:*&<&'string'&>&*}*&
10186 .cindex "expansion" "base64 encoding"
10187 .cindex "base64 encoding" "in string expansion"
10188 .cindex "&%str2b64%& expansion item"
10189 This operator converts a string into one that is base64 encoded.
10190
10191
10192
10193 .vitem &*${strlen:*&<&'string'&>&*}*&
10194 .cindex "expansion" "string length"
10195 .cindex "string" "length in expansion"
10196 .cindex "&%strlen%& expansion item"
10197 The item is replace by the length of the expanded string, expressed as a
10198 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10199
10200
10201 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10202 .cindex "&%substr%& expansion item"
10203 .cindex "substring extraction"
10204 .cindex "expansion" "substring expansion"
10205 The &%substr%& operator is a simpler interface to the &%substr%& function that
10206 can be used when the two parameters are fixed numbers (as opposed to strings
10207 that change when expanded). The effect is the same as
10208 .code
10209 ${substr{<start>}{<length>}{<string>}}
10210 .endd
10211 See the description of the general &%substr%& item above for details. The
10212 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10213
10214 .vitem &*${time_eval:*&<&'string'&>&*}*&
10215 .cindex "&%time_eval%& expansion item"
10216 .cindex "time interval" "decoding"
10217 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10218 seconds.
10219
10220 .vitem &*${time_interval:*&<&'string'&>&*}*&
10221 .cindex "&%time_interval%& expansion item"
10222 .cindex "time interval" "formatting"
10223 The argument (after sub-expansion) must be a sequence of decimal digits that
10224 represents an interval of time as a number of seconds. It is converted into a
10225 number of larger units and output in Exim's normal time format, for example,
10226 &`1w3d4h2m6s`&.
10227
10228 .vitem &*${uc:*&<&'string'&>&*}*&
10229 .cindex "case forcing in strings"
10230 .cindex "string" "case forcing"
10231 .cindex "upper casing"
10232 .cindex "expansion" "case forcing"
10233 .cindex "&%uc%& expansion item"
10234 This forces the letters in the string into upper-case.
10235
10236 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10237 .cindex "correction of invalid utf-8 sequences in strings"
10238 .cindex "utf-8" "utf-8 sequences"
10239 .cindex "incorrect utf-8"
10240 .cindex "expansion" "utf-8 forcing"
10241 .cindex "&%utf8clean%& expansion item"
10242 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10243 .endlist
10244
10245
10246
10247
10248
10249
10250 .section "Expansion conditions" "SECTexpcond"
10251 .scindex IIDexpcond "expansion" "conditions"
10252 The following conditions are available for testing by the &%${if%& construct
10253 while expanding strings:
10254
10255 .vlist
10256 .vitem &*!*&<&'condition'&>
10257 .cindex "expansion" "negating a condition"
10258 .cindex "negation" "in expansion condition"
10259 Preceding any condition with an exclamation mark negates the result of the
10260 condition.
10261
10262 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10263 .cindex "numeric comparison"
10264 .cindex "expansion" "numeric comparison"
10265 There are a number of symbolic operators for doing numeric comparisons. They
10266 are:
10267 .display
10268 &`=   `&   equal
10269 &`==  `&   equal
10270 &`>   `&   greater
10271 &`>=  `&   greater or equal
10272 &`<   `&   less
10273 &`<=  `&   less or equal
10274 .endd
10275 For example:
10276 .code
10277 ${if >{$message_size}{10M} ...
10278 .endd
10279 Note that the general negation operator provides for inequality testing. The
10280 two strings must take the form of optionally signed decimal integers,
10281 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10282 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10283 As a special case, the numerical value of an empty string is taken as
10284 zero.
10285
10286 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10287 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10288 10M, not if 10M is larger than &$message_size$&.
10289
10290
10291 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10292         {*&<&'arg2'&>&*}...}*&
10293 .cindex "expansion" "calling an acl"
10294 .cindex "&%acl%&" "expansion condition"
10295 The name and zero to nine argument strings are first expanded separately.  The expanded
10296 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10297 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10298 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10299 and may use the variables; if another acl expansion is used the values
10300 are restored after it returns.  If the ACL sets
10301 a value using a "message =" modifier the variable $value becomes
10302 the result of the expansion, otherwise it is empty.
10303 If the ACL returns accept the condition is true; if deny, false.
10304 If the ACL returns defer the result is a forced-fail.
10305
10306 .vitem &*bool&~{*&<&'string'&>&*}*&
10307 .cindex "expansion" "boolean parsing"
10308 .cindex "&%bool%& expansion condition"
10309 This condition turns a string holding a true or false representation into
10310 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10311 (case-insensitively); also integer numbers map to true if non-zero,
10312 false if zero.
10313 An empty string is treated as false.
10314 Leading and trailing whitespace is ignored;
10315 thus a string consisting only of whitespace is false.
10316 All other string values will result in expansion failure.
10317
10318 When combined with ACL variables, this expansion condition will let you
10319 make decisions in one place and act on those decisions in another place.
10320 For example:
10321 .code
10322 ${if bool{$acl_m_privileged_sender} ...
10323 .endd
10324
10325
10326 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10327 .cindex "expansion" "boolean parsing"
10328 .cindex "&%bool_lax%& expansion condition"
10329 Like &%bool%&, this condition turns a string into a boolean state.  But
10330 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10331 loose definition that the Router &%condition%& option uses.  The empty string
10332 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10333 true.  Leading and trailing whitespace is ignored.
10334
10335 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10336
10337 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10338 .cindex "expansion" "encrypted comparison"
10339 .cindex "encrypted strings, comparing"
10340 .cindex "&%crypteq%& expansion condition"
10341 This condition is included in the Exim binary if it is built to support any
10342 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10343 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10344 included in the binary.
10345
10346 The &%crypteq%& condition has two arguments. The first is encrypted and
10347 compared against the second, which is already encrypted. The second string may
10348 be in the LDAP form for storing encrypted strings, which starts with the
10349 encryption type in curly brackets, followed by the data. If the second string
10350 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10351 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10352 Typically this will be a field from a password file. An example of an encrypted
10353 string in LDAP form is:
10354 .code
10355 {md5}CY9rzUYh03PK3k6DJie09g==
10356 .endd
10357 If such a string appears directly in an expansion, the curly brackets have to
10358 be quoted, because they are part of the expansion syntax. For example:
10359 .code
10360 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10361 .endd
10362 The following encryption types (whose names are matched case-independently) are
10363 supported:
10364
10365 .ilist
10366 .cindex "MD5 hash"
10367 .cindex "base64 encoding" "in encrypted password"
10368 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10369 printable characters to compare with the remainder of the second string. If the
10370 length of the comparison string is 24, Exim assumes that it is base64 encoded
10371 (as in the above example). If the length is 32, Exim assumes that it is a
10372 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10373 comparison fails.
10374
10375 .next
10376 .cindex "SHA-1 hash"
10377 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10378 printable characters to compare with the remainder of the second string. If the
10379 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10380 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10381 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10382
10383 .next
10384 .cindex "&[crypt()]&"
10385 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10386 only the first eight characters of the password. However, in modern operating
10387 systems this is no longer true, and in many cases the entire password is used,
10388 whatever its length.
10389
10390 .next
10391 .cindex "&[crypt16()]&"
10392 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10393 use up to 16 characters of the password in some operating systems. Again, in
10394 modern operating systems, more characters may be used.
10395 .endlist
10396 Exim has its own version of &[crypt16()]&, which is just a double call to
10397 &[crypt()]&. For operating systems that have their own version, setting
10398 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10399 operating system version instead of its own. This option is set by default in
10400 the OS-dependent &_Makefile_& for those operating systems that are known to
10401 support &[crypt16()]&.
10402
10403 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10404 it was not using the same algorithm as some operating systems' versions. It
10405 turns out that as well as &[crypt16()]& there is a function called
10406 &[bigcrypt()]& in some operating systems. This may or may not use the same
10407 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10408
10409 However, since there is now a move away from the traditional &[crypt()]&
10410 functions towards using SHA1 and other algorithms, tidying up this area of
10411 Exim is seen as very low priority.
10412
10413 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10414 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10415 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10416 default is &`{crypt}`&. Whatever the default, you can always use either
10417 function by specifying it explicitly in curly brackets.
10418
10419 .vitem &*def:*&<&'variable&~name'&>
10420 .cindex "expansion" "checking for empty variable"
10421 .cindex "&%def%& expansion condition"
10422 The &%def%& condition must be followed by the name of one of the expansion
10423 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10424 variable does not contain the empty string. For example:
10425 .code
10426 ${if def:sender_ident {from $sender_ident}}
10427 .endd
10428 Note that the variable name is given without a leading &%$%& character. If the
10429 variable does not exist, the expansion fails.
10430
10431 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10432         &~&*def:h_*&<&'header&~name'&>&*:*&"
10433 .cindex "expansion" "checking header line existence"
10434 This condition is true if a message is being processed and the named header
10435 exists in the message. For example,
10436 .code
10437 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10438 .endd
10439 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10440 the header name must be terminated by a colon if white space does not follow.
10441
10442 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10443        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10444 .cindex "string" "comparison"
10445 .cindex "expansion" "string comparison"
10446 .cindex "&%eq%& expansion condition"
10447 .cindex "&%eqi%& expansion condition"
10448 The two substrings are first expanded. The condition is true if the two
10449 resulting strings are identical. For &%eq%& the comparison includes the case of
10450 letters, whereas for &%eqi%& the comparison is case-independent.
10451
10452 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10453 .cindex "expansion" "file existence test"
10454 .cindex "file" "existence test"
10455 .cindex "&%exists%&, expansion condition"
10456 The substring is first expanded and then interpreted as an absolute path. The
10457 condition is true if the named file (or directory) exists. The existence test
10458 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10459 users' filter files may be locked out by the system administrator.
10460
10461 .vitem &*first_delivery*&
10462 .cindex "delivery" "first"
10463 .cindex "first delivery"
10464 .cindex "expansion" "first delivery test"
10465 .cindex "&%first_delivery%& expansion condition"
10466 This condition, which has no data, is true during a message's first delivery
10467 attempt. It is false during any subsequent delivery attempts.
10468
10469
10470 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10471        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10472 .cindex "list" "iterative conditions"
10473 .cindex "expansion" "&*forall*& condition"
10474 .cindex "expansion" "&*forany*& condition"
10475 .vindex "&$item$&"
10476 These conditions iterate over a list. The first argument is expanded to form
10477 the list. By default, the list separator is a colon, but it can be changed by
10478 the normal method. The second argument is interpreted as a condition that is to
10479 be applied to each item in the list in turn. During the interpretation of the
10480 condition, the current list item is placed in a variable called &$item$&.
10481 .ilist
10482 For &*forany*&, interpretation stops if the condition is true for any item, and
10483 the result of the whole condition is true. If the condition is false for all
10484 items in the list, the overall condition is false.
10485 .next
10486 For &*forall*&, interpretation stops if the condition is false for any item,
10487 and the result of the whole condition is false. If the condition is true for
10488 all items in the list, the overall condition is true.
10489 .endlist
10490 Note that negation of &*forany*& means that the condition must be false for all
10491 items for the overall condition to succeed, and negation of &*forall*& means
10492 that the condition must be false for at least one item. In this example, the
10493 list separator is changed to a comma:
10494 .code
10495 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10496 .endd
10497 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10498 being processed, to enable these expansion items to be nested.
10499
10500 To scan a named list, expand it with the &*listnamed*& operator.
10501
10502
10503 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10504        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10505 .cindex "string" "comparison"
10506 .cindex "expansion" "string comparison"
10507 .cindex "&%ge%& expansion condition"
10508 .cindex "&%gei%& expansion condition"
10509 The two substrings are first expanded. The condition is true if the first
10510 string is lexically greater than or equal to the second string. For &%ge%& the
10511 comparison includes the case of letters, whereas for &%gei%& the comparison is
10512 case-independent.
10513
10514 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10515        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10516 .cindex "string" "comparison"
10517 .cindex "expansion" "string comparison"
10518 .cindex "&%gt%& expansion condition"
10519 .cindex "&%gti%& expansion condition"
10520 The two substrings are first expanded. The condition is true if the first
10521 string is lexically greater than the second string. For &%gt%& the comparison
10522 includes the case of letters, whereas for &%gti%& the comparison is
10523 case-independent.
10524
10525 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10526        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10527 .cindex "string" "comparison"
10528 .cindex "list" "iterative conditions"
10529 Both strings are expanded; the second string is treated as a list of simple
10530 strings; if the first string is a member of the second, then the condition
10531 is true.
10532
10533 These are simpler to use versions of the more powerful &*forany*& condition.
10534 Examples, and the &*forany*& equivalents:
10535 .code
10536 ${if inlist{needle}{foo:needle:bar}}
10537   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10538 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10539   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10540 .endd
10541
10542 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10543        &*isip4&~{*&<&'string'&>&*}*& &&&
10544        &*isip6&~{*&<&'string'&>&*}*&
10545 .cindex "IP address" "testing string format"
10546 .cindex "string" "testing for IP address"
10547 .cindex "&%isip%& expansion condition"
10548 .cindex "&%isip4%& expansion condition"
10549 .cindex "&%isip6%& expansion condition"
10550 The substring is first expanded, and then tested to see if it has the form of
10551 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10552 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10553
10554 For an IPv4 address, the test is for four dot-separated components, each of
10555 which consists of from one to three digits. For an IPv6 address, up to eight
10556 colon-separated components are permitted, each containing from one to four
10557 hexadecimal digits. There may be fewer than eight components if an empty
10558 component (adjacent colons) is present. Only one empty component is permitted.
10559
10560 &*Note*&: The checks are just on the form of the address; actual numerical
10561 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10562 check. The main use of these tests is to distinguish between IP addresses and
10563 host names, or between IPv4 and IPv6 addresses. For example, you could use
10564 .code
10565 ${if isip4{$sender_host_address}...
10566 .endd
10567 to test which IP version an incoming SMTP connection is using.
10568
10569 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10570 .cindex "LDAP" "use for authentication"
10571 .cindex "expansion" "LDAP authentication test"
10572 .cindex "&%ldapauth%& expansion condition"
10573 This condition supports user authentication using LDAP. See section
10574 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10575 queries. For this use, the query must contain a user name and password. The
10576 query itself is not used, and can be empty. The condition is true if the
10577 password is not empty, and the user name and password are accepted by the LDAP
10578 server. An empty password is rejected without calling LDAP because LDAP binds
10579 with an empty password are considered anonymous regardless of the username, and
10580 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10581 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10582 this can be used.
10583
10584
10585 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10586        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10587 .cindex "string" "comparison"
10588 .cindex "expansion" "string comparison"
10589 .cindex "&%le%& expansion condition"
10590 .cindex "&%lei%& expansion condition"
10591 The two substrings are first expanded. The condition is true if the first
10592 string is lexically less than or equal to the second string. For &%le%& the
10593 comparison includes the case of letters, whereas for &%lei%& the comparison is
10594 case-independent.
10595
10596 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10597        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10598 .cindex "string" "comparison"
10599 .cindex "expansion" "string comparison"
10600 .cindex "&%lt%& expansion condition"
10601 .cindex "&%lti%& expansion condition"
10602 The two substrings are first expanded. The condition is true if the first
10603 string is lexically less than the second string. For &%lt%& the comparison
10604 includes the case of letters, whereas for &%lti%& the comparison is
10605 case-independent.
10606
10607
10608 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10609 .cindex "expansion" "regular expression comparison"
10610 .cindex "regular expressions" "match in expanded string"
10611 .cindex "&%match%& expansion condition"
10612 The two substrings are first expanded. The second is then treated as a regular
10613 expression and applied to the first. Because of the pre-expansion, if the
10614 regular expression contains dollar, or backslash characters, they must be
10615 escaped. Care must also be taken if the regular expression contains braces
10616 (curly brackets). A closing brace must be escaped so that it is not taken as a
10617 premature termination of <&'string2'&>. The easiest approach is to use the
10618 &`\N`& feature to disable expansion of the regular expression.
10619 For example,
10620 .code
10621 ${if match {$local_part}{\N^\d{3}\N} ...
10622 .endd
10623 If the whole expansion string is in double quotes, further escaping of
10624 backslashes is also required.
10625
10626 The condition is true if the regular expression match succeeds.
10627 The regular expression is not required to begin with a circumflex
10628 metacharacter, but if there is no circumflex, the expression is not anchored,
10629 and it may match anywhere in the subject, not just at the start. If you want
10630 the pattern to match at the end of the subject, you must include the &`$`&
10631 metacharacter at an appropriate point.
10632
10633 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10634 At the start of an &%if%& expansion the values of the numeric variable
10635 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10636 succeeds causes them to be reset to the substrings of that condition and they
10637 will have these values during the expansion of the success string. At the end
10638 of the &%if%& expansion, the previous values are restored. After testing a
10639 combination of conditions using &%or%&, the subsequent values of the numeric
10640 variables are those of the condition that succeeded.
10641
10642 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10643 .cindex "&%match_address%& expansion condition"
10644 See &*match_local_part*&.
10645
10646 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10647 .cindex "&%match_domain%& expansion condition"
10648 See &*match_local_part*&.
10649
10650 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10651 .cindex "&%match_ip%& expansion condition"
10652 This condition matches an IP address to a list of IP address patterns. It must
10653 be followed by two argument strings. The first (after expansion) must be an IP
10654 address or an empty string. The second (not expanded) is a restricted host
10655 list that can match only an IP address, not a host name. For example:
10656 .code
10657 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10658 .endd
10659 The specific types of host list item that are permitted in the list are:
10660
10661 .ilist
10662 An IP address, optionally with a CIDR mask.
10663 .next
10664 A single asterisk, which matches any IP address.
10665 .next
10666 An empty item, which matches only if the IP address is empty. This could be
10667 useful for testing for a locally submitted message or one from specific hosts
10668 in a single test such as
10669 . ==== As this is a nested list, any displays it contains must be indented
10670 . ==== as otherwise they are too far to the left. This comment applies to
10671 . ==== the use of xmlto plus fop. There's no problem when formatting with
10672 . ==== sdop, with or without the extra indent.
10673 .code
10674   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10675 .endd
10676 where the first item in the list is the empty string.
10677 .next
10678 The item @[] matches any of the local host's interface addresses.
10679 .next
10680 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10681 even if &`net-`& is not specified. There is never any attempt to turn the IP
10682 address into a host name. The most common type of linear search for
10683 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10684 masks. For example:
10685 .code
10686   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10687 .endd
10688 It is of course possible to use other kinds of lookup, and in such a case, you
10689 do need to specify the &`net-`& prefix if you want to specify a specific
10690 address mask, for example:
10691 .code
10692   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10693 .endd
10694 However, unless you are combining a &%match_ip%& condition with others, it is
10695 just as easy to use the fact that a lookup is itself a condition, and write:
10696 .code
10697   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10698 .endd
10699 .endlist ilist
10700
10701 Note that <&'string2'&> is not itself subject to string expansion, unless
10702 Exim was built with the EXPAND_LISTMATCH_RHS option.
10703
10704 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10705
10706 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10707 .cindex "domain list" "in expansion condition"
10708 .cindex "address list" "in expansion condition"
10709 .cindex "local part" "list, in expansion condition"
10710 .cindex "&%match_local_part%& expansion condition"
10711 This condition, together with &%match_address%& and &%match_domain%&, make it
10712 possible to test domain, address, and local part lists within expansions. Each
10713 condition requires two arguments: an item and a list to match. A trivial
10714 example is:
10715 .code
10716 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10717 .endd
10718 In each case, the second argument may contain any of the allowable items for a
10719 list of the appropriate type. Also, because the second argument (after
10720 expansion) is a standard form of list, it is possible to refer to a named list.
10721 Thus, you can use conditions like this:
10722 .code
10723 ${if match_domain{$domain}{+local_domains}{...
10724 .endd
10725 .cindex "&`+caseful`&"
10726 For address lists, the matching starts off caselessly, but the &`+caseful`&
10727 item can be used, as in all address lists, to cause subsequent items to
10728 have their local parts matched casefully. Domains are always matched
10729 caselessly.
10730
10731 Note that <&'string2'&> is not itself subject to string expansion, unless
10732 Exim was built with the EXPAND_LISTMATCH_RHS option.
10733
10734 &*Note*&: Host lists are &'not'& supported in this way. This is because
10735 hosts have two identities: a name and an IP address, and it is not clear
10736 how to specify cleanly how such a test would work. However, IP addresses can be
10737 matched using &%match_ip%&.
10738
10739 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10740 .cindex "PAM authentication"
10741 .cindex "AUTH" "with PAM"
10742 .cindex "Solaris" "PAM support"
10743 .cindex "expansion" "PAM authentication test"
10744 .cindex "&%pam%& expansion condition"
10745 &'Pluggable Authentication Modules'&
10746 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10747 available in the latest releases of Solaris and in some GNU/Linux
10748 distributions. The Exim support, which is intended for use in conjunction with
10749 the SMTP AUTH command, is available only if Exim is compiled with
10750 .code
10751 SUPPORT_PAM=yes
10752 .endd
10753 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10754 in some releases of GNU/Linux &%-ldl%& is also needed.
10755
10756 The argument string is first expanded, and the result must be a
10757 colon-separated list of strings. Leading and trailing white space is ignored.
10758 The PAM module is initialized with the service name &"exim"& and the user name
10759 taken from the first item in the colon-separated data string (<&'string1'&>).
10760 The remaining items in the data string are passed over in response to requests
10761 from the authentication function. In the simple case there will only be one
10762 request, for a password, so the data consists of just two strings.
10763
10764 There can be problems if any of the strings are permitted to contain colon
10765 characters. In the usual way, these have to be doubled to avoid being taken as
10766 separators. If the data is being inserted from a variable, the &%sg%& expansion
10767 item can be used to double any existing colons. For example, the configuration
10768 of a LOGIN authenticator might contain this setting:
10769 .code
10770 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10771 .endd
10772 For a PLAIN authenticator you could use:
10773 .code
10774 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10775 .endd
10776 In some operating systems, PAM authentication can be done only from a process
10777 running as root. Since Exim is running as the Exim user when receiving
10778 messages, this means that PAM cannot be used directly in those systems.
10779 A patched version of the &'pam_unix'& module that comes with the
10780 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10781 The patched module allows one special uid/gid combination, in addition to root,
10782 to authenticate. If you build the patched module to allow the Exim user and
10783 group, PAM can then be used from an Exim authenticator.
10784
10785
10786 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10787 .cindex "&'pwcheck'& daemon"
10788 .cindex "Cyrus"
10789 .cindex "expansion" "&'pwcheck'& authentication test"
10790 .cindex "&%pwcheck%& expansion condition"
10791 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10792 This is one way of making it possible for passwords to be checked by a process
10793 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10794 deprecated. Its replacement is &'saslauthd'& (see below).
10795
10796 The pwcheck support is not included in Exim by default. You need to specify
10797 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10798 building Exim. For example:
10799 .code
10800 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10801 .endd
10802 You do not need to install the full Cyrus software suite in order to use
10803 the pwcheck daemon. You can compile and install just the daemon alone
10804 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10805 access to the &_/var/pwcheck_& directory.
10806
10807 The &%pwcheck%& condition takes one argument, which must be the user name and
10808 password, separated by a colon. For example, in a LOGIN authenticator
10809 configuration, you might have this:
10810 .code
10811 server_condition = ${if pwcheck{$auth1:$auth2}}
10812 .endd
10813 Again, for a PLAIN authenticator configuration, this would be:
10814 .code
10815 server_condition = ${if pwcheck{$auth2:$auth3}}
10816 .endd
10817 .vitem &*queue_running*&
10818 .cindex "queue runner" "detecting when delivering from"
10819 .cindex "expansion" "queue runner test"
10820 .cindex "&%queue_running%& expansion condition"
10821 This condition, which has no data, is true during delivery attempts that are
10822 initiated by queue runner processes, and false otherwise.
10823
10824
10825 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10826 .cindex "Radius"
10827 .cindex "expansion" "Radius authentication"
10828 .cindex "&%radius%& expansion condition"
10829 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10830 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10831 the Radius client configuration file in order to build Exim with Radius
10832 support.
10833
10834 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10835 library, using the original API. If you are using release 0.4.0 or later of
10836 this library, you need to set
10837 .code
10838 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10839 .endd
10840 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10841 &%libradius%& library that comes with FreeBSD. To do this, set
10842 .code
10843 RADIUS_LIB_TYPE=RADLIB
10844 .endd
10845 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10846 You may also have to supply a suitable setting in EXTRALIBS so that the
10847 Radius library can be found when Exim is linked.
10848
10849 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10850 Radius client library, which calls the Radius server. The condition is true if
10851 the authentication is successful. For example:
10852 .code
10853 server_condition = ${if radius{<arguments>}}
10854 .endd
10855
10856
10857 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10858         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10859 .cindex "&'saslauthd'& daemon"
10860 .cindex "Cyrus"
10861 .cindex "expansion" "&'saslauthd'& authentication test"
10862 .cindex "&%saslauthd%& expansion condition"
10863 This condition supports user authentication using the Cyrus &'saslauthd'&
10864 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10865 Using this daemon is one way of making it possible for passwords to be checked
10866 by a process that is not running as root.
10867
10868 The saslauthd support is not included in Exim by default. You need to specify
10869 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10870 building Exim. For example:
10871 .code
10872 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10873 .endd
10874 You do not need to install the full Cyrus software suite in order to use
10875 the saslauthd daemon. You can compile and install just the daemon alone
10876 from the Cyrus SASL library.
10877
10878 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10879 two are mandatory. For example:
10880 .code
10881 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10882 .endd
10883 The service and the realm are optional (which is why the arguments are enclosed
10884 in their own set of braces). For details of the meaning of the service and
10885 realm, and how to run the daemon, consult the Cyrus documentation.
10886 .endlist vlist
10887
10888
10889
10890 .section "Combining expansion conditions" "SECID84"
10891 .cindex "expansion" "combining conditions"
10892 Several conditions can be tested at once by combining them using the &%and%&
10893 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10894 conditions on their own, and precede their lists of sub-conditions. Each
10895 sub-condition must be enclosed in braces within the overall braces that contain
10896 the list. No repetition of &%if%& is used.
10897
10898
10899 .vlist
10900 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10901 .cindex "&""or""& expansion condition"
10902 .cindex "expansion" "&""or""& of conditions"
10903 The sub-conditions are evaluated from left to right. The condition is true if
10904 any one of the sub-conditions is true.
10905 For example,
10906 .code
10907 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10908 .endd
10909 When a true sub-condition is found, the following ones are parsed but not
10910 evaluated. If there are several &"match"& sub-conditions the values of the
10911 numeric variables afterwards are taken from the first one that succeeds.
10912
10913 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10914 .cindex "&""and""& expansion condition"
10915 .cindex "expansion" "&""and""& of conditions"
10916 The sub-conditions are evaluated from left to right. The condition is true if
10917 all of the sub-conditions are true. If there are several &"match"&
10918 sub-conditions, the values of the numeric variables afterwards are taken from
10919 the last one. When a false sub-condition is found, the following ones are
10920 parsed but not evaluated.
10921 .endlist
10922 .ecindex IIDexpcond
10923
10924
10925
10926
10927 .section "Expansion variables" "SECTexpvar"
10928 .cindex "expansion" "variables, list of"
10929 This section contains an alphabetical list of all the expansion variables. Some
10930 of them are available only when Exim is compiled with specific options such as
10931 support for TLS or the content scanning extension.
10932
10933 .vlist
10934 .vitem "&$0$&, &$1$&, etc"
10935 .cindex "numerical variables (&$1$& &$2$& etc)"
10936 When a &%match%& expansion condition succeeds, these variables contain the
10937 captured substrings identified by the regular expression during subsequent
10938 processing of the success string of the containing &%if%& expansion item.
10939 However, they do not retain their values afterwards; in fact, their previous
10940 values are restored at the end of processing an &%if%& item. The numerical
10941 variables may also be set externally by some other matching process which
10942 precedes the expansion of the string. For example, the commands available in
10943 Exim filter files include an &%if%& command with its own regular expression
10944 matching condition.
10945
10946 .vitem "&$acl_c...$&"
10947 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10948 can be given any name that starts with &$acl_c$& and is at least six characters
10949 long, but the sixth character must be either a digit or an underscore. For
10950 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10951 variables persist throughout the lifetime of an SMTP connection. They can be
10952 used to pass information between ACLs and between different invocations of the
10953 same ACL. When a message is received, the values of these variables are saved
10954 with the message, and can be accessed by filters, routers, and transports
10955 during subsequent delivery.
10956
10957 .vitem "&$acl_m...$&"
10958 These variables are like the &$acl_c...$& variables, except that their values
10959 are reset after a message has been received. Thus, if several messages are
10960 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10961 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10962 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10963 message is received, the values of these variables are saved with the message,
10964 and can be accessed by filters, routers, and transports during subsequent
10965 delivery.
10966
10967 .vitem &$acl_verify_message$&
10968 .vindex "&$acl_verify_message$&"
10969 After an address verification has failed, this variable contains the failure
10970 message. It retains its value for use in subsequent modifiers. The message can
10971 be preserved by coding like this:
10972 .code
10973 warn !verify = sender
10974      set acl_m0 = $acl_verify_message
10975 .endd
10976 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10977 &%log_message%& modifiers, to include information about the verification
10978 failure.
10979
10980 .vitem &$address_data$&
10981 .vindex "&$address_data$&"
10982 This variable is set by means of the &%address_data%& option in routers. The
10983 value then remains with the address while it is processed by subsequent routers
10984 and eventually a transport. If the transport is handling multiple addresses,
10985 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10986 for more details. &*Note*&: The contents of &$address_data$& are visible in
10987 user filter files.
10988
10989 If &$address_data$& is set when the routers are called from an ACL to verify
10990 a recipient address, the final value is still in the variable for subsequent
10991 conditions and modifiers of the ACL statement. If routing the address caused it
10992 to be redirected to just one address, the child address is also routed as part
10993 of the verification, and in this case the final value of &$address_data$& is
10994 from the child's routing.
10995
10996 If &$address_data$& is set when the routers are called from an ACL to verify a
10997 sender address, the final value is also preserved, but this time in
10998 &$sender_address_data$&, to distinguish it from data from a recipient
10999 address.
11000
11001 In both cases (recipient and sender verification), the value does not persist
11002 after the end of the current ACL statement. If you want to preserve
11003 these values for longer, you can save them in ACL variables.
11004
11005 .vitem &$address_file$&
11006 .vindex "&$address_file$&"
11007 When, as a result of aliasing, forwarding, or filtering, a message is directed
11008 to a specific file, this variable holds the name of the file when the transport
11009 is running. At other times, the variable is empty. For example, using the
11010 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11011 .code
11012 /home/r2d2/savemail
11013 .endd
11014 then when the &(address_file)& transport is running, &$address_file$&
11015 contains the text string &`/home/r2d2/savemail`&.
11016 .cindex "Sieve filter" "value of &$address_file$&"
11017 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11018 then up to the transport configuration to generate an appropriate absolute path
11019 to the relevant file.
11020
11021 .vitem &$address_pipe$&
11022 .vindex "&$address_pipe$&"
11023 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11024 this variable holds the pipe command when the transport is running.
11025
11026 .vitem "&$auth1$& &-- &$auth3$&"
11027 .vindex "&$auth1$&, &$auth2$&, etc"
11028 These variables are used in SMTP authenticators (see chapters
11029 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11030
11031 .vitem &$authenticated_id$&
11032 .cindex "authentication" "id"
11033 .vindex "&$authenticated_id$&"
11034 When a server successfully authenticates a client it may be configured to
11035 preserve some of the authentication information in the variable
11036 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11037 user/password authenticator configuration might preserve the user name for use
11038 in the routers. Note that this is not the same information that is saved in
11039 &$sender_host_authenticated$&.
11040 When a message is submitted locally (that is, not over a TCP connection)
11041 the value of &$authenticated_id$& is normally the login name of the calling
11042 process. However, a trusted user can override this by means of the &%-oMai%&
11043 command line option.
11044
11045 .vitem &$authenticated_fail_id$&
11046 .cindex "authentication" "fail" "id"
11047 .vindex "&$authenticated_fail_id$&"
11048 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11049 will contain the failed authentication id. If more than one authentication
11050 id is attempted, it will contain only the last one. The variable is
11051 available for processing in the ACL's, generally the quit or notquit ACL.
11052 A message to a local recipient could still be accepted without requiring
11053 authentication, which means this variable could also be visible in all of
11054 the ACL's as well.
11055
11056
11057 .vitem &$authenticated_sender$&
11058 .cindex "sender" "authenticated"
11059 .cindex "authentication" "sender"
11060 .cindex "AUTH" "on MAIL command"
11061 .vindex "&$authenticated_sender$&"
11062 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11063 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11064 described in section &<<SECTauthparamail>>&. Unless the data is the string
11065 &"<>"&, it is set as the authenticated sender of the message, and the value is
11066 available during delivery in the &$authenticated_sender$& variable. If the
11067 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11068
11069 .vindex "&$qualify_domain$&"
11070 When a message is submitted locally (that is, not over a TCP connection), the
11071 value of &$authenticated_sender$& is an address constructed from the login
11072 name of the calling process and &$qualify_domain$&, except that a trusted user
11073 can override this by means of the &%-oMas%& command line option.
11074
11075
11076 .vitem &$authentication_failed$&
11077 .cindex "authentication" "failure"
11078 .vindex "&$authentication_failed$&"
11079 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11080 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11081 possible to distinguish between &"did not try to authenticate"&
11082 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11083 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11084 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11085 negative response to an AUTH command, including (for example) an attempt to use
11086 an undefined mechanism.
11087
11088 .vitem &$av_failed$&
11089 .cindex "content scanning" "AV scanner failure"
11090 This variable is available when Exim is compiled with the content-scanning
11091 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11092 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11093 the ACL malware condition.
11094
11095 .vitem &$body_linecount$&
11096 .cindex "message body" "line count"
11097 .cindex "body of message" "line count"
11098 .vindex "&$body_linecount$&"
11099 When a message is being received or delivered, this variable contains the
11100 number of lines in the message's body. See also &$message_linecount$&.
11101
11102 .vitem &$body_zerocount$&
11103 .cindex "message body" "binary zero count"
11104 .cindex "body of message" "binary zero count"
11105 .cindex "binary zero" "in message body"
11106 .vindex "&$body_zerocount$&"
11107 When a message is being received or delivered, this variable contains the
11108 number of binary zero bytes (ASCII NULs) in the message's body.
11109
11110 .vitem &$bounce_recipient$&
11111 .vindex "&$bounce_recipient$&"
11112 This is set to the recipient address of a bounce message while Exim is creating
11113 it. It is useful if a customized bounce message text file is in use (see
11114 chapter &<<CHAPemsgcust>>&).
11115
11116 .vitem &$bounce_return_size_limit$&
11117 .vindex "&$bounce_return_size_limit$&"
11118 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11119 up to a multiple of 1000. It is useful when a customized error message text
11120 file is in use (see chapter &<<CHAPemsgcust>>&).
11121
11122 .vitem &$caller_gid$&
11123 .cindex "gid (group id)" "caller"
11124 .vindex "&$caller_gid$&"
11125 The real group id under which the process that called Exim was running. This is
11126 not the same as the group id of the originator of a message (see
11127 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11128 incarnation normally contains the Exim gid.
11129
11130 .vitem &$caller_uid$&
11131 .cindex "uid (user id)" "caller"
11132 .vindex "&$caller_uid$&"
11133 The real user id under which the process that called Exim was running. This is
11134 not the same as the user id of the originator of a message (see
11135 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11136 incarnation normally contains the Exim uid.
11137
11138 .vitem &$compile_date$&
11139 .vindex "&$compile_date$&"
11140 The date on which the Exim binary was compiled.
11141
11142 .vitem &$compile_number$&
11143 .vindex "&$compile_number$&"
11144 The building process for Exim keeps a count of the number
11145 of times it has been compiled. This serves to distinguish different
11146 compilations of the same version of the program.
11147
11148 .vitem &$demime_errorlevel$&
11149 .vindex "&$demime_errorlevel$&"
11150 This variable is available when Exim is compiled with
11151 the content-scanning extension and the obsolete &%demime%& condition. For
11152 details, see section &<<SECTdemimecond>>&.
11153
11154 .vitem &$demime_reason$&
11155 .vindex "&$demime_reason$&"
11156 This variable is available when Exim is compiled with the
11157 content-scanning extension and the obsolete &%demime%& condition. For details,
11158 see section &<<SECTdemimecond>>&.
11159
11160 .vitem &$dnslist_domain$& &&&
11161        &$dnslist_matched$& &&&
11162        &$dnslist_text$& &&&
11163        &$dnslist_value$&
11164 .vindex "&$dnslist_domain$&"
11165 .vindex "&$dnslist_matched$&"
11166 .vindex "&$dnslist_text$&"
11167 .vindex "&$dnslist_value$&"
11168 .cindex "black list (DNS)"
11169 When a DNS (black) list lookup succeeds, these variables are set to contain
11170 the following data from the lookup: the list's domain name, the key that was
11171 looked up, the contents of any associated TXT record, and the value from the
11172 main A record. See section &<<SECID204>>& for more details.
11173
11174 .vitem &$domain$&
11175 .vindex "&$domain$&"
11176 When an address is being routed, or delivered on its own, this variable
11177 contains the domain. Uppercase letters in the domain are converted into lower
11178 case for &$domain$&.
11179
11180 Global address rewriting happens when a message is received, so the value of
11181 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11182 is set during user filtering, but not during system filtering, because a
11183 message may have many recipients and the system filter is called just once.
11184
11185 When more than one address is being delivered at once (for example, several
11186 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11187 have the same domain. Transports can be restricted to handling only one domain
11188 at a time if the value of &$domain$& is required at transport time &-- this is
11189 the default for local transports. For further details of the environment in
11190 which local transports are run, see chapter &<<CHAPenvironment>>&.
11191
11192 .oindex "&%delay_warning_condition%&"
11193 At the end of a delivery, if all deferred addresses have the same domain, it is
11194 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11195
11196 The &$domain$& variable is also used in some other circumstances:
11197
11198 .ilist
11199 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11200 the recipient address. The domain of the &'sender'& address is in
11201 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11202 normally set during the running of the MAIL ACL. However, if the sender address
11203 is verified with a callout during the MAIL ACL, the sender domain is placed in
11204 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11205 the &(smtp)& transport.
11206
11207 .next
11208 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11209 &$domain$& contains the domain portion of the address that is being rewritten;
11210 it can be used in the expansion of the replacement address, for example, to
11211 rewrite domains by file lookup.
11212
11213 .next
11214 With one important exception, whenever a domain list is being scanned,
11215 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11216 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11217 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11218 that, in a RCPT ACL, the sender domain list can be dependent on the
11219 recipient domain (which is what is in &$domain$& at this time).
11220
11221 .next
11222 .cindex "ETRN" "value of &$domain$&"
11223 .oindex "&%smtp_etrn_command%&"
11224 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11225 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11226 .endlist
11227
11228
11229 .vitem &$domain_data$&
11230 .vindex "&$domain_data$&"
11231 When the &%domains%& option on a router matches a domain by
11232 means of a lookup, the data read by the lookup is available during the running
11233 of the router as &$domain_data$&. In addition, if the driver routes the
11234 address to a transport, the value is available in that transport. If the
11235 transport is handling multiple addresses, the value from the first address is
11236 used.
11237
11238 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11239 domain by means of a lookup. The data read by the lookup is available during
11240 the rest of the ACL statement. In all other situations, this variable expands
11241 to nothing.
11242
11243 .vitem &$exim_gid$&
11244 .vindex "&$exim_gid$&"
11245 This variable contains the numerical value of the Exim group id.
11246
11247 .vitem &$exim_path$&
11248 .vindex "&$exim_path$&"
11249 This variable contains the path to the Exim binary.
11250
11251 .vitem &$exim_uid$&
11252 .vindex "&$exim_uid$&"
11253 This variable contains the numerical value of the Exim user id.
11254
11255 .vitem &$found_extension$&
11256 .vindex "&$found_extension$&"
11257 This variable is available when Exim is compiled with the
11258 content-scanning extension and the obsolete &%demime%& condition. For details,
11259 see section &<<SECTdemimecond>>&.
11260
11261 .vitem &$header_$&<&'name'&>
11262 This is not strictly an expansion variable. It is expansion syntax for
11263 inserting the message header line with the given name. Note that the name must
11264 be terminated by colon or white space, because it may contain a wide variety of
11265 characters. Note also that braces must &'not'& be used.
11266
11267 .vitem &$headers_added$&
11268 .vindex "&$headers_added$&"
11269 Within an ACL this variable contains the headers added so far by
11270 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11271 The headers are a newline-separated list.
11272
11273 .vitem &$home$&
11274 .vindex "&$home$&"
11275 When the &%check_local_user%& option is set for a router, the user's home
11276 directory is placed in &$home$& when the check succeeds. In particular, this
11277 means it is set during the running of users' filter files. A router may also
11278 explicitly set a home directory for use by a transport; this can be overridden
11279 by a setting on the transport itself.
11280
11281 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11282 of the environment variable HOME.
11283
11284 .vitem &$host$&
11285 .vindex "&$host$&"
11286 If a router assigns an address to a transport (any transport), and passes a
11287 list of hosts with the address, the value of &$host$& when the transport starts
11288 to run is the name of the first host on the list. Note that this applies both
11289 to local and remote transports.
11290
11291 .cindex "transport" "filter"
11292 .cindex "filter" "transport filter"
11293 For the &(smtp)& transport, if there is more than one host, the value of
11294 &$host$& changes as the transport works its way through the list. In
11295 particular, when the &(smtp)& transport is expanding its options for encryption
11296 using TLS, or for specifying a transport filter (see chapter
11297 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11298 is connected.
11299
11300 When used in the client part of an authenticator configuration (see chapter
11301 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11302 client is connected.
11303
11304
11305 .vitem &$host_address$&
11306 .vindex "&$host_address$&"
11307 This variable is set to the remote host's IP address whenever &$host$& is set
11308 for a remote connection. It is also set to the IP address that is being checked
11309 when the &%ignore_target_hosts%& option is being processed.
11310
11311 .vitem &$host_data$&
11312 .vindex "&$host_data$&"
11313 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11314 result of the lookup is made available in the &$host_data$& variable. This
11315 allows you, for example, to do things like this:
11316 .code
11317 deny  hosts = net-lsearch;/some/file
11318 message = $host_data
11319 .endd
11320 .vitem &$host_lookup_deferred$&
11321 .cindex "host name" "lookup, failure of"
11322 .vindex "&$host_lookup_deferred$&"
11323 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11324 message comes from a remote host and there is an attempt to look up the host's
11325 name from its IP address, and the attempt is not successful, one of these
11326 variables is set to &"1"&.
11327
11328 .ilist
11329 If the lookup receives a definite negative response (for example, a DNS lookup
11330 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11331
11332 .next
11333 If there is any kind of problem during the lookup, such that Exim cannot
11334 tell whether or not the host name is defined (for example, a timeout for a DNS
11335 lookup), &$host_lookup_deferred$& is set to &"1"&.
11336 .endlist ilist
11337
11338 Looking up a host's name from its IP address consists of more than just a
11339 single reverse lookup. Exim checks that a forward lookup of at least one of the
11340 names it receives from a reverse lookup yields the original IP address. If this
11341 is not the case, Exim does not accept the looked up name(s), and
11342 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11343 IP address (for example, the existence of a PTR record in the DNS) is not
11344 sufficient on its own for the success of a host name lookup. If the reverse
11345 lookup succeeds, but there is a lookup problem such as a timeout when checking
11346 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11347 &"1"&. See also &$sender_host_name$&.
11348
11349 .vitem &$host_lookup_failed$&
11350 .vindex "&$host_lookup_failed$&"
11351 See &$host_lookup_deferred$&.
11352
11353
11354 .vitem &$inode$&
11355 .vindex "&$inode$&"
11356 The only time this variable is set is while expanding the &%directory_file%&
11357 option in the &(appendfile)& transport. The variable contains the inode number
11358 of the temporary file which is about to be renamed. It can be used to construct
11359 a unique name for the file.
11360
11361 .vitem &$interface_address$&
11362 .vindex "&$interface_address$&"
11363 This is an obsolete name for &$received_ip_address$&.
11364
11365 .vitem &$interface_port$&
11366 .vindex "&$interface_port$&"
11367 This is an obsolete name for &$received_port$&.
11368
11369 .vitem &$item$&
11370 .vindex "&$item$&"
11371 This variable is used during the expansion of &*forall*& and &*forany*&
11372 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11373 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11374 empty.
11375
11376 .vitem &$ldap_dn$&
11377 .vindex "&$ldap_dn$&"
11378 This variable, which is available only when Exim is compiled with LDAP support,
11379 contains the DN from the last entry in the most recently successful LDAP
11380 lookup.
11381
11382 .vitem &$load_average$&
11383 .vindex "&$load_average$&"
11384 This variable contains the system load average, multiplied by 1000 so that it
11385 is an integer. For example, if the load average is 0.21, the value of the
11386 variable is 210. The value is recomputed every time the variable is referenced.
11387
11388 .vitem &$local_part$&
11389 .vindex "&$local_part$&"
11390 When an address is being routed, or delivered on its own, this
11391 variable contains the local part. When a number of addresses are being
11392 delivered together (for example, multiple RCPT commands in an SMTP
11393 session), &$local_part$& is not set.
11394
11395 Global address rewriting happens when a message is received, so the value of
11396 &$local_part$& during routing and delivery is the value after rewriting.
11397 &$local_part$& is set during user filtering, but not during system filtering,
11398 because a message may have many recipients and the system filter is called just
11399 once.
11400
11401 .vindex "&$local_part_prefix$&"
11402 .vindex "&$local_part_suffix$&"
11403 If a local part prefix or suffix has been recognized, it is not included in the
11404 value of &$local_part$& during routing and subsequent delivery. The values of
11405 any prefix or suffix are in &$local_part_prefix$& and
11406 &$local_part_suffix$&, respectively.
11407
11408 When a message is being delivered to a file, pipe, or autoreply transport as a
11409 result of aliasing or forwarding, &$local_part$& is set to the local part of
11410 the parent address, not to the file name or command (see &$address_file$& and
11411 &$address_pipe$&).
11412
11413 When an ACL is running for a RCPT command, &$local_part$& contains the
11414 local part of the recipient address.
11415
11416 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11417 &$local_part$& contains the local part of the address that is being rewritten;
11418 it can be used in the expansion of the replacement address, for example.
11419
11420 In all cases, all quoting is removed from the local part. For example, for both
11421 the addresses
11422 .code
11423 "abc:xyz"@test.example
11424 abc\:xyz@test.example
11425 .endd
11426 the value of &$local_part$& is
11427 .code
11428 abc:xyz
11429 .endd
11430 If you use &$local_part$& to create another address, you should always wrap it
11431 inside a quoting operator. For example, in a &(redirect)& router you could
11432 have:
11433 .code
11434 data = ${quote_local_part:$local_part}@new.domain.example
11435 .endd
11436 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11437 to process local parts in a case-dependent manner in a router, you can set the
11438 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11439
11440 .vitem &$local_part_data$&
11441 .vindex "&$local_part_data$&"
11442 When the &%local_parts%& option on a router matches a local part by means of a
11443 lookup, the data read by the lookup is available during the running of the
11444 router as &$local_part_data$&. In addition, if the driver routes the address
11445 to a transport, the value is available in that transport. If the transport is
11446 handling multiple addresses, the value from the first address is used.
11447
11448 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11449 matches a local part by means of a lookup. The data read by the lookup is
11450 available during the rest of the ACL statement. In all other situations, this
11451 variable expands to nothing.
11452
11453 .vitem &$local_part_prefix$&
11454 .vindex "&$local_part_prefix$&"
11455 When an address is being routed or delivered, and a
11456 specific prefix for the local part was recognized, it is available in this
11457 variable, having been removed from &$local_part$&.
11458
11459 .vitem &$local_part_suffix$&
11460 .vindex "&$local_part_suffix$&"
11461 When an address is being routed or delivered, and a
11462 specific suffix for the local part was recognized, it is available in this
11463 variable, having been removed from &$local_part$&.
11464
11465 .vitem &$local_scan_data$&
11466 .vindex "&$local_scan_data$&"
11467 This variable contains the text returned by the &[local_scan()]& function when
11468 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11469
11470 .vitem &$local_user_gid$&
11471 .vindex "&$local_user_gid$&"
11472 See &$local_user_uid$&.
11473
11474 .vitem &$local_user_uid$&
11475 .vindex "&$local_user_uid$&"
11476 This variable and &$local_user_gid$& are set to the uid and gid after the
11477 &%check_local_user%& router precondition succeeds. This means that their values
11478 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11479 and &%condition%&), for the &%address_data%& expansion, and for any
11480 router-specific expansions. At all other times, the values in these variables
11481 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11482
11483 .vitem &$localhost_number$&
11484 .vindex "&$localhost_number$&"
11485 This contains the expanded value of the
11486 &%localhost_number%& option. The expansion happens after the main options have
11487 been read.
11488
11489 .vitem &$log_inodes$&
11490 .vindex "&$log_inodes$&"
11491 The number of free inodes in the disk partition where Exim's
11492 log files are being written. The value is recalculated whenever the variable is
11493 referenced. If the relevant file system does not have the concept of inodes,
11494 the value of is -1. See also the &%check_log_inodes%& option.
11495
11496 .vitem &$log_space$&
11497 .vindex "&$log_space$&"
11498 The amount of free space (as a number of kilobytes) in the disk
11499 partition where Exim's log files are being written. The value is recalculated
11500 whenever the variable is referenced. If the operating system does not have the
11501 ability to find the amount of free space (only true for experimental systems),
11502 the space value is -1. See also the &%check_log_space%& option.
11503
11504
11505 .new
11506 .vitem &$lookup_dnssec_authenticated$&
11507 .vindex "&$lookup_dnssec_authenticated$&"
11508 This variable is set after a DNS lookup done by
11509 a dnsdb lookup expansion, dnslookup router or smtp transport.
11510 It will be empty if &(DNSSEC)& was not requested,
11511 &"no"& if the result was not labelled as authenticated data
11512 and &"yes"& if it was.
11513 .wen
11514
11515 .vitem &$mailstore_basename$&
11516 .vindex "&$mailstore_basename$&"
11517 This variable is set only when doing deliveries in &"mailstore"& format in the
11518 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11519 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11520 contains the basename of the files that are being written, that is, the name
11521 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11522 variable is empty.
11523
11524 .vitem &$malware_name$&
11525 .vindex "&$malware_name$&"
11526 This variable is available when Exim is compiled with the
11527 content-scanning extension. It is set to the name of the virus that was found
11528 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11529
11530 .vitem &$max_received_linelength$&
11531 .vindex "&$max_received_linelength$&"
11532 .cindex "maximum" "line length"
11533 .cindex "line length" "maximum"
11534 This variable contains the number of bytes in the longest line that was
11535 received as part of the message, not counting the line termination
11536 character(s).
11537
11538 .vitem &$message_age$&
11539 .cindex "message" "age of"
11540 .vindex "&$message_age$&"
11541 This variable is set at the start of a delivery attempt to contain the number
11542 of seconds since the message was received. It does not change during a single
11543 delivery attempt.
11544
11545 .vitem &$message_body$&
11546 .cindex "body of message" "expansion variable"
11547 .cindex "message body" "in expansion"
11548 .cindex "binary zero" "in message body"
11549 .vindex "&$message_body$&"
11550 .oindex "&%message_body_visible%&"
11551 This variable contains the initial portion of a message's body while it is
11552 being delivered, and is intended mainly for use in filter files. The maximum
11553 number of characters of the body that are put into the variable is set by the
11554 &%message_body_visible%& configuration option; the default is 500.
11555
11556 .oindex "&%message_body_newlines%&"
11557 By default, newlines are converted into spaces in &$message_body$&, to make it
11558 easier to search for phrases that might be split over a line break. However,
11559 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11560 zeros are always converted into spaces.
11561
11562 .vitem &$message_body_end$&
11563 .cindex "body of message" "expansion variable"
11564 .cindex "message body" "in expansion"
11565 .vindex "&$message_body_end$&"
11566 This variable contains the final portion of a message's
11567 body while it is being delivered. The format and maximum size are as for
11568 &$message_body$&.
11569
11570 .vitem &$message_body_size$&
11571 .cindex "body of message" "size"
11572 .cindex "message body" "size"
11573 .vindex "&$message_body_size$&"
11574 When a message is being delivered, this variable contains the size of the body
11575 in bytes. The count starts from the character after the blank line that
11576 separates the body from the header. Newlines are included in the count. See
11577 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11578
11579 .vitem &$message_exim_id$&
11580 .vindex "&$message_exim_id$&"
11581 When a message is being received or delivered, this variable contains the
11582 unique message id that is generated and used by Exim to identify the message.
11583 An id is not created for a message until after its header has been successfully
11584 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11585 line; it is the local id that Exim assigns to the message, for example:
11586 &`1BXTIK-0001yO-VA`&.
11587
11588 .vitem &$message_headers$&
11589 .vindex &$message_headers$&
11590 This variable contains a concatenation of all the header lines when a message
11591 is being processed, except for lines added by routers or transports. The header
11592 lines are separated by newline characters. Their contents are decoded in the
11593 same way as a header line that is inserted by &%bheader%&.
11594
11595 .vitem &$message_headers_raw$&
11596 .vindex &$message_headers_raw$&
11597 This variable is like &$message_headers$& except that no processing of the
11598 contents of header lines is done.
11599
11600 .vitem &$message_id$&
11601 This is an old name for &$message_exim_id$&, which is now deprecated.
11602
11603 .vitem &$message_linecount$&
11604 .vindex "&$message_linecount$&"
11605 This variable contains the total number of lines in the header and body of the
11606 message. Compare &$body_linecount$&, which is the count for the body only.
11607 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11608 number of lines received. Before delivery happens (that is, before filters,
11609 routers, and transports run) the count is increased to include the
11610 &'Received:'& header line that Exim standardly adds, and also any other header
11611 lines that are added by ACLs. The blank line that separates the message header
11612 from the body is not counted.
11613
11614 As with the special case of &$message_size$&, during the expansion of the
11615 appendfile transport's maildir_tag option in maildir format, the value of
11616 &$message_linecount$& is the precise size of the number of newlines in the
11617 file that has been written (minus one for the blank line between the
11618 header and the body).
11619
11620 Here is an example of the use of this variable in a DATA ACL:
11621 .code
11622 deny message   = Too many lines in message header
11623      condition = \
11624       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11625 .endd
11626 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11627 message has not yet been received.
11628
11629 .vitem &$message_size$&
11630 .cindex "size" "of message"
11631 .cindex "message" "size"
11632 .vindex "&$message_size$&"
11633 When a message is being processed, this variable contains its size in bytes. In
11634 most cases, the size includes those headers that were received with the
11635 message, but not those (such as &'Envelope-to:'&) that are added to individual
11636 deliveries as they are written. However, there is one special case: during the
11637 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11638 doing a delivery in maildir format, the value of &$message_size$& is the
11639 precise size of the file that has been written. See also
11640 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11641
11642 .cindex "RCPT" "value of &$message_size$&"
11643 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11644 contains the size supplied on the MAIL command, or -1 if no size was given. The
11645 value may not, of course, be truthful.
11646
11647 .vitem &$mime_$&&'xxx'&
11648 A number of variables whose names start with &$mime$& are
11649 available when Exim is compiled with the content-scanning extension. For
11650 details, see section &<<SECTscanmimepart>>&.
11651
11652 .vitem "&$n0$& &-- &$n9$&"
11653 These variables are counters that can be incremented by means
11654 of the &%add%& command in filter files.
11655
11656 .vitem &$original_domain$&
11657 .vindex "&$domain$&"
11658 .vindex "&$original_domain$&"
11659 When a top-level address is being processed for delivery, this contains the
11660 same value as &$domain$&. However, if a &"child"& address (for example,
11661 generated by an alias, forward, or filter file) is being processed, this
11662 variable contains the domain of the original address (lower cased). This
11663 differs from &$parent_domain$& only when there is more than one level of
11664 aliasing or forwarding. When more than one address is being delivered in a
11665 single transport run, &$original_domain$& is not set.
11666
11667 If a new address is created by means of a &%deliver%& command in a system
11668 filter, it is set up with an artificial &"parent"& address. This has the local
11669 part &'system-filter'& and the default qualify domain.
11670
11671 .vitem &$original_local_part$&
11672 .vindex "&$local_part$&"
11673 .vindex "&$original_local_part$&"
11674 When a top-level address is being processed for delivery, this contains the
11675 same value as &$local_part$&, unless a prefix or suffix was removed from the
11676 local part, because &$original_local_part$& always contains the full local
11677 part. When a &"child"& address (for example, generated by an alias, forward, or
11678 filter file) is being processed, this variable contains the full local part of
11679 the original address.
11680
11681 If the router that did the redirection processed the local part
11682 case-insensitively, the value in &$original_local_part$& is in lower case.
11683 This variable differs from &$parent_local_part$& only when there is more than
11684 one level of aliasing or forwarding. When more than one address is being
11685 delivered in a single transport run, &$original_local_part$& is not set.
11686
11687 If a new address is created by means of a &%deliver%& command in a system
11688 filter, it is set up with an artificial &"parent"& address. This has the local
11689 part &'system-filter'& and the default qualify domain.
11690
11691 .vitem &$originator_gid$&
11692 .cindex "gid (group id)" "of originating user"
11693 .cindex "sender" "gid"
11694 .vindex "&$caller_gid$&"
11695 .vindex "&$originator_gid$&"
11696 This variable contains the value of &$caller_gid$& that was set when the
11697 message was received. For messages received via the command line, this is the
11698 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11699 normally the gid of the Exim user.
11700
11701 .vitem &$originator_uid$&
11702 .cindex "uid (user id)" "of originating user"
11703 .cindex "sender" "uid"
11704 .vindex "&$caller_uid$&"
11705 .vindex "&$originaltor_uid$&"
11706 The value of &$caller_uid$& that was set when the message was received. For
11707 messages received via the command line, this is the uid of the sending user.
11708 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11709 user.
11710
11711 .vitem &$parent_domain$&
11712 .vindex "&$parent_domain$&"
11713 This variable is similar to &$original_domain$& (see
11714 above), except that it refers to the immediately preceding parent address.
11715
11716 .vitem &$parent_local_part$&
11717 .vindex "&$parent_local_part$&"
11718 This variable is similar to &$original_local_part$&
11719 (see above), except that it refers to the immediately preceding parent address.
11720
11721 .vitem &$pid$&
11722 .cindex "pid (process id)" "of current process"
11723 .vindex "&$pid$&"
11724 This variable contains the current process id.
11725
11726 .vitem &$pipe_addresses$&
11727 .cindex "filter" "transport filter"
11728 .cindex "transport" "filter"
11729 .vindex "&$pipe_addresses$&"
11730 This is not an expansion variable, but is mentioned here because the string
11731 &`$pipe_addresses`& is handled specially in the command specification for the
11732 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11733 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11734 It cannot be used in general expansion strings, and provokes an &"unknown
11735 variable"& error if encountered.
11736
11737 .vitem &$primary_hostname$&
11738 .vindex "&$primary_hostname$&"
11739 This variable contains the value set by &%primary_hostname%& in the
11740 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11741 a single-component name, Exim calls &[gethostbyname()]& (or
11742 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11743 qualified host name. See also &$smtp_active_hostname$&.
11744
11745
11746 .vitem &$prvscheck_address$&
11747 This variable is used in conjunction with the &%prvscheck%& expansion item,
11748 which is described in sections &<<SECTexpansionitems>>& and
11749 &<<SECTverifyPRVS>>&.
11750
11751 .vitem &$prvscheck_keynum$&
11752 This variable is used in conjunction with the &%prvscheck%& expansion item,
11753 which is described in sections &<<SECTexpansionitems>>& and
11754 &<<SECTverifyPRVS>>&.
11755
11756 .vitem &$prvscheck_result$&
11757 This variable is used in conjunction with the &%prvscheck%& expansion item,
11758 which is described in sections &<<SECTexpansionitems>>& and
11759 &<<SECTverifyPRVS>>&.
11760
11761 .vitem &$qualify_domain$&
11762 .vindex "&$qualify_domain$&"
11763 The value set for the &%qualify_domain%& option in the configuration file.
11764
11765 .vitem &$qualify_recipient$&
11766 .vindex "&$qualify_recipient$&"
11767 The value set for the &%qualify_recipient%& option in the configuration file,
11768 or if not set, the value of &$qualify_domain$&.
11769
11770 .vitem &$rcpt_count$&
11771 .vindex "&$rcpt_count$&"
11772 When a message is being received by SMTP, this variable contains the number of
11773 RCPT commands received for the current message. If this variable is used in a
11774 RCPT ACL, its value includes the current command.
11775
11776 .vitem &$rcpt_defer_count$&
11777 .vindex "&$rcpt_defer_count$&"
11778 .cindex "4&'xx'& responses" "count of"
11779 When a message is being received by SMTP, this variable contains the number of
11780 RCPT commands in the current message that have previously been rejected with a
11781 temporary (4&'xx'&) response.
11782
11783 .vitem &$rcpt_fail_count$&
11784 .vindex "&$rcpt_fail_count$&"
11785 When a message is being received by SMTP, this variable contains the number of
11786 RCPT commands in the current message that have previously been rejected with a
11787 permanent (5&'xx'&) response.
11788
11789 .vitem &$received_count$&
11790 .vindex "&$received_count$&"
11791 This variable contains the number of &'Received:'& header lines in the message,
11792 including the one added by Exim (so its value is always greater than zero). It
11793 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11794 delivering.
11795
11796 .vitem &$received_for$&
11797 .vindex "&$received_for$&"
11798 If there is only a single recipient address in an incoming message, this
11799 variable contains that address when the &'Received:'& header line is being
11800 built. The value is copied after recipient rewriting has happened, but before
11801 the &[local_scan()]& function is run.
11802
11803 .vitem &$received_ip_address$&
11804 .vindex "&$received_ip_address$&"
11805 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11806 variable is set to the address of the local IP interface, and &$received_port$&
11807 is set to the local port number. (The remote IP address and port are in
11808 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11809 the port value is -1 unless it has been set using the &%-oMi%& command line
11810 option.
11811
11812 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11813 could be used, for example, to make the file name for a TLS certificate depend
11814 on which interface and/or port is being used for the incoming connection. The
11815 values of &$received_ip_address$& and &$received_port$& are saved with any
11816 messages that are received, thus making these variables available at delivery
11817 time.
11818
11819 &*Note:*& There are no equivalent variables for outgoing connections, because
11820 the values are unknown (unless they are explicitly set by options of the
11821 &(smtp)& transport).
11822
11823 .vitem &$received_port$&
11824 .vindex "&$received_port$&"
11825 See &$received_ip_address$&.
11826
11827 .vitem &$received_protocol$&
11828 .vindex "&$received_protocol$&"
11829 When a message is being processed, this variable contains the name of the
11830 protocol by which it was received. Most of the names used by Exim are defined
11831 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11832 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11833 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11834 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11835 connection and the client was successfully authenticated.
11836
11837 Exim uses the protocol name &"smtps"& for the case when encryption is
11838 automatically set up on connection without the use of STARTTLS (see
11839 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11840 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11841 where the client initially uses EHLO, sets up an encrypted connection using
11842 STARTTLS, and then uses HELO afterwards.
11843
11844 The &%-oMr%& option provides a way of specifying a custom protocol name for
11845 messages that are injected locally by trusted callers. This is commonly used to
11846 identify messages that are being re-injected after some kind of scanning.
11847
11848 .vitem &$received_time$&
11849 .vindex "&$received_time$&"
11850 This variable contains the date and time when the current message was received,
11851 as a number of seconds since the start of the Unix epoch.
11852
11853 .vitem &$recipient_data$&
11854 .vindex "&$recipient_data$&"
11855 This variable is set after an indexing lookup success in an ACL &%recipients%&
11856 condition. It contains the data from the lookup, and the value remains set
11857 until the next &%recipients%& test. Thus, you can do things like this:
11858 .display
11859 &`require recipients  = cdb*@;/some/file`&
11860 &`deny    `&&'some further test involving'& &`$recipient_data`&
11861 .endd
11862 &*Warning*&: This variable is set only when a lookup is used as an indexing
11863 method in the address list, using the semicolon syntax as in the example above.
11864 The variable is not set for a lookup that is used as part of the string
11865 expansion that all such lists undergo before being interpreted.
11866
11867 .vitem &$recipient_verify_failure$&
11868 .vindex "&$recipient_verify_failure$&"
11869 In an ACL, when a recipient verification fails, this variable contains
11870 information about the failure. It is set to one of the following words:
11871
11872 .ilist
11873 &"qualify"&: The address was unqualified (no domain), and the message
11874 was neither local nor came from an exempted host.
11875
11876 .next
11877 &"route"&: Routing failed.
11878
11879 .next
11880 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11881 or before the MAIL command (that is, on initial connection, HELO, or
11882 MAIL).
11883
11884 .next
11885 &"recipient"&: The RCPT command in a callout was rejected.
11886 .next
11887
11888 &"postmaster"&: The postmaster check in a callout was rejected.
11889 .endlist
11890
11891 The main use of this variable is expected to be to distinguish between
11892 rejections of MAIL and rejections of RCPT.
11893
11894 .vitem &$recipients$&
11895 .vindex "&$recipients$&"
11896 This variable contains a list of envelope recipients for a message. A comma and
11897 a space separate the addresses in the replacement text. However, the variable
11898 is not generally available, to prevent exposure of Bcc recipients in
11899 unprivileged users' filter files. You can use &$recipients$& only in these
11900 cases:
11901
11902 .olist
11903 In a system filter file.
11904 .next
11905 In the ACLs associated with the DATA command and with non-SMTP messages, that
11906 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11907 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11908 &%acl_not_smtp_mime%&.
11909 .next
11910 From within a &[local_scan()]& function.
11911 .endlist
11912
11913
11914 .vitem &$recipients_count$&
11915 .vindex "&$recipients_count$&"
11916 When a message is being processed, this variable contains the number of
11917 envelope recipients that came with the message. Duplicates are not excluded
11918 from the count. While a message is being received over SMTP, the number
11919 increases for each accepted recipient. It can be referenced in an ACL.
11920
11921
11922 .vitem &$regex_match_string$&
11923 .vindex "&$regex_match_string$&"
11924 This variable is set to contain the matching regular expression after a
11925 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11926
11927
11928 .vitem &$reply_address$&
11929 .vindex "&$reply_address$&"
11930 When a message is being processed, this variable contains the contents of the
11931 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11932 contents of the &'From:'& header line. Apart from the removal of leading
11933 white space, the value is not processed in any way. In particular, no RFC 2047
11934 decoding or character code translation takes place.
11935
11936 .vitem &$return_path$&
11937 .vindex "&$return_path$&"
11938 When a message is being delivered, this variable contains the return path &--
11939 the sender field that will be sent as part of the envelope. It is not enclosed
11940 in <> characters. At the start of routing an address, &$return_path$& has the
11941 same value as &$sender_address$&, but if, for example, an incoming message to a
11942 mailing list has been expanded by a router which specifies a different address
11943 for bounce messages, &$return_path$& subsequently contains the new bounce
11944 address, whereas &$sender_address$& always contains the original sender address
11945 that was received with the message. In other words, &$sender_address$& contains
11946 the incoming envelope sender, and &$return_path$& contains the outgoing
11947 envelope sender.
11948
11949 .vitem &$return_size_limit$&
11950 .vindex "&$return_size_limit$&"
11951 This is an obsolete name for &$bounce_return_size_limit$&.
11952
11953 .vitem &$router_name$&
11954 .cindex "router" "name"
11955 .cindex "name" "of router"
11956 .vindex "&$router_name$&"
11957 During the running of a router this variable contains its name.
11958
11959 .vitem &$runrc$&
11960 .cindex "return code" "from &%run%& expansion"
11961 .vindex "&$runrc$&"
11962 This variable contains the return code from a command that is run by the
11963 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11964 assume the order in which option values are expanded, except for those
11965 preconditions whose order of testing is documented. Therefore, you cannot
11966 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11967 another.
11968
11969 .vitem &$self_hostname$&
11970 .oindex "&%self%&" "value of host name"
11971 .vindex "&$self_hostname$&"
11972 When an address is routed to a supposedly remote host that turns out to be the
11973 local host, what happens is controlled by the &%self%& generic router option.
11974 One of its values causes the address to be passed to another router. When this
11975 happens, &$self_hostname$& is set to the name of the local host that the
11976 original router encountered. In other circumstances its contents are null.
11977
11978 .vitem &$sender_address$&
11979 .vindex "&$sender_address$&"
11980 When a message is being processed, this variable contains the sender's address
11981 that was received in the message's envelope. The case of letters in the address
11982 is retained, in both the local part and the domain. For bounce messages, the
11983 value of this variable is the empty string. See also &$return_path$&.
11984
11985 .vitem &$sender_address_data$&
11986 .vindex "&$address_data$&"
11987 .vindex "&$sender_address_data$&"
11988 If &$address_data$& is set when the routers are called from an ACL to verify a
11989 sender address, the final value is preserved in &$sender_address_data$&, to
11990 distinguish it from data from a recipient address. The value does not persist
11991 after the end of the current ACL statement. If you want to preserve it for
11992 longer, you can save it in an ACL variable.
11993
11994 .vitem &$sender_address_domain$&
11995 .vindex "&$sender_address_domain$&"
11996 The domain portion of &$sender_address$&.
11997
11998 .vitem &$sender_address_local_part$&
11999 .vindex "&$sender_address_local_part$&"
12000 The local part portion of &$sender_address$&.
12001
12002 .vitem &$sender_data$&
12003 .vindex "&$sender_data$&"
12004 This variable is set after a lookup success in an ACL &%senders%& condition or
12005 in a router &%senders%& option. It contains the data from the lookup, and the
12006 value remains set until the next &%senders%& test. Thus, you can do things like
12007 this:
12008 .display
12009 &`require senders      = cdb*@;/some/file`&
12010 &`deny    `&&'some further test involving'& &`$sender_data`&
12011 .endd
12012 &*Warning*&: This variable is set only when a lookup is used as an indexing
12013 method in the address list, using the semicolon syntax as in the example above.
12014 The variable is not set for a lookup that is used as part of the string
12015 expansion that all such lists undergo before being interpreted.
12016
12017 .vitem &$sender_fullhost$&
12018 .vindex "&$sender_fullhost$&"
12019 When a message is received from a remote host, this variable contains the host
12020 name and IP address in a single string. It ends with the IP address in square
12021 brackets, followed by a colon and a port number if the logging of ports is
12022 enabled. The format of the rest of the string depends on whether the host
12023 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12024 looking up its IP address. (Looking up the IP address can be forced by the
12025 &%host_lookup%& option, independent of verification.) A plain host name at the
12026 start of the string is a verified host name; if this is not present,
12027 verification either failed or was not requested. A host name in parentheses is
12028 the argument of a HELO or EHLO command. This is omitted if it is identical to
12029 the verified host name or to the host's IP address in square brackets.
12030
12031 .vitem &$sender_helo_name$&
12032 .vindex "&$sender_helo_name$&"
12033 When a message is received from a remote host that has issued a HELO or EHLO
12034 command, the argument of that command is placed in this variable. It is also
12035 set if HELO or EHLO is used when a message is received using SMTP locally via
12036 the &%-bs%& or &%-bS%& options.
12037
12038 .vitem &$sender_host_address$&
12039 .vindex "&$sender_host_address$&"
12040 When a message is received from a remote host, this variable contains that
12041 host's IP address. For locally submitted messages, it is empty.
12042
12043 .vitem &$sender_host_authenticated$&
12044 .vindex "&$sender_host_authenticated$&"
12045 This variable contains the name (not the public name) of the authenticator
12046 driver that successfully authenticated the client from which the message was
12047 received. It is empty if there was no successful authentication. See also
12048 &$authenticated_id$&.
12049
12050 .vitem &$sender_host_dnssec$&
12051 .vindex "&$sender_host_dnssec$&"
12052 If &$sender_host_name$& has been populated (by reference, &%hosts_lookup%& or
12053 otherwise) then this boolean will have been set true if, and only if, the
12054 resolver library states that the reverse DNS was authenticated data.  At all
12055 other times, this variable is false.
12056
12057 It is likely that you will need to coerce DNSSEC support on in the resolver
12058 library, by setting:
12059 .code
12060 dns_dnssec_ok = 1
12061 .endd
12062
12063 Exim does not perform DNSSEC validation itself, instead leaving that to a
12064 validating resolver (eg, unbound, or bind with suitable configuration).
12065
12066 Exim does not (currently) check to see if the forward DNS was also secured
12067 with DNSSEC, only the reverse DNS.
12068
12069 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12070 mechanism in the list, then this variable will be false.
12071
12072
12073 .vitem &$sender_host_name$&
12074 .vindex "&$sender_host_name$&"
12075 When a message is received from a remote host, this variable contains the
12076 host's name as obtained by looking up its IP address. For messages received by
12077 other means, this variable is empty.
12078
12079 .vindex "&$host_lookup_failed$&"
12080 If the host name has not previously been looked up, a reference to
12081 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12082 A looked up name is accepted only if it leads back to the original IP address
12083 via a forward lookup. If either the reverse or the forward lookup fails to find
12084 any data, or if the forward lookup does not yield the original IP address,
12085 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12086
12087 .vindex "&$host_lookup_deferred$&"
12088 However, if either of the lookups cannot be completed (for example, there is a
12089 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12090 &$host_lookup_failed$& remains set to &"0"&.
12091
12092 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12093 host name again if there is a subsequent reference to &$sender_host_name$&
12094 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12095 is set to &"1"&.
12096
12097 Exim does not automatically look up every calling host's name. If you want
12098 maximum efficiency, you should arrange your configuration so that it avoids
12099 these lookups altogether. The lookup happens only if one or more of the
12100 following are true:
12101
12102 .ilist
12103 A string containing &$sender_host_name$& is expanded.
12104 .next
12105 The calling host matches the list in &%host_lookup%&. In the default
12106 configuration, this option is set to *, so it must be changed if lookups are
12107 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12108 .next
12109 Exim needs the host name in order to test an item in a host list. The items
12110 that require this are described in sections &<<SECThoslispatnam>>& and
12111 &<<SECThoslispatnamsk>>&.
12112 .next
12113 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12114 In this case, the host name is required to compare with the name quoted in any
12115 EHLO or HELO commands that the client issues.
12116 .next
12117 The remote host issues a EHLO or HELO command that quotes one of the
12118 domains in &%helo_lookup_domains%&. The default value of this option is
12119 . ==== As this is a nested list, any displays it contains must be indented
12120 . ==== as otherwise they are too far to the left.
12121 .code
12122   helo_lookup_domains = @ : @[]
12123 .endd
12124 which causes a lookup if a remote host (incorrectly) gives the server's name or
12125 IP address in an EHLO or HELO command.
12126 .endlist
12127
12128
12129 .vitem &$sender_host_port$&
12130 .vindex "&$sender_host_port$&"
12131 When a message is received from a remote host, this variable contains the port
12132 number that was used on the remote host.
12133
12134 .vitem &$sender_ident$&
12135 .vindex "&$sender_ident$&"
12136 When a message is received from a remote host, this variable contains the
12137 identification received in response to an RFC 1413 request. When a message has
12138 been received locally, this variable contains the login name of the user that
12139 called Exim.
12140
12141 .vitem &$sender_rate_$&&'xxx'&
12142 A number of variables whose names begin &$sender_rate_$& are set as part of the
12143 &%ratelimit%& ACL condition. Details are given in section
12144 &<<SECTratelimiting>>&.
12145
12146 .vitem &$sender_rcvhost$&
12147 .cindex "DNS" "reverse lookup"
12148 .cindex "reverse DNS lookup"
12149 .vindex "&$sender_rcvhost$&"
12150 This is provided specifically for use in &'Received:'& headers. It starts with
12151 either the verified host name (as obtained from a reverse DNS lookup) or, if
12152 there is no verified host name, the IP address in square brackets. After that
12153 there may be text in parentheses. When the first item is a verified host name,
12154 the first thing in the parentheses is the IP address in square brackets,
12155 followed by a colon and a port number if port logging is enabled. When the
12156 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12157 the parentheses.
12158
12159 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12160 was used and its argument was not identical to the real host name or IP
12161 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12162 all three items are present in the parentheses, a newline and tab are inserted
12163 into the string, to improve the formatting of the &'Received:'& header.
12164
12165 .vitem &$sender_verify_failure$&
12166 .vindex "&$sender_verify_failure$&"
12167 In an ACL, when a sender verification fails, this variable contains information
12168 about the failure. The details are the same as for
12169 &$recipient_verify_failure$&.
12170
12171 .vitem &$sending_ip_address$&
12172 .vindex "&$sending_ip_address$&"
12173 This variable is set whenever an outgoing SMTP connection to another host has
12174 been set up. It contains the IP address of the local interface that is being
12175 used. This is useful if a host that has more than one IP address wants to take
12176 on different personalities depending on which one is being used. For incoming
12177 connections, see &$received_ip_address$&.
12178
12179 .vitem &$sending_port$&
12180 .vindex "&$sending_port$&"
12181 This variable is set whenever an outgoing SMTP connection to another host has
12182 been set up. It contains the local port that is being used. For incoming
12183 connections, see &$received_port$&.
12184
12185 .vitem &$smtp_active_hostname$&
12186 .vindex "&$smtp_active_hostname$&"
12187 During an incoming SMTP session, this variable contains the value of the active
12188 host name, as specified by the &%smtp_active_hostname%& option. The value of
12189 &$smtp_active_hostname$& is saved with any message that is received, so its
12190 value can be consulted during routing and delivery.
12191
12192 .vitem &$smtp_command$&
12193 .vindex "&$smtp_command$&"
12194 During the processing of an incoming SMTP command, this variable contains the
12195 entire command. This makes it possible to distinguish between HELO and EHLO in
12196 the HELO ACL, and also to distinguish between commands such as these:
12197 .code
12198 MAIL FROM:<>
12199 MAIL FROM: <>
12200 .endd
12201 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12202 command, the address in &$smtp_command$& is the original address before any
12203 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12204 the address after SMTP-time rewriting.
12205
12206 .vitem &$smtp_command_argument$&
12207 .cindex "SMTP" "command, argument for"
12208 .vindex "&$smtp_command_argument$&"
12209 While an ACL is running to check an SMTP command, this variable contains the
12210 argument, that is, the text that follows the command name, with leading white
12211 space removed. Following the introduction of &$smtp_command$&, this variable is
12212 somewhat redundant, but is retained for backwards compatibility.
12213
12214 .vitem &$smtp_count_at_connection_start$&
12215 .vindex "&$smtp_count_at_connection_start$&"
12216 This variable is set greater than zero only in processes spawned by the Exim
12217 daemon for handling incoming SMTP connections. The name is deliberately long,
12218 in order to emphasize what the contents are. When the daemon accepts a new
12219 connection, it increments this variable. A copy of the variable is passed to
12220 the child process that handles the connection, but its value is fixed, and
12221 never changes. It is only an approximation of how many incoming connections
12222 there actually are, because many other connections may come and go while a
12223 single connection is being processed. When a child process terminates, the
12224 daemon decrements its copy of the variable.
12225
12226 .vitem "&$sn0$& &-- &$sn9$&"
12227 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12228 that were current at the end of the system filter file. This allows a system
12229 filter file to set values that can be tested in users' filter files. For
12230 example, a system filter could set a value indicating how likely it is that a
12231 message is junk mail.
12232
12233 .vitem &$spam_$&&'xxx'&
12234 A number of variables whose names start with &$spam$& are available when Exim
12235 is compiled with the content-scanning extension. For details, see section
12236 &<<SECTscanspamass>>&.
12237
12238
12239 .vitem &$spool_directory$&
12240 .vindex "&$spool_directory$&"
12241 The name of Exim's spool directory.
12242
12243 .vitem &$spool_inodes$&
12244 .vindex "&$spool_inodes$&"
12245 The number of free inodes in the disk partition where Exim's spool files are
12246 being written. The value is recalculated whenever the variable is referenced.
12247 If the relevant file system does not have the concept of inodes, the value of
12248 is -1. See also the &%check_spool_inodes%& option.
12249
12250 .vitem &$spool_space$&
12251 .vindex "&$spool_space$&"
12252 The amount of free space (as a number of kilobytes) in the disk partition where
12253 Exim's spool files are being written. The value is recalculated whenever the
12254 variable is referenced. If the operating system does not have the ability to
12255 find the amount of free space (only true for experimental systems), the space
12256 value is -1. For example, to check in an ACL that there is at least 50
12257 megabytes free on the spool, you could write:
12258 .code
12259 condition = ${if > {$spool_space}{50000}}
12260 .endd
12261 See also the &%check_spool_space%& option.
12262
12263
12264 .vitem &$thisaddress$&
12265 .vindex "&$thisaddress$&"
12266 This variable is set only during the processing of the &%foranyaddress%&
12267 command in a filter file. Its use is explained in the description of that
12268 command, which can be found in the separate document entitled &'Exim's
12269 interfaces to mail filtering'&.
12270
12271 .vitem &$tls_in_bits$&
12272 .vindex "&$tls_in_bits$&"
12273 Contains an approximation of the TLS cipher's bit-strength
12274 on the inbound connection; the meaning of
12275 this depends upon the TLS implementation used.
12276 If TLS has not been negotiated, the value will be 0.
12277 The value of this is automatically fed into the Cyrus SASL authenticator
12278 when acting as a server, to specify the "external SSF" (a SASL term).
12279
12280 The deprecated &$tls_bits$& variable refers to the inbound side
12281 except when used in the context of an outbound SMTP delivery, when it refers to
12282 the outbound.
12283
12284 .vitem &$tls_out_bits$&
12285 .vindex "&$tls_out_bits$&"
12286 Contains an approximation of the TLS cipher's bit-strength
12287 on an outbound SMTP connection; the meaning of
12288 this depends upon the TLS implementation used.
12289 If TLS has not been negotiated, the value will be 0.
12290
12291 .new
12292 .vitem &$tls_in_ourcert$&
12293 .vindex "&$tls_in_ourcert$&"
12294 This variable refers to the certificate presented to the peer of an
12295 inbound connection when the message was received.
12296 It is only useful as the argument of a
12297 &%certextract%& expansion item or the name for a &%def%& expansion condition.
12298 .wen
12299
12300 .new
12301 .vitem &$tls_in_peercert$&
12302 .vindex "&$tls_in_peercert$&"
12303 This variable refers to the certificate presented by the peer of an
12304 inbound connection when the message was received.
12305 It is only useful as the argument of a
12306 &%certextract%& expansion item or the name for a &%def%& expansion condition.
12307 .wen
12308
12309 .new
12310 .vitem &$tls_out_ourcert$&
12311 .vindex "&$tls_out_ourcert$&"
12312 This variable refers to the certificate presented to the peer of an
12313 outbound connection.  It is only useful as the argument of a
12314 &%certextract%& expansion item or the name for a &%def%& expansion condition.
12315 .wen
12316
12317 .new
12318 .vitem &$tls_out_peercert$&
12319 .vindex "&$tls_out_peercert$&"
12320 This variable refers to the certificate presented by the peer of an
12321 outbound connection.  It is only useful as the argument of a
12322 &%certextract%& expansion item or the name for a &%def%& expansion condition.
12323 .wen
12324
12325 .vitem &$tls_in_certificate_verified$&
12326 .vindex "&$tls_in_certificate_verified$&"
12327 This variable is set to &"1"& if a TLS certificate was verified when the
12328 message was received, and &"0"& otherwise.
12329
12330 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12331 except when used in the context of an outbound SMTP delivery, when it refers to
12332 the outbound.
12333
12334 .vitem &$tls_out_certificate_verified$&
12335 .vindex "&$tls_out_certificate_verified$&"
12336 This variable is set to &"1"& if a TLS certificate was verified when an
12337 outbound SMTP connection was made,
12338 and &"0"& otherwise.
12339
12340 .vitem &$tls_in_cipher$&
12341 .vindex "&$tls_in_cipher$&"
12342 .vindex "&$tls_cipher$&"
12343 When a message is received from a remote host over an encrypted SMTP
12344 connection, this variable is set to the cipher suite that was negotiated, for
12345 example DES-CBC3-SHA. In other circumstances, in particular, for message
12346 received over unencrypted connections, the variable is empty. Testing
12347 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12348 non-encrypted connections during ACL processing.
12349
12350 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12351 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12352 becomes the same as &$tls_out_cipher$&.
12353
12354 .vitem &$tls_out_cipher$&
12355 .vindex "&$tls_out_cipher$&"
12356 This variable is
12357 cleared before any outgoing SMTP connection is made,
12358 and then set to the outgoing cipher suite if one is negotiated. See chapter
12359 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12360 details of the &(smtp)& transport.
12361
12362 .vitem &$tls_in_peerdn$&
12363 .vindex "&$tls_in_peerdn$&"
12364 .vindex "&$tls_peerdn$&"
12365 When a message is received from a remote host over an encrypted SMTP
12366 connection, and Exim is configured to request a certificate from the client,
12367 the value of the Distinguished Name of the certificate is made available in the
12368 &$tls_in_peerdn$& during subsequent processing.
12369
12370 The deprecated &$tls_peerdn$& variable refers to the inbound side
12371 except when used in the context of an outbound SMTP delivery, when it refers to
12372 the outbound.
12373
12374 .vitem &$tls_out_peerdn$&
12375 .vindex "&$tls_out_peerdn$&"
12376 When a message is being delivered to a remote host over an encrypted SMTP
12377 connection, and Exim is configured to request a certificate from the server,
12378 the value of the Distinguished Name of the certificate is made available in the
12379 &$tls_out_peerdn$& during subsequent processing.
12380
12381 .vitem &$tls_in_sni$&
12382 .vindex "&$tls_in_sni$&"
12383 .vindex "&$tls_sni$&"
12384 .cindex "TLS" "Server Name Indication"
12385 When a TLS session is being established, if the client sends the Server
12386 Name Indication extension, the value will be placed in this variable.
12387 If the variable appears in &%tls_certificate%& then this option and
12388 some others, described in &<<SECTtlssni>>&,
12389 will be re-expanded early in the TLS session, to permit
12390 a different certificate to be presented (and optionally a different key to be
12391 used) to the client, based upon the value of the SNI extension.
12392
12393 The deprecated &$tls_sni$& variable refers to the inbound side
12394 except when used in the context of an outbound SMTP delivery, when it refers to
12395 the outbound.
12396
12397 .vitem &$tls_out_sni$&
12398 .vindex "&$tls_out_sni$&"
12399 .cindex "TLS" "Server Name Indication"
12400 During outbound
12401 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12402 the transport.
12403
12404 .vitem &$tod_bsdinbox$&
12405 .vindex "&$tod_bsdinbox$&"
12406 The time of day and the date, in the format required for BSD-style mailbox
12407 files, for example: Thu Oct 17 17:14:09 1995.
12408
12409 .vitem &$tod_epoch$&
12410 .vindex "&$tod_epoch$&"
12411 The time and date as a number of seconds since the start of the Unix epoch.
12412
12413 .vitem &$tod_epoch_l$&
12414 .vindex "&$tod_epoch_l$&"
12415 The time and date as a number of microseconds since the start of the Unix epoch.
12416
12417 .vitem &$tod_full$&
12418 .vindex "&$tod_full$&"
12419 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12420 +0100. The timezone is always given as a numerical offset from UTC, with
12421 positive values used for timezones that are ahead (east) of UTC, and negative
12422 values for those that are behind (west).
12423
12424 .vitem &$tod_log$&
12425 .vindex "&$tod_log$&"
12426 The time and date in the format used for writing Exim's log files, for example:
12427 1995-10-12 15:32:29, but without a timezone.
12428
12429 .vitem &$tod_logfile$&
12430 .vindex "&$tod_logfile$&"
12431 This variable contains the date in the format yyyymmdd. This is the format that
12432 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12433 flag.
12434
12435 .vitem &$tod_zone$&
12436 .vindex "&$tod_zone$&"
12437 This variable contains the numerical value of the local timezone, for example:
12438 -0500.
12439
12440 .vitem &$tod_zulu$&
12441 .vindex "&$tod_zulu$&"
12442 This variable contains the UTC date and time in &"Zulu"& format, as specified
12443 by ISO 8601, for example: 20030221154023Z.
12444
12445 .vitem &$transport_name$&
12446 .cindex "transport" "name"
12447 .cindex "name" "of transport"
12448 .vindex "&$transport_name$&"
12449 During the running of a transport, this variable contains its name.
12450
12451 .vitem &$value$&
12452 .vindex "&$value$&"
12453 This variable contains the result of an expansion lookup, extraction operation,
12454 or external command, as described above. It is also used during a
12455 &*reduce*& expansion.
12456
12457 .vitem &$version_number$&
12458 .vindex "&$version_number$&"
12459 The version number of Exim.
12460
12461 .vitem &$warn_message_delay$&
12462 .vindex "&$warn_message_delay$&"
12463 This variable is set only during the creation of a message warning about a
12464 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12465
12466 .vitem &$warn_message_recipients$&
12467 .vindex "&$warn_message_recipients$&"
12468 This variable is set only during the creation of a message warning about a
12469 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12470 .endlist
12471 .ecindex IIDstrexp
12472
12473
12474
12475 . ////////////////////////////////////////////////////////////////////////////
12476 . ////////////////////////////////////////////////////////////////////////////
12477
12478 .chapter "Embedded Perl" "CHAPperl"
12479 .scindex IIDperl "Perl" "calling from Exim"
12480 Exim can be built to include an embedded Perl interpreter. When this is done,
12481 Perl subroutines can be called as part of the string expansion process. To make
12482 use of the Perl support, you need version 5.004 or later of Perl installed on
12483 your system. To include the embedded interpreter in the Exim binary, include
12484 the line
12485 .code
12486 EXIM_PERL = perl.o
12487 .endd
12488 in your &_Local/Makefile_& and then build Exim in the normal way.
12489
12490
12491 .section "Setting up so Perl can be used" "SECID85"
12492 .oindex "&%perl_startup%&"
12493 Access to Perl subroutines is via a global configuration option called
12494 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12495 no &%perl_startup%& option in the Exim configuration file then no Perl
12496 interpreter is started and there is almost no overhead for Exim (since none of
12497 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12498 option then the associated value is taken to be Perl code which is executed in
12499 a newly created Perl interpreter.
12500
12501 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12502 need backslashes before any characters to escape special meanings. The option
12503 should usually be something like
12504 .code
12505 perl_startup = do '/etc/exim.pl'
12506 .endd
12507 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12508 use from Exim. Exim can be configured either to start up a Perl interpreter as
12509 soon as it is entered, or to wait until the first time it is needed. Starting
12510 the interpreter at the beginning ensures that it is done while Exim still has
12511 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12512 fact used in a particular run. Also, note that this does not mean that Exim is
12513 necessarily running as root when Perl is called at a later time. By default,
12514 the interpreter is started only when it is needed, but this can be changed in
12515 two ways:
12516
12517 .ilist
12518 .oindex "&%perl_at_start%&"
12519 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12520 a startup when Exim is entered.
12521 .next
12522 The command line option &%-ps%& also requests a startup when Exim is entered,
12523 overriding the setting of &%perl_at_start%&.
12524 .endlist
12525
12526 There is also a command line option &%-pd%& (for delay) which suppresses the
12527 initial startup, even if &%perl_at_start%& is set.
12528
12529
12530 .section "Calling Perl subroutines" "SECID86"
12531 When the configuration file includes a &%perl_startup%& option you can make use
12532 of the string expansion item to call the Perl subroutines that are defined
12533 by the &%perl_startup%& code. The operator is used in any of the following
12534 forms:
12535 .code
12536 ${perl{foo}}
12537 ${perl{foo}{argument}}
12538 ${perl{foo}{argument1}{argument2} ... }
12539 .endd
12540 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12541 arguments may be passed. Passing more than this results in an expansion failure
12542 with an error message of the form
12543 .code
12544 Too many arguments passed to Perl subroutine "foo" (max is 8)
12545 .endd
12546 The return value of the Perl subroutine is evaluated in a scalar context before
12547 it is passed back to Exim to be inserted into the expanded string. If the
12548 return value is &'undef'&, the expansion is forced to fail in the same way as
12549 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12550 by obeying Perl's &%die%& function, the expansion fails with the error message
12551 that was passed to &%die%&.
12552
12553
12554 .section "Calling Exim functions from Perl" "SECID87"
12555 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12556 is available to call back into Exim's string expansion function. For example,
12557 the Perl code
12558 .code
12559 my $lp = Exim::expand_string('$local_part');
12560 .endd
12561 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12562 Note those are single quotes and not double quotes to protect against
12563 &$local_part$& being interpolated as a Perl variable.
12564
12565 If the string expansion is forced to fail by a &"fail"& item, the result of
12566 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12567 expansion string, the Perl call from the original expansion string fails with
12568 an appropriate error message, in the same way as if &%die%& were used.
12569
12570 .cindex "debugging" "from embedded Perl"
12571 .cindex "log" "writing from embedded Perl"
12572 Two other Exim functions are available for use from within Perl code.
12573 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12574 debugging is enabled. If you want a newline at the end, you must supply it.
12575 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12576 timestamp. In this case, you should not supply a terminating newline.
12577
12578
12579 .section "Use of standard output and error by Perl" "SECID88"
12580 .cindex "Perl" "standard output and error"
12581 You should not write to the standard error or output streams from within your
12582 Perl code, as it is not defined how these are set up. In versions of Exim
12583 before 4.50, it is possible for the standard output or error to refer to the
12584 SMTP connection during message reception via the daemon. Writing to this stream
12585 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12586 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12587 avoided, but the output is lost.
12588
12589 .cindex "Perl" "use of &%warn%&"
12590 The Perl &%warn%& statement writes to the standard error stream by default.
12591 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12592 you have no control. When Exim starts up the Perl interpreter, it arranges for
12593 output from the &%warn%& statement to be written to the Exim main log. You can
12594 change this by including appropriate Perl magic somewhere in your Perl code.
12595 For example, to discard &%warn%& output completely, you need this:
12596 .code
12597 $SIG{__WARN__} = sub { };
12598 .endd
12599 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12600 example, the code for the subroutine is empty, so it does nothing, but you can
12601 include any Perl code that you like. The text of the &%warn%& message is passed
12602 as the first subroutine argument.
12603 .ecindex IIDperl
12604
12605
12606 . ////////////////////////////////////////////////////////////////////////////
12607 . ////////////////////////////////////////////////////////////////////////////
12608
12609 .chapter "Starting the daemon and the use of network interfaces" &&&
12610          "CHAPinterfaces" &&&
12611          "Starting the daemon"
12612 .cindex "daemon" "starting"
12613 .cindex "interface" "listening"
12614 .cindex "network interface"
12615 .cindex "interface" "network"
12616 .cindex "IP address" "for listening"
12617 .cindex "daemon" "listening IP addresses"
12618 .cindex "TCP/IP" "setting listening interfaces"
12619 .cindex "TCP/IP" "setting listening ports"
12620 A host that is connected to a TCP/IP network may have one or more physical
12621 hardware network interfaces. Each of these interfaces may be configured as one
12622 or more &"logical"& interfaces, which are the entities that a program actually
12623 works with. Each of these logical interfaces is associated with an IP address.
12624 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12625 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12626 knowledge about the host's interfaces for use in three different circumstances:
12627
12628 .olist
12629 When a listening daemon is started, Exim needs to know which interfaces
12630 and ports to listen on.
12631 .next
12632 When Exim is routing an address, it needs to know which IP addresses
12633 are associated with local interfaces. This is required for the correct
12634 processing of MX lists by removing the local host and others with the
12635 same or higher priority values. Also, Exim needs to detect cases
12636 when an address is routed to an IP address that in fact belongs to the
12637 local host. Unless the &%self%& router option or the &%allow_localhost%&
12638 option of the smtp transport is set (as appropriate), this is treated
12639 as an error situation.
12640 .next
12641 When Exim connects to a remote host, it may need to know which interface to use
12642 for the outgoing connection.
12643 .endlist
12644
12645
12646 Exim's default behaviour is likely to be appropriate in the vast majority
12647 of cases. If your host has only one interface, and you want all its IP
12648 addresses to be treated in the same way, and you are using only the
12649 standard SMTP port, you should not need to take any special action. The
12650 rest of this chapter does not apply to you.
12651
12652 In a more complicated situation you may want to listen only on certain
12653 interfaces, or on different ports, and for this reason there are a number of
12654 options that can be used to influence Exim's behaviour. The rest of this
12655 chapter describes how they operate.
12656
12657 When a message is received over TCP/IP, the interface and port that were
12658 actually used are set in &$received_ip_address$& and &$received_port$&.
12659
12660
12661
12662 .section "Starting a listening daemon" "SECID89"
12663 When a listening daemon is started (by means of the &%-bd%& command line
12664 option), the interfaces and ports on which it listens are controlled by the
12665 following options:
12666
12667 .ilist
12668 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12669 compatibility, this option can also be specified in the singular.)
12670 .next
12671 &%local_interfaces%& contains list of interface IP addresses on which to
12672 listen. Each item may optionally also specify a port.
12673 .endlist
12674
12675 The default list separator in both cases is a colon, but this can be changed as
12676 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12677 it is usually best to change the separator to avoid having to double all the
12678 colons. For example:
12679 .code
12680 local_interfaces = <; 127.0.0.1 ; \
12681                       192.168.23.65 ; \
12682                       ::1 ; \
12683                       3ffe:ffff:836f::fe86:a061
12684 .endd
12685 There are two different formats for specifying a port along with an IP address
12686 in &%local_interfaces%&:
12687
12688 .olist
12689 The port is added onto the address with a dot separator. For example, to listen
12690 on port 1234 on two different IP addresses:
12691 .code
12692 local_interfaces = <; 192.168.23.65.1234 ; \
12693                       3ffe:ffff:836f::fe86:a061.1234
12694 .endd
12695 .next
12696 The IP address is enclosed in square brackets, and the port is added
12697 with a colon separator, for example:
12698 .code
12699 local_interfaces = <; [192.168.23.65]:1234 ; \
12700                       [3ffe:ffff:836f::fe86:a061]:1234
12701 .endd
12702 .endlist
12703
12704 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12705 default setting contains just one port:
12706 .code
12707 daemon_smtp_ports = smtp
12708 .endd
12709 If more than one port is listed, each interface that does not have its own port
12710 specified listens on all of them. Ports that are listed in
12711 &%daemon_smtp_ports%& can be identified either by name (defined in
12712 &_/etc/services_&) or by number. However, when ports are given with individual
12713 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12714
12715
12716
12717 .section "Special IP listening addresses" "SECID90"
12718 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12719 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12720 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12721 instead of setting up separate listening sockets for each interface. The
12722 default value of &%local_interfaces%& is
12723 .code
12724 local_interfaces = 0.0.0.0
12725 .endd
12726 when Exim is built without IPv6 support; otherwise it is:
12727 .code
12728 local_interfaces = <; ::0 ; 0.0.0.0
12729 .endd
12730 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12731
12732
12733
12734 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12735 The &%-oX%& command line option can be used to override the values of
12736 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12737 instance. Another way of doing this would be to use macros and the &%-D%&
12738 option. However, &%-oX%& can be used by any admin user, whereas modification of
12739 the runtime configuration by &%-D%& is allowed only when the caller is root or
12740 exim.
12741
12742 The value of &%-oX%& is a list of items. The default colon separator can be
12743 changed in the usual way if required. If there are any items that do not
12744 contain dots or colons (that is, are not IP addresses), the value of
12745 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12746 items that do contain dots or colons, the value of &%local_interfaces%& is
12747 replaced by those items. Thus, for example,
12748 .code
12749 -oX 1225
12750 .endd
12751 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12752 whereas
12753 .code
12754 -oX 192.168.34.5.1125
12755 .endd
12756 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12757 (However, since &%local_interfaces%& now contains no items without ports, the
12758 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12759
12760
12761
12762 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12763 .cindex "ssmtp protocol"
12764 .cindex "smtps protocol"
12765 .cindex "SMTP" "ssmtp protocol"
12766 .cindex "SMTP" "smtps protocol"
12767 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12768 before the STARTTLS command was standardized for SMTP. Some legacy clients
12769 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12770 list of port numbers, connections to those ports must use SSMTP. The most
12771 common use of this option is expected to be
12772 .code
12773 tls_on_connect_ports = 465
12774 .endd
12775 because 465 is the usual port number used by the legacy clients. There is also
12776 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12777 this way when a daemon is started.
12778
12779 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12780 daemon to listen on those ports. You must still specify them in
12781 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12782 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12783 connections via the daemon.)
12784
12785
12786
12787
12788 .section "IPv6 address scopes" "SECID92"
12789 .cindex "IPv6" "address scopes"
12790 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12791 can, in principle, have the same link-local IPv6 address on different
12792 interfaces. Thus, additional information is needed, over and above the IP
12793 address, to distinguish individual interfaces. A convention of using a
12794 percent sign followed by something (often the interface name) has been
12795 adopted in some cases, leading to addresses like this:
12796 .code
12797 fe80::202:b3ff:fe03:45c1%eth0
12798 .endd
12799 To accommodate this usage, a percent sign followed by an arbitrary string is
12800 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12801 to convert a textual IPv6 address for actual use. This function recognizes the
12802 percent convention in operating systems that support it, and it processes the
12803 address appropriately. Unfortunately, some older libraries have problems with
12804 &[getaddrinfo()]&. If
12805 .code
12806 IPV6_USE_INET_PTON=yes
12807 .endd
12808 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12809 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12810 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12811 function.) Of course, this means that the additional functionality of
12812 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12813
12814 .section "Disabling IPv6" "SECID93"
12815 .cindex "IPv6" "disabling"
12816 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12817 run on a host whose kernel does not support IPv6. The binary will fall back to
12818 using IPv4, but it may waste resources looking up AAAA records, and trying to
12819 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12820 .oindex "&%disable_ipv6%&"
12821 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12822 activities take place. AAAA records are never looked up, and any IPv6 addresses
12823 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12824 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12825 to handle IPv6 literal addresses.
12826
12827 On the other hand, when IPv6 is in use, there may be times when you want to
12828 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12829 option to globally suppress the lookup of AAAA records for specified domains,
12830 and you can use the &%ignore_target_hosts%& generic router option to ignore
12831 IPv6 addresses in an individual router.
12832
12833
12834
12835 .section "Examples of starting a listening daemon" "SECID94"
12836 The default case in an IPv6 environment is
12837 .code
12838 daemon_smtp_ports = smtp
12839 local_interfaces = <; ::0 ; 0.0.0.0
12840 .endd
12841 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12842 Either one or two sockets may be used, depending on the characteristics of
12843 the TCP/IP stack. (This is complicated and messy; for more information,
12844 read the comments in the &_daemon.c_& source file.)
12845
12846 To specify listening on ports 25 and 26 on all interfaces:
12847 .code
12848 daemon_smtp_ports = 25 : 26
12849 .endd
12850 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12851 .code
12852 local_interfaces = <; ::0.25     ; ::0.26 \
12853                       0.0.0.0.25 ; 0.0.0.0.26
12854 .endd
12855 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12856 IPv4 loopback address only:
12857 .code
12858 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12859 .endd
12860 To specify listening on the default port on specific interfaces only:
12861 .code
12862 local_interfaces = 10.0.0.67 : 192.168.34.67
12863 .endd
12864 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12865
12866
12867
12868 .section "Recognizing the local host" "SECTreclocipadd"
12869 The &%local_interfaces%& option is also used when Exim needs to determine
12870 whether or not an IP address refers to the local host. That is, the IP
12871 addresses of all the interfaces on which a daemon is listening are always
12872 treated as local.
12873
12874 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12875 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12876 available interfaces from the operating system, and extracts the relevant
12877 (that is, IPv4 or IPv6) addresses to use for checking.
12878
12879 Some systems set up large numbers of virtual interfaces in order to provide
12880 many virtual web servers. In this situation, you may want to listen for
12881 email on only a few of the available interfaces, but nevertheless treat all
12882 interfaces as local when routing. You can do this by setting
12883 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12884 &"all"& wildcard values. These addresses are recognized as local, but are not
12885 used for listening. Consider this example:
12886 .code
12887 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12888                       192.168.53.235 ; \
12889                       3ffe:2101:12:1:a00:20ff:fe86:a061
12890
12891 extra_local_interfaces = <; ::0 ; 0.0.0.0
12892 .endd
12893 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12894 address, but all available interface addresses are treated as local when
12895 Exim is routing.
12896
12897 In some environments the local host name may be in an MX list, but with an IP
12898 address that is not assigned to any local interface. In other cases it may be
12899 desirable to treat other host names as if they referred to the local host. Both
12900 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12901 This contains host names rather than IP addresses. When a host is referenced
12902 during routing, either via an MX record or directly, it is treated as the local
12903 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12904 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12905
12906
12907
12908 .section "Delivering to a remote host" "SECID95"
12909 Delivery to a remote host is handled by the smtp transport. By default, it
12910 allows the system's TCP/IP functions to choose which interface to use (if
12911 there is more than one) when connecting to a remote host. However, the
12912 &%interface%& option can be set to specify which interface is used. See the
12913 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12914 details.
12915
12916
12917
12918
12919 . ////////////////////////////////////////////////////////////////////////////
12920 . ////////////////////////////////////////////////////////////////////////////
12921
12922 .chapter "Main configuration" "CHAPmainconfig"
12923 .scindex IIDconfima "configuration file" "main section"
12924 .scindex IIDmaiconf "main configuration"
12925 The first part of the run time configuration file contains three types of item:
12926
12927 .ilist
12928 Macro definitions: These lines start with an upper case letter. See section
12929 &<<SECTmacrodefs>>& for details of macro processing.
12930 .next
12931 Named list definitions: These lines start with one of the words &"domainlist"&,
12932 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12933 section &<<SECTnamedlists>>&.
12934 .next
12935 Main configuration settings: Each setting occupies one line of the file
12936 (with possible continuations). If any setting is preceded by the word
12937 &"hide"&, the &%-bP%& command line option displays its value to admin users
12938 only. See section &<<SECTcos>>& for a description of the syntax of these option
12939 settings.
12940 .endlist
12941
12942 This chapter specifies all the main configuration options, along with their
12943 types and default values. For ease of finding a particular option, they appear
12944 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12945 are now so many options, they are first listed briefly in functional groups, as
12946 an aid to finding the name of the option you are looking for. Some options are
12947 listed in more than one group.
12948
12949 .section "Miscellaneous" "SECID96"
12950 .table2
12951 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12952 .row &%disable_ipv6%&                "do no IPv6 processing"
12953 .row &%keep_malformed%&              "for broken files &-- should not happen"
12954 .row &%localhost_number%&            "for unique message ids in clusters"
12955 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12956 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12957 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12958 .row &%print_topbitchars%&           "top-bit characters are printing"
12959 .row &%timezone%&                    "force time zone"
12960 .endtable
12961
12962
12963 .section "Exim parameters" "SECID97"
12964 .table2
12965 .row &%exim_group%&                  "override compiled-in value"
12966 .row &%exim_path%&                   "override compiled-in value"
12967 .row &%exim_user%&                   "override compiled-in value"
12968 .row &%primary_hostname%&            "default from &[uname()]&"
12969 .row &%split_spool_directory%&       "use multiple directories"
12970 .row &%spool_directory%&             "override compiled-in value"
12971 .endtable
12972
12973
12974
12975 .section "Privilege controls" "SECID98"
12976 .table2
12977 .row &%admin_groups%&                "groups that are Exim admin users"
12978 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12979 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12980 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12981 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12982 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12983 .row &%never_users%&                 "do not run deliveries as these"
12984 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12985 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12986 .row &%trusted_groups%&              "groups that are trusted"
12987 .row &%trusted_users%&               "users that are trusted"
12988 .endtable
12989
12990
12991
12992 .section "Logging" "SECID99"
12993 .table2
12994 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12995 .row &%log_file_path%&               "override compiled-in value"
12996 .row &%log_selector%&                "set/unset optional logging"
12997 .row &%log_timezone%&                "add timezone to log lines"
12998 .row &%message_logs%&                "create per-message logs"
12999 .row &%preserve_message_logs%&       "after message completion"
13000 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13001 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13002 .row &%syslog_facility%&             "set syslog &""facility""& field"
13003 .row &%syslog_processname%&          "set syslog &""ident""& field"
13004 .row &%syslog_timestamp%&            "timestamp syslog lines"
13005 .row &%write_rejectlog%&             "control use of message log"
13006 .endtable
13007
13008
13009
13010 .section "Frozen messages" "SECID100"
13011 .table2
13012 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13013 .row &%freeze_tell%&                 "send message when freezing"
13014 .row &%move_frozen_messages%&        "to another directory"
13015 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13016 .endtable
13017
13018
13019
13020 .section "Data lookups" "SECID101"
13021 .table2
13022 .row &%ibase_servers%&               "InterBase servers"
13023 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13024 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13025 .row &%ldap_cert_file%&              "client cert file for LDAP"
13026 .row &%ldap_cert_key%&               "client key file for LDAP"
13027 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13028 .row &%ldap_default_servers%&        "used if no server in query"
13029 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13030 .row &%ldap_start_tls%&              "require TLS within LDAP"
13031 .row &%ldap_version%&                "set protocol version"
13032 .row &%lookup_open_max%&             "lookup files held open"
13033 .row &%mysql_servers%&               "default MySQL servers"
13034 .row &%oracle_servers%&              "Oracle servers"
13035 .row &%pgsql_servers%&               "default PostgreSQL servers"
13036 .row &%sqlite_lock_timeout%&         "as it says"
13037 .endtable
13038
13039
13040
13041 .section "Message ids" "SECID102"
13042 .table2
13043 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13044 .row &%message_id_header_text%&      "ditto"
13045 .endtable
13046
13047
13048
13049 .section "Embedded Perl Startup" "SECID103"
13050 .table2
13051 .row &%perl_at_start%&               "always start the interpreter"
13052 .row &%perl_startup%&                "code to obey when starting Perl"
13053 .endtable
13054
13055
13056
13057 .section "Daemon" "SECID104"
13058 .table2
13059 .row &%daemon_smtp_ports%&           "default ports"
13060 .row &%daemon_startup_retries%&      "number of times to retry"
13061 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13062 .row &%extra_local_interfaces%&      "not necessarily listened on"
13063 .row &%local_interfaces%&            "on which to listen, with optional ports"
13064 .row &%pid_file_path%&               "override compiled-in value"
13065 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13066 .endtable
13067
13068
13069
13070 .section "Resource control" "SECID105"
13071 .table2
13072 .row &%check_log_inodes%&            "before accepting a message"
13073 .row &%check_log_space%&             "before accepting a message"
13074 .row &%check_spool_inodes%&          "before accepting a message"
13075 .row &%check_spool_space%&           "before accepting a message"
13076 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13077 .row &%queue_only_load%&             "queue incoming if load high"
13078 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13079 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13080 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13081 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13082 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13083 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13084 .row &%smtp_accept_max_per_connection%& "messages per connection"
13085 .row &%smtp_accept_max_per_host%&    "connections from one host"
13086 .row &%smtp_accept_queue%&           "queue mail if more connections"
13087 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13088                                            connection"
13089 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13090 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13091 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13092 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13093 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13094 .endtable
13095
13096
13097
13098 .section "Policy controls" "SECID106"
13099 .table2
13100 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13101 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13102 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13103 .row &%acl_smtp_auth%&               "ACL for AUTH"
13104 .row &%acl_smtp_connect%&            "ACL for connection"
13105 .row &%acl_smtp_data%&               "ACL for DATA"
13106 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13107 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13108 .row &%acl_smtp_expn%&               "ACL for EXPN"
13109 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13110 .row &%acl_smtp_mail%&               "ACL for MAIL"
13111 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13112 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13113 .row &%acl_smtp_predata%&            "ACL for start of data"
13114 .row &%acl_smtp_quit%&               "ACL for QUIT"
13115 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13116 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13117 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13118 .row &%av_scanner%&                  "specify virus scanner"
13119 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13120                                       words""&"
13121 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13122 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13123 .row &%header_maxsize%&              "total size of message header"
13124 .row &%header_line_maxsize%&         "individual header line limit"
13125 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13126 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13127 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13128 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13129 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13130 .row &%host_lookup%&                 "host name looked up for these hosts"
13131 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13132 .row &%host_reject_connection%&      "reject connection from these hosts"
13133 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13134 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13135 .row &%message_size_limit%&          "for all messages"
13136 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13137 .row &%spamd_address%&               "set interface to SpamAssassin"
13138 .row &%strict_acl_vars%&             "object to unset ACL variables"
13139 .endtable
13140
13141
13142
13143 .section "Callout cache" "SECID107"
13144 .table2
13145 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13146                                          item"
13147 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13148                                          item"
13149 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13150 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13151 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13152 .endtable
13153
13154
13155
13156 .section "TLS" "SECID108"
13157 .table2
13158 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13159 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13160 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13161 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13162 .row &%tls_certificate%&             "location of server certificate"
13163 .row &%tls_crl%&                     "certificate revocation list"
13164 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13165 .row &%tls_dhparam%&                 "DH parameters for server"
13166 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13167 .row &%tls_privatekey%&              "location of server private key"
13168 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13169 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13170 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13171 .row &%tls_verify_certificates%&     "expected client certificates"
13172 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13173 .endtable
13174
13175
13176
13177 .section "Local user handling" "SECID109"
13178 .table2
13179 .row &%finduser_retries%&            "useful in NIS environments"
13180 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13181 .row &%gecos_pattern%&               "ditto"
13182 .row &%max_username_length%&         "for systems that truncate"
13183 .row &%unknown_login%&               "used when no login name found"
13184 .row &%unknown_username%&            "ditto"
13185 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13186 .row &%uucp_from_sender%&            "ditto"
13187 .endtable
13188
13189
13190
13191 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13192 .table2
13193 .row &%header_maxsize%&              "total size of message header"
13194 .row &%header_line_maxsize%&         "individual header line limit"
13195 .row &%message_size_limit%&          "applies to all messages"
13196 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13197 .row &%received_header_text%&        "expanded to make &'Received:'&"
13198 .row &%received_headers_max%&        "for mail loop detection"
13199 .row &%recipients_max%&              "limit per message"
13200 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13201 .endtable
13202
13203
13204
13205
13206 .section "Non-SMTP incoming messages" "SECID111"
13207 .table2
13208 .row &%receive_timeout%&             "for non-SMTP messages"
13209 .endtable
13210
13211
13212
13213
13214
13215 .section "Incoming SMTP messages" "SECID112"
13216 See also the &'Policy controls'& section above.
13217
13218 .table2
13219 .row &%host_lookup%&                 "host name looked up for these hosts"
13220 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13221 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13222 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13223 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13224 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13225 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13226 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13227 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13228 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13229 .row &%smtp_accept_max_per_connection%& "messages per connection"
13230 .row &%smtp_accept_max_per_host%&    "connections from one host"
13231 .row &%smtp_accept_queue%&           "queue mail if more connections"
13232 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13233                                            connection"
13234 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13235 .row &%smtp_active_hostname%&        "host name to use in messages"
13236 .row &%smtp_banner%&                 "text for welcome banner"
13237 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13238 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13239 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13240 .row &%smtp_etrn_command%&           "what to run for ETRN"
13241 .row &%smtp_etrn_serialize%&         "only one at once"
13242 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13243 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13244 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13245 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13246 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13247 .row &%smtp_receive_timeout%&        "per command or data line"
13248 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13249 .row &%smtp_return_error_details%&   "give detail on rejections"
13250 .endtable
13251
13252
13253
13254 .section "SMTP extensions" "SECID113"
13255 .table2
13256 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13257 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13258 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13259 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13260 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13261 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13262 .endtable
13263
13264
13265
13266 .section "Processing messages" "SECID114"
13267 .table2
13268 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13269 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13270 .row &%allow_utf8_domains%&          "in addresses"
13271 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13272                                       words""&"
13273 .row &%delivery_date_remove%&        "from incoming messages"
13274 .row &%envelope_to_remove%&          "from incoming messages"
13275 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13276 .row &%headers_charset%&             "default for translations"
13277 .row &%qualify_domain%&              "default for senders"
13278 .row &%qualify_recipient%&           "default for recipients"
13279 .row &%return_path_remove%&          "from incoming messages"
13280 .row &%strip_excess_angle_brackets%& "in addresses"
13281 .row &%strip_trailing_dot%&          "at end of addresses"
13282 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13283 .endtable
13284
13285
13286
13287 .section "System filter" "SECID115"
13288 .table2
13289 .row &%system_filter%&               "locate system filter"
13290 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13291                                             directory"
13292 .row &%system_filter_file_transport%& "transport for delivery to a file"
13293 .row &%system_filter_group%&         "group for filter running"
13294 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13295 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13296 .row &%system_filter_user%&          "user for filter running"
13297 .endtable
13298
13299
13300
13301 .section "Routing and delivery" "SECID116"
13302 .table2
13303 .row &%disable_ipv6%&                "do no IPv6 processing"
13304 .row &%dns_again_means_nonexist%&    "for broken domains"
13305 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13306 .row &%dns_dnssec_ok%&               "parameter for resolver"
13307 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13308 .row &%dns_retrans%&                 "parameter for resolver"
13309 .row &%dns_retry%&                   "parameter for resolver"
13310 .row &%dns_use_edns0%&               "parameter for resolver"
13311 .row &%hold_domains%&                "hold delivery for these domains"
13312 .row &%local_interfaces%&            "for routing checks"
13313 .row &%queue_domains%&               "no immediate delivery for these"
13314 .row &%queue_only%&                  "no immediate delivery at all"
13315 .row &%queue_only_file%&             "no immediate delivery if file exists"
13316 .row &%queue_only_load%&             "no immediate delivery if load is high"
13317 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13318 .row &%queue_only_override%&         "allow command line to override"
13319 .row &%queue_run_in_order%&          "order of arrival"
13320 .row &%queue_run_max%&               "of simultaneous queue runners"
13321 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13322 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13323 .row &%remote_sort_domains%&         "order of remote deliveries"
13324 .row &%retry_data_expire%&           "timeout for retry data"
13325 .row &%retry_interval_max%&          "safety net for retry rules"
13326 .endtable
13327
13328
13329
13330 .section "Bounce and warning messages" "SECID117"
13331 .table2
13332 .row &%bounce_message_file%&         "content of bounce"
13333 .row &%bounce_message_text%&         "content of bounce"
13334 .row &%bounce_return_body%&          "include body if returning message"
13335 .row &%bounce_return_message%&       "include original message in bounce"
13336 .row &%bounce_return_size_limit%&    "limit on returned message"
13337 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13338 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13339 .row &%errors_copy%&                 "copy bounce messages"
13340 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13341 .row &%delay_warning%&               "time schedule"
13342 .row &%delay_warning_condition%&     "condition for warning messages"
13343 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13344 .row &%smtp_return_error_details%&   "give detail on rejections"
13345 .row &%warn_message_file%&           "content of warning message"
13346 .endtable
13347
13348
13349
13350 .section "Alphabetical list of main options" "SECTalomo"
13351 Those options that undergo string expansion before use are marked with
13352 &dagger;.
13353
13354 .option accept_8bitmime main boolean true
13355 .cindex "8BITMIME"
13356 .cindex "8-bit characters"
13357 .cindex "log" "selectors"
13358 .cindex "log" "8BITMIME"
13359 This option causes Exim to send 8BITMIME in its response to an SMTP
13360 EHLO command, and to accept the BODY= parameter on MAIL commands.
13361 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13362 takes no steps to do anything special with messages received by this route.
13363
13364 Historically Exim kept this option off by default, but the maintainers
13365 feel that in today's Internet, this causes more problems than it solves.
13366 It now defaults to true.
13367 A more detailed analysis of the issues is provided by Dan Bernstein:
13368 .display
13369 &url(http://cr.yp.to/smtp/8bitmime.html)
13370 .endd
13371
13372 To log received 8BITMIME status use
13373 .code
13374 log_selector = +8bitmime
13375 .endd
13376
13377 .option acl_not_smtp main string&!! unset
13378 .cindex "&ACL;" "for non-SMTP messages"
13379 .cindex "non-SMTP messages" "ACLs for"
13380 This option defines the ACL that is run when a non-SMTP message has been
13381 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13382 further details.
13383
13384 .option acl_not_smtp_mime main string&!! unset
13385 This option defines the ACL that is run for individual MIME parts of non-SMTP
13386 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13387 SMTP messages.
13388
13389 .option acl_not_smtp_start main string&!! unset
13390 .cindex "&ACL;" "at start of non-SMTP message"
13391 .cindex "non-SMTP messages" "ACLs for"
13392 This option defines the ACL that is run before Exim starts reading a
13393 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13394
13395 .option acl_smtp_auth main string&!! unset
13396 .cindex "&ACL;" "setting up for SMTP commands"
13397 .cindex "AUTH" "ACL for"
13398 This option defines the ACL that is run when an SMTP AUTH command is
13399 received. See chapter &<<CHAPACL>>& for further details.
13400
13401 .option acl_smtp_connect main string&!! unset
13402 .cindex "&ACL;" "on SMTP connection"
13403 This option defines the ACL that is run when an SMTP connection is received.
13404 See chapter &<<CHAPACL>>& for further details.
13405
13406 .option acl_smtp_data main string&!! unset
13407 .cindex "DATA" "ACL for"
13408 This option defines the ACL that is run after an SMTP DATA command has been
13409 processed and the message itself has been received, but before the final
13410 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13411
13412 .option acl_smtp_etrn main string&!! unset
13413 .cindex "ETRN" "ACL for"
13414 This option defines the ACL that is run when an SMTP ETRN command is
13415 received. See chapter &<<CHAPACL>>& for further details.
13416
13417 .option acl_smtp_expn main string&!! unset
13418 .cindex "EXPN" "ACL for"
13419 This option defines the ACL that is run when an SMTP EXPN command is
13420 received. See chapter &<<CHAPACL>>& for further details.
13421
13422 .option acl_smtp_helo main string&!! unset
13423 .cindex "EHLO" "ACL for"
13424 .cindex "HELO" "ACL for"
13425 This option defines the ACL that is run when an SMTP EHLO or HELO
13426 command is received. See chapter &<<CHAPACL>>& for further details.
13427
13428
13429 .option acl_smtp_mail main string&!! unset
13430 .cindex "MAIL" "ACL for"
13431 This option defines the ACL that is run when an SMTP MAIL command is
13432 received. See chapter &<<CHAPACL>>& for further details.
13433
13434 .option acl_smtp_mailauth main string&!! unset
13435 .cindex "AUTH" "on MAIL command"
13436 This option defines the ACL that is run when there is an AUTH parameter on
13437 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13438 &<<CHAPSMTPAUTH>>& for details of authentication.
13439
13440 .option acl_smtp_mime main string&!! unset
13441 .cindex "MIME content scanning" "ACL for"
13442 This option is available when Exim is built with the content-scanning
13443 extension. It defines the ACL that is run for each MIME part in a message. See
13444 section &<<SECTscanmimepart>>& for details.
13445
13446 .option acl_smtp_predata main string&!! unset
13447 This option defines the ACL that is run when an SMTP DATA command is
13448 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13449 further details.
13450
13451 .option acl_smtp_quit main string&!! unset
13452 .cindex "QUIT, ACL for"
13453 This option defines the ACL that is run when an SMTP QUIT command is
13454 received. See chapter &<<CHAPACL>>& for further details.
13455
13456 .option acl_smtp_rcpt main string&!! unset
13457 .cindex "RCPT" "ACL for"
13458 This option defines the ACL that is run when an SMTP RCPT command is
13459 received. See chapter &<<CHAPACL>>& for further details.
13460
13461 .option acl_smtp_starttls main string&!! unset
13462 .cindex "STARTTLS, ACL for"
13463 This option defines the ACL that is run when an SMTP STARTTLS command is
13464 received. See chapter &<<CHAPACL>>& for further details.
13465
13466 .option acl_smtp_vrfy main string&!! unset
13467 .cindex "VRFY" "ACL for"
13468 This option defines the ACL that is run when an SMTP VRFY command is
13469 received. See chapter &<<CHAPACL>>& for further details.
13470
13471 .option admin_groups main "string list&!!" unset
13472 .cindex "admin user"
13473 This option is expanded just once, at the start of Exim's processing. If the
13474 current group or any of the supplementary groups of an Exim caller is in this
13475 colon-separated list, the caller has admin privileges. If all your system
13476 programmers are in a specific group, for example, you can give them all Exim
13477 admin privileges by putting that group in &%admin_groups%&. However, this does
13478 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13479 To permit this, you have to add individuals to the Exim group.
13480
13481 .option allow_domain_literals main boolean false
13482 .cindex "domain literal"
13483 If this option is set, the RFC 2822 domain literal format is permitted in
13484 email addresses. The option is not set by default, because the domain literal
13485 format is not normally required these days, and few people know about it. It
13486 has, however, been exploited by mail abusers.
13487
13488 Unfortunately, it seems that some DNS black list maintainers are using this
13489 format to report black listing to postmasters. If you want to accept messages
13490 addressed to your hosts by IP address, you need to set
13491 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13492 domains (defined in the named domain list &%local_domains%& in the default
13493 configuration). This &"magic string"& matches the domain literal form of all
13494 the local host's IP addresses.
13495
13496
13497 .option allow_mx_to_ip main boolean false
13498 .cindex "MX record" "pointing to IP address"
13499 It appears that more and more DNS zone administrators are breaking the rules
13500 and putting domain names that look like IP addresses on the right hand side of
13501 MX records. Exim follows the rules and rejects this, giving an error message
13502 that explains the mis-configuration. However, some other MTAs support this
13503 practice, so to avoid &"Why can't Exim do this?"& complaints,
13504 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13505 recommended, except when you have no other choice.
13506
13507 .option allow_utf8_domains main boolean false
13508 .cindex "domain" "UTF-8 characters in"
13509 .cindex "UTF-8" "in domain name"
13510 Lots of discussion is going on about internationalized domain names. One
13511 camp is strongly in favour of just using UTF-8 characters, and it seems
13512 that at least two other MTAs permit this. This option allows Exim users to
13513 experiment if they wish.
13514
13515 If it is set true, Exim's domain parsing function allows valid
13516 UTF-8 multicharacters to appear in domain name components, in addition to
13517 letters, digits, and hyphens. However, just setting this option is not
13518 enough; if you want to look up these domain names in the DNS, you must also
13519 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13520 suitable setting is:
13521 .code
13522 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13523   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13524 .endd
13525 Alternatively, you can just disable this feature by setting
13526 .code
13527 dns_check_names_pattern =
13528 .endd
13529 That is, set the option to an empty string so that no check is done.
13530
13531
13532 .option auth_advertise_hosts main "host list&!!" *
13533 .cindex "authentication" "advertising"
13534 .cindex "AUTH" "advertising"
13535 If any server authentication mechanisms are configured, Exim advertises them in
13536 response to an EHLO command only if the calling host matches this list.
13537 Otherwise, Exim does not advertise AUTH.
13538 Exim does not accept AUTH commands from clients to which it has not
13539 advertised the availability of AUTH. The advertising of individual
13540 authentication mechanisms can be controlled by the use of the
13541 &%server_advertise_condition%& generic authenticator option on the individual
13542 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13543
13544 Certain mail clients (for example, Netscape) require the user to provide a name
13545 and password for authentication if AUTH is advertised, even though it may
13546 not be needed (the host may accept messages from hosts on its local LAN without
13547 authentication, for example). The &%auth_advertise_hosts%& option can be used
13548 to make these clients more friendly by excluding them from the set of hosts to
13549 which Exim advertises AUTH.
13550
13551 .cindex "AUTH" "advertising when encrypted"
13552 If you want to advertise the availability of AUTH only when the connection
13553 is encrypted using TLS, you can make use of the fact that the value of this
13554 option is expanded, with a setting like this:
13555 .code
13556 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13557 .endd
13558 .vindex "&$tls_in_cipher$&"
13559 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13560 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13561 expansion is *, which matches all hosts.
13562
13563
13564 .option auto_thaw main time 0s
13565 .cindex "thawing messages"
13566 .cindex "unfreezing messages"
13567 If this option is set to a time greater than zero, a queue runner will try a
13568 new delivery attempt on any frozen message, other than a bounce message, if
13569 this much time has passed since it was frozen. This may result in the message
13570 being re-frozen if nothing has changed since the last attempt. It is a way of
13571 saying &"keep on trying, even though there are big problems"&.
13572
13573 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13574 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13575 thought to be very useful any more, and its use should probably be avoided.
13576
13577
13578 .option av_scanner main string "see below"
13579 This option is available if Exim is built with the content-scanning extension.
13580 It specifies which anti-virus scanner to use. The default value is:
13581 .code
13582 sophie:/var/run/sophie
13583 .endd
13584 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13585 before use. See section &<<SECTscanvirus>>& for further details.
13586
13587
13588 .option bi_command main string unset
13589 .oindex "&%-bi%&"
13590 This option supplies the name of a command that is run when Exim is called with
13591 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13592 just the command name, it is not a complete command line. If an argument is
13593 required, it must come from the &%-oA%& command line option.
13594
13595
13596 .option bounce_message_file main string unset
13597 .cindex "bounce message" "customizing"
13598 .cindex "customizing" "bounce message"
13599 This option defines a template file containing paragraphs of text to be used
13600 for constructing bounce messages.  Details of the file's contents are given in
13601 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13602
13603
13604 .option bounce_message_text main string unset
13605 When this option is set, its contents are included in the default bounce
13606 message immediately after &"This message was created automatically by mail
13607 delivery software."& It is not used if &%bounce_message_file%& is set.
13608
13609 .option bounce_return_body main boolean true
13610 .cindex "bounce message" "including body"
13611 This option controls whether the body of an incoming message is included in a
13612 bounce message when &%bounce_return_message%& is true. The default setting
13613 causes the entire message, both header and body, to be returned (subject to the
13614 value of &%bounce_return_size_limit%&). If this option is false, only the
13615 message header is included. In the case of a non-SMTP message containing an
13616 error that is detected during reception, only those header lines preceding the
13617 point at which the error was detected are returned.
13618 .cindex "bounce message" "including original"
13619
13620 .option bounce_return_message main boolean true
13621 If this option is set false, none of the original message is included in
13622 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13623 &%bounce_return_body%&.
13624
13625
13626 .option bounce_return_size_limit main integer 100K
13627 .cindex "size" "of bounce, limit"
13628 .cindex "bounce message" "size limit"
13629 .cindex "limit" "bounce message size"
13630 This option sets a limit in bytes on the size of messages that are returned to
13631 senders as part of bounce messages when &%bounce_return_message%& is true. The
13632 limit should be less than the value of the global &%message_size_limit%& and of
13633 any &%message_size_limit%& settings on transports, to allow for the bounce text
13634 that Exim generates. If this option is set to zero there is no limit.
13635
13636 When the body of any message that is to be included in a bounce message is
13637 greater than the limit, it is truncated, and a comment pointing this out is
13638 added at the top. The actual cutoff may be greater than the value given, owing
13639 to the use of buffering for transferring the message in chunks (typically 8K in
13640 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13641 messages.
13642
13643 .option bounce_sender_authentication main string unset
13644 .cindex "bounce message" "sender authentication"
13645 .cindex "authentication" "bounce message"
13646 .cindex "AUTH" "on bounce message"
13647 This option provides an authenticated sender address that is sent with any
13648 bounce messages generated by Exim that are sent over an authenticated SMTP
13649 connection. A typical setting might be:
13650 .code
13651 bounce_sender_authentication = mailer-daemon@my.domain.example
13652 .endd
13653 which would cause bounce messages to be sent using the SMTP command:
13654 .code
13655 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13656 .endd
13657 The value of &%bounce_sender_authentication%& must always be a complete email
13658 address.
13659
13660 .option callout_domain_negative_expire main time 3h
13661 .cindex "caching" "callout timeouts"
13662 .cindex "callout" "caching timeouts"
13663 This option specifies the expiry time for negative callout cache data for a
13664 domain. See section &<<SECTcallver>>& for details of callout verification, and
13665 section &<<SECTcallvercache>>& for details of the caching.
13666
13667
13668 .option callout_domain_positive_expire main time 7d
13669 This option specifies the expiry time for positive callout cache data for a
13670 domain. See section &<<SECTcallver>>& for details of callout verification, and
13671 section &<<SECTcallvercache>>& for details of the caching.
13672
13673
13674 .option callout_negative_expire main time 2h
13675 This option specifies the expiry time for negative callout cache data for an
13676 address. See section &<<SECTcallver>>& for details of callout verification, and
13677 section &<<SECTcallvercache>>& for details of the caching.
13678
13679
13680 .option callout_positive_expire main time 24h
13681 This option specifies the expiry time for positive callout cache data for an
13682 address. See section &<<SECTcallver>>& for details of callout verification, and
13683 section &<<SECTcallvercache>>& for details of the caching.
13684
13685
13686 .option callout_random_local_part main string&!! "see below"
13687 This option defines the &"random"& local part that can be used as part of
13688 callout verification. The default value is
13689 .code
13690 $primary_hostname-$tod_epoch-testing
13691 .endd
13692 See section &<<CALLaddparcall>>& for details of how this value is used.
13693
13694
13695 .option check_log_inodes main integer 0
13696 See &%check_spool_space%& below.
13697
13698
13699 .option check_log_space main integer 0
13700 See &%check_spool_space%& below.
13701
13702 .oindex "&%check_rfc2047_length%&"
13703 .cindex "RFC 2047" "disabling length check"
13704 .option check_rfc2047_length main boolean true
13705 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13706 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13707 word; strings to be encoded that exceed this length are supposed to use
13708 multiple encoded words. By default, Exim does not recognize encoded words that
13709 exceed the maximum length. However, it seems that some software, in violation
13710 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13711 set false, Exim recognizes encoded words of any length.
13712
13713
13714 .option check_spool_inodes main integer 0
13715 See &%check_spool_space%& below.
13716
13717
13718 .option check_spool_space main integer 0
13719 .cindex "checking disk space"
13720 .cindex "disk space, checking"
13721 .cindex "spool directory" "checking space"
13722 The four &%check_...%& options allow for checking of disk resources before a
13723 message is accepted.
13724
13725 .vindex "&$log_inodes$&"
13726 .vindex "&$log_space$&"
13727 .vindex "&$spool_inodes$&"
13728 .vindex "&$spool_space$&"
13729 When any of these options are set, they apply to all incoming messages. If you
13730 want to apply different checks to different kinds of message, you can do so by
13731 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13732 &$spool_space$& in an ACL with appropriate additional conditions.
13733
13734
13735 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13736 either value is greater than zero, for example:
13737 .code
13738 check_spool_space = 10M
13739 check_spool_inodes = 100
13740 .endd
13741 The spool partition is the one that contains the directory defined by
13742 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13743 transit.
13744
13745 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13746 files are written if either is greater than zero. These should be set only if
13747 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13748
13749 If there is less space or fewer inodes than requested, Exim refuses to accept
13750 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13751 error response to the MAIL command. If ESMTP is in use and there was a
13752 SIZE parameter on the MAIL command, its value is added to the
13753 &%check_spool_space%& value, and the check is performed even if
13754 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13755
13756 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13757 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13758
13759 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13760 failure a message is written to stderr and Exim exits with a non-zero code, as
13761 it obviously cannot send an error message of any kind.
13762
13763 .option daemon_smtp_ports main string &`smtp`&
13764 .cindex "port" "for daemon"
13765 .cindex "TCP/IP" "setting listening ports"
13766 This option specifies one or more default SMTP ports on which the Exim daemon
13767 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13768 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13769
13770 .option daemon_startup_retries main integer 9
13771 .cindex "daemon startup, retrying"
13772 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13773 the daemon at startup when it cannot immediately bind a listening socket
13774 (typically because the socket is already in use): &%daemon_startup_retries%&
13775 defines the number of retries after the first failure, and
13776 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13777
13778 .option daemon_startup_sleep main time 30s
13779 See &%daemon_startup_retries%&.
13780
13781 .option delay_warning main "time list" 24h
13782 .cindex "warning of delay"
13783 .cindex "delay warning, specifying"
13784 When a message is delayed, Exim sends a warning message to the sender at
13785 intervals specified by this option. The data is a colon-separated list of times
13786 after which to send warning messages. If the value of the option is an empty
13787 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13788 message has been on the queue for longer than the last time, the last interval
13789 between the times is used to compute subsequent warning times. For example,
13790 with
13791 .code
13792 delay_warning = 4h:8h:24h
13793 .endd
13794 the first message is sent after 4 hours, the second after 8 hours, and
13795 the third one after 24 hours. After that, messages are sent every 16 hours,
13796 because that is the interval between the last two times on the list. If you set
13797 just one time, it specifies the repeat interval. For example, with:
13798 .code
13799 delay_warning = 6h
13800 .endd
13801 messages are repeated every six hours. To stop warnings after a given time, set
13802 a very large time at the end of the list. For example:
13803 .code
13804 delay_warning = 2h:12h:99d
13805 .endd
13806 Note that the option is only evaluated at the time a delivery attempt fails,
13807 which depends on retry and queue-runner configuration.
13808 Typically retries will be configured more frequently than warning messages.
13809
13810 .option delay_warning_condition main string&!! "see below"
13811 .vindex "&$domain$&"
13812 The string is expanded at the time a warning message might be sent. If all the
13813 deferred addresses have the same domain, it is set in &$domain$& during the
13814 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13815 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13816 &"false"& (the comparison being done caselessly) then the warning message is
13817 not sent. The default is:
13818 .code
13819 delay_warning_condition = ${if or {\
13820   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13821   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13822   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13823   } {no}{yes}}
13824 .endd
13825 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13826 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13827 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13828 &"auto-replied"& in an &'Auto-Submitted:'& header.
13829
13830 .option deliver_drop_privilege main boolean false
13831 .cindex "unprivileged delivery"
13832 .cindex "delivery" "unprivileged"
13833 If this option is set true, Exim drops its root privilege at the start of a
13834 delivery process, and runs as the Exim user throughout. This severely restricts
13835 the kinds of local delivery that are possible, but is viable in certain types
13836 of configuration. There is a discussion about the use of root privilege in
13837 chapter &<<CHAPsecurity>>&.
13838
13839 .option deliver_queue_load_max main fixed-point unset
13840 .cindex "load average"
13841 .cindex "queue runner" "abandoning"
13842 When this option is set, a queue run is abandoned if the system load average
13843 becomes greater than the value of the option. The option has no effect on
13844 ancient operating systems on which Exim cannot determine the load average.
13845 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13846
13847
13848 .option delivery_date_remove main boolean true
13849 .cindex "&'Delivery-date:'& header line"
13850 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13851 message when it is delivered, in exactly the same way as &'Return-path:'& is
13852 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13853 should not be present in incoming messages, and this option causes them to be
13854 removed at the time the message is received, to avoid any problems that might
13855 occur when a delivered message is subsequently sent on to some other recipient.
13856
13857 .option disable_fsync main boolean false
13858 .cindex "&[fsync()]&, disabling"
13859 This option is available only if Exim was built with the compile-time option
13860 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13861 a runtime configuration generates an &"unknown option"& error. You should not
13862 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13863 really, really, really understand what you are doing. &'No pre-compiled
13864 distributions of Exim should ever make this option available.'&
13865
13866 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13867 updated files' data to be written to disc before continuing. Unexpected events
13868 such as crashes and power outages may cause data to be lost or scrambled.
13869 Here be Dragons. &*Beware.*&
13870
13871
13872 .option disable_ipv6 main boolean false
13873 .cindex "IPv6" "disabling"
13874 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13875 activities take place. AAAA records are never looked up, and any IPv6 addresses
13876 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13877 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13878 to handle IPv6 literal addresses.
13879
13880
13881 .option dns_again_means_nonexist main "domain list&!!" unset
13882 .cindex "DNS" "&""try again""& response; overriding"
13883 DNS lookups give a &"try again"& response for the DNS errors
13884 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13885 keep trying to deliver a message, or to give repeated temporary errors to
13886 incoming mail. Sometimes the effect is caused by a badly set up name server and
13887 may persist for a long time. If a domain which exhibits this problem matches
13888 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13889 This option should be used with care. You can make it apply to reverse lookups
13890 by a setting such as this:
13891 .code
13892 dns_again_means_nonexist = *.in-addr.arpa
13893 .endd
13894 This option applies to all DNS lookups that Exim does. It also applies when the
13895 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13896 since these are most likely to be caused by DNS lookup problems. The
13897 &(dnslookup)& router has some options of its own for controlling what happens
13898 when lookups for MX or SRV records give temporary errors. These more specific
13899 options are applied after this global option.
13900
13901 .option dns_check_names_pattern main string "see below"
13902 .cindex "DNS" "pre-check of name syntax"
13903 When this option is set to a non-empty string, it causes Exim to check domain
13904 names for characters that are not allowed in host names before handing them to
13905 the DNS resolver, because some resolvers give temporary errors for names that
13906 contain unusual characters. If a domain name contains any unwanted characters,
13907 a &"not found"& result is forced, and the resolver is not called. The check is
13908 done by matching the domain name against a regular expression, which is the
13909 value of this option. The default pattern is
13910 .code
13911 dns_check_names_pattern = \
13912   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13913 .endd
13914 which permits only letters, digits, slashes, and hyphens in components, but
13915 they must start and end with a letter or digit. Slashes are not, in fact,
13916 permitted in host names, but they are found in certain NS records (which can be
13917 accessed in Exim by using a &%dnsdb%& lookup). If you set
13918 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13919 empty string.
13920
13921 .option dns_csa_search_limit main integer 5
13922 This option controls the depth of parental searching for CSA SRV records in the
13923 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13924
13925 .option dns_csa_use_reverse main boolean true
13926 This option controls whether or not an IP address, given as a CSA domain, is
13927 reversed and looked up in the reverse DNS, as described in more detail in
13928 section &<<SECTverifyCSA>>&.
13929
13930
13931 .option dns_dnssec_ok main integer -1
13932 .cindex "DNS" "resolver options"
13933 .cindex "DNS" "DNSSEC"
13934 If this option is set to a non-negative number then Exim will initialise the
13935 DNS resolver library to either use or not use DNSSEC, overriding the system
13936 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
13937
13938 If the resolver library does not support DNSSEC then this option has no effect.
13939
13940
13941 .option dns_ipv4_lookup main "domain list&!!" unset
13942 .cindex "IPv6" "DNS lookup for AAAA records"
13943 .cindex "DNS" "IPv6 lookup for AAAA records"
13944 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13945 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13946 (A records) when trying to find IP addresses for hosts, unless the host's
13947 domain matches this list.
13948
13949 This is a fudge to help with name servers that give big delays or otherwise do
13950 not work for the AAAA record type. In due course, when the world's name
13951 servers have all been upgraded, there should be no need for this option.
13952
13953
13954 .option dns_retrans main time 0s
13955 .cindex "DNS" "resolver options"
13956 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13957 retransmission and retry parameters for DNS lookups. Values of zero (the
13958 defaults) leave the system default settings unchanged. The first value is the
13959 time between retries, and the second is the number of retries. It isn't
13960 totally clear exactly how these settings affect the total time a DNS lookup may
13961 take. I haven't found any documentation about timeouts on DNS lookups; these
13962 parameter values are available in the external resolver interface structure,
13963 but nowhere does it seem to describe how they are used or what you might want
13964 to set in them.
13965
13966
13967 .option dns_retry main integer 0
13968 See &%dns_retrans%& above.
13969
13970
13971 .option dns_use_edns0 main integer -1
13972 .cindex "DNS" "resolver options"
13973 .cindex "DNS" "EDNS0"
13974 If this option is set to a non-negative number then Exim will initialise the
13975 DNS resolver library to either use or not use EDNS0 extensions, overriding
13976 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13977 on.
13978
13979 If the resolver library does not support EDNS0 then this option has no effect.
13980
13981
13982 .option drop_cr main boolean false
13983 This is an obsolete option that is now a no-op. It used to affect the way Exim
13984 handled CR and LF characters in incoming messages. What happens now is
13985 described in section &<<SECTlineendings>>&.
13986
13987 .option dsn_from main "string&!!" "see below"
13988 .cindex "&'From:'& header line" "in bounces"
13989 .cindex "bounce messages" "&'From:'& line, specifying"
13990 This option can be used to vary the contents of &'From:'& header lines in
13991 bounces and other automatically generated messages (&"Delivery Status
13992 Notifications"& &-- hence the name of the option). The default setting is:
13993 .code
13994 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13995 .endd
13996 The value is expanded every time it is needed. If the expansion fails, a
13997 panic is logged, and the default value is used.
13998
13999 .option envelope_to_remove main boolean true
14000 .cindex "&'Envelope-to:'& header line"
14001 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14002 message when it is delivered, in exactly the same way as &'Return-path:'& is
14003 handled. &'Envelope-to:'& records the original recipient address from the
14004 messages's envelope that caused the delivery to happen. Such headers should not
14005 be present in incoming messages, and this option causes them to be removed at
14006 the time the message is received, to avoid any problems that might occur when a
14007 delivered message is subsequently sent on to some other recipient.
14008
14009
14010 .option errors_copy main "string list&!!" unset
14011 .cindex "bounce message" "copy to other address"
14012 .cindex "copy of bounce message"
14013 Setting this option causes Exim to send bcc copies of bounce messages that it
14014 generates to other addresses. &*Note*&: This does not apply to bounce messages
14015 coming from elsewhere. The value of the option is a colon-separated list of
14016 items. Each item consists of a pattern, terminated by white space, followed by
14017 a comma-separated list of email addresses. If a pattern contains spaces, it
14018 must be enclosed in double quotes.
14019
14020 Each pattern is processed in the same way as a single item in an address list
14021 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14022 the bounce message, the message is copied to the addresses on the list. The
14023 items are scanned in order, and once a matching one is found, no further items
14024 are examined. For example:
14025 .code
14026 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14027               rqps@mydomain   hostmaster@mydomain.example,\
14028                               postmaster@mydomain.example
14029 .endd
14030 .vindex "&$domain$&"
14031 .vindex "&$local_part$&"
14032 The address list is expanded before use. The expansion variables &$local_part$&
14033 and &$domain$& are set from the original recipient of the error message, and if
14034 there was any wildcard matching in the pattern, the expansion
14035 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14036 variables &$0$&, &$1$&, etc. are set in the normal way.
14037
14038
14039 .option errors_reply_to main string unset
14040 .cindex "bounce message" "&'Reply-to:'& in"
14041 By default, Exim's bounce and delivery warning messages contain the header line
14042 .display
14043 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14044 .endd
14045 .oindex &%quota_warn_message%&
14046 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14047 A warning message that is generated by the &%quota_warn_message%& option in an
14048 &(appendfile)& transport may contain its own &'From:'& header line that
14049 overrides the default.
14050
14051 Experience shows that people reply to bounce messages. If the
14052 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14053 and warning messages. For example:
14054 .code
14055 errors_reply_to = postmaster@my.domain.example
14056 .endd
14057 The value of the option is not expanded. It must specify a valid RFC 2822
14058 address. However, if a warning message that is generated by the
14059 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14060 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14061 not used.
14062
14063
14064 .option exim_group main string "compile-time configured"
14065 .cindex "gid (group id)" "Exim's own"
14066 .cindex "Exim group"
14067 This option changes the gid under which Exim runs when it gives up root
14068 privilege. The default value is compiled into the binary. The value of this
14069 option is used only when &%exim_user%& is also set. Unless it consists entirely
14070 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14071 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14072 security issues.
14073
14074
14075 .option exim_path main string "see below"
14076 .cindex "Exim binary, path name"
14077 This option specifies the path name of the Exim binary, which is used when Exim
14078 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14079 the directory configured at compile time by the BIN_DIRECTORY setting. It
14080 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14081 other place.
14082 &*Warning*&: Do not use a macro to define the value of this option, because
14083 you will break those Exim utilities that scan the configuration file to find
14084 where the binary is. (They then use the &%-bP%& option to extract option
14085 settings such as the value of &%spool_directory%&.)
14086
14087
14088 .option exim_user main string "compile-time configured"
14089 .cindex "uid (user id)" "Exim's own"
14090 .cindex "Exim user"
14091 This option changes the uid under which Exim runs when it gives up root
14092 privilege. The default value is compiled into the binary. Ownership of the run
14093 time configuration file and the use of the &%-C%& and &%-D%& command line
14094 options is checked against the values in the binary, not what is set here.
14095
14096 Unless it consists entirely of digits, the string is looked up using
14097 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14098 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14099 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14100
14101
14102 .option extra_local_interfaces main "string list" unset
14103 This option defines network interfaces that are to be considered local when
14104 routing, but which are not used for listening by the daemon. See section
14105 &<<SECTreclocipadd>>& for details.
14106
14107
14108 . Allow this long option name to split; give it unsplit as a fifth argument
14109 . for the automatic .oindex that is generated by .option.
14110
14111 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14112          extract_addresses_remove_arguments
14113 .oindex "&%-t%&"
14114 .cindex "command line" "addresses with &%-t%&"
14115 .cindex "Sendmail compatibility" "&%-t%& option"
14116 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14117 are present on the command line when the &%-t%& option is used to build an
14118 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14119 line addresses are removed from the recipients list. This is also how Smail
14120 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14121 command line addresses are added to those obtained from the header lines. When
14122 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14123 argument headers. If it is set false, Exim adds rather than removes argument
14124 addresses.
14125
14126
14127 .option finduser_retries main integer 0
14128 .cindex "NIS, retrying user lookups"
14129 On systems running NIS or other schemes in which user and group information is
14130 distributed from a remote system, there can be times when &[getpwnam()]& and
14131 related functions fail, even when given valid data, because things time out.
14132 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14133 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14134 many extra times to find a user or a group, waiting for one second between
14135 retries.
14136
14137 .cindex "&_/etc/passwd_&" "multiple reading of"
14138 You should not set this option greater than zero if your user information is in
14139 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14140 search the file multiple times for non-existent users, and also cause delay.
14141
14142
14143
14144 .option freeze_tell main "string list, comma separated" unset
14145 .cindex "freezing messages" "sending a message when freezing"
14146 On encountering certain errors, or when configured to do so in a system filter,
14147 ACL, or special router, Exim freezes a message. This means that no further
14148 delivery attempts take place until an administrator thaws the message, or the
14149 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14150 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14151 warning message whenever it freezes something, unless the message it is
14152 freezing is a locally-generated bounce message. (Without this exception there
14153 is the possibility of looping.) The warning message is sent to the addresses
14154 supplied as the comma-separated value of this option. If several of the
14155 message's addresses cause freezing, only a single message is sent. If the
14156 freezing was automatic, the reason(s) for freezing can be found in the message
14157 log. If you configure freezing in a filter or ACL, you must arrange for any
14158 logging that you require.
14159
14160
14161 .option gecos_name main string&!! unset
14162 .cindex "HP-UX"
14163 .cindex "&""gecos""& field, parsing"
14164 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14165 password file to hold other information in addition to users' real names. Exim
14166 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14167 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14168 of the field are used unchanged, except that, if an ampersand is encountered,
14169 it is replaced by the user's login name with the first character forced to
14170 upper case, since this is a convention that is observed on many systems.
14171
14172 When these options are set, &%gecos_pattern%& is treated as a regular
14173 expression that is to be applied to the field (again with && replaced by the
14174 login name), and if it matches, &%gecos_name%& is expanded and used as the
14175 user's name.
14176
14177 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14178 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14179 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14180 name terminates at the first comma, the following can be used:
14181 .code
14182 gecos_pattern = ([^,]*)
14183 gecos_name = $1
14184 .endd
14185
14186 .option gecos_pattern main string unset
14187 See &%gecos_name%& above.
14188
14189
14190 .option gnutls_compat_mode main boolean unset
14191 This option controls whether GnuTLS is used in compatibility mode in an Exim
14192 server. This reduces security slightly, but improves interworking with older
14193 implementations of TLS.
14194
14195
14196 option gnutls_allow_auto_pkcs11 main boolean unset
14197 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14198 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14199
14200 See
14201 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14202 for documentation.
14203
14204
14205
14206 .option headers_charset main string "see below"
14207 This option sets a default character set for translating from encoded MIME
14208 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14209 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14210 ultimate default is ISO-8859-1. For more details see the description of header
14211 insertions in section &<<SECTexpansionitems>>&.
14212
14213
14214
14215 .option header_maxsize main integer "see below"
14216 .cindex "header section" "maximum size of"
14217 .cindex "limit" "size of message header section"
14218 This option controls the overall maximum size of a message's header
14219 section. The default is the value of HEADER_MAXSIZE in
14220 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14221 sections are rejected.
14222
14223
14224 .option header_line_maxsize main integer 0
14225 .cindex "header lines" "maximum size of"
14226 .cindex "limit" "size of one header line"
14227 This option limits the length of any individual header line in a message, after
14228 all the continuations have been joined together. Messages with individual
14229 header lines that are longer than the limit are rejected. The default value of
14230 zero means &"no limit"&.
14231
14232
14233
14234
14235 .option helo_accept_junk_hosts main "host list&!!" unset
14236 .cindex "HELO" "accepting junk data"
14237 .cindex "EHLO" "accepting junk data"
14238 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14239 mail, and gives an error response for invalid data. Unfortunately, there are
14240 some SMTP clients that send syntactic junk. They can be accommodated by setting
14241 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14242 if you want to do semantic checking.
14243 See also &%helo_allow_chars%& for a way of extending the permitted character
14244 set.
14245
14246
14247 .option helo_allow_chars main string unset
14248 .cindex "HELO" "underscores in"
14249 .cindex "EHLO" "underscores in"
14250 .cindex "underscore in EHLO/HELO"
14251 This option can be set to a string of rogue characters that are permitted in
14252 all EHLO and HELO names in addition to the standard letters, digits,
14253 hyphens, and dots. If you really must allow underscores, you can set
14254 .code
14255 helo_allow_chars = _
14256 .endd
14257 Note that the value is one string, not a list.
14258
14259
14260 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14261 .cindex "HELO" "forcing reverse lookup"
14262 .cindex "EHLO" "forcing reverse lookup"
14263 If the domain given by a client in a HELO or EHLO command matches this
14264 list, a reverse lookup is done in order to establish the host's true name. The
14265 default forces a lookup if the client host gives the server's name or any of
14266 its IP addresses (in brackets), something that broken clients have been seen to
14267 do.
14268
14269
14270 .option helo_try_verify_hosts main "host list&!!" unset
14271 .cindex "HELO verifying" "optional"
14272 .cindex "EHLO" "verifying, optional"
14273 By default, Exim just checks the syntax of HELO and EHLO commands (see
14274 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14275 to do more extensive checking of the data supplied by these commands. The ACL
14276 condition &`verify = helo`& is provided to make this possible.
14277 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14278 to force the check to occur. From release 4.53 onwards, this is no longer
14279 necessary. If the check has not been done before &`verify = helo`& is
14280 encountered, it is done at that time. Consequently, this option is obsolete.
14281 Its specification is retained here for backwards compatibility.
14282
14283 When an EHLO or HELO command is received, if the calling host matches
14284 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14285 EHLO command either:
14286
14287 .ilist
14288 is an IP literal matching the calling address of the host, or
14289 .next
14290 .cindex "DNS" "reverse lookup"
14291 .cindex "reverse DNS lookup"
14292 matches the host name that Exim obtains by doing a reverse lookup of the
14293 calling host address, or
14294 .next
14295 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14296 available) yields the calling host address.
14297 .endlist
14298
14299 However, the EHLO or HELO command is not rejected if any of the checks
14300 fail. Processing continues, but the result of the check is remembered, and can
14301 be detected later in an ACL by the &`verify = helo`& condition.
14302
14303 .option helo_verify_hosts main "host list&!!" unset
14304 .cindex "HELO verifying" "mandatory"
14305 .cindex "EHLO" "verifying, mandatory"
14306 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14307 backwards compatibility. For hosts that match this option, Exim checks the host
14308 name given in the HELO or EHLO in the same way as for
14309 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14310 rejected with a 550 error, and entries are written to the main and reject logs.
14311 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14312 error.
14313
14314 .option hold_domains main "domain list&!!" unset
14315 .cindex "domain" "delaying delivery"
14316 .cindex "delivery" "delaying certain domains"
14317 This option allows mail for particular domains to be held on the queue
14318 manually. The option is overridden if a message delivery is forced with the
14319 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14320 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14321 item in &%hold_domains%&, no routing or delivery for that address is done, and
14322 it is deferred every time the message is looked at.
14323
14324 This option is intended as a temporary operational measure for delaying the
14325 delivery of mail while some problem is being sorted out, or some new
14326 configuration tested. If you just want to delay the processing of some
14327 domains until a queue run occurs, you should use &%queue_domains%& or
14328 &%queue_smtp_domains%&, not &%hold_domains%&.
14329
14330 A setting of &%hold_domains%& does not override Exim's code for removing
14331 messages from the queue if they have been there longer than the longest retry
14332 time in any retry rule. If you want to hold messages for longer than the normal
14333 retry times, insert a dummy retry rule with a long retry time.
14334
14335
14336 .option host_lookup main "host list&!!" unset
14337 .cindex "host name" "lookup, forcing"
14338 Exim does not look up the name of a calling host from its IP address unless it
14339 is required to compare against some host list, or the host matches
14340 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14341 option (which normally contains IP addresses rather than host names). The
14342 default configuration file contains
14343 .code
14344 host_lookup = *
14345 .endd
14346 which causes a lookup to happen for all hosts. If the expense of these lookups
14347 is felt to be too great, the setting can be changed or removed.
14348
14349 After a successful reverse lookup, Exim does a forward lookup on the name it
14350 has obtained, to verify that it yields the IP address that it started with. If
14351 this check fails, Exim behaves as if the name lookup failed.
14352
14353 .vindex "&$host_lookup_failed$&"
14354 .vindex "&$sender_host_name$&"
14355 After any kind of failure, the host name (in &$sender_host_name$&) remains
14356 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14357 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14358 &`verify = reverse_host_lookup`& in ACLs.
14359
14360
14361 .option host_lookup_order main "string list" &`bydns:byaddr`&
14362 This option specifies the order of different lookup methods when Exim is trying
14363 to find a host name from an IP address. The default is to do a DNS lookup
14364 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14365 if that fails. You can change the order of these lookups, or omit one entirely,
14366 if you want.
14367
14368 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14369 multiple PTR records in the DNS and the IP address is not listed in
14370 &_/etc/hosts_&. Different operating systems give different results in this
14371 case. That is why the default tries a DNS lookup first.
14372
14373
14374
14375 .option host_reject_connection main "host list&!!" unset
14376 .cindex "host" "rejecting connections from"
14377 If this option is set, incoming SMTP calls from the hosts listed are rejected
14378 as soon as the connection is made.
14379 This option is obsolete, and retained only for backward compatibility, because
14380 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14381 connections immediately.
14382
14383 The ability to give an immediate rejection (either by this option or using an
14384 ACL) is provided for use in unusual cases. Many hosts will just try again,
14385 sometimes without much delay. Normally, it is better to use an ACL to reject
14386 incoming messages at a later stage, such as after RCPT commands. See
14387 chapter &<<CHAPACL>>&.
14388
14389
14390 .option hosts_connection_nolog main "host list&!!" unset
14391 .cindex "host" "not logging connections from"
14392 This option defines a list of hosts for which connection logging does not
14393 happen, even though the &%smtp_connection%& log selector is set. For example,
14394 you might want not to log SMTP connections from local processes, or from
14395 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14396 the daemon; you should therefore strive to restrict its value to a short inline
14397 list of IP addresses and networks. To disable logging SMTP connections from
14398 local processes, you must create a host list with an empty item. For example:
14399 .code
14400 hosts_connection_nolog = :
14401 .endd
14402 If the &%smtp_connection%& log selector is not set, this option has no effect.
14403
14404
14405
14406 .option hosts_treat_as_local main "domain list&!!" unset
14407 .cindex "local host" "domains treated as"
14408 .cindex "host" "treated as local"
14409 If this option is set, any host names that match the domain list are treated as
14410 if they were the local host when Exim is scanning host lists obtained from MX
14411 records
14412 or other sources. Note that the value of this option is a domain list, not a
14413 host list, because it is always used to check host names, not IP addresses.
14414
14415 This option also applies when Exim is matching the special items
14416 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14417 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14418 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14419 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14420 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14421 interfaces and recognizing the local host.
14422
14423
14424 .option ibase_servers main "string list" unset
14425 .cindex "InterBase" "server list"
14426 This option provides a list of InterBase servers and associated connection data,
14427 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14428 The option is available only if Exim has been built with InterBase support.
14429
14430
14431
14432 .option ignore_bounce_errors_after main time 10w
14433 .cindex "bounce message" "discarding"
14434 .cindex "discarding bounce message"
14435 This option affects the processing of bounce messages that cannot be delivered,
14436 that is, those that suffer a permanent delivery failure. (Bounce messages that
14437 suffer temporary delivery failures are of course retried in the usual way.)
14438
14439 After a permanent delivery failure, bounce messages are frozen,
14440 because there is no sender to whom they can be returned. When a frozen bounce
14441 message has been on the queue for more than the given time, it is unfrozen at
14442 the next queue run, and a further delivery is attempted. If delivery fails
14443 again, the bounce message is discarded. This makes it possible to keep failed
14444 bounce messages around for a shorter time than the normal maximum retry time
14445 for frozen messages. For example,
14446 .code
14447 ignore_bounce_errors_after = 12h
14448 .endd
14449 retries failed bounce message deliveries after 12 hours, discarding any further
14450 failures. If the value of this option is set to a zero time period, bounce
14451 failures are discarded immediately. Setting a very long time (as in the default
14452 value) has the effect of disabling this option. For ways of automatically
14453 dealing with other kinds of frozen message, see &%auto_thaw%& and
14454 &%timeout_frozen_after%&.
14455
14456
14457 .option ignore_fromline_hosts main "host list&!!" unset
14458 .cindex "&""From""& line"
14459 .cindex "UUCP" "&""From""& line"
14460 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14461 the headers of a message. By default this is treated as the start of the
14462 message's body, which means that any following headers are not recognized as
14463 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14464 match those hosts that insist on sending it. If the sender is actually a local
14465 process rather than a remote host, and is using &%-bs%& to inject the messages,
14466 &%ignore_fromline_local%& must be set to achieve this effect.
14467
14468
14469 .option ignore_fromline_local main boolean false
14470 See &%ignore_fromline_hosts%& above.
14471
14472
14473 .option keep_malformed main time 4d
14474 This option specifies the length of time to keep messages whose spool files
14475 have been corrupted in some way. This should, of course, never happen. At the
14476 next attempt to deliver such a message, it gets removed. The incident is
14477 logged.
14478
14479
14480 .option ldap_ca_cert_dir main string unset
14481 .cindex "LDAP", "TLS CA certificate directory"
14482 This option indicates which directory contains CA certificates for verifying
14483 a TLS certificate presented by an LDAP server.
14484 While Exim does not provide a default value, your SSL library may.
14485 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14486 and constrained to be a directory.
14487
14488
14489 .option ldap_ca_cert_file main string unset
14490 .cindex "LDAP", "TLS CA certificate file"
14491 This option indicates which file contains CA certificates for verifying
14492 a TLS certificate presented by an LDAP server.
14493 While Exim does not provide a default value, your SSL library may.
14494 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14495 and constrained to be a file.
14496
14497
14498 .option ldap_cert_file main string unset
14499 .cindex "LDAP" "TLS client certificate file"
14500 This option indicates which file contains an TLS client certificate which
14501 Exim should present to the LDAP server during TLS negotiation.
14502 Should be used together with &%ldap_cert_key%&.
14503
14504
14505 .option ldap_cert_key main string unset
14506 .cindex "LDAP" "TLS client key file"
14507 This option indicates which file contains the secret/private key to use
14508 to prove identity to the LDAP server during TLS negotiation.
14509 Should be used together with &%ldap_cert_file%&, which contains the
14510 identity to be proven.
14511
14512
14513 .option ldap_cipher_suite main string unset
14514 .cindex "LDAP" "TLS cipher suite"
14515 This controls the TLS cipher-suite negotiation during TLS negotiation with
14516 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14517 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14518
14519
14520 .option ldap_default_servers main "string list" unset
14521 .cindex "LDAP" "default servers"
14522 This option provides a list of LDAP servers which are tried in turn when an
14523 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14524 details of LDAP queries. This option is available only when Exim has been built
14525 with LDAP support.
14526
14527
14528 .option ldap_require_cert main string unset.
14529 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14530 This should be one of the values "hard", "demand", "allow", "try" or "never".
14531 A value other than one of these is interpreted as "never".
14532 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14533 Although Exim does not set a default, the LDAP library probably defaults
14534 to hard/demand.
14535
14536
14537 .option ldap_start_tls main boolean false
14538 .cindex "LDAP" "whether or not to negotiate TLS"
14539 If set, Exim will attempt to negotiate TLS with the LDAP server when
14540 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14541 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14542 of SSL-on-connect.
14543 In the event of failure to negotiate TLS, the action taken is controlled
14544 by &%ldap_require_cert%&.
14545
14546
14547 .option ldap_version main integer unset
14548 .cindex "LDAP" "protocol version, forcing"
14549 This option can be used to force Exim to set a specific protocol version for
14550 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14551 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14552 the LDAP headers; otherwise it is 2. This option is available only when Exim
14553 has been built with LDAP support.
14554
14555
14556
14557 .option local_from_check main boolean true
14558 .cindex "&'Sender:'& header line" "disabling addition of"
14559 .cindex "&'From:'& header line" "disabling checking of"
14560 When a message is submitted locally (that is, not over a TCP/IP connection) by
14561 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14562 checks that the &'From:'& header line matches the login of the calling user and
14563 the domain specified by &%qualify_domain%&.
14564
14565 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14566 locally submitted message is automatically qualified by Exim, unless the
14567 &%-bnq%& command line option is used.
14568
14569 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14570 on the local part. If the &'From:'& header line does not match, Exim adds a
14571 &'Sender:'& header with an address constructed from the calling user's login
14572 and the default qualify domain.
14573
14574 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14575 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14576 &'Sender:'& header lines supplied by untrusted users, you must also set
14577 &%local_sender_retain%& to be true.
14578
14579 .cindex "envelope sender"
14580 These options affect only the header lines in the message. The envelope sender
14581 is still forced to be the login id at the qualify domain unless
14582 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14583
14584 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14585 request similar header line checking. See section &<<SECTthesenhea>>&, which
14586 has more details about &'Sender:'& processing.
14587
14588
14589
14590
14591 .option local_from_prefix main string unset
14592 When Exim checks the &'From:'& header line of locally submitted messages for
14593 matching the login id (see &%local_from_check%& above), it can be configured to
14594 ignore certain prefixes and suffixes in the local part of the address. This is
14595 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14596 appropriate lists, in the same form as the &%local_part_prefix%& and
14597 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14598 example, if
14599 .code
14600 local_from_prefix = *-
14601 .endd
14602 is set, a &'From:'& line containing
14603 .code
14604 From: anything-user@your.domain.example
14605 .endd
14606 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14607 matches the actual sender address that is constructed from the login name and
14608 qualify domain.
14609
14610
14611 .option local_from_suffix main string unset
14612 See &%local_from_prefix%& above.
14613
14614
14615 .option local_interfaces main "string list" "see below"
14616 This option controls which network interfaces are used by the daemon for
14617 listening; they are also used to identify the local host when routing. Chapter
14618 &<<CHAPinterfaces>>& contains a full description of this option and the related
14619 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14620 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14621 &%local_interfaces%& is
14622 .code
14623 local_interfaces = 0.0.0.0
14624 .endd
14625 when Exim is built without IPv6 support; otherwise it is
14626 .code
14627 local_interfaces = <; ::0 ; 0.0.0.0
14628 .endd
14629
14630 .option local_scan_timeout main time 5m
14631 .cindex "timeout" "for &[local_scan()]& function"
14632 .cindex "&[local_scan()]& function" "timeout"
14633 This timeout applies to the &[local_scan()]& function (see chapter
14634 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14635 the incoming message is rejected with a temporary error if it is an SMTP
14636 message. For a non-SMTP message, the message is dropped and Exim ends with a
14637 non-zero code. The incident is logged on the main and reject logs.
14638
14639
14640
14641 .option local_sender_retain main boolean false
14642 .cindex "&'Sender:'& header line" "retaining from local submission"
14643 When a message is submitted locally (that is, not over a TCP/IP connection) by
14644 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14645 do not want this to happen, you must set &%local_sender_retain%&, and you must
14646 also set &%local_from_check%& to be false (Exim will complain if you do not).
14647 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14648 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14649
14650
14651
14652
14653 .option localhost_number main string&!! unset
14654 .cindex "host" "locally unique number for"
14655 .cindex "message ids" "with multiple hosts"
14656 .vindex "&$localhost_number$&"
14657 Exim's message ids are normally unique only within the local host. If
14658 uniqueness among a set of hosts is required, each host must set a different
14659 value for the &%localhost_number%& option. The string is expanded immediately
14660 after reading the configuration file (so that a number can be computed from the
14661 host name, for example) and the result of the expansion must be a number in the
14662 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14663 systems). This is available in subsequent string expansions via the variable
14664 &$localhost_number$&. When &%localhost_number is set%&, the final two
14665 characters of the message id, instead of just being a fractional part of the
14666 time, are computed from the time and the local host number as described in
14667 section &<<SECTmessiden>>&.
14668
14669
14670
14671 .option log_file_path main "string list&!!" "set at compile time"
14672 .cindex "log" "file path for"
14673 This option sets the path which is used to determine the names of Exim's log
14674 files, or indicates that logging is to be to syslog, or both. It is expanded
14675 when Exim is entered, so it can, for example, contain a reference to the host
14676 name. If no specific path is set for the log files at compile or run time, they
14677 are written in a sub-directory called &_log_& in Exim's spool directory.
14678 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14679 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14680 used. If this string is fixed at your installation (contains no expansion
14681 variables) it is recommended that you do not set this option in the
14682 configuration file, but instead supply the path using LOG_FILE_PATH in
14683 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14684 early on &-- in particular, failure to read the configuration file.
14685
14686
14687 .option log_selector main string unset
14688 .cindex "log" "selectors"
14689 This option can be used to reduce or increase the number of things that Exim
14690 writes to its log files. Its argument is made up of names preceded by plus or
14691 minus characters. For example:
14692 .code
14693 log_selector = +arguments -retry_defer
14694 .endd
14695 A list of possible names and what they control is given in the chapter on
14696 logging, in section &<<SECTlogselector>>&.
14697
14698
14699 .option log_timezone main boolean false
14700 .cindex "log" "timezone for entries"
14701 .vindex "&$tod_log$&"
14702 .vindex "&$tod_zone$&"
14703 By default, the timestamps on log lines are in local time without the
14704 timezone. This means that if your timezone changes twice a year, the timestamps
14705 in log lines are ambiguous for an hour when the clocks go back. One way of
14706 avoiding this problem is to set the timezone to UTC. An alternative is to set
14707 &%log_timezone%& true. This turns on the addition of the timezone offset to
14708 timestamps in log lines. Turning on this option can add quite a lot to the size
14709 of log files because each line is extended by 6 characters. Note that the
14710 &$tod_log$& variable contains the log timestamp without the zone, but there is
14711 another variable called &$tod_zone$& that contains just the timezone offset.
14712
14713
14714 .option lookup_open_max main integer 25
14715 .cindex "too many open files"
14716 .cindex "open files, too many"
14717 .cindex "file" "too many open"
14718 .cindex "lookup" "maximum open files"
14719 .cindex "limit" "open files for lookups"
14720 This option limits the number of simultaneously open files for single-key
14721 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14722 Exim normally keeps these files open during routing, because often the same
14723 file is required several times. If the limit is reached, Exim closes the least
14724 recently used file. Note that if you are using the &'ndbm'& library, it
14725 actually opens two files for each logical DBM database, though it still counts
14726 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14727 open files"& errors with NDBM, you need to reduce the value of
14728 &%lookup_open_max%&.
14729
14730
14731 .option max_username_length main integer 0
14732 .cindex "length of login name"
14733 .cindex "user name" "maximum length"
14734 .cindex "limit" "user name length"
14735 Some operating systems are broken in that they truncate long arguments to
14736 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14737 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14738 an argument that is longer behaves as if &[getpwnam()]& failed.
14739
14740
14741 .option message_body_newlines main bool false
14742 .cindex "message body" "newlines in variables"
14743 .cindex "newline" "in message body variables"
14744 .vindex "&$message_body$&"
14745 .vindex "&$message_body_end$&"
14746 By default, newlines in the message body are replaced by spaces when setting
14747 the &$message_body$& and &$message_body_end$& expansion variables. If this
14748 option is set true, this no longer happens.
14749
14750
14751 .option message_body_visible main integer 500
14752 .cindex "body of message" "visible size"
14753 .cindex "message body" "visible size"
14754 .vindex "&$message_body$&"
14755 .vindex "&$message_body_end$&"
14756 This option specifies how much of a message's body is to be included in the
14757 &$message_body$& and &$message_body_end$& expansion variables.
14758
14759
14760 .option message_id_header_domain main string&!! unset
14761 .cindex "&'Message-ID:'& header line"
14762 If this option is set, the string is expanded and used as the right hand side
14763 (domain) of the &'Message-ID:'& header that Exim creates if a
14764 locally-originated incoming message does not have one. &"Locally-originated"&
14765 means &"not received over TCP/IP."&
14766 Otherwise, the primary host name is used.
14767 Only letters, digits, dot and hyphen are accepted; any other characters are
14768 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14769 empty string, the option is ignored.
14770
14771
14772 .option message_id_header_text main string&!! unset
14773 If this variable is set, the string is expanded and used to augment the text of
14774 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14775 message does not have one. The text of this header is required by RFC 2822 to
14776 take the form of an address. By default, Exim uses its internal message id as
14777 the local part, and the primary host name as the domain. If this option is set,
14778 it is expanded, and provided the expansion is not forced to fail, and does not
14779 yield an empty string, the result is inserted into the header immediately
14780 before the @, separated from the internal message id by a dot. Any characters
14781 that are illegal in an address are automatically converted into hyphens. This
14782 means that variables such as &$tod_log$& can be used, because the spaces and
14783 colons will become hyphens.
14784
14785
14786 .option message_logs main boolean true
14787 .cindex "message logs" "disabling"
14788 .cindex "log" "message log; disabling"
14789 If this option is turned off, per-message log files are not created in the
14790 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14791 Exim, by reducing the number of files involved in handling a message from a
14792 minimum of four (header spool file, body spool file, delivery journal, and
14793 per-message log) to three. The other major I/O activity is Exim's main log,
14794 which is not affected by this option.
14795
14796
14797 .option message_size_limit main string&!! 50M
14798 .cindex "message" "size limit"
14799 .cindex "limit" "message size"
14800 .cindex "size" "of message, limit"
14801 This option limits the maximum size of message that Exim will process. The
14802 value is expanded for each incoming connection so, for example, it can be made
14803 to depend on the IP address of the remote host for messages arriving via
14804 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14805 optionally followed by K or M.
14806
14807 &*Note*&: This limit cannot be made to depend on a message's sender or any
14808 other properties of an individual message, because it has to be advertised in
14809 the server's response to EHLO. String expansion failure causes a temporary
14810 error. A value of zero means no limit, but its use is not recommended. See also
14811 &%bounce_return_size_limit%&.
14812
14813 Incoming SMTP messages are failed with a 552 error if the limit is
14814 exceeded; locally-generated messages either get a stderr message or a delivery
14815 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14816 an oversized message is logged in both the main and the reject logs. See also
14817 the generic transport option &%message_size_limit%&, which limits the size of
14818 message that an individual transport can process.
14819
14820 If you use a virus-scanner and set this option to to a value larger than the
14821 maximum size that your virus-scanner is configured to support, you may get
14822 failures triggered by large mails.  The right size to configure for the
14823 virus-scanner depends upon what data is passed and the options in use but it's
14824 probably safest to just set it to a little larger than this value.  Eg, with a
14825 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14826 some problems may result.
14827
14828 A value of 0 will disable size limit checking; Exim will still advertise the
14829 SIZE extension in an EHLO response, but without a limit, so as to permit
14830 SMTP clients to still indicate the message size along with the MAIL verb.
14831
14832
14833 .option move_frozen_messages main boolean false
14834 .cindex "frozen messages" "moving"
14835 This option, which is available only if Exim has been built with the setting
14836 .code
14837 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14838 .endd
14839 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14840 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14841 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14842 standard utilities for handling such moved messages, and they do not show up in
14843 lists generated by &%-bp%& or by the Exim monitor.
14844
14845
14846 .option mua_wrapper main boolean false
14847 Setting this option true causes Exim to run in a very restrictive mode in which
14848 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14849 contains a full description of this facility.
14850
14851
14852
14853 .option mysql_servers main "string list" unset
14854 .cindex "MySQL" "server list"
14855 This option provides a list of MySQL servers and associated connection data, to
14856 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14857 option is available only if Exim has been built with MySQL support.
14858
14859
14860 .option never_users main "string list&!!" unset
14861 This option is expanded just once, at the start of Exim's processing. Local
14862 message deliveries are normally run in processes that are setuid to the
14863 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14864 It is usually desirable to prevent any deliveries from running as root, as a
14865 safety precaution.
14866
14867 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14868 list of users that must not be used for local deliveries. This list is fixed in
14869 the binary and cannot be overridden by the configuration file. By default, it
14870 contains just the single user name &"root"&. The &%never_users%& runtime option
14871 can be used to add more users to the fixed list.
14872
14873 If a message is to be delivered as one of the users on the fixed list or the
14874 &%never_users%& list, an error occurs, and delivery is deferred. A common
14875 example is
14876 .code
14877 never_users = root:daemon:bin
14878 .endd
14879 Including root is redundant if it is also on the fixed list, but it does no
14880 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14881 transport driver.
14882
14883
14884 .option openssl_options main "string list" "+no_sslv2"
14885 .cindex "OpenSSL "compatibility options"
14886 This option allows an administrator to adjust the SSL options applied
14887 by OpenSSL to connections.  It is given as a space-separated list of items,
14888 each one to be +added or -subtracted from the current value.
14889
14890 This option is only available if Exim is built against OpenSSL.  The values
14891 available for this option vary according to the age of your OpenSSL install.
14892 The &"all"& value controls a subset of flags which are available, typically
14893 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14894 list the values known on your system and Exim should support all the
14895 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14896 names lose the leading &"SSL_OP_"& and are lower-cased.
14897
14898 Note that adjusting the options can have severe impact upon the security of
14899 SSL as used by Exim.  It is possible to disable safety checks and shoot
14900 yourself in the foot in various unpleasant ways.  This option should not be
14901 adjusted lightly.  An unrecognised item will be detected at startup, by
14902 invoking Exim with the &%-bV%& flag.
14903
14904 Historical note: prior to release 4.80, Exim defaulted this value to
14905 "+dont_insert_empty_fragments", which may still be needed for compatibility
14906 with some clients, but which lowers security by increasing exposure to
14907 some now infamous attacks.
14908
14909 An example:
14910 .code
14911 # Make both old MS and old Eudora happy:
14912 openssl_options = -all +microsoft_big_sslv3_buffer \
14913                        +dont_insert_empty_fragments
14914 .endd
14915
14916 Possible options may include:
14917 .ilist
14918 &`all`&
14919 .next
14920 &`allow_unsafe_legacy_renegotiation`&
14921 .next
14922 &`cipher_server_preference`&
14923 .next
14924 &`dont_insert_empty_fragments`&
14925 .next
14926 &`ephemeral_rsa`&
14927 .next
14928 &`legacy_server_connect`&
14929 .next
14930 &`microsoft_big_sslv3_buffer`&
14931 .next
14932 &`microsoft_sess_id_bug`&
14933 .next
14934 &`msie_sslv2_rsa_padding`&
14935 .next
14936 &`netscape_challenge_bug`&
14937 .next
14938 &`netscape_reuse_cipher_change_bug`&
14939 .next
14940 &`no_compression`&
14941 .next
14942 &`no_session_resumption_on_renegotiation`&
14943 .next
14944 &`no_sslv2`&
14945 .next
14946 &`no_sslv3`&
14947 .next
14948 &`no_ticket`&
14949 .next
14950 &`no_tlsv1`&
14951 .next
14952 &`no_tlsv1_1`&
14953 .next
14954 &`no_tlsv1_2`&
14955 .next
14956 &`safari_ecdhe_ecdsa_bug`&
14957 .next
14958 &`single_dh_use`&
14959 .next
14960 &`single_ecdh_use`&
14961 .next
14962 &`ssleay_080_client_dh_bug`&
14963 .next
14964 &`sslref2_reuse_cert_type_bug`&
14965 .next
14966 &`tls_block_padding_bug`&
14967 .next
14968 &`tls_d5_bug`&
14969 .next
14970 &`tls_rollback_bug`&
14971 .endlist
14972
14973 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
14974 all clients connecting using the MacOS SecureTransport TLS facility prior
14975 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
14976 to negotiate TLS then this option value might help, provided that your OpenSSL
14977 release is new enough to contain this work-around.  This may be a situation
14978 where you have to upgrade OpenSSL to get buggy clients working.
14979
14980
14981 .option oracle_servers main "string list" unset
14982 .cindex "Oracle" "server list"
14983 This option provides a list of Oracle servers and associated connection data,
14984 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14985 The option is available only if Exim has been built with Oracle support.
14986
14987
14988 .option percent_hack_domains main "domain list&!!" unset
14989 .cindex "&""percent hack""&"
14990 .cindex "source routing" "in email address"
14991 .cindex "address" "source-routed"
14992 The &"percent hack"& is the convention whereby a local part containing a
14993 percent sign is re-interpreted as a new email address, with the percent
14994 replaced by @. This is sometimes called &"source routing"&, though that term is
14995 also applied to RFC 2822 addresses that begin with an @ character. If this
14996 option is set, Exim implements the percent facility for those domains listed,
14997 but no others. This happens before an incoming SMTP address is tested against
14998 an ACL.
14999
15000 &*Warning*&: The &"percent hack"& has often been abused by people who are
15001 trying to get round relaying restrictions. For this reason, it is best avoided
15002 if at all possible. Unfortunately, a number of less security-conscious MTAs
15003 implement it unconditionally. If you are running Exim on a gateway host, and
15004 routing mail through to internal MTAs without processing the local parts, it is
15005 a good idea to reject recipient addresses with percent characters in their
15006 local parts. Exim's default configuration does this.
15007
15008
15009 .option perl_at_start main boolean false
15010 This option is available only when Exim is built with an embedded Perl
15011 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15012
15013
15014 .option perl_startup main string unset
15015 This option is available only when Exim is built with an embedded Perl
15016 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15017
15018
15019 .option pgsql_servers main "string list" unset
15020 .cindex "PostgreSQL lookup type" "server list"
15021 This option provides a list of PostgreSQL servers and associated connection
15022 data, to be used in conjunction with &(pgsql)& lookups (see section
15023 &<<SECID72>>&). The option is available only if Exim has been built with
15024 PostgreSQL support.
15025
15026
15027 .option pid_file_path main string&!! "set at compile time"
15028 .cindex "daemon" "pid file path"
15029 .cindex "pid file, path for"
15030 This option sets the name of the file to which the Exim daemon writes its
15031 process id. The string is expanded, so it can contain, for example, references
15032 to the host name:
15033 .code
15034 pid_file_path = /var/log/$primary_hostname/exim.pid
15035 .endd
15036 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15037 spool directory.
15038 The value set by the option can be overridden by the &%-oP%& command line
15039 option. A pid file is not written if a &"non-standard"& daemon is run by means
15040 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15041
15042
15043 .option pipelining_advertise_hosts main "host list&!!" *
15044 .cindex "PIPELINING" "suppressing advertising"
15045 This option can be used to suppress the advertisement of the SMTP
15046 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15047 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15048 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15049 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15050 that clients will use it; &"out of order"& commands that are &"expected"& do
15051 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15052
15053
15054 .option preserve_message_logs main boolean false
15055 .cindex "message logs" "preserving"
15056 If this option is set, message log files are not deleted when messages are
15057 completed. Instead, they are moved to a sub-directory of the spool directory
15058 called &_msglog.OLD_&, where they remain available for statistical or debugging
15059 purposes. This is a dangerous option to set on systems with any appreciable
15060 volume of mail. Use with care!
15061
15062
15063 .option primary_hostname main string "see below"
15064 .cindex "name" "of local host"
15065 .cindex "host" "name of local"
15066 .cindex "local host" "name of"
15067 .vindex "&$primary_hostname$&"
15068 This specifies the name of the current host. It is used in the default EHLO or
15069 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15070 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15071 The value is also used by default in some SMTP response messages from an Exim
15072 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15073
15074 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15075 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15076 contains only one component, Exim passes it to &[gethostbyname()]& (or
15077 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15078 version. The variable &$primary_hostname$& contains the host name, whether set
15079 explicitly by this option, or defaulted.
15080
15081
15082 .option print_topbitchars main boolean false
15083 .cindex "printing characters"
15084 .cindex "8-bit characters"
15085 By default, Exim considers only those characters whose codes lie in the range
15086 32&--126 to be printing characters. In a number of circumstances (for example,
15087 when writing log entries) non-printing characters are converted into escape
15088 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15089 is set, code values of 128 and above are also considered to be printing
15090 characters.
15091
15092 This option also affects the header syntax checks performed by the
15093 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15094 the user's full name when constructing From: and Sender: addresses (as
15095 described in section &<<SECTconstr>>&). Setting this option can cause
15096 Exim to generate eight bit message headers that do not conform to the
15097 standards.
15098
15099
15100 .option process_log_path main string unset
15101 .cindex "process log path"
15102 .cindex "log" "process log"
15103 .cindex "&'exiwhat'&"
15104 This option sets the name of the file to which an Exim process writes its
15105 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15106 utility script. If this option is unset, the file called &_exim-process.info_&
15107 in Exim's spool directory is used. The ability to specify the name explicitly
15108 can be useful in environments where two different Exims are running, using
15109 different spool directories.
15110
15111
15112 .option prod_requires_admin main boolean true
15113 .oindex "&%-M%&"
15114 .oindex "&%-R%&"
15115 .oindex "&%-q%&"
15116 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15117 admin user unless &%prod_requires_admin%& is set false. See also
15118 &%queue_list_requires_admin%&.
15119
15120
15121 .option qualify_domain main string "see below"
15122 .cindex "domain" "for qualifying addresses"
15123 .cindex "address" "qualification"
15124 This option specifies the domain name that is added to any envelope sender
15125 addresses that do not have a domain qualification. It also applies to
15126 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15127 are accepted by default only for locally-generated messages. Qualification is
15128 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15129 locally-generated messages, unless the &%-bnq%& command line option is used.
15130
15131 Messages from external sources must always contain fully qualified addresses,
15132 unless the sending host matches &%sender_unqualified_hosts%& or
15133 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15134 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15135 necessary. Internally, Exim always works with fully qualified envelope
15136 addresses. If &%qualify_domain%& is not set, it defaults to the
15137 &%primary_hostname%& value.
15138
15139
15140 .option qualify_recipient main string "see below"
15141 This option allows you to specify a different domain for qualifying recipient
15142 addresses to the one that is used for senders. See &%qualify_domain%& above.
15143
15144
15145
15146 .option queue_domains main "domain list&!!" unset
15147 .cindex "domain" "specifying non-immediate delivery"
15148 .cindex "queueing incoming messages"
15149 .cindex "message" "queueing certain domains"
15150 This option lists domains for which immediate delivery is not required.
15151 A delivery process is started whenever a message is received, but only those
15152 domains that do not match are processed. All other deliveries wait until the
15153 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15154
15155
15156 .option queue_list_requires_admin main boolean true
15157 .oindex "&%-bp%&"
15158 The &%-bp%& command-line option, which lists the messages that are on the
15159 queue, requires the caller to be an admin user unless
15160 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15161
15162
15163 .option queue_only main boolean false
15164 .cindex "queueing incoming messages"
15165 .cindex "message" "queueing unconditionally"
15166 If &%queue_only%& is set, a delivery process is not automatically started
15167 whenever a message is received. Instead, the message waits on the queue for the
15168 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15169 delivered immediately when certain conditions (such as heavy load) occur.
15170
15171 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15172 and &%-odi%& command line options override &%queue_only%& unless
15173 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15174 &%queue_only_load%&, and &%smtp_accept_queue%&.
15175
15176
15177 .option queue_only_file main string unset
15178 .cindex "queueing incoming messages"
15179 .cindex "message" "queueing by file existence"
15180 This option can be set to a colon-separated list of absolute path names, each
15181 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15182 it tests for the existence of each listed path using a call to &[stat()]&. For
15183 each path that exists, the corresponding queueing option is set.
15184 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15185 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15186 .code
15187 queue_only_file = smtp/some/file
15188 .endd
15189 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15190 &_/some/file_& exists.
15191
15192
15193 .option queue_only_load main fixed-point unset
15194 .cindex "load average"
15195 .cindex "queueing incoming messages"
15196 .cindex "message" "queueing by load"
15197 If the system load average is higher than this value, incoming messages from
15198 all sources are queued, and no automatic deliveries are started. If this
15199 happens during local or remote SMTP input, all subsequent messages received on
15200 the same SMTP connection are queued by default, whatever happens to the load in
15201 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15202 false.
15203
15204 Deliveries will subsequently be performed by queue runner processes. This
15205 option has no effect on ancient operating systems on which Exim cannot
15206 determine the load average. See also &%deliver_queue_load_max%& and
15207 &%smtp_load_reserve%&.
15208
15209
15210 .option queue_only_load_latch main boolean true
15211 .cindex "load average" "re-evaluating per message"
15212 When this option is true (the default), once one message has been queued
15213 because the load average is higher than the value set by &%queue_only_load%&,
15214 all subsequent messages received on the same SMTP connection are also queued.
15215 This is a deliberate choice; even though the load average may fall below the
15216 threshold, it doesn't seem right to deliver later messages on the same
15217 connection when not delivering earlier ones. However, there are special
15218 circumstances such as very long-lived connections from scanning appliances
15219 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15220 should be set false. This causes the value of the load average to be
15221 re-evaluated for each message.
15222
15223
15224 .option queue_only_override main boolean true
15225 .cindex "queueing incoming messages"
15226 When this option is true, the &%-od%&&'x'& command line options override the
15227 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15228 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15229 to override; they are accepted, but ignored.
15230
15231
15232 .option queue_run_in_order main boolean false
15233 .cindex "queue runner" "processing messages in order"
15234 If this option is set, queue runs happen in order of message arrival instead of
15235 in an arbitrary order. For this to happen, a complete list of the entire queue
15236 must be set up before the deliveries start. When the queue is all held in a
15237 single directory (the default), a single list is created for both the ordered
15238 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15239 single list is not created when &%queue_run_in_order%& is false. In this case,
15240 the sub-directories are processed one at a time (in a random order), and this
15241 avoids setting up one huge list for the whole queue. Thus, setting
15242 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15243 when the queue is large, because of the extra work in setting up the single,
15244 large list. In most situations, &%queue_run_in_order%& should not be set.
15245
15246
15247
15248 .option queue_run_max main integer 5
15249 .cindex "queue runner" "maximum number of"
15250 This controls the maximum number of queue runner processes that an Exim daemon
15251 can run simultaneously. This does not mean that it starts them all at once,
15252 but rather that if the maximum number are still running when the time comes to
15253 start another one, it refrains from starting another one. This can happen with
15254 very large queues and/or very sluggish deliveries. This option does not,
15255 however, interlock with other processes, so additional queue runners can be
15256 started by other means, or by killing and restarting the daemon.
15257
15258 Setting this option to zero does not suppress queue runs; rather, it disables
15259 the limit, allowing any number of simultaneous queue runner processes to be
15260 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15261 the daemon's command line.
15262
15263 .option queue_smtp_domains main "domain list&!!" unset
15264 .cindex "queueing incoming messages"
15265 .cindex "message" "queueing remote deliveries"
15266 When this option is set, a delivery process is started whenever a message is
15267 received, routing is performed, and local deliveries take place.
15268 However, if any SMTP deliveries are required for domains that match
15269 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15270 message waits on the queue for the next queue run. Since routing of the message
15271 has taken place, Exim knows to which remote hosts it must be delivered, and so
15272 when the queue run happens, multiple messages for the same host are delivered
15273 over a single SMTP connection. The &%-odqs%& command line option causes all
15274 SMTP deliveries to be queued in this way, and is equivalent to setting
15275 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15276 &%queue_domains%&.
15277
15278
15279 .option receive_timeout main time 0s
15280 .cindex "timeout" "for non-SMTP input"
15281 This option sets the timeout for accepting a non-SMTP message, that is, the
15282 maximum time that Exim waits when reading a message on the standard input. If
15283 the value is zero, it will wait for ever. This setting is overridden by the
15284 &%-or%& command line option. The timeout for incoming SMTP messages is
15285 controlled by &%smtp_receive_timeout%&.
15286
15287 .option received_header_text main string&!! "see below"
15288 .cindex "customizing" "&'Received:'& header"
15289 .cindex "&'Received:'& header line" "customizing"
15290 This string defines the contents of the &'Received:'& message header that is
15291 added to each message, except for the timestamp, which is automatically added
15292 on at the end (preceded by a semicolon). The string is expanded each time it is
15293 used. If the expansion yields an empty string, no &'Received:'& header line is
15294 added to the message. Otherwise, the string should start with the text
15295 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15296 header lines. The default setting is:
15297
15298 .code
15299 received_header_text = Received: \
15300   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15301   {${if def:sender_ident \
15302   {from ${quote_local_part:$sender_ident} }}\
15303   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15304   by $primary_hostname \
15305   ${if def:received_protocol {with $received_protocol}} \
15306   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15307   (Exim $version_number)\n\t\
15308   ${if def:sender_address \
15309   {(envelope-from <$sender_address>)\n\t}}\
15310   id $message_exim_id\
15311   ${if def:received_for {\n\tfor $received_for}}
15312 .endd
15313
15314 The reference to the TLS cipher is omitted when Exim is built without TLS
15315 support. The use of conditional expansions ensures that this works for both
15316 locally generated messages and messages received from remote hosts, giving
15317 header lines such as the following:
15318 .code
15319 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15320 by marley.carol.example with esmtp (Exim 4.00)
15321 (envelope-from <bob@carol.example>)
15322 id 16IOWa-00019l-00
15323 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15324 Received: by scrooge.carol.example with local (Exim 4.00)
15325 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15326 .endd
15327 Until the body of the message has been received, the timestamp is the time when
15328 the message started to be received. Once the body has arrived, and all policy
15329 checks have taken place, the timestamp is updated to the time at which the
15330 message was accepted.
15331
15332
15333 .option received_headers_max main integer 30
15334 .cindex "loop" "prevention"
15335 .cindex "mail loop prevention"
15336 .cindex "&'Received:'& header line" "counting"
15337 When a message is to be delivered, the number of &'Received:'& headers is
15338 counted, and if it is greater than this parameter, a mail loop is assumed to
15339 have occurred, the delivery is abandoned, and an error message is generated.
15340 This applies to both local and remote deliveries.
15341
15342
15343 .option recipient_unqualified_hosts main "host list&!!" unset
15344 .cindex "unqualified addresses"
15345 .cindex "host" "unqualified addresses from"
15346 This option lists those hosts from which Exim is prepared to accept unqualified
15347 recipient addresses in message envelopes. The addresses are made fully
15348 qualified by the addition of the &%qualify_recipient%& value. This option also
15349 affects message header lines. Exim does not reject unqualified recipient
15350 addresses in headers, but it qualifies them only if the message came from a
15351 host that matches &%recipient_unqualified_hosts%&,
15352 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15353 option was not set.
15354
15355
15356 .option recipients_max main integer 0
15357 .cindex "limit" "number of recipients"
15358 .cindex "recipient" "maximum number"
15359 If this option is set greater than zero, it specifies the maximum number of
15360 original recipients for any message. Additional recipients that are generated
15361 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15362 all recipients over the limit; earlier recipients are delivered as normal.
15363 Non-SMTP messages with too many recipients are failed, and no deliveries are
15364 done.
15365
15366 .cindex "RCPT" "maximum number of incoming"
15367 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15368 RCPT commands in a single message.
15369
15370
15371 .option recipients_max_reject main boolean false
15372 If this option is set true, Exim rejects SMTP messages containing too many
15373 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15374 error to the eventual DATA command. Otherwise (the default) it gives a 452
15375 error to the surplus RCPT commands and accepts the message on behalf of the
15376 initial set of recipients. The remote server should then re-send the message
15377 for the remaining recipients at a later time.
15378
15379
15380 .option remote_max_parallel main integer 2
15381 .cindex "delivery" "parallelism for remote"
15382 This option controls parallel delivery of one message to a number of remote
15383 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15384 does all the remote deliveries for a message one by one. Otherwise, if a single
15385 message has to be delivered to more than one remote host, or if several copies
15386 have to be sent to the same remote host, up to &%remote_max_parallel%&
15387 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15388 deliveries are required, the maximum number of processes are started, and as
15389 each one finishes, another is begun. The order of starting processes is the
15390 same as if sequential delivery were being done, and can be controlled by the
15391 &%remote_sort_domains%& option. If parallel delivery takes place while running
15392 with debugging turned on, the debugging output from each delivery process is
15393 tagged with its process id.
15394
15395 This option controls only the maximum number of parallel deliveries for one
15396 message in one Exim delivery process. Because Exim has no central queue
15397 manager, there is no way of controlling the total number of simultaneous
15398 deliveries if the configuration allows a delivery attempt as soon as a message
15399 is received.
15400
15401 .cindex "number of deliveries"
15402 .cindex "delivery" "maximum number of"
15403 If you want to control the total number of deliveries on the system, you
15404 need to set the &%queue_only%& option. This ensures that all incoming messages
15405 are added to the queue without starting a delivery process. Then set up an Exim
15406 daemon to start queue runner processes at appropriate intervals (probably
15407 fairly often, for example, every minute), and limit the total number of queue
15408 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15409 delivers only one message at a time, the maximum number of deliveries that can
15410 then take place at once is &%queue_run_max%& multiplied by
15411 &%remote_max_parallel%&.
15412
15413 If it is purely remote deliveries you want to control, use
15414 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15415 doing the SMTP routing before queueing, so that several messages for the same
15416 host will eventually get delivered down the same connection.
15417
15418
15419 .option remote_sort_domains main "domain list&!!" unset
15420 .cindex "sorting remote deliveries"
15421 .cindex "delivery" "sorting remote"
15422 When there are a number of remote deliveries for a message, they are sorted by
15423 domain into the order given by this list. For example,
15424 .code
15425 remote_sort_domains = *.cam.ac.uk:*.uk
15426 .endd
15427 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15428 then to those in the &%uk%& domain, then to any others.
15429
15430
15431 .option retry_data_expire main time 7d
15432 .cindex "hints database" "data expiry"
15433 This option sets a &"use before"& time on retry information in Exim's hints
15434 database. Any older retry data is ignored. This means that, for example, once a
15435 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15436 past failures.
15437
15438
15439 .option retry_interval_max main time 24h
15440 .cindex "retry" "limit on interval"
15441 .cindex "limit" "on retry interval"
15442 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15443 intervals between delivery attempts for messages that cannot be delivered
15444 straight away. This option sets an overall limit to the length of time between
15445 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15446 the default value.
15447
15448
15449 .option return_path_remove main boolean true
15450 .cindex "&'Return-path:'& header line" "removing"
15451 RFC 2821, section 4.4, states that an SMTP server must insert a
15452 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15453 The &'Return-path:'& header preserves the sender address as received in the
15454 MAIL command. This description implies that this header should not be present
15455 in an incoming message. If &%return_path_remove%& is true, any existing
15456 &'Return-path:'& headers are removed from messages at the time they are
15457 received. Exim's transports have options for adding &'Return-path:'& headers at
15458 the time of delivery. They are normally used only for final local deliveries.
15459
15460
15461 .option return_size_limit main integer 100K
15462 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15463
15464
15465 .option rfc1413_hosts main "host list&!!" *
15466 .cindex "RFC 1413"
15467 .cindex "host" "for RFC 1413 calls"
15468 RFC 1413 identification calls are made to any client host which matches an item
15469 in the list.
15470
15471 .option rfc1413_query_timeout main time 5s
15472 .cindex "RFC 1413" "query timeout"
15473 .cindex "timeout" "for RFC 1413 call"
15474 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15475 no RFC 1413 calls are ever made.
15476
15477
15478 .option sender_unqualified_hosts main "host list&!!" unset
15479 .cindex "unqualified addresses"
15480 .cindex "host" "unqualified addresses from"
15481 This option lists those hosts from which Exim is prepared to accept unqualified
15482 sender addresses. The addresses are made fully qualified by the addition of
15483 &%qualify_domain%&. This option also affects message header lines. Exim does
15484 not reject unqualified addresses in headers that contain sender addresses, but
15485 it qualifies them only if the message came from a host that matches
15486 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15487 using TCP/IP), and the &%-bnq%& option was not set.
15488
15489
15490 .option smtp_accept_keepalive main boolean true
15491 .cindex "keepalive" "on incoming connection"
15492 This option controls the setting of the SO_KEEPALIVE option on incoming
15493 TCP/IP socket connections. When set, it causes the kernel to probe idle
15494 connections periodically, by sending packets with &"old"& sequence numbers. The
15495 other end of the connection should send an acknowledgment if the connection is
15496 still okay or a reset if the connection has been aborted. The reason for doing
15497 this is that it has the beneficial effect of freeing up certain types of
15498 connection that can get stuck when the remote host is disconnected without
15499 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15500 hours to detect unreachable hosts.
15501
15502
15503
15504 .option smtp_accept_max main integer 20
15505 .cindex "limit" "incoming SMTP connections"
15506 .cindex "SMTP" "incoming connection count"
15507 .cindex "inetd"
15508 This option specifies the maximum number of simultaneous incoming SMTP calls
15509 that Exim will accept. It applies only to the listening daemon; there is no
15510 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15511 value is set to zero, no limit is applied. However, it is required to be
15512 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15513 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15514
15515 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15516 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15517 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15518 and &%smtp_load_reserve%& are then checked before accepting the connection.
15519
15520
15521 .option smtp_accept_max_nonmail main integer 10
15522 .cindex "limit" "non-mail SMTP commands"
15523 .cindex "SMTP" "limiting non-mail commands"
15524 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15525 the connection if there are too many. This option defines &"too many"&. The
15526 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15527 client looping sending EHLO, for example. The check is applied only if the
15528 client host matches &%smtp_accept_max_nonmail_hosts%&.
15529
15530 When a new message is expected, one occurrence of RSET is not counted. This
15531 allows a client to send one RSET between messages (this is not necessary,
15532 but some clients do it). Exim also allows one uncounted occurrence of HELO
15533 or EHLO, and one occurrence of STARTTLS between messages. After
15534 starting up a TLS session, another EHLO is expected, and so it too is not
15535 counted. The first occurrence of AUTH in a connection, or immediately
15536 following STARTTLS is not counted. Otherwise, all commands other than
15537 MAIL, RCPT, DATA, and QUIT are counted.
15538
15539
15540 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15541 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15542 check by setting this option. The default value makes it apply to all hosts. By
15543 changing the value, you can exclude any badly-behaved hosts that you have to
15544 live with.
15545
15546
15547 . Allow this long option name to split; give it unsplit as a fifth argument
15548 . for the automatic .oindex that is generated by .option.
15549 . We insert " &~&~" which is both pretty nasty visually and results in
15550 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15551 . zero-width-space, which would be nicer visually and results in (at least)
15552 . html that Firefox will split on when it's forced to reflow (rather than
15553 . inserting a horizontal scrollbar).  However, the text is still not
15554 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15555 . the option name to split.
15556
15557 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15558          smtp_accept_max_per_connection
15559 .cindex "SMTP" "limiting incoming message count"
15560 .cindex "limit" "messages per SMTP connection"
15561 The value of this option limits the number of MAIL commands that Exim is
15562 prepared to accept over a single SMTP connection, whether or not each command
15563 results in the transfer of a message. After the limit is reached, a 421
15564 response is given to subsequent MAIL commands. This limit is a safety
15565 precaution against a client that goes mad (incidents of this type have been
15566 seen).
15567
15568
15569 .option smtp_accept_max_per_host main string&!! unset
15570 .cindex "limit" "SMTP connections from one host"
15571 .cindex "host" "limiting SMTP connections from"
15572 This option restricts the number of simultaneous IP connections from a single
15573 host (strictly, from a single IP address) to the Exim daemon. The option is
15574 expanded, to enable different limits to be applied to different hosts by
15575 reference to &$sender_host_address$&. Once the limit is reached, additional
15576 connection attempts from the same host are rejected with error code 421. This
15577 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15578 of zero imposes no limit. If this option is set greater than zero, it is
15579 required that &%smtp_accept_max%& be non-zero.
15580
15581 &*Warning*&: When setting this option you should not use any expansion
15582 constructions that take an appreciable amount of time. The expansion and test
15583 happen in the main daemon loop, in order to reject additional connections
15584 without forking additional processes (otherwise a denial-of-service attack
15585 could cause a vast number or processes to be created). While the daemon is
15586 doing this processing, it cannot accept any other incoming connections.
15587
15588
15589
15590 .option smtp_accept_queue main integer 0
15591 .cindex "SMTP" "incoming connection count"
15592 .cindex "queueing incoming messages"
15593 .cindex "message" "queueing by SMTP connection count"
15594 If the number of simultaneous incoming SMTP connections being handled via the
15595 listening daemon exceeds this value, messages received by SMTP are just placed
15596 on the queue; no delivery processes are started automatically. The count is
15597 fixed at the start of an SMTP connection. It cannot be updated in the
15598 subprocess that receives messages, and so the queueing or not queueing applies
15599 to all messages received in the same connection.
15600
15601 A value of zero implies no limit, and clearly any non-zero value is useful only
15602 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15603 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15604 various &%-od%&&'x'& command line options.
15605
15606
15607 . See the comment on smtp_accept_max_per_connection
15608
15609 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15610          smtp_accept_queue_per_connection
15611 .cindex "queueing incoming messages"
15612 .cindex "message" "queueing by message count"
15613 This option limits the number of delivery processes that Exim starts
15614 automatically when receiving messages via SMTP, whether via the daemon or by
15615 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15616 and the number of messages received in a single SMTP session exceeds this
15617 number, subsequent messages are placed on the queue, but no delivery processes
15618 are started. This helps to limit the number of Exim processes when a server
15619 restarts after downtime and there is a lot of mail waiting for it on other
15620 systems. On large systems, the default should probably be increased, and on
15621 dial-in client systems it should probably be set to zero (that is, disabled).
15622
15623
15624 .option smtp_accept_reserve main integer 0
15625 .cindex "SMTP" "incoming call count"
15626 .cindex "host" "reserved"
15627 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15628 number of SMTP connections that are reserved for connections from the hosts
15629 that are specified in &%smtp_reserve_hosts%&. The value set in
15630 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15631 restricted to this number of connections; the option specifies a minimum number
15632 of connection slots for them, not a maximum. It is a guarantee that this group
15633 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15634 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15635 individual host.
15636
15637 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15638 set to 5, once there are 45 active connections (from any hosts), new
15639 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15640 provided the other criteria for acceptance are met.
15641
15642
15643 .option smtp_active_hostname main string&!! unset
15644 .cindex "host" "name in SMTP responses"
15645 .cindex "SMTP" "host name in responses"
15646 .vindex "&$primary_hostname$&"
15647 This option is provided for multi-homed servers that want to masquerade as
15648 several different hosts. At the start of an incoming SMTP connection, its value
15649 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15650 responses. For example, it is used as domain name in the response to an
15651 incoming HELO or EHLO command.
15652
15653 .vindex "&$smtp_active_hostname$&"
15654 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15655 is saved with any messages that are received. It is therefore available for use
15656 in routers and transports when the message is later delivered.
15657
15658 If this option is unset, or if its expansion is forced to fail, or if the
15659 expansion results in an empty string, the value of &$primary_hostname$& is
15660 used. Other expansion failures cause a message to be written to the main and
15661 panic logs, and the SMTP command receives a temporary error. Typically, the
15662 value of &%smtp_active_hostname%& depends on the incoming interface address.
15663 For example:
15664 .code
15665 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15666   {cox.mydomain}{box.mydomain}}
15667 .endd
15668
15669 Although &$smtp_active_hostname$& is primarily concerned with incoming
15670 messages, it is also used as the default for HELO commands in callout
15671 verification if there is no remote transport from which to obtain a
15672 &%helo_data%& value.
15673
15674 .option smtp_banner main string&!! "see below"
15675 .cindex "SMTP" "welcome banner"
15676 .cindex "banner for SMTP"
15677 .cindex "welcome banner for SMTP"
15678 .cindex "customizing" "SMTP banner"
15679 This string, which is expanded every time it is used, is output as the initial
15680 positive response to an SMTP connection. The default setting is:
15681 .code
15682 smtp_banner = $smtp_active_hostname ESMTP Exim \
15683   $version_number $tod_full
15684 .endd
15685 Failure to expand the string causes a panic error. If you want to create a
15686 multiline response to the initial SMTP connection, use &"\n"& in the string at
15687 appropriate points, but not at the end. Note that the 220 code is not included
15688 in this string. Exim adds it automatically (several times in the case of a
15689 multiline response).
15690
15691
15692 .option smtp_check_spool_space main boolean true
15693 .cindex "checking disk space"
15694 .cindex "disk space, checking"
15695 .cindex "spool directory" "checking space"
15696 When this option is set, if an incoming SMTP session encounters the SIZE
15697 option on a MAIL command, it checks that there is enough space in the
15698 spool directory's partition to accept a message of that size, while still
15699 leaving free the amount specified by &%check_spool_space%& (even if that value
15700 is zero). If there isn't enough space, a temporary error code is returned.
15701
15702
15703 .option smtp_connect_backlog main integer 20
15704 .cindex "connection backlog"
15705 .cindex "SMTP" "connection backlog"
15706 .cindex "backlog of connections"
15707 This option specifies a maximum number of waiting SMTP connections. Exim passes
15708 this value to the TCP/IP system when it sets up its listener. Once this number
15709 of connections are waiting for the daemon's attention, subsequent connection
15710 attempts are refused at the TCP/IP level. At least, that is what the manuals
15711 say; in some circumstances such connection attempts have been observed to time
15712 out instead. For large systems it is probably a good idea to increase the
15713 value (to 50, say). It also gives some protection against denial-of-service
15714 attacks by SYN flooding.
15715
15716
15717 .option smtp_enforce_sync main boolean true
15718 .cindex "SMTP" "synchronization checking"
15719 .cindex "synchronization checking in SMTP"
15720 The SMTP protocol specification requires the client to wait for a response from
15721 the server at certain points in the dialogue. Without PIPELINING these
15722 synchronization points are after every command; with PIPELINING they are
15723 fewer, but they still exist.
15724
15725 Some spamming sites send out a complete set of SMTP commands without waiting
15726 for any response. Exim protects against this by rejecting a message if the
15727 client has sent further input when it should not have. The error response &"554
15728 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15729 for this error cannot be perfect because of transmission delays (unexpected
15730 input may be on its way but not yet received when Exim checks). However, it
15731 does detect many instances.
15732
15733 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15734 If you want to disable the check selectively (for example, only for certain
15735 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15736 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15737
15738
15739
15740 .option smtp_etrn_command main string&!! unset
15741 .cindex "ETRN" "command to be run"
15742 .vindex "&$domain$&"
15743 If this option is set, the given command is run whenever an SMTP ETRN
15744 command is received from a host that is permitted to issue such commands (see
15745 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15746 are independently expanded. The expansion variable &$domain$& is set to the
15747 argument of the ETRN command, and no syntax checking is done on it. For
15748 example:
15749 .code
15750 smtp_etrn_command = /etc/etrn_command $domain \
15751                     $sender_host_address
15752 .endd
15753 A new process is created to run the command, but Exim does not wait for it to
15754 complete. Consequently, its status cannot be checked. If the command cannot be
15755 run, a line is written to the panic log, but the ETRN caller still receives
15756 a 250 success response. Exim is normally running under its own uid when
15757 receiving SMTP, so it is not possible for it to change the uid before running
15758 the command.
15759
15760
15761 .option smtp_etrn_serialize main boolean true
15762 .cindex "ETRN" "serializing"
15763 When this option is set, it prevents the simultaneous execution of more than
15764 one identical command as a result of ETRN in an SMTP connection. See
15765 section &<<SECTETRN>>& for details.
15766
15767
15768 .option smtp_load_reserve main fixed-point unset
15769 .cindex "load average"
15770 If the system load average ever gets higher than this, incoming SMTP calls are
15771 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15772 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15773 the load is over the limit. The option has no effect on ancient operating
15774 systems on which Exim cannot determine the load average. See also
15775 &%deliver_queue_load_max%& and &%queue_only_load%&.
15776
15777
15778
15779 .option smtp_max_synprot_errors main integer 3
15780 .cindex "SMTP" "limiting syntax and protocol errors"
15781 .cindex "limit" "SMTP syntax and protocol errors"
15782 Exim rejects SMTP commands that contain syntax or protocol errors. In
15783 particular, a syntactically invalid email address, as in this command:
15784 .code
15785 RCPT TO:<abc xyz@a.b.c>
15786 .endd
15787 causes immediate rejection of the command, before any other tests are done.
15788 (The ACL cannot be run if there is no valid address to set up for it.) An
15789 example of a protocol error is receiving RCPT before MAIL. If there are
15790 too many syntax or protocol errors in one SMTP session, the connection is
15791 dropped. The limit is set by this option.
15792
15793 .cindex "PIPELINING" "expected errors"
15794 When the PIPELINING extension to SMTP is in use, some protocol errors are
15795 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15796 Exim assumes that PIPELINING will be used if it advertises it (see
15797 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15798 not count towards the limit.
15799
15800
15801
15802 .option smtp_max_unknown_commands main integer 3
15803 .cindex "SMTP" "limiting unknown commands"
15804 .cindex "limit" "unknown SMTP commands"
15805 If there are too many unrecognized commands in an incoming SMTP session, an
15806 Exim server drops the connection. This is a defence against some kinds of abuse
15807 that subvert web
15808 clients
15809 into making connections to SMTP ports; in these circumstances, a number of
15810 non-SMTP command lines are sent first.
15811
15812
15813
15814 .option smtp_ratelimit_hosts main "host list&!!" unset
15815 .cindex "SMTP" "rate limiting"
15816 .cindex "limit" "rate of message arrival"
15817 .cindex "RCPT" "rate limiting"
15818 Some sites find it helpful to be able to limit the rate at which certain hosts
15819 can send them messages, and the rate at which an individual message can specify
15820 recipients.
15821
15822 Exim has two rate-limiting facilities. This section describes the older
15823 facility, which can limit rates within a single connection. The newer
15824 &%ratelimit%& ACL condition can limit rates across all connections. See section
15825 &<<SECTratelimiting>>& for details of the newer facility.
15826
15827 When a host matches &%smtp_ratelimit_hosts%&, the values of
15828 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15829 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15830 respectively. Each option, if set, must contain a set of four comma-separated
15831 values:
15832
15833 .ilist
15834 A threshold, before which there is no rate limiting.
15835 .next
15836 An initial time delay. Unlike other times in Exim, numbers with decimal
15837 fractional parts are allowed here.
15838 .next
15839 A factor by which to increase the delay each time.
15840 .next
15841 A maximum value for the delay. This should normally be less than 5 minutes,
15842 because after that time, the client is liable to timeout the SMTP command.
15843 .endlist
15844
15845 For example, these settings have been used successfully at the site which
15846 first suggested this feature, for controlling mail from their customers:
15847 .code
15848 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15849 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15850 .endd
15851 The first setting specifies delays that are applied to MAIL commands after
15852 two have been received over a single connection. The initial delay is 0.5
15853 seconds, increasing by a factor of 1.05 each time. The second setting applies
15854 delays to RCPT commands when more than four occur in a single message.
15855
15856
15857 .option smtp_ratelimit_mail main string unset
15858 See &%smtp_ratelimit_hosts%& above.
15859
15860
15861 .option smtp_ratelimit_rcpt main string unset
15862 See &%smtp_ratelimit_hosts%& above.
15863
15864
15865 .option smtp_receive_timeout main time 5m
15866 .cindex "timeout" "for SMTP input"
15867 .cindex "SMTP" "input timeout"
15868 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15869 input, including batch SMTP. If a line of input (either an SMTP command or a
15870 data line) is not received within this time, the SMTP connection is dropped and
15871 the message is abandoned.
15872 A line is written to the log containing one of the following messages:
15873 .code
15874 SMTP command timeout on connection from...
15875 SMTP data timeout on connection from...
15876 .endd
15877 The former means that Exim was expecting to read an SMTP command; the latter
15878 means that it was in the DATA phase, reading the contents of a message.
15879
15880
15881 .oindex "&%-os%&"
15882 The value set by this option can be overridden by the
15883 &%-os%& command-line option. A setting of zero time disables the timeout, but
15884 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15885 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15886 timeout is controlled by &%receive_timeout%& and &%-or%&.
15887
15888
15889 .option smtp_reserve_hosts main "host list&!!" unset
15890 This option defines hosts for which SMTP connections are reserved; see
15891 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15892
15893
15894 .option smtp_return_error_details main boolean false
15895 .cindex "SMTP" "details policy failures"
15896 .cindex "policy control" "rejection, returning details"
15897 In the default state, Exim uses bland messages such as
15898 &"Administrative prohibition"& when it rejects SMTP commands for policy
15899 reasons. Many sysadmins like this because it gives away little information
15900 to spammers. However, some other sysadmins who are applying strict checking
15901 policies want to give out much fuller information about failures. Setting
15902 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15903 example, instead of &"Administrative prohibition"&, it might give:
15904 .code
15905 550-Rejected after DATA: '>' missing at end of address:
15906 550 failing address in "From" header is: <user@dom.ain
15907 .endd
15908
15909 .option spamd_address main string "see below"
15910 This option is available when Exim is compiled with the content-scanning
15911 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15912 The default value is
15913 .code
15914 127.0.0.1 783
15915 .endd
15916 See section &<<SECTscanspamass>>& for more details.
15917
15918
15919
15920 .option split_spool_directory main boolean false
15921 .cindex "multiple spool directories"
15922 .cindex "spool directory" "split"
15923 .cindex "directories, multiple"
15924 If this option is set, it causes Exim to split its input directory into 62
15925 subdirectories, each with a single alphanumeric character as its name. The
15926 sixth character of the message id is used to allocate messages to
15927 subdirectories; this is the least significant base-62 digit of the time of
15928 arrival of the message.
15929
15930 Splitting up the spool in this way may provide better performance on systems
15931 where there are long mail queues, by reducing the number of files in any one
15932 directory. The msglog directory is also split up in a similar way to the input
15933 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15934 are still placed in the single directory &_msglog.OLD_&.
15935
15936 It is not necessary to take any special action for existing messages when
15937 changing &%split_spool_directory%&. Exim notices messages that are in the
15938 &"wrong"& place, and continues to process them. If the option is turned off
15939 after a period of being on, the subdirectories will eventually empty and be
15940 automatically deleted.
15941
15942 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15943 changes. Instead of creating a list of all messages in the queue, and then
15944 trying to deliver each one in turn, it constructs a list of those in one
15945 sub-directory and tries to deliver them, before moving on to the next
15946 sub-directory. The sub-directories are processed in a random order. This
15947 spreads out the scanning of the input directories, and uses less memory. It is
15948 particularly beneficial when there are lots of messages on the queue. However,
15949 if &%queue_run_in_order%& is set, none of this new processing happens. The
15950 entire queue has to be scanned and sorted before any deliveries can start.
15951
15952
15953 .option spool_directory main string&!! "set at compile time"
15954 .cindex "spool directory" "path to"
15955 This defines the directory in which Exim keeps its spool, that is, the messages
15956 it is waiting to deliver. The default value is taken from the compile-time
15957 configuration setting, if there is one. If not, this option must be set. The
15958 string is expanded, so it can contain, for example, a reference to
15959 &$primary_hostname$&.
15960
15961 If the spool directory name is fixed on your installation, it is recommended
15962 that you set it at build time rather than from this option, particularly if the
15963 log files are being written to the spool directory (see &%log_file_path%&).
15964 Otherwise log files cannot be used for errors that are detected early on, such
15965 as failures in the configuration file.
15966
15967 By using this option to override the compiled-in path, it is possible to run
15968 tests of Exim without using the standard spool.
15969
15970 .option sqlite_lock_timeout main time 5s
15971 .cindex "sqlite lookup type" "lock timeout"
15972 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15973 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15974
15975 .option strict_acl_vars main boolean false
15976 .cindex "&ACL;" "variables, handling unset"
15977 This option controls what happens if a syntactically valid but undefined ACL
15978 variable is referenced. If it is false (the default), an empty string
15979 is substituted; if it is true, an error is generated. See section
15980 &<<SECTaclvariables>>& for details of ACL variables.
15981
15982 .option strip_excess_angle_brackets main boolean false
15983 .cindex "angle brackets, excess"
15984 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15985 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15986 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15987 passed on to another MTA, the excess angle brackets are not passed on. If this
15988 option is not set, multiple pairs of angle brackets cause a syntax error.
15989
15990
15991 .option strip_trailing_dot main boolean false
15992 .cindex "trailing dot on domain"
15993 .cindex "dot" "trailing on domain"
15994 If this option is set, a trailing dot at the end of a domain in an address is
15995 ignored. If this is in the envelope and the message is passed on to another
15996 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15997 domain causes a syntax error.
15998 However, addresses in header lines are checked only when an ACL requests header
15999 syntax checking.
16000
16001
16002 .option syslog_duplication main boolean true
16003 .cindex "syslog" "duplicate log lines; suppressing"
16004 When Exim is logging to syslog, it writes the log lines for its three
16005 separate logs at different syslog priorities so that they can in principle
16006 be separated on the logging hosts. Some installations do not require this
16007 separation, and in those cases, the duplication of certain log lines is a
16008 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16009 particular log line is written to syslog. For lines that normally go to
16010 both the main log and the reject log, the reject log version (possibly
16011 containing message header lines) is written, at LOG_NOTICE priority.
16012 Lines that normally go to both the main and the panic log are written at
16013 the LOG_ALERT priority.
16014
16015
16016 .option syslog_facility main string unset
16017 .cindex "syslog" "facility; setting"
16018 This option sets the syslog &"facility"& name, used when Exim is logging to
16019 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16020 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16021 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16022 details of Exim's logging.
16023
16024
16025
16026 .option syslog_processname main string &`exim`&
16027 .cindex "syslog" "process name; setting"
16028 This option sets the syslog &"ident"& name, used when Exim is logging to
16029 syslog. The value must be no longer than 32 characters. See chapter
16030 &<<CHAPlog>>& for details of Exim's logging.
16031
16032
16033
16034 .option syslog_timestamp main boolean true
16035 .cindex "syslog" "timestamps"
16036 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16037 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16038 details of Exim's logging.
16039
16040
16041 .option system_filter main string&!! unset
16042 .cindex "filter" "system filter"
16043 .cindex "system filter" "specifying"
16044 .cindex "Sieve filter" "not available for system filter"
16045 This option specifies an Exim filter file that is applied to all messages at
16046 the start of each delivery attempt, before any routing is done. System filters
16047 must be Exim filters; they cannot be Sieve filters. If the system filter
16048 generates any deliveries to files or pipes, or any new mail messages, the
16049 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16050 which transports are to be used. Details of this facility are given in chapter
16051 &<<CHAPsystemfilter>>&.
16052
16053
16054 .option system_filter_directory_transport main string&!! unset
16055 .vindex "&$address_file$&"
16056 This sets the name of the transport driver that is to be used when the
16057 &%save%& command in a system message filter specifies a path ending in &"/"&,
16058 implying delivery of each message into a separate file in some directory.
16059 During the delivery, the variable &$address_file$& contains the path name.
16060
16061
16062 .option system_filter_file_transport main string&!! unset
16063 .cindex "file" "transport for system filter"
16064 This sets the name of the transport driver that is to be used when the &%save%&
16065 command in a system message filter specifies a path not ending in &"/"&. During
16066 the delivery, the variable &$address_file$& contains the path name.
16067
16068 .option system_filter_group main string unset
16069 .cindex "gid (group id)" "system filter"
16070 This option is used only when &%system_filter_user%& is also set. It sets the
16071 gid under which the system filter is run, overriding any gid that is associated
16072 with the user. The value may be numerical or symbolic.
16073
16074 .option system_filter_pipe_transport main string&!! unset
16075 .cindex "&(pipe)& transport" "for system filter"
16076 .vindex "&$address_pipe$&"
16077 This specifies the transport driver that is to be used when a &%pipe%& command
16078 is used in a system filter. During the delivery, the variable &$address_pipe$&
16079 contains the pipe command.
16080
16081
16082 .option system_filter_reply_transport main string&!! unset
16083 .cindex "&(autoreply)& transport" "for system filter"
16084 This specifies the transport driver that is to be used when a &%mail%& command
16085 is used in a system filter.
16086
16087
16088 .option system_filter_user main string unset
16089 .cindex "uid (user id)" "system filter"
16090 If this option is set to root, the system filter is run in the main Exim
16091 delivery process, as root.  Otherwise, the system filter runs in a separate
16092 process, as the given user, defaulting to the Exim run-time user.
16093 Unless the string consists entirely of digits, it
16094 is looked up in the password data. Failure to find the named user causes a
16095 configuration error. The gid is either taken from the password data, or
16096 specified by &%system_filter_group%&. When the uid is specified numerically,
16097 &%system_filter_group%& is required to be set.
16098
16099 If the system filter generates any pipe, file, or reply deliveries, the uid
16100 under which the filter is run is used when transporting them, unless a
16101 transport option overrides.
16102
16103
16104 .option tcp_nodelay main boolean true
16105 .cindex "daemon" "TCP_NODELAY on sockets"
16106 .cindex "Nagle algorithm"
16107 .cindex "TCP_NODELAY on listening sockets"
16108 If this option is set false, it stops the Exim daemon setting the
16109 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16110 turns off the &"Nagle algorithm"&, which is a way of improving network
16111 performance in interactive (character-by-character) situations. Turning it off
16112 should improve Exim's performance a bit, so that is what happens by default.
16113 However, it appears that some broken clients cannot cope, and time out. Hence
16114 this option. It affects only those sockets that are set up for listening by the
16115 daemon. Sockets created by the smtp transport for delivering mail always set
16116 TCP_NODELAY.
16117
16118
16119 .option timeout_frozen_after main time 0s
16120 .cindex "frozen messages" "timing out"
16121 .cindex "timeout" "frozen messages"
16122 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16123 message of any kind that has been on the queue for longer than the given time
16124 is automatically cancelled at the next queue run. If the frozen message is a
16125 bounce message, it is just discarded; otherwise, a bounce is sent to the
16126 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16127 If you want to timeout frozen bounce messages earlier than other kinds of
16128 frozen message, see &%ignore_bounce_errors_after%&.
16129
16130 &*Note:*& the default value of zero means no timeouts; with this setting,
16131 frozen messages remain on the queue forever (except for any frozen bounce
16132 messages that are released by &%ignore_bounce_errors_after%&).
16133
16134
16135 .option timezone main string unset
16136 .cindex "timezone, setting"
16137 The value of &%timezone%& is used to set the environment variable TZ while
16138 running Exim (if it is different on entry). This ensures that all timestamps
16139 created by Exim are in the required timezone. If you want all your timestamps
16140 to be in UTC (aka GMT) you should set
16141 .code
16142 timezone = UTC
16143 .endd
16144 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16145 or, if that is not set, from the value of the TZ environment variable when Exim
16146 is built. If &%timezone%& is set to the empty string, either at build or run
16147 time, any existing TZ variable is removed from the environment when Exim
16148 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16149 unfortunately not all, operating systems.
16150
16151
16152 .option tls_advertise_hosts main "host list&!!" unset
16153 .cindex "TLS" "advertising"
16154 .cindex "encryption" "on SMTP connection"
16155 .cindex "SMTP" "encrypted connection"
16156 When Exim is built with support for TLS encrypted connections, the availability
16157 of the STARTTLS command to set up an encrypted session is advertised in
16158 response to EHLO only to those client hosts that match this option. See
16159 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16160
16161
16162 .option tls_certificate main string&!! unset
16163 .cindex "TLS" "server certificate; location of"
16164 .cindex "certificate" "server, location of"
16165 The value of this option is expanded, and must then be the absolute path to a
16166 file which contains the server's certificates. The server's private key is also
16167 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16168 &<<CHAPTLS>>& for further details.
16169
16170 &*Note*&: The certificates defined by this option are used only when Exim is
16171 receiving incoming messages as a server. If you want to supply certificates for
16172 use when sending messages as a client, you must set the &%tls_certificate%&
16173 option in the relevant &(smtp)& transport.
16174
16175 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16176 if the OpenSSL build supports TLS extensions and the TLS client sends the
16177 Server Name Indication extension, then this option and others documented in
16178 &<<SECTtlssni>>& will be re-expanded.
16179
16180 .option tls_crl main string&!! unset
16181 .cindex "TLS" "server certificate revocation list"
16182 .cindex "certificate" "revocation list for server"
16183 This option specifies a certificate revocation list. The expanded value must
16184 be the name of a file that contains a CRL in PEM format.
16185
16186 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16187
16188
16189 .option tls_dh_max_bits main integer 2236
16190 .cindex "TLS" "D-H bit count"
16191 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16192 the chosen TLS library.  That value might prove to be too high for
16193 interoperability.  This option provides a maximum clamp on the value
16194 suggested, trading off security for interoperability.
16195
16196 The value must be at least 1024.
16197
16198 The value 2236 was chosen because, at time of adding the option, it was the
16199 hard-coded maximum value supported by the NSS cryptographic library, as used
16200 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16201
16202 If you prefer more security and are willing to break some clients, raise this
16203 number.
16204
16205 Note that the value passed to GnuTLS for *generating* a new prime may be a
16206 little less than this figure, because GnuTLS is inexact and may produce a
16207 larger prime than requested.
16208
16209
16210 .option tls_dhparam main string&!! unset
16211 .cindex "TLS" "D-H parameters for server"
16212 The value of this option is expanded and indicates the source of DH parameters
16213 to be used by Exim.
16214
16215 If it is a filename starting with a &`/`&, then it names a file from which DH
16216 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16217 PKCS#3 representation of the DH prime.  If the file does not exist, for
16218 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16219 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16220 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16221 and treated as though the &%tls_dhparam%& were set to "none".
16222
16223 If this option expands to the string "none", then no DH parameters will be
16224 loaded by Exim.
16225
16226 If this option expands to the string "historic" and Exim is using GnuTLS, then
16227 Exim will attempt to load a file from inside the spool directory.  If the file
16228 does not exist, Exim will attempt to create it.
16229 See section &<<SECTgnutlsparam>>& for further details.
16230
16231 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16232 a default DH prime; the default is the 2048 bit prime described in section
16233 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16234 in IKE is assigned number 23.
16235
16236 Otherwise, the option must expand to the name used by Exim for any of a number
16237 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16238 "ike" followed by the number used by IKE, of "default" which corresponds to
16239 "ike23".
16240
16241 The available primes are:
16242 &`ike1`&, &`ike2`&, &`ike5`&,
16243 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16244 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16245
16246 Some of these will be too small to be accepted by clients.
16247 Some may be too large to be accepted by clients.
16248
16249 The TLS protocol does not negotiate an acceptable size for this; clients tend
16250 to hard-drop connections if what is offered by the server is unacceptable,
16251 whether too large or too small, and there's no provision for the client to
16252 tell the server what these constraints are.  Thus, as a server operator, you
16253 need to make an educated guess as to what is most likely to work for your
16254 userbase.
16255
16256 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16257 is most likely to maximise interoperability.  The upper bound comes from
16258 applications using the Mozilla Network Security Services (NSS) library, which
16259 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16260 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16261 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16262 acceptable bound from 1024 to 2048.
16263
16264
16265 .option tls_on_connect_ports main "string list" unset
16266 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16267 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16268 set up without waiting for the client to issue a STARTTLS command. For
16269 further details, see section &<<SECTsupobssmt>>&.
16270
16271
16272
16273 .option tls_privatekey main string&!! unset
16274 .cindex "TLS" "server private key; location of"
16275 The value of this option is expanded, and must then be the absolute path to a
16276 file which contains the server's private key. If this option is unset, or if
16277 the expansion is forced to fail, or the result is an empty string, the private
16278 key is assumed to be in the same file as the server's certificates. See chapter
16279 &<<CHAPTLS>>& for further details.
16280
16281 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16282
16283
16284 .option tls_remember_esmtp main boolean false
16285 .cindex "TLS" "esmtp state; remembering"
16286 .cindex "TLS" "broken clients"
16287 If this option is set true, Exim violates the RFCs by remembering that it is in
16288 &"esmtp"& state after successfully negotiating a TLS session. This provides
16289 support for broken clients that fail to send a new EHLO after starting a
16290 TLS session.
16291
16292
16293 .option tls_require_ciphers main string&!! unset
16294 .cindex "TLS" "requiring specific ciphers"
16295 .cindex "cipher" "requiring specific"
16296 This option controls which ciphers can be used for incoming TLS connections.
16297 The &(smtp)& transport has an option of the same name for controlling outgoing
16298 connections. This option is expanded for each connection, so can be varied for
16299 different clients if required. The value of this option must be a list of
16300 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16301 in somewhat different ways. If GnuTLS is being used, the client controls the
16302 preference order of the available ciphers. Details are given in sections
16303 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16304
16305
16306 .option tls_try_verify_hosts main "host list&!!" unset
16307 .cindex "TLS" "client certificate verification"
16308 .cindex "certificate" "verification of client"
16309 See &%tls_verify_hosts%& below.
16310
16311
16312 .option tls_verify_certificates main string&!! unset
16313 .cindex "TLS" "client certificate verification"
16314 .cindex "certificate" "verification of client"
16315 The value of this option is expanded, and must then be the absolute path to
16316 a file containing permitted certificates for clients that
16317 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16318 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
16319 directory containing certificate files. This does not work with GnuTLS; the
16320 option must be set to the name of a single file if you are using GnuTLS.
16321
16322 These certificates should be for the certificate authorities trusted, rather
16323 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16324 the value is a file then the certificates are sent by Exim as a server to
16325 connecting clients, defining the list of accepted certificate authorities.
16326 Thus the values defined should be considered public data.  To avoid this,
16327 use OpenSSL with a directory.
16328
16329 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16330
16331 A forced expansion failure or setting to an empty string is equivalent to
16332 being unset.
16333
16334
16335 .option tls_verify_hosts main "host list&!!" unset
16336 .cindex "TLS" "client certificate verification"
16337 .cindex "certificate" "verification of client"
16338 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16339 certificates from clients. The expected certificates are defined by
16340 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16341 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16342 &%tls_verify_certificates%& is not set.
16343
16344 Any client that matches &%tls_verify_hosts%& is constrained by
16345 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16346 present one of the listed certificates. If it does not, the connection is
16347 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16348 the host to use TLS. It can still send SMTP commands through unencrypted
16349 connections. Forcing a client to use TLS has to be done separately using an
16350 ACL to reject inappropriate commands when the connection is not encrypted.
16351
16352 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16353 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16354 certificate and checks it against &%tls_verify_certificates%&, but does not
16355 abort the connection if there is no certificate or if it does not match. This
16356 state can be detected in an ACL, which makes it possible to implement policies
16357 such as &"accept for relay only if a verified certificate has been received,
16358 but accept for local delivery if encrypted, even without a verified
16359 certificate"&.
16360
16361 Client hosts that match neither of these lists are not asked to present
16362 certificates.
16363
16364
16365 .option trusted_groups main "string list&!!" unset
16366 .cindex "trusted groups"
16367 .cindex "groups" "trusted"
16368 This option is expanded just once, at the start of Exim's processing. If this
16369 option is set, any process that is running in one of the listed groups, or
16370 which has one of them as a supplementary group, is trusted. The groups can be
16371 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16372 details of what trusted callers are permitted to do. If neither
16373 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16374 are trusted.
16375
16376 .option trusted_users main "string list&!!" unset
16377 .cindex "trusted users"
16378 .cindex "user" "trusted"
16379 This option is expanded just once, at the start of Exim's processing. If this
16380 option is set, any process that is running as one of the listed users is
16381 trusted. The users can be specified numerically or by name. See section
16382 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16383 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16384 Exim user are trusted.
16385
16386 .option unknown_login main string&!! unset
16387 .cindex "uid (user id)" "unknown caller"
16388 .vindex "&$caller_uid$&"
16389 This is a specialized feature for use in unusual configurations. By default, if
16390 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16391 gives up. The &%unknown_login%& option can be used to set a login name to be
16392 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16393 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16394 is used for the user's real name (gecos field), unless this has been set by the
16395 &%-F%& option.
16396
16397 .option unknown_username main string unset
16398 See &%unknown_login%&.
16399
16400 .option untrusted_set_sender main "address list&!!" unset
16401 .cindex "trusted users"
16402 .cindex "sender" "setting by untrusted user"
16403 .cindex "untrusted user setting sender"
16404 .cindex "user" "untrusted setting sender"
16405 .cindex "envelope sender"
16406 When an untrusted user submits a message to Exim using the standard input, Exim
16407 normally creates an envelope sender address from the user's login and the
16408 default qualification domain. Data from the &%-f%& option (for setting envelope
16409 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16410 is used) is ignored.
16411
16412 However, untrusted users are permitted to set an empty envelope sender address,
16413 to declare that a message should never generate any bounces. For example:
16414 .code
16415 exim -f '<>' user@domain.example
16416 .endd
16417 .vindex "&$sender_ident$&"
16418 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16419 other envelope sender addresses in a controlled way. When it is set, untrusted
16420 users are allowed to set envelope sender addresses that match any of the
16421 patterns in the list. Like all address lists, the string is expanded. The
16422 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16423 users to setting senders that start with their login ids
16424 followed by a hyphen
16425 by a setting like this:
16426 .code
16427 untrusted_set_sender = ^$sender_ident-
16428 .endd
16429 If you want to allow untrusted users to set envelope sender addresses without
16430 restriction, you can use
16431 .code
16432 untrusted_set_sender = *
16433 .endd
16434 The &%untrusted_set_sender%& option applies to all forms of local input, but
16435 only to the setting of the envelope sender. It does not permit untrusted users
16436 to use the other options which trusted user can use to override message
16437 parameters. Furthermore, it does not stop Exim from removing an existing
16438 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16439 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16440 overriding these actions. The handling of the &'Sender:'& header is also
16441 described in section &<<SECTthesenhea>>&.
16442
16443 The log line for a message's arrival shows the envelope sender following
16444 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16445 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16446 envelope sender address, the user's login is shown in parentheses after the
16447 sender address.
16448
16449
16450 .option uucp_from_pattern main string "see below"
16451 .cindex "&""From""& line"
16452 .cindex "UUCP" "&""From""& line"
16453 Some applications that pass messages to an MTA via a command line interface use
16454 an initial line starting with &"From&~"& to pass the envelope sender. In
16455 particular, this is used by UUCP software. Exim recognizes such a line by means
16456 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16457 matches, the sender address is constructed by expanding the contents of
16458 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16459 default pattern recognizes lines in the following two forms:
16460 .code
16461 From ph10 Fri Jan  5 12:35 GMT 1996
16462 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16463 .endd
16464 The pattern can be seen by running
16465 .code
16466 exim -bP uucp_from_pattern
16467 .endd
16468 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16469 year in the second case. The first word after &"From&~"& is matched in the
16470 regular expression by a parenthesized subpattern. The default value for
16471 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16472 (&"ph10"& in the example above) as the message's sender. See also
16473 &%ignore_fromline_hosts%&.
16474
16475
16476 .option uucp_from_sender main string&!! &`$1`&
16477 See &%uucp_from_pattern%& above.
16478
16479
16480 .option warn_message_file main string unset
16481 .cindex "warning of delay" "customizing the message"
16482 .cindex "customizing" "warning message"
16483 This option defines a template file containing paragraphs of text to be used
16484 for constructing the warning message which is sent by Exim when a message has
16485 been on the queue for a specified amount of time, as specified by
16486 &%delay_warning%&. Details of the file's contents are given in chapter
16487 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16488
16489
16490 .option write_rejectlog main boolean true
16491 .cindex "reject log" "disabling"
16492 If this option is set false, Exim no longer writes anything to the reject log.
16493 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16494 .ecindex IIDconfima
16495 .ecindex IIDmaiconf
16496
16497
16498
16499
16500 . ////////////////////////////////////////////////////////////////////////////
16501 . ////////////////////////////////////////////////////////////////////////////
16502
16503 .chapter "Generic options for routers" "CHAProutergeneric"
16504 .scindex IIDgenoprou1 "options" "generic; for routers"
16505 .scindex IIDgenoprou2 "generic options" "router"
16506 This chapter describes the generic options that apply to all routers.
16507 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16508
16509 For a general description of how a router operates, see sections
16510 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16511 which the preconditions are tested. The order of expansion of the options that
16512 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16513 &%headers_remove%&, &%transport%&.
16514
16515
16516
16517 .option address_data routers string&!! unset
16518 .cindex "router" "data attached to address"
16519 The string is expanded just before the router is run, that is, after all the
16520 precondition tests have succeeded. If the expansion is forced to fail, the
16521 router declines, the value of &%address_data%& remains unchanged, and the
16522 &%more%& option controls what happens next. Other expansion failures cause
16523 delivery of the address to be deferred.
16524
16525 .vindex "&$address_data$&"
16526 When the expansion succeeds, the value is retained with the address, and can be
16527 accessed using the variable &$address_data$& in the current router, subsequent
16528 routers, and the eventual transport.
16529
16530 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16531 that runs a user's filter file, the contents of &$address_data$& are accessible
16532 in the filter. This is not normally a problem, because such data is usually
16533 either not confidential or it &"belongs"& to the current user, but if you do
16534 put confidential data into &$address_data$& you need to remember this point.
16535
16536 Even if the router declines or passes, the value of &$address_data$& remains
16537 with the address, though it can be changed by another &%address_data%& setting
16538 on a subsequent router. If a router generates child addresses, the value of
16539 &$address_data$& propagates to them. This also applies to the special kind of
16540 &"child"& that is generated by a router with the &%unseen%& option.
16541
16542 The idea of &%address_data%& is that you can use it to look up a lot of data
16543 for the address once, and then pick out parts of the data later. For example,
16544 you could use a single LDAP lookup to return a string of the form
16545 .code
16546 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16547 .endd
16548 In the transport you could pick out the mailbox by a setting such as
16549 .code
16550 file = ${extract{mailbox}{$address_data}}
16551 .endd
16552 This makes the configuration file less messy, and also reduces the number of
16553 lookups (though Exim does cache lookups).
16554
16555 .vindex "&$sender_address_data$&"
16556 .vindex "&$address_data$&"
16557 The &%address_data%& facility is also useful as a means of passing information
16558 from one router to another, and from a router to a transport. In addition, if
16559 &$address_data$& is set by a router when verifying a recipient address from an
16560 ACL, it remains available for use in the rest of the ACL statement. After
16561 verifying a sender, the value is transferred to &$sender_address_data$&.
16562
16563
16564
16565 .option address_test routers&!? boolean true
16566 .oindex "&%-bt%&"
16567 .cindex "router" "skipping when address testing"
16568 If this option is set false, the router is skipped when routing is being tested
16569 by means of the &%-bt%& command line option. This can be a convenience when
16570 your first router sends messages to an external scanner, because it saves you
16571 having to set the &"already scanned"& indicator when testing real address
16572 routing.
16573
16574
16575
16576 .option cannot_route_message routers string&!! unset
16577 .cindex "router" "customizing &""cannot route""& message"
16578 .cindex "customizing" "&""cannot route""& message"
16579 This option specifies a text message that is used when an address cannot be
16580 routed because Exim has run out of routers. The default message is
16581 &"Unrouteable address"&. This option is useful only on routers that have
16582 &%more%& set false, or on the very last router in a configuration, because the
16583 value that is used is taken from the last router that is considered. This
16584 includes a router that is skipped because its preconditions are not met, as
16585 well as a router that declines. For example, using the default configuration,
16586 you could put:
16587 .code
16588 cannot_route_message = Remote domain not found in DNS
16589 .endd
16590 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16591 and
16592 .code
16593 cannot_route_message = Unknown local user
16594 .endd
16595 on the final router that checks for local users. If string expansion fails for
16596 this option, the default message is used. Unless the expansion failure was
16597 explicitly forced, a message about the failure is written to the main and panic
16598 logs, in addition to the normal message about the routing failure.
16599
16600
16601 .option caseful_local_part routers boolean false
16602 .cindex "case of local parts"
16603 .cindex "router" "case of local parts"
16604 By default, routers handle the local parts of addresses in a case-insensitive
16605 manner, though the actual case is preserved for transmission with the message.
16606 If you want the case of letters to be significant in a router, you must set
16607 this option true. For individual router options that contain address or local
16608 part lists (for example, &%local_parts%&), case-sensitive matching can be
16609 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16610 more details.
16611
16612 .vindex "&$local_part$&"
16613 .vindex "&$original_local_part$&"
16614 .vindex "&$parent_local_part$&"
16615 The value of the &$local_part$& variable is forced to lower case while a
16616 router is running unless &%caseful_local_part%& is set. When a router assigns
16617 an address to a transport, the value of &$local_part$& when the transport runs
16618 is the same as it was in the router. Similarly, when a router generates child
16619 addresses by aliasing or forwarding, the values of &$original_local_part$&
16620 and &$parent_local_part$& are those that were used by the redirecting router.
16621
16622 This option applies to the processing of an address by a router. When a
16623 recipient address is being processed in an ACL, there is a separate &%control%&
16624 modifier that can be used to specify case-sensitive processing within the ACL
16625 (see section &<<SECTcontrols>>&).
16626
16627
16628
16629 .option check_local_user routers&!? boolean false
16630 .cindex "local user, checking in router"
16631 .cindex "router" "checking for local user"
16632 .cindex "&_/etc/passwd_&"
16633 .vindex "&$home$&"
16634 When this option is true, Exim checks that the local part of the recipient
16635 address (with affixes removed if relevant) is the name of an account on the
16636 local system. The check is done by calling the &[getpwnam()]& function rather
16637 than trying to read &_/etc/passwd_& directly. This means that other methods of
16638 holding password data (such as NIS) are supported. If the local part is a local
16639 user, &$home$& is set from the password data, and can be tested in other
16640 preconditions that are evaluated after this one (the order of evaluation is
16641 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16642 overridden by &%router_home_directory%&. If the local part is not a local user,
16643 the router is skipped.
16644
16645 If you want to check that the local part is either the name of a local user
16646 or matches something else, you cannot combine &%check_local_user%& with a
16647 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16648 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16649 setting to achieve this. For example:
16650 .code
16651 local_parts = passwd;$local_part : lsearch;/etc/other/users
16652 .endd
16653 Note, however, that the side effects of &%check_local_user%& (such as setting
16654 up a home directory) do not occur when a &(passwd)& lookup is used in a
16655 &%local_parts%& (or any other) precondition.
16656
16657
16658
16659 .option condition routers&!? string&!! unset
16660 .cindex "router" "customized precondition"
16661 This option specifies a general precondition test that has to succeed for the
16662 router to be called. The &%condition%& option is the last precondition to be
16663 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16664 result is a forced failure, or an empty string, or one of the strings &"0"& or
16665 &"no"& or &"false"& (checked without regard to the case of the letters), the
16666 router is skipped, and the address is offered to the next one.
16667
16668 If the result is any other value, the router is run (as this is the last
16669 precondition to be evaluated, all the other preconditions must be true).
16670
16671 This option is unusual in that multiple &%condition%& options may be present.
16672 All &%condition%& options must succeed.
16673
16674 The &%condition%& option provides a means of applying custom conditions to the
16675 running of routers. Note that in the case of a simple conditional expansion,
16676 the default expansion values are exactly what is wanted. For example:
16677 .code
16678 condition = ${if >{$message_age}{600}}
16679 .endd
16680 Because of the default behaviour of the string expansion, this is equivalent to
16681 .code
16682 condition = ${if >{$message_age}{600}{true}{}}
16683 .endd
16684
16685 A multiple condition example, which succeeds:
16686 .code
16687 condition = ${if >{$message_age}{600}}
16688 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16689 condition = foobar
16690 .endd
16691
16692 If the expansion fails (other than forced failure) delivery is deferred. Some
16693 of the other precondition options are common special cases that could in fact
16694 be specified using &%condition%&.
16695
16696
16697 .option debug_print routers string&!! unset
16698 .cindex "testing" "variables in drivers"
16699 If this option is set and debugging is enabled (see the &%-d%& command line
16700 option) or in address-testing mode (see the &%-bt%& command line option),
16701 the string is expanded and included in the debugging output.
16702 If expansion of the string fails, the error message is written to the debugging
16703 output, and Exim carries on processing.
16704 This option is provided to help with checking out the values of variables and
16705 so on when debugging router configurations. For example, if a &%condition%&
16706 option appears not to be working, &%debug_print%& can be used to output the
16707 variables it references. The output happens after checks for &%domains%&,
16708 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16709 are tested. A newline is added to the text if it does not end with one.
16710 The variable &$router_name$& contains the name of the router.
16711
16712
16713
16714 .option disable_logging routers boolean false
16715 If this option is set true, nothing is logged for any routing errors
16716 or for any deliveries caused by this router. You should not set this option
16717 unless you really, really know what you are doing. See also the generic
16718 transport option of the same name.
16719
16720
16721 .option domains routers&!? "domain list&!!" unset
16722 .cindex "router" "restricting to specific domains"
16723 .vindex "&$domain_data$&"
16724 If this option is set, the router is skipped unless the current domain matches
16725 the list. If the match is achieved by means of a file lookup, the data that the
16726 lookup returned for the domain is placed in &$domain_data$& for use in string
16727 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16728 a list of the order in which preconditions are evaluated.
16729
16730
16731
16732 .option driver routers string unset
16733 This option must always be set. It specifies which of the available routers is
16734 to be used.
16735
16736
16737
16738 .option errors_to routers string&!! unset
16739 .cindex "envelope sender"
16740 .cindex "router" "changing address for errors"
16741 If a router successfully handles an address, it may assign the address to a
16742 transport for delivery or it may generate child addresses. In both cases, if
16743 there is a delivery problem during later processing, the resulting bounce
16744 message is sent to the address that results from expanding this string,
16745 provided that the address verifies successfully. The &%errors_to%& option is
16746 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16747
16748 The &%errors_to%& setting associated with an address can be overridden if it
16749 subsequently passes through other routers that have their own &%errors_to%&
16750 settings, or if the message is delivered by a transport with a &%return_path%&
16751 setting.
16752
16753 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16754 the expansion fails to verify, the errors address associated with the incoming
16755 address is used. At top level, this is the envelope sender. A non-forced
16756 expansion failure causes delivery to be deferred.
16757
16758 If an address for which &%errors_to%& has been set ends up being delivered over
16759 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16760 any bounces that are generated by other MTAs on the delivery route are also
16761 sent there. You can set &%errors_to%& to the empty string by either of these
16762 settings:
16763 .code
16764 errors_to =
16765 errors_to = ""
16766 .endd
16767 An expansion item that yields an empty string has the same effect. If you do
16768 this, a locally detected delivery error for addresses processed by this router
16769 no longer gives rise to a bounce message; the error is discarded. If the
16770 address is delivered to a remote host, the return path is set to &`<>`&, unless
16771 overridden by the &%return_path%& option on the transport.
16772
16773 .vindex "&$address_data$&"
16774 If for some reason you want to discard local errors, but use a non-empty
16775 MAIL command for remote delivery, you can preserve the original return
16776 path in &$address_data$& in the router, and reinstate it in the transport by
16777 setting &%return_path%&.
16778
16779 The most common use of &%errors_to%& is to direct mailing list bounces to the
16780 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16781 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16782
16783
16784
16785 .option expn routers&!? boolean true
16786 .cindex "address" "testing"
16787 .cindex "testing" "addresses"
16788 .cindex "EXPN" "router skipping"
16789 .cindex "router" "skipping for EXPN"
16790 If this option is turned off, the router is skipped when testing an address
16791 as a result of processing an SMTP EXPN command. You might, for example,
16792 want to turn it off on a router for users' &_.forward_& files, while leaving it
16793 on for the system alias file.
16794 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16795 are evaluated.
16796
16797 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16798 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16799 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16800
16801
16802
16803 .option fail_verify routers boolean false
16804 .cindex "router" "forcing verification failure"
16805 Setting this option has the effect of setting both &%fail_verify_sender%& and
16806 &%fail_verify_recipient%& to the same value.
16807
16808
16809
16810 .option fail_verify_recipient routers boolean false
16811 If this option is true and an address is accepted by this router when
16812 verifying a recipient, verification fails.
16813
16814
16815
16816 .option fail_verify_sender routers boolean false
16817 If this option is true and an address is accepted by this router when
16818 verifying a sender, verification fails.
16819
16820
16821
16822 .option fallback_hosts routers "string list" unset
16823 .cindex "router" "fallback hosts"
16824 .cindex "fallback" "hosts specified on router"
16825 String expansion is not applied to this option. The argument must be a
16826 colon-separated list of host names or IP addresses. The list separator can be
16827 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16828 each name or address. In fact, the format of each item is exactly the same as
16829 defined for the list of hosts in a &(manualroute)& router (see section
16830 &<<SECTformatonehostitem>>&).
16831
16832 If a router queues an address for a remote transport, this host list is
16833 associated with the address, and used instead of the transport's fallback host
16834 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16835 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16836 transport for further details.
16837
16838
16839 .option group routers string&!! "see below"
16840 .cindex "gid (group id)" "local delivery"
16841 .cindex "local transports" "uid and gid"
16842 .cindex "transport" "local"
16843 .cindex "router" "setting group"
16844 When a router queues an address for a transport, and the transport does not
16845 specify a group, the group given here is used when running the delivery
16846 process.
16847 The group may be specified numerically or by name. If expansion fails, the
16848 error is logged and delivery is deferred.
16849 The default is unset, unless &%check_local_user%& is set, when the default
16850 is taken from the password information. See also &%initgroups%& and &%user%&
16851 and the discussion in chapter &<<CHAPenvironment>>&.
16852
16853
16854
16855 .option headers_add routers list&!! unset
16856 .cindex "header lines" "adding"
16857 .cindex "router" "adding header lines"
16858 This option specifies a list of text headers, newline-separated,
16859 that is associated with any addresses that are accepted by the router.
16860 Each item is separately expanded, at routing time.  However, this
16861 option has no effect when an address is just being verified. The way in which
16862 the text is used to add header lines at transport time is described in section
16863 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16864 message is in the process of being transported. This means that references to
16865 header lines in string expansions in the transport's configuration do not
16866 &"see"& the added header lines.
16867
16868 The &%headers_add%& option is expanded after &%errors_to%&, but before
16869 &%headers_remove%& and &%transport%&. If an item is empty, or if
16870 an item expansion is forced to fail, the item has no effect. Other expansion
16871 failures are treated as configuration errors.
16872
16873 Unlike most options, &%headers_add%& can be specified multiple times
16874 for a router; all listed headers are added.
16875
16876 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16877 router that has the &%one_time%& option set.
16878
16879 .cindex "duplicate addresses"
16880 .oindex "&%unseen%&"
16881 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16882 additions are deleted when the address is passed on to subsequent routers.
16883 For a &%redirect%& router, if a generated address is the same as the incoming
16884 address, this can lead to duplicate addresses with different header
16885 modifications. Exim does not do duplicate deliveries (except, in certain
16886 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16887 which of the duplicates is discarded, so this ambiguous situation should be
16888 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16889
16890
16891
16892 .option headers_remove routers list&!! unset
16893 .cindex "header lines" "removing"
16894 .cindex "router" "removing header lines"
16895 This option specifies a list of text headers, colon-separated,
16896 that is associated with any addresses that are accepted by the router.
16897 Each item is separately expanded, at routing time.  However, this
16898 option has no effect when an address is just being verified. The way in which
16899 the text is used to remove header lines at transport time is described in
16900 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16901 the message is in the process of being transported. This means that references
16902 to header lines in string expansions in the transport's configuration still
16903 &"see"& the original header lines.
16904
16905 The &%headers_remove%& option is expanded after &%errors_to%& and
16906 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
16907 the item has no effect. Other expansion failures are treated as configuration
16908 errors.
16909
16910 Unlike most options, &%headers_remove%& can be specified multiple times
16911 for a router; all listed headers are removed.
16912
16913 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16914 router that has the &%one_time%& option set.
16915
16916 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16917 removal requests are deleted when the address is passed on to subsequent
16918 routers, and this can lead to problems with duplicates -- see the similar
16919 warning for &%headers_add%& above.
16920
16921
16922 .option ignore_target_hosts routers "host list&!!" unset
16923 .cindex "IP address" "discarding"
16924 .cindex "router" "discarding IP addresses"
16925 Although this option is a host list, it should normally contain IP address
16926 entries rather than names. If any host that is looked up by the router has an
16927 IP address that matches an item in this list, Exim behaves as if that IP
16928 address did not exist. This option allows you to cope with rogue DNS entries
16929 like
16930 .code
16931 remote.domain.example.  A  127.0.0.1
16932 .endd
16933 by setting
16934 .code
16935 ignore_target_hosts = 127.0.0.1
16936 .endd
16937 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16938 discarded in this way, the router declines. In a conventional configuration, an
16939 attempt to mail to such a domain would normally provoke the &"unrouteable
16940 domain"& error, and an attempt to verify an address in the domain would fail.
16941 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16942 router declines if presented with one of the listed addresses.
16943
16944 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16945 means of the first or the second of the following settings, respectively:
16946 .code
16947 ignore_target_hosts = 0.0.0.0/0
16948 ignore_target_hosts = <; 0::0/0
16949 .endd
16950 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16951 in the second line matches all IPv6 addresses.
16952
16953 This option may also be useful for ignoring link-local and site-local IPv6
16954 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16955 is expanded before use as a list, it is possible to make it dependent on the
16956 domain that is being routed.
16957
16958 .vindex "&$host_address$&"
16959 During its expansion, &$host_address$& is set to the IP address that is being
16960 checked.
16961
16962 .option initgroups routers boolean false
16963 .cindex "additional groups"
16964 .cindex "groups" "additional"
16965 .cindex "local transports" "uid and gid"
16966 .cindex "transport" "local"
16967 If the router queues an address for a transport, and this option is true, and
16968 the uid supplied by the router is not overridden by the transport, the
16969 &[initgroups()]& function is called when running the transport to ensure that
16970 any additional groups associated with the uid are set up. See also &%group%&
16971 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16972
16973
16974
16975 .option local_part_prefix routers&!? "string list" unset
16976 .cindex "router" "prefix for local part"
16977 .cindex "prefix" "for local part, used in router"
16978 If this option is set, the router is skipped unless the local part starts with
16979 one of the given strings, or &%local_part_prefix_optional%& is true. See
16980 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16981 evaluated.
16982
16983 The list is scanned from left to right, and the first prefix that matches is
16984 used. A limited form of wildcard is available; if the prefix begins with an
16985 asterisk, it matches the longest possible sequence of arbitrary characters at
16986 the start of the local part. An asterisk should therefore always be followed by
16987 some character that does not occur in normal local parts.
16988 .cindex "multiple mailboxes"
16989 .cindex "mailbox" "multiple"
16990 Wildcarding can be used to set up multiple user mailboxes, as described in
16991 section &<<SECTmulbox>>&.
16992
16993 .vindex "&$local_part$&"
16994 .vindex "&$local_part_prefix$&"
16995 During the testing of the &%local_parts%& option, and while the router is
16996 running, the prefix is removed from the local part, and is available in the
16997 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16998 the router accepts the address, this remains true during subsequent delivery by
16999 a transport. In particular, the local part that is transmitted in the RCPT
17000 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17001 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17002 the relevant transport.
17003
17004 When an address is being verified, &%local_part_prefix%& affects only the
17005 behaviour of the router. If the callout feature of verification is in use, this
17006 means that the full address, including the prefix, will be used during the
17007 callout.
17008
17009 The prefix facility is commonly used to handle local parts of the form
17010 &%owner-something%&. Another common use is to support local parts of the form
17011 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17012 to tell a user their forwarding is broken &-- by placing a router like this one
17013 immediately before the router that handles &_.forward_& files:
17014 .code
17015 real_localuser:
17016   driver = accept
17017   local_part_prefix = real-
17018   check_local_user
17019   transport = local_delivery
17020 .endd
17021 For security, it would probably be a good idea to restrict the use of this
17022 router to locally-generated messages, using a condition such as this:
17023 .code
17024   condition = ${if match {$sender_host_address}\
17025                          {\N^(|127\.0\.0\.1)$\N}}
17026 .endd
17027
17028 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17029 both conditions must be met if not optional. Care must be taken if wildcards
17030 are used in both a prefix and a suffix on the same router. Different
17031 separator characters must be used to avoid ambiguity.
17032
17033
17034 .option local_part_prefix_optional routers boolean false
17035 See &%local_part_prefix%& above.
17036
17037
17038
17039 .option local_part_suffix routers&!? "string list" unset
17040 .cindex "router" "suffix for local part"
17041 .cindex "suffix for local part" "used in router"
17042 This option operates in the same way as &%local_part_prefix%&, except that the
17043 local part must end (rather than start) with the given string, the
17044 &%local_part_suffix_optional%& option determines whether the suffix is
17045 mandatory, and the wildcard * character, if present, must be the last
17046 character of the suffix. This option facility is commonly used to handle local
17047 parts of the form &%something-request%& and multiple user mailboxes of the form
17048 &%username-foo%&.
17049
17050
17051 .option local_part_suffix_optional routers boolean false
17052 See &%local_part_suffix%& above.
17053
17054
17055
17056 .option local_parts routers&!? "local part list&!!" unset
17057 .cindex "router" "restricting to specific local parts"
17058 .cindex "local part" "checking in router"
17059 The router is run only if the local part of the address matches the list.
17060 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17061 are evaluated, and
17062 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17063 string is expanded, it is possible to make it depend on the domain, for
17064 example:
17065 .code
17066 local_parts = dbm;/usr/local/specials/$domain
17067 .endd
17068 .vindex "&$local_part_data$&"
17069 If the match is achieved by a lookup, the data that the lookup returned
17070 for the local part is placed in the variable &$local_part_data$& for use in
17071 expansions of the router's private options. You might use this option, for
17072 example, if you have a large number of local virtual domains, and you want to
17073 send all postmaster mail to the same place without having to set up an alias in
17074 each virtual domain:
17075 .code
17076 postmaster:
17077   driver = redirect
17078   local_parts = postmaster
17079   data = postmaster@real.domain.example
17080 .endd
17081
17082
17083 .option log_as_local routers boolean "see below"
17084 .cindex "log" "delivery line"
17085 .cindex "delivery" "log line format"
17086 Exim has two logging styles for delivery, the idea being to make local
17087 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17088 recipient address is given just as the local part, without a domain. The use of
17089 this style is controlled by this option. It defaults to true for the &(accept)&
17090 router, and false for all the others. This option applies only when a
17091 router assigns an address to a transport. It has no effect on routers that
17092 redirect addresses.
17093
17094
17095
17096 .option more routers boolean&!! true
17097 The result of string expansion for this option must be a valid boolean value,
17098 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17099 result causes an error, and delivery is deferred. If the expansion is forced to
17100 fail, the default value for the option (true) is used. Other failures cause
17101 delivery to be deferred.
17102
17103 If this option is set false, and the router declines to handle the address, no
17104 further routers are tried, routing fails, and the address is bounced.
17105 .oindex "&%self%&"
17106 However, if the router explicitly passes an address to the following router by
17107 means of the setting
17108 .code
17109 self = pass
17110 .endd
17111 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17112 does not affect the behaviour if one of the precondition tests fails. In that
17113 case, the address is always passed to the next router.
17114
17115 Note that &%address_data%& is not considered to be a precondition. If its
17116 expansion is forced to fail, the router declines, and the value of &%more%&
17117 controls what happens next.
17118
17119
17120 .option pass_on_timeout routers boolean false
17121 .cindex "timeout" "of router"
17122 .cindex "router" "timeout"
17123 If a router times out during a host lookup, it normally causes deferral of the
17124 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17125 router, overriding &%no_more%&. This may be helpful for systems that are
17126 intermittently connected to the Internet, or those that want to pass to a smart
17127 host any messages that cannot immediately be delivered.
17128
17129 There are occasional other temporary errors that can occur while doing DNS
17130 lookups. They are treated in the same way as a timeout, and this option
17131 applies to all of them.
17132
17133
17134
17135 .option pass_router routers string unset
17136 .cindex "router" "go to after &""pass""&"
17137 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17138 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17139 routing to continue, and overriding a false setting of &%more%&. When one of
17140 these routers returns &"pass"&, the address is normally handed on to the next
17141 router in sequence. This can be changed by setting &%pass_router%& to the name
17142 of another router. However (unlike &%redirect_router%&) the named router must
17143 be below the current router, to avoid loops. Note that this option applies only
17144 to the special case of &"pass"&. It does not apply when a router returns
17145 &"decline"& because it cannot handle an address.
17146
17147
17148
17149 .option redirect_router routers string unset
17150 .cindex "router" "start at after redirection"
17151 Sometimes an administrator knows that it is pointless to reprocess addresses
17152 generated from alias or forward files with the same router again. For
17153 example, if an alias file translates real names into login ids there is no
17154 point searching the alias file a second time, especially if it is a large file.
17155
17156 The &%redirect_router%& option can be set to the name of any router instance.
17157 It causes the routing of any generated addresses to start at the named router
17158 instead of at the first router. This option has no effect if the router in
17159 which it is set does not generate new addresses.
17160
17161
17162
17163 .option require_files routers&!? "string list&!!" unset
17164 .cindex "file" "requiring for router"
17165 .cindex "router" "requiring file existence"
17166 This option provides a general mechanism for predicating the running of a
17167 router on the existence or non-existence of certain files or directories.
17168 Before running a router, as one of its precondition tests, Exim works its way
17169 through the &%require_files%& list, expanding each item separately.
17170
17171 Because the list is split before expansion, any colons in expansion items must
17172 be doubled, or the facility for using a different list separator must be used.
17173 If any expansion is forced to fail, the item is ignored. Other expansion
17174 failures cause routing of the address to be deferred.
17175
17176 If any expanded string is empty, it is ignored. Otherwise, except as described
17177 below, each string must be a fully qualified file path, optionally preceded by
17178 &"!"&. The paths are passed to the &[stat()]& function to test for the
17179 existence of the files or directories. The router is skipped if any paths not
17180 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17181
17182 .cindex "NFS"
17183 If &[stat()]& cannot determine whether a file exists or not, delivery of
17184 the message is deferred. This can happen when NFS-mounted filesystems are
17185 unavailable.
17186
17187 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17188 options, so you cannot use it to check for the existence of a file in which to
17189 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17190 full list of the order in which preconditions are evaluated.) However, as
17191 these options are all expanded, you can use the &%exists%& expansion condition
17192 to make such tests. The &%require_files%& option is intended for checking files
17193 that the router may be going to use internally, or which are needed by a
17194 transport (for example &_.procmailrc_&).
17195
17196 During delivery, the &[stat()]& function is run as root, but there is a
17197 facility for some checking of the accessibility of a file by another user.
17198 This is not a proper permissions check, but just a &"rough"& check that
17199 operates as follows:
17200
17201 If an item in a &%require_files%& list does not contain any forward slash
17202 characters, it is taken to be the user (and optional group, separated by a
17203 comma) to be checked for subsequent files in the list. If no group is specified
17204 but the user is specified symbolically, the gid associated with the uid is
17205 used. For example:
17206 .code
17207 require_files = mail:/some/file
17208 require_files = $local_part:$home/.procmailrc
17209 .endd
17210 If a user or group name in a &%require_files%& list does not exist, the
17211 &%require_files%& condition fails.
17212
17213 Exim performs the check by scanning along the components of the file path, and
17214 checking the access for the given uid and gid. It checks for &"x"& access on
17215 directories, and &"r"& access on the final file. Note that this means that file
17216 access control lists, if the operating system has them, are ignored.
17217
17218 &*Warning 1*&: When the router is being run to verify addresses for an
17219 incoming SMTP message, Exim is not running as root, but under its own uid. This
17220 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17221 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17222 user is not permitted to read one of the directories on the file's path.
17223
17224 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17225 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17226 without root access. In this case, if a check for access by a particular user
17227 is requested, Exim creates a subprocess that runs as that user, and tries the
17228 check again in that process.
17229
17230 The default action for handling an unresolved EACCES is to consider it to
17231 be caused by a configuration error, and routing is deferred because the
17232 existence or non-existence of the file cannot be determined. However, in some
17233 circumstances it may be desirable to treat this condition as if the file did
17234 not exist. If the file name (or the exclamation mark that precedes the file
17235 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17236 as if the file did not exist. For example:
17237 .code
17238 require_files = +/some/file
17239 .endd
17240 If the router is not an essential part of verification (for example, it
17241 handles users' &_.forward_& files), another solution is to set the &%verify%&
17242 option false so that the router is skipped when verifying.
17243
17244
17245
17246 .option retry_use_local_part routers boolean "see below"
17247 .cindex "hints database" "retry keys"
17248 .cindex "local part" "in retry keys"
17249 When a delivery suffers a temporary routing failure, a retry record is created
17250 in Exim's hints database. For addresses whose routing depends only on the
17251 domain, the key for the retry record should not involve the local part, but for
17252 other addresses, both the domain and the local part should be included.
17253 Usually, remote routing is of the former kind, and local routing is of the
17254 latter kind.
17255
17256 This option controls whether the local part is used to form the key for retry
17257 hints for addresses that suffer temporary errors while being handled by this
17258 router. The default value is true for any router that has &%check_local_user%&
17259 set, and false otherwise. Note that this option does not apply to hints keys
17260 for transport delays; they are controlled by a generic transport option of the
17261 same name.
17262
17263 The setting of &%retry_use_local_part%& applies only to the router on which it
17264 appears. If the router generates child addresses, they are routed
17265 independently; this setting does not become attached to them.
17266
17267
17268
17269 .option router_home_directory routers string&!! unset
17270 .cindex "router" "home directory for"
17271 .cindex "home directory" "for router"
17272 .vindex "&$home$&"
17273 This option sets a home directory for use while the router is running. (Compare
17274 &%transport_home_directory%&, which sets a home directory for later
17275 transporting.) In particular, if used on a &(redirect)& router, this option
17276 sets a value for &$home$& while a filter is running. The value is expanded;
17277 forced expansion failure causes the option to be ignored &-- other failures
17278 cause the router to defer.
17279
17280 Expansion of &%router_home_directory%& happens immediately after the
17281 &%check_local_user%& test (if configured), before any further expansions take
17282 place.
17283 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17284 are evaluated.)
17285 While the router is running, &%router_home_directory%& overrides the value of
17286 &$home$& that came from &%check_local_user%&.
17287
17288 When a router accepts an address and assigns it to a local transport (including
17289 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17290 delivery), the home directory setting for the transport is taken from the first
17291 of these values that is set:
17292
17293 .ilist
17294 The &%home_directory%& option on the transport;
17295 .next
17296 The &%transport_home_directory%& option on the router;
17297 .next
17298 The password data if &%check_local_user%& is set on the router;
17299 .next
17300 The &%router_home_directory%& option on the router.
17301 .endlist
17302
17303 In other words, &%router_home_directory%& overrides the password data for the
17304 router, but not for the transport.
17305
17306
17307
17308 .option self routers string freeze
17309 .cindex "MX record" "pointing to local host"
17310 .cindex "local host" "MX pointing to"
17311 This option applies to those routers that use a recipient address to find a
17312 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17313 and &(manualroute)& routers.
17314 Certain configurations of the &(queryprogram)& router can also specify a list
17315 of remote hosts.
17316 Usually such routers are configured to send the message to a remote host via an
17317 &(smtp)& transport. The &%self%& option specifies what happens when the first
17318 host on the list turns out to be the local host.
17319 The way in which Exim checks for the local host is described in section
17320 &<<SECTreclocipadd>>&.
17321
17322 Normally this situation indicates either an error in Exim's configuration (for
17323 example, the router should be configured not to process this domain), or an
17324 error in the DNS (for example, the MX should not point to this host). For this
17325 reason, the default action is to log the incident, defer the address, and
17326 freeze the message. The following alternatives are provided for use in special
17327 cases:
17328
17329 .vlist
17330 .vitem &%defer%&
17331 Delivery of the message is tried again later, but the message is not frozen.
17332
17333 .vitem "&%reroute%&: <&'domain'&>"
17334 The domain is changed to the given domain, and the address is passed back to
17335 be reprocessed by the routers. No rewriting of headers takes place. This
17336 behaviour is essentially a redirection.
17337
17338 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17339 The domain is changed to the given domain, and the address is passed back to be
17340 reprocessed by the routers. Any headers that contain the original domain are
17341 rewritten.
17342
17343 .vitem &%pass%&
17344 .oindex "&%more%&"
17345 .vindex "&$self_hostname$&"
17346 The router passes the address to the next router, or to the router named in the
17347 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17348 subsequent routing and delivery, the variable &$self_hostname$& contains the
17349 name of the local host that the router encountered. This can be used to
17350 distinguish between different cases for hosts with multiple names. The
17351 combination
17352 .code
17353 self = pass
17354 no_more
17355 .endd
17356 ensures that only those addresses that routed to the local host are passed on.
17357 Without &%no_more%&, addresses that were declined for other reasons would also
17358 be passed to the next router.
17359
17360 .vitem &%fail%&
17361 Delivery fails and an error report is generated.
17362
17363 .vitem &%send%&
17364 .cindex "local host" "sending to"
17365 The anomaly is ignored and the address is queued for the transport. This
17366 setting should be used with extreme caution. For an &(smtp)& transport, it
17367 makes sense only in cases where the program that is listening on the SMTP port
17368 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17369 different configuration file that handles the domain in another way.
17370 .endlist
17371
17372
17373
17374 .option senders routers&!? "address list&!!" unset
17375 .cindex "router" "checking senders"
17376 If this option is set, the router is skipped unless the message's sender
17377 address matches something on the list.
17378 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17379 are evaluated.
17380
17381 There are issues concerning verification when the running of routers is
17382 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17383 setting, it sets the sender to the null string. When using the &%-bt%& option
17384 to check a configuration file, it is necessary also to use the &%-f%& option to
17385 set an appropriate sender. For incoming mail, the sender is unset when
17386 verifying the sender, but is available when verifying any recipients. If the
17387 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17388 matters.
17389
17390
17391 .option translate_ip_address routers string&!! unset
17392 .cindex "IP address" "translating"
17393 .cindex "packet radio"
17394 .cindex "router" "IP address translation"
17395 There exist some rare networking situations (for example, packet radio) where
17396 it is helpful to be able to translate IP addresses generated by normal routing
17397 mechanisms into other IP addresses, thus performing a kind of manual IP
17398 routing. This should be done only if the normal IP routing of the TCP/IP stack
17399 is inadequate or broken. Because this is an extremely uncommon requirement, the
17400 code to support this option is not included in the Exim binary unless
17401 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17402
17403 .vindex "&$host_address$&"
17404 The &%translate_ip_address%& string is expanded for every IP address generated
17405 by the router, with the generated address set in &$host_address$&. If the
17406 expansion is forced to fail, no action is taken.
17407 For any other expansion error, delivery of the message is deferred.
17408 If the result of the expansion is an IP address, that replaces the original
17409 address; otherwise the result is assumed to be a host name &-- this is looked
17410 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17411 produce one or more replacement IP addresses. For example, to subvert all IP
17412 addresses in some specific networks, this could be added to a router:
17413 .code
17414 translate_ip_address = \
17415   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17416     {$value}fail}}
17417 .endd
17418 The file would contain lines like
17419 .code
17420 10.2.3.128/26    some.host
17421 10.8.4.34/26     10.44.8.15
17422 .endd
17423 You should not make use of this facility unless you really understand what you
17424 are doing.
17425
17426
17427
17428 .option transport routers string&!! unset
17429 This option specifies the transport to be used when a router accepts an address
17430 and sets it up for delivery. A transport is never needed if a router is used
17431 only for verification. The value of the option is expanded at routing time,
17432 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17433 and result must be the name of one of the configured transports. If it is not,
17434 delivery is deferred.
17435
17436 The &%transport%& option is not used by the &(redirect)& router, but it does
17437 have some private options that set up transports for pipe and file deliveries
17438 (see chapter &<<CHAPredirect>>&).
17439
17440
17441
17442 .option transport_current_directory routers string&!! unset
17443 .cindex "current directory for local transport"
17444 This option associates a current directory with any address that is routed
17445 to a local transport. This can happen either because a transport is
17446 explicitly configured for the router, or because it generates a delivery to a
17447 file or a pipe. During the delivery process (that is, at transport time), this
17448 option string is expanded and is set as the current directory, unless
17449 overridden by a setting on the transport.
17450 If the expansion fails for any reason, including forced failure, an error is
17451 logged, and delivery is deferred.
17452 See chapter &<<CHAPenvironment>>& for details of the local delivery
17453 environment.
17454
17455
17456
17457
17458 .option transport_home_directory routers string&!! "see below"
17459 .cindex "home directory" "for local transport"
17460 This option associates a home directory with any address that is routed to a
17461 local transport. This can happen either because a transport is explicitly
17462 configured for the router, or because it generates a delivery to a file or a
17463 pipe. During the delivery process (that is, at transport time), the option
17464 string is expanded and is set as the home directory, unless overridden by a
17465 setting of &%home_directory%& on the transport.
17466 If the expansion fails for any reason, including forced failure, an error is
17467 logged, and delivery is deferred.
17468
17469 If the transport does not specify a home directory, and
17470 &%transport_home_directory%& is not set for the router, the home directory for
17471 the transport is taken from the password data if &%check_local_user%& is set for
17472 the router. Otherwise it is taken from &%router_home_directory%& if that option
17473 is set; if not, no home directory is set for the transport.
17474
17475 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17476 environment.
17477
17478
17479
17480
17481 .option unseen routers boolean&!! false
17482 .cindex "router" "carrying on after success"
17483 The result of string expansion for this option must be a valid boolean value,
17484 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17485 result causes an error, and delivery is deferred. If the expansion is forced to
17486 fail, the default value for the option (false) is used. Other failures cause
17487 delivery to be deferred.
17488
17489 When this option is set true, routing does not cease if the router accepts the
17490 address. Instead, a copy of the incoming address is passed to the next router,
17491 overriding a false setting of &%more%&. There is little point in setting
17492 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17493 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17494 sometimes true and sometimes false).
17495
17496 .cindex "copy of message (&%unseen%& option)"
17497 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17498 qualifier in filter files. It can be used to cause copies of messages to be
17499 delivered to some other destination, while also carrying out a normal delivery.
17500 In effect, the current address is made into a &"parent"& that has two children
17501 &-- one that is delivered as specified by this router, and a clone that goes on
17502 to be routed further. For this reason, &%unseen%& may not be combined with the
17503 &%one_time%& option in a &(redirect)& router.
17504
17505 &*Warning*&: Header lines added to the address (or specified for removal) by
17506 this router or by previous routers affect the &"unseen"& copy of the message
17507 only. The clone that continues to be processed by further routers starts with
17508 no added headers and none specified for removal. For a &%redirect%& router, if
17509 a generated address is the same as the incoming address, this can lead to
17510 duplicate addresses with different header modifications. Exim does not do
17511 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17512 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17513 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17514 &%redirect%& router may be of help.
17515
17516 Unlike the handling of header modifications, any data that was set by the
17517 &%address_data%& option in the current or previous routers &'is'& passed on to
17518 subsequent routers.
17519
17520
17521 .option user routers string&!! "see below"
17522 .cindex "uid (user id)" "local delivery"
17523 .cindex "local transports" "uid and gid"
17524 .cindex "transport" "local"
17525 .cindex "router" "user for filter processing"
17526 .cindex "filter" "user for processing"
17527 When a router queues an address for a transport, and the transport does not
17528 specify a user, the user given here is used when running the delivery process.
17529 The user may be specified numerically or by name. If expansion fails, the
17530 error is logged and delivery is deferred.
17531 This user is also used by the &(redirect)& router when running a filter file.
17532 The default is unset, except when &%check_local_user%& is set. In this case,
17533 the default is taken from the password information. If the user is specified as
17534 a name, and &%group%& is not set, the group associated with the user is used.
17535 See also &%initgroups%& and &%group%& and the discussion in chapter
17536 &<<CHAPenvironment>>&.
17537
17538
17539
17540 .option verify routers&!? boolean true
17541 Setting this option has the effect of setting &%verify_sender%& and
17542 &%verify_recipient%& to the same value.
17543
17544
17545 .option verify_only routers&!? boolean false
17546 .cindex "EXPN" "with &%verify_only%&"
17547 .oindex "&%-bv%&"
17548 .cindex "router" "used only when verifying"
17549 If this option is set, the router is used only when verifying an address,
17550 delivering in cutthrough mode or
17551 testing with the &%-bv%& option, not when actually doing a delivery, testing
17552 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17553 restricted to verifying only senders or recipients by means of
17554 &%verify_sender%& and &%verify_recipient%&.
17555
17556 &*Warning*&: When the router is being run to verify addresses for an incoming
17557 SMTP message, Exim is not running as root, but under its own uid. If the router
17558 accesses any files, you need to make sure that they are accessible to the Exim
17559 user or group.
17560
17561
17562 .option verify_recipient routers&!? boolean true
17563 If this option is false, the router is skipped when verifying recipient
17564 addresses,
17565 delivering in cutthrough mode
17566 or testing recipient verification using &%-bv%&.
17567 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17568 are evaluated.
17569
17570
17571 .option verify_sender routers&!? boolean true
17572 If this option is false, the router is skipped when verifying sender addresses
17573 or testing sender verification using &%-bvs%&.
17574 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17575 are evaluated.
17576 .ecindex IIDgenoprou1
17577 .ecindex IIDgenoprou2
17578
17579
17580
17581
17582
17583
17584 . ////////////////////////////////////////////////////////////////////////////
17585 . ////////////////////////////////////////////////////////////////////////////
17586
17587 .chapter "The accept router" "CHID4"
17588 .cindex "&(accept)& router"
17589 .cindex "routers" "&(accept)&"
17590 The &(accept)& router has no private options of its own. Unless it is being
17591 used purely for verification (see &%verify_only%&) a transport is required to
17592 be defined by the generic &%transport%& option. If the preconditions that are
17593 specified by generic options are met, the router accepts the address and queues
17594 it for the given transport. The most common use of this router is for setting
17595 up deliveries to local mailboxes. For example:
17596 .code
17597 localusers:
17598   driver = accept
17599   domains = mydomain.example
17600   check_local_user
17601   transport = local_delivery
17602 .endd
17603 The &%domains%& condition in this example checks the domain of the address, and
17604 &%check_local_user%& checks that the local part is the login of a local user.
17605 When both preconditions are met, the &(accept)& router runs, and queues the
17606 address for the &(local_delivery)& transport.
17607
17608
17609
17610
17611
17612
17613 . ////////////////////////////////////////////////////////////////////////////
17614 . ////////////////////////////////////////////////////////////////////////////
17615
17616 .chapter "The dnslookup router" "CHAPdnslookup"
17617 .scindex IIDdnsrou1 "&(dnslookup)& router"
17618 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17619 The &(dnslookup)& router looks up the hosts that handle mail for the
17620 recipient's domain in the DNS. A transport must always be set for this router,
17621 unless &%verify_only%& is set.
17622
17623 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17624 SRV records. If none are found, or if SRV support is not configured,
17625 MX records are looked up. If no MX records exist, address records are sought.
17626 However, &%mx_domains%& can be set to disable the direct use of address
17627 records.
17628
17629 MX records of equal priority are sorted by Exim into a random order. Exim then
17630 looks for address records for the host names obtained from MX or SRV records.
17631 When a host has more than one IP address, they are sorted into a random order,
17632 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17633 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17634 generic option, the router declines.
17635
17636 Unless they have the highest priority (lowest MX value), MX records that point
17637 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17638 are discarded, together with any other MX records of equal or lower priority.
17639
17640 .cindex "MX record" "pointing to local host"
17641 .cindex "local host" "MX pointing to"
17642 .oindex "&%self%&" "in &(dnslookup)& router"
17643 If the host pointed to by the highest priority MX record, or looked up as an
17644 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17645 happens is controlled by the generic &%self%& option.
17646
17647
17648 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17649 There have been problems with DNS servers when SRV records are looked up.
17650 Some mis-behaving servers return a DNS error or timeout when a non-existent
17651 SRV record is sought. Similar problems have in the past been reported for
17652 MX records. The global &%dns_again_means_nonexist%& option can help with this
17653 problem, but it is heavy-handed because it is a global option.
17654
17655 For this reason, there are two options, &%srv_fail_domains%& and
17656 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17657 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17658 an attempt to look up an SRV or MX record causes one of these results, and the
17659 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17660 such record"&. In the case of an SRV lookup, this means that the router
17661 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17662 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17663 case routing fails.
17664
17665
17666 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17667 .cindex "&(dnslookup)& router" "declines"
17668 There are a few cases where a &(dnslookup)& router will decline to accept
17669 an address; if such a router is expected to handle "all remaining non-local
17670 domains", then it is important to set &%no_more%&.
17671
17672 Reasons for a &(dnslookup)& router to decline currently include:
17673 .ilist
17674 The domain does not exist in DNS
17675 .next
17676 The domain exists but the MX record's host part is just "."; this is a common
17677 convention (borrowed from SRV) used to indicate that there is no such service
17678 for this domain and to not fall back to trying A/AAAA records.
17679 .next
17680 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17681 .next
17682 MX record points to a non-existent host.
17683 .next
17684 MX record points to an IP address and the main section option
17685 &%allow_mx_to_ip%& is not set.
17686 .next
17687 MX records exist and point to valid hosts, but all hosts resolve only to
17688 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17689 .next
17690 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17691 &%dns_check_names_pattern%& for handling one variant of this)
17692 .next
17693 &%check_secondary_mx%& is set on this router but the local host can
17694 not be found in the MX records (see below)
17695 .endlist
17696
17697
17698
17699
17700 .section "Private options for dnslookup" "SECID118"
17701 .cindex "options" "&(dnslookup)& router"
17702 The private options for the &(dnslookup)& router are as follows:
17703
17704 .option check_secondary_mx dnslookup boolean false
17705 .cindex "MX record" "checking for secondary"
17706 If this option is set, the router declines unless the local host is found in
17707 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17708 process domains for which the local host is a secondary mail exchanger
17709 differently to other domains. The way in which Exim decides whether a host is
17710 the local host is described in section &<<SECTreclocipadd>>&.
17711
17712
17713 .option check_srv dnslookup string&!! unset
17714 .cindex "SRV record" "enabling use of"
17715 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17716 addition to MX and address records. The support is disabled by default. To
17717 enable SRV support, set the &%check_srv%& option to the name of the service
17718 required. For example,
17719 .code
17720 check_srv = smtp
17721 .endd
17722 looks for SRV records that refer to the normal smtp service. The option is
17723 expanded, so the service name can vary from message to message or address
17724 to address. This might be helpful if SRV records are being used for a
17725 submission service. If the expansion is forced to fail, the &%check_srv%&
17726 option is ignored, and the router proceeds to look for MX records in the
17727 normal way.
17728
17729 When the expansion succeeds, the router searches first for SRV records for
17730 the given service (it assumes TCP protocol). A single SRV record with a
17731 host name that consists of just a single dot indicates &"no such service for
17732 this domain"&; if this is encountered, the router declines. If other kinds of
17733 SRV record are found, they are used to construct a host list for delivery
17734 according to the rules of RFC 2782. MX records are not sought in this case.
17735
17736 When no SRV records are found, MX records (and address records) are sought in
17737 the traditional way. In other words, SRV records take precedence over MX
17738 records, just as MX records take precedence over address records. Note that
17739 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17740 defined it. It is apparently believed that MX records are sufficient for email
17741 and that SRV records should not be used for this purpose. However, SRV records
17742 have an additional &"weight"& feature which some people might find useful when
17743 trying to split an SMTP load between hosts of different power.
17744
17745 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17746 when there is a DNS lookup error.
17747
17748
17749
17750 .new
17751 .option dnssec_request_domains dnslookup "domain list&!!" unset
17752 .cindex "MX record" "security"
17753 .cindex "DNSSEC" "MX lookup"
17754 .cindex "security" "MX lookup"
17755 .cindex "DNS" "DNSSEC"
17756 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17757 the dnssec request bit set.
17758 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
17759 .wen
17760
17761
17762
17763 .new
17764 .option dnssec_require_domains dnslookup "domain list&!!" unset
17765 .cindex "MX record" "security"
17766 .cindex "DNSSEC" "MX lookup"
17767 .cindex "security" "MX lookup"
17768 .cindex "DNS" "DNSSEC"
17769 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17770 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17771 (AD bit) set wil be ignored and logged as a host-lookup failure.
17772 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
17773 .wen
17774
17775
17776
17777 .option mx_domains dnslookup "domain list&!!" unset
17778 .cindex "MX record" "required to exist"
17779 .cindex "SRV record" "required to exist"
17780 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17781 record in order to be recognized. (The name of this option could be improved.)
17782 For example, if all the mail hosts in &'fict.example'& are known to have MX
17783 records, except for those in &'discworld.fict.example'&, you could use this
17784 setting:
17785 .code
17786 mx_domains = ! *.discworld.fict.example : *.fict.example
17787 .endd
17788 This specifies that messages addressed to a domain that matches the list but
17789 has no MX record should be bounced immediately instead of being routed using
17790 the address record.
17791
17792
17793 .option mx_fail_domains dnslookup "domain list&!!" unset
17794 If the DNS lookup for MX records for one of the domains in this list causes a
17795 DNS lookup error, Exim behaves as if no MX records were found. See section
17796 &<<SECTprowitdnsloo>>& for more discussion.
17797
17798
17799
17800
17801 .option qualify_single dnslookup boolean true
17802 .cindex "DNS" "resolver options"
17803 .cindex "DNS" "qualifying single-component names"
17804 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17805 lookups. Typically, but not standardly, this causes the resolver to qualify
17806 single-component names with the default domain. For example, on a machine
17807 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17808 &'thesaurus.ref.example'& inside the resolver. For details of what your
17809 resolver actually does, consult your man pages for &'resolver'& and
17810 &'resolv.conf'&.
17811
17812
17813
17814 .option rewrite_headers dnslookup boolean true
17815 .cindex "rewriting" "header lines"
17816 .cindex "header lines" "rewriting"
17817 If the domain name in the address that is being processed is not fully
17818 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17819 an address is specified as &'dormouse@teaparty'&, the domain might be
17820 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17821 occur as a result of setting the &%widen_domains%& option. If
17822 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17823 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17824 header lines of the message are rewritten with the full domain name.
17825
17826 This option should be turned off only when it is known that no message is
17827 ever going to be sent outside an environment where the abbreviation makes
17828 sense.
17829
17830 When an MX record is looked up in the DNS and matches a wildcard record, name
17831 servers normally return a record containing the name that has been looked up,
17832 making it impossible to detect whether a wildcard was present or not. However,
17833 some name servers have recently been seen to return the wildcard entry. If the
17834 name returned by a DNS lookup begins with an asterisk, it is not used for
17835 header rewriting.
17836
17837
17838 .option same_domain_copy_routing dnslookup boolean false
17839 .cindex "address" "copying routing"
17840 Addresses with the same domain are normally routed by the &(dnslookup)& router
17841 to the same list of hosts. However, this cannot be presumed, because the router
17842 options and preconditions may refer to the local part of the address. By
17843 default, therefore, Exim routes each address in a message independently. DNS
17844 servers run caches, so repeated DNS lookups are not normally expensive, and in
17845 any case, personal messages rarely have more than a few recipients.
17846
17847 If you are running mailing lists with large numbers of subscribers at the same
17848 domain, and you are using a &(dnslookup)& router which is independent of the
17849 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17850 lookups for identical domains in one message. In this case, when &(dnslookup)&
17851 routes an address to a remote transport, any other unrouted addresses in the
17852 message that have the same domain are automatically given the same routing
17853 without processing them independently,
17854 provided the following conditions are met:
17855
17856 .ilist
17857 No router that processed the address specified &%headers_add%& or
17858 &%headers_remove%&.
17859 .next
17860 The router did not change the address in any way, for example, by &"widening"&
17861 the domain.
17862 .endlist
17863
17864
17865
17866
17867 .option search_parents dnslookup boolean false
17868 .cindex "DNS" "resolver options"
17869 When this option is true, the resolver option RES_DNSRCH is set for DNS
17870 lookups. This is different from the &%qualify_single%& option in that it
17871 applies to domains containing dots. Typically, but not standardly, it causes
17872 the resolver to search for the name in the current domain and in parent
17873 domains. For example, on a machine in the &'fict.example'& domain, if looking
17874 up &'teaparty.wonderland'& failed, the resolver would try
17875 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17876 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17877
17878 Setting this option true can cause problems in domains that have a wildcard MX
17879 record, because any domain that does not have its own MX record matches the
17880 local wildcard.
17881
17882
17883
17884 .option srv_fail_domains dnslookup "domain list&!!" unset
17885 If the DNS lookup for SRV records for one of the domains in this list causes a
17886 DNS lookup error, Exim behaves as if no SRV records were found. See section
17887 &<<SECTprowitdnsloo>>& for more discussion.
17888
17889
17890
17891
17892 .option widen_domains dnslookup "string list" unset
17893 .cindex "domain" "partial; widening"
17894 If a DNS lookup fails and this option is set, each of its strings in turn is
17895 added onto the end of the domain, and the lookup is tried again. For example,
17896 if
17897 .code
17898 widen_domains = fict.example:ref.example
17899 .endd
17900 is set and a lookup of &'klingon.dictionary'& fails,
17901 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17902 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17903 and &%search_parents%& options can cause some widening to be undertaken inside
17904 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17905 when verifying, unless &%rewrite_headers%& is false (not the default).
17906
17907
17908 .section "Effect of qualify_single and search_parents" "SECID119"
17909 When a domain from an envelope recipient is changed by the resolver as a result
17910 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17911 corresponding address in the message's header lines unless &%rewrite_headers%&
17912 is set false. Exim then re-routes the address, using the full domain.
17913
17914 These two options affect only the DNS lookup that takes place inside the router
17915 for the domain of the address that is being routed. They do not affect lookups
17916 such as that implied by
17917 .code
17918 domains = @mx_any
17919 .endd
17920 that may happen while processing a router precondition before the router is
17921 entered. No widening ever takes place for these lookups.
17922 .ecindex IIDdnsrou1
17923 .ecindex IIDdnsrou2
17924
17925
17926
17927
17928
17929
17930
17931
17932
17933 . ////////////////////////////////////////////////////////////////////////////
17934 . ////////////////////////////////////////////////////////////////////////////
17935
17936 .chapter "The ipliteral router" "CHID5"
17937 .cindex "&(ipliteral)& router"
17938 .cindex "domain literal" "routing"
17939 .cindex "routers" "&(ipliteral)&"
17940 This router has no private options. Unless it is being used purely for
17941 verification (see &%verify_only%&) a transport is required to be defined by the
17942 generic &%transport%& option. The router accepts the address if its domain part
17943 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17944 router handles the address
17945 .code
17946 root@[192.168.1.1]
17947 .endd
17948 by setting up delivery to the host with that IP address. IPv4 domain literals
17949 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17950 are similar, but the address is preceded by &`ipv6:`&. For example:
17951 .code
17952 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17953 .endd
17954 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17955 grounds that sooner or later somebody will try it.
17956
17957 .oindex "&%self%&" "in &(ipliteral)& router"
17958 If the IP address matches something in &%ignore_target_hosts%&, the router
17959 declines. If an IP literal turns out to refer to the local host, the generic
17960 &%self%& option determines what happens.
17961
17962 The RFCs require support for domain literals; however, their use is
17963 controversial in today's Internet. If you want to use this router, you must
17964 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17965 Exim will not recognize the domain literal syntax in addresses.
17966
17967
17968
17969 . ////////////////////////////////////////////////////////////////////////////
17970 . ////////////////////////////////////////////////////////////////////////////
17971
17972 .chapter "The iplookup router" "CHID6"
17973 .cindex "&(iplookup)& router"
17974 .cindex "routers" "&(iplookup)&"
17975 The &(iplookup)& router was written to fulfil a specific requirement in
17976 Cambridge University (which in fact no longer exists). For this reason, it is
17977 not included in the binary of Exim by default. If you want to include it, you
17978 must set
17979 .code
17980 ROUTER_IPLOOKUP=yes
17981 .endd
17982 in your &_Local/Makefile_& configuration file.
17983
17984 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17985 connection to one or more specific hosts. The host can then return the same or
17986 a different address &-- in effect rewriting the recipient address in the
17987 message's envelope. The new address is then passed on to subsequent routers. If
17988 this process fails, the address can be passed on to other routers, or delivery
17989 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17990 must not be specified for it.
17991
17992 .cindex "options" "&(iplookup)& router"
17993 .option hosts iplookup string unset
17994 This option must be supplied. Its value is a colon-separated list of host
17995 names. The hosts are looked up using &[gethostbyname()]&
17996 (or &[getipnodebyname()]& when available)
17997 and are tried in order until one responds to the query. If none respond, what
17998 happens is controlled by &%optional%&.
17999
18000
18001 .option optional iplookup boolean false
18002 If &%optional%& is true, if no response is obtained from any host, the address
18003 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18004 delivery to the address is deferred.
18005
18006
18007 .option port iplookup integer 0
18008 .cindex "port" "&(iplookup)& router"
18009 This option must be supplied. It specifies the port number for the TCP or UDP
18010 call.
18011
18012
18013 .option protocol iplookup string udp
18014 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18015 protocols is to be used.
18016
18017
18018 .option query iplookup string&!! "see below"
18019 This defines the content of the query that is sent to the remote hosts. The
18020 default value is:
18021 .code
18022 $local_part@$domain $local_part@$domain
18023 .endd
18024 The repetition serves as a way of checking that a response is to the correct
18025 query in the default case (see &%response_pattern%& below).
18026
18027
18028 .option reroute iplookup string&!! unset
18029 If this option is not set, the rerouted address is precisely the byte string
18030 returned by the remote host, up to the first white space, if any. If set, the
18031 string is expanded to form the rerouted address. It can include parts matched
18032 in the response by &%response_pattern%& by means of numeric variables such as
18033 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18034 whether or not a pattern is in use. In all cases, the rerouted address must end
18035 up in the form &'local_part@domain'&.
18036
18037
18038 .option response_pattern iplookup string unset
18039 This option can be set to a regular expression that is applied to the string
18040 returned from the remote host. If the pattern does not match the response, the
18041 router declines. If &%response_pattern%& is not set, no checking of the
18042 response is done, unless the query was defaulted, in which case there is a
18043 check that the text returned after the first white space is the original
18044 address. This checks that the answer that has been received is in response to
18045 the correct question. For example, if the response is just a new domain, the
18046 following could be used:
18047 .code
18048 response_pattern = ^([^@]+)$
18049 reroute = $local_part@$1
18050 .endd
18051
18052 .option timeout iplookup time 5s
18053 This specifies the amount of time to wait for a response from the remote
18054 machine. The same timeout is used for the &[connect()]& function for a TCP
18055 call. It does not apply to UDP.
18056
18057
18058
18059
18060 . ////////////////////////////////////////////////////////////////////////////
18061 . ////////////////////////////////////////////////////////////////////////////
18062
18063 .chapter "The manualroute router" "CHID7"
18064 .scindex IIDmanrou1 "&(manualroute)& router"
18065 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18066 .cindex "domain" "manually routing"
18067 The &(manualroute)& router is so-called because it provides a way of manually
18068 routing an address according to its domain. It is mainly used when you want to
18069 route addresses to remote hosts according to your own rules, bypassing the
18070 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18071 route to local transports, a facility that may be useful if you want to save
18072 messages for dial-in hosts in local files.
18073
18074 The &(manualroute)& router compares a list of domain patterns with the domain
18075 it is trying to route. If there is no match, the router declines. Each pattern
18076 has associated with it a list of hosts and some other optional data, which may
18077 include a transport. The combination of a pattern and its data is called a
18078 &"routing rule"&. For patterns that do not have an associated transport, the
18079 generic &%transport%& option must specify a transport, unless the router is
18080 being used purely for verification (see &%verify_only%&).
18081
18082 .vindex "&$host$&"
18083 In the case of verification, matching the domain pattern is sufficient for the
18084 router to accept the address. When actually routing an address for delivery,
18085 an address that matches a domain pattern is queued for the associated
18086 transport. If the transport is not a local one, a host list must be associated
18087 with the pattern; IP addresses are looked up for the hosts, and these are
18088 passed to the transport along with the mail address. For local transports, a
18089 host list is optional. If it is present, it is passed in &$host$& as a single
18090 text string.
18091
18092 The list of routing rules can be provided as an inline string in
18093 &%route_list%&, or the data can be obtained by looking up the domain in a file
18094 or database by setting &%route_data%&. Only one of these settings may appear in
18095 any one instance of &(manualroute)&. The format of routing rules is described
18096 below, following the list of private options.
18097
18098
18099 .section "Private options for manualroute" "SECTprioptman"
18100
18101 .cindex "options" "&(manualroute)& router"
18102 The private options for the &(manualroute)& router are as follows:
18103
18104 .option host_all_ignored manualroute string defer
18105 See &%host_find_failed%&.
18106
18107 .option host_find_failed manualroute string freeze
18108 This option controls what happens when &(manualroute)& tries to find an IP
18109 address for a host, and the host does not exist. The option can be set to one
18110 of the following values:
18111 .code
18112 decline
18113 defer
18114 fail
18115 freeze
18116 ignore
18117 pass
18118 .endd
18119 The default (&"freeze"&) assumes that this state is a serious configuration
18120 error. The difference between &"pass"& and &"decline"& is that the former
18121 forces the address to be passed to the next router (or the router defined by
18122 &%pass_router%&),
18123 .oindex "&%more%&"
18124 overriding &%no_more%&, whereas the latter passes the address to the next
18125 router only if &%more%& is true.
18126
18127 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18128 cannot be found. If all the hosts in the list are ignored, the behaviour is
18129 controlled by the &%host_all_ignored%& option. This takes the same values
18130 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18131
18132 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18133 state; if a host lookup gets a temporary error, delivery is deferred unless the
18134 generic &%pass_on_timeout%& option is set.
18135
18136
18137 .option hosts_randomize manualroute boolean false
18138 .cindex "randomized host list"
18139 .cindex "host" "list of; randomized"
18140 If this option is set, the order of the items in a host list in a routing rule
18141 is randomized each time the list is used, unless an option in the routing rule
18142 overrides (see below). Randomizing the order of a host list can be used to do
18143 crude load sharing. However, if more than one mail address is routed by the
18144 same router to the same host list, the host lists are considered to be the same
18145 (even though they may be randomized into different orders) for the purpose of
18146 deciding whether to batch the deliveries into a single SMTP transaction.
18147
18148 When &%hosts_randomize%& is true, a host list may be split
18149 into groups whose order is separately randomized. This makes it possible to
18150 set up MX-like behaviour. The boundaries between groups are indicated by an
18151 item that is just &`+`& in the host list. For example:
18152 .code
18153 route_list = * host1:host2:host3:+:host4:host5
18154 .endd
18155 The order of the first three hosts and the order of the last two hosts is
18156 randomized for each use, but the first three always end up before the last two.
18157 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18158 randomized host list is passed to an &(smtp)& transport that also has
18159 &%hosts_randomize set%&, the list is not re-randomized.
18160
18161
18162 .option route_data manualroute string&!! unset
18163 If this option is set, it must expand to yield the data part of a routing rule.
18164 Typically, the expansion string includes a lookup based on the domain. For
18165 example:
18166 .code
18167 route_data = ${lookup{$domain}dbm{/etc/routes}}
18168 .endd
18169 If the expansion is forced to fail, or the result is an empty string, the
18170 router declines. Other kinds of expansion failure cause delivery to be
18171 deferred.
18172
18173
18174 .option route_list manualroute "string list" unset
18175 This string is a list of routing rules, in the form defined below. Note that,
18176 unlike most string lists, the items are separated by semicolons. This is so
18177 that they may contain colon-separated host lists.
18178
18179
18180 .option same_domain_copy_routing manualroute boolean false
18181 .cindex "address" "copying routing"
18182 Addresses with the same domain are normally routed by the &(manualroute)&
18183 router to the same list of hosts. However, this cannot be presumed, because the
18184 router options and preconditions may refer to the local part of the address. By
18185 default, therefore, Exim routes each address in a message independently. DNS
18186 servers run caches, so repeated DNS lookups are not normally expensive, and in
18187 any case, personal messages rarely have more than a few recipients.
18188
18189 If you are running mailing lists with large numbers of subscribers at the same
18190 domain, and you are using a &(manualroute)& router which is independent of the
18191 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18192 lookups for identical domains in one message. In this case, when
18193 &(manualroute)& routes an address to a remote transport, any other unrouted
18194 addresses in the message that have the same domain are automatically given the
18195 same routing without processing them independently. However, this is only done
18196 if &%headers_add%& and &%headers_remove%& are unset.
18197
18198
18199
18200
18201 .section "Routing rules in route_list" "SECID120"
18202 The value of &%route_list%& is a string consisting of a sequence of routing
18203 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18204 entered as two semicolons. Alternatively, the list separator can be changed as
18205 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18206 Empty rules are ignored. The format of each rule is
18207 .display
18208 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18209 .endd
18210 The following example contains two rules, each with a simple domain pattern and
18211 no options:
18212 .code
18213 route_list = \
18214   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18215   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18216 .endd
18217 The three parts of a rule are separated by white space. The pattern and the
18218 list of hosts can be enclosed in quotes if necessary, and if they are, the
18219 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18220 single domain pattern, which is the only mandatory item in the rule. The
18221 pattern is in the same format as one item in a domain list (see section
18222 &<<SECTdomainlist>>&),
18223 except that it may not be the name of an interpolated file.
18224 That is, it may be wildcarded, or a regular expression, or a file or database
18225 lookup (with semicolons doubled, because of the use of semicolon as a separator
18226 in a &%route_list%&).
18227
18228 The rules in &%route_list%& are searched in order until one of the patterns
18229 matches the domain that is being routed. The list of hosts and then options are
18230 then used as described below. If there is no match, the router declines. When
18231 &%route_list%& is set, &%route_data%& must not be set.
18232
18233
18234
18235 .section "Routing rules in route_data" "SECID121"
18236 The use of &%route_list%& is convenient when there are only a small number of
18237 routing rules. For larger numbers, it is easier to use a file or database to
18238 hold the routing information, and use the &%route_data%& option instead.
18239 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18240 Most commonly, &%route_data%& is set as a string that contains an
18241 expansion lookup. For example, suppose we place two routing rules in a file
18242 like this:
18243 .code
18244 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18245 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18246 .endd
18247 This data can be accessed by setting
18248 .code
18249 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18250 .endd
18251 Failure of the lookup results in an empty string, causing the router to
18252 decline. However, you do not have to use a lookup in &%route_data%&. The only
18253 requirement is that the result of expanding the string is a list of hosts,
18254 possibly followed by options, separated by white space. The list of hosts must
18255 be enclosed in quotes if it contains white space.
18256
18257
18258
18259
18260 .section "Format of the list of hosts" "SECID122"
18261 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18262 always separately expanded before use. If the expansion fails, the router
18263 declines. The result of the expansion must be a colon-separated list of names
18264 and/or IP addresses, optionally also including ports. The format of each item
18265 in the list is described in the next section. The list separator can be changed
18266 as described in section &<<SECTlistconstruct>>&.
18267
18268 If the list of hosts was obtained from a &%route_list%& item, the following
18269 variables are set during its expansion:
18270
18271 .ilist
18272 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18273 If the domain was matched against a regular expression, the numeric variables
18274 &$1$&, &$2$&, etc. may be set. For example:
18275 .code
18276 route_list = ^domain(\d+)   host-$1.text.example
18277 .endd
18278 .next
18279 &$0$& is always set to the entire domain.
18280 .next
18281 &$1$& is also set when partial matching is done in a file lookup.
18282
18283 .next
18284 .vindex "&$value$&"
18285 If the pattern that matched the domain was a lookup item, the data that was
18286 looked up is available in the expansion variable &$value$&. For example:
18287 .code
18288 route_list = lsearch;;/some/file.routes  $value
18289 .endd
18290 .endlist
18291
18292 Note the doubling of the semicolon in the pattern that is necessary because
18293 semicolon is the default route list separator.
18294
18295
18296
18297 .section "Format of one host item" "SECTformatonehostitem"
18298 Each item in the list of hosts is either a host name or an IP address,
18299 optionally with an attached port number. When no port is given, an IP address
18300 is not enclosed in brackets. When a port is specified, it overrides the port
18301 specification on the transport. The port is separated from the name or address
18302 by a colon. This leads to some complications:
18303
18304 .ilist
18305 Because colon is the default separator for the list of hosts, either
18306 the colon that specifies a port must be doubled, or the list separator must
18307 be changed. The following two examples have the same effect:
18308 .code
18309 route_list = * "host1.tld::1225 : host2.tld::1226"
18310 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18311 .endd
18312 .next
18313 When IPv6 addresses are involved, it gets worse, because they contain
18314 colons of their own. To make this case easier, it is permitted to
18315 enclose an IP address (either v4 or v6) in square brackets if a port
18316 number follows. For example:
18317 .code
18318 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18319 .endd
18320 .endlist
18321
18322 .section "How the list of hosts is used" "SECThostshowused"
18323 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18324 the hosts is tried, in the order specified, when carrying out the SMTP
18325 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18326 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18327 transport.
18328
18329 Hosts may be listed by name or by IP address. An unadorned name in the list of
18330 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18331 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18332 records in the DNS. For example:
18333 .code
18334 route_list = *  x.y.z:p.q.r/MX:e.f.g
18335 .endd
18336 If this feature is used with a port specifier, the port must come last. For
18337 example:
18338 .code
18339 route_list = *  dom1.tld/mx::1225
18340 .endd
18341 If the &%hosts_randomize%& option is set, the order of the items in the list is
18342 randomized before any lookups are done. Exim then scans the list; for any name
18343 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18344 be an interface on the local host and the item is not the first in the list,
18345 Exim discards it and any subsequent items. If it is the first item, what
18346 happens is controlled by the
18347 .oindex "&%self%&" "in &(manualroute)& router"
18348 &%self%& option of the router.
18349
18350 A name on the list that is followed by &`/MX`& is replaced with the list of
18351 hosts obtained by looking up MX records for the name. This is always a DNS
18352 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18353 below) are not relevant here. The order of these hosts is determined by the
18354 preference values in the MX records, according to the usual rules. Because
18355 randomizing happens before the MX lookup, it does not affect the order that is
18356 defined by MX preferences.
18357
18358 If the local host is present in the sublist obtained from MX records, but is
18359 not the most preferred host in that list, it and any equally or less
18360 preferred hosts are removed before the sublist is inserted into the main list.
18361
18362 If the local host is the most preferred host in the MX list, what happens
18363 depends on where in the original list of hosts the &`/MX`& item appears. If it
18364 is not the first item (that is, there are previous hosts in the main list),
18365 Exim discards this name and any subsequent items in the main list.
18366
18367 If the MX item is first in the list of hosts, and the local host is the
18368 most preferred host, what happens is controlled by the &%self%& option of the
18369 router.
18370
18371 DNS failures when lookup up the MX records are treated in the same way as DNS
18372 failures when looking up IP addresses: &%pass_on_timeout%& and
18373 &%host_find_failed%& are used when relevant.
18374
18375 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18376 whether obtained from an MX lookup or not.
18377
18378
18379
18380 .section "How the options are used" "SECThowoptused"
18381 The options are a sequence of words; in practice no more than three are ever
18382 present. One of the words can be the name of a transport; this overrides the
18383 &%transport%& option on the router for this particular routing rule only. The
18384 other words (if present) control randomization of the list of hosts on a
18385 per-rule basis, and how the IP addresses of the hosts are to be found when
18386 routing to a remote transport. These options are as follows:
18387
18388 .ilist
18389 &%randomize%&: randomize the order of the hosts in this list, overriding the
18390 setting of &%hosts_randomize%& for this routing rule only.
18391 .next
18392 &%no_randomize%&: do not randomize the order of the hosts in this list,
18393 overriding the setting of &%hosts_randomize%& for this routing rule only.
18394 .next
18395 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18396 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18397 also look in &_/etc/hosts_& or other sources of information.
18398 .next
18399 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18400 no address records are found. If there is a temporary DNS error (such as a
18401 timeout), delivery is deferred.
18402 .endlist
18403
18404 For example:
18405 .code
18406 route_list = domain1  host1:host2:host3  randomize bydns;\
18407              domain2  host4:host5
18408 .endd
18409 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18410 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18411 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18412 or &[gethostbyname()]&, and the result of the lookup is the result of that
18413 call.
18414
18415 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18416 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18417 instead of TRY_AGAIN. That is why the default action is to try a DNS
18418 lookup first. Only if that gives a definite &"no such host"& is the local
18419 function called.
18420
18421
18422
18423 If no IP address for a host can be found, what happens is controlled by the
18424 &%host_find_failed%& option.
18425
18426 .vindex "&$host$&"
18427 When an address is routed to a local transport, IP addresses are not looked up.
18428 The host list is passed to the transport in the &$host$& variable.
18429
18430
18431
18432 .section "Manualroute examples" "SECID123"
18433 In some of the examples that follow, the presence of the &%remote_smtp%&
18434 transport, as defined in the default configuration file, is assumed:
18435
18436 .ilist
18437 .cindex "smart host" "example router"
18438 The &(manualroute)& router can be used to forward all external mail to a
18439 &'smart host'&. If you have set up, in the main part of the configuration, a
18440 named domain list that contains your local domains, for example:
18441 .code
18442 domainlist local_domains = my.domain.example
18443 .endd
18444 You can arrange for all other domains to be routed to a smart host by making
18445 your first router something like this:
18446 .code
18447 smart_route:
18448   driver = manualroute
18449   domains = !+local_domains
18450   transport = remote_smtp
18451   route_list = * smarthost.ref.example
18452 .endd
18453 This causes all non-local addresses to be sent to the single host
18454 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18455 they are tried in order
18456 (but you can use &%hosts_randomize%& to vary the order each time).
18457 Another way of configuring the same thing is this:
18458 .code
18459 smart_route:
18460   driver = manualroute
18461   transport = remote_smtp
18462   route_list = !+local_domains  smarthost.ref.example
18463 .endd
18464 There is no difference in behaviour between these two routers as they stand.
18465 However, they behave differently if &%no_more%& is added to them. In the first
18466 example, the router is skipped if the domain does not match the &%domains%&
18467 precondition; the following router is always tried. If the router runs, it
18468 always matches the domain and so can never decline. Therefore, &%no_more%&
18469 would have no effect. In the second case, the router is never skipped; it
18470 always runs. However, if it doesn't match the domain, it declines. In this case
18471 &%no_more%& would prevent subsequent routers from running.
18472
18473 .next
18474 .cindex "mail hub example"
18475 A &'mail hub'& is a host which receives mail for a number of domains via MX
18476 records in the DNS and delivers it via its own private routing mechanism. Often
18477 the final destinations are behind a firewall, with the mail hub being the one
18478 machine that can connect to machines both inside and outside the firewall. The
18479 &(manualroute)& router is usually used on a mail hub to route incoming messages
18480 to the correct hosts. For a small number of domains, the routing can be inline,
18481 using the &%route_list%& option, but for a larger number a file or database
18482 lookup is easier to manage.
18483
18484 If the domain names are in fact the names of the machines to which the mail is
18485 to be sent by the mail hub, the configuration can be quite simple. For
18486 example:
18487 .code
18488 hub_route:
18489   driver = manualroute
18490   transport = remote_smtp
18491   route_list = *.rhodes.tvs.example  $domain
18492 .endd
18493 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18494 whose names are the same as the mail domains. A similar approach can be taken
18495 if the host name can be obtained from the domain name by a string manipulation
18496 that the expansion facilities can handle. Otherwise, a lookup based on the
18497 domain can be used to find the host:
18498 .code
18499 through_firewall:
18500   driver = manualroute
18501   transport = remote_smtp
18502   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18503 .endd
18504 The result of the lookup must be the name or IP address of the host (or
18505 hosts) to which the address is to be routed. If the lookup fails, the route
18506 data is empty, causing the router to decline. The address then passes to the
18507 next router.
18508
18509 .next
18510 .cindex "batched SMTP output example"
18511 .cindex "SMTP" "batched outgoing; example"
18512 You can use &(manualroute)& to deliver messages to pipes or files in batched
18513 SMTP format for onward transportation by some other means. This is one way of
18514 storing mail for a dial-up host when it is not connected. The route list entry
18515 can be as simple as a single domain name in a configuration like this:
18516 .code
18517 save_in_file:
18518   driver = manualroute
18519   transport = batchsmtp_appendfile
18520   route_list = saved.domain.example
18521 .endd
18522 though often a pattern is used to pick up more than one domain. If there are
18523 several domains or groups of domains with different transport requirements,
18524 different transports can be listed in the routing information:
18525 .code
18526 save_in_file:
18527   driver = manualroute
18528   route_list = \
18529     *.saved.domain1.example  $domain  batch_appendfile; \
18530     *.saved.domain2.example  \
18531       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18532       batch_pipe
18533 .endd
18534 .vindex "&$domain$&"
18535 .vindex "&$host$&"
18536 The first of these just passes the domain in the &$host$& variable, which
18537 doesn't achieve much (since it is also in &$domain$&), but the second does a
18538 file lookup to find a value to pass, causing the router to decline to handle
18539 the address if the lookup fails.
18540
18541 .next
18542 .cindex "UUCP" "example of router for"
18543 Routing mail directly to UUCP software is a specific case of the use of
18544 &(manualroute)& in a gateway to another mail environment. This is an example of
18545 one way it can be done:
18546 .code
18547 # Transport
18548 uucp:
18549   driver = pipe
18550   user = nobody
18551   command = /usr/local/bin/uux -r - \
18552     ${substr_-5:$host}!rmail ${local_part}
18553   return_fail_output = true
18554
18555 # Router
18556 uucphost:
18557   transport = uucp
18558   driver = manualroute
18559   route_data = \
18560     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18561 .endd
18562 The file &_/usr/local/exim/uucphosts_& contains entries like
18563 .code
18564 darksite.ethereal.example:           darksite.UUCP
18565 .endd
18566 It can be set up more simply without adding and removing &".UUCP"& but this way
18567 makes clear the distinction between the domain name
18568 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18569 .endlist
18570 .ecindex IIDmanrou1
18571 .ecindex IIDmanrou2
18572
18573
18574
18575
18576
18577
18578
18579
18580 . ////////////////////////////////////////////////////////////////////////////
18581 . ////////////////////////////////////////////////////////////////////////////
18582
18583 .chapter "The queryprogram router" "CHAPdriverlast"
18584 .scindex IIDquerou1 "&(queryprogram)& router"
18585 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18586 .cindex "routing" "by external program"
18587 The &(queryprogram)& router routes an address by running an external command
18588 and acting on its output. This is an expensive way to route, and is intended
18589 mainly for use in lightly-loaded systems, or for performing experiments.
18590 However, if it is possible to use the precondition options (&%domains%&,
18591 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18592 be used in special cases, even on a busy host. There are the following private
18593 options:
18594 .cindex "options" "&(queryprogram)& router"
18595
18596 .option command queryprogram string&!! unset
18597 This option must be set. It specifies the command that is to be run. The
18598 command is split up into a command name and arguments, and then each is
18599 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18600 &<<CHAPpipetransport>>&).
18601
18602
18603 .option command_group queryprogram string unset
18604 .cindex "gid (group id)" "in &(queryprogram)& router"
18605 This option specifies a gid to be set when running the command while routing an
18606 address for deliver. It must be set if &%command_user%& specifies a numerical
18607 uid. If it begins with a digit, it is interpreted as the numerical value of the
18608 gid. Otherwise it is looked up using &[getgrnam()]&.
18609
18610
18611 .option command_user queryprogram string unset
18612 .cindex "uid (user id)" "for &(queryprogram)&"
18613 This option must be set. It specifies the uid which is set when running the
18614 command while routing an address for delivery. If the value begins with a digit,
18615 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18616 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18617 not set, a value for the gid also.
18618
18619 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18620 root, which it does during a normal delivery in a conventional configuration.
18621 However, when an address is being verified during message reception, Exim is
18622 usually running as the Exim user, not as root. If the &(queryprogram)& router
18623 is called from a non-root process, Exim cannot change uid or gid before running
18624 the command. In this circumstance the command runs under the current uid and
18625 gid.
18626
18627
18628 .option current_directory queryprogram string /
18629 This option specifies an absolute path which is made the current directory
18630 before running the command.
18631
18632
18633 .option timeout queryprogram time 1h
18634 If the command does not complete within the timeout period, its process group
18635 is killed and the message is frozen. A value of zero time specifies no
18636 timeout.
18637
18638
18639 The standard output of the command is connected to a pipe, which is read when
18640 the command terminates. It should consist of a single line of output,
18641 containing up to five fields, separated by white space. The maximum length of
18642 the line is 1023 characters. Longer lines are silently truncated. The first
18643 field is one of the following words (case-insensitive):
18644
18645 .ilist
18646 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18647 below).
18648 .next
18649 &'Decline'&: the router declines; pass the address to the next router, unless
18650 &%no_more%& is set.
18651 .next
18652 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18653 subsequent text on the line is an error message. If the router is run as part
18654 of address verification during an incoming SMTP message, the message is
18655 included in the SMTP response.
18656 .next
18657 &'Defer'&: routing could not be completed at this time; try again later. Any
18658 subsequent text on the line is an error message which is logged. It is not
18659 included in any SMTP response.
18660 .next
18661 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18662 .next
18663 &'Pass'&: pass the address to the next router (or the router specified by
18664 &%pass_router%&), overriding &%no_more%&.
18665 .next
18666 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18667 new addresses, which are routed independently, starting with the first router,
18668 or the router specified by &%redirect_router%&, if set.
18669 .endlist
18670
18671 When the first word is &'accept'&, the remainder of the line consists of a
18672 number of keyed data values, as follows (split into two lines here, to fit on
18673 the page):
18674 .code
18675 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18676 LOOKUP=byname|bydns DATA=<text>
18677 .endd
18678 The data items can be given in any order, and all are optional. If no transport
18679 is included, the transport specified by the generic &%transport%& option is
18680 used. The list of hosts and the lookup type are needed only if the transport is
18681 an &(smtp)& transport that does not itself supply a list of hosts.
18682
18683 The format of the list of hosts is the same as for the &(manualroute)& router.
18684 As well as host names and IP addresses with optional port numbers, as described
18685 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18686 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18687 (see section &<<SECThostshowused>>&).
18688
18689 If the lookup type is not specified, Exim behaves as follows when trying to
18690 find an IP address for each host: First, a DNS lookup is done. If this yields
18691 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18692 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18693 result of the lookup is the result of that call.
18694
18695 .vindex "&$address_data$&"
18696 If the DATA field is set, its value is placed in the &$address_data$&
18697 variable. For example, this return line
18698 .code
18699 accept hosts=x1.y.example:x2.y.example data="rule1"
18700 .endd
18701 routes the address to the default transport, passing a list of two hosts. When
18702 the transport runs, the string &"rule1"& is in &$address_data$&.
18703 .ecindex IIDquerou1
18704 .ecindex IIDquerou2
18705
18706
18707
18708
18709 . ////////////////////////////////////////////////////////////////////////////
18710 . ////////////////////////////////////////////////////////////////////////////
18711
18712 .chapter "The redirect router" "CHAPredirect"
18713 .scindex IIDredrou1 "&(redirect)& router"
18714 .scindex IIDredrou2 "routers" "&(redirect)&"
18715 .cindex "alias file" "in a &(redirect)& router"
18716 .cindex "address redirection" "&(redirect)& router"
18717 The &(redirect)& router handles several kinds of address redirection. Its most
18718 common uses are for resolving local part aliases from a central alias file
18719 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18720 files, but it has many other potential uses. The incoming address can be
18721 redirected in several different ways:
18722
18723 .ilist
18724 It can be replaced by one or more new addresses which are themselves routed
18725 independently.
18726 .next
18727 It can be routed to be delivered to a given file or directory.
18728 .next
18729 It can be routed to be delivered to a specified pipe command.
18730 .next
18731 It can cause an automatic reply to be generated.
18732 .next
18733 It can be forced to fail, optionally with a custom error message.
18734 .next
18735 It can be temporarily deferred, optionally with a custom message.
18736 .next
18737 It can be discarded.
18738 .endlist
18739
18740 The generic &%transport%& option must not be set for &(redirect)& routers.
18741 However, there are some private options which define transports for delivery to
18742 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18743 &%pipe_transport%& and &%reply_transport%& descriptions below.
18744
18745
18746
18747 .section "Redirection data" "SECID124"
18748 The router operates by interpreting a text string which it obtains either by
18749 expanding the contents of the &%data%& option, or by reading the entire
18750 contents of a file whose name is given in the &%file%& option. These two
18751 options are mutually exclusive. The first is commonly used for handling system
18752 aliases, in a configuration like this:
18753 .code
18754 system_aliases:
18755   driver = redirect
18756   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18757 .endd
18758 If the lookup fails, the expanded string in this example is empty. When the
18759 expansion of &%data%& results in an empty string, the router declines. A forced
18760 expansion failure also causes the router to decline; other expansion failures
18761 cause delivery to be deferred.
18762
18763 A configuration using &%file%& is commonly used for handling users'
18764 &_.forward_& files, like this:
18765 .code
18766 userforward:
18767   driver = redirect
18768   check_local_user
18769   file = $home/.forward
18770   no_verify
18771 .endd
18772 If the file does not exist, or causes no action to be taken (for example, it is
18773 empty or consists only of comments), the router declines. &*Warning*&: This
18774 is not the case when the file contains syntactically valid items that happen to
18775 yield empty addresses, for example, items containing only RFC 2822 address
18776 comments.
18777
18778
18779
18780 .section "Forward files and address verification" "SECID125"
18781 .cindex "address redirection" "while verifying"
18782 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18783 &_.forward_& files, as in the example above. There are two reasons for this:
18784
18785 .ilist
18786 When Exim is receiving an incoming SMTP message from a remote host, it is
18787 running under the Exim uid, not as root. Exim is unable to change uid to read
18788 the file as the user, and it may not be able to read it as the Exim user. So in
18789 practice the router may not be able to operate.
18790 .next
18791 However, even when the router can operate, the existence of a &_.forward_& file
18792 is unimportant when verifying an address. What should be checked is whether the
18793 local part is a valid user name or not. Cutting out the redirection processing
18794 saves some resources.
18795 .endlist
18796
18797
18798
18799
18800
18801
18802 .section "Interpreting redirection data" "SECID126"
18803 .cindex "Sieve filter" "specifying in redirection data"
18804 .cindex "filter" "specifying in redirection data"
18805 The contents of the data string, whether obtained from &%data%& or &%file%&,
18806 can be interpreted in two different ways:
18807
18808 .ilist
18809 If the &%allow_filter%& option is set true, and the data begins with the text
18810 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18811 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18812 respectively. Details of the syntax and semantics of filter files are described
18813 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18814 document is intended for use by end users.
18815 .next
18816 Otherwise, the data must be a comma-separated list of redirection items, as
18817 described in the next section.
18818 .endlist
18819
18820 When a message is redirected to a file (a &"mail folder"&), the file name given
18821 in a non-filter redirection list must always be an absolute path. A filter may
18822 generate a relative path &-- how this is handled depends on the transport's
18823 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18824 for the &(appendfile)& transport.
18825
18826
18827
18828 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18829 .cindex "address redirection" "non-filter list items"
18830 When the redirection data is not an Exim or Sieve filter, for example, if it
18831 comes from a conventional alias or forward file, it consists of a list of
18832 addresses, file names, pipe commands, or certain special items (see section
18833 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18834 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18835 depending on their default values. The items in the list are separated by
18836 commas or newlines.
18837 If a comma is required in an item, the entire item must be enclosed in double
18838 quotes.
18839
18840 Lines starting with a # character are comments, and are ignored, and # may
18841 also appear following a comma, in which case everything between the # and the
18842 next newline character is ignored.
18843
18844 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18845 double quotes are retained because some forms of mail address require their use
18846 (but never to enclose the entire address). In the following description,
18847 &"item"& refers to what remains after any surrounding double quotes have been
18848 removed.
18849
18850 .vindex "&$local_part$&"
18851 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18852 and the expansion contains a reference to &$local_part$&, you should make use
18853 of the &%quote_local_part%& expansion operator, in case the local part contains
18854 special characters. For example, to redirect all mail for the domain
18855 &'obsolete.example'&, retaining the existing local part, you could use this
18856 setting:
18857 .code
18858 data = ${quote_local_part:$local_part}@newdomain.example
18859 .endd
18860
18861
18862 .section "Redirecting to a local mailbox" "SECTredlocmai"
18863 .cindex "routing" "loops in"
18864 .cindex "loop" "while routing, avoidance of"
18865 .cindex "address redirection" "to local mailbox"
18866 A redirection item may safely be the same as the address currently under
18867 consideration. This does not cause a routing loop, because a router is
18868 automatically skipped if any ancestor of the address that is being processed
18869 is the same as the current address and was processed by the current router.
18870 Such an address is therefore passed to the following routers, so it is handled
18871 as if there were no redirection. When making this loop-avoidance test, the
18872 complete local part, including any prefix or suffix, is used.
18873
18874 .cindex "address redirection" "local part without domain"
18875 Specifying the same local part without a domain is a common usage in personal
18876 filter files when the user wants to have messages delivered to the local
18877 mailbox and also forwarded elsewhere. For example, the user whose login is
18878 &'cleo'& might have a &_.forward_& file containing this:
18879 .code
18880 cleo, cleopatra@egypt.example
18881 .endd
18882 .cindex "backslash in alias file"
18883 .cindex "alias file" "backslash in"
18884 For compatibility with other MTAs, such unqualified local parts may be
18885 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18886 it does make a difference if more than one domain is being handled
18887 synonymously.
18888
18889 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18890 2822 address that does not include a domain, the item is qualified using the
18891 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18892 addresses are qualified using the value in &%qualify_recipient%&, but you can
18893 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18894
18895 Care must be taken if there are alias names for local users.
18896 Consider an MTA handling a single local domain where the system alias file
18897 contains:
18898 .code
18899 Sam.Reman: spqr
18900 .endd
18901 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18902 messages in the local mailbox, and also forward copies elsewhere. He creates
18903 this forward file:
18904 .code
18905 Sam.Reman, spqr@reme.elsewhere.example
18906 .endd
18907 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18908 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18909 second time round, because it has previously routed it,
18910 and the following routers presumably cannot handle the alias. The forward file
18911 should really contain
18912 .code
18913 spqr, spqr@reme.elsewhere.example
18914 .endd
18915 but because this is such a common error, the &%check_ancestor%& option (see
18916 below) exists to provide a way to get round it. This is normally set on a
18917 &(redirect)& router that is handling users' &_.forward_& files.
18918
18919
18920
18921 .section "Special items in redirection lists" "SECTspecitredli"
18922 In addition to addresses, the following types of item may appear in redirection
18923 lists (that is, in non-filter redirection data):
18924
18925 .ilist
18926 .cindex "pipe" "in redirection list"
18927 .cindex "address redirection" "to pipe"
18928 An item is treated as a pipe command if it begins with &"|"& and does not parse
18929 as a valid RFC 2822 address that includes a domain. A transport for running the
18930 command must be specified by the &%pipe_transport%& option.
18931 Normally, either the router or the transport specifies a user and a group under
18932 which to run the delivery. The default is to use the Exim user and group.
18933
18934 Single or double quotes can be used for enclosing the individual arguments of
18935 the pipe command; no interpretation of escapes is done for single quotes. If
18936 the command contains a comma character, it is necessary to put the whole item
18937 in double quotes, for example:
18938 .code
18939 "|/some/command ready,steady,go"
18940 .endd
18941 since items in redirection lists are terminated by commas. Do not, however,
18942 quote just the command. An item such as
18943 .code
18944 |"/some/command ready,steady,go"
18945 .endd
18946 is interpreted as a pipe with a rather strange command name, and no arguments.
18947
18948 Note that the above example assumes that the text comes from a lookup source
18949 of some sort, so that the quotes are part of the data.  If composing a
18950 redirect router with a &%data%& option directly specifying this command, the
18951 quotes will be used by the configuration parser to define the extent of one
18952 string, but will not be passed down into the redirect router itself.  There
18953 are two main approaches to get around this: escape quotes to be part of the
18954 data itself, or avoid using this mechanism and instead create a custom
18955 transport with the &%command%& option set and reference that transport from
18956 an &%accept%& router.
18957
18958 .next
18959 .cindex "file" "in redirection list"
18960 .cindex "address redirection" "to file"
18961 An item is interpreted as a path name if it begins with &"/"& and does not
18962 parse as a valid RFC 2822 address that includes a domain. For example,
18963 .code
18964 /home/world/minbari
18965 .endd
18966 is treated as a file name, but
18967 .code
18968 /s=molari/o=babylon/@x400gate.way
18969 .endd
18970 is treated as an address. For a file name, a transport must be specified using
18971 the &%file_transport%& option. However, if the generated path name ends with a
18972 forward slash character, it is interpreted as a directory name rather than a
18973 file name, and &%directory_transport%& is used instead.
18974
18975 Normally, either the router or the transport specifies a user and a group under
18976 which to run the delivery. The default is to use the Exim user and group.
18977
18978 .cindex "&_/dev/null_&"
18979 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18980 bypassed at a high level, and the log entry shows &"**bypassed**"&
18981 instead of a transport name. In this case the user and group are not used.
18982
18983 .next
18984 .cindex "included address list"
18985 .cindex "address redirection" "included external list"
18986 If an item is of the form
18987 .code
18988 :include:<path name>
18989 .endd
18990 a list of further items is taken from the given file and included at that
18991 point. &*Note*&: Such a file can not be a filter file; it is just an
18992 out-of-line addition to the list. The items in the included list are separated
18993 by commas or newlines and are not subject to expansion. If this is the first
18994 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18995 the alias name. This example is incorrect:
18996 .code
18997 list1    :include:/opt/lists/list1
18998 .endd
18999 It must be given as
19000 .code
19001 list1:   :include:/opt/lists/list1
19002 .endd
19003 .next
19004 .cindex "address redirection" "to black hole"
19005 Sometimes you want to throw away mail to a particular local part. Making the
19006 &%data%& option expand to an empty string does not work, because that causes
19007 the router to decline. Instead, the alias item
19008 .cindex "black hole"
19009 .cindex "abandoning mail"
19010 &':blackhole:'& can be used. It does what its name implies. No delivery is
19011 done, and no error message is generated. This has the same effect as specifing
19012 &_/dev/null_& as a destination, but it can be independently disabled.
19013
19014 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19015 delivery is done for the original local part, even if other redirection items
19016 are present. If you are generating a multi-item list (for example, by reading a
19017 database) and need the ability to provide a no-op item, you must use
19018 &_/dev/null_&.
19019
19020 .next
19021 .cindex "delivery" "forcing failure"
19022 .cindex "delivery" "forcing deferral"
19023 .cindex "failing delivery" "forcing"
19024 .cindex "deferred delivery, forcing"
19025 .cindex "customizing" "failure message"
19026 An attempt to deliver a particular address can be deferred or forced to fail by
19027 redirection items of the form
19028 .code
19029 :defer:
19030 :fail:
19031 .endd
19032 respectively. When a redirection list contains such an item, it applies
19033 to the entire redirection; any other items in the list are ignored. Any
19034 text following &':fail:'& or &':defer:'& is placed in the error text
19035 associated with the failure. For example, an alias file might contain:
19036 .code
19037 X.Employee:  :fail: Gone away, no forwarding address
19038 .endd
19039 In the case of an address that is being verified from an ACL or as the subject
19040 of a
19041 .cindex "VRFY" "error text, display of"
19042 VRFY command, the text is included in the SMTP error response by
19043 default.
19044 .cindex "EXPN" "error text, display of"
19045 The text is not included in the response to an EXPN command. In non-SMTP cases
19046 the text is included in the error message that Exim generates.
19047
19048 .cindex "SMTP" "error codes"
19049 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19050 &':fail:'&. However, if the message starts with three digits followed by a
19051 space, optionally followed by an extended code of the form &'n.n.n'&, also
19052 followed by a space, and the very first digit is the same as the default error
19053 code, the code from the message is used instead. If the very first digit is
19054 incorrect, a panic error is logged, and the default code is used. You can
19055 suppress the use of the supplied code in a redirect router by setting the
19056 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19057 ignored.
19058
19059 .vindex "&$acl_verify_message$&"
19060 In an ACL, an explicitly provided message overrides the default, but the
19061 default message is available in the variable &$acl_verify_message$& and can
19062 therefore be included in a custom message if this is desired.
19063
19064 Normally the error text is the rest of the redirection list &-- a comma does
19065 not terminate it &-- but a newline does act as a terminator. Newlines are not
19066 normally present in alias expansions. In &(lsearch)& lookups they are removed
19067 as part of the continuation process, but they may exist in other kinds of
19068 lookup and in &':include:'& files.
19069
19070 During routing for message delivery (as opposed to verification), a redirection
19071 containing &':fail:'& causes an immediate failure of the incoming address,
19072 whereas &':defer:'& causes the message to remain on the queue so that a
19073 subsequent delivery attempt can happen at a later time. If an address is
19074 deferred for too long, it will ultimately fail, because the normal retry
19075 rules still apply.
19076
19077 .next
19078 .cindex "alias file" "exception to default"
19079 Sometimes it is useful to use a single-key search type with a default (see
19080 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19081 for exceptions to the default. These can be handled by aliasing them to
19082 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19083 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19084 results in an empty redirection list has the same effect.
19085 .endlist
19086
19087
19088 .section "Duplicate addresses" "SECTdupaddr"
19089 .cindex "duplicate addresses"
19090 .cindex "address duplicate, discarding"
19091 .cindex "pipe" "duplicated"
19092 Exim removes duplicate addresses from the list to which it is delivering, so as
19093 to deliver just one copy to each address. This does not apply to deliveries
19094 routed to pipes by different immediate parent addresses, but an indirect
19095 aliasing scheme of the type
19096 .code
19097 pipe:       |/some/command $local_part
19098 localpart1: pipe
19099 localpart2: pipe
19100 .endd
19101 does not work with a message that is addressed to both local parts, because
19102 when the second is aliased to the intermediate local part &"pipe"& it gets
19103 discarded as being the same as a previously handled address. However, a scheme
19104 such as
19105 .code
19106 localpart1: |/some/command $local_part
19107 localpart2: |/some/command $local_part
19108 .endd
19109 does result in two different pipe deliveries, because the immediate parents of
19110 the pipes are distinct.
19111
19112
19113
19114 .section "Repeated redirection expansion" "SECID128"
19115 .cindex "repeated redirection expansion"
19116 .cindex "address redirection" "repeated for each delivery attempt"
19117 When a message cannot be delivered to all of its recipients immediately,
19118 leading to two or more delivery attempts, redirection expansion is carried out
19119 afresh each time for those addresses whose children were not all previously
19120 delivered. If redirection is being used as a mailing list, this can lead to new
19121 members of the list receiving copies of old messages. The &%one_time%& option
19122 can be used to avoid this.
19123
19124
19125 .section "Errors in redirection lists" "SECID129"
19126 .cindex "address redirection" "errors"
19127 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19128 error is skipped, and an entry is written to the main log. This may be useful
19129 for mailing lists that are automatically managed. Otherwise, if an error is
19130 detected while generating the list of new addresses, the original address is
19131 deferred. See also &%syntax_errors_to%&.
19132
19133
19134
19135 .section "Private options for the redirect router" "SECID130"
19136
19137 .cindex "options" "&(redirect)& router"
19138 The private options for the &(redirect)& router are as follows:
19139
19140
19141 .option allow_defer redirect boolean false
19142 Setting this option allows the use of &':defer:'& in non-filter redirection
19143 data, or the &%defer%& command in an Exim filter file.
19144
19145
19146 .option allow_fail redirect boolean false
19147 .cindex "failing delivery" "from filter"
19148 If this option is true, the &':fail:'& item can be used in a redirection list,
19149 and the &%fail%& command may be used in an Exim filter file.
19150
19151
19152 .option allow_filter redirect boolean false
19153 .cindex "filter" "enabling use of"
19154 .cindex "Sieve filter" "enabling use of"
19155 Setting this option allows Exim to interpret redirection data that starts with
19156 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19157 are some features of Exim filter files that some administrators may wish to
19158 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19159
19160 It is also possible to lock out Exim filters or Sieve filters while allowing
19161 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19162
19163
19164 The filter is run using the uid and gid set by the generic &%user%& and
19165 &%group%& options. These take their defaults from the password data if
19166 &%check_local_user%& is set, so in the normal case of users' personal filter
19167 files, the filter is run as the relevant user. When &%allow_filter%& is set
19168 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19169
19170
19171
19172 .option allow_freeze redirect boolean false
19173 .cindex "freezing messages" "allowing in filter"
19174 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19175 This command is more normally encountered in system filters, and is disabled by
19176 default for redirection filters because it isn't something you usually want to
19177 let ordinary users do.
19178
19179
19180
19181 .option check_ancestor redirect boolean false
19182 This option is concerned with handling generated addresses that are the same
19183 as some address in the list of redirection ancestors of the current address.
19184 Although it is turned off by default in the code, it is set in the default
19185 configuration file for handling users' &_.forward_& files. It is recommended
19186 for this use of the &(redirect)& router.
19187
19188 When &%check_ancestor%& is set, if a generated address (including the domain)
19189 is the same as any ancestor of the current address, it is replaced by a copy of
19190 the current address. This helps in the case where local part A is aliased to B,
19191 and B has a &_.forward_& file pointing back to A. For example, within a single
19192 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19193 &_&~jb/.forward_& contains:
19194 .code
19195 \Joe.Bloggs, <other item(s)>
19196 .endd
19197 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19198 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19199 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19200 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19201 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19202 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19203 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19204 original address. See also the &%repeat_use%& option below.
19205
19206
19207 .option check_group redirect boolean "see below"
19208 When the &%file%& option is used, the group owner of the file is checked only
19209 when this option is set. The permitted groups are those listed in the
19210 &%owngroups%& option, together with the user's default group if
19211 &%check_local_user%& is set. If the file has the wrong group, routing is
19212 deferred. The default setting for this option is true if &%check_local_user%&
19213 is set and the &%modemask%& option permits the group write bit, or if the
19214 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19215
19216
19217
19218 .option check_owner redirect boolean "see below"
19219 When the &%file%& option is used, the owner of the file is checked only when
19220 this option is set. If &%check_local_user%& is set, the local user is
19221 permitted; otherwise the owner must be one of those listed in the &%owners%&
19222 option. The default value for this option is true if &%check_local_user%& or
19223 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19224
19225
19226 .option data redirect string&!! unset
19227 This option is mutually exclusive with &%file%&. One or other of them must be
19228 set, but not both. The contents of &%data%& are expanded, and then used as the
19229 list of forwarding items, or as a set of filtering instructions. If the
19230 expansion is forced to fail, or the result is an empty string or a string that
19231 has no effect (consists entirely of comments), the router declines.
19232
19233 When filtering instructions are used, the string must begin with &"#Exim
19234 filter"&, and all comments in the string, including this initial one, must be
19235 terminated with newline characters. For example:
19236 .code
19237 data = #Exim filter\n\
19238        if $h_to: contains Exim then save $home/mail/exim endif
19239 .endd
19240 If you are reading the data from a database where newlines cannot be included,
19241 you can use the &${sg}$& expansion item to turn the escape string of your
19242 choice into a newline.
19243
19244
19245 .option directory_transport redirect string&!! unset
19246 A &(redirect)& router sets up a direct delivery to a directory when a path name
19247 ending with a slash is specified as a new &"address"&. The transport used is
19248 specified by this option, which, after expansion, must be the name of a
19249 configured transport. This should normally be an &(appendfile)& transport.
19250
19251
19252 .option file redirect string&!! unset
19253 This option specifies the name of a file that contains the redirection data. It
19254 is mutually exclusive with the &%data%& option. The string is expanded before
19255 use; if the expansion is forced to fail, the router declines. Other expansion
19256 failures cause delivery to be deferred. The result of a successful expansion
19257 must be an absolute path. The entire file is read and used as the redirection
19258 data. If the data is an empty string or a string that has no effect (consists
19259 entirely of comments), the router declines.
19260
19261 .cindex "NFS" "checking for file existence"
19262 If the attempt to open the file fails with a &"does not exist"& error, Exim
19263 runs a check on the containing directory,
19264 unless &%ignore_enotdir%& is true (see below).
19265 If the directory does not appear to exist, delivery is deferred. This can
19266 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19267 is a mount problem. If the containing directory does exist, but the file does
19268 not, the router declines.
19269
19270
19271 .option file_transport redirect string&!! unset
19272 .vindex "&$address_file$&"
19273 A &(redirect)& router sets up a direct delivery to a file when a path name not
19274 ending in a slash is specified as a new &"address"&. The transport used is
19275 specified by this option, which, after expansion, must be the name of a
19276 configured transport. This should normally be an &(appendfile)& transport. When
19277 it is running, the file name is in &$address_file$&.
19278
19279
19280 .option filter_prepend_home redirect boolean true
19281 When this option is true, if a &(save)& command in an Exim filter specifies a
19282 relative path, and &$home$& is defined, it is automatically prepended to the
19283 relative path. If this option is set false, this action does not happen. The
19284 relative path is then passed to the transport unmodified.
19285
19286
19287 .option forbid_blackhole redirect boolean false
19288 If this option is true, the &':blackhole:'& item may not appear in a
19289 redirection list.
19290
19291
19292 .option forbid_exim_filter redirect boolean false
19293 If this option is set true, only Sieve filters are permitted when
19294 &%allow_filter%& is true.
19295
19296
19297
19298
19299 .option forbid_file redirect boolean false
19300 .cindex "delivery" "to file; forbidding"
19301 .cindex "Sieve filter" "forbidding delivery to a file"
19302 .cindex "Sieve filter" "&""keep""& facility; disabling"
19303 If this option is true, this router may not generate a new address that
19304 specifies delivery to a local file or directory, either from a filter or from a
19305 conventional forward file. This option is forced to be true if &%one_time%& is
19306 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19307 locks out the Sieve's &"keep"& facility.
19308
19309
19310 .option forbid_filter_dlfunc redirect boolean false
19311 .cindex "filter" "locking out certain features"
19312 If this option is true, string expansions in Exim filters are not allowed to
19313 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19314 functions.
19315
19316 .option forbid_filter_existstest redirect boolean false
19317 .cindex "expansion" "statting a file"
19318 If this option is true, string expansions in Exim filters are not allowed to
19319 make use of the &%exists%& condition or the &%stat%& expansion item.
19320
19321 .option forbid_filter_logwrite redirect boolean false
19322 If this option is true, use of the logging facility in Exim filters is not
19323 permitted. Logging is in any case available only if the filter is being run
19324 under some unprivileged uid (which is normally the case for ordinary users'
19325 &_.forward_& files).
19326
19327
19328 .option forbid_filter_lookup redirect boolean false
19329 If this option is true, string expansions in Exim filter files are not allowed
19330 to make use of &%lookup%& items.
19331
19332
19333 .option forbid_filter_perl redirect boolean false
19334 This option has an effect only if Exim is built with embedded Perl support. If
19335 it is true, string expansions in Exim filter files are not allowed to make use
19336 of the embedded Perl support.
19337
19338
19339 .option forbid_filter_readfile redirect boolean false
19340 If this option is true, string expansions in Exim filter files are not allowed
19341 to make use of &%readfile%& items.
19342
19343
19344 .option forbid_filter_readsocket redirect boolean false
19345 If this option is true, string expansions in Exim filter files are not allowed
19346 to make use of &%readsocket%& items.
19347
19348
19349 .option forbid_filter_reply redirect boolean false
19350 If this option is true, this router may not generate an automatic reply
19351 message. Automatic replies can be generated only from Exim or Sieve filter
19352 files, not from traditional forward files. This option is forced to be true if
19353 &%one_time%& is set.
19354
19355
19356 .option forbid_filter_run redirect boolean false
19357 If this option is true, string expansions in Exim filter files are not allowed
19358 to make use of &%run%& items.
19359
19360
19361 .option forbid_include redirect boolean false
19362 If this option is true, items of the form
19363 .code
19364 :include:<path name>
19365 .endd
19366 are not permitted in non-filter redirection lists.
19367
19368
19369 .option forbid_pipe redirect boolean false
19370 .cindex "delivery" "to pipe; forbidding"
19371 If this option is true, this router may not generate a new address which
19372 specifies delivery to a pipe, either from an Exim filter or from a conventional
19373 forward file. This option is forced to be true if &%one_time%& is set.
19374
19375
19376 .option forbid_sieve_filter redirect boolean false
19377 If this option is set true, only Exim filters are permitted when
19378 &%allow_filter%& is true.
19379
19380
19381 .cindex "SMTP" "error codes"
19382 .option forbid_smtp_code redirect boolean false
19383 If this option is set true, any SMTP error codes that are present at the start
19384 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19385 the default codes (451 and 550, respectively) are always used.
19386
19387
19388
19389
19390 .option hide_child_in_errmsg redirect boolean false
19391 .cindex "bounce message" "redirection details; suppressing"
19392 If this option is true, it prevents Exim from quoting a child address if it
19393 generates a bounce or delay message for it. Instead it says &"an address
19394 generated from <&'the top level address'&>"&. Of course, this applies only to
19395 bounces generated locally. If a message is forwarded to another host, &'its'&
19396 bounce may well quote the generated address.
19397
19398
19399 .option ignore_eacces redirect boolean false
19400 .cindex "EACCES"
19401 If this option is set and an attempt to open a redirection file yields the
19402 EACCES error (permission denied), the &(redirect)& router behaves as if the
19403 file did not exist.
19404
19405
19406 .option ignore_enotdir redirect boolean false
19407 .cindex "ENOTDIR"
19408 If this option is set and an attempt to open a redirection file yields the
19409 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19410 router behaves as if the file did not exist.
19411
19412 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19413 router that has the &%file%& option set discovers that the file does not exist
19414 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19415 against unmounted NFS directories. If the parent can not be statted, delivery
19416 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19417 is set, because that option tells Exim to ignore &"something on the path is not
19418 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19419 that some operating systems give ENOENT where others give ENOTDIR.
19420
19421
19422
19423 .option include_directory redirect string unset
19424 If this option is set, the path names of any &':include:'& items in a
19425 redirection list must start with this directory.
19426
19427
19428 .option modemask redirect "octal integer" 022
19429 This specifies mode bits which must not be set for a file specified by the
19430 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19431
19432
19433 .option one_time redirect boolean false
19434 .cindex "one-time aliasing/forwarding expansion"
19435 .cindex "alias file" "one-time expansion"
19436 .cindex "forward file" "one-time expansion"
19437 .cindex "mailing lists" "one-time expansion"
19438 .cindex "address redirection" "one-time expansion"
19439 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19440 files each time it tries to deliver a message causes a problem when one or more
19441 of the generated addresses fails be delivered at the first attempt. The problem
19442 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19443 but of what happens when the redirection list changes during the time that the
19444 message is on Exim's queue. This is particularly true in the case of mailing
19445 lists, where new subscribers might receive copies of messages that were posted
19446 before they subscribed.
19447
19448 If &%one_time%& is set and any addresses generated by the router fail to
19449 deliver at the first attempt, the failing addresses are added to the message as
19450 &"top level"& addresses, and the parent address that generated them is marked
19451 &"delivered"&. Thus, redirection does not happen again at the next delivery
19452 attempt.
19453
19454 &*Warning 1*&: Any header line addition or removal that is specified by this
19455 router would be lost if delivery did not succeed at the first attempt. For this
19456 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19457 permitted when &%one_time%& is set.
19458
19459 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19460 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19461 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19462
19463 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19464 &%one_time%&.
19465
19466 The original top-level address is remembered with each of the generated
19467 addresses, and is output in any log messages. However, any intermediate parent
19468 addresses are not recorded. This makes a difference to the log only if
19469 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19470 typically be used for mailing lists, where there is normally just one level of
19471 expansion.
19472
19473
19474 .option owners redirect "string list" unset
19475 .cindex "ownership" "alias file"
19476 .cindex "ownership" "forward file"
19477 .cindex "alias file" "ownership"
19478 .cindex "forward file" "ownership"
19479 This specifies a list of permitted owners for the file specified by &%file%&.
19480 This list is in addition to the local user when &%check_local_user%& is set.
19481 See &%check_owner%& above.
19482
19483
19484 .option owngroups redirect "string list" unset
19485 This specifies a list of permitted groups for the file specified by &%file%&.
19486 The list is in addition to the local user's primary group when
19487 &%check_local_user%& is set. See &%check_group%& above.
19488
19489
19490 .option pipe_transport redirect string&!! unset
19491 .vindex "&$address_pipe$&"
19492 A &(redirect)& router sets up a direct delivery to a pipe when a string
19493 starting with a vertical bar character is specified as a new &"address"&. The
19494 transport used is specified by this option, which, after expansion, must be the
19495 name of a configured transport. This should normally be a &(pipe)& transport.
19496 When the transport is run, the pipe command is in &$address_pipe$&.
19497
19498
19499 .option qualify_domain redirect string&!! unset
19500 .vindex "&$qualify_recipient$&"
19501 If this option is set, and an unqualified address (one without a domain) is
19502 generated, and that address would normally be qualified by the global setting
19503 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19504 expanding this string. If the expansion fails, the router declines. If you want
19505 to revert to the default, you can have the expansion generate
19506 &$qualify_recipient$&.
19507
19508 This option applies to all unqualified addresses generated by Exim filters,
19509 but for traditional &_.forward_& files, it applies only to addresses that are
19510 not preceded by a backslash. Sieve filters cannot generate unqualified
19511 addresses.
19512
19513 .option qualify_preserve_domain redirect boolean false
19514 .cindex "domain" "in redirection; preserving"
19515 .cindex "preserving domain in redirection"
19516 .cindex "address redirection" "domain; preserving"
19517 If this option is set, the router's local &%qualify_domain%& option must not be
19518 set (a configuration error occurs if it is). If an unqualified address (one
19519 without a domain) is generated, it is qualified with the domain of the parent
19520 address (the immediately preceding ancestor) instead of the global
19521 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19522 this applies whether or not the address is preceded by a backslash.
19523
19524
19525 .option repeat_use redirect boolean true
19526 If this option is set false, the router is skipped for a child address that has
19527 any ancestor that was routed by this router. This test happens before any of
19528 the other preconditions are tested. Exim's default anti-looping rules skip
19529 only when the ancestor is the same as the current address. See also
19530 &%check_ancestor%& above and the generic &%redirect_router%& option.
19531
19532
19533 .option reply_transport redirect string&!! unset
19534 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19535 &%vacation%& command is used in a filter file. The transport used is specified
19536 by this option, which, after expansion, must be the name of a configured
19537 transport. This should normally be an &(autoreply)& transport. Other transports
19538 are unlikely to do anything sensible or useful.
19539
19540
19541 .option rewrite redirect boolean true
19542 .cindex "address redirection" "disabling rewriting"
19543 If this option is set false, addresses generated by the router are not
19544 subject to address rewriting. Otherwise, they are treated like new addresses
19545 and are rewritten according to the global rewriting rules.
19546
19547
19548 .option sieve_subaddress redirect string&!! unset
19549 The value of this option is passed to a Sieve filter to specify the
19550 :subaddress part of an address.
19551
19552 .option sieve_useraddress redirect string&!! unset
19553 The value of this option is passed to a Sieve filter to specify the :user part
19554 of an address. However, if it is unset, the entire original local part
19555 (including any prefix or suffix) is used for :user.
19556
19557
19558 .option sieve_vacation_directory redirect string&!! unset
19559 .cindex "Sieve filter" "vacation directory"
19560 To enable the &"vacation"& extension for Sieve filters, you must set
19561 &%sieve_vacation_directory%& to the directory where vacation databases are held
19562 (do not put anything else in that directory), and ensure that the
19563 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19564 needs their own directory; Exim will create it if necessary.
19565
19566
19567
19568 .option skip_syntax_errors redirect boolean false
19569 .cindex "forward file" "broken"
19570 .cindex "address redirection" "broken files"
19571 .cindex "alias file" "broken"
19572 .cindex "broken alias or forward files"
19573 .cindex "ignoring faulty addresses"
19574 .cindex "skipping faulty addresses"
19575 .cindex "error" "skipping bad syntax"
19576 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19577 non-filter redirection data are skipped, and each failing address is logged. If
19578 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19579 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19580 are expanded and placed at the head of the error message generated by
19581 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19582 be the same address as the generic &%errors_to%& option. The
19583 &%skip_syntax_errors%& option is often used when handling mailing lists.
19584
19585 If all the addresses in a redirection list are skipped because of syntax
19586 errors, the router declines to handle the original address, and it is passed to
19587 the following routers.
19588
19589 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19590 error in the filter causes filtering to be abandoned without any action being
19591 taken. The incident is logged, and the router declines to handle the address,
19592 so it is passed to the following routers.
19593
19594 .cindex "Sieve filter" "syntax errors in"
19595 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19596 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19597 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19598
19599 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19600 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19601 option, used with an address that does not get redirected, can be used to
19602 notify users of these errors, by means of a router like this:
19603 .code
19604 userforward:
19605   driver = redirect
19606   allow_filter
19607   check_local_user
19608   file = $home/.forward
19609   file_transport = address_file
19610   pipe_transport = address_pipe
19611   reply_transport = address_reply
19612   no_verify
19613   skip_syntax_errors
19614   syntax_errors_to = real-$local_part@$domain
19615   syntax_errors_text = \
19616    This is an automatically generated message. An error has\n\
19617    been found in your .forward file. Details of the error are\n\
19618    reported below. While this error persists, you will receive\n\
19619    a copy of this message for every message that is addressed\n\
19620    to you. If your .forward file is a filter file, or if it is\n\
19621    a non-filter file containing no valid forwarding addresses,\n\
19622    a copy of each incoming message will be put in your normal\n\
19623    mailbox. If a non-filter file contains at least one valid\n\
19624    forwarding address, forwarding to the valid addresses will\n\
19625    happen, and those will be the only deliveries that occur.
19626 .endd
19627 You also need a router to ensure that local addresses that are prefixed by
19628 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19629 put this immediately before the &(userforward)& router:
19630 .code
19631 real_localuser:
19632   driver = accept
19633   check_local_user
19634   local_part_prefix = real-
19635   transport = local_delivery
19636 .endd
19637 For security, it would probably be a good idea to restrict the use of this
19638 router to locally-generated messages, using a condition such as this:
19639 .code
19640   condition = ${if match {$sender_host_address}\
19641                          {\N^(|127\.0\.0\.1)$\N}}
19642 .endd
19643
19644
19645 .option syntax_errors_text redirect string&!! unset
19646 See &%skip_syntax_errors%& above.
19647
19648
19649 .option syntax_errors_to redirect string unset
19650 See &%skip_syntax_errors%& above.
19651 .ecindex IIDredrou1
19652 .ecindex IIDredrou2
19653
19654
19655
19656
19657
19658
19659 . ////////////////////////////////////////////////////////////////////////////
19660 . ////////////////////////////////////////////////////////////////////////////
19661
19662 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19663          "Environment for local transports"
19664 .scindex IIDenvlotra1 "local transports" "environment for"
19665 .scindex IIDenvlotra2 "environment for local transports"
19666 .scindex IIDenvlotra3 "transport" "local; environment for"
19667 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19668 transport can be thought of as similar to a pipe.) Exim always runs transports
19669 in subprocesses, under specified uids and gids. Typical deliveries to local
19670 mailboxes run under the uid and gid of the local user.
19671
19672 Exim also sets a specific current directory while running the transport; for
19673 some transports a home directory setting is also relevant. The &(pipe)&
19674 transport is the only one that sets up environment variables; see section
19675 &<<SECTpipeenv>>& for details.
19676
19677 The values used for the uid, gid, and the directories may come from several
19678 different places. In many cases, the router that handles the address associates
19679 settings with that address as a result of its &%check_local_user%&, &%group%&,
19680 or &%user%& options. However, values may also be given in the transport's own
19681 configuration, and these override anything that comes from the router.
19682
19683
19684
19685 .section "Concurrent deliveries" "SECID131"
19686 .cindex "concurrent deliveries"
19687 .cindex "simultaneous deliveries"
19688 If two different messages for the same local recipient arrive more or less
19689 simultaneously, the two delivery processes are likely to run concurrently. When
19690 the &(appendfile)& transport is used to write to a file, Exim applies locking
19691 rules to stop concurrent processes from writing to the same file at the same
19692 time.
19693
19694 However, when you use a &(pipe)& transport, it is up to you to arrange any
19695 locking that is needed. Here is a silly example:
19696 .code
19697 my_transport:
19698   driver = pipe
19699   command = /bin/sh -c 'cat >>/some/file'
19700 .endd
19701 This is supposed to write the message at the end of the file. However, if two
19702 messages arrive at the same time, the file will be scrambled. You can use the
19703 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19704 file using the same algorithm that Exim itself uses.
19705
19706
19707
19708
19709 .section "Uids and gids" "SECTenvuidgid"
19710 .cindex "local transports" "uid and gid"
19711 .cindex "transport" "local; uid and gid"
19712 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19713 overrides any group that the router set in the address, even if &%user%& is not
19714 set for the transport. This makes it possible, for example, to run local mail
19715 delivery under the uid of the recipient (set by the router), but in a special
19716 group (set by the transport). For example:
19717 .code
19718 # Routers ...
19719 # User/group are set by check_local_user in this router
19720 local_users:
19721   driver = accept
19722   check_local_user
19723   transport = group_delivery
19724
19725 # Transports ...
19726 # This transport overrides the group
19727 group_delivery:
19728   driver = appendfile
19729   file = /var/spool/mail/$local_part
19730   group = mail
19731 .endd
19732 If &%user%& is set for a transport, its value overrides what is set in the
19733 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19734 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19735 set.
19736
19737 .oindex "&%initgroups%&"
19738 When the uid is taken from the transport's configuration, the &[initgroups()]&
19739 function is called for the groups associated with that uid if the
19740 &%initgroups%& option is set for the transport. When the uid is not specified
19741 by the transport, but is associated with the address by a router, the option
19742 for calling &[initgroups()]& is taken from the router configuration.
19743
19744 .cindex "&(pipe)& transport" "uid for"
19745 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19746 is set and &%user%& is not set, the uid of the process that called Exim to
19747 receive the message is used, and if &%group%& is not set, the corresponding
19748 original gid is also used.
19749
19750 This is the detailed preference order for obtaining a gid; the first of the
19751 following that is set is used:
19752
19753 .ilist
19754 A &%group%& setting of the transport;
19755 .next
19756 A &%group%& setting of the router;
19757 .next
19758 A gid associated with a user setting of the router, either as a result of
19759 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19760 .next
19761 The group associated with a non-numeric &%user%& setting of the transport;
19762 .next
19763 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19764 the uid is the creator's uid;
19765 .next
19766 The Exim gid if the Exim uid is being used as a default.
19767 .endlist
19768
19769 If, for example, the user is specified numerically on the router and there are
19770 no group settings, no gid is available. In this situation, an error occurs.
19771 This is different for the uid, for which there always is an ultimate default.
19772 The first of the following that is set is used:
19773
19774 .ilist
19775 A &%user%& setting of the transport;
19776 .next
19777 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19778 .next
19779 A &%user%& setting of the router;
19780 .next
19781 A &%check_local_user%& setting of the router;
19782 .next
19783 The Exim uid.
19784 .endlist
19785
19786 Of course, an error will still occur if the uid that is chosen is on the
19787 &%never_users%& list.
19788
19789
19790
19791
19792
19793 .section "Current and home directories" "SECID132"
19794 .cindex "current directory for local transport"
19795 .cindex "home directory" "for local transport"
19796 .cindex "transport" "local; home directory for"
19797 .cindex "transport" "local; current directory for"
19798 Routers may set current and home directories for local transports by means of
19799 the &%transport_current_directory%& and &%transport_home_directory%& options.
19800 However, if the transport's &%current_directory%& or &%home_directory%& options
19801 are set, they override the router's values. In detail, the home directory
19802 for a local transport is taken from the first of these values that is set:
19803
19804 .ilist
19805 The &%home_directory%& option on the transport;
19806 .next
19807 The &%transport_home_directory%& option on the router;
19808 .next
19809 The password data if &%check_local_user%& is set on the router;
19810 .next
19811 The &%router_home_directory%& option on the router.
19812 .endlist
19813
19814 The current directory is taken from the first of these values that is set:
19815
19816 .ilist
19817 The &%current_directory%& option on the transport;
19818 .next
19819 The &%transport_current_directory%& option on the router.
19820 .endlist
19821
19822
19823 If neither the router nor the transport sets a current directory, Exim uses the
19824 value of the home directory, if it is set. Otherwise it sets the current
19825 directory to &_/_& before running a local transport.
19826
19827
19828
19829 .section "Expansion variables derived from the address" "SECID133"
19830 .vindex "&$domain$&"
19831 .vindex "&$local_part$&"
19832 .vindex "&$original_domain$&"
19833 Normally a local delivery is handling a single address, and in that case the
19834 variables such as &$domain$& and &$local_part$& are set during local
19835 deliveries. However, in some circumstances more than one address may be handled
19836 at once (for example, while writing batch SMTP for onward transmission by some
19837 other means). In this case, the variables associated with the local part are
19838 never set, &$domain$& is set only if all the addresses have the same domain,
19839 and &$original_domain$& is never set.
19840 .ecindex IIDenvlotra1
19841 .ecindex IIDenvlotra2
19842 .ecindex IIDenvlotra3
19843
19844
19845
19846
19847
19848
19849
19850 . ////////////////////////////////////////////////////////////////////////////
19851 . ////////////////////////////////////////////////////////////////////////////
19852
19853 .chapter "Generic options for transports" "CHAPtransportgeneric"
19854 .scindex IIDgenoptra1 "generic options" "transport"
19855 .scindex IIDgenoptra2 "options" "generic; for transports"
19856 .scindex IIDgenoptra3 "transport" "generic options for"
19857 The following generic options apply to all transports:
19858
19859
19860 .option body_only transports boolean false
19861 .cindex "transport" "body only"
19862 .cindex "message" "transporting body only"
19863 .cindex "body of message" "transporting"
19864 If this option is set, the message's headers are not transported. It is
19865 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19866 or &(pipe)& transports, the settings of &%message_prefix%& and
19867 &%message_suffix%& should be checked, because this option does not
19868 automatically suppress them.
19869
19870
19871 .option current_directory transports string&!! unset
19872 .cindex "transport" "current directory for"
19873 This specifies the current directory that is to be set while running the
19874 transport, overriding any value that may have been set by the router.
19875 If the expansion fails for any reason, including forced failure, an error is
19876 logged, and delivery is deferred.
19877
19878
19879 .option disable_logging transports boolean false
19880 If this option is set true, nothing is logged for any
19881 deliveries by the transport or for any
19882 transport errors. You should not set this option unless you really, really know
19883 what you are doing.
19884
19885
19886 .option debug_print transports string&!! unset
19887 .cindex "testing" "variables in drivers"
19888 If this option is set and debugging is enabled (see the &%-d%& command line
19889 option), the string is expanded and included in the debugging output when the
19890 transport is run.
19891 If expansion of the string fails, the error message is written to the debugging
19892 output, and Exim carries on processing.
19893 This facility is provided to help with checking out the values of variables and
19894 so on when debugging driver configurations. For example, if a &%headers_add%&
19895 option is not working properly, &%debug_print%& could be used to output the
19896 variables it references. A newline is added to the text if it does not end with
19897 one.
19898 The variables &$transport_name$& and &$router_name$& contain the name of the
19899 transport and the router that called it.
19900
19901 .option delivery_date_add transports boolean false
19902 .cindex "&'Delivery-date:'& header line"
19903 If this option is true, a &'Delivery-date:'& header is added to the message.
19904 This gives the actual time the delivery was made. As this is not a standard
19905 header, Exim has a configuration option (&%delivery_date_remove%&) which
19906 requests its removal from incoming messages, so that delivered messages can
19907 safely be resent to other recipients.
19908
19909
19910 .option driver transports string unset
19911 This specifies which of the available transport drivers is to be used.
19912 There is no default, and this option must be set for every transport.
19913
19914
19915 .option envelope_to_add transports boolean false
19916 .cindex "&'Envelope-to:'& header line"
19917 If this option is true, an &'Envelope-to:'& header is added to the message.
19918 This gives the original address(es) in the incoming envelope that caused this
19919 delivery to happen. More than one address may be present if the transport is
19920 configured to handle several addresses at once, or if more than one original
19921 address was redirected to the same final address. As this is not a standard
19922 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19923 its removal from incoming messages, so that delivered messages can safely be
19924 resent to other recipients.
19925
19926
19927 .option group transports string&!! "Exim group"
19928 .cindex "transport" "group; specifying"
19929 This option specifies a gid for running the transport process, overriding any
19930 value that the router supplies, and also overriding any value associated with
19931 &%user%& (see below).
19932
19933
19934 .option headers_add transports list&!! unset
19935 .cindex "header lines" "adding in transport"
19936 .cindex "transport" "header lines; adding"
19937 This option specifies a list of text headers, newline-separated,
19938 which are (separately) expanded and added to the header
19939 portion of a message as it is transported, as described in section
19940 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19941 routers. If the result of the expansion is an empty string, or if the expansion
19942 is forced to fail, no action is taken. Other expansion failures are treated as
19943 errors and cause the delivery to be deferred.
19944
19945 Unlike most options, &%headers_add%& can be specified multiple times
19946 for a transport; all listed headers are added.
19947
19948
19949 .option headers_only transports boolean false
19950 .cindex "transport" "header lines only"
19951 .cindex "message" "transporting headers only"
19952 .cindex "header lines" "transporting"
19953 If this option is set, the message's body is not transported. It is mutually
19954 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19955 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19956 checked, since this option does not automatically suppress them.
19957
19958
19959 .option headers_remove transports list&!! unset
19960 .cindex "header lines" "removing"
19961 .cindex "transport" "header lines; removing"
19962 This option specifies a list of header names, colon-separated;
19963 these headers are omitted from the message as it is transported, as described
19964 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19965 routers.
19966 Each list item is separately expanded.
19967 If the result of the expansion is an empty string, or if the expansion
19968 is forced to fail, no action is taken. Other expansion failures are treated as
19969 errors and cause the delivery to be deferred.
19970
19971 Unlike most options, &%headers_remove%& can be specified multiple times
19972 for a router; all listed headers are removed.
19973
19974
19975
19976 .option headers_rewrite transports string unset
19977 .cindex "transport" "header lines; rewriting"
19978 .cindex "rewriting" "at transport time"
19979 This option allows addresses in header lines to be rewritten at transport time,
19980 that is, as the message is being copied to its destination. The contents of the
19981 option are a colon-separated list of rewriting rules. Each rule is in exactly
19982 the same form as one of the general rewriting rules that are applied when a
19983 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19984 example,
19985 .code
19986 headers_rewrite = a@b c@d f : \
19987                   x@y w@z
19988 .endd
19989 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19990 &'w@z'& in all address-bearing header lines. The rules are applied to the
19991 header lines just before they are written out at transport time, so they affect
19992 only those copies of the message that pass through the transport. However, only
19993 the message's original header lines, and any that were added by a system
19994 filter, are rewritten. If a router or transport adds header lines, they are not
19995 affected by this option. These rewriting rules are &'not'& applied to the
19996 envelope. You can change the return path using &%return_path%&, but you cannot
19997 change envelope recipients at this time.
19998
19999
20000 .option home_directory transports string&!! unset
20001 .cindex "transport" "home directory for"
20002 .vindex "&$home$&"
20003 This option specifies a home directory setting for a local transport,
20004 overriding any value that may be set by the router. The home directory is
20005 placed in &$home$& while expanding the transport's private options. It is also
20006 used as the current directory if no current directory is set by the
20007 &%current_directory%& option on the transport or the
20008 &%transport_current_directory%& option on the router. If the expansion fails
20009 for any reason, including forced failure, an error is logged, and delivery is
20010 deferred.
20011
20012
20013 .option initgroups transports boolean false
20014 .cindex "additional groups"
20015 .cindex "groups" "additional"
20016 .cindex "transport" "group; additional"
20017 If this option is true and the uid for the delivery process is provided by the
20018 transport, the &[initgroups()]& function is called when running the transport
20019 to ensure that any additional groups associated with the uid are set up.
20020
20021
20022 .option message_size_limit transports string&!! 0
20023 .cindex "limit" "message size per transport"
20024 .cindex "size" "of message, limit"
20025 .cindex "transport" "message size; limiting"
20026 This option controls the size of messages passed through the transport. It is
20027 expanded before use; the result of the expansion must be a sequence of decimal
20028 digits, optionally followed by K or M. If the expansion fails for any reason,
20029 including forced failure, or if the result is not of the required form,
20030 delivery is deferred. If the value is greater than zero and the size of a
20031 message exceeds this limit, the address is failed. If there is any chance that
20032 the resulting bounce message could be routed to the same transport, you should
20033 ensure that &%return_size_limit%& is less than the transport's
20034 &%message_size_limit%&, as otherwise the bounce message will fail to get
20035 delivered.
20036
20037
20038
20039 .option rcpt_include_affixes transports boolean false
20040 .cindex "prefix" "for local part, including in envelope"
20041 .cindex "suffix for local part" "including in envelope"
20042 .cindex "local part" "prefix"
20043 .cindex "local part" "suffix"
20044 When this option is false (the default), and an address that has had any
20045 affixes (prefixes or suffixes) removed from the local part is delivered by any
20046 form of SMTP or LMTP, the affixes are not included. For example, if a router
20047 that contains
20048 .code
20049 local_part_prefix = *-
20050 .endd
20051 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20052 is delivered with
20053 .code
20054 RCPT TO:<xyz@some.domain>
20055 .endd
20056 This is also the case when an ACL-time callout is being used to verify a
20057 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20058 whole local part is included in the RCPT command. This option applies to BSMTP
20059 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20060 &(lmtp)& and &(smtp)& transports.
20061
20062
20063 .option retry_use_local_part transports boolean "see below"
20064 .cindex "hints database" "retry keys"
20065 When a delivery suffers a temporary failure, a retry record is created
20066 in Exim's hints database. For remote deliveries, the key for the retry record
20067 is based on the name and/or IP address of the failing remote host. For local
20068 deliveries, the key is normally the entire address, including both the local
20069 part and the domain. This is suitable for most common cases of local delivery
20070 temporary failure &-- for example, exceeding a mailbox quota should delay only
20071 deliveries to that mailbox, not to the whole domain.
20072
20073 However, in some special cases you may want to treat a temporary local delivery
20074 as a failure associated with the domain, and not with a particular local part.
20075 (For example, if you are storing all mail for some domain in files.) You can do
20076 this by setting &%retry_use_local_part%& false.
20077
20078 For all the local transports, its default value is true. For remote transports,
20079 the default value is false for tidiness, but changing the value has no effect
20080 on a remote transport in the current implementation.
20081
20082
20083 .option return_path transports string&!! unset
20084 .cindex "envelope sender"
20085 .cindex "transport" "return path; changing"
20086 .cindex "return path" "changing in transport"
20087 If this option is set, the string is expanded at transport time and replaces
20088 the existing return path (envelope sender) value in the copy of the message
20089 that is being delivered. An empty return path is permitted. This feature is
20090 designed for remote deliveries, where the value of this option is used in the
20091 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20092 only effect is to change the address that is placed in the &'Return-path:'&
20093 header line, if one is added to the message (see the next option).
20094
20095 &*Note:*& A changed return path is not logged unless you add
20096 &%return_path_on_delivery%& to the log selector.
20097
20098 .vindex "&$return_path$&"
20099 The expansion can refer to the existing value via &$return_path$&. This is
20100 either the message's envelope sender, or an address set by the
20101 &%errors_to%& option on a router. If the expansion is forced to fail, no
20102 replacement occurs; if it fails for another reason, delivery is deferred. This
20103 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20104 section &<<SECTverp>>&.
20105
20106 &*Note*&: If a delivery error is detected locally, including the case when a
20107 remote server rejects a message at SMTP time, the bounce message is not sent to
20108 the value of this option. It is sent to the previously set errors address.
20109 This defaults to the incoming sender address, but can be changed by setting
20110 &%errors_to%& in a router.
20111
20112
20113
20114 .option return_path_add transports boolean false
20115 .cindex "&'Return-path:'& header line"
20116 If this option is true, a &'Return-path:'& header is added to the message.
20117 Although the return path is normally available in the prefix line of BSD
20118 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20119 have easy access to it.
20120
20121 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20122 the delivery SMTP server makes the final delivery"&. This implies that this
20123 header should not be present in incoming messages. Exim has a configuration
20124 option, &%return_path_remove%&, which requests removal of this header from
20125 incoming messages, so that delivered messages can safely be resent to other
20126 recipients.
20127
20128
20129 .option shadow_condition transports string&!! unset
20130 See &%shadow_transport%& below.
20131
20132
20133 .option shadow_transport transports string unset
20134 .cindex "shadow transport"
20135 .cindex "transport" "shadow"
20136 A local transport may set the &%shadow_transport%& option to the name of
20137 another local transport. Shadow remote transports are not supported.
20138
20139 Whenever a delivery to the main transport succeeds, and either
20140 &%shadow_condition%& is unset, or its expansion does not result in the empty
20141 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20142 passed to the shadow transport, with the same delivery address or addresses. If
20143 expansion fails, no action is taken except that non-forced expansion failures
20144 cause a log line to be written.
20145
20146 The result of the shadow transport is discarded and does not affect the
20147 subsequent processing of the message. Only a single level of shadowing is
20148 provided; the &%shadow_transport%& option is ignored on any transport when it
20149 is running as a shadow. Options concerned with output from pipes are also
20150 ignored. The log line for the successful delivery has an item added on the end,
20151 of the form
20152 .code
20153 ST=<shadow transport name>
20154 .endd
20155 If the shadow transport did not succeed, the error message is put in
20156 parentheses afterwards. Shadow transports can be used for a number of different
20157 purposes, including keeping more detailed log information than Exim normally
20158 provides, and implementing automatic acknowledgment policies based on message
20159 headers that some sites insist on.
20160
20161
20162 .option transport_filter transports string&!! unset
20163 .cindex "transport" "filter"
20164 .cindex "filter" "transport filter"
20165 This option sets up a filtering (in the Unix shell sense) process for messages
20166 at transport time. It should not be confused with mail filtering as set up by
20167 individual users or via a system filter.
20168
20169 When the message is about to be written out, the command specified by
20170 &%transport_filter%& is started up in a separate, parallel process, and
20171 the entire message, including the header lines, is passed to it on its standard
20172 input (this in fact is done from a third process, to avoid deadlock). The
20173 command must be specified as an absolute path.
20174
20175 The lines of the message that are written to the transport filter are
20176 terminated by newline (&"\n"&). The message is passed to the filter before any
20177 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20178 lines beginning with a dot, and also before any processing implied by the
20179 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20180 &(pipe)& transports.
20181
20182 The standard error for the filter process is set to the same destination as its
20183 standard output; this is read and written to the message's ultimate
20184 destination. The process that writes the message to the filter, the
20185 filter itself, and the original process that reads the result and delivers it
20186 are all run in parallel, like a shell pipeline.
20187
20188 The filter can perform any transformations it likes, but of course should take
20189 care not to break RFC 2822 syntax. Exim does not check the result, except to
20190 test for a final newline when SMTP is in use. All messages transmitted over
20191 SMTP must end with a newline, so Exim supplies one if it is missing.
20192
20193 .cindex "content scanning" "per user"
20194 A transport filter can be used to provide content-scanning on a per-user basis
20195 at delivery time if the only required effect of the scan is to modify the
20196 message. For example, a content scan could insert a new header line containing
20197 a spam score. This could be interpreted by a filter in the user's MUA. It is
20198 not possible to discard a message at this stage.
20199
20200 .cindex "SMTP" "SIZE"
20201 A problem might arise if the filter increases the size of a message that is
20202 being sent down an SMTP connection. If the receiving SMTP server has indicated
20203 support for the SIZE parameter, Exim will have sent the size of the message
20204 at the start of the SMTP session. If what is actually sent is substantially
20205 more, the server might reject the message. This can be worked round by setting
20206 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20207 additions to the message, or to disable the use of SIZE altogether.
20208
20209 .vindex "&$pipe_addresses$&"
20210 The value of the &%transport_filter%& option is the command string for starting
20211 the filter, which is run directly from Exim, not under a shell. The string is
20212 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20213 Exim breaks it up into arguments and then expands each argument separately (see
20214 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20215 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20216 of arguments, one for each address that applies to this delivery. (This isn't
20217 an ideal name for this feature here, but as it was already implemented for the
20218 &(pipe)& transport, it seemed sensible not to change it.)
20219
20220 .vindex "&$host$&"
20221 .vindex "&$host_address$&"
20222 The expansion variables &$host$& and &$host_address$& are available when the
20223 transport is a remote one. They contain the name and IP address of the host to
20224 which the message is being sent. For example:
20225 .code
20226 transport_filter = /some/directory/transport-filter.pl \
20227   $host $host_address $sender_address $pipe_addresses
20228 .endd
20229
20230 Two problems arise if you want to use more complicated expansion items to
20231 generate transport filter commands, both of which due to the fact that the
20232 command is split up &'before'& expansion.
20233 .ilist
20234 If an expansion item contains white space, you must quote it, so that it is all
20235 part of the same command item. If the entire option setting is one such
20236 expansion item, you have to take care what kind of quoting you use. For
20237 example:
20238 .code
20239 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20240 .endd
20241 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20242 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20243 stripped by Exim when it read the option's value. When the value is used, if
20244 the single quotes were missing, the line would be split into two items,
20245 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20246 Exim tried to expand the first one.
20247 .next
20248 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20249 expansion cannot generate multiple arguments, or a command name followed by
20250 arguments. Consider this example:
20251 .code
20252 transport_filter = ${lookup{$host}lsearch{/a/file}\
20253                     {$value}{/bin/cat}}
20254 .endd
20255 The result of the lookup is interpreted as the name of the command, even
20256 if it contains white space. The simplest way round this is to use a shell:
20257 .code
20258 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20259                                {$value}{/bin/cat}}
20260 .endd
20261 .endlist
20262
20263 The filter process is run under the same uid and gid as the normal delivery.
20264 For remote deliveries this is the Exim uid/gid by default. The command should
20265 normally yield a zero return code. Transport filters are not supposed to fail.
20266 A non-zero code is taken to mean that the transport filter encountered some
20267 serious problem. Delivery of the message is deferred; the message remains on
20268 the queue and is tried again later. It is not possible to cause a message to be
20269 bounced from a transport filter.
20270
20271 If a transport filter is set on an autoreply transport, the original message is
20272 passed through the filter as it is being copied into the newly generated
20273 message, which happens if the &%return_message%& option is set.
20274
20275
20276 .option transport_filter_timeout transports time 5m
20277 .cindex "transport" "filter, timeout"
20278 When Exim is reading the output of a transport filter, it applies a timeout
20279 that can be set by this option. Exceeding the timeout is normally treated as a
20280 temporary delivery failure. However, if a transport filter is used with a
20281 &(pipe)& transport, a timeout in the transport filter is treated in the same
20282 way as a timeout in the pipe command itself. By default, a timeout is a hard
20283 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20284 becomes a temporary error.
20285
20286
20287 .option user transports string&!! "Exim user"
20288 .cindex "uid (user id)" "local delivery"
20289 .cindex "transport" "user, specifying"
20290 This option specifies the user under whose uid the delivery process is to be
20291 run, overriding any uid that may have been set by the router. If the user is
20292 given as a name, the uid is looked up from the password data, and the
20293 associated group is taken as the value of the gid to be used if the &%group%&
20294 option is not set.
20295
20296 For deliveries that use local transports, a user and group are normally
20297 specified explicitly or implicitly (for example, as a result of
20298 &%check_local_user%&) by the router or transport.
20299
20300 .cindex "hints database" "access by remote transport"
20301 For remote transports, you should leave this option unset unless you really are
20302 sure you know what you are doing. When a remote transport is running, it needs
20303 to be able to access Exim's hints databases, because each host may have its own
20304 retry data.
20305 .ecindex IIDgenoptra1
20306 .ecindex IIDgenoptra2
20307 .ecindex IIDgenoptra3
20308
20309
20310
20311
20312
20313
20314 . ////////////////////////////////////////////////////////////////////////////
20315 . ////////////////////////////////////////////////////////////////////////////
20316
20317 .chapter "Address batching in local transports" "CHAPbatching" &&&
20318          "Address batching"
20319 .cindex "transport" "local; address batching in"
20320 The only remote transport (&(smtp)&) is normally configured to handle more than
20321 one address at a time, so that when several addresses are routed to the same
20322 remote host, just one copy of the message is sent. Local transports, however,
20323 normally handle one address at a time. That is, a separate instance of the
20324 transport is run for each address that is routed to the transport. A separate
20325 copy of the message is delivered each time.
20326
20327 .cindex "batched local delivery"
20328 .oindex "&%batch_max%&"
20329 .oindex "&%batch_id%&"
20330 In special cases, it may be desirable to handle several addresses at once in a
20331 local transport, for example:
20332
20333 .ilist
20334 In an &(appendfile)& transport, when storing messages in files for later
20335 delivery by some other means, a single copy of the message with multiple
20336 recipients saves space.
20337 .next
20338 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20339 a single copy saves time, and is the normal way LMTP is expected to work.
20340 .next
20341 In a &(pipe)& transport, when passing the message
20342 to a scanner program or
20343 to some other delivery mechanism such as UUCP, multiple recipients may be
20344 acceptable.
20345 .endlist
20346
20347 These three local transports all have the same options for controlling multiple
20348 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20349 repeating the information for each transport, these options are described here.
20350
20351 The &%batch_max%& option specifies the maximum number of addresses that can be
20352 delivered together in a single run of the transport. Its default value is one
20353 (no batching). When more than one address is routed to a transport that has a
20354 &%batch_max%& value greater than one, the addresses are delivered in a batch
20355 (that is, in a single run of the transport with multiple recipients), subject
20356 to certain conditions:
20357
20358 .ilist
20359 .vindex "&$local_part$&"
20360 If any of the transport's options contain a reference to &$local_part$&, no
20361 batching is possible.
20362 .next
20363 .vindex "&$domain$&"
20364 If any of the transport's options contain a reference to &$domain$&, only
20365 addresses with the same domain are batched.
20366 .next
20367 .cindex "customizing" "batching condition"
20368 If &%batch_id%& is set, it is expanded for each address, and only those
20369 addresses with the same expanded value are batched. This allows you to specify
20370 customized batching conditions. Failure of the expansion for any reason,
20371 including forced failure, disables batching, but it does not stop the delivery
20372 from taking place.
20373 .next
20374 Batched addresses must also have the same errors address (where to send
20375 delivery errors), the same header additions and removals, the same user and
20376 group for the transport, and if a host list is present, the first host must
20377 be the same.
20378 .endlist
20379
20380 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20381 both when the file or pipe command is specified in the transport, and when it
20382 is specified by a &(redirect)& router, but all the batched addresses must of
20383 course be routed to the same file or pipe command. These two transports have an
20384 option called &%use_bsmtp%&, which causes them to deliver the message in
20385 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20386 &%check_string%& and &%escape_string%& options are forced to the values
20387 .code
20388 check_string = "."
20389 escape_string = ".."
20390 .endd
20391 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20392 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20393 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20394
20395 .cindex "&'Envelope-to:'& header line"
20396 If the generic &%envelope_to_add%& option is set for a batching transport, the
20397 &'Envelope-to:'& header that is added to the message contains all the addresses
20398 that are being processed together. If you are using a batching &(appendfile)&
20399 transport without &%use_bsmtp%&, the only way to preserve the recipient
20400 addresses is to set the &%envelope_to_add%& option.
20401
20402 .cindex "&(pipe)& transport" "with multiple addresses"
20403 .vindex "&$pipe_addresses$&"
20404 If you are using a &(pipe)& transport without BSMTP, and setting the
20405 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20406 the command. This is not a true variable; it is a bit of magic that causes each
20407 of the recipient addresses to be inserted into the command as a separate
20408 argument. This provides a way of accessing all the addresses that are being
20409 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20410 are specified by a &(redirect)& router.
20411
20412
20413
20414
20415 . ////////////////////////////////////////////////////////////////////////////
20416 . ////////////////////////////////////////////////////////////////////////////
20417
20418 .chapter "The appendfile transport" "CHAPappendfile"
20419 .scindex IIDapptra1 "&(appendfile)& transport"
20420 .scindex IIDapptra2 "transports" "&(appendfile)&"
20421 .cindex "directory creation"
20422 .cindex "creating directories"
20423 The &(appendfile)& transport delivers a message by appending it to an existing
20424 file, or by creating an entirely new file in a specified directory. Single
20425 files to which messages are appended can be in the traditional Unix mailbox
20426 format, or optionally in the MBX format supported by the Pine MUA and
20427 University of Washington IMAP daemon, &'inter alia'&. When each message is
20428 being delivered as a separate file, &"maildir"& format can optionally be used
20429 to give added protection against failures that happen part-way through the
20430 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20431 supported. For all file formats, Exim attempts to create as many levels of
20432 directory as necessary, provided that &%create_directory%& is set.
20433
20434 The code for the optional formats is not included in the Exim binary by
20435 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20436 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20437 included.
20438
20439 .cindex "quota" "system"
20440 Exim recognizes system quota errors, and generates an appropriate message. Exim
20441 also supports its own quota control within the transport, for use when the
20442 system facility is unavailable or cannot be used for some reason.
20443
20444 If there is an error while appending to a file (for example, quota exceeded or
20445 partition filled), Exim attempts to reset the file's length and last
20446 modification time back to what they were before. If there is an error while
20447 creating an entirely new file, the new file is removed.
20448
20449 Before appending to a file, a number of security checks are made, and the
20450 file is locked. A detailed description is given below, after the list of
20451 private options.
20452
20453 The &(appendfile)& transport is most commonly used for local deliveries to
20454 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20455 putting messages into files for remote delivery by some means other than Exim.
20456 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20457 option).
20458
20459
20460
20461 .section "The file and directory options" "SECTfildiropt"
20462 The &%file%& option specifies a single file, to which the message is appended;
20463 the &%directory%& option specifies a directory, in which a new file containing
20464 the message is created. Only one of these two options can be set, and for
20465 normal deliveries to mailboxes, one of them &'must'& be set.
20466
20467 .vindex "&$address_file$&"
20468 .vindex "&$local_part$&"
20469 However, &(appendfile)& is also used for delivering messages to files or
20470 directories whose names (or parts of names) are obtained from alias,
20471 forwarding, or filtering operations (for example, a &%save%& command in a
20472 user's Exim filter). When such a transport is running, &$local_part$& contains
20473 the local part that was aliased or forwarded, and &$address_file$& contains the
20474 name (or partial name) of the file or directory generated by the redirection
20475 operation. There are two cases:
20476
20477 .ilist
20478 If neither &%file%& nor &%directory%& is set, the redirection operation
20479 must specify an absolute path (one that begins with &`/`&). This is the most
20480 common case when users with local accounts use filtering to sort mail into
20481 different folders. See for example, the &(address_file)& transport in the
20482 default configuration. If the path ends with a slash, it is assumed to be the
20483 name of a directory. A delivery to a directory can also be forced by setting
20484 &%maildir_format%& or &%mailstore_format%&.
20485 .next
20486 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20487 used to determine the file or directory name for the delivery. Normally, the
20488 contents of &$address_file$& are used in some way in the string expansion.
20489 .endlist
20490
20491
20492 .cindex "Sieve filter" "configuring &(appendfile)&"
20493 .cindex "Sieve filter" "relative mailbox path handling"
20494 As an example of the second case, consider an environment where users do not
20495 have home directories. They may be permitted to use Exim filter commands of the
20496 form:
20497 .code
20498 save folder23
20499 .endd
20500 or Sieve filter commands of the form:
20501 .code
20502 require "fileinto";
20503 fileinto "folder23";
20504 .endd
20505 In this situation, the expansion of &%file%& or &%directory%& in the transport
20506 must transform the relative path into an appropriate absolute file name. In the
20507 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20508 is used as a result of a &"keep"& action in the filter. This example shows one
20509 way of handling this requirement:
20510 .code
20511 file = ${if eq{$address_file}{inbox} \
20512             {/var/mail/$local_part} \
20513             {${if eq{${substr_0_1:$address_file}}{/} \
20514                   {$address_file} \
20515                   {$home/mail/$address_file} \
20516             }} \
20517        }
20518 .endd
20519 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20520 location, absolute paths are used without change, and other folders are in the
20521 &_mail_& directory within the home directory.
20522
20523 &*Note 1*&: While processing an Exim filter, a relative path such as
20524 &_folder23_& is turned into an absolute path if a home directory is known to
20525 the router. In particular, this is the case if &%check_local_user%& is set. If
20526 you want to prevent this happening at routing time, you can set
20527 &%router_home_directory%& empty. This forces the router to pass the relative
20528 path to the transport.
20529
20530 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20531 the &%file%& or &%directory%& option is still used if it is set.
20532
20533
20534
20535
20536 .section "Private options for appendfile" "SECID134"
20537 .cindex "options" "&(appendfile)& transport"
20538
20539
20540
20541 .option allow_fifo appendfile boolean false
20542 .cindex "fifo (named pipe)"
20543 .cindex "named pipe (fifo)"
20544 .cindex "pipe" "named (fifo)"
20545 Setting this option permits delivery to named pipes (FIFOs) as well as to
20546 regular files. If no process is reading the named pipe at delivery time, the
20547 delivery is deferred.
20548
20549
20550 .option allow_symlink appendfile boolean false
20551 .cindex "symbolic link" "to mailbox"
20552 .cindex "mailbox" "symbolic link"
20553 By default, &(appendfile)& will not deliver if the path name for the file is
20554 that of a symbolic link. Setting this option relaxes that constraint, but there
20555 are security issues involved in the use of symbolic links. Be sure you know
20556 what you are doing if you set this. Details of exactly what this option affects
20557 are included in the discussion which follows this list of options.
20558
20559
20560 .option batch_id appendfile string&!! unset
20561 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20562 However, batching is automatically disabled for &(appendfile)& deliveries that
20563 happen as a result of forwarding or aliasing or other redirection directly to a
20564 file.
20565
20566
20567 .option batch_max appendfile integer 1
20568 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20569
20570
20571 .option check_group appendfile boolean false
20572 When this option is set, the group owner of the file defined by the &%file%&
20573 option is checked to see that it is the same as the group under which the
20574 delivery process is running. The default setting is false because the default
20575 file mode is 0600, which means that the group is irrelevant.
20576
20577
20578 .option check_owner appendfile boolean true
20579 When this option is set, the owner of the file defined by the &%file%& option
20580 is checked to ensure that it is the same as the user under which the delivery
20581 process is running.
20582
20583
20584 .option check_string appendfile string "see below"
20585 .cindex "&""From""& line"
20586 As &(appendfile)& writes the message, the start of each line is tested for
20587 matching &%check_string%&, and if it does, the initial matching characters are
20588 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20589 a literal string, not a regular expression, and the case of any letters it
20590 contains is significant.
20591
20592 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20593 are forced to &"."& and &".."& respectively, and any settings in the
20594 configuration are ignored. Otherwise, they default to &"From&~"& and
20595 &">From&~"& when the &%file%& option is set, and unset when any of the
20596 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20597
20598 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20599 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20600 &"From&~"& indicates the start of a new message. All four options need changing
20601 if another format is used. For example, to deliver to mailboxes in MMDF format:
20602 .cindex "MMDF format mailbox"
20603 .cindex "mailbox" "MMDF format"
20604 .code
20605 check_string = "\1\1\1\1\n"
20606 escape_string = "\1\1\1\1 \n"
20607 message_prefix = "\1\1\1\1\n"
20608 message_suffix = "\1\1\1\1\n"
20609 .endd
20610 .option create_directory appendfile boolean true
20611 .cindex "directory creation"
20612 When this option is true, Exim attempts to create any missing superior
20613 directories for the file that it is about to write. A created directory's mode
20614 is given by the &%directory_mode%& option.
20615
20616 The group ownership of a newly created directory is highly dependent on the
20617 operating system (and possibly the file system) that is being used. For
20618 example, in Solaris, if the parent directory has the setgid bit set, its group
20619 is propagated to the child; if not, the currently set group is used. However,
20620 in FreeBSD, the parent's group is always used.
20621
20622
20623
20624 .option create_file appendfile string anywhere
20625 This option constrains the location of files and directories that are created
20626 by this transport. It applies to files defined by the &%file%& option and
20627 directories defined by the &%directory%& option. In the case of maildir
20628 delivery, it applies to the top level directory, not the maildir directories
20629 beneath.
20630
20631 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20632 &"belowhome"&. In the second and third cases, a home directory must have been
20633 set for the transport. This option is not useful when an explicit file name is
20634 given for normal mailbox deliveries. It is intended for the case when file
20635 names are generated from users' &_.forward_& files. These are usually handled
20636 by an &(appendfile)& transport called &%address_file%&. See also
20637 &%file_must_exist%&.
20638
20639
20640 .option directory appendfile string&!! unset
20641 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20642 or &%directory%& must be set, unless the delivery is the direct result of a
20643 redirection (see section &<<SECTfildiropt>>&).
20644
20645 When &%directory%& is set, the string is expanded, and the message is delivered
20646 into a new file or files in or below the given directory, instead of being
20647 appended to a single mailbox file. A number of different formats are provided
20648 (see &%maildir_format%& and &%mailstore_format%&), and see section
20649 &<<SECTopdir>>& for further details of this form of delivery.
20650
20651
20652 .option directory_file appendfile string&!! "see below"
20653 .cindex "base62"
20654 .vindex "&$inode$&"
20655 When &%directory%& is set, but neither &%maildir_format%& nor
20656 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20657 whose name is obtained by expanding this string. The default value is:
20658 .code
20659 q${base62:$tod_epoch}-$inode
20660 .endd
20661 This generates a unique name from the current time, in base 62 form, and the
20662 inode of the file. The variable &$inode$& is available only when expanding this
20663 option.
20664
20665
20666 .option directory_mode appendfile "octal integer" 0700
20667 If &(appendfile)& creates any directories as a result of the
20668 &%create_directory%& option, their mode is specified by this option.
20669
20670
20671 .option escape_string appendfile string "see description"
20672 See &%check_string%& above.
20673
20674
20675 .option file appendfile string&!! unset
20676 This option is mutually exclusive with the &%directory%& option, but one of
20677 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20678 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20679 specifies a single file, to which the message is appended. One or more of
20680 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20681 &%file%&.
20682
20683 .cindex "NFS" "lock file"
20684 .cindex "locking files"
20685 .cindex "lock files"
20686 If you are using more than one host to deliver over NFS into the same
20687 mailboxes, you should always use lock files.
20688
20689 The string value is expanded for each delivery, and must yield an absolute
20690 path. The most common settings of this option are variations on one of these
20691 examples:
20692 .code
20693 file = /var/spool/mail/$local_part
20694 file = /home/$local_part/inbox
20695 file = $home/inbox
20696 .endd
20697 .cindex "&""sticky""& bit"
20698 In the first example, all deliveries are done into the same directory. If Exim
20699 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20700 create a file in the directory, so the &"sticky"& bit must be turned on for
20701 deliveries to be possible, or alternatively the &%group%& option can be used to
20702 run the delivery under a group id which has write access to the directory.
20703
20704
20705
20706 .option file_format appendfile string unset
20707 .cindex "file" "mailbox; checking existing format"
20708 This option requests the transport to check the format of an existing file
20709 before adding to it. The check consists of matching a specific string at the
20710 start of the file. The value of the option consists of an even number of
20711 colon-separated strings. The first of each pair is the test string, and the
20712 second is the name of a transport. If the transport associated with a matched
20713 string is not the current transport, control is passed over to the other
20714 transport. For example, suppose the standard &(local_delivery)& transport has
20715 this added to it:
20716 .code
20717 file_format = "From       : local_delivery :\
20718                \1\1\1\1\n : local_mmdf_delivery"
20719 .endd
20720 Mailboxes that begin with &"From"& are still handled by this transport, but if
20721 a mailbox begins with four binary ones followed by a newline, control is passed
20722 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20723 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20724 is assumed to match the current transport. If the start of a mailbox doesn't
20725 match any string, or if the transport named for a given string is not defined,
20726 delivery is deferred.
20727
20728
20729 .option file_must_exist appendfile boolean false
20730 If this option is true, the file specified by the &%file%& option must exist.
20731 A temporary error occurs if it does not, causing delivery to be deferred.
20732 If this option is false, the file is created if it does not exist.
20733
20734
20735 .option lock_fcntl_timeout appendfile time 0s
20736 .cindex "timeout" "mailbox locking"
20737 .cindex "mailbox" "locking, blocking and non-blocking"
20738 .cindex "locking files"
20739 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20740 when locking an open mailbox file. If the call fails, the delivery process
20741 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20742 Non-blocking calls are used so that the file is not kept open during the wait
20743 for the lock; the reason for this is to make it as safe as possible for
20744 deliveries over NFS in the case when processes might be accessing an NFS
20745 mailbox without using a lock file. This should not be done, but
20746 misunderstandings and hence misconfigurations are not unknown.
20747
20748 On a busy system, however, the performance of a non-blocking lock approach is
20749 not as good as using a blocking lock with a timeout. In this case, the waiting
20750 is done inside the system call, and Exim's delivery process acquires the lock
20751 and can proceed as soon as the previous lock holder releases it.
20752
20753 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20754 timeout, are used. There may still be some retrying: the maximum number of
20755 retries is
20756 .code
20757 (lock_retries * lock_interval) / lock_fcntl_timeout
20758 .endd
20759 rounded up to the next whole number. In other words, the total time during
20760 which &(appendfile)& is trying to get a lock is roughly the same, unless
20761 &%lock_fcntl_timeout%& is set very large.
20762
20763 You should consider setting this option if you are getting a lot of delayed
20764 local deliveries because of errors of the form
20765 .code
20766 failed to lock mailbox /some/file (fcntl)
20767 .endd
20768
20769 .option lock_flock_timeout appendfile time 0s
20770 This timeout applies to file locking when using &[flock()]& (see
20771 &%use_flock%&); the timeout operates in a similar manner to
20772 &%lock_fcntl_timeout%&.
20773
20774
20775 .option lock_interval appendfile time 3s
20776 This specifies the time to wait between attempts to lock the file. See below
20777 for details of locking.
20778
20779
20780 .option lock_retries appendfile integer 10
20781 This specifies the maximum number of attempts to lock the file. A value of zero
20782 is treated as 1. See below for details of locking.
20783
20784
20785 .option lockfile_mode appendfile "octal integer" 0600
20786 This specifies the mode of the created lock file, when a lock file is being
20787 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20788
20789
20790 .option lockfile_timeout appendfile time 30m
20791 .cindex "timeout" "mailbox locking"
20792 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20793 exists and is older than this value, it is assumed to have been left behind by
20794 accident, and Exim attempts to remove it.
20795
20796
20797 .option mailbox_filecount appendfile string&!! unset
20798 .cindex "mailbox" "specifying size of"
20799 .cindex "size" "of mailbox"
20800 If this option is set, it is expanded, and the result is taken as the current
20801 number of files in the mailbox. It must be a decimal number, optionally
20802 followed by K or M. This provides a way of obtaining this information from an
20803 external source that maintains the data.
20804
20805
20806 .option mailbox_size appendfile string&!! unset
20807 .cindex "mailbox" "specifying size of"
20808 .cindex "size" "of mailbox"
20809 If this option is set, it is expanded, and the result is taken as the current
20810 size the mailbox. It must be a decimal number, optionally followed by K or M.
20811 This provides a way of obtaining this information from an external source that
20812 maintains the data. This is likely to be helpful for maildir deliveries where
20813 it is computationally expensive to compute the size of a mailbox.
20814
20815
20816
20817 .option maildir_format appendfile boolean false
20818 .cindex "maildir format" "specifying"
20819 If this option is set with the &%directory%& option, the delivery is into a new
20820 file, in the &"maildir"& format that is used by other mail software. When the
20821 transport is activated directly from a &(redirect)& router (for example, the
20822 &(address_file)& transport in the default configuration), setting
20823 &%maildir_format%& causes the path received from the router to be treated as a
20824 directory, whether or not it ends with &`/`&. This option is available only if
20825 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20826 &<<SECTmaildirdelivery>>& below for further details.
20827
20828
20829 .option maildir_quota_directory_regex appendfile string "See below"
20830 .cindex "maildir format" "quota; directories included in"
20831 .cindex "quota" "maildir; directories included in"
20832 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20833 a regular expression for specifying directories, relative to the quota
20834 directory (see &%quota_directory%&), that should be included in the quota
20835 calculation. The default value is:
20836 .code
20837 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20838 .endd
20839 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20840 (directories whose names begin with a dot). If you want to exclude the
20841 &_Trash_&
20842 folder from the count (as some sites do), you need to change this setting to
20843 .code
20844 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20845 .endd
20846 This uses a negative lookahead in the regular expression to exclude the
20847 directory whose name is &_.Trash_&. When a directory is excluded from quota
20848 calculations, quota processing is bypassed for any messages that are delivered
20849 directly into that directory.
20850
20851
20852 .option maildir_retries appendfile integer 10
20853 This option specifies the number of times to retry when writing a file in
20854 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20855
20856
20857 .option maildir_tag appendfile string&!! unset
20858 This option applies only to deliveries in maildir format, and is described in
20859 section &<<SECTmaildirdelivery>>& below.
20860
20861
20862 .option maildir_use_size_file appendfile&!! boolean false
20863 .cindex "maildir format" "&_maildirsize_& file"
20864 The result of string expansion for this option must be a valid boolean value.
20865 If it is true, it enables support for &_maildirsize_& files. Exim
20866 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20867 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20868 value is zero. See &%maildir_quota_directory_regex%& above and section
20869 &<<SECTmaildirdelivery>>& below for further details.
20870
20871 .option maildirfolder_create_regex appendfile string unset
20872 .cindex "maildir format" "&_maildirfolder_& file"
20873 .cindex "&_maildirfolder_&, creating"
20874 The value of this option is a regular expression. If it is unset, it has no
20875 effect. Otherwise, before a maildir delivery takes place, the pattern is
20876 matched against the name of the maildir directory, that is, the directory
20877 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20878 delivery. If there is a match, Exim checks for the existence of a file called
20879 &_maildirfolder_& in the directory, and creates it if it does not exist.
20880 See section &<<SECTmaildirdelivery>>& for more details.
20881
20882
20883 .option mailstore_format appendfile boolean false
20884 .cindex "mailstore format" "specifying"
20885 If this option is set with the &%directory%& option, the delivery is into two
20886 new files in  &"mailstore"& format. The option is available only if
20887 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20888 below for further details.
20889
20890
20891 .option mailstore_prefix appendfile string&!! unset
20892 This option applies only to deliveries in mailstore format, and is described in
20893 section &<<SECTopdir>>& below.
20894
20895
20896 .option mailstore_suffix appendfile string&!! unset
20897 This option applies only to deliveries in mailstore format, and is described in
20898 section &<<SECTopdir>>& below.
20899
20900
20901 .option mbx_format appendfile boolean false
20902 .cindex "locking files"
20903 .cindex "file" "locking"
20904 .cindex "file" "MBX format"
20905 .cindex "MBX format, specifying"
20906 This option is available only if Exim has been compiled with SUPPORT_MBX
20907 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20908 the message is appended to the mailbox file in MBX format instead of
20909 traditional Unix format. This format is supported by Pine4 and its associated
20910 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20911
20912 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20913 automatically changed by the use of &%mbx_format%&. They should normally be set
20914 empty when using MBX format, so this option almost always appears in this
20915 combination:
20916 .code
20917 mbx_format = true
20918 message_prefix =
20919 message_suffix =
20920 .endd
20921 If none of the locking options are mentioned in the configuration,
20922 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20923 is possible to specify the other kinds of locking with &%mbx_format%&, but
20924 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20925 interworks with &'c-client'&, providing for shared access to the mailbox. It
20926 should not be used if any program that does not use this form of locking is
20927 going to access the mailbox, nor should it be used if the mailbox file is NFS
20928 mounted, because it works only when the mailbox is accessed from a single host.
20929
20930 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20931 the standard version of &'c-client'&, because as long as it has a mailbox open
20932 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20933 append messages to it.
20934
20935
20936 .option message_prefix appendfile string&!! "see below"
20937 .cindex "&""From""& line"
20938 The string specified here is expanded and output at the start of every message.
20939 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20940 in which case it is:
20941 .code
20942 message_prefix = "From ${if def:return_path{$return_path}\
20943   {MAILER-DAEMON}} $tod_bsdinbox\n"
20944 .endd
20945 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20946 &`\n`& to &`\r\n`& in &%message_prefix%&.
20947
20948 .option message_suffix appendfile string&!! "see below"
20949 The string specified here is expanded and output at the end of every message.
20950 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20951 in which case it is a single newline character. The suffix can be suppressed by
20952 setting
20953 .code
20954 message_suffix =
20955 .endd
20956 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20957 &`\n`& to &`\r\n`& in &%message_suffix%&.
20958
20959 .option mode appendfile "octal integer" 0600
20960 If the output file is created, it is given this mode. If it already exists and
20961 has wider permissions, they are reduced to this mode. If it has narrower
20962 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20963 if the delivery is the result of a &%save%& command in a filter file specifying
20964 a particular mode, the mode of the output file is always forced to take that
20965 value, and this option is ignored.
20966
20967
20968 .option mode_fail_narrower appendfile boolean true
20969 This option applies in the case when an existing mailbox file has a narrower
20970 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20971 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20972 continues with the delivery attempt, using the existing mode of the file.
20973
20974
20975 .option notify_comsat appendfile boolean false
20976 If this option is true, the &'comsat'& daemon is notified after every
20977 successful delivery to a user mailbox. This is the daemon that notifies logged
20978 on users about incoming mail.
20979
20980
20981 .option quota appendfile string&!! unset
20982 .cindex "quota" "imposed by Exim"
20983 This option imposes a limit on the size of the file to which Exim is appending,
20984 or to the total space used in the directory tree when the &%directory%& option
20985 is set. In the latter case, computation of the space used is expensive, because
20986 all the files in the directory (and any sub-directories) have to be
20987 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20988 &%maildir_use_size_file%& for ways to avoid this in environments where users
20989 have no shell access to their mailboxes).
20990
20991 As there is no interlock against two simultaneous deliveries into a
20992 multi-file mailbox, it is possible for the quota to be overrun in this case.
20993 For single-file mailboxes, of course, an interlock is a necessity.
20994
20995 A file's size is taken as its &'used'& value. Because of blocking effects, this
20996 may be a lot less than the actual amount of disk space allocated to the file.
20997 If the sizes of a number of files are being added up, the rounding effect can
20998 become quite noticeable, especially on systems that have large block sizes.
20999 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21000 the obvious value which users understand most easily.
21001
21002 The value of the option is expanded, and must then be a numerical value
21003 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21004 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21005 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21006 be handled.
21007
21008 &*Note*&: A value of zero is interpreted as &"no quota"&.
21009
21010 The expansion happens while Exim is running as root, before it changes uid for
21011 the delivery. This means that files that are inaccessible to the end user can
21012 be used to hold quota values that are looked up in the expansion. When delivery
21013 fails because this quota is exceeded, the handling of the error is as for
21014 system quota failures.
21015
21016 By default, Exim's quota checking mimics system quotas, and restricts the
21017 mailbox to the specified maximum size, though the value is not accurate to the
21018 last byte, owing to separator lines and additional headers that may get added
21019 during message delivery. When a mailbox is nearly full, large messages may get
21020 refused even though small ones are accepted, because the size of the current
21021 message is added to the quota when the check is made. This behaviour can be
21022 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21023 for exceeding the quota does not include the current message. Thus, deliveries
21024 continue until the quota has been exceeded; thereafter, no further messages are
21025 delivered. See also &%quota_warn_threshold%&.
21026
21027
21028 .option quota_directory appendfile string&!! unset
21029 This option defines the directory to check for quota purposes when delivering
21030 into individual files. The default is the delivery directory, or, if a file
21031 called &_maildirfolder_& exists in a maildir directory, the parent of the
21032 delivery directory.
21033
21034
21035 .option quota_filecount appendfile string&!! 0
21036 This option applies when the &%directory%& option is set. It limits the total
21037 number of files in the directory (compare the inode limit in system quotas). It
21038 can only be used if &%quota%& is also set. The value is expanded; an expansion
21039 failure causes delivery to be deferred. A value of zero is interpreted as
21040 &"no quota"&.
21041
21042
21043 .option quota_is_inclusive appendfile boolean true
21044 See &%quota%& above.
21045
21046
21047 .option quota_size_regex appendfile string unset
21048 This option applies when one of the delivery modes that writes a separate file
21049 for each message is being used. When Exim wants to find the size of one of
21050 these files in order to test the quota, it first checks &%quota_size_regex%&.
21051 If this is set to a regular expression that matches the file name, and it
21052 captures one string, that string is interpreted as a representation of the
21053 file's size. The value of &%quota_size_regex%& is not expanded.
21054
21055 This feature is useful only when users have no shell access to their mailboxes
21056 &-- otherwise they could defeat the quota simply by renaming the files. This
21057 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21058 the file length to the file name. For example:
21059 .code
21060 maildir_tag = ,S=$message_size
21061 quota_size_regex = ,S=(\d+)
21062 .endd
21063 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21064 number of lines in the message.
21065
21066 The regular expression should not assume that the length is at the end of the
21067 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21068 sometimes add other information onto the ends of message file names.
21069
21070 Section &<<SECID136>>& contains further information.
21071
21072
21073 .option quota_warn_message appendfile string&!! "see below"
21074 See below for the use of this option. If it is not set when
21075 &%quota_warn_threshold%& is set, it defaults to
21076 .code
21077 quota_warn_message = "\
21078   To: $local_part@$domain\n\
21079   Subject: Your mailbox\n\n\
21080   This message is automatically created \
21081   by mail delivery software.\n\n\
21082   The size of your mailbox has exceeded \
21083   a warning threshold that is\n\
21084   set by the system administrator.\n"
21085 .endd
21086
21087
21088 .option quota_warn_threshold appendfile string&!! 0
21089 .cindex "quota" "warning threshold"
21090 .cindex "mailbox" "size warning"
21091 .cindex "size" "of mailbox"
21092 This option is expanded in the same way as &%quota%& (see above). If the
21093 resulting value is greater than zero, and delivery of the message causes the
21094 size of the file or total space in the directory tree to cross the given
21095 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21096 may be specified as a percentage of it by following the value with a percent
21097 sign. For example:
21098 .code
21099 quota = 10M
21100 quota_warn_threshold = 75%
21101 .endd
21102 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21103 percent sign is ignored.
21104
21105 The warning message itself is specified by the &%quota_warn_message%& option,
21106 and it must start with a &'To:'& header line containing the recipient(s) of the
21107 warning message. These do not necessarily have to include the recipient(s) of
21108 the original message. A &'Subject:'& line should also normally be supplied. You
21109 can include any other header lines that you want. If you do not include a
21110 &'From:'& line, the default is:
21111 .code
21112 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21113 .endd
21114 .oindex &%errors_reply_to%&
21115 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21116 option.
21117
21118 The &%quota%& option does not have to be set in order to use this option; they
21119 are independent of one another except when the threshold is specified as a
21120 percentage.
21121
21122
21123 .option use_bsmtp appendfile boolean false
21124 .cindex "envelope sender"
21125 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21126 format, with the envelope sender and recipient(s) included as SMTP commands. If
21127 you want to include a leading HELO command with such messages, you can do
21128 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21129 for details of batch SMTP.
21130
21131
21132 .option use_crlf appendfile boolean false
21133 .cindex "carriage return"
21134 .cindex "linefeed"
21135 This option causes lines to be terminated with the two-character CRLF sequence
21136 (carriage return, linefeed) instead of just a linefeed character. In the case
21137 of batched SMTP, the byte sequence written to the file is then an exact image
21138 of what would be sent down a real SMTP connection.
21139
21140 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21141 (which are used to supply the traditional &"From&~"& and blank line separators
21142 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21143 carriage return characters if these are needed. In cases where these options
21144 have non-empty defaults, the values end with a single linefeed, so they must be
21145 changed to end with &`\r\n`& if &%use_crlf%& is set.
21146
21147
21148 .option use_fcntl_lock appendfile boolean "see below"
21149 This option controls the use of the &[fcntl()]& function to lock a file for
21150 exclusive use when a message is being appended. It is set by default unless
21151 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21152 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21153 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21154
21155
21156 .option use_flock_lock appendfile boolean false
21157 This option is provided to support the use of &[flock()]& for file locking, for
21158 the few situations where it is needed. Most modern operating systems support
21159 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21160 each other. Exim uses &[fcntl()]& locking by default.
21161
21162 This option is required only if you are using an operating system where
21163 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21164 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21165 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21166
21167 .cindex "Solaris" "&[flock()]& support"
21168 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21169 have it (and some, I think, provide a not quite right version built on top of
21170 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21171 the ability to use it, and any attempt to do so will cause a configuration
21172 error.
21173
21174 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21175 is just being mapped onto &[fcntl()]& by the OS).
21176
21177
21178 .option use_lockfile appendfile boolean "see below"
21179 If this option is turned off, Exim does not attempt to create a lock file when
21180 appending to a mailbox file. In this situation, the only locking is by
21181 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21182 sure that every MUA that is ever going to look at your users' mailboxes uses
21183 &[fcntl()]& rather than a lock file, and even then only when you are not
21184 delivering over NFS from more than one host.
21185
21186 .cindex "NFS" "lock file"
21187 In order to append to an NFS file safely from more than one host, it is
21188 necessary to take out a lock &'before'& opening the file, and the lock file
21189 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21190 file corruption.
21191
21192 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21193 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21194 except when &%mbx_format%& is set.
21195
21196
21197 .option use_mbx_lock appendfile boolean "see below"
21198 This option is available only if Exim has been compiled with SUPPORT_MBX
21199 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21200 locking rules be used. It is set by default if &%mbx_format%& is set and none
21201 of the locking options are mentioned in the configuration. The locking rules
21202 are the same as are used by the &'c-client'& library that underlies Pine and
21203 the IMAP4 and POP daemons that come with it (see the discussion below). The
21204 rules allow for shared access to the mailbox. However, this kind of locking
21205 does not work when the mailbox is NFS mounted.
21206
21207 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21208 &%use_flock_lock%& to control what kind of locking is used in implementing the
21209 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21210 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21211
21212
21213
21214
21215 .section "Operational details for appending" "SECTopappend"
21216 .cindex "appending to a file"
21217 .cindex "file" "appending"
21218 Before appending to a file, the following preparations are made:
21219
21220 .ilist
21221 If the name of the file is &_/dev/null_&, no action is taken, and a success
21222 return is given.
21223
21224 .next
21225 .cindex "directory creation"
21226 If any directories on the file's path are missing, Exim creates them if the
21227 &%create_directory%& option is set. A created directory's mode is given by the
21228 &%directory_mode%& option.
21229
21230 .next
21231 If &%file_format%& is set, the format of an existing file is checked. If this
21232 indicates that a different transport should be used, control is passed to that
21233 transport.
21234
21235 .next
21236 .cindex "file" "locking"
21237 .cindex "locking files"
21238 .cindex "NFS" "lock file"
21239 If &%use_lockfile%& is set, a lock file is built in a way that will work
21240 reliably over NFS, as follows:
21241
21242 .olist
21243 Create a &"hitching post"& file whose name is that of the lock file with the
21244 current time, primary host name, and process id added, by opening for writing
21245 as a new file. If this fails with an access error, delivery is deferred.
21246 .next
21247 Close the hitching post file, and hard link it to the lock file name.
21248 .next
21249 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21250 Unlink the hitching post name.
21251 .next
21252 Otherwise, use &[stat()]& to get information about the hitching post file, and
21253 then unlink hitching post name. If the number of links is exactly two, creation
21254 of the lock file succeeded but something (for example, an NFS server crash and
21255 restart) caused this fact not to be communicated to the &[link()]& call.
21256 .next
21257 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21258 up to &%lock_retries%& times. However, since any program that writes to a
21259 mailbox should complete its task very quickly, it is reasonable to time out old
21260 lock files that are normally the result of user agent and system crashes. If an
21261 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21262 it before trying again.
21263 .endlist olist
21264
21265 .next
21266 A call is made to &[lstat()]& to discover whether the main file exists, and if
21267 so, what its characteristics are. If &[lstat()]& fails for any reason other
21268 than non-existence, delivery is deferred.
21269
21270 .next
21271 .cindex "symbolic link" "to mailbox"
21272 .cindex "mailbox" "symbolic link"
21273 If the file does exist and is a symbolic link, delivery is deferred, unless the
21274 &%allow_symlink%& option is set, in which case the ownership of the link is
21275 checked, and then &[stat()]& is called to find out about the real file, which
21276 is then subjected to the checks below. The check on the top-level link
21277 ownership prevents one user creating a link for another's mailbox in a sticky
21278 directory, though allowing symbolic links in this case is definitely not a good
21279 idea. If there is a chain of symbolic links, the intermediate ones are not
21280 checked.
21281
21282 .next
21283 If the file already exists but is not a regular file, or if the file's owner
21284 and group (if the group is being checked &-- see &%check_group%& above) are
21285 different from the user and group under which the delivery is running,
21286 delivery is deferred.
21287
21288 .next
21289 If the file's permissions are more generous than specified, they are reduced.
21290 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21291 is set false, in which case the delivery is tried using the existing
21292 permissions.
21293
21294 .next
21295 The file's inode number is saved, and the file is then opened for appending.
21296 If this fails because the file has vanished, &(appendfile)& behaves as if it
21297 hadn't existed (see below). For any other failures, delivery is deferred.
21298
21299 .next
21300 If the file is opened successfully, check that the inode number hasn't
21301 changed, that it is still a regular file, and that the owner and permissions
21302 have not changed. If anything is wrong, defer delivery and freeze the message.
21303
21304 .next
21305 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21306 option is set. Otherwise, check that the file is being created in a permitted
21307 directory if the &%create_file%& option is set (deferring on failure), and then
21308 open for writing as a new file, with the O_EXCL and O_CREAT options,
21309 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21310 set). In this case, which can happen if the link points to a non-existent file,
21311 the file is opened for writing using O_CREAT but not O_EXCL, because
21312 that prevents link following.
21313
21314 .next
21315 .cindex "loop" "while file testing"
21316 If opening fails because the file exists, obey the tests given above for
21317 existing files. However, to avoid looping in a situation where the file is
21318 being continuously created and destroyed, the exists/not-exists loop is broken
21319 after 10 repetitions, and the message is then frozen.
21320
21321 .next
21322 If opening fails with any other error, defer delivery.
21323
21324 .next
21325 .cindex "file" "locking"
21326 .cindex "locking files"
21327 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21328 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21329 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21330 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21331 file, and an exclusive lock on the file whose name is
21332 .code
21333 /tmp/.<device-number>.<inode-number>
21334 .endd
21335 using the device and inode numbers of the open mailbox file, in accordance with
21336 the MBX locking rules. This file is created with a mode that is specified by
21337 the &%lockfile_mode%& option.
21338
21339 If Exim fails to lock the file, there are two possible courses of action,
21340 depending on the value of the locking timeout. This is obtained from
21341 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21342
21343 If the timeout value is zero, the file is closed, Exim waits for
21344 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21345 to lock it again. This happens up to &%lock_retries%& times, after which the
21346 delivery is deferred.
21347
21348 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21349 &[flock()]& are used (with the given timeout), so there has already been some
21350 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21351 immediately. It retries up to
21352 .code
21353 (lock_retries * lock_interval) / <timeout>
21354 .endd
21355 times (rounded up).
21356 .endlist
21357
21358 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21359 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21360
21361
21362 .section "Operational details for delivery to a new file" "SECTopdir"
21363 .cindex "delivery" "to single file"
21364 .cindex "&""From""& line"
21365 When the &%directory%& option is set instead of &%file%&, each message is
21366 delivered into a newly-created file or set of files. When &(appendfile)& is
21367 activated directly from a &(redirect)& router, neither &%file%& nor
21368 &%directory%& is normally set, because the path for delivery is supplied by the
21369 router. (See for example, the &(address_file)& transport in the default
21370 configuration.) In this case, delivery is to a new file if either the path name
21371 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21372
21373 No locking is required while writing the message to a new file, so the various
21374 locking options of the transport are ignored. The &"From"& line that by default
21375 separates messages in a single file is not normally needed, nor is the escaping
21376 of message lines that start with &"From"&, and there is no need to ensure a
21377 newline at the end of each message. Consequently, the default values for
21378 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21379 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21380
21381 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21382 the files in the delivery directory by default. However, you can specify a
21383 different directory by setting &%quota_directory%&. Also, for maildir
21384 deliveries (see below) the &_maildirfolder_& convention is honoured.
21385
21386
21387 .cindex "maildir format"
21388 .cindex "mailstore format"
21389 There are three different ways in which delivery to individual files can be
21390 done, controlled by the settings of the &%maildir_format%& and
21391 &%mailstore_format%& options. Note that code to support maildir or mailstore
21392 formats is not included in the binary unless SUPPORT_MAILDIR or
21393 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21394
21395 .cindex "directory creation"
21396 In all three cases an attempt is made to create the directory and any necessary
21397 sub-directories if they do not exist, provided that the &%create_directory%&
21398 option is set (the default). The location of a created directory can be
21399 constrained by setting &%create_file%&. A created directory's mode is given by
21400 the &%directory_mode%& option. If creation fails, or if the
21401 &%create_directory%& option is not set when creation is required, delivery is
21402 deferred.
21403
21404
21405
21406 .section "Maildir delivery" "SECTmaildirdelivery"
21407 .cindex "maildir format" "description of"
21408 If the &%maildir_format%& option is true, Exim delivers each message by writing
21409 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21410 directory that is defined by the &%directory%& option (the &"delivery
21411 directory"&). If the delivery is successful, the file is renamed into the
21412 &_new_& subdirectory.
21413
21414 In the file name, <&'stime'&> is the current time of day in seconds, and
21415 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21416 Exim checks that the time-of-day clock has moved on by at least one microsecond
21417 before terminating the delivery process. This guarantees uniqueness for the
21418 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21419 opening it. If any response other than ENOENT (does not exist) is given,
21420 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21421
21422 Before Exim carries out a maildir delivery, it ensures that subdirectories
21423 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21424 do not exist, Exim tries to create them and any superior directories in their
21425 path, subject to the &%create_directory%& and &%create_file%& options. If the
21426 &%maildirfolder_create_regex%& option is set, and the regular expression it
21427 contains matches the delivery directory, Exim also ensures that a file called
21428 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21429 &_maildirfolder_& file cannot be created, delivery is deferred.
21430
21431 These features make it possible to use Exim to create all the necessary files
21432 and directories in a maildir mailbox, including subdirectories for maildir++
21433 folders. Consider this example:
21434 .code
21435 maildir_format = true
21436 directory = /var/mail/$local_part\
21437            ${if eq{$local_part_suffix}{}{}\
21438            {/.${substr_1:$local_part_suffix}}}
21439 maildirfolder_create_regex = /\.[^/]+$
21440 .endd
21441 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21442 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21443 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21444 not match this name, so Exim will not look for or create the file
21445 &_/var/mail/pimbo/maildirfolder_&, though it will create
21446 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21447
21448 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21449 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21450 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21451 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21452 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21453
21454 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21455 not inadvertently match the toplevel maildir directory, because a
21456 &_maildirfolder_& file at top level would completely break quota calculations.
21457
21458 .cindex "quota" "in maildir delivery"
21459 .cindex "maildir++"
21460 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21461 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21462 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21463 Exim assumes the directory is a maildir++ folder directory, which is one level
21464 down from the user's top level mailbox directory. This causes it to start at
21465 the parent directory instead of the current directory when calculating the
21466 amount of space used.
21467
21468 One problem with delivering into a multi-file mailbox is that it is
21469 computationally expensive to compute the size of the mailbox for quota
21470 checking. Various approaches have been taken to reduce the amount of work
21471 needed. The next two sections describe two of them. A third alternative is to
21472 use some external process for maintaining the size data, and use the expansion
21473 of the &%mailbox_size%& option as a way of importing it into Exim.
21474
21475
21476
21477
21478 .section "Using tags to record message sizes" "SECID135"
21479 If &%maildir_tag%& is set, the string is expanded for each delivery.
21480 When the maildir file is renamed into the &_new_& sub-directory, the
21481 tag is added to its name. However, if adding the tag takes the length of the
21482 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21483 the tag is dropped and the maildir file is created with no tag.
21484
21485
21486 .vindex "&$message_size$&"
21487 Tags can be used to encode the size of files in their names; see
21488 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21489 happens after the message has been written. The value of the &$message_size$&
21490 variable is set to the number of bytes actually written. If the expansion is
21491 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21492 be deferred. The expanded tag may contain any printing characters except &"/"&.
21493 Non-printing characters in the string are ignored; if the resulting string is
21494 empty, it is ignored. If it starts with an alphanumeric character, a leading
21495 colon is inserted; this default has not proven to be the path that popular
21496 maildir implementations have chosen (but changing it in Exim would break
21497 backwards compatibility).
21498
21499 For one common implementation, you might set:
21500 .code
21501 maildir_tag = ,S=${message_size}
21502 .endd
21503 but you should check the documentation of the other software to be sure.
21504
21505 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21506 as this allows Exim to extract the size from your tag, instead of having to
21507 &[stat()]& each message file.
21508
21509
21510 .section "Using a maildirsize file" "SECID136"
21511 .cindex "quota" "in maildir delivery"
21512 .cindex "maildir format" "&_maildirsize_& file"
21513 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21514 storing quota and message size information in a file called &_maildirsize_&
21515 within the toplevel maildir directory. If this file does not exist, Exim
21516 creates it, setting the quota from the &%quota%& option of the transport. If
21517 the maildir directory itself does not exist, it is created before any attempt
21518 to write a &_maildirsize_& file.
21519
21520 The &_maildirsize_& file is used to hold information about the sizes of
21521 messages in the maildir, thus speeding up quota calculations. The quota value
21522 in the file is just a cache; if the quota is changed in the transport, the new
21523 value overrides the cached value when the next message is delivered. The cache
21524 is maintained for the benefit of other programs that access the maildir and
21525 need to know the quota.
21526
21527 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21528 file is maintained (with a zero quota setting), but no quota is imposed.
21529
21530 A regular expression is available for controlling which directories in the
21531 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21532 See the description of the &%maildir_quota_directory_regex%& option above for
21533 details.
21534
21535
21536 .section "Mailstore delivery" "SECID137"
21537 .cindex "mailstore format" "description of"
21538 If the &%mailstore_format%& option is true, each message is written as two
21539 files in the given directory. A unique base name is constructed from the
21540 message id and the current delivery process, and the files that are written use
21541 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21542 contains the message's envelope, and the &_.msg_& file contains the message
21543 itself. The base name is placed in the variable &$mailstore_basename$&.
21544
21545 During delivery, the envelope is first written to a file with the suffix
21546 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21547 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21548 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21549 file before accessing either of them. An alternative approach is to wait for
21550 the absence of a &_.tmp_& file.
21551
21552 The envelope file starts with any text defined by the &%mailstore_prefix%&
21553 option, expanded and terminated by a newline if there isn't one. Then follows
21554 the sender address on one line, then all the recipient addresses, one per line.
21555 There can be more than one recipient only if the &%batch_max%& option is set
21556 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21557 appended to the file, followed by a newline if it does not end with one.
21558
21559 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21560 failure, it is ignored. Other expansion errors are treated as serious
21561 configuration errors, and delivery is deferred. The variable
21562 &$mailstore_basename$& is available for use during these expansions.
21563
21564
21565 .section "Non-special new file delivery" "SECID138"
21566 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21567 file is created directly in the named directory. For example, when delivering
21568 messages into files in batched SMTP format for later delivery to some host (see
21569 section &<<SECTbatchSMTP>>&), a setting such as
21570 .code
21571 directory = /var/bsmtp/$host
21572 .endd
21573 might be used. A message is written to a file with a temporary name, which is
21574 then renamed when the delivery is complete. The final name is obtained by
21575 expanding the contents of the &%directory_file%& option.
21576 .ecindex IIDapptra1
21577 .ecindex IIDapptra2
21578
21579
21580
21581
21582
21583
21584 . ////////////////////////////////////////////////////////////////////////////
21585 . ////////////////////////////////////////////////////////////////////////////
21586
21587 .chapter "The autoreply transport" "CHID8"
21588 .scindex IIDauttra1 "transports" "&(autoreply)&"
21589 .scindex IIDauttra2 "&(autoreply)& transport"
21590 The &(autoreply)& transport is not a true transport in that it does not cause
21591 the message to be transmitted. Instead, it generates a new mail message as an
21592 automatic reply to the incoming message. &'References:'& and
21593 &'Auto-Submitted:'& header lines are included. These are constructed according
21594 to the rules in RFCs 2822 and 3834, respectively.
21595
21596 If the router that passes the message to this transport does not have the
21597 &%unseen%& option set, the original message (for the current recipient) is not
21598 delivered anywhere. However, when the &%unseen%& option is set on the router
21599 that passes the message to this transport, routing of the address continues, so
21600 another router can set up a normal message delivery.
21601
21602
21603 The &(autoreply)& transport is usually run as the result of mail filtering, a
21604 &"vacation"& message being the standard example. However, it can also be run
21605 directly from a router like any other transport. To reduce the possibility of
21606 message cascades, messages created by the &(autoreply)& transport always have
21607 empty envelope sender addresses, like bounce messages.
21608
21609 The parameters of the message to be sent can be specified in the configuration
21610 by options described below. However, these are used only when the address
21611 passed to the transport does not contain its own reply information. When the
21612 transport is run as a consequence of a
21613 &%mail%&
21614 or &%vacation%& command in a filter file, the parameters of the message are
21615 supplied by the filter, and passed with the address. The transport's options
21616 that define the message are then ignored (so they are not usually set in this
21617 case). The message is specified entirely by the filter or by the transport; it
21618 is never built from a mixture of options. However, the &%file_optional%&,
21619 &%mode%&, and &%return_message%& options apply in all cases.
21620
21621 &(Autoreply)& is implemented as a local transport. When used as a result of a
21622 command in a user's filter file, &(autoreply)& normally runs under the uid and
21623 gid of the user, and with appropriate current and home directories (see chapter
21624 &<<CHAPenvironment>>&).
21625
21626 There is a subtle difference between routing a message to a &(pipe)& transport
21627 that generates some text to be returned to the sender, and routing it to an
21628 &(autoreply)& transport. This difference is noticeable only if more than one
21629 address from the same message is so handled. In the case of a pipe, the
21630 separate outputs from the different addresses are gathered up and returned to
21631 the sender in a single message, whereas if &(autoreply)& is used, a separate
21632 message is generated for each address that is passed to it.
21633
21634 Non-printing characters are not permitted in the header lines generated for the
21635 message that &(autoreply)& creates, with the exception of newlines that are
21636 immediately followed by white space. If any non-printing characters are found,
21637 the transport defers.
21638 Whether characters with the top bit set count as printing characters or not is
21639 controlled by the &%print_topbitchars%& global option.
21640
21641 If any of the generic options for manipulating headers (for example,
21642 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21643 of the original message that is included in the generated message when
21644 &%return_message%& is set. They do not apply to the generated message itself.
21645
21646 .vindex "&$sender_address$&"
21647 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21648 the message, indicating that there were no recipients, it does not treat this
21649 as an error. This means that autoreplies sent to &$sender_address$& when this
21650 is empty (because the incoming message is a bounce message) do not cause
21651 problems. They are just discarded.
21652
21653
21654
21655 .section "Private options for autoreply" "SECID139"
21656 .cindex "options" "&(autoreply)& transport"
21657
21658 .option bcc autoreply string&!! unset
21659 This specifies the addresses that are to receive &"blind carbon copies"& of the
21660 message when the message is specified by the transport.
21661
21662
21663 .option cc autoreply string&!! unset
21664 This specifies recipients of the message and the contents of the &'Cc:'& header
21665 when the message is specified by the transport.
21666
21667
21668 .option file autoreply string&!! unset
21669 The contents of the file are sent as the body of the message when the message
21670 is specified by the transport. If both &%file%& and &%text%& are set, the text
21671 string comes first.
21672
21673
21674 .option file_expand autoreply boolean false
21675 If this is set, the contents of the file named by the &%file%& option are
21676 subjected to string expansion as they are added to the message.
21677
21678
21679 .option file_optional autoreply boolean false
21680 If this option is true, no error is generated if the file named by the &%file%&
21681 option or passed with the address does not exist or cannot be read.
21682
21683
21684 .option from autoreply string&!! unset
21685 This specifies the contents of the &'From:'& header when the message is
21686 specified by the transport.
21687
21688
21689 .option headers autoreply string&!! unset
21690 This specifies additional RFC 2822 headers that are to be added to the message
21691 when the message is specified by the transport. Several can be given by using
21692 &"\n"& to separate them. There is no check on the format.
21693
21694
21695 .option log autoreply string&!! unset
21696 This option names a file in which a record of every message sent is logged when
21697 the message is specified by the transport.
21698
21699
21700 .option mode autoreply "octal integer" 0600
21701 If either the log file or the &"once"& file has to be created, this mode is
21702 used.
21703
21704
21705 .option never_mail autoreply "address list&!!" unset
21706 If any run of the transport creates a message with a recipient that matches any
21707 item in the list, that recipient is quietly discarded. If all recipients are
21708 discarded, no message is created. This applies both when the recipients are
21709 generated by a filter and when they are specified in the transport.
21710
21711
21712
21713 .option once autoreply string&!! unset
21714 This option names a file or DBM database in which a record of each &'To:'&
21715 recipient is kept when the message is specified by the transport. &*Note*&:
21716 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21717
21718 If &%once%& is unset, or is set to an empty string, the message is always sent.
21719 By default, if &%once%& is set to a non-empty file name, the message
21720 is not sent if a potential recipient is already listed in the database.
21721 However, if the &%once_repeat%& option specifies a time greater than zero, the
21722 message is sent if that much time has elapsed since a message was last sent to
21723 this recipient. A setting of zero time for &%once_repeat%& (the default)
21724 prevents a message from being sent a second time &-- in this case, zero means
21725 infinity.
21726
21727 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21728 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21729 greater than zero, it changes the way Exim implements the &%once%& option.
21730 Instead of using a DBM file to record every recipient it sends to, it uses a
21731 regular file, whose size will never get larger than the given value.
21732
21733 In the file, Exim keeps a linear list of recipient addresses and the times at
21734 which they were sent messages. If the file is full when a new address needs to
21735 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21736 means that a given recipient may receive multiple messages, but at
21737 unpredictable intervals that depend on the rate of turnover of addresses in the
21738 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21739
21740
21741 .option once_file_size autoreply integer 0
21742 See &%once%& above.
21743
21744
21745 .option once_repeat autoreply time&!! 0s
21746 See &%once%& above.
21747 After expansion, the value of this option must be a valid time value.
21748
21749
21750 .option reply_to autoreply string&!! unset
21751 This specifies the contents of the &'Reply-To:'& header when the message is
21752 specified by the transport.
21753
21754
21755 .option return_message autoreply boolean false
21756 If this is set, a copy of the original message is returned with the new
21757 message, subject to the maximum size set in the &%return_size_limit%& global
21758 configuration option.
21759
21760
21761 .option subject autoreply string&!! unset
21762 This specifies the contents of the &'Subject:'& header when the message is
21763 specified by the transport. It is tempting to quote the original subject in
21764 automatic responses. For example:
21765 .code
21766 subject = Re: $h_subject:
21767 .endd
21768 There is a danger in doing this, however. It may allow a third party to
21769 subscribe your users to an opt-in mailing list, provided that the list accepts
21770 bounce messages as subscription confirmations. Well-managed lists require a
21771 non-bounce message to confirm a subscription, so the danger is relatively
21772 small.
21773
21774
21775
21776 .option text autoreply string&!! unset
21777 This specifies a single string to be used as the body of the message when the
21778 message is specified by the transport. If both &%text%& and &%file%& are set,
21779 the text comes first.
21780
21781
21782 .option to autoreply string&!! unset
21783 This specifies recipients of the message and the contents of the &'To:'& header
21784 when the message is specified by the transport.
21785 .ecindex IIDauttra1
21786 .ecindex IIDauttra2
21787
21788
21789
21790
21791 . ////////////////////////////////////////////////////////////////////////////
21792 . ////////////////////////////////////////////////////////////////////////////
21793
21794 .chapter "The lmtp transport" "CHAPLMTP"
21795 .cindex "transports" "&(lmtp)&"
21796 .cindex "&(lmtp)& transport"
21797 .cindex "LMTP" "over a pipe"
21798 .cindex "LMTP" "over a socket"
21799 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21800 specified command
21801 or by interacting with a Unix domain socket.
21802 This transport is something of a cross between the &(pipe)& and &(smtp)&
21803 transports. Exim also has support for using LMTP over TCP/IP; this is
21804 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21805 to be of minority interest, the default build-time configure in &_src/EDITME_&
21806 has it commented out. You need to ensure that
21807 .code
21808 TRANSPORT_LMTP=yes
21809 .endd
21810 .cindex "options" "&(lmtp)& transport"
21811 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21812 included in the Exim binary. The private options of the &(lmtp)& transport are
21813 as follows:
21814
21815 .option batch_id lmtp string&!! unset
21816 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21817
21818
21819 .option batch_max lmtp integer 1
21820 This limits the number of addresses that can be handled in a single delivery.
21821 Most LMTP servers can handle several addresses at once, so it is normally a
21822 good idea to increase this value. See the description of local delivery
21823 batching in chapter &<<CHAPbatching>>&.
21824
21825
21826 .option command lmtp string&!! unset
21827 This option must be set if &%socket%& is not set. The string is a command which
21828 is run in a separate process. It is split up into a command name and list of
21829 arguments, each of which is separately expanded (so expansion cannot change the
21830 number of arguments). The command is run directly, not via a shell. The message
21831 is passed to the new process using the standard input and output to operate the
21832 LMTP protocol.
21833
21834 .option ignore_quota lmtp boolean false
21835 .cindex "LMTP" "ignoring quota errors"
21836 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21837 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21838 in its response to the LHLO command.
21839
21840 .option socket lmtp string&!! unset
21841 This option must be set if &%command%& is not set. The result of expansion must
21842 be the name of a Unix domain socket. The transport connects to the socket and
21843 delivers the message to it using the LMTP protocol.
21844
21845
21846 .option timeout lmtp time 5m
21847 The transport is aborted if the created process or Unix domain socket does not
21848 respond to LMTP commands or message input within this timeout. Delivery
21849 is deferred, and will be tried again later. Here is an example of a typical
21850 LMTP transport:
21851 .code
21852 lmtp:
21853   driver = lmtp
21854   command = /some/local/lmtp/delivery/program
21855   batch_max = 20
21856   user = exim
21857 .endd
21858 This delivers up to 20 addresses at a time, in a mixture of domains if
21859 necessary, running as the user &'exim'&.
21860
21861
21862
21863 . ////////////////////////////////////////////////////////////////////////////
21864 . ////////////////////////////////////////////////////////////////////////////
21865
21866 .chapter "The pipe transport" "CHAPpipetransport"
21867 .scindex IIDpiptra1 "transports" "&(pipe)&"
21868 .scindex IIDpiptra2 "&(pipe)& transport"
21869 The &(pipe)& transport is used to deliver messages via a pipe to a command
21870 running in another process. One example is the use of &(pipe)& as a
21871 pseudo-remote transport for passing messages to some other delivery mechanism
21872 (such as UUCP). Another is the use by individual users to automatically process
21873 their incoming messages. The &(pipe)& transport can be used in one of the
21874 following ways:
21875
21876 .ilist
21877 .vindex "&$local_part$&"
21878 A router routes one address to a transport in the normal way, and the
21879 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21880 contains the local part of the address (as usual), and the command that is run
21881 is specified by the &%command%& option on the transport.
21882 .next
21883 .vindex "&$pipe_addresses$&"
21884 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21885 transport can handle more than one address in a single run. In this case, when
21886 more than one address is routed to the transport, &$local_part$& is not set
21887 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21888 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21889 that are routed to the transport.
21890 .next
21891 .vindex "&$address_pipe$&"
21892 A router redirects an address directly to a pipe command (for example, from an
21893 alias or forward file). In this case, &$address_pipe$& contains the text of the
21894 pipe command, and the &%command%& option on the transport is ignored unless
21895 &%force_command%& is set. If only one address is being transported
21896 (&%batch_max%& is not greater than one, or only one address was redirected to
21897 this pipe command), &$local_part$& contains the local part that was redirected.
21898 .endlist
21899
21900
21901 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21902 deliver messages over pipes using the LMTP interactive protocol. This is
21903 implemented by the &(lmtp)& transport.
21904
21905 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21906 &_.forward_& file, the command runs under the uid and gid of that user. In
21907 other cases, the uid and gid have to be specified explicitly, either on the
21908 transport or on the router that handles the address. Current and &"home"&
21909 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21910 details of the local delivery environment and chapter &<<CHAPbatching>>&
21911 for a discussion of local delivery batching.
21912
21913
21914 .section "Concurrent delivery" "SECID140"
21915 If two messages arrive at almost the same time, and both are routed to a pipe
21916 delivery, the two pipe transports may be run concurrently. You must ensure that
21917 any pipe commands you set up are robust against this happening. If the commands
21918 write to a file, the &%exim_lock%& utility might be of use.
21919
21920
21921
21922
21923 .section "Returned status and data" "SECID141"
21924 .cindex "&(pipe)& transport" "returned data"
21925 If the command exits with a non-zero return code, the delivery is deemed to
21926 have failed, unless either the &%ignore_status%& option is set (in which case
21927 the return code is treated as zero), or the return code is one of those listed
21928 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21929 later"&. In this case, delivery is deferred. Details of a permanent failure are
21930 logged, but are not included in the bounce message, which merely contains
21931 &"local delivery failed"&.
21932
21933 If the command exits on a signal and the &%freeze_signal%& option is set then
21934 the message will be frozen in the queue. If that option is not set, a bounce
21935 will be sent as normal.
21936
21937 If the return code is greater than 128 and the command being run is a shell
21938 script, it normally means that the script was terminated by a signal whose
21939 value is the return code minus 128. The &%freeze_signal%& option does not
21940 apply in this case.
21941
21942 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21943 return code is set to 127. This is the value that a shell returns if it is
21944 asked to run a non-existent command. The wording for the log line suggests that
21945 a non-existent command may be the problem.
21946
21947 The &%return_output%& option can affect the result of a pipe delivery. If it is
21948 set and the command produces any output on its standard output or standard
21949 error streams, the command is considered to have failed, even if it gave a zero
21950 return code or if &%ignore_status%& is set. The output from the command is
21951 included as part of the bounce message. The &%return_fail_output%& option is
21952 similar, except that output is returned only when the command exits with a
21953 failure return code, that is, a value other than zero or a code that matches
21954 &%temp_errors%&.
21955
21956
21957
21958 .section "How the command is run" "SECThowcommandrun"
21959 .cindex "&(pipe)& transport" "path for command"
21960 The command line is (by default) broken down into a command name and arguments
21961 by the &(pipe)& transport itself. The &%allow_commands%& and
21962 &%restrict_to_path%& options can be used to restrict the commands that may be
21963 run.
21964
21965 .cindex "quoting" "in pipe command"
21966 Unquoted arguments are delimited by white space. If an argument appears in
21967 double quotes, backslash is interpreted as an escape character in the usual
21968 way. If an argument appears in single quotes, no escaping is done.
21969
21970 String expansion is applied to the command line except when it comes from a
21971 traditional &_.forward_& file (commands from a filter file are expanded). The
21972 expansion is applied to each argument in turn rather than to the whole line.
21973 For this reason, any string expansion item that contains white space must be
21974 quoted so as to be contained within a single argument. A setting such as
21975 .code
21976 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21977 .endd
21978 will not work, because the expansion item gets split between several
21979 arguments. You have to write
21980 .code
21981 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21982 .endd
21983 to ensure that it is all in one argument. The expansion is done in this way,
21984 argument by argument, so that the number of arguments cannot be changed as a
21985 result of expansion, and quotes or backslashes in inserted variables do not
21986 interact with external quoting. However, this leads to problems if you want to
21987 generate multiple arguments (or the command name plus arguments) from a single
21988 expansion. In this situation, the simplest solution is to use a shell. For
21989 example:
21990 .code
21991 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21992 .endd
21993
21994 .cindex "transport" "filter"
21995 .cindex "filter" "transport filter"
21996 .vindex "&$pipe_addresses$&"
21997 Special handling takes place when an argument consists of precisely the text
21998 &`$pipe_addresses`&. This is not a general expansion variable; the only
21999 place this string is recognized is when it appears as an argument for a pipe or
22000 transport filter command. It causes each address that is being handled to be
22001 inserted in the argument list at that point &'as a separate argument'&. This
22002 avoids any problems with spaces or shell metacharacters, and is of use when a
22003 &(pipe)& transport is handling groups of addresses in a batch.
22004
22005 If &%force_command%& is enabled on the transport, Special handling takes place
22006 for an argument that consists of precisely the text &`$address_pipe`&.  It
22007 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22008 argument is inserted in the argument list at that point
22009 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22010 the only item in the argument; in fact, if it were then &%force_command%&
22011 should behave as a no-op.  Rather, it should be used to adjust the command
22012 run while preserving the argument vector separation.
22013
22014 After splitting up into arguments and expansion, the resulting command is run
22015 in a subprocess directly from the transport, &'not'& under a shell. The
22016 message that is being delivered is supplied on the standard input, and the
22017 standard output and standard error are both connected to a single pipe that is
22018 read by Exim. The &%max_output%& option controls how much output the command
22019 may produce, and the &%return_output%& and &%return_fail_output%& options
22020 control what is done with it.
22021
22022 Not running the command under a shell (by default) lessens the security risks
22023 in cases when a command from a user's filter file is built out of data that was
22024 taken from an incoming message. If a shell is required, it can of course be
22025 explicitly specified as the command to be run. However, there are circumstances
22026 where existing commands (for example, in &_.forward_& files) expect to be run
22027 under a shell and cannot easily be modified. To allow for these cases, there is
22028 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22029 works. Instead of breaking up the command line as just described, it expands it
22030 as a single string and passes the result to &_/bin/sh_&. The
22031 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22032 with &%use_shell%&, and the whole mechanism is inherently less secure.
22033
22034
22035
22036 .section "Environment variables" "SECTpipeenv"
22037 .cindex "&(pipe)& transport" "environment for command"
22038 .cindex "environment for pipe transport"
22039 The environment variables listed below are set up when the command is invoked.
22040 This list is a compromise for maximum compatibility with other MTAs. Note that
22041 the &%environment%& option can be used to add additional variables to this
22042 environment.
22043 .display
22044 &`DOMAIN            `&   the domain of the address
22045 &`HOME              `&   the home directory, if set
22046 &`HOST              `&   the host name when called from a router (see below)
22047 &`LOCAL_PART        `&   see below
22048 &`LOCAL_PART_PREFIX `&   see below
22049 &`LOCAL_PART_SUFFIX `&   see below
22050 &`LOGNAME           `&   see below
22051 &`MESSAGE_ID        `&   Exim's local ID for the message
22052 &`PATH              `&   as specified by the &%path%& option below
22053 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22054 &`RECIPIENT         `&   the complete recipient address
22055 &`SENDER            `&   the sender of the message (empty if a bounce)
22056 &`SHELL             `&   &`/bin/sh`&
22057 &`TZ                `&   the value of the &%timezone%& option, if set
22058 &`USER              `&   see below
22059 .endd
22060 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22061 router, LOCAL_PART is set to the local part of the address. When it is
22062 called as a result of a forward or alias expansion, LOCAL_PART is set to
22063 the local part of the address that was expanded. In both cases, any affixes are
22064 removed from the local part, and made available in LOCAL_PART_PREFIX and
22065 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22066 same value as LOCAL_PART for compatibility with other MTAs.
22067
22068 .cindex "HOST"
22069 HOST is set only when a &(pipe)& transport is called from a router that
22070 associates hosts with an address, typically when using &(pipe)& as a
22071 pseudo-remote transport. HOST is set to the first host name specified by
22072 the router.
22073
22074 .cindex "HOME"
22075 If the transport's generic &%home_directory%& option is set, its value is used
22076 for the HOME environment variable. Otherwise, a home directory may be set
22077 by the router's &%transport_home_directory%& option, which defaults to the
22078 user's home directory if &%check_local_user%& is set.
22079
22080
22081 .section "Private options for pipe" "SECID142"
22082 .cindex "options" "&(pipe)& transport"
22083
22084
22085
22086 .option allow_commands pipe "string list&!!" unset
22087 .cindex "&(pipe)& transport" "permitted commands"
22088 The string is expanded, and is then interpreted as a colon-separated list of
22089 permitted commands. If &%restrict_to_path%& is not set, the only commands
22090 permitted are those in the &%allow_commands%& list. They need not be absolute
22091 paths; the &%path%& option is still used for relative paths. If
22092 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22093 in the &%allow_commands%& list, or a name without any slashes that is found on
22094 the path. In other words, if neither &%allow_commands%& nor
22095 &%restrict_to_path%& is set, there is no restriction on the command, but
22096 otherwise only commands that are permitted by one or the other are allowed. For
22097 example, if
22098 .code
22099 allow_commands = /usr/bin/vacation
22100 .endd
22101 and &%restrict_to_path%& is not set, the only permitted command is
22102 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22103 &%use_shell%& is set.
22104
22105
22106 .option batch_id pipe string&!! unset
22107 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22108
22109
22110 .option batch_max pipe integer 1
22111 This limits the number of addresses that can be handled in a single delivery.
22112 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22113
22114
22115 .option check_string pipe string unset
22116 As &(pipe)& writes the message, the start of each line is tested for matching
22117 &%check_string%&, and if it does, the initial matching characters are replaced
22118 by the contents of &%escape_string%&, provided both are set. The value of
22119 &%check_string%& is a literal string, not a regular expression, and the case of
22120 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22121 of &%check_string%& and &%escape_string%& are forced to values that implement
22122 the SMTP escaping protocol. Any settings made in the configuration file are
22123 ignored.
22124
22125
22126 .option command pipe string&!! unset
22127 This option need not be set when &(pipe)& is being used to deliver to pipes
22128 obtained directly from address redirections. In other cases, the option must be
22129 set, to provide a command to be run. It need not yield an absolute path (see
22130 the &%path%& option below). The command is split up into separate arguments by
22131 Exim, and each argument is separately expanded, as described in section
22132 &<<SECThowcommandrun>>& above.
22133
22134
22135 .option environment pipe string&!! unset
22136 .cindex "&(pipe)& transport" "environment for command"
22137 .cindex "environment for &(pipe)& transport"
22138 This option is used to add additional variables to the environment in which the
22139 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22140 a string which is expanded, and then interpreted as a colon-separated list of
22141 environment settings of the form <&'name'&>=<&'value'&>.
22142
22143
22144 .option escape_string pipe string unset
22145 See &%check_string%& above.
22146
22147
22148 .option freeze_exec_fail pipe boolean false
22149 .cindex "exec failure"
22150 .cindex "failure of exec"
22151 .cindex "&(pipe)& transport" "failure of exec"
22152 Failure to exec the command in a pipe transport is by default treated like
22153 any other failure while running the command. However, if &%freeze_exec_fail%&
22154 is set, failure to exec is treated specially, and causes the message to be
22155 frozen, whatever the setting of &%ignore_status%&.
22156
22157
22158 .option freeze_signal pipe boolean false
22159 .cindex "signal exit"
22160 .cindex "&(pipe)& transport", "signal exit"
22161 Normally if the process run by a command in a pipe transport exits on a signal,
22162 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22163 frozen in Exim's queue instead.
22164
22165
22166 .option force_command pipe boolean false
22167 .cindex "force command"
22168 .cindex "&(pipe)& transport", "force command"
22169 Normally when a router redirects an address directly to a pipe command
22170 the &%command%& option on the transport is ignored.  If &%force_command%&
22171 is set, the &%command%& option will used. This is especially
22172 useful for forcing a wrapper or additional argument to be added to the
22173 command. For example:
22174 .code
22175 command = /usr/bin/remote_exec myhost -- $address_pipe
22176 force_command
22177 .endd
22178
22179 Note that &$address_pipe$& is handled specially in &%command%& when
22180 &%force_command%& is set, expanding out to the original argument vector as
22181 separate items, similarly to a Unix shell &`"$@"`& construct.
22182
22183 .option ignore_status pipe boolean false
22184 If this option is true, the status returned by the subprocess that is set up to
22185 run the command is ignored, and Exim behaves as if zero had been returned.
22186 Otherwise, a non-zero status or termination by signal causes an error return
22187 from the transport unless the status value is one of those listed in
22188 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22189
22190 &*Note*&: This option does not apply to timeouts, which do not return a status.
22191 See the &%timeout_defer%& option for how timeouts are handled.
22192
22193 .option log_defer_output pipe boolean false
22194 .cindex "&(pipe)& transport" "logging output"
22195 If this option is set, and the status returned by the command is
22196 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22197 and any output was produced, the first line of it is written to the main log.
22198
22199
22200 .option log_fail_output pipe boolean false
22201 If this option is set, and the command returns any output, and also ends with a
22202 return code that is neither zero nor one of the return codes listed in
22203 &%temp_errors%& (that is, the delivery failed), the first line of output is
22204 written to the main log. This option and &%log_output%& are mutually exclusive.
22205 Only one of them may be set.
22206
22207
22208
22209 .option log_output pipe boolean false
22210 If this option is set and the command returns any output, the first line of
22211 output is written to the main log, whatever the return code. This option and
22212 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22213
22214
22215
22216 .option max_output pipe integer 20K
22217 This specifies the maximum amount of output that the command may produce on its
22218 standard output and standard error file combined. If the limit is exceeded, the
22219 process running the command is killed. This is intended as a safety measure to
22220 catch runaway processes. The limit is applied independently of the settings of
22221 the options that control what is done with such output (for example,
22222 &%return_output%&). Because of buffering effects, the amount of output may
22223 exceed the limit by a small amount before Exim notices.
22224
22225
22226 .option message_prefix pipe string&!! "see below"
22227 The string specified here is expanded and output at the start of every message.
22228 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22229 .code
22230 message_prefix = \
22231   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22232   ${tod_bsdinbox}\n
22233 .endd
22234 .cindex "Cyrus"
22235 .cindex "&%tmail%&"
22236 .cindex "&""From""& line"
22237 This is required by the commonly used &_/usr/bin/vacation_& program.
22238 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22239 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22240 setting
22241 .code
22242 message_prefix =
22243 .endd
22244 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22245 &`\n`& to &`\r\n`& in &%message_prefix%&.
22246
22247
22248 .option message_suffix pipe string&!! "see below"
22249 The string specified here is expanded and output at the end of every message.
22250 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22251 The suffix can be suppressed by setting
22252 .code
22253 message_suffix =
22254 .endd
22255 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22256 &`\n`& to &`\r\n`& in &%message_suffix%&.
22257
22258
22259 .option path pipe string "see below"
22260 This option specifies the string that is set up in the PATH environment
22261 variable of the subprocess. The default is:
22262 .code
22263 /bin:/usr/bin
22264 .endd
22265 If the &%command%& option does not yield an absolute path name, the command is
22266 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22267 apply to a command specified as a transport filter.
22268
22269
22270 .option permit_coredump pipe boolean false
22271 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22272 a core-dump of a pipe command, enable this command.  This enables core-dumps
22273 during delivery and affects both the Exim binary and the pipe command run.
22274 It is recommended that this option remain off unless and until you have a need
22275 for it and that this only be enabled when needed, as the risk of excessive
22276 resource consumption can be quite high.  Note also that Exim is typically
22277 installed as a setuid binary and most operating systems will inhibit coredumps
22278 of these by default, so further OS-specific action may be required.
22279
22280
22281 .option pipe_as_creator pipe boolean false
22282 .cindex "uid (user id)" "local delivery"
22283 If the generic &%user%& option is not set and this option is true, the delivery
22284 process is run under the uid that was in force when Exim was originally called
22285 to accept the message. If the group id is not otherwise set (via the generic
22286 &%group%& option), the gid that was in force when Exim was originally called to
22287 accept the message is used.
22288
22289
22290 .option restrict_to_path pipe boolean false
22291 When this option is set, any command name not listed in &%allow_commands%& must
22292 contain no slashes. The command is searched for only in the directories listed
22293 in the &%path%& option. This option is intended for use in the case when a pipe
22294 command has been generated from a user's &_.forward_& file. This is usually
22295 handled by a &(pipe)& transport called &%address_pipe%&.
22296
22297
22298 .option return_fail_output pipe boolean false
22299 If this option is true, and the command produced any output and ended with a
22300 return code other than zero or one of the codes listed in &%temp_errors%& (that
22301 is, the delivery failed), the output is returned in the bounce message.
22302 However, if the message has a null sender (that is, it is itself a bounce
22303 message), output from the command is discarded. This option and
22304 &%return_output%& are mutually exclusive. Only one of them may be set.
22305
22306
22307
22308 .option return_output pipe boolean false
22309 If this option is true, and the command produced any output, the delivery is
22310 deemed to have failed whatever the return code from the command, and the output
22311 is returned in the bounce message. Otherwise, the output is just discarded.
22312 However, if the message has a null sender (that is, it is a bounce message),
22313 output from the command is always discarded, whatever the setting of this
22314 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22315 of them may be set.
22316
22317
22318
22319 .option temp_errors pipe "string list" "see below"
22320 .cindex "&(pipe)& transport" "temporary failure"
22321 This option contains either a colon-separated list of numbers, or a single
22322 asterisk. If &%ignore_status%& is false
22323 and &%return_output%& is not set,
22324 and the command exits with a non-zero return code, the failure is treated as
22325 temporary and the delivery is deferred if the return code matches one of the
22326 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22327 codes are treated as permanent errors. The default setting contains the codes
22328 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22329 compiled on a system that does not define these macros, it assumes values of 75
22330 and 73, respectively.
22331
22332
22333 .option timeout pipe time 1h
22334 If the command fails to complete within this time, it is killed. This normally
22335 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22336 specifies no timeout. In order to ensure that any subprocesses created by the
22337 command are also killed, Exim makes the initial process a process group leader,
22338 and kills the whole process group on a timeout. However, this can be defeated
22339 if one of the processes starts a new process group.
22340
22341 .option timeout_defer pipe boolean false
22342 A timeout in a &(pipe)& transport, either in the command that the transport
22343 runs, or in a transport filter that is associated with it, is by default
22344 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22345 is set true, both kinds of timeout become temporary errors, causing the
22346 delivery to be deferred.
22347
22348 .option umask pipe "octal integer" 022
22349 This specifies the umask setting for the subprocess that runs the command.
22350
22351
22352 .option use_bsmtp pipe boolean false
22353 .cindex "envelope sender"
22354 If this option is set true, the &(pipe)& transport writes messages in &"batch
22355 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22356 commands. If you want to include a leading HELO command with such messages,
22357 you can do so by setting the &%message_prefix%& option. See section
22358 &<<SECTbatchSMTP>>& for details of batch SMTP.
22359
22360 .option use_classresources pipe boolean false
22361 .cindex "class resources (BSD)"
22362 This option is available only when Exim is running on FreeBSD, NetBSD, or
22363 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22364 resource limits when a &(pipe)& transport is run to perform a delivery. The
22365 limits for the uid under which the pipe is to run are obtained from the login
22366 class database.
22367
22368
22369 .option use_crlf pipe boolean false
22370 .cindex "carriage return"
22371 .cindex "linefeed"
22372 This option causes lines to be terminated with the two-character CRLF sequence
22373 (carriage return, linefeed) instead of just a linefeed character. In the case
22374 of batched SMTP, the byte sequence written to the pipe is then an exact image
22375 of what would be sent down a real SMTP connection.
22376
22377 The contents of the &%message_prefix%& and &%message_suffix%& options are
22378 written verbatim, so must contain their own carriage return characters if these
22379 are needed. When &%use_bsmtp%& is not set, the default values for both
22380 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22381 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22382
22383
22384 .option use_shell pipe boolean false
22385 .vindex "&$pipe_addresses$&"
22386 If this option is set, it causes the command to be passed to &_/bin/sh_&
22387 instead of being run directly from the transport, as described in section
22388 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22389 where the command is expected to be run under a shell and cannot easily be
22390 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22391 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22392 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22393 its &%-c%& option.
22394
22395
22396
22397 .section "Using an external local delivery agent" "SECID143"
22398 .cindex "local delivery" "using an external agent"
22399 .cindex "&'procmail'&"
22400 .cindex "external local delivery"
22401 .cindex "delivery" "&'procmail'&"
22402 .cindex "delivery" "by external agent"
22403 The &(pipe)& transport can be used to pass all messages that require local
22404 delivery to a separate local delivery agent such as &%procmail%&. When doing
22405 this, care must be taken to ensure that the pipe is run under an appropriate
22406 uid and gid. In some configurations one wants this to be a uid that is trusted
22407 by the delivery agent to supply the correct sender of the message. It may be
22408 necessary to recompile or reconfigure the delivery agent so that it trusts an
22409 appropriate user. The following is an example transport and router
22410 configuration for &%procmail%&:
22411 .code
22412 # transport
22413 procmail_pipe:
22414   driver = pipe
22415   command = /usr/local/bin/procmail -d $local_part
22416   return_path_add
22417   delivery_date_add
22418   envelope_to_add
22419   check_string = "From "
22420   escape_string = ">From "
22421   umask = 077
22422   user = $local_part
22423   group = mail
22424
22425 # router
22426 procmail:
22427   driver = accept
22428   check_local_user
22429   transport = procmail_pipe
22430 .endd
22431 In this example, the pipe is run as the local user, but with the group set to
22432 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22433 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22434 user to supply a correct sender address. If you do not specify either a
22435 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22436 home directory is the user's home directory by default.
22437
22438 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22439 .code
22440 IFS=" "
22441 .endd
22442 as shown in some &%procmail%& documentation, because Exim does not by default
22443 use a shell to run pipe commands.
22444
22445 .cindex "Cyrus"
22446 The next example shows a transport and a router for a system where local
22447 deliveries are handled by the Cyrus IMAP server.
22448 .code
22449 # transport
22450 local_delivery_cyrus:
22451   driver = pipe
22452   command = /usr/cyrus/bin/deliver \
22453             -m ${substr_1:$local_part_suffix} -- $local_part
22454   user = cyrus
22455   group = mail
22456   return_output
22457   log_output
22458   message_prefix =
22459   message_suffix =
22460
22461 # router
22462 local_user_cyrus:
22463   driver = accept
22464   check_local_user
22465   local_part_suffix = .*
22466   transport = local_delivery_cyrus
22467 .endd
22468 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22469 &%return_output%& to cause any text written by Cyrus to be returned to the
22470 sender.
22471 .ecindex IIDpiptra1
22472 .ecindex IIDpiptra2
22473
22474
22475 . ////////////////////////////////////////////////////////////////////////////
22476 . ////////////////////////////////////////////////////////////////////////////
22477
22478 .chapter "The smtp transport" "CHAPsmtptrans"
22479 .scindex IIDsmttra1 "transports" "&(smtp)&"
22480 .scindex IIDsmttra2 "&(smtp)& transport"
22481 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22482 or LMTP protocol. The list of hosts to try can either be taken from the address
22483 that is being processed (having been set up by the router), or specified
22484 explicitly for the transport. Timeout and retry processing (see chapter
22485 &<<CHAPretry>>&) is applied to each IP address independently.
22486
22487
22488 .section "Multiple messages on a single connection" "SECID144"
22489 The sending of multiple messages over a single TCP/IP connection can arise in
22490 two ways:
22491
22492 .ilist
22493 If a message contains more than &%max_rcpt%& (see below) addresses that are
22494 routed to the same host, more than one copy of the message has to be sent to
22495 that host. In this situation, multiple copies may be sent in a single run of
22496 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22497 does when it has too many addresses to send in one message also depends on the
22498 value of the global &%remote_max_parallel%& option. Details are given in
22499 section &<<SECToutSMTPTCP>>&.)
22500 .next
22501 .cindex "hints database" "remembering routing"
22502 When a message has been successfully delivered over a TCP/IP connection, Exim
22503 looks in its hints database to see if there are any other messages awaiting a
22504 connection to the same host. If there are, a new delivery process is started
22505 for one of them, and the current TCP/IP connection is passed on to it. The new
22506 process may in turn send multiple copies and possibly create yet another
22507 process.
22508 .endlist
22509
22510
22511 For each copy sent over the same TCP/IP connection, a sequence counter is
22512 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22513 no further messages are sent over that connection.
22514
22515
22516
22517 .section "Use of the $host and $host_address variables" "SECID145"
22518 .vindex "&$host$&"
22519 .vindex "&$host_address$&"
22520 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22521 &$host_address$& are the name and IP address of the first host on the host list
22522 passed by the router. However, when the transport is about to connect to a
22523 specific host, and while it is connected to that host, &$host$& and
22524 &$host_address$& are set to the values for that host. These are the values
22525 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22526 &%serialize_hosts%&, and the various TLS options are expanded.
22527
22528
22529 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22530 .vindex &$tls_bits$&
22531 .vindex &$tls_cipher$&
22532 .vindex &$tls_peerdn$&
22533 .vindex &$tls_sni$&
22534 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22535 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22536 are the values that were set when the message was received.
22537 These are the values that are used for options that are expanded before any
22538 SMTP connections are made. Just before each connection is made, these four
22539 variables are emptied. If TLS is subsequently started, they are set to the
22540 appropriate values for the outgoing connection, and these are the values that
22541 are in force when any authenticators are run and when the
22542 &%authenticated_sender%& option is expanded.
22543
22544 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22545 and will be removed in a future release.
22546
22547
22548 .section "Private options for smtp" "SECID146"
22549 .cindex "options" "&(smtp)& transport"
22550 The private options of the &(smtp)& transport are as follows:
22551
22552
22553 .option address_retry_include_sender smtp boolean true
22554 .cindex "4&'xx'& responses" "retrying after"
22555 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22556 is the combination of sender and recipient that is delayed in subsequent queue
22557 runs until the retry time is reached. You can delay the recipient without
22558 reference to the sender (which is what earlier versions of Exim did), by
22559 setting &%address_retry_include_sender%& false. However, this can lead to
22560 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22561
22562 .option allow_localhost smtp boolean false
22563 .cindex "local host" "sending to"
22564 .cindex "fallback" "hosts specified on transport"
22565 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22566 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22567 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22568 the delivery anyway. This should be used only in special cases when the
22569 configuration ensures that no looping will result (for example, a differently
22570 configured Exim is listening on the port to which the message is sent).
22571
22572
22573 .option authenticated_sender smtp string&!! unset
22574 .cindex "Cyrus"
22575 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22576 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22577 overriding any existing authenticated sender value. If the string expansion is
22578 forced to fail, the option is ignored. Other expansion failures cause delivery
22579 to be deferred. If the result of expansion is an empty string, that is also
22580 ignored.
22581
22582 The expansion happens after the outgoing connection has been made and TLS
22583 started, if required. This means that the &$host$&, &$host_address$&,
22584 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22585 particular connection.
22586
22587 If the SMTP session is not authenticated, the expansion of
22588 &%authenticated_sender%& still happens (and can cause the delivery to be
22589 deferred if it fails), but no AUTH= item is added to MAIL commands
22590 unless &%authenticated_sender_force%& is true.
22591
22592 This option allows you to use the &(smtp)& transport in LMTP mode to
22593 deliver mail to Cyrus IMAP and provide the proper local part as the
22594 &"authenticated sender"&, via a setting such as:
22595 .code
22596 authenticated_sender = $local_part
22597 .endd
22598 This removes the need for IMAP subfolders to be assigned special ACLs to
22599 allow direct delivery to those subfolders.
22600
22601 Because of expected uses such as that just described for Cyrus (when no
22602 domain is involved), there is no checking on the syntax of the provided
22603 value.
22604
22605
22606 .option authenticated_sender_force smtp boolean false
22607 If this option is set true, the &%authenticated_sender%& option's value
22608 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22609 authenticated as a client.
22610
22611
22612 .option command_timeout smtp time 5m
22613 This sets a timeout for receiving a response to an SMTP command that has been
22614 sent out. It is also used when waiting for the initial banner line from the
22615 remote host. Its value must not be zero.
22616
22617
22618 .option connect_timeout smtp time 5m
22619 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22620 to a remote host. A setting of zero allows the system timeout (typically
22621 several minutes) to act. To have any effect, the value of this option must be
22622 less than the system timeout. However, it has been observed that on some
22623 systems there is no system timeout, which is why the default value for this
22624 option is 5 minutes, a value recommended by RFC 1123.
22625
22626
22627 .option connection_max_messages smtp integer 500
22628 .cindex "SMTP" "passed connection"
22629 .cindex "SMTP" "multiple deliveries"
22630 .cindex "multiple SMTP deliveries"
22631 This controls the maximum number of separate message deliveries that are sent
22632 over a single TCP/IP connection. If the value is zero, there is no limit.
22633 For testing purposes, this value can be overridden by the &%-oB%& command line
22634 option.
22635
22636
22637 .option data_timeout smtp time 5m
22638 This sets a timeout for the transmission of each block in the data portion of
22639 the message. As a result, the overall timeout for a message depends on the size
22640 of the message. Its value must not be zero. See also &%final_timeout%&.
22641
22642
22643 .option delay_after_cutoff smtp boolean true
22644 This option controls what happens when all remote IP addresses for a given
22645 domain have been inaccessible for so long that they have passed their retry
22646 cutoff times.
22647
22648 In the default state, if the next retry time has not been reached for any of
22649 them, the address is bounced without trying any deliveries. In other words,
22650 Exim delays retrying an IP address after the final cutoff time until a new
22651 retry time is reached, and can therefore bounce an address without ever trying
22652 a delivery, when machines have been down for a long time. Some people are
22653 unhappy at this prospect, so...
22654
22655 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22656 addresses are past their final cutoff time, Exim tries to deliver to those
22657 IP addresses that have not been tried since the message arrived. If there are
22658 none, of if they all fail, the address is bounced. In other words, it does not
22659 delay when a new message arrives, but immediately tries those expired IP
22660 addresses that haven't been tried since the message arrived. If there is a
22661 continuous stream of messages for the dead hosts, unsetting
22662 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22663 to them.
22664
22665
22666 .option dns_qualify_single smtp boolean true
22667 If the &%hosts%& or &%fallback_hosts%& option is being used,
22668 and the &%gethostbyname%& option is false,
22669 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22670 in chapter &<<CHAPdnslookup>>& for more details.
22671
22672
22673 .option dns_search_parents smtp boolean false
22674 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22675 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22676 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22677 details.
22678
22679
22680 .new
22681 .option dnssec_request_domains smtp "domain list&!!" unset
22682 .cindex "MX record" "security"
22683 .cindex "DNSSEC" "MX lookup"
22684 .cindex "security" "MX lookup"
22685 .cindex "DNS" "DNSSEC"
22686 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22687 the dnssec request bit set.
22688 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22689 .wen
22690
22691
22692
22693 .new
22694 .option dnssec_require_domains smtp "domain list&!!" unset
22695 .cindex "MX record" "security"
22696 .cindex "DNSSEC" "MX lookup"
22697 .cindex "security" "MX lookup"
22698 .cindex "DNS" "DNSSEC"
22699 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22700 the dnssec request bit set.  Any returns not having the Authenticated Data bit
22701 (AD bit) set wil be ignored and logged as a host-lookup failure.
22702 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22703 .wen
22704
22705
22706
22707 .option dscp smtp string&!! unset
22708 .cindex "DCSP" "outbound"
22709 This option causes the DSCP value associated with a socket to be set to one
22710 of a number of fixed strings or to numeric value.
22711 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22712 Common values include &`throughput`&, &`mincost`&, and on newer systems
22713 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22714
22715 The outbound packets from Exim will be marked with this value in the header
22716 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22717 that these values will have any effect, not be stripped by networking
22718 equipment, or do much of anything without cooperation with your Network
22719 Engineer and those of all network operators between the source and destination.
22720
22721
22722 .option fallback_hosts smtp "string list" unset
22723 .cindex "fallback" "hosts specified on transport"
22724 String expansion is not applied to this option. The argument must be a
22725 colon-separated list of host names or IP addresses, optionally also including
22726 port numbers, though the separator can be changed, as described in section
22727 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22728 item in a &%route_list%& setting for the &(manualroute)& router, as described
22729 in section &<<SECTformatonehostitem>>&.
22730
22731 Fallback hosts can also be specified on routers, which associate them with the
22732 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22733 &%fallback_hosts%& specified on the transport is used only if the address does
22734 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22735 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22736 However, &%hosts_randomize%& does apply to fallback host lists.
22737
22738 If Exim is unable to deliver to any of the hosts for a particular address, and
22739 the errors are not permanent rejections, the address is put on a separate
22740 transport queue with its host list replaced by the fallback hosts, unless the
22741 address was routed via MX records and the current host was in the original MX
22742 list. In that situation, the fallback host list is not used.
22743
22744 Once normal deliveries are complete, the fallback queue is delivered by
22745 re-running the same transports with the new host lists. If several failing
22746 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22747 copy of the message is sent.
22748
22749 The resolution of the host names on the fallback list is controlled by the
22750 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22751 both to cases when the host list comes with the address and when it is taken
22752 from &%hosts%&. This option provides a &"use a smart host only if delivery
22753 fails"& facility.
22754
22755
22756 .option final_timeout smtp time 10m
22757 This is the timeout that applies while waiting for the response to the final
22758 line containing just &"."& that terminates a message. Its value must not be
22759 zero.
22760
22761 .option gethostbyname smtp boolean false
22762 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22763 being used, names are looked up using &[gethostbyname()]&
22764 (or &[getipnodebyname()]& when available)
22765 instead of using the DNS. Of course, that function may in fact use the DNS, but
22766 it may also consult other sources of information such as &_/etc/hosts_&.
22767
22768 .option gnutls_compat_mode smtp boolean unset
22769 This option controls whether GnuTLS is used in compatibility mode in an Exim
22770 server. This reduces security slightly, but improves interworking with older
22771 implementations of TLS.
22772
22773 .option helo_data smtp string&!! "see below"
22774 .cindex "HELO" "argument, setting"
22775 .cindex "EHLO" "argument, setting"
22776 .cindex "LHLO argument setting"
22777 The value of this option is expanded after a connection to a another host has
22778 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22779 command that starts the outgoing SMTP or LMTP session. The default value of the
22780 option is:
22781 .code
22782 $primary_hostname
22783 .endd
22784 During the expansion, the variables &$host$& and &$host_address$& are set to
22785 the identity of the remote host, and the variables &$sending_ip_address$& and
22786 &$sending_port$& are set to the local IP address and port number that are being
22787 used. These variables can be used to generate different values for different
22788 servers or different local IP addresses. For example, if you want the string
22789 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22790 interface address, you could use this:
22791 .code
22792 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22793   {$primary_hostname}}
22794 .endd
22795 The use of &%helo_data%& applies both to sending messages and when doing
22796 callouts.
22797
22798 .option hosts smtp "string list&!!" unset
22799 Hosts are associated with an address by a router such as &(dnslookup)&, which
22800 finds the hosts by looking up the address domain in the DNS, or by
22801 &(manualroute)&, which has lists of hosts in its configuration. However,
22802 email addresses can be passed to the &(smtp)& transport by any router, and not
22803 all of them can provide an associated list of hosts.
22804
22805 The &%hosts%& option specifies a list of hosts to be used if the address being
22806 processed does not have any hosts associated with it. The hosts specified by
22807 &%hosts%& are also used, whether or not the address has its own hosts, if
22808 &%hosts_override%& is set.
22809
22810 The string is first expanded, before being interpreted as a colon-separated
22811 list of host names or IP addresses, possibly including port numbers. The
22812 separator may be changed to something other than colon, as described in section
22813 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22814 item in a &%route_list%& setting for the &(manualroute)& router, as described
22815 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22816 of the &(manualroute)& router is not available here.
22817
22818 If the expansion fails, delivery is deferred. Unless the failure was caused by
22819 the inability to complete a lookup, the error is logged to the panic log as
22820 well as the main log. Host names are looked up either by searching directly for
22821 address records in the DNS or by calling &[gethostbyname()]& (or
22822 &[getipnodebyname()]& when available), depending on the setting of the
22823 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22824 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22825 address are used.
22826
22827 During delivery, the hosts are tried in order, subject to their retry status,
22828 unless &%hosts_randomize%& is set.
22829
22830
22831 .option hosts_avoid_esmtp smtp "host list&!!" unset
22832 .cindex "ESMTP, avoiding use of"
22833 .cindex "HELO" "forcing use of"
22834 .cindex "EHLO" "avoiding use of"
22835 .cindex "PIPELINING" "avoiding the use of"
22836 This option is for use with broken hosts that announce ESMTP facilities (for
22837 example, PIPELINING) and then fail to implement them properly. When a host
22838 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22839 start of the SMTP session. This means that it cannot use any of the ESMTP
22840 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22841
22842
22843 .option hosts_avoid_pipelining smtp "host list&!!" unset
22844 .cindex "PIPELINING" "avoiding the use of"
22845 Exim will not use the SMTP PIPELINING extension when delivering to any host
22846 that matches this list, even if the server host advertises PIPELINING support.
22847
22848
22849 .option hosts_avoid_tls smtp "host list&!!" unset
22850 .cindex "TLS" "avoiding for certain hosts"
22851 Exim will not try to start a TLS session when delivering to any host that
22852 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22853
22854 .option hosts_verify_avoid_tls smtp "host list&!!" *
22855 .cindex "TLS" "avoiding for certain hosts"
22856 Exim will not try to start a TLS session for a verify callout,
22857 or when delivering in cutthrough mode,
22858 to any host that matches this list.
22859 Note that the default is to not use TLS.
22860
22861
22862 .option hosts_max_try smtp integer 5
22863 .cindex "host" "maximum number to try"
22864 .cindex "limit" "number of hosts tried"
22865 .cindex "limit" "number of MX tried"
22866 .cindex "MX record" "maximum tried"
22867 This option limits the number of IP addresses that are tried for any one
22868 delivery in cases where there are temporary delivery errors. Section
22869 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22870
22871
22872 .option hosts_max_try_hardlimit smtp integer 50
22873 This is an additional check on the maximum number of IP addresses that Exim
22874 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22875 why it exists.
22876
22877
22878
22879 .option hosts_nopass_tls smtp "host list&!!" unset
22880 .cindex "TLS" "passing connection"
22881 .cindex "multiple SMTP deliveries"
22882 .cindex "TLS" "multiple message deliveries"
22883 For any host that matches this list, a connection on which a TLS session has
22884 been started will not be passed to a new delivery process for sending another
22885 message on the same connection. See section &<<SECTmulmessam>>& for an
22886 explanation of when this might be needed.
22887
22888
22889 .option hosts_override smtp boolean false
22890 If this option is set and the &%hosts%& option is also set, any hosts that are
22891 attached to the address are ignored, and instead the hosts specified by the
22892 &%hosts%& option are always used. This option does not apply to
22893 &%fallback_hosts%&.
22894
22895
22896 .option hosts_randomize smtp boolean false
22897 .cindex "randomized host list"
22898 .cindex "host" "list of; randomized"
22899 .cindex "fallback" "randomized hosts"
22900 If this option is set, and either the list of hosts is taken from the
22901 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22902 were not obtained from MX records (this includes fallback hosts from the
22903 router), and were not randomized by the router, the order of trying the hosts
22904 is randomized each time the transport runs. Randomizing the order of a host
22905 list can be used to do crude load sharing.
22906
22907 When &%hosts_randomize%& is true, a host list may be split into groups whose
22908 order is separately randomized. This makes it possible to set up MX-like
22909 behaviour. The boundaries between groups are indicated by an item that is just
22910 &`+`& in the host list. For example:
22911 .code
22912 hosts = host1:host2:host3:+:host4:host5
22913 .endd
22914 The order of the first three hosts and the order of the last two hosts is
22915 randomized for each use, but the first three always end up before the last two.
22916 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22917
22918 .option hosts_require_auth smtp "host list&!!" unset
22919 .cindex "authentication" "required by client"
22920 This option provides a list of servers for which authentication must succeed
22921 before Exim will try to transfer a message. If authentication fails for
22922 servers which are not in this list, Exim tries to send unauthenticated. If
22923 authentication fails for one of these servers, delivery is deferred. This
22924 temporary error is detectable in the retry rules, so it can be turned into a
22925 hard failure if required. See also &%hosts_try_auth%&, and chapter
22926 &<<CHAPSMTPAUTH>>& for details of authentication.
22927
22928
22929 .option hosts_require_tls smtp "host list&!!" unset
22930 .cindex "TLS" "requiring for certain servers"
22931 Exim will insist on using a TLS session when delivering to any host that
22932 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22933 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22934 incoming messages, use an appropriate ACL.
22935
22936 .option hosts_try_auth smtp "host list&!!" unset
22937 .cindex "authentication" "optional in client"
22938 This option provides a list of servers to which, provided they announce
22939 authentication support, Exim will attempt to authenticate as a client when it
22940 connects. If authentication fails, Exim will try to transfer the message
22941 unauthenticated. See also &%hosts_require_auth%&, and chapter
22942 &<<CHAPSMTPAUTH>>& for details of authentication.
22943
22944 .option interface smtp "string list&!!" unset
22945 .cindex "bind IP address"
22946 .cindex "IP address" "binding"
22947 .vindex "&$host$&"
22948 .vindex "&$host_address$&"
22949 This option specifies which interface to bind to when making an outgoing SMTP
22950 call. The value is an IP address, not an interface name such as
22951 &`eth0`&. Do not confuse this with the interface address that was used when a
22952 message was received, which is in &$received_ip_address$&, formerly known as
22953 &$interface_address$&. The name was changed to minimize confusion with the
22954 outgoing interface address. There is no variable that contains an outgoing
22955 interface address because, unless it is set by this option, its value is
22956 unknown.
22957
22958 During the expansion of the &%interface%& option the variables &$host$& and
22959 &$host_address$& refer to the host to which a connection is about to be made
22960 during the expansion of the string. Forced expansion failure, or an empty
22961 string result causes the option to be ignored. Otherwise, after expansion, the
22962 string must be a list of IP addresses, colon-separated by default, but the
22963 separator can be changed in the usual way. For example:
22964 .code
22965 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22966 .endd
22967 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22968 connection. If none of them are the correct type, the option is ignored. If
22969 &%interface%& is not set, or is ignored, the system's IP functions choose which
22970 interface to use if the host has more than one.
22971
22972
22973 .option keepalive smtp boolean true
22974 .cindex "keepalive" "on outgoing connection"
22975 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22976 connections. When set, it causes the kernel to probe idle connections
22977 periodically, by sending packets with &"old"& sequence numbers. The other end
22978 of the connection should send a acknowledgment if the connection is still okay
22979 or a reset if the connection has been aborted. The reason for doing this is
22980 that it has the beneficial effect of freeing up certain types of connection
22981 that can get stuck when the remote host is disconnected without tidying up the
22982 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22983 unreachable hosts.
22984
22985
22986 .option lmtp_ignore_quota smtp boolean false
22987 .cindex "LMTP" "ignoring quota errors"
22988 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22989 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22990 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22991
22992 .option max_rcpt smtp integer 100
22993 .cindex "RCPT" "maximum number of outgoing"
22994 This option limits the number of RCPT commands that are sent in a single
22995 SMTP message transaction. Each set of addresses is treated independently, and
22996 so can cause parallel connections to the same host if &%remote_max_parallel%&
22997 permits this.
22998
22999
23000 .option multi_domain smtp boolean true
23001 .vindex "&$domain$&"
23002 When this option is set, the &(smtp)& transport can handle a number of
23003 addresses containing a mixture of different domains provided they all resolve
23004 to the same list of hosts. Turning the option off restricts the transport to
23005 handling only one domain at a time. This is useful if you want to use
23006 &$domain$& in an expansion for the transport, because it is set only when there
23007 is a single domain involved in a remote delivery.
23008
23009
23010 .option port smtp string&!! "see below"
23011 .cindex "port" "sending TCP/IP"
23012 .cindex "TCP/IP" "setting outgoing port"
23013 This option specifies the TCP/IP port on the server to which Exim connects.
23014 &*Note:*& Do not confuse this with the port that was used when a message was
23015 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23016 The name was changed to minimize confusion with the outgoing port. There is no
23017 variable that contains an outgoing port.
23018
23019 If the value of this option begins with a digit it is taken as a port number;
23020 otherwise it is looked up using &[getservbyname()]&. The default value is
23021 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23022 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23023 is deferred.
23024
23025
23026
23027 .option protocol smtp string smtp
23028 .cindex "LMTP" "over TCP/IP"
23029 .cindex "ssmtp protocol" "outbound"
23030 .cindex "TLS" "SSL-on-connect outbound"
23031 .vindex "&$port$&"
23032 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23033 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23034 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23035 deliveries into closed message stores. Exim also has support for running LMTP
23036 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23037
23038 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23039 changes to &"smtps"&, and the transport initiates TLS immediately after
23040 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23041 The Internet standards bodies strongly discourage use of this mode.
23042
23043
23044 .option retry_include_ip_address smtp boolean true
23045 Exim normally includes both the host name and the IP address in the key it
23046 constructs for indexing retry data after a temporary delivery failure. This
23047 means that when one of several IP addresses for a host is failing, it gets
23048 tried periodically (controlled by the retry rules), but use of the other IP
23049 addresses is not affected.
23050
23051 However, in some dialup environments hosts are assigned a different IP address
23052 each time they connect. In this situation the use of the IP address as part of
23053 the retry key leads to undesirable behaviour. Setting this option false causes
23054 Exim to use only the host name. This should normally be done on a separate
23055 instance of the &(smtp)& transport, set up specially to handle the dialup
23056 hosts.
23057
23058
23059 .option serialize_hosts smtp "host list&!!" unset
23060 .cindex "serializing connections"
23061 .cindex "host" "serializing connections"
23062 Because Exim operates in a distributed manner, if several messages for the same
23063 host arrive at around the same time, more than one simultaneous connection to
23064 the remote host can occur. This is not usually a problem except when there is a
23065 slow link between the hosts. In that situation it may be helpful to restrict
23066 Exim to one connection at a time. This can be done by setting
23067 &%serialize_hosts%& to match the relevant hosts.
23068
23069 .cindex "hints database" "serializing deliveries to a host"
23070 Exim implements serialization by means of a hints database in which a record is
23071 written whenever a process connects to one of the restricted hosts. The record
23072 is deleted when the connection is completed. Obviously there is scope for
23073 records to get left lying around if there is a system or program crash. To
23074 guard against this, Exim ignores any records that are more than six hours old.
23075
23076 If you set up this kind of serialization, you should also arrange to delete the
23077 relevant hints database whenever your system reboots. The names of the files
23078 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23079 may be one or two files, depending on the type of DBM in use. The same files
23080 are used for ETRN serialization.
23081
23082
23083 .option size_addition smtp integer 1024
23084 .cindex "SMTP" "SIZE"
23085 .cindex "message" "size issue for transport filter"
23086 .cindex "size" "of message"
23087 .cindex "transport" "filter"
23088 .cindex "filter" "transport filter"
23089 If a remote SMTP server indicates that it supports the SIZE option of the
23090 MAIL command, Exim uses this to pass over the message size at the start of
23091 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23092 sends, to allow for headers and other text that may be added during delivery by
23093 configuration options or in a transport filter. It may be necessary to increase
23094 this if a lot of text is added to messages.
23095
23096 Alternatively, if the value of &%size_addition%& is set negative, it disables
23097 the use of the SIZE option altogether.
23098
23099
23100 .option tls_certificate smtp string&!! unset
23101 .cindex "TLS" "client certificate, location of"
23102 .cindex "certificate" "client, location of"
23103 .vindex "&$host$&"
23104 .vindex "&$host_address$&"
23105 The value of this option must be the absolute path to a file which contains the
23106 client's certificate, for possible use when sending a message over an encrypted
23107 connection. The values of &$host$& and &$host_address$& are set to the name and
23108 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23109 details of TLS.
23110
23111 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23112 certificate when sending messages as a client. The global option of the same
23113 name specifies the certificate for Exim as a server; it is not automatically
23114 assumed that the same certificate should be used when Exim is operating as a
23115 client.
23116
23117
23118 .option tls_crl smtp string&!! unset
23119 .cindex "TLS" "client certificate revocation list"
23120 .cindex "certificate" "revocation list for client"
23121 This option specifies a certificate revocation list. The expanded value must
23122 be the name of a file that contains a CRL in PEM format.
23123
23124
23125 .option tls_dh_min_bits smtp integer 1024
23126 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23127 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23128 key agreement is negotiated, the server will provide a large prime number
23129 for use.  This option establishes the minimum acceptable size of that number.
23130 If the parameter offered by the server is too small, then the TLS handshake
23131 will fail.
23132
23133 Only supported when using GnuTLS.
23134
23135
23136 .option tls_privatekey smtp string&!! unset
23137 .cindex "TLS" "client private key, location of"
23138 .vindex "&$host$&"
23139 .vindex "&$host_address$&"
23140 The value of this option must be the absolute path to a file which contains the
23141 client's private key. This is used when sending a message over an encrypted
23142 connection using a client certificate. The values of &$host$& and
23143 &$host_address$& are set to the name and address of the server during the
23144 expansion. If this option is unset, or the expansion is forced to fail, or the
23145 result is an empty string, the private key is assumed to be in the same file as
23146 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23147
23148
23149 .option tls_require_ciphers smtp string&!! unset
23150 .cindex "TLS" "requiring specific ciphers"
23151 .cindex "cipher" "requiring specific"
23152 .vindex "&$host$&"
23153 .vindex "&$host_address$&"
23154 The value of this option must be a list of permitted cipher suites, for use
23155 when setting up an outgoing encrypted connection. (There is a global option of
23156 the same name for controlling incoming connections.) The values of &$host$& and
23157 &$host_address$& are set to the name and address of the server during the
23158 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23159 is used in different ways by OpenSSL and GnuTLS (see sections
23160 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23161 ciphers is a preference order.
23162
23163
23164
23165 .option tls_sni smtp string&!! unset
23166 .cindex "TLS" "Server Name Indication"
23167 .vindex "&$tls_sni$&"
23168 If this option is set then it sets the $tls_out_sni variable and causes any
23169 TLS session to pass this value as the Server Name Indication extension to
23170 the remote side, which can be used by the remote side to select an appropriate
23171 certificate and private key for the session.
23172
23173 See &<<SECTtlssni>>& for more information.
23174
23175 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23176 TLS extensions.
23177
23178
23179
23180
23181 .option tls_tempfail_tryclear smtp boolean true
23182 .cindex "4&'xx'& responses" "to STARTTLS"
23183 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23184 setting up a TLS session, this option determines whether or not Exim should try
23185 to deliver the message unencrypted. If it is set false, delivery to the
23186 current host is deferred; if there are other hosts, they are tried. If this
23187 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23188 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23189 TLS negotiation fails, Exim closes the current connection (because it is in an
23190 unknown state), opens a new one to the same host, and then tries the delivery
23191 in clear.
23192
23193
23194 .option tls_try_verify_hosts smtp "host list&!! unset
23195 .cindex "TLS" "server certificate verification"
23196 .cindex "certificate" "verification of server"
23197 This option gives a list of hosts for which, on encrypted connections,
23198 certificate verification will be tried but need not succeed.
23199 The &%tls_verify_certificates%& option must also be set.
23200
23201
23202 .option tls_verify_certificates smtp string&!! unset
23203 .cindex "TLS" "server certificate verification"
23204 .cindex "certificate" "verification of server"
23205 .vindex "&$host$&"
23206 .vindex "&$host_address$&"
23207 The value of this option must be the absolute path to a file containing
23208 permitted server certificates, for use when setting up an encrypted connection.
23209 Alternatively, if you are using OpenSSL, you can set
23210 &%tls_verify_certificates%& to the name of a directory containing certificate
23211 files. This does not work with GnuTLS; the option must be set to the name of a
23212 single file if you are using GnuTLS. The values of &$host$& and
23213 &$host_address$& are set to the name and address of the server during the
23214 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23215
23216 For back-compatability,
23217 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23218 and certificate verification fails the TLS connection is closed.
23219
23220
23221 .option tls_verify_hosts smtp "host list&!! unset
23222 .cindex "TLS" "server certificate verification"
23223 .cindex "certificate" "verification of server"
23224 This option gives a list of hosts for which. on encrypted connections,
23225 certificate verification must succeed.
23226 The &%tls_verify_certificates%& option must also be set.
23227 If both this option and &%tls_try_verify_hosts%& are unset
23228 operation is as if this option selected all hosts.
23229
23230
23231
23232
23233 .section "How the limits for the number of hosts to try are used" &&&
23234          "SECTvalhosmax"
23235 .cindex "host" "maximum number to try"
23236 .cindex "limit" "hosts; maximum number tried"
23237 There are two options that are concerned with the number of hosts that are
23238 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23239 &%hosts_max_try_hardlimit%&.
23240
23241
23242 The &%hosts_max_try%& option limits the number of hosts that are tried
23243 for a single delivery. However, despite the term &"host"& in its name, the
23244 option actually applies to each IP address independently. In other words, a
23245 multihomed host is treated as several independent hosts, just as it is for
23246 retrying.
23247
23248 Many of the larger ISPs have multiple MX records which often point to
23249 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23250 created as a result of routing one of these domains.
23251
23252 Trying every single IP address on such a long list does not seem sensible; if
23253 several at the top of the list fail, it is reasonable to assume there is some
23254 problem that is likely to affect all of them. Roughly speaking, the value of
23255 &%hosts_max_try%& is the maximum number that are tried before deferring the
23256 delivery. However, the logic cannot be quite that simple.
23257
23258 Firstly, IP addresses that are skipped because their retry times have not
23259 arrived do not count, and in addition, addresses that are past their retry
23260 limits are also not counted, even when they are tried. This means that when
23261 some IP addresses are past their retry limits, more than the value of
23262 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23263 that all IP addresses are considered before timing out an email address (but
23264 see below for an exception).
23265
23266 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23267 list to see if there is a subsequent host with a different (higher valued) MX.
23268 If there is, that host is considered next, and the current IP address is used
23269 but not counted. This behaviour helps in the case of a domain with a retry rule
23270 that hardly ever delays any hosts, as is now explained:
23271
23272 Consider the case of a long list of hosts with one MX value, and a few with a
23273 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23274 hosts at the top of the list are tried at first. With the default retry rule,
23275 which specifies increasing retry times, the higher MX hosts are eventually
23276 tried when those at the top of the list are skipped because they have not
23277 reached their retry times.
23278
23279 However, it is common practice to put a fixed short retry time on domains for
23280 large ISPs, on the grounds that their servers are rarely down for very long.
23281 Unfortunately, these are exactly the domains that tend to resolve to long lists
23282 of hosts. The short retry time means that the lowest MX hosts are tried every
23283 time. The attempts may be in a different order because of random sorting, but
23284 without the special MX check, the higher MX hosts would never be tried until
23285 all the lower MX hosts had timed out (which might be several days), because
23286 there are always some lower MX hosts that have reached their retry times. With
23287 the special check, Exim considers at least one IP address from each MX value at
23288 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23289 reached.
23290
23291 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23292 particular, Exim normally eventually tries all the IP addresses before timing
23293 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23294 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23295 been set up with hundreds of IP addresses for some domains. It can
23296 take a very long time indeed for an address to time out in these cases.
23297
23298 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23299 Exim never tries more than this number of IP addresses; if it hits this limit
23300 and they are all timed out, the email address is bounced, even though not all
23301 possible IP addresses have been tried.
23302 .ecindex IIDsmttra1
23303 .ecindex IIDsmttra2
23304
23305
23306
23307
23308
23309 . ////////////////////////////////////////////////////////////////////////////
23310 . ////////////////////////////////////////////////////////////////////////////
23311
23312 .chapter "Address rewriting" "CHAPrewrite"
23313 .scindex IIDaddrew "rewriting" "addresses"
23314 There are some circumstances in which Exim automatically rewrites domains in
23315 addresses. The two most common are when an address is given without a domain
23316 (referred to as an &"unqualified address"&) or when an address contains an
23317 abbreviated domain that is expanded by DNS lookup.
23318
23319 Unqualified envelope addresses are accepted only for locally submitted
23320 messages, or for messages that are received from hosts matching
23321 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23322 appropriate. Unqualified addresses in header lines are qualified if they are in
23323 locally submitted messages, or messages from hosts that are permitted to send
23324 unqualified envelope addresses. Otherwise, unqualified addresses in header
23325 lines are neither qualified nor rewritten.
23326
23327 One situation in which Exim does &'not'& automatically rewrite a domain is
23328 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23329 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23330 do this. The new RFCs do not contain this suggestion.
23331
23332
23333 .section "Explicitly configured address rewriting" "SECID147"
23334 This chapter describes the rewriting rules that can be used in the
23335 main rewrite section of the configuration file, and also in the generic
23336 &%headers_rewrite%& option that can be set on any transport.
23337
23338 Some people believe that configured address rewriting is a Mortal Sin.
23339 Others believe that life is not possible without it. Exim provides the
23340 facility; you do not have to use it.
23341
23342 The main rewriting rules that appear in the &"rewrite"& section of the
23343 configuration file are applied to addresses in incoming messages, both envelope
23344 addresses and addresses in header lines. Each rule specifies the types of
23345 address to which it applies.
23346
23347 Whether or not addresses in header lines are rewritten depends on the origin of
23348 the headers and the type of rewriting. Global rewriting, that is, rewriting
23349 rules from the rewrite section of the configuration file, is applied only to
23350 those headers that were received with the message. Header lines that are added
23351 by ACLs or by a system filter or by individual routers or transports (which
23352 are specific to individual recipient addresses) are not rewritten by the global
23353 rules.
23354
23355 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23356 applies all headers except those added by routers and transports. That is, as
23357 well as the headers that were received with the message, it also applies to
23358 headers that were added by an ACL or a system filter.
23359
23360
23361 In general, rewriting addresses from your own system or domain has some
23362 legitimacy. Rewriting other addresses should be done only with great care and
23363 in special circumstances. The author of Exim believes that rewriting should be
23364 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23365 Although it can sometimes be used as a routing tool, this is very strongly
23366 discouraged.
23367
23368 There are two commonly encountered circumstances where rewriting is used, as
23369 illustrated by these examples:
23370
23371 .ilist
23372 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23373 exchange mail with each other behind a firewall, but there is only a single
23374 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23375 &'hitch.fict.example'& when sending mail off-site.
23376 .next
23377 A host rewrites the local parts of its own users so that, for example,
23378 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23379 .endlist
23380
23381
23382
23383 .section "When does rewriting happen?" "SECID148"
23384 .cindex "rewriting" "timing of"
23385 .cindex "&ACL;" "rewriting addresses in"
23386 Configured address rewriting can take place at several different stages of a
23387 message's processing.
23388
23389 .vindex "&$sender_address$&"
23390 At the start of an ACL for MAIL, the sender address may have been rewritten
23391 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23392 ordinary rewrite rules have yet been applied. If, however, the sender address
23393 is verified in the ACL, it is rewritten before verification, and remains
23394 rewritten thereafter. The subsequent value of &$sender_address$& is the
23395 rewritten address. This also applies if sender verification happens in a
23396 RCPT ACL. Otherwise, when the sender address is not verified, it is
23397 rewritten as soon as a message's header lines have been received.
23398
23399 .vindex "&$domain$&"
23400 .vindex "&$local_part$&"
23401 Similarly, at the start of an ACL for RCPT, the current recipient's address
23402 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23403 rewrite rules have yet been applied to it. However, the behaviour is different
23404 from the sender address when a recipient is verified. The address is rewritten
23405 for the verification, but the rewriting is not remembered at this stage. The
23406 value of &$local_part$& and &$domain$& after verification are always the same
23407 as they were before (that is, they contain the unrewritten &-- except for
23408 SMTP-time rewriting &-- address).
23409
23410 As soon as a message's header lines have been received, all the envelope
23411 recipient addresses are permanently rewritten, and rewriting is also applied to
23412 the addresses in the header lines (if configured). This happens before adding
23413 any header lines that were specified in MAIL or RCPT ACLs, and
23414 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23415 before the DATA ACL and &[local_scan()]& functions are run.
23416
23417 When an address is being routed, either for delivery or for verification,
23418 rewriting is applied immediately to child addresses that are generated by
23419 redirection, unless &%no_rewrite%& is set on the router.
23420
23421 .cindex "envelope sender" "rewriting at transport time"
23422 .cindex "rewriting" "at transport time"
23423 .cindex "header lines" "rewriting at transport time"
23424 At transport time, additional rewriting of addresses in header lines can be
23425 specified by setting the generic &%headers_rewrite%& option on a transport.
23426 This option contains rules that are identical in form to those in the rewrite
23427 section of the configuration file. They are applied to the original message
23428 header lines and any that were added by ACLs or a system filter. They are not
23429 applied to header lines that are added by routers or the transport.
23430
23431 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23432 transport option. However, it is not possible to rewrite envelope recipients at
23433 transport time.
23434
23435
23436
23437
23438 .section "Testing the rewriting rules that apply on input" "SECID149"
23439 .cindex "rewriting" "testing"
23440 .cindex "testing" "rewriting"
23441 Exim's input rewriting configuration appears in a part of the run time
23442 configuration file headed by &"begin rewrite"&. It can be tested by the
23443 &%-brw%& command line option. This takes an address (which can be a full RFC
23444 2822 address) as its argument. The output is a list of how the address would be
23445 transformed by the rewriting rules for each of the different places it might
23446 appear in an incoming message, that is, for each different header and for the
23447 envelope sender and recipient fields. For example,
23448 .code
23449 exim -brw ph10@exim.workshop.example
23450 .endd
23451 might produce the output
23452 .code
23453 sender: Philip.Hazel@exim.workshop.example
23454 from: Philip.Hazel@exim.workshop.example
23455 to: ph10@exim.workshop.example
23456 cc: ph10@exim.workshop.example
23457 bcc: ph10@exim.workshop.example
23458 reply-to: Philip.Hazel@exim.workshop.example
23459 env-from: Philip.Hazel@exim.workshop.example
23460 env-to: ph10@exim.workshop.example
23461 .endd
23462 which shows that rewriting has been set up for that address when used in any of
23463 the source fields, but not when it appears as a recipient address. At the
23464 present time, there is no equivalent way of testing rewriting rules that are
23465 set for a particular transport.
23466
23467
23468 .section "Rewriting rules" "SECID150"
23469 .cindex "rewriting" "rules"
23470 The rewrite section of the configuration file consists of lines of rewriting
23471 rules in the form
23472 .display
23473 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23474 .endd
23475 Rewriting rules that are specified for the &%headers_rewrite%& generic
23476 transport option are given as a colon-separated list. Each item in the list
23477 takes the same form as a line in the main rewriting configuration (except that
23478 any colons must be doubled, of course).
23479
23480 The formats of source patterns and replacement strings are described below.
23481 Each is terminated by white space, unless enclosed in double quotes, in which
23482 case normal quoting conventions apply inside the quotes. The flags are single
23483 characters which may appear in any order. Spaces and tabs between them are
23484 ignored.
23485
23486 For each address that could potentially be rewritten, the rules are scanned in
23487 order, and replacements for the address from earlier rules can themselves be
23488 replaced by later rules (but see the &"q"& and &"R"& flags).
23489
23490 The order in which addresses are rewritten is undefined, may change between
23491 releases, and must not be relied on, with one exception: when a message is
23492 received, the envelope sender is always rewritten first, before any header
23493 lines are rewritten. For example, the replacement string for a rewrite of an
23494 address in &'To:'& must not assume that the message's address in &'From:'& has
23495 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23496 that the envelope sender has already been rewritten.
23497
23498 .vindex "&$domain$&"
23499 .vindex "&$local_part$&"
23500 The variables &$local_part$& and &$domain$& can be used in the replacement
23501 string to refer to the address that is being rewritten. Note that lookup-driven
23502 rewriting can be done by a rule of the form
23503 .code
23504 *@*   ${lookup ...
23505 .endd
23506 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23507 refer to the address that is being rewritten.
23508
23509
23510 .section "Rewriting patterns" "SECID151"
23511 .cindex "rewriting" "patterns"
23512 .cindex "address list" "in a rewriting pattern"
23513 The source pattern in a rewriting rule is any item which may appear in an
23514 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23515 single-item address list, which means that it is expanded before being tested
23516 against the address. As always, if you use a regular expression as a pattern,
23517 you must take care to escape dollar and backslash characters, or use the &`\N`&
23518 facility to suppress string expansion within the regular expression.
23519
23520 Domains in patterns should be given in lower case. Local parts in patterns are
23521 case-sensitive. If you want to do case-insensitive matching of local parts, you
23522 can use a regular expression that starts with &`^(?i)`&.
23523
23524 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23525 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23526 depending on the type of match which occurred. These can be used in the
23527 replacement string to insert portions of the incoming address. &$0$& always
23528 refers to the complete incoming address. When a regular expression is used, the
23529 numerical variables are set from its capturing subexpressions. For other types
23530 of pattern they are set as follows:
23531
23532 .ilist
23533 If a local part or domain starts with an asterisk, the numerical variables
23534 refer to the character strings matched by asterisks, with &$1$& associated with
23535 the first asterisk, and &$2$& with the second, if present. For example, if the
23536 pattern
23537 .code
23538 *queen@*.fict.example
23539 .endd
23540 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23541 .code
23542 $0 = hearts-queen@wonderland.fict.example
23543 $1 = hearts-
23544 $2 = wonderland
23545 .endd
23546 Note that if the local part does not start with an asterisk, but the domain
23547 does, it is &$1$& that contains the wild part of the domain.
23548
23549 .next
23550 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23551 of the domain are placed in the next available numerical variables. Suppose,
23552 for example, that the address &'foo@bar.baz.example'& is processed by a
23553 rewriting rule of the form
23554 .display
23555 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23556 .endd
23557 and the key in the file that matches the domain is &`*.baz.example`&. Then
23558 .code
23559 $1 = foo
23560 $2 = bar
23561 $3 = baz.example
23562 .endd
23563 If the address &'foo@baz.example'& is looked up, this matches the same
23564 wildcard file entry, and in this case &$2$& is set to the empty string, but
23565 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23566 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23567 whole domain. For non-partial domain lookups, no numerical variables are set.
23568 .endlist
23569
23570
23571 .section "Rewriting replacements" "SECID152"
23572 .cindex "rewriting" "replacements"
23573 If the replacement string for a rule is a single asterisk, addresses that
23574 match the pattern and the flags are &'not'& rewritten, and no subsequent
23575 rewriting rules are scanned. For example,
23576 .code
23577 hatta@lookingglass.fict.example  *  f
23578 .endd
23579 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23580 &'From:'& headers.
23581
23582 .vindex "&$domain$&"
23583 .vindex "&$local_part$&"
23584 If the replacement string is not a single asterisk, it is expanded, and must
23585 yield a fully qualified address. Within the expansion, the variables
23586 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23587 Any letters they contain retain their original case &-- they are not lower
23588 cased. The numerical variables are set up according to the type of pattern that
23589 matched the address, as described above. If the expansion is forced to fail by
23590 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23591 current rule is abandoned, but subsequent rules may take effect. Any other
23592 expansion failure causes the entire rewriting operation to be abandoned, and an
23593 entry written to the panic log.
23594
23595
23596
23597 .section "Rewriting flags" "SECID153"
23598 There are three different kinds of flag that may appear on rewriting rules:
23599
23600 .ilist
23601 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23602 c, f, h, r, s, t.
23603 .next
23604 A flag that specifies rewriting at SMTP time: S.
23605 .next
23606 Flags that control the rewriting process: Q, q, R, w.
23607 .endlist
23608
23609 For rules that are part of the &%headers_rewrite%& generic transport option,
23610 E, F, T, and S are not permitted.
23611
23612
23613
23614 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23615          "SECID154"
23616 .cindex "rewriting" "flags"
23617 If none of the following flag letters, nor the &"S"& flag (see section
23618 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23619 and to both the sender and recipient fields of the envelope, whereas a
23620 transport-time rewriting rule just applies to all headers. Otherwise, the
23621 rewriting rule is skipped unless the relevant addresses are being processed.
23622 .display
23623 &`E`&       rewrite all envelope fields
23624 &`F`&       rewrite the envelope From field
23625 &`T`&       rewrite the envelope To field
23626 &`b`&       rewrite the &'Bcc:'& header
23627 &`c`&       rewrite the &'Cc:'& header
23628 &`f`&       rewrite the &'From:'& header
23629 &`h`&       rewrite all headers
23630 &`r`&       rewrite the &'Reply-To:'& header
23631 &`s`&       rewrite the &'Sender:'& header
23632 &`t`&       rewrite the &'To:'& header
23633 .endd
23634 "All headers" means all of the headers listed above that can be selected
23635 individually, plus their &'Resent-'& versions. It does not include
23636 other headers such as &'Subject:'& etc.
23637
23638 You should be particularly careful about rewriting &'Sender:'& headers, and
23639 restrict this to special known cases in your own domains.
23640
23641
23642 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23643 .cindex "SMTP" "rewriting malformed addresses"
23644 .cindex "RCPT" "rewriting argument of"
23645 .cindex "MAIL" "rewriting argument of"
23646 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23647 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23648 before any other processing; even before syntax checking. The pattern is
23649 required to be a regular expression, and it is matched against the whole of the
23650 data for the command, including any surrounding angle brackets.
23651
23652 .vindex "&$domain$&"
23653 .vindex "&$local_part$&"
23654 This form of rewrite rule allows for the handling of addresses that are not
23655 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23656 input). Because the input is not required to be a syntactically valid address,
23657 the variables &$local_part$& and &$domain$& are not available during the
23658 expansion of the replacement string. The result of rewriting replaces the
23659 original address in the MAIL or RCPT command.
23660
23661
23662 .section "Flags controlling the rewriting process" "SECID155"
23663 There are four flags which control the way the rewriting process works. These
23664 take effect only when a rule is invoked, that is, when the address is of the
23665 correct type (matches the flags) and matches the pattern:
23666
23667 .ilist
23668 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23669 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23670 absence of &"Q"& the rewritten address must always include a domain.
23671 .next
23672 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23673 even if no rewriting actually takes place because of a &"fail"& in the
23674 expansion. The &"q"& flag is not effective if the address is of the wrong type
23675 (does not match the flags) or does not match the pattern.
23676 .next
23677 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23678 address, up to ten times. It can be combined with the &"q"& flag, to stop
23679 rewriting once it fails to match (after at least one successful rewrite).
23680 .next
23681 .cindex "rewriting" "whole addresses"
23682 When an address in a header is rewritten, the rewriting normally applies only
23683 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23684 left unchanged. For example, rewriting might change
23685 .code
23686 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23687 .endd
23688 into
23689 .code
23690 From: Ford Prefect <prefectf@hitch.fict.example>
23691 .endd
23692 .cindex "RFC 2047"
23693 Sometimes there is a need to replace the whole address item, and this can be
23694 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23695 causes an address in a header line to be rewritten, the entire address is
23696 replaced, not just the working part. The replacement must be a complete RFC
23697 2822 address, including the angle brackets if necessary. If text outside angle
23698 brackets contains a character whose value is greater than 126 or less than 32
23699 (except for tab), the text is encoded according to RFC 2047. The character set
23700 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23701
23702 When the &"w"& flag is set on a rule that causes an envelope address to be
23703 rewritten, all but the working part of the replacement address is discarded.
23704 .endlist
23705
23706
23707 .section "Rewriting examples" "SECID156"
23708 Here is an example of the two common rewriting paradigms:
23709 .code
23710 *@*.hitch.fict.example  $1@hitch.fict.example
23711 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23712                      {$value}fail}@hitch.fict.example bctfrF
23713 .endd
23714 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23715 the string expansion to fail if the lookup does not succeed. In this context it
23716 has the effect of leaving the original address unchanged, but Exim goes on to
23717 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23718 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23719 explicitly, which would cause the rewritten address to be the same as before,
23720 at the cost of a small bit of processing. Not supplying either of these is an
23721 error, since the rewritten address would then contain no local part.
23722
23723 The first example above replaces the domain with a superior, more general
23724 domain. This may not be desirable for certain local parts. If the rule
23725 .code
23726 root@*.hitch.fict.example  *
23727 .endd
23728 were inserted before the first rule, rewriting would be suppressed for the
23729 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23730
23731 Rewriting can be made conditional on a number of tests, by making use of
23732 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23733 messages that originate outside the local host:
23734 .code
23735 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23736                          {$1@hitch.fict.example}fail}"
23737 .endd
23738 The replacement string is quoted in this example because it contains white
23739 space.
23740
23741 .cindex "rewriting" "bang paths"
23742 .cindex "bang paths" "rewriting"
23743 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23744 an address it treats it as an unqualified local part which it qualifies with
23745 the local qualification domain (if the source of the message is local or if the
23746 remote host is permitted to send unqualified addresses). Rewriting can
23747 sometimes be used to handle simple bang paths with a fixed number of
23748 components. For example, the rule
23749 .code
23750 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23751 .endd
23752 rewrites a two-component bang path &'host.name!user'& as the domain address
23753 &'user@host.name'&. However, there is a security implication in using this as
23754 a global rewriting rule for envelope addresses. It can provide a backdoor
23755 method for using your system as a relay, because the incoming addresses appear
23756 to be local. If the bang path addresses are received via SMTP, it is safer to
23757 use the &"S"& flag to rewrite them as they are received, so that relay checking
23758 can be done on the rewritten addresses.
23759 .ecindex IIDaddrew
23760
23761
23762
23763
23764
23765 . ////////////////////////////////////////////////////////////////////////////
23766 . ////////////////////////////////////////////////////////////////////////////
23767
23768 .chapter "Retry configuration" "CHAPretry"
23769 .scindex IIDretconf1 "retry" "configuration, description of"
23770 .scindex IIDregconf2 "configuration file" "retry section"
23771 The &"retry"& section of the runtime configuration file contains a list of
23772 retry rules that control how often Exim tries to deliver messages that cannot
23773 be delivered at the first attempt. If there are no retry rules (the section is
23774 empty or not present), there are no retries. In this situation, temporary
23775 errors are treated as permanent. The default configuration contains a single,
23776 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23777 line option can be used to test which retry rule will be used for a given
23778 address, domain and error.
23779
23780 The most common cause of retries is temporary failure to deliver to a remote
23781 host because the host is down, or inaccessible because of a network problem.
23782 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23783 address) basis, not on a per-message basis. Thus, if one message has recently
23784 been delayed, delivery of a new message to the same host is not immediately
23785 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23786 log selector is set, the message
23787 .cindex "retry" "time not reached"
23788 &"retry time not reached"& is written to the main log whenever a delivery is
23789 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23790 the handling of errors during remote deliveries.
23791
23792 Retry processing applies to routing as well as to delivering, except as covered
23793 in the next paragraph. The retry rules do not distinguish between these
23794 actions. It is not possible, for example, to specify different behaviour for
23795 failures to route the domain &'snark.fict.example'& and failures to deliver to
23796 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23797 added complication, so did not implement it. However, although they share the
23798 same retry rule, the actual retry times for routing and transporting a given
23799 domain are maintained independently.
23800
23801 When a delivery is not part of a queue run (typically an immediate delivery on
23802 receipt of a message), the routers are always run, and local deliveries are
23803 always attempted, even if retry times are set for them. This makes for better
23804 behaviour if one particular message is causing problems (for example, causing
23805 quota overflow, or provoking an error in a filter file). If such a delivery
23806 suffers a temporary failure, the retry data is updated as normal, and
23807 subsequent delivery attempts from queue runs occur only when the retry time for
23808 the local address is reached.
23809
23810 .section "Changing retry rules" "SECID157"
23811 If you change the retry rules in your configuration, you should consider
23812 whether or not to delete the retry data that is stored in Exim's spool area in
23813 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23814 always safe; that is why they are called &"hints"&.
23815
23816 The hints retry data contains suggested retry times based on the previous
23817 rules. In the case of a long-running problem with a remote host, it might
23818 record the fact that the host has timed out. If your new rules increase the
23819 timeout time for such a host, you should definitely remove the old retry data
23820 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23821 messages that it should now be retaining.
23822
23823
23824
23825 .section "Format of retry rules" "SECID158"
23826 .cindex "retry" "rules"
23827 Each retry rule occupies one line and consists of three or four parts,
23828 separated by white space: a pattern, an error name, an optional list of sender
23829 addresses, and a list of retry parameters. The pattern and sender lists must be
23830 enclosed in double quotes if they contain white space. The rules are searched
23831 in order until one is found where the pattern, error name, and sender list (if
23832 present) match the failing host or address, the error that occurred, and the
23833 message's sender, respectively.
23834
23835
23836 The pattern is any single item that may appear in an address list (see section
23837 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23838 which means that it is expanded before being tested against the address that
23839 has been delayed. A negated address list item is permitted. Address
23840 list processing treats a plain domain name as if it were preceded by &"*@"&,
23841 which makes it possible for many retry rules to start with just a domain. For
23842 example,
23843 .code
23844 lookingglass.fict.example        *  F,24h,30m;
23845 .endd
23846 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23847 whereas
23848 .code
23849 alice@lookingglass.fict.example  *  F,24h,30m;
23850 .endd
23851 applies only to temporary failures involving the local part &%alice%&.
23852 In practice, almost all rules start with a domain name pattern without a local
23853 part.
23854
23855 .cindex "regular expressions" "in retry rules"
23856 &*Warning*&: If you use a regular expression in a retry rule pattern, it
23857 must match a complete address, not just a domain, because that is how regular
23858 expressions work in address lists.
23859 .display
23860 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23861 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23862 .endd
23863
23864
23865 .section "Choosing which retry rule to use for address errors" "SECID159"
23866 When Exim is looking for a retry rule after a routing attempt has failed (for
23867 example, after a DNS timeout), each line in the retry configuration is tested
23868 against the complete address only if &%retry_use_local_part%& is set for the
23869 router. Otherwise, only the domain is used, except when matching against a
23870 regular expression, when the local part of the address is replaced with &"*"&.
23871 A domain on its own can match a domain pattern, or a pattern that starts with
23872 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23873 &%check_local_user%& is true, and false for other routers.
23874
23875 Similarly, when Exim is looking for a retry rule after a local delivery has
23876 failed (for example, after a mailbox full error), each line in the retry
23877 configuration is tested against the complete address only if
23878 &%retry_use_local_part%& is set for the transport (it defaults true for all
23879 local transports).
23880
23881 .cindex "4&'xx'& responses" "retry rules for"
23882 However, when Exim is looking for a retry rule after a remote delivery attempt
23883 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23884 whole address is always used as the key when searching the retry rules. The
23885 rule that is found is used to create a retry time for the combination of the
23886 failing address and the message's sender. It is the combination of sender and
23887 recipient that is delayed in subsequent queue runs until its retry time is
23888 reached. You can delay the recipient without regard to the sender by setting
23889 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23890 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23891 commands.
23892
23893
23894
23895 .section "Choosing which retry rule to use for host and message errors" &&&
23896          "SECID160"
23897 For a temporary error that is not related to an individual address (for
23898 example, a connection timeout), each line in the retry configuration is checked
23899 twice. First, the name of the remote host is used as a domain name (preceded by
23900 &"*@"& when matching a regular expression). If this does not match the line,
23901 the domain from the email address is tried in a similar fashion. For example,
23902 suppose the MX records for &'a.b.c.example'& are
23903 .code
23904 a.b.c.example  MX  5  x.y.z.example
23905                MX  6  p.q.r.example
23906                MX  7  m.n.o.example
23907 .endd
23908 and the retry rules are
23909 .code
23910 p.q.r.example    *      F,24h,30m;
23911 a.b.c.example    *      F,4d,45m;
23912 .endd
23913 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23914 first rule matches neither the host nor the domain, so Exim looks at the second
23915 rule. This does not match the host, but it does match the domain, so it is used
23916 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23917 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23918 first retry rule is used, because it matches the host.
23919
23920 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23921 first rule to determine retry times, but for all the other hosts for the domain
23922 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23923 routing to &'a.b.c.example'& suffers a temporary failure.
23924
23925 &*Note*&: The host name is used when matching the patterns, not its IP address.
23926 However, if a message is routed directly to an IP address without the use of a
23927 host name, for example, if a &(manualroute)& router contains a setting such as:
23928 .code
23929 route_list = *.a.example  192.168.34.23
23930 .endd
23931 then the &"host name"& that is used when searching for a retry rule is the
23932 textual form of the IP address.
23933
23934 .section "Retry rules for specific errors" "SECID161"
23935 .cindex "retry" "specific errors; specifying"
23936 The second field in a retry rule is the name of a particular error, or an
23937 asterisk, which matches any error. The errors that can be tested for are:
23938
23939 .vlist
23940 .vitem &%auth_failed%&
23941 Authentication failed when trying to send to a host in the
23942 &%hosts_require_auth%& list in an &(smtp)& transport.
23943
23944 .vitem &%data_4xx%&
23945 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23946 after the command, or after sending the message's data.
23947
23948 .vitem &%mail_4xx%&
23949 A 4&'xx'& error was received for an outgoing MAIL command.
23950
23951 .vitem &%rcpt_4xx%&
23952 A 4&'xx'& error was received for an outgoing RCPT command.
23953 .endlist
23954
23955 For the three 4&'xx'& errors, either the first or both of the x's can be given
23956 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23957 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23958 and have retries every ten minutes with a one-hour timeout, you could set up a
23959 retry rule of this form:
23960 .code
23961 the.domain.name  rcpt_452   F,1h,10m
23962 .endd
23963 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23964 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23965
23966 .vlist
23967 .vitem &%lost_connection%&
23968 A server unexpectedly closed the SMTP connection. There may, of course,
23969 legitimate reasons for this (host died, network died), but if it repeats a lot
23970 for the same host, it indicates something odd.
23971
23972 .vitem &%refused_MX%&
23973 A connection to a host obtained from an MX record was refused.
23974
23975 .vitem &%refused_A%&
23976 A connection to a host not obtained from an MX record was refused.
23977
23978 .vitem &%refused%&
23979 A connection was refused.
23980
23981 .vitem &%timeout_connect_MX%&
23982 A connection attempt to a host obtained from an MX record timed out.
23983
23984 .vitem &%timeout_connect_A%&
23985 A connection attempt to a host not obtained from an MX record timed out.
23986
23987 .vitem &%timeout_connect%&
23988 A connection attempt timed out.
23989
23990 .vitem &%timeout_MX%&
23991 There was a timeout while connecting or during an SMTP session with a host
23992 obtained from an MX record.
23993
23994 .vitem &%timeout_A%&
23995 There was a timeout while connecting or during an SMTP session with a host not
23996 obtained from an MX record.
23997
23998 .vitem &%timeout%&
23999 There was a timeout while connecting or during an SMTP session.
24000
24001 .vitem &%tls_required%&
24002 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24003 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24004 to STARTTLS, or there was a problem setting up the TLS connection.
24005
24006 .vitem &%quota%&
24007 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24008 transport.
24009
24010 .vitem &%quota_%&<&'time'&>
24011 .cindex "quota" "error testing in retry rule"
24012 .cindex "retry" "quota error testing"
24013 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24014 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24015 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24016 for four days.
24017 .endlist
24018
24019 .cindex "mailbox" "time of last read"
24020 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24021 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24022 it should be based on the last time that the user accessed the mailbox.
24023 However, it is not always possible to determine this. Exim uses the following
24024 heuristic rules:
24025
24026 .ilist
24027 If the mailbox is a single file, the time of last access (the &"atime"&) is
24028 used. As no new messages are being delivered (because the mailbox is over
24029 quota), Exim does not access the file, so this is the time of last user access.
24030 .next
24031 .cindex "maildir format" "time of last read"
24032 For a maildir delivery, the time of last modification of the &_new_&
24033 subdirectory is used. As the mailbox is over quota, no new files are created in
24034 the &_new_& subdirectory, because no new messages are being delivered. Any
24035 change to the &_new_& subdirectory is therefore assumed to be the result of an
24036 MUA moving a new message to the &_cur_& directory when it is first read. The
24037 time that is used is therefore the last time that the user read a new message.
24038 .next
24039 For other kinds of multi-file mailbox, the time of last access cannot be
24040 obtained, so a retry rule that uses this type of error field is never matched.
24041 .endlist
24042
24043 The quota errors apply both to system-enforced quotas and to Exim's own quota
24044 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24045 when a local delivery is deferred because a partition is full (the ENOSPC
24046 error).
24047
24048
24049
24050 .section "Retry rules for specified senders" "SECID162"
24051 .cindex "retry" "rules; sender-specific"
24052 You can specify retry rules that apply only when the failing message has a
24053 specific sender. In particular, this can be used to define retry rules that
24054 apply only to bounce messages. The third item in a retry rule can be of this
24055 form:
24056 .display
24057 &`senders=`&<&'address list'&>
24058 .endd
24059 The retry timings themselves are then the fourth item. For example:
24060 .code
24061 *   rcpt_4xx   senders=:   F,1h,30m
24062 .endd
24063 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24064 host. If the address list contains white space, it must be enclosed in quotes.
24065 For example:
24066 .code
24067 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24068 .endd
24069 &*Warning*&: This facility can be unhelpful if it is used for host errors
24070 (which do not depend on the recipient). The reason is that the sender is used
24071 only to match the retry rule. Once the rule has been found for a host error,
24072 its contents are used to set a retry time for the host, and this will apply to
24073 all messages, not just those with specific senders.
24074
24075 When testing retry rules using &%-brt%&, you can supply a sender using the
24076 &%-f%& command line option, like this:
24077 .code
24078 exim -f "" -brt user@dom.ain
24079 .endd
24080 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24081 list is never matched.
24082
24083
24084
24085
24086
24087 .section "Retry parameters" "SECID163"
24088 .cindex "retry" "parameters in rules"
24089 The third (or fourth, if a senders list is present) field in a retry rule is a
24090 sequence of retry parameter sets, separated by semicolons. Each set consists of
24091 .display
24092 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24093 .endd
24094 The letter identifies the algorithm for computing a new retry time; the cutoff
24095 time is the time beyond which this algorithm no longer applies, and the
24096 arguments vary the algorithm's action. The cutoff time is measured from the
24097 time that the first failure for the domain (combined with the local part if
24098 relevant) was detected, not from the time the message was received.
24099
24100 .cindex "retry" "algorithms"
24101 .cindex "retry" "fixed intervals"
24102 .cindex "retry" "increasing intervals"
24103 .cindex "retry" "random intervals"
24104 The available algorithms are:
24105
24106 .ilist
24107 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24108 the interval.
24109 .next
24110 &'G'&: retry at geometrically increasing intervals. The first argument
24111 specifies a starting value for the interval, and the second a multiplier, which
24112 is used to increase the size of the interval at each retry.
24113 .next
24114 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24115 retry, the previous interval is multiplied by the factor in order to get a
24116 maximum for the next interval. The minimum interval is the first argument of
24117 the parameter, and an actual interval is chosen randomly between them. Such a
24118 rule has been found to be helpful in cluster configurations when all the
24119 members of the cluster restart at once, and may therefore synchronize their
24120 queue processing times.
24121 .endlist
24122
24123 When computing the next retry time, the algorithm definitions are scanned in
24124 order until one whose cutoff time has not yet passed is reached. This is then
24125 used to compute a new retry time that is later than the current time. In the
24126 case of fixed interval retries, this simply means adding the interval to the
24127 current time. For geometrically increasing intervals, retry intervals are
24128 computed from the rule's parameters until one that is greater than the previous
24129 interval is found. The main configuration variable
24130 .cindex "limit" "retry interval"
24131 .cindex "retry" "interval, maximum"
24132 .oindex "&%retry_interval_max%&"
24133 &%retry_interval_max%& limits the maximum interval between retries. It
24134 cannot be set greater than &`24h`&, which is its default value.
24135
24136 A single remote domain may have a number of hosts associated with it, and each
24137 host may have more than one IP address. Retry algorithms are selected on the
24138 basis of the domain name, but are applied to each IP address independently. If,
24139 for example, a host has two IP addresses and one is unusable, Exim will
24140 generate retry times for it and will not try to use it until its next retry
24141 time comes. Thus the good IP address is likely to be tried first most of the
24142 time.
24143
24144 .cindex "hints database" "use for retrying"
24145 Retry times are hints rather than promises. Exim does not make any attempt to
24146 run deliveries exactly at the computed times. Instead, a queue runner process
24147 starts delivery processes for delayed messages periodically, and these attempt
24148 new deliveries only for those addresses that have passed their next retry time.
24149 If a new message arrives for a deferred address, an immediate delivery attempt
24150 occurs only if the address has passed its retry time. In the absence of new
24151 messages, the minimum time between retries is the interval between queue runner
24152 processes. There is not much point in setting retry times of five minutes if
24153 your queue runners happen only once an hour, unless there are a significant
24154 number of incoming messages (which might be the case on a system that is
24155 sending everything to a smart host, for example).
24156
24157 The data in the retry hints database can be inspected by using the
24158 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24159 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24160 &'exinext'& utility script can be used to find out what the next retry times
24161 are for the hosts associated with a particular mail domain, and also for local
24162 deliveries that have been deferred.
24163
24164
24165 .section "Retry rule examples" "SECID164"
24166 Here are some example retry rules:
24167 .code
24168 alice@wonderland.fict.example quota_5d  F,7d,3h
24169 wonderland.fict.example       quota_5d
24170 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24171 lookingglass.fict.example     *         F,24h,30m;
24172 *                 refused_A   F,2h,20m;
24173 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24174 .endd
24175 The first rule sets up special handling for mail to
24176 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24177 mailbox has not been read for at least 5 days. Retries continue every three
24178 hours for 7 days. The second rule handles over-quota errors for all other local
24179 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24180 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24181 fail are bounced immediately if the mailbox has not been read for at least 5
24182 days.
24183
24184 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24185 happen every 15 minutes for an hour, then with geometrically increasing
24186 intervals until two days have passed since a delivery first failed. After the
24187 first hour there is a delay of one hour, then two hours, then four hours, and
24188 so on (this is a rather extreme example).
24189
24190 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24191 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24192 all other domains, with special action for connection refusal from hosts that
24193 were not obtained from an MX record.
24194
24195 The final rule in a retry configuration should always have asterisks in the
24196 first two fields so as to provide a general catch-all for any addresses that do
24197 not have their own special handling. This example tries every 15 minutes for 2
24198 hours, then with intervals starting at one hour and increasing by a factor of
24199 1.5 up to 16 hours, then every 8 hours up to 5 days.
24200
24201
24202
24203 .section "Timeout of retry data" "SECID165"
24204 .cindex "timeout" "of retry data"
24205 .oindex "&%retry_data_expire%&"
24206 .cindex "hints database" "data expiry"
24207 .cindex "retry" "timeout of data"
24208 Exim timestamps the data that it writes to its retry hints database. When it
24209 consults the data during a delivery it ignores any that is older than the value
24210 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24211 been tried for 7 days, Exim will try to deliver to it immediately a message
24212 arrives, and if that fails, it will calculate a retry time as if it were
24213 failing for the first time.
24214
24215 This improves the behaviour for messages routed to rarely-used hosts such as MX
24216 backups. If such a host was down at one time, and happens to be down again when
24217 Exim tries a month later, using the old retry data would imply that it had been
24218 down all the time, which is not a justified assumption.
24219
24220 If a host really is permanently dead, this behaviour causes a burst of retries
24221 every now and again, but only if messages routed to it are rare. If there is a
24222 message at least once every 7 days the retry data never expires.
24223
24224
24225
24226
24227 .section "Long-term failures" "SECID166"
24228 .cindex "delivery failure, long-term"
24229 .cindex "retry" "after long-term failure"
24230 Special processing happens when an email address has been failing for so long
24231 that the cutoff time for the last algorithm is reached. For example, using the
24232 default retry rule:
24233 .code
24234 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24235 .endd
24236 the cutoff time is four days. Reaching the retry cutoff is independent of how
24237 long any specific message has been failing; it is the length of continuous
24238 failure for the recipient address that counts.
24239
24240 When the cutoff time is reached for a local delivery, or for all the IP
24241 addresses associated with a remote delivery, a subsequent delivery failure
24242 causes Exim to give up on the address, and a bounce message is generated.
24243 In order to cater for new messages that use the failing address, a next retry
24244 time is still computed from the final algorithm, and is used as follows:
24245
24246 For local deliveries, one delivery attempt is always made for any subsequent
24247 messages. If this delivery fails, the address fails immediately. The
24248 post-cutoff retry time is not used.
24249
24250 If the delivery is remote, there are two possibilities, controlled by the
24251 .oindex "&%delay_after_cutoff%&"
24252 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24253 default. Until the post-cutoff retry time for one of the IP addresses is
24254 reached, the failing email address is bounced immediately, without a delivery
24255 attempt taking place. After that time, one new delivery attempt is made to
24256 those IP addresses that are past their retry times, and if that still fails,
24257 the address is bounced and new retry times are computed.
24258
24259 In other words, when all the hosts for a given email address have been failing
24260 for a long time, Exim bounces rather then defers until one of the hosts' retry
24261 times is reached. Then it tries once, and bounces if that attempt fails. This
24262 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24263 to a broken destination, but if the host does recover, Exim will eventually
24264 notice.
24265
24266 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24267 addresses are past their final cutoff time, Exim tries to deliver to those IP
24268 addresses that have not been tried since the message arrived. If there are
24269 no suitable IP addresses, or if they all fail, the address is bounced. In other
24270 words, it does not delay when a new message arrives, but tries the expired
24271 addresses immediately, unless they have been tried since the message arrived.
24272 If there is a continuous stream of messages for the failing domains, setting
24273 &%delay_after_cutoff%& false means that there will be many more attempts to
24274 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24275 true.
24276
24277 .section "Deliveries that work intermittently" "SECID167"
24278 .cindex "retry" "intermittently working deliveries"
24279 Some additional logic is needed to cope with cases where a host is
24280 intermittently available, or when a message has some attribute that prevents
24281 its delivery when others to the same address get through. In this situation,
24282 because some messages are successfully delivered, the &"retry clock"& for the
24283 host or address keeps getting reset by the successful deliveries, and so
24284 failing messages remain on the queue for ever because the cutoff time is never
24285 reached.
24286
24287 Two exceptional actions are applied to prevent this happening. The first
24288 applies to errors that are related to a message rather than a remote host.
24289 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24290 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24291 commands, and quota failures. For this type of error, if a message's arrival
24292 time is earlier than the &"first failed"& time for the error, the earlier time
24293 is used when scanning the retry rules to decide when to try next and when to
24294 time out the address.
24295
24296 The exceptional second action applies in all cases. If a message has been on
24297 the queue for longer than the cutoff time of any applicable retry rule for a
24298 given address, a delivery is attempted for that address, even if it is not yet
24299 time, and if this delivery fails, the address is timed out. A new retry time is
24300 not computed in this case, so that other messages for the same address are
24301 considered immediately.
24302 .ecindex IIDretconf1
24303 .ecindex IIDregconf2
24304
24305
24306
24307
24308
24309
24310 . ////////////////////////////////////////////////////////////////////////////
24311 . ////////////////////////////////////////////////////////////////////////////
24312
24313 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24314 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24315 .scindex IIDauthconf2 "authentication"
24316 The &"authenticators"& section of Exim's run time configuration is concerned
24317 with SMTP authentication. This facility is an extension to the SMTP protocol,
24318 described in RFC 2554, which allows a client SMTP host to authenticate itself
24319 to a server. This is a common way for a server to recognize clients that are
24320 permitted to use it as a relay. SMTP authentication is not of relevance to the
24321 transfer of mail between servers that have no managerial connection with each
24322 other.
24323
24324 .cindex "AUTH" "description of"
24325 Very briefly, the way SMTP authentication works is as follows:
24326
24327 .ilist
24328 The server advertises a number of authentication &'mechanisms'& in response to
24329 the client's EHLO command.
24330 .next
24331 The client issues an AUTH command, naming a specific mechanism. The command
24332 may, optionally, contain some authentication data.
24333 .next
24334 The server may issue one or more &'challenges'&, to which the client must send
24335 appropriate responses. In simple authentication mechanisms, the challenges are
24336 just prompts for user names and passwords. The server does not have to issue
24337 any challenges &-- in some mechanisms the relevant data may all be transmitted
24338 with the AUTH command.
24339 .next
24340 The server either accepts or denies authentication.
24341 .next
24342 If authentication succeeds, the client may optionally make use of the AUTH
24343 option on the MAIL command to pass an authenticated sender in subsequent
24344 mail transactions. Authentication lasts for the remainder of the SMTP
24345 connection.
24346 .next
24347 If authentication fails, the client may give up, or it may try a different
24348 authentication mechanism, or it may try transferring mail over the
24349 unauthenticated connection.
24350 .endlist
24351
24352 If you are setting up a client, and want to know which authentication
24353 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24354 SMTP port) on the server, and issue an EHLO command. The response to this
24355 includes the list of supported mechanisms. For example:
24356 .display
24357 &`$ `&&*&`telnet server.example 25`&*&
24358 &`Trying 192.168.34.25...`&
24359 &`Connected to server.example.`&
24360 &`Escape character is &#x0027;^]&#x0027;.`&
24361 &`220 server.example ESMTP Exim 4.20 ...`&
24362 &*&`ehlo client.example`&*&
24363 &`250-server.example Hello client.example [10.8.4.5]`&
24364 &`250-SIZE 52428800`&
24365 &`250-PIPELINING`&
24366 &`250-AUTH PLAIN`&
24367 &`250 HELP`&
24368 .endd
24369 The second-last line of this example output shows that the server supports
24370 authentication using the PLAIN mechanism. In Exim, the different authentication
24371 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24372 routers and transports, which authenticators are included in the binary is
24373 controlled by build-time definitions. The following are currently available,
24374 included by setting
24375 .code
24376 AUTH_CRAM_MD5=yes
24377 AUTH_CYRUS_SASL=yes
24378 AUTH_DOVECOT=yes
24379 AUTH_GSASL=yes
24380 AUTH_HEIMDAL_GSSAPI=yes
24381 AUTH_PLAINTEXT=yes
24382 AUTH_SPA=yes
24383 .endd
24384 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24385 authentication mechanism (RFC 2195), and the second provides an interface to
24386 the Cyrus SASL authentication library.
24387 The third is an interface to Dovecot's authentication system, delegating the
24388 work via a socket interface.
24389 The fourth provides an interface to the GNU SASL authentication library, which
24390 provides mechanisms but typically not data sources.
24391 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24392 supporting setting a server keytab.
24393 The sixth can be configured to support
24394 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24395 not formally documented, but used by several MUAs. The seventh authenticator
24396 supports Microsoft's &'Secure Password Authentication'& mechanism.
24397
24398 The authenticators are configured using the same syntax as other drivers (see
24399 section &<<SECTfordricon>>&). If no authenticators are required, no
24400 authentication section need be present in the configuration file. Each
24401 authenticator can in principle have both server and client functions. When Exim
24402 is receiving SMTP mail, it is acting as a server; when it is sending out
24403 messages over SMTP, it is acting as a client. Authenticator configuration
24404 options are provided for use in both these circumstances.
24405
24406 To make it clear which options apply to which situation, the prefixes
24407 &%server_%& and &%client_%& are used on option names that are specific to
24408 either the server or the client function, respectively. Server and client
24409 functions are disabled if none of their options are set. If an authenticator is
24410 to be used for both server and client functions, a single definition, using
24411 both sets of options, is required. For example:
24412 .code
24413 cram:
24414   driver = cram_md5
24415   public_name = CRAM-MD5
24416   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24417   client_name = ph10
24418   client_secret = secret2
24419 .endd
24420 The &%server_%& option is used when Exim is acting as a server, and the
24421 &%client_%& options when it is acting as a client.
24422
24423 Descriptions of the individual authenticators are given in subsequent chapters.
24424 The remainder of this chapter covers the generic options for the
24425 authenticators, followed by general discussion of the way authentication works
24426 in Exim.
24427
24428 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24429 per-mechanism basis.  Please read carefully to determine which variables hold
24430 account labels such as usercodes and which hold passwords or other
24431 authenticating data.
24432
24433 Note that some mechanisms support two different identifiers for accounts: the
24434 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24435 and &'authz'& are commonly encountered.  The American spelling is standard here.
24436 Conceptually, authentication data such as passwords are tied to the identifier
24437 used to authenticate; servers may have rules to permit one user to act as a
24438 second user, so that after login the session is treated as though that second
24439 user had logged in.  That second user is the &'authorization id'&.  A robust
24440 configuration might confirm that the &'authz'& field is empty or matches the
24441 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24442 as verified data, the &'authz'& as an unverified request which the server might
24443 choose to honour.
24444
24445 A &'realm'& is a text string, typically a domain name, presented by a server
24446 to a client to help it select an account and credentials to use.  In some
24447 mechanisms, the client and server provably agree on the realm, but clients
24448 typically can not treat the realm as secure data to be blindly trusted.
24449
24450
24451
24452 .section "Generic options for authenticators" "SECID168"
24453 .cindex "authentication" "generic options"
24454 .cindex "options" "generic; for authenticators"
24455
24456 .option client_condition authenticators string&!! unset
24457 When Exim is authenticating as a client, it skips any authenticator whose
24458 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24459 used, for example, to skip plain text authenticators when the connection is not
24460 encrypted by a setting such as:
24461 .code
24462 client_condition = ${if !eq{$tls_out_cipher}{}}
24463 .endd
24464
24465
24466 .option client_set_id authenticators string&!! unset
24467 When client authentication succeeds, this condition is expanded; the
24468 result is used in the log lines for outbound messasges.
24469 Typically it will be the user name used for authentication.
24470
24471
24472 .option driver authenticators string unset
24473 This option must always be set. It specifies which of the available
24474 authenticators is to be used.
24475
24476
24477 .option public_name authenticators string unset
24478 This option specifies the name of the authentication mechanism that the driver
24479 implements, and by which it is known to the outside world. These names should
24480 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24481 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24482 defaults to the driver's instance name.
24483
24484
24485 .option server_advertise_condition authenticators string&!! unset
24486 When a server is about to advertise an authentication mechanism, the condition
24487 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24488 mechanism is not advertised.
24489 If the expansion fails, the mechanism is not advertised. If the failure was not
24490 forced, and was not caused by a lookup defer, the incident is logged.
24491 See section &<<SECTauthexiser>>& below for further discussion.
24492
24493
24494 .option server_condition authenticators string&!! unset
24495 This option must be set for a &%plaintext%& server authenticator, where it
24496 is used directly to control authentication. See section &<<SECTplainserver>>&
24497 for details.
24498
24499 For the &(gsasl)& authenticator, this option is required for various
24500 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24501
24502 For the other authenticators, &%server_condition%& can be used as an additional
24503 authentication or authorization mechanism that is applied after the other
24504 authenticator conditions succeed. If it is set, it is expanded when the
24505 authenticator would otherwise return a success code. If the expansion is forced
24506 to fail, authentication fails. Any other expansion failure causes a temporary
24507 error code to be returned. If the result of a successful expansion is an empty
24508 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24509 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24510 other result, a temporary error code is returned, with the expanded string as
24511 the error text.
24512
24513
24514 .option server_debug_print authenticators string&!! unset
24515 If this option is set and authentication debugging is enabled (see the &%-d%&
24516 command line option), the string is expanded and included in the debugging
24517 output when the authenticator is run as a server. This can help with checking
24518 out the values of variables.
24519 If expansion of the string fails, the error message is written to the debugging
24520 output, and Exim carries on processing.
24521
24522
24523 .option server_set_id authenticators string&!! unset
24524 .vindex "&$authenticated_id$&"
24525 When an Exim server successfully authenticates a client, this string is
24526 expanded using data from the authentication, and preserved for any incoming
24527 messages in the variable &$authenticated_id$&. It is also included in the log
24528 lines for incoming messages. For example, a user/password authenticator
24529 configuration might preserve the user name that was used to authenticate, and
24530 refer to it subsequently during delivery of the message.
24531 If expansion fails, the option is ignored.
24532
24533
24534 .option server_mail_auth_condition authenticators string&!! unset
24535 This option allows a server to discard authenticated sender addresses supplied
24536 as part of MAIL commands in SMTP connections that are authenticated by the
24537 driver on which &%server_mail_auth_condition%& is set. The option is not used
24538 as part of the authentication process; instead its (unexpanded) value is
24539 remembered for later use.
24540 How it is used is described in the following section.
24541
24542
24543
24544
24545
24546 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24547 .cindex "authentication" "sender; authenticated"
24548 .cindex "AUTH" "on MAIL command"
24549 When a client supplied an AUTH= item on a MAIL command, Exim applies
24550 the following checks before accepting it as the authenticated sender of the
24551 message:
24552
24553 .ilist
24554 If the connection is not using extended SMTP (that is, HELO was used rather
24555 than EHLO), the use of AUTH= is a syntax error.
24556 .next
24557 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24558 .next
24559 .vindex "&$authenticated_sender$&"
24560 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24561 running, the value of &$authenticated_sender$& is set to the value obtained
24562 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24563 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24564 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24565 given for the MAIL command.
24566 .next
24567 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24568 is accepted and placed in &$authenticated_sender$& only if the client has
24569 authenticated.
24570 .next
24571 If the AUTH= value was accepted by either of the two previous rules, and
24572 the client has authenticated, and the authenticator has a setting for the
24573 &%server_mail_auth_condition%&, the condition is checked at this point. The
24574 valued that was saved from the authenticator is expanded. If the expansion
24575 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24576 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24577 the value of &$authenticated_sender$& is retained and passed on with the
24578 message.
24579 .endlist
24580
24581
24582 When &$authenticated_sender$& is set for a message, it is passed on to other
24583 hosts to which Exim authenticates as a client. Do not confuse this value with
24584 &$authenticated_id$&, which is a string obtained from the authentication
24585 process, and which is not usually a complete email address.
24586
24587 .vindex "&$sender_address$&"
24588 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24589 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24590 therefore make use of &$authenticated_sender$&. The converse is not true: the
24591 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24592 ACL is run.
24593
24594
24595
24596 .section "Authentication on an Exim server" "SECTauthexiser"
24597 .cindex "authentication" "on an Exim server"
24598 When Exim receives an EHLO command, it advertises the public names of those
24599 authenticators that are configured as servers, subject to the following
24600 conditions:
24601
24602 .ilist
24603 The client host must match &%auth_advertise_hosts%& (default *).
24604 .next
24605 It the &%server_advertise_condition%& option is set, its expansion must not
24606 yield the empty string, &"0"&, &"no"&, or &"false"&.
24607 .endlist
24608
24609 The order in which the authenticators are defined controls the order in which
24610 the mechanisms are advertised.
24611
24612 Some mail clients (for example, some versions of Netscape) require the user to
24613 provide a name and password for authentication whenever AUTH is advertised,
24614 even though authentication may not in fact be needed (for example, Exim may be
24615 set up to allow unconditional relaying from the client by an IP address check).
24616 You can make such clients more friendly by not advertising AUTH to them.
24617 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24618 that runs for RCPT) to relay without authentication, you should set
24619 .code
24620 auth_advertise_hosts = ! 10.9.8.0/24
24621 .endd
24622 so that no authentication mechanisms are advertised to them.
24623
24624 The &%server_advertise_condition%& controls the advertisement of individual
24625 authentication mechanisms. For example, it can be used to restrict the
24626 advertisement of a particular mechanism to encrypted connections, by a setting
24627 such as:
24628 .code
24629 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24630 .endd
24631 .vindex "&$tls_in_cipher$&"
24632 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24633 yields &"yes"&, which allows the advertisement to happen.
24634
24635 When an Exim server receives an AUTH command from a client, it rejects it
24636 immediately if AUTH was not advertised in response to an earlier EHLO
24637 command. This is the case if
24638
24639 .ilist
24640 The client host does not match &%auth_advertise_hosts%&; or
24641 .next
24642 No authenticators are configured with server options; or
24643 .next
24644 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24645 server authenticators.
24646 .endlist
24647
24648
24649 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24650 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24651 AUTH is accepted from any client host.
24652
24653 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24654 server authentication mechanism that was advertised in response to EHLO and
24655 that matches the one named in the AUTH command. If it finds one, it runs
24656 the appropriate authentication protocol, and authentication either succeeds or
24657 fails. If there is no matching advertised mechanism, the AUTH command is
24658 rejected with a 504 error.
24659
24660 .vindex "&$received_protocol$&"
24661 .vindex "&$sender_host_authenticated$&"
24662 When a message is received from an authenticated host, the value of
24663 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24664 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24665 public name) of the authenticator driver that successfully authenticated the
24666 client from which the message was received. This variable is empty if there was
24667 no successful authentication.
24668
24669
24670
24671
24672 .section "Testing server authentication" "SECID169"
24673 .cindex "authentication" "testing a server"
24674 .cindex "AUTH" "testing a server"
24675 .cindex "base64 encoding" "creating authentication test data"
24676 Exim's &%-bh%& option can be useful for testing server authentication
24677 configurations. The data for the AUTH command has to be sent using base64
24678 encoding. A quick way to produce such data for testing is the following Perl
24679 script:
24680 .code
24681 use MIME::Base64;
24682 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24683 .endd
24684 .cindex "binary zero" "in authentication data"
24685 This interprets its argument as a Perl string, and then encodes it. The
24686 interpretation as a Perl string allows binary zeros, which are required for
24687 some kinds of authentication, to be included in the data. For example, a
24688 command line to run this script on such data might be
24689 .code
24690 encode '\0user\0password'
24691 .endd
24692 Note the use of single quotes to prevent the shell interpreting the
24693 backslashes, so that they can be interpreted by Perl to specify characters
24694 whose code value is zero.
24695
24696 &*Warning 1*&: If either of the user or password strings starts with an octal
24697 digit, you must use three zeros instead of one after the leading backslash. If
24698 you do not, the octal digit that starts your string will be incorrectly
24699 interpreted as part of the code for the first character.
24700
24701 &*Warning 2*&: If there are characters in the strings that Perl interprets
24702 specially, you must use a Perl escape to prevent them being misinterpreted. For
24703 example, a command such as
24704 .code
24705 encode '\0user@domain.com\0pas$$word'
24706 .endd
24707 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24708
24709 If you have the &%mimencode%& command installed, another way to do produce
24710 base64-encoded strings is to run the command
24711 .code
24712 echo -e -n `\0user\0password' | mimencode
24713 .endd
24714 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24715 in the argument, and the &%-n%& option specifies no newline at the end of its
24716 output. However, not all versions of &%echo%& recognize these options, so you
24717 should check your version before relying on this suggestion.
24718
24719
24720
24721 .section "Authentication by an Exim client" "SECID170"
24722 .cindex "authentication" "on an Exim client"
24723 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24724 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24725 announces support for authentication, and the host matches an entry in either
24726 of these options, Exim (as a client) tries to authenticate as follows:
24727
24728 .ilist
24729 For each authenticator that is configured as a client, in the order in which
24730 they are defined in the configuration, it searches the authentication
24731 mechanisms announced by the server for one whose name matches the public name
24732 of the authenticator.
24733 .next
24734 .vindex "&$host$&"
24735 .vindex "&$host_address$&"
24736 When it finds one that matches, it runs the authenticator's client code. The
24737 variables &$host$& and &$host_address$& are available for any string expansions
24738 that the client might do. They are set to the server's name and IP address. If
24739 any expansion is forced to fail, the authentication attempt is abandoned, and
24740 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24741 delivery to be deferred.
24742 .next
24743 If the result of the authentication attempt is a temporary error or a timeout,
24744 Exim abandons trying to send the message to the host for the moment. It will
24745 try again later. If there are any backup hosts available, they are tried in the
24746 usual way.
24747 .next
24748 If the response to authentication is a permanent error (5&'xx'& code), Exim
24749 carries on searching the list of authenticators and tries another one if
24750 possible. If all authentication attempts give permanent errors, or if there are
24751 no attempts because no mechanisms match (or option expansions force failure),
24752 what happens depends on whether the host matches &%hosts_require_auth%& or
24753 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24754 delivery is deferred. The error can be detected in the retry rules, and thereby
24755 turned into a permanent error if you wish. In the second case, Exim tries to
24756 deliver the message unauthenticated.
24757 .endlist
24758
24759 .cindex "AUTH" "on MAIL command"
24760 When Exim has authenticated itself to a remote server, it adds the AUTH
24761 parameter to the MAIL commands it sends, if it has an authenticated sender for
24762 the message. If the message came from a remote host, the authenticated sender
24763 is the one that was receiving on an incoming MAIL command, provided that the
24764 incoming connection was authenticated and the &%server_mail_auth%& condition
24765 allowed the authenticated sender to be retained. If a local process calls Exim
24766 to send a message, the sender address that is built from the login name and
24767 &%qualify_domain%& is treated as authenticated. However, if the
24768 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24769 the authenticated sender that was received with the message.
24770 .ecindex IIDauthconf1
24771 .ecindex IIDauthconf2
24772
24773
24774
24775
24776
24777
24778 . ////////////////////////////////////////////////////////////////////////////
24779 . ////////////////////////////////////////////////////////////////////////////
24780
24781 .chapter "The plaintext authenticator" "CHAPplaintext"
24782 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24783 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24784 The &(plaintext)& authenticator can be configured to support the PLAIN and
24785 LOGIN authentication mechanisms, both of which transfer authentication data as
24786 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24787 security risk; you are strongly advised to insist on the use of SMTP encryption
24788 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24789 use unencrypted plain text, you should not use the same passwords for SMTP
24790 connections as you do for login accounts.
24791
24792 .section "Plaintext options" "SECID171"
24793 .cindex "options" "&(plaintext)& authenticator (server)"
24794 When configured as a server, &(plaintext)& uses the following options:
24795
24796 .option server_condition authenticators string&!! unset
24797 This is actually a global authentication option, but it must be set in order to
24798 configure the &(plaintext)& driver as a server. Its use is described below.
24799
24800 .option server_prompts plaintext string&!! unset
24801 The contents of this option, after expansion, must be a colon-separated list of
24802 prompt strings. If expansion fails, a temporary authentication rejection is
24803 given.
24804
24805 .section "Using plaintext in a server" "SECTplainserver"
24806 .cindex "AUTH" "in &(plaintext)& authenticator"
24807 .cindex "binary zero" "in &(plaintext)& authenticator"
24808 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24809         "in &(plaintext)& authenticator"
24810 .vindex "&$auth1$&, &$auth2$&, etc"
24811 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24812
24813 When running as a server, &(plaintext)& performs the authentication test by
24814 expanding a string. The data sent by the client with the AUTH command, or in
24815 response to subsequent prompts, is base64 encoded, and so may contain any byte
24816 values when decoded. If any data is supplied with the command, it is treated as
24817 a list of strings, separated by NULs (binary zeros), the first three of which
24818 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24819 (neither LOGIN nor PLAIN uses more than three strings).
24820
24821 For compatibility with previous releases of Exim, the values are also placed in
24822 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24823 variables for this purpose is now deprecated, as it can lead to confusion in
24824 string expansions that also use them for other things.
24825
24826 If there are more strings in &%server_prompts%& than the number of strings
24827 supplied with the AUTH command, the remaining prompts are used to obtain more
24828 data. Each response from the client may be a list of NUL-separated strings.
24829
24830 .vindex "&$authenticated_id$&"
24831 Once a sufficient number of data strings have been received,
24832 &%server_condition%& is expanded. If the expansion is forced to fail,
24833 authentication fails. Any other expansion failure causes a temporary error code
24834 to be returned. If the result of a successful expansion is an empty string,
24835 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24836 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24837 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24838 For any other result, a temporary error code is returned, with the expanded
24839 string as the error text
24840
24841 &*Warning*&: If you use a lookup in the expansion to find the user's
24842 password, be sure to make the authentication fail if the user is unknown.
24843 There are good and bad examples at the end of the next section.
24844
24845
24846
24847 .section "The PLAIN authentication mechanism" "SECID172"
24848 .cindex "PLAIN authentication mechanism"
24849 .cindex "authentication" "PLAIN mechanism"
24850 .cindex "binary zero" "in &(plaintext)& authenticator"
24851 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24852 sent as one item of data (that is, one combined string containing two NUL
24853 separators). The data is sent either as part of the AUTH command, or
24854 subsequently in response to an empty prompt from the server.
24855
24856 The second and third strings are a user name and a corresponding password.
24857 Using a single fixed user name and password as an example, this could be
24858 configured as follows:
24859 .code
24860 fixed_plain:
24861   driver = plaintext
24862   public_name = PLAIN
24863   server_prompts = :
24864   server_condition = \
24865     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24866   server_set_id = $auth2
24867 .endd
24868 Note that the default result strings from &%if%& (&"true"& or an empty string)
24869 are exactly what we want here, so they need not be specified. Obviously, if the
24870 password contains expansion-significant characters such as dollar, backslash,
24871 or closing brace, they have to be escaped.
24872
24873 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24874 the end of a string list are ignored). If all the data comes as part of the
24875 AUTH command, as is commonly the case, the prompt is not used. This
24876 authenticator is advertised in the response to EHLO as
24877 .code
24878 250-AUTH PLAIN
24879 .endd
24880 and a client host can authenticate itself by sending the command
24881 .code
24882 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24883 .endd
24884 As this contains three strings (more than the number of prompts), no further
24885 data is required from the client. Alternatively, the client may just send
24886 .code
24887 AUTH PLAIN
24888 .endd
24889 to initiate authentication, in which case the server replies with an empty
24890 prompt. The client must respond with the combined data string.
24891
24892 The data string is base64 encoded, as required by the RFC. This example,
24893 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24894 represents a zero byte. This is split up into three strings, the first of which
24895 is empty. The &%server_condition%& option in the authenticator checks that the
24896 second two are &`username`& and &`mysecret`& respectively.
24897
24898 Having just one fixed user name and password, as in this example, is not very
24899 realistic, though for a small organization with only a handful of
24900 authenticating clients it could make sense.
24901
24902 A more sophisticated instance of this authenticator could use the user name in
24903 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24904 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24905 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24906 This is an incorrect example:
24907 .code
24908 server_condition = \
24909   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24910 .endd
24911 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24912 which it then compares to the supplied password (&$auth3$&). Why is this example
24913 incorrect? It works fine for existing users, but consider what happens if a
24914 non-existent user name is given. The lookup fails, but as no success/failure
24915 strings are given for the lookup, it yields an empty string. Thus, to defeat
24916 the authentication, all a client has to do is to supply a non-existent user
24917 name and an empty password. The correct way of writing this test is:
24918 .code
24919 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24920   {${if eq{$value}{$auth3}}} {false}}
24921 .endd
24922 In this case, if the lookup succeeds, the result is checked; if the lookup
24923 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24924 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24925 always fails if its second argument is empty. However, the second way of
24926 writing the test makes the logic clearer.
24927
24928
24929 .section "The LOGIN authentication mechanism" "SECID173"
24930 .cindex "LOGIN authentication mechanism"
24931 .cindex "authentication" "LOGIN mechanism"
24932 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24933 in a number of programs. No data is sent with the AUTH command. Instead, a
24934 user name and password are supplied separately, in response to prompts. The
24935 plaintext authenticator can be configured to support this as in this example:
24936 .code
24937 fixed_login:
24938   driver = plaintext
24939   public_name = LOGIN
24940   server_prompts = User Name : Password
24941   server_condition = \
24942     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24943   server_set_id = $auth1
24944 .endd
24945 Because of the way plaintext operates, this authenticator accepts data supplied
24946 with the AUTH command (in contravention of the specification of LOGIN), but
24947 if the client does not supply it (as is the case for LOGIN clients), the prompt
24948 strings are used to obtain two data items.
24949
24950 Some clients are very particular about the precise text of the prompts. For
24951 example, Outlook Express is reported to recognize only &"Username:"& and
24952 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24953 strings. It uses the &%ldapauth%& expansion condition to check the user
24954 name and password by binding to an LDAP server:
24955 .code
24956 login:
24957   driver = plaintext
24958   public_name = LOGIN
24959   server_prompts = Username:: : Password::
24960   server_condition = ${if and{{ \
24961     !eq{}{$auth1} }{ \
24962     ldapauth{\
24963       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24964       pass=${quote:$auth2} \
24965       ldap://ldap.example.org/} }} }
24966   server_set_id = uid=$auth1,ou=people,o=example.org
24967 .endd
24968 We have to check that the username is not empty before using it, because LDAP
24969 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24970 operator to correctly quote the DN for authentication. However, the basic
24971 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24972 correct one to use for the password, because quoting is needed only to make
24973 the password conform to the Exim syntax. At the LDAP level, the password is an
24974 uninterpreted string.
24975
24976
24977 .section "Support for different kinds of authentication" "SECID174"
24978 A number of string expansion features are provided for the purpose of
24979 interfacing to different ways of user authentication. These include checking
24980 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24981 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24982 &<<SECTexpcond>>&.
24983
24984
24985
24986
24987 .section "Using plaintext in a client" "SECID175"
24988 .cindex "options" "&(plaintext)& authenticator (client)"
24989 The &(plaintext)& authenticator has two client options:
24990
24991 .option client_ignore_invalid_base64 plaintext boolean false
24992 If the client receives a server prompt that is not a valid base64 string,
24993 authentication is abandoned by default. However, if this option is set true,
24994 the error in the challenge is ignored and the client sends the response as
24995 usual.
24996
24997 .option client_send plaintext string&!! unset
24998 The string is a colon-separated list of authentication data strings. Each
24999 string is independently expanded before being sent to the server. The first
25000 string is sent with the AUTH command; any more strings are sent in response
25001 to prompts from the server. Before each string is expanded, the value of the
25002 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25003 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25004 way. Thus, the prompt that is received in response to sending the first string
25005 (with the AUTH command) can be used in the expansion of the second string, and
25006 so on. If an invalid base64 string is received when
25007 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25008 &$auth$&<&'n'&> variable.
25009
25010 &*Note*&: You cannot use expansion to create multiple strings, because
25011 splitting takes priority and happens first.
25012
25013 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25014 the data, further processing is applied to each string before it is sent. If
25015 there are any single circumflex characters in the string, they are converted to
25016 NULs. Should an actual circumflex be required as data, it must be doubled in
25017 the string.
25018
25019 This is an example of a client configuration that implements the PLAIN
25020 authentication mechanism with a fixed user name and password:
25021 .code
25022 fixed_plain:
25023   driver = plaintext
25024   public_name = PLAIN
25025   client_send = ^username^mysecret
25026 .endd
25027 The lack of colons means that the entire text is sent with the AUTH
25028 command, with the circumflex characters converted to NULs. A similar example
25029 that uses the LOGIN mechanism is:
25030 .code
25031 fixed_login:
25032   driver = plaintext
25033   public_name = LOGIN
25034   client_send = : username : mysecret
25035 .endd
25036 The initial colon means that the first string is empty, so no data is sent with
25037 the AUTH command itself. The remaining strings are sent in response to
25038 prompts.
25039 .ecindex IIDplaiauth1
25040 .ecindex IIDplaiauth2
25041
25042
25043
25044
25045 . ////////////////////////////////////////////////////////////////////////////
25046 . ////////////////////////////////////////////////////////////////////////////
25047
25048 .chapter "The cram_md5 authenticator" "CHID9"
25049 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25050 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25051 .cindex "CRAM-MD5 authentication mechanism"
25052 .cindex "authentication" "CRAM-MD5 mechanism"
25053 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25054 sends a challenge string to the client, and the response consists of a user
25055 name and the CRAM-MD5 digest of the challenge string combined with a secret
25056 string (password) which is known to both server and client. Thus, the secret
25057 is not sent over the network as plain text, which makes this authenticator more
25058 secure than &(plaintext)&. However, the downside is that the secret has to be
25059 available in plain text at either end.
25060
25061
25062 .section "Using cram_md5 as a server" "SECID176"
25063 .cindex "options" "&(cram_md5)& authenticator (server)"
25064 This authenticator has one server option, which must be set to configure the
25065 authenticator as a server:
25066
25067 .option server_secret cram_md5 string&!! unset
25068 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25069 When the server receives the client's response, the user name is placed in
25070 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25071 obtain the password for that user. The server then computes the CRAM-MD5 digest
25072 that the client should have sent, and checks that it received the correct
25073 string. If the expansion of &%server_secret%& is forced to fail, authentication
25074 fails. If the expansion fails for some other reason, a temporary error code is
25075 returned to the client.
25076
25077 For compatibility with previous releases of Exim, the user name is also placed
25078 in &$1$&. However, the use of this variables for this purpose is now
25079 deprecated, as it can lead to confusion in string expansions that also use
25080 numeric variables for other things.
25081
25082 For example, the following authenticator checks that the user name given by the
25083 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25084 user name, authentication fails.
25085 .code
25086 fixed_cram:
25087   driver = cram_md5
25088   public_name = CRAM-MD5
25089   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25090   server_set_id = $auth1
25091 .endd
25092 .vindex "&$authenticated_id$&"
25093 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25094 name in &$authenticated_id$&. A more typical configuration might look up the
25095 secret string in a file, using the user name as the key. For example:
25096 .code
25097 lookup_cram:
25098   driver = cram_md5
25099   public_name = CRAM-MD5
25100   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25101                   {$value}fail}
25102   server_set_id = $auth1
25103 .endd
25104 Note that this expansion explicitly forces failure if the lookup fails
25105 because &$auth1$& contains an unknown user name.
25106
25107 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25108 using the relevant libraries, you need to know the realm to specify in the
25109 lookup and then ask for the &"userPassword"& attribute for that user in that
25110 realm, with:
25111 .code
25112 cyrusless_crammd5:
25113   driver = cram_md5
25114   public_name = CRAM-MD5
25115   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25116                   dbmjz{/etc/sasldb2}}
25117   server_set_id = $auth1
25118 .endd
25119
25120 .section "Using cram_md5 as a client" "SECID177"
25121 .cindex "options" "&(cram_md5)& authenticator (client)"
25122 When used as a client, the &(cram_md5)& authenticator has two options:
25123
25124
25125
25126 .option client_name cram_md5 string&!! "the primary host name"
25127 This string is expanded, and the result used as the user name data when
25128 computing the response to the server's challenge.
25129
25130
25131 .option client_secret cram_md5 string&!! unset
25132 This option must be set for the authenticator to work as a client. Its value is
25133 expanded and the result used as the secret string when computing the response.
25134
25135
25136 .vindex "&$host$&"
25137 .vindex "&$host_address$&"
25138 Different user names and secrets can be used for different servers by referring
25139 to &$host$& or &$host_address$& in the options. Forced failure of either
25140 expansion string is treated as an indication that this authenticator is not
25141 prepared to handle this case. Exim moves on to the next configured client
25142 authenticator. Any other expansion failure causes Exim to give up trying to
25143 send the message to the current server.
25144
25145 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25146 strings, is:
25147 .code
25148 fixed_cram:
25149   driver = cram_md5
25150   public_name = CRAM-MD5
25151   client_name = ph10
25152   client_secret = secret
25153 .endd
25154 .ecindex IIDcramauth1
25155 .ecindex IIDcramauth2
25156
25157
25158
25159 . ////////////////////////////////////////////////////////////////////////////
25160 . ////////////////////////////////////////////////////////////////////////////
25161
25162 .chapter "The cyrus_sasl authenticator" "CHID10"
25163 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25164 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25165 .cindex "Cyrus" "SASL library"
25166 .cindex "Kerberos"
25167 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25168 Digital Ltd (&url(http://www.aldigital.co.uk)).
25169
25170 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25171 library implementation of the RFC 2222 (&"Simple Authentication and Security
25172 Layer"&). This library supports a number of authentication mechanisms,
25173 including PLAIN and LOGIN, but also several others that Exim does not support
25174 directly. In particular, there is support for Kerberos authentication.
25175
25176 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25177 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25178 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25179 name of the driver to determine which mechanism to support.
25180
25181 Where access to some kind of secret file is required, for example in GSSAPI
25182 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25183 user, and that the Cyrus SASL library has no way of escalating privileges
25184 by default. You may also find you need to set environment variables,
25185 depending on the driver you are using.
25186
25187 The application name provided by Exim is &"exim"&, so various SASL options may
25188 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25189 Kerberos, note that because of limitations in the GSSAPI interface,
25190 changing the server keytab might need to be communicated down to the Kerberos
25191 layer independently. The mechanism for doing so is dependent upon the Kerberos
25192 implementation.
25193
25194 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25195 may be set to point to an alternative keytab file. Exim will pass this
25196 variable through from its own inherited environment when started as root or the
25197 Exim user. The keytab file needs to be readable by the Exim user.
25198 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25199 environment variable.  In practice, for those releases, the Cyrus authenticator
25200 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25201 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25202
25203
25204 .section "Using cyrus_sasl as a server" "SECID178"
25205 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25206 (on a successful authentication) into &$auth1$&. For compatibility with
25207 previous releases of Exim, the username is also placed in &$1$&. However, the
25208 use of this variable for this purpose is now deprecated, as it can lead to
25209 confusion in string expansions that also use numeric variables for other
25210 things.
25211
25212
25213 .option server_hostname cyrus_sasl string&!! "see below"
25214 This option selects the hostname that is used when communicating with the
25215 library. The default value is &`$primary_hostname`&. It is up to the underlying
25216 SASL plug-in what it does with this data.
25217
25218
25219 .option server_mech cyrus_sasl string "see below"
25220 This option selects the authentication mechanism this driver should use. The
25221 default is the value of the generic &%public_name%& option. This option allows
25222 you to use a different underlying mechanism from the advertised name. For
25223 example:
25224 .code
25225 sasl:
25226   driver = cyrus_sasl
25227   public_name = X-ANYTHING
25228   server_mech = CRAM-MD5
25229   server_set_id = $auth1
25230 .endd
25231
25232 .option server_realm cyrus_sasl string&!! unset
25233 This specifies the SASL realm that the server claims to be in.
25234
25235
25236 .option server_service cyrus_sasl string &`smtp`&
25237 This is the SASL service that the server claims to implement.
25238
25239
25240 For straightforward cases, you do not need to set any of the authenticator's
25241 private options. All you need to do is to specify an appropriate mechanism as
25242 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25243 PLAIN, you could have two authenticators as follows:
25244 .code
25245 sasl_cram_md5:
25246   driver = cyrus_sasl
25247   public_name = CRAM-MD5
25248   server_set_id = $auth1
25249
25250 sasl_plain:
25251   driver = cyrus_sasl
25252   public_name = PLAIN
25253   server_set_id = $auth2
25254 .endd
25255 Cyrus SASL does implement the LOGIN authentication method, even though it is
25256 not a standard method. It is disabled by default in the source distribution,
25257 but it is present in many binary distributions.
25258 .ecindex IIDcyrauth1
25259 .ecindex IIDcyrauth2
25260
25261
25262
25263
25264 . ////////////////////////////////////////////////////////////////////////////
25265 . ////////////////////////////////////////////////////////////////////////////
25266 .chapter "The dovecot authenticator" "CHAPdovecot"
25267 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25268 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25269 This authenticator is an interface to the authentication facility of the
25270 Dovecot POP/IMAP server, which can support a number of authentication methods.
25271 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25272 to use the same mechanisms for SMTP authentication. This is a server
25273 authenticator only. There is only one option:
25274
25275 .option server_socket dovecot string unset
25276
25277 This option must specify the socket that is the interface to Dovecot
25278 authentication. The &%public_name%& option must specify an authentication
25279 mechanism that Dovecot is configured to support. You can have several
25280 authenticators for different mechanisms. For example:
25281 .code
25282 dovecot_plain:
25283   driver = dovecot
25284   public_name = PLAIN
25285   server_socket = /var/run/dovecot/auth-client
25286   server_set_id = $auth2
25287
25288 dovecot_ntlm:
25289   driver = dovecot
25290   public_name = NTLM
25291   server_socket = /var/run/dovecot/auth-client
25292   server_set_id = $auth1
25293 .endd
25294 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25295 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25296 option is passed in the Dovecot authentication command. If, for a TLS
25297 connection, a client certificate has been verified, the &"valid-client-cert"&
25298 option is passed. When authentication succeeds, the identity of the user
25299 who authenticated is placed in &$auth1$&.
25300 .ecindex IIDdcotauth1
25301 .ecindex IIDdcotauth2
25302
25303
25304 . ////////////////////////////////////////////////////////////////////////////
25305 . ////////////////////////////////////////////////////////////////////////////
25306 .chapter "The gsasl authenticator" "CHAPgsasl"
25307 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25308 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25309 .cindex "authentication" "GNU SASL"
25310 .cindex "authentication" "SASL"
25311 .cindex "authentication" "EXTERNAL"
25312 .cindex "authentication" "ANONYMOUS"
25313 .cindex "authentication" "PLAIN"
25314 .cindex "authentication" "LOGIN"
25315 .cindex "authentication" "DIGEST-MD5"
25316 .cindex "authentication" "CRAM-MD5"
25317 .cindex "authentication" "SCRAM-SHA-1"
25318 The &(gsasl)& authenticator provides server integration for the GNU SASL
25319 library and the mechanisms it provides.  This is new as of the 4.80 release
25320 and there are a few areas where the library does not let Exim smoothly
25321 scale to handle future authentication mechanisms, so no guarantee can be
25322 made that any particular new authentication mechanism will be supported
25323 without code changes in Exim.
25324
25325
25326 .option server_channelbinding gsasl boolean false
25327 Some authentication mechanisms are able to use external context at both ends
25328 of the session to bind the authentication to that context, and fail the
25329 authentication process if that context differs.  Specifically, some TLS
25330 ciphersuites can provide identifying information about the cryptographic
25331 context.
25332
25333 This means that certificate identity and verification becomes a non-issue,
25334 as a man-in-the-middle attack will cause the correct client and server to
25335 see different identifiers and authentication will fail.
25336
25337 This is currently only supported when using the GnuTLS library.  This is
25338 only usable by mechanisms which support "channel binding"; at time of
25339 writing, that's the SCRAM family.
25340
25341 This defaults off to ensure smooth upgrade across Exim releases, in case
25342 this option causes some clients to start failing.  Some future release
25343 of Exim may switch the default to be true.
25344
25345
25346 .option server_hostname gsasl string&!! "see below"
25347 This option selects the hostname that is used when communicating with the
25348 library. The default value is &`$primary_hostname`&.
25349 Some mechanisms will use this data.
25350
25351
25352 .option server_mech gsasl string "see below"
25353 This option selects the authentication mechanism this driver should use. The
25354 default is the value of the generic &%public_name%& option. This option allows
25355 you to use a different underlying mechanism from the advertised name. For
25356 example:
25357 .code
25358 sasl:
25359   driver = gsasl
25360   public_name = X-ANYTHING
25361   server_mech = CRAM-MD5
25362   server_set_id = $auth1
25363 .endd
25364
25365
25366 .option server_password gsasl string&!! unset
25367 Various mechanisms need access to the cleartext password on the server, so
25368 that proof-of-possession can be demonstrated on the wire, without sending
25369 the password itself.
25370
25371 The data available for lookup varies per mechanism.
25372 In all cases, &$auth1$& is set to the &'authentication id'&.
25373 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25374 if available, else the empty string.
25375 The &$auth3$& variable will always be the &'realm'& if available,
25376 else the empty string.
25377
25378 A forced failure will cause authentication to defer.
25379
25380 If using this option, it may make sense to set the &%server_condition%&
25381 option to be simply "true".
25382
25383
25384 .option server_realm gsasl string&!! unset
25385 This specifies the SASL realm that the server claims to be in.
25386 Some mechanisms will use this data.
25387
25388
25389 .option server_scram_iter gsasl string&!! unset
25390 This option provides data for the SCRAM family of mechanisms.
25391 &$auth1$& is not available at evaluation time.
25392 (This may change, as we receive feedback on use)
25393
25394
25395 .option server_scram_salt gsasl string&!! unset
25396 This option provides data for the SCRAM family of mechanisms.
25397 &$auth1$& is not available at evaluation time.
25398 (This may change, as we receive feedback on use)
25399
25400
25401 .option server_service gsasl string &`smtp`&
25402 This is the SASL service that the server claims to implement.
25403 Some mechanisms will use this data.
25404
25405
25406 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25407 .vindex "&$auth1$&, &$auth2$&, etc"
25408 These may be set when evaluating specific options, as detailed above.
25409 They will also be set when evaluating &%server_condition%&.
25410
25411 Unless otherwise stated below, the &(gsasl)& integration will use the following
25412 meanings for these variables:
25413
25414 .ilist
25415 .vindex "&$auth1$&"
25416 &$auth1$&: the &'authentication id'&
25417 .next
25418 .vindex "&$auth2$&"
25419 &$auth2$&: the &'authorization id'&
25420 .next
25421 .vindex "&$auth3$&"
25422 &$auth3$&: the &'realm'&
25423 .endlist
25424
25425 On a per-mechanism basis:
25426
25427 .ilist
25428 .cindex "authentication" "EXTERNAL"
25429 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25430 the &%server_condition%& option must be present.
25431 .next
25432 .cindex "authentication" "ANONYMOUS"
25433 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25434 the &%server_condition%& option must be present.
25435 .next
25436 .cindex "authentication" "GSSAPI"
25437 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25438 &$auth2$& will be set to the &'authorization id'&,
25439 the &%server_condition%& option must be present.
25440 .endlist
25441
25442 An &'anonymous token'& is something passed along as an unauthenticated
25443 identifier; this is analogous to FTP anonymous authentication passing an
25444 email address, or software-identifier@, as the "password".
25445
25446
25447 An example showing the password having the realm specified in the callback
25448 and demonstrating a Cyrus SASL to GSASL migration approach is:
25449 .code
25450 gsasl_cyrusless_crammd5:
25451   driver = gsasl
25452   public_name = CRAM-MD5
25453   server_realm = imap.example.org
25454   server_password = ${lookup{$auth1:$auth3:userPassword}\
25455                     dbmjz{/etc/sasldb2}{$value}fail}
25456   server_set_id = ${quote:$auth1}
25457   server_condition = yes
25458 .endd
25459
25460
25461 . ////////////////////////////////////////////////////////////////////////////
25462 . ////////////////////////////////////////////////////////////////////////////
25463
25464 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25465 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25466 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25467 .cindex "authentication" "GSSAPI"
25468 .cindex "authentication" "Kerberos"
25469 The &(heimdal_gssapi)& authenticator provides server integration for the
25470 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25471 reliably.
25472
25473 .option server_hostname heimdal_gssapi string&!! "see below"
25474 This option selects the hostname that is used, with &%server_service%&,
25475 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25476 identifier.  The default value is &`$primary_hostname`&.
25477
25478 .option server_keytab heimdal_gssapi string&!! unset
25479 If set, then Heimdal will not use the system default keytab (typically
25480 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25481 The value should be a pathname, with no &"file:"& prefix.
25482
25483 .option server_service heimdal_gssapi string&!! "smtp"
25484 This option specifies the service identifier used, in conjunction with
25485 &%server_hostname%&, for building the identifer for finding credentials
25486 from the keytab.
25487
25488
25489 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25490 Beware that these variables will typically include a realm, thus will appear
25491 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25492 not verified, so a malicious client can set it to anything.
25493
25494 The &$auth1$& field should be safely trustable as a value from the Key
25495 Distribution Center.  Note that these are not quite email addresses.
25496 Each identifier is for a role, and so the left-hand-side may include a
25497 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25498
25499 .vindex "&$auth1$&, &$auth2$&, etc"
25500 .ilist
25501 .vindex "&$auth1$&"
25502 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25503 .next
25504 .vindex "&$auth2$&"
25505 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25506 authentication.  If that was empty, this will also be set to the
25507 GSS Display Name.
25508 .endlist
25509
25510
25511 . ////////////////////////////////////////////////////////////////////////////
25512 . ////////////////////////////////////////////////////////////////////////////
25513
25514 .chapter "The spa authenticator" "CHAPspa"
25515 .scindex IIDspaauth1 "&(spa)& authenticator"
25516 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25517 .cindex "authentication" "Microsoft Secure Password"
25518 .cindex "authentication" "NTLM"
25519 .cindex "Microsoft Secure Password Authentication"
25520 .cindex "NTLM authentication"
25521 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25522 Password Authentication'& mechanism,
25523 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25524 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25525 taken from the Samba project (&url(http://www.samba.org)). The code for the
25526 server side was subsequently contributed by Tom Kistner. The mechanism works as
25527 follows:
25528
25529 .ilist
25530 After the AUTH command has been accepted, the client sends an SPA
25531 authentication request based on the user name and optional domain.
25532 .next
25533 The server sends back a challenge.
25534 .next
25535 The client builds a challenge response which makes use of the user's password
25536 and sends it to the server, which then accepts or rejects it.
25537 .endlist
25538
25539 Encryption is used to protect the password in transit.
25540
25541
25542
25543 .section "Using spa as a server" "SECID179"
25544 .cindex "options" "&(spa)& authenticator (server)"
25545 The &(spa)& authenticator has just one server option:
25546
25547 .option server_password spa string&!! unset
25548 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25549 This option is expanded, and the result must be the cleartext password for the
25550 authenticating user, whose name is at this point in &$auth1$&. For
25551 compatibility with previous releases of Exim, the user name is also placed in
25552 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25553 it can lead to confusion in string expansions that also use numeric variables
25554 for other things. For example:
25555 .code
25556 spa:
25557   driver = spa
25558   public_name = NTLM
25559   server_password = \
25560     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25561 .endd
25562 If the expansion is forced to fail, authentication fails. Any other expansion
25563 failure causes a temporary error code to be returned.
25564
25565
25566
25567
25568
25569 .section "Using spa as a client" "SECID180"
25570 .cindex "options" "&(spa)& authenticator (client)"
25571 The &(spa)& authenticator has the following client options:
25572
25573
25574
25575 .option client_domain spa string&!! unset
25576 This option specifies an optional domain for the authentication.
25577
25578
25579 .option client_password spa string&!! unset
25580 This option specifies the user's password, and must be set.
25581
25582
25583 .option client_username spa string&!! unset
25584 This option specifies the user name, and must be set. Here is an example of a
25585 configuration of this authenticator for use with the mail servers at
25586 &'msn.com'&:
25587 .code
25588 msn:
25589   driver = spa
25590   public_name = MSN
25591   client_username = msn/msn_username
25592   client_password = msn_plaintext_password
25593   client_domain = DOMAIN_OR_UNSET
25594 .endd
25595 .ecindex IIDspaauth1
25596 .ecindex IIDspaauth2
25597
25598
25599
25600
25601
25602 . ////////////////////////////////////////////////////////////////////////////
25603 . ////////////////////////////////////////////////////////////////////////////
25604
25605 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25606          "Encrypted SMTP connections"
25607 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25608 .scindex IIDencsmtp2 "SMTP" "encryption"
25609 .cindex "TLS" "on SMTP connection"
25610 .cindex "OpenSSL"
25611 .cindex "GnuTLS"
25612 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25613 Sockets Layer), is implemented by making use of the OpenSSL library or the
25614 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25615 cryptographic code in the Exim distribution itself for implementing TLS. In
25616 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25617 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25618 You also need to understand the basic concepts of encryption at a managerial
25619 level, and in particular, the way that public keys, private keys, and
25620 certificates are used.
25621
25622 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25623 connection is established, the client issues a STARTTLS command. If the
25624 server accepts this, the client and the server negotiate an encryption
25625 mechanism. If the negotiation succeeds, the data that subsequently passes
25626 between them is encrypted.
25627
25628 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25629 and if so, what cipher suite is in use, whether the client supplied a
25630 certificate, and whether or not that certificate was verified. This makes it
25631 possible for an Exim server to deny or accept certain commands based on the
25632 encryption state.
25633
25634 &*Warning*&: Certain types of firewall and certain anti-virus products can
25635 disrupt TLS connections. You need to turn off SMTP scanning for these products
25636 in order to get TLS to work.
25637
25638
25639
25640 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25641          "SECID284"
25642 .cindex "ssmtp protocol"
25643 .cindex "smtps protocol"
25644 .cindex "SMTP" "ssmtp protocol"
25645 .cindex "SMTP" "smtps protocol"
25646 Early implementations of encrypted SMTP used a different TCP port from normal
25647 SMTP, and expected an encryption negotiation to start immediately, instead of
25648 waiting for a STARTTLS command from the client using the standard SMTP
25649 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25650 allocated for this purpose.
25651
25652 This approach was abandoned when encrypted SMTP was standardized, but there are
25653 still some legacy clients that use it. Exim supports these clients by means of
25654 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25655 numbers; the most common use is expected to be:
25656 .code
25657 tls_on_connect_ports = 465
25658 .endd
25659 The port numbers specified by this option apply to all SMTP connections, both
25660 via the daemon and via &'inetd'&. You still need to specify all the ports that
25661 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25662 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25663 an extra port &-- rather, it specifies different behaviour on a port that is
25664 defined elsewhere.
25665
25666 There is also a &%-tls-on-connect%& command line option. This overrides
25667 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25668
25669
25670
25671
25672
25673
25674 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25675 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25676 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25677 followed later, when the first versions of GnuTLS were released. To build Exim
25678 to use GnuTLS, you need to set
25679 .code
25680 USE_GNUTLS=yes
25681 .endd
25682 in Local/Makefile, in addition to
25683 .code
25684 SUPPORT_TLS=yes
25685 .endd
25686 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25687 include files and libraries for GnuTLS can be found.
25688
25689 There are some differences in usage when using GnuTLS instead of OpenSSL:
25690
25691 .ilist
25692 The &%tls_verify_certificates%& option must contain the name of a file, not the
25693 name of a directory (for OpenSSL it can be either).
25694 .next
25695 The default value for &%tls_dhparam%& differs for historical reasons.
25696 .next
25697 .vindex "&$tls_in_peerdn$&"
25698 .vindex "&$tls_out_peerdn$&"
25699 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25700 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25701 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25702 .next
25703 OpenSSL identifies cipher suites using hyphens as separators, for example:
25704 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25705 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25706 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25707 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25708 to handle its own older variants) when processing lists of cipher suites in the
25709 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25710 option).
25711 .next
25712 The &%tls_require_ciphers%& options operate differently, as described in the
25713 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25714 .next
25715 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25716 When using OpenSSL, this option is ignored.
25717 (If an API is found to let OpenSSL be configured in this way,
25718 let the Exim Maintainers know and we'll likely use it).
25719 .next
25720 Some other recently added features may only be available in one or the other.
25721 This should be documented with the feature.  If the documentation does not
25722 explicitly state that the feature is infeasible in the other TLS
25723 implementation, then patches are welcome.
25724 .endlist
25725
25726
25727 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25728 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25729 an explicit path; if the latter, then the text about generation still applies,
25730 but not the chosen filename.
25731 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25732 See the documentation of &%tls_dhparam%& for more information.
25733
25734 GnuTLS uses D-H parameters that may take a substantial amount of time
25735 to compute. It is unreasonable to re-compute them for every TLS session.
25736 Therefore, Exim keeps this data in a file in its spool directory, called
25737 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25738 of bits requested.
25739 The file is owned by the Exim user and is readable only by
25740 its owner. Every Exim process that start up GnuTLS reads the D-H
25741 parameters from this file. If the file does not exist, the first Exim process
25742 that needs it computes the data and writes it to a temporary file which is
25743 renamed once it is complete. It does not matter if several Exim processes do
25744 this simultaneously (apart from wasting a few resources). Once a file is in
25745 place, new Exim processes immediately start using it.
25746
25747 For maximum security, the parameters that are stored in this file should be
25748 recalculated periodically, the frequency depending on your paranoia level.
25749 If you are avoiding using the fixed D-H primes published in RFCs, then you
25750 are concerned about some advanced attacks and will wish to do this; if you do
25751 not regenerate then you might as well stick to the standard primes.
25752
25753 Arranging this is easy in principle; just delete the file when you want new
25754 values to be computed. However, there may be a problem. The calculation of new
25755 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25756 If the system is not very active, &_/dev/random_& may delay returning data
25757 until enough randomness (entropy) is available. This may cause Exim to hang for
25758 a substantial amount of time, causing timeouts on incoming connections.
25759
25760 The solution is to generate the parameters externally to Exim. They are stored
25761 in &_gnutls-params-N_& in PEM format, which means that they can be
25762 generated externally using the &(certtool)& command that is part of GnuTLS.
25763
25764 To replace the parameters with new ones, instead of deleting the file
25765 and letting Exim re-create it, you can generate new parameters using
25766 &(certtool)& and, when this has been done, replace Exim's cache file by
25767 renaming. The relevant commands are something like this:
25768 .code
25769 # ls
25770 [ look for file; assume gnutls-params-2236 is the most recent ]
25771 # rm -f new-params
25772 # touch new-params
25773 # chown exim:exim new-params
25774 # chmod 0600 new-params
25775 # certtool --generate-dh-params --bits 2236 >>new-params
25776 # openssl dhparam -noout -text -in new-params | head
25777 [ check the first line, make sure it's not more than 2236;
25778   if it is, then go back to the start ("rm") and repeat
25779   until the size generated is at most the size requested ]
25780 # chmod 0400 new-params
25781 # mv new-params gnutls-params-2236
25782 .endd
25783 If Exim never has to generate the parameters itself, the possibility of
25784 stalling is removed.
25785
25786 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25787 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25788 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25789 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25790 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25791 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25792 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25793 which applies to all D-H usage, client or server.  If the value returned by
25794 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25795 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25796 limit, which is still much higher than Exim historically used.
25797
25798 The filename and bits used will change as the GnuTLS maintainers change the
25799 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25800 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25801 2432 bits, while NSS is limited to 2236 bits.
25802
25803 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25804 increase the chance of the generated prime actually being within acceptable
25805 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25806 procedure above.  There is no sane procedure available to Exim to double-check
25807 the size of the generated prime, so it might still be too large.
25808
25809
25810 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25811 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25812 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25813 There is a function in the OpenSSL library that can be passed a list of cipher
25814 suites before the cipher negotiation takes place. This specifies which ciphers
25815 are acceptable. The list is colon separated and may contain names like
25816 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25817 directly to this function call.
25818 Many systems will install the OpenSSL manual-pages, so you may have
25819 &'ciphers(1)'& available to you.
25820 The following quotation from the OpenSSL
25821 documentation specifies what forms of item are allowed in the cipher string:
25822
25823 .ilist
25824 It can consist of a single cipher suite such as RC4-SHA.
25825 .next
25826 It can represent a list of cipher suites containing a certain algorithm,
25827 or cipher suites of a certain type. For example SHA1 represents all
25828 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25829 SSL v3 algorithms.
25830 .next
25831 Lists of cipher suites can be combined in a single cipher string using
25832 the + character. This is used as a logical and operation. For example
25833 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25834 algorithms.
25835 .endlist
25836
25837 Each cipher string can be optionally preceded by one of the characters &`!`&,
25838 &`-`& or &`+`&.
25839 .ilist
25840 If &`!`& is used, the ciphers are permanently deleted from the list. The
25841 ciphers deleted can never reappear in the list even if they are explicitly
25842 stated.
25843 .next
25844 If &`-`& is used, the ciphers are deleted from the list, but some or all
25845 of the ciphers can be added again by later options.
25846 .next
25847 If &`+`& is used, the ciphers are moved to the end of the list. This
25848 option does not add any new ciphers; it just moves matching existing ones.
25849 .endlist
25850
25851 If none of these characters is present, the string is interpreted as
25852 a list of ciphers to be appended to the current preference list. If the list
25853 includes any ciphers already present they will be ignored: that is, they will
25854 not be moved to the end of the list.
25855 .endlist
25856
25857 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25858 string:
25859 .code
25860 # note single-quotes to get ! past any shell history expansion
25861 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25862 .endd
25863
25864 This example will let the library defaults be permitted on the MX port, where
25865 there's probably no identity verification anyway, but ups the ante on the
25866 submission ports where the administrator might have some influence on the
25867 choice of clients used:
25868 .code
25869 # OpenSSL variant; see man ciphers(1)
25870 tls_require_ciphers = ${if =={$received_port}{25}\
25871                            {DEFAULT}\
25872                            {HIGH:!MD5:!SHA1}}
25873 .endd
25874
25875
25876
25877 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25878          "SECTreqciphgnu"
25879 .cindex "GnuTLS" "specifying parameters for"
25880 .cindex "TLS" "specifying ciphers (GnuTLS)"
25881 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25882 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25883 .cindex "TLS" "specifying protocols (GnuTLS)"
25884 .cindex "TLS" "specifying priority string (GnuTLS)"
25885 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25886 The GnuTLS library allows the caller to provide a "priority string", documented
25887 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25888 ciphersuite specification in OpenSSL.
25889
25890 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25891
25892 The &%tls_require_ciphers%& option is available both as an global option,
25893 controlling how Exim behaves as a server, and also as an option of the
25894 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25895 the value is string expanded.  The resulting string is not an Exim list and
25896 the string is given to the GnuTLS library, so that Exim does not need to be
25897 aware of future feature enhancements of GnuTLS.
25898
25899 Documentation of the strings accepted may be found in the GnuTLS manual, under
25900 "Priority strings".  This is online as
25901 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
25902 but beware that this relates to GnuTLS 3, which may be newer than the version
25903 installed on your system.  If you are using GnuTLS 3,
25904 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
25905 on that site can be used to test a given string.
25906
25907 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25908 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25909 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25910
25911 This example will let the library defaults be permitted on the MX port, where
25912 there's probably no identity verification anyway, and lowers security further
25913 by increasing compatibility; but this ups the ante on the submission ports
25914 where the administrator might have some influence on the choice of clients
25915 used:
25916 .code
25917 # GnuTLS variant
25918 tls_require_ciphers = ${if =={$received_port}{25}\
25919                            {NORMAL:%COMPAT}\
25920                            {SECURE128}}
25921 .endd
25922
25923
25924 .section "Configuring an Exim server to use TLS" "SECID182"
25925 .cindex "TLS" "configuring an Exim server"
25926 When Exim has been built with TLS support, it advertises the availability of
25927 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25928 but not to any others. The default value of this option is unset, which means
25929 that STARTTLS is not advertised at all. This default is chosen because you
25930 need to set some other options in order to make TLS available, and also it is
25931 sensible for systems that want to use TLS only as a client.
25932
25933 If a client issues a STARTTLS command and there is some configuration
25934 problem in the server, the command is rejected with a 454 error. If the client
25935 persists in trying to issue SMTP commands, all except QUIT are rejected
25936 with the error
25937 .code
25938 554 Security failure
25939 .endd
25940 If a STARTTLS command is issued within an existing TLS session, it is
25941 rejected with a 554 error code.
25942
25943 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25944 match some hosts. You can, of course, set it to * to match all hosts.
25945 However, this is not all you need to do. TLS sessions to a server won't work
25946 without some further configuration at the server end.
25947
25948 It is rumoured that all existing clients that support TLS/SSL use RSA
25949 encryption. To make this work you need to set, in the server,
25950 .code
25951 tls_certificate = /some/file/name
25952 tls_privatekey = /some/file/name
25953 .endd
25954 These options are, in fact, expanded strings, so you can make them depend on
25955 the identity of the client that is connected if you wish. The first file
25956 contains the server's X509 certificate, and the second contains the private key
25957 that goes with it. These files need to be readable by the Exim user, and must
25958 always be given as full path names. They can be the same file if both the
25959 certificate and the key are contained within it. If &%tls_privatekey%& is not
25960 set, or if its expansion is forced to fail or results in an empty string, this
25961 is assumed to be the case. The certificate file may also contain intermediate
25962 certificates that need to be sent to the client to enable it to authenticate
25963 the server's certificate.
25964
25965 If you do not understand about certificates and keys, please try to find a
25966 source of this background information, which is not Exim-specific. (There are a
25967 few comments below in section &<<SECTcerandall>>&.)
25968
25969 &*Note*&: These options do not apply when Exim is operating as a client &--
25970 they apply only in the case of a server. If you need to use a certificate in an
25971 Exim client, you must set the options of the same names in an &(smtp)&
25972 transport.
25973
25974 With just these options, an Exim server will be able to use TLS. It does not
25975 require the client to have a certificate (but see below for how to insist on
25976 this). There is one other option that may be needed in other situations. If
25977 .code
25978 tls_dhparam = /some/file/name
25979 .endd
25980 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25981 with the parameters contained in the file.
25982 Set this to &`none`& to disable use of DH entirely, by making no prime
25983 available:
25984 .code
25985 tls_dhparam = none
25986 .endd
25987 This may also be set to a string identifying a standard prime to be used for
25988 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
25989 used is &`ike23`&.  There are a few standard primes available, see the
25990 documentation for &%tls_dhparam%& for the complete list.
25991
25992 See the command
25993 .code
25994 openssl dhparam
25995 .endd
25996 for a way of generating file data.
25997
25998 The strings supplied for these three options are expanded every time a client
25999 host connects. It is therefore possible to use different certificates and keys
26000 for different hosts, if you so wish, by making use of the client's IP address
26001 in &$sender_host_address$& to control the expansion. If a string expansion is
26002 forced to fail, Exim behaves as if the option is not set.
26003
26004 .cindex "cipher" "logging"
26005 .cindex "log" "TLS cipher"
26006 .vindex "&$tls_in_cipher$&"
26007 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26008 an incoming TLS connection. It is included in the &'Received:'& header of an
26009 incoming message (by default &-- you can, of course, change this), and it is
26010 also included in the log line that records a message's arrival, keyed by
26011 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26012 condition can be used to test for specific cipher suites in ACLs.
26013
26014 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26015 can check the name of the cipher suite and vary their actions accordingly. The
26016 cipher suite names vary, depending on which TLS library is being used. For
26017 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26018 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26019 documentation for more details.
26020
26021 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26022 (again depending on the &%tls_cipher%& log selector).
26023
26024
26025 .section "Requesting and verifying client certificates" "SECID183"
26026 .cindex "certificate" "verification of client"
26027 .cindex "TLS" "client certificate verification"
26028 If you want an Exim server to request a certificate when negotiating a TLS
26029 session with a client, you must set either &%tls_verify_hosts%& or
26030 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26031 apply to all TLS connections. For any host that matches one of these options,
26032 Exim requests a certificate as part of the setup of the TLS session. The
26033 contents of the certificate are verified by comparing it with a list of
26034 expected certificates. These must be available in a file or,
26035 for OpenSSL only (not GnuTLS), a directory, identified by
26036 &%tls_verify_certificates%&.
26037
26038 A file can contain multiple certificates, concatenated end to end. If a
26039 directory is used
26040 (OpenSSL only),
26041 each certificate must be in a separate file, with a name (or a symbolic link)
26042 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26043 certificate. You can compute the relevant hash by running the command
26044 .code
26045 openssl x509 -hash -noout -in /cert/file
26046 .endd
26047 where &_/cert/file_& contains a single certificate.
26048
26049 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26050 what happens if the client does not supply a certificate, or if the certificate
26051 does not match any of the certificates in the collection named by
26052 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26053 attempt to set up a TLS session is aborted, and the incoming connection is
26054 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26055 session continues. ACLs that run for subsequent SMTP commands can detect the
26056 fact that no certificate was verified, and vary their actions accordingly. For
26057 example, you can insist on a certificate before accepting a message for
26058 relaying, but not when the message is destined for local delivery.
26059
26060 .vindex "&$tls_in_peerdn$&"
26061 When a client supplies a certificate (whether it verifies or not), the value of
26062 the Distinguished Name of the certificate is made available in the variable
26063 &$tls_in_peerdn$& during subsequent processing of the message.
26064
26065 .cindex "log" "distinguished name"
26066 Because it is often a long text string, it is not included in the log line or
26067 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26068 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26069 &%received_header_text%& to change the &'Received:'& header. When no
26070 certificate is supplied, &$tls_in_peerdn$& is empty.
26071
26072
26073 .section "Revoked certificates" "SECID184"
26074 .cindex "TLS" "revoked certificates"
26075 .cindex "revocation list"
26076 .cindex "certificate" "revocation list"
26077 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26078 certificates are revoked. If you have such a list, you can pass it to an Exim
26079 server using the global option called &%tls_crl%& and to an Exim client using
26080 an identically named option for the &(smtp)& transport. In each case, the value
26081 of the option is expanded and must then be the name of a file that contains a
26082 CRL in PEM format.
26083
26084
26085 .section "Configuring an Exim client to use TLS" "SECID185"
26086 .cindex "cipher" "logging"
26087 .cindex "log" "TLS cipher"
26088 .cindex "log" "distinguished name"
26089 .cindex "TLS" "configuring an Exim client"
26090 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26091 deliveries as well as to incoming, the latter one causing logging of the
26092 server certificate's DN. The remaining client configuration for TLS is all
26093 within the &(smtp)& transport.
26094
26095 It is not necessary to set any options to have TLS work in the &(smtp)&
26096 transport. If Exim is built with TLS support, and TLS is advertised by a
26097 server, the &(smtp)& transport always tries to start a TLS session. However,
26098 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26099 transport) to a list of server hosts for which TLS should not be used.
26100
26101 If you do not want Exim to attempt to send messages unencrypted when an attempt
26102 to set up an encrypted connection fails in any way, you can set
26103 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26104 those hosts, delivery is always deferred if an encrypted connection cannot be
26105 set up. If there are any other hosts for the address, they are tried in the
26106 usual way.
26107
26108 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26109 the message unencrypted. It always does this if the response to STARTTLS is
26110 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26111 session after a success response code, what happens is controlled by the
26112 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26113 delivery to this host is deferred, and other hosts (if available) are tried. If
26114 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26115 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26116 negotiation fails, Exim closes the current connection (because it is in an
26117 unknown state), opens a new one to the same host, and then tries the delivery
26118 unencrypted.
26119
26120 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26121 transport provide the client with a certificate, which is passed to the server
26122 if it requests it. If the server is Exim, it will request a certificate only if
26123 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26124
26125 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26126 must name a file or,
26127 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
26128 expected server certificates. The client verifies the server's certificate
26129 against this collection, taking into account any revoked certificates that are
26130 in the list defined by &%tls_crl%&.
26131 Failure to verify fails the TLS connection unless either of the
26132 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26133
26134 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26135 certificate verification to the listed servers.  Verification either must
26136 or need not succeed respectively.
26137
26138 If
26139 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26140 list of permitted cipher suites. If either of these checks fails, delivery to
26141 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26142 alternative hosts, if any.
26143
26144  &*Note*&:
26145 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26146 is operating as a client. Exim does not assume that a server certificate (set
26147 by the global options of the same name) should also be used when operating as a
26148 client.
26149
26150 .vindex "&$host$&"
26151 .vindex "&$host_address$&"
26152 All the TLS options in the &(smtp)& transport are expanded before use, with
26153 &$host$& and &$host_address$& containing the name and address of the server to
26154 which the client is connected. Forced failure of an expansion causes Exim to
26155 behave as if the relevant option were unset.
26156
26157 .vindex &$tls_out_bits$&
26158 .vindex &$tls_out_cipher$&
26159 .vindex &$tls_out_peerdn$&
26160 .vindex &$tls_out_sni$&
26161 Before an SMTP connection is established, the
26162 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26163 variables are emptied. (Until the first connection, they contain the values
26164 that were set when the message was received.) If STARTTLS is subsequently
26165 successfully obeyed, these variables are set to the relevant values for the
26166 outgoing connection.
26167
26168
26169
26170 .section "Use of TLS Server Name Indication" "SECTtlssni"
26171 .cindex "TLS" "Server Name Indication"
26172 .vindex "&$tls_in_sni$&"
26173 .oindex "&%tls_in_sni%&"
26174 With TLS1.0 or above, there is an extension mechanism by which extra
26175 information can be included at various points in the protocol.  One of these
26176 extensions, documented in RFC 6066 (and before that RFC 4366) is
26177 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26178 client in the initial handshake, so that the server can examine the servername
26179 within and possibly choose to use different certificates and keys (and more)
26180 for this session.
26181
26182 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26183 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26184 address.
26185
26186 With SMTP to MX, there are the same problems here as in choosing the identity
26187 against which to validate a certificate: you can't rely on insecure DNS to
26188 provide the identity which you then cryptographically verify.  So this will
26189 be of limited use in that environment.
26190
26191 With SMTP to Submission, there is a well-defined hostname which clients are
26192 connecting to and can validate certificates against.  Thus clients &*can*&
26193 choose to include this information in the TLS negotiation.  If this becomes
26194 wide-spread, then hosters can choose to present different certificates to
26195 different clients.  Or even negotiate different cipher suites.
26196
26197 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26198 if not empty, will be sent on a TLS session as part of the handshake.  There's
26199 nothing more to it.  Choosing a sensible value not derived insecurely is the
26200 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26201 for the lifetime of the client connection (including during authentication).
26202
26203 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26204 received from a client.
26205 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26206
26207 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26208 option (prior to expansion) then the following options will be re-expanded
26209 during TLS session handshake, to permit alternative values to be chosen:
26210
26211 .ilist
26212 .vindex "&%tls_certificate%&"
26213 &%tls_certificate%&
26214 .next
26215 .vindex "&%tls_crl%&"
26216 &%tls_crl%&
26217 .next
26218 .vindex "&%tls_privatekey%&"
26219 &%tls_privatekey%&
26220 .next
26221 .vindex "&%tls_verify_certificates%&"
26222 &%tls_verify_certificates%&
26223 .endlist
26224
26225 Great care should be taken to deal with matters of case, various injection
26226 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26227 can always be referenced; it is important to remember that &$tls_sni$& is
26228 arbitrary unverified data provided prior to authentication.
26229
26230 The Exim developers are proceeding cautiously and so far no other TLS options
26231 are re-expanded.
26232
26233 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26234 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26235 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26236 see &`-servername`& in the output, then OpenSSL has support.
26237
26238 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26239 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26240 built, then you have SNI support).
26241
26242
26243
26244 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26245          "SECTmulmessam"
26246 .cindex "multiple SMTP deliveries with TLS"
26247 .cindex "TLS" "multiple message deliveries"
26248 Exim sends multiple messages down the same TCP/IP connection by starting up
26249 an entirely new delivery process for each message, passing the socket from
26250 one process to the next. This implementation does not fit well with the use
26251 of TLS, because there is quite a lot of state information associated with a TLS
26252 connection, not just a socket identification. Passing all the state information
26253 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26254 session before passing the socket to a new process. The new process may then
26255 try to start a new TLS session, and if successful, may try to re-authenticate
26256 if AUTH is in use, before sending the next message.
26257
26258 The RFC is not clear as to whether or not an SMTP session continues in clear
26259 after TLS has been shut down, or whether TLS may be restarted again later, as
26260 just described. However, if the server is Exim, this shutdown and
26261 reinitialization works. It is not known which (if any) other servers operate
26262 successfully if the client closes a TLS session and continues with unencrypted
26263 SMTP, but there are certainly some that do not work. For such servers, Exim
26264 should not pass the socket to another process, because the failure of the
26265 subsequent attempt to use it would cause Exim to record a temporary host error,
26266 and delay other deliveries to that host.
26267
26268 To test for this case, Exim sends an EHLO command to the server after
26269 closing down the TLS session. If this fails in any way, the connection is
26270 closed instead of being passed to a new delivery process, but no retry
26271 information is recorded.
26272
26273 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26274 &(smtp)& transport to match those hosts for which Exim should not pass
26275 connections to new processes if TLS has been used.
26276
26277
26278
26279
26280 .section "Certificates and all that" "SECTcerandall"
26281 .cindex "certificate" "references to discussion"
26282 In order to understand fully how TLS works, you need to know about
26283 certificates, certificate signing, and certificate authorities. This is not the
26284 place to give a tutorial, especially as I do not know very much about it
26285 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26286 to Apache, currently at
26287 .display
26288 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26289 .endd
26290 Other parts of the &'modssl'& documentation are also helpful, and have
26291 links to further files.
26292 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26293 0-201-61598-3), contains both introductory and more in-depth descriptions.
26294 Some sample programs taken from the book are available from
26295 .display
26296 &url(http://www.rtfm.com/openssl-examples/)
26297 .endd
26298
26299
26300 .section "Certificate chains" "SECID186"
26301 The file named by &%tls_certificate%& may contain more than one
26302 certificate. This is useful in the case where the certificate that is being
26303 sent is validated by an intermediate certificate which the other end does
26304 not have. Multiple certificates must be in the correct order in the file.
26305 First the host's certificate itself, then the first intermediate
26306 certificate to validate the issuer of the host certificate, then the next
26307 intermediate certificate to validate the issuer of the first intermediate
26308 certificate, and so on, until finally (optionally) the root certificate.
26309 The root certificate must already be trusted by the recipient for
26310 validation to succeed, of course, but if it's not preinstalled, sending the
26311 root certificate along with the rest makes it available for the user to
26312 install if the receiving end is a client MUA that can interact with a user.
26313
26314 Note that certificates using MD5 are unlikely to work on today's Internet;
26315 even if your libraries allow loading them for use in Exim when acting as a
26316 server, increasingly clients will not accept such certificates.  The error
26317 diagnostics in such a case can be frustratingly vague.
26318
26319
26320
26321 .section "Self-signed certificates" "SECID187"
26322 .cindex "certificate" "self-signed"
26323 You can create a self-signed certificate using the &'req'& command provided
26324 with OpenSSL, like this:
26325 . ==== Do not shorten the duration here without reading and considering
26326 . ==== the text below.  Please leave it at 9999 days.
26327 .code
26328 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26329             -days 9999 -nodes
26330 .endd
26331 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26332 delimited and so can be identified independently. The &%-days%& option
26333 specifies a period for which the certificate is valid. The &%-nodes%& option is
26334 important: if you do not set it, the key is encrypted with a passphrase
26335 that you are prompted for, and any use that is made of the key causes more
26336 prompting for the passphrase. This is not helpful if you are going to use
26337 this certificate and key in an MTA, where prompting is not possible.
26338
26339 . ==== I expect to still be working 26 years from now.  The less technical
26340 . ==== debt I create, in terms of storing up trouble for my later years, the
26341 . ==== happier I will be then.  We really have reached the point where we
26342 . ==== should start, at the very least, provoking thought and making folks
26343 . ==== pause before proceeding, instead of leaving all the fixes until two
26344 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26345 . ==== -pdp, 2012
26346 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26347 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26348 the above command might produce a date in the past.  Think carefully about
26349 the lifetime of the systems you're deploying, and either reduce the duration
26350 of the certificate or reconsider your platform deployment.  (At time of
26351 writing, reducing the duration is the most likely choice, but the inexorable
26352 progression of time takes us steadily towards an era where this will not
26353 be a sensible resolution).
26354
26355 A self-signed certificate made in this way is sufficient for testing, and
26356 may be adequate for all your requirements if you are mainly interested in
26357 encrypting transfers, and not in secure identification.
26358
26359 However, many clients require that the certificate presented by the server be a
26360 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26361 certificate. In this situation, the self-signed certificate described above
26362 must be installed on the client host as a trusted root &'certification
26363 authority'& (CA), and the certificate used by Exim must be a user certificate
26364 signed with that self-signed certificate.
26365
26366 For information on creating self-signed CA certificates and using them to sign
26367 user certificates, see the &'General implementation overview'& chapter of the
26368 Open-source PKI book, available online at
26369 &url(http://ospkibook.sourceforge.net/).
26370 .ecindex IIDencsmtp1
26371 .ecindex IIDencsmtp2
26372
26373
26374
26375 . ////////////////////////////////////////////////////////////////////////////
26376 . ////////////////////////////////////////////////////////////////////////////
26377
26378 .chapter "Access control lists" "CHAPACL"
26379 .scindex IIDacl "&ACL;" "description"
26380 .cindex "control of incoming mail"
26381 .cindex "message" "controlling incoming"
26382 .cindex "policy control" "access control lists"
26383 Access Control Lists (ACLs) are defined in a separate section of the run time
26384 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26385 name, terminated by a colon. Here is a complete ACL section that contains just
26386 one very small ACL:
26387 .code
26388 begin acl
26389 small_acl:
26390   accept   hosts = one.host.only
26391 .endd
26392 You can have as many lists as you like in the ACL section, and the order in
26393 which they appear does not matter. The lists are self-terminating.
26394
26395 The majority of ACLs are used to control Exim's behaviour when it receives
26396 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26397 when a local process submits a message using SMTP by specifying the &%-bs%&
26398 option. The most common use is for controlling which recipients are accepted
26399 in incoming messages. In addition, you can define an ACL that is used to check
26400 local non-SMTP messages. The default configuration file contains an example of
26401 a realistic ACL for checking RCPT commands. This is discussed in chapter
26402 &<<CHAPdefconfil>>&.
26403
26404
26405 .section "Testing ACLs" "SECID188"
26406 The &%-bh%& command line option provides a way of testing your ACL
26407 configuration locally by running a fake SMTP session with which you interact.
26408 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26409 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26410
26411
26412
26413 .section "Specifying when ACLs are used" "SECID189"
26414 .cindex "&ACL;" "options for specifying"
26415 In order to cause an ACL to be used, you have to name it in one of the relevant
26416 options in the main part of the configuration. These options are:
26417 .cindex "AUTH" "ACL for"
26418 .cindex "DATA" "ACLs for"
26419 .cindex "ETRN" "ACL for"
26420 .cindex "EXPN" "ACL for"
26421 .cindex "HELO" "ACL for"
26422 .cindex "EHLO" "ACL for"
26423 .cindex "MAIL" "ACL for"
26424 .cindex "QUIT, ACL for"
26425 .cindex "RCPT" "ACL for"
26426 .cindex "STARTTLS, ACL for"
26427 .cindex "VRFY" "ACL for"
26428 .cindex "SMTP" "connection, ACL for"
26429 .cindex "non-SMTP messages" "ACLs for"
26430 .cindex "MIME content scanning" "ACL for"
26431
26432 .table2 140pt
26433 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26434 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26435 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26436 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26437 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26438 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26439 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26440 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26441 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26442 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26443 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26444 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26445 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26446 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26447 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26448 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26449 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26450 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26451 .endtable
26452
26453 For example, if you set
26454 .code
26455 acl_smtp_rcpt = small_acl
26456 .endd
26457 the little ACL defined above is used whenever Exim receives a RCPT command
26458 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26459 done when RCPT commands arrive. A rejection of RCPT should cause the
26460 sending MTA to give up on the recipient address contained in the RCPT
26461 command, whereas rejection at other times may cause the client MTA to keep on
26462 trying to deliver the message. It is therefore recommended that you do as much
26463 testing as possible at RCPT time.
26464
26465
26466 .section "The non-SMTP ACLs" "SECID190"
26467 .cindex "non-SMTP messages" "ACLs for"
26468 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26469 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26470 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26471 the state of the SMTP connection such as encryption and authentication) are not
26472 relevant and are forbidden in these ACLs. However, the sender and recipients
26473 are known, so the &%senders%& and &%sender_domains%& conditions and the
26474 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26475 &$authenticated_sender$& are also available. You can specify added header lines
26476 in any of these ACLs.
26477
26478 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26479 non-SMTP message, before any of the message has been read. (This is the
26480 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26481 batched SMTP input, it runs after the DATA command has been reached. The
26482 result of this ACL is ignored; it cannot be used to reject a message. If you
26483 really need to, you could set a value in an ACL variable here and reject based
26484 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26485 controls, and in particular, it can be used to set
26486 .code
26487 control = suppress_local_fixups
26488 .endd
26489 This cannot be used in the other non-SMTP ACLs because by the time they are
26490 run, it is too late.
26491
26492 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26493 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26494
26495 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26496 kind of rejection is treated as permanent, because there is no way of sending a
26497 temporary error for these kinds of message.
26498
26499
26500 .section "The SMTP connect ACL" "SECID191"
26501 .cindex "SMTP" "connection, ACL for"
26502 .oindex &%smtp_banner%&
26503 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26504 session, after the test specified by &%host_reject_connection%& (which is now
26505 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26506 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26507 the message override the banner message that is otherwise specified by the
26508 &%smtp_banner%& option.
26509
26510
26511 .section "The EHLO/HELO ACL" "SECID192"
26512 .cindex "EHLO" "ACL for"
26513 .cindex "HELO" "ACL for"
26514 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26515 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26516 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26517 Note that a client may issue more than one EHLO or HELO command in an SMTP
26518 session, and indeed is required to issue a new EHLO or HELO after successfully
26519 setting up encryption following a STARTTLS command.
26520
26521 If the command is accepted by an &%accept%& verb that has a &%message%&
26522 modifier, the message may not contain more than one line (it will be truncated
26523 at the first newline and a panic logged if it does). Such a message cannot
26524 affect the EHLO options that are listed on the second and subsequent lines of
26525 an EHLO response.
26526
26527
26528 .section "The DATA ACLs" "SECID193"
26529 .cindex "DATA" "ACLs for"
26530 Two ACLs are associated with the DATA command, because it is two-stage
26531 command, with two responses being sent to the client.
26532 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26533 is obeyed. This gives you control after all the RCPT commands, but before
26534 the message itself is received. It offers the opportunity to give a negative
26535 response to the DATA command before the data is transmitted. Header lines
26536 added by MAIL or RCPT ACLs are not visible at this time, but any that
26537 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26538
26539 You cannot test the contents of the message, for example, to verify addresses
26540 in the headers, at RCPT time or when the DATA command is received. Such
26541 tests have to appear in the ACL that is run after the message itself has been
26542 received, before the final response to the DATA command is sent. This is
26543 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26544 associated with the DATA command.
26545
26546 For both of these ACLs, it is not possible to reject individual recipients. An
26547 error response rejects the entire message. Unfortunately, it is known that some
26548 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26549 before or after the data) correctly &-- they keep the message on their queues
26550 and try again later, but that is their problem, though it does waste some of
26551 your resources.
26552
26553 The &%acl_smtp_data%& ACL is run after both the &%acl_smtp_dkim%& and
26554 the &%acl_smtp_mime%& ACLs.
26555
26556 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26557 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26558 enabled (which is the default).
26559
26560 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26561 received, and is executed for each DKIM signature found in a message.  If not
26562 otherwise specified, the default action is to accept.
26563
26564 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
26565
26566 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
26567
26568
26569 .section "The SMTP MIME ACL" "SECID194"
26570 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26571 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26572
26573 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26574
26575
26576 .section "The QUIT ACL" "SECTQUITACL"
26577 .cindex "QUIT, ACL for"
26578 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26579 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26580 does not in fact control any access. For this reason, the only verbs that are
26581 permitted are &%accept%& and &%warn%&.
26582
26583 This ACL can be used for tasks such as custom logging at the end of an SMTP
26584 session. For example, you can use ACL variables in other ACLs to count
26585 messages, recipients, etc., and log the totals at QUIT time using one or
26586 more &%logwrite%& modifiers on a &%warn%& verb.
26587
26588 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26589 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26590
26591 You do not need to have a final &%accept%&, but if you do, you can use a
26592 &%message%& modifier to specify custom text that is sent as part of the 221
26593 response to QUIT.
26594
26595 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26596 failure (for example, failure to open a log file, or when Exim is bombing out
26597 because it has detected an unrecoverable error), all SMTP commands from the
26598 client are given temporary error responses until QUIT is received or the
26599 connection is closed. In these special cases, the QUIT ACL does not run.
26600
26601
26602 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26603 .vindex &$acl_smtp_notquit$&
26604 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26605 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
26606 trouble, such as being unable to write to its log files, this ACL is not run,
26607 because it might try to do things (such as write to log files) that make the
26608 situation even worse.
26609
26610 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26611 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26612 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26613 and &%warn%&.
26614
26615 .vindex &$smtp_notquit_reason$&
26616 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26617 to a string that indicates the reason for the termination of the SMTP
26618 connection. The possible values are:
26619 .table2
26620 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26621 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
26622 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
26623 .irow &`connection-lost`&          "The SMTP connection has been lost"
26624 .irow &`data-timeout`&             "Timeout while reading message data"
26625 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
26626 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
26627 .irow &`signal-exit`&              "SIGTERM or SIGINT"
26628 .irow &`synchronization-error`&    "SMTP synchronization error"
26629 .irow &`tls-failed`&               "TLS failed to start"
26630 .endtable
26631 In most cases when an SMTP connection is closed without having received QUIT,
26632 Exim sends an SMTP response message before actually closing the connection.
26633 With the exception of the &`acl-drop`& case, the default message can be
26634 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
26635 &%drop%& verb in another ACL, it is the message from the other ACL that is
26636 used.
26637
26638
26639 .section "Finding an ACL to use" "SECID195"
26640 .cindex "&ACL;" "finding which to use"
26641 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
26642 you can use different ACLs in different circumstances. For example,
26643 .code
26644 acl_smtp_rcpt = ${if ={25}{$interface_port} \
26645                      {acl_check_rcpt} {acl_check_rcpt_submit} }
26646 .endd
26647 In the default configuration file there are some example settings for
26648 providing an RFC 4409 message submission service on port 587 and a
26649 non-standard &"smtps"& service on port 465. You can use a string
26650 expansion like this to choose an ACL for MUAs on these ports which is
26651 more appropriate for this purpose than the default ACL on port 25.
26652
26653 The expanded string does not have to be the name of an ACL in the
26654 configuration file; there are other possibilities. Having expanded the
26655 string, Exim searches for an ACL as follows:
26656
26657 .ilist
26658 If the string begins with a slash, Exim uses it as a file name, and reads its
26659 contents as an ACL. The lines are processed in the same way as lines in the
26660 Exim configuration file. In particular, continuation lines are supported, blank
26661 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
26662 If the file does not exist or cannot be read, an error occurs (typically
26663 causing a temporary failure of whatever caused the ACL to be run). For example:
26664 .code
26665 acl_smtp_data = /etc/acls/\
26666   ${lookup{$sender_host_address}lsearch\
26667   {/etc/acllist}{$value}{default}}
26668 .endd
26669 This looks up an ACL file to use on the basis of the host's IP address, falling
26670 back to a default if the lookup fails. If an ACL is successfully read from a
26671 file, it is retained in memory for the duration of the Exim process, so that it
26672 can be re-used without having to re-read the file.
26673 .next
26674 If the string does not start with a slash, and does not contain any spaces,
26675 Exim searches the ACL section of the configuration for an ACL whose name
26676 matches the string.
26677 .next
26678 If no named ACL is found, or if the string contains spaces, Exim parses
26679 the string as an inline ACL. This can save typing in cases where you just
26680 want to have something like
26681 .code
26682 acl_smtp_vrfy = accept
26683 .endd
26684 in order to allow free use of the VRFY command. Such a string may contain
26685 newlines; it is processed in the same way as an ACL that is read from a file.
26686 .endlist
26687
26688
26689
26690
26691 .section "ACL return codes" "SECID196"
26692 .cindex "&ACL;" "return codes"
26693 Except for the QUIT ACL, which does not affect the SMTP return code (see
26694 section &<<SECTQUITACL>>& above), the result of running an ACL is either
26695 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
26696 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
26697 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
26698 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
26699 This also causes a 4&'xx'& return code.
26700
26701 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
26702 &"deny"&, because there is no mechanism for passing temporary errors to the
26703 submitters of non-SMTP messages.
26704
26705
26706 ACLs that are relevant to message reception may also return &"discard"&. This
26707 has the effect of &"accept"&, but causes either the entire message or an
26708 individual recipient address to be discarded. In other words, it is a
26709 blackholing facility. Use it with care.
26710
26711 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
26712 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
26713 RCPT ACL is to discard just the one recipient address. If there are no
26714 recipients left when the message's data is received, the DATA ACL is not
26715 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
26716 remaining recipients. The &"discard"& return is not permitted for the
26717 &%acl_smtp_predata%& ACL.
26718
26719
26720 .cindex "&[local_scan()]& function" "when all recipients discarded"
26721 The &[local_scan()]& function is always run, even if there are no remaining
26722 recipients; it may create new recipients.
26723
26724
26725
26726 .section "Unset ACL options" "SECID197"
26727 .cindex "&ACL;" "unset options"
26728 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
26729 all the same. &*Note*&: These defaults apply only when the relevant ACL is
26730 not defined at all. For any defined ACL, the default action when control
26731 reaches the end of the ACL statements is &"deny"&.
26732
26733 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
26734 these two are ACLs that are used only for their side effects. They cannot be
26735 used to accept or reject anything.
26736
26737 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
26738 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
26739 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
26740 when the ACL is not defined is &"accept"&.
26741
26742 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
26743 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
26744 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
26745 messages over an SMTP connection. For an example, see the ACL in the default
26746 configuration file.
26747
26748
26749
26750
26751 .section "Data for message ACLs" "SECID198"
26752 .cindex "&ACL;" "data for message ACL"
26753 .vindex &$domain$&
26754 .vindex &$local_part$&
26755 .vindex &$sender_address$&
26756 .vindex &$sender_host_address$&
26757 .vindex &$smtp_command$&
26758 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
26759 that contain information about the host and the message's sender (for example,
26760 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
26761 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
26762 &$local_part$& are set from the argument address. The entire SMTP command
26763 is available in &$smtp_command$&.
26764
26765 When an ACL for the AUTH parameter of MAIL is running, the variables that
26766 contain information about the host are set, but &$sender_address$& is not yet
26767 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
26768 how it is used.
26769
26770 .vindex "&$message_size$&"
26771 The &$message_size$& variable is set to the value of the SIZE parameter on
26772 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
26773 that parameter is not given. The value is updated to the true message size by
26774 the time the final DATA ACL is run (after the message data has been
26775 received).
26776
26777 .vindex "&$rcpt_count$&"
26778 .vindex "&$recipients_count$&"
26779 The &$rcpt_count$& variable increases by one for each RCPT command received.
26780 The &$recipients_count$& variable increases by one each time a RCPT command is
26781 accepted, so while an ACL for RCPT is being processed, it contains the number
26782 of previously accepted recipients. At DATA time (for both the DATA ACLs),
26783 &$rcpt_count$& contains the total number of RCPT commands, and
26784 &$recipients_count$& contains the total number of accepted recipients.
26785
26786
26787
26788
26789
26790 .section "Data for non-message ACLs" "SECTdatfornon"
26791 .cindex "&ACL;" "data for non-message ACL"
26792 .vindex &$smtp_command_argument$&
26793 .vindex &$smtp_command$&
26794 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
26795 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
26796 and the entire SMTP command is available in &$smtp_command$&.
26797 These variables can be tested using a &%condition%& condition. For example,
26798 here is an ACL for use with AUTH, which insists that either the session is
26799 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
26800 does not permit authentication methods that use cleartext passwords on
26801 unencrypted connections.
26802 .code
26803 acl_check_auth:
26804   accept encrypted = *
26805   accept condition = ${if eq{${uc:$smtp_command_argument}}\
26806                      {CRAM-MD5}}
26807   deny   message   = TLS encryption or CRAM-MD5 required
26808 .endd
26809 (Another way of applying this restriction is to arrange for the authenticators
26810 that use cleartext passwords not to be advertised when the connection is not
26811 encrypted. You can use the generic &%server_advertise_condition%& authenticator
26812 option to do this.)
26813
26814
26815
26816 .section "Format of an ACL" "SECID199"
26817 .cindex "&ACL;" "format of"
26818 .cindex "&ACL;" "verbs, definition of"
26819 An individual ACL consists of a number of statements. Each statement starts
26820 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26821 Modifiers can change the way the verb operates, define error and log messages,
26822 set variables, insert delays, and vary the processing of accepted messages.
26823
26824 If all the conditions are met, the verb is obeyed. The same condition may be
26825 used (with different arguments) more than once in the same statement. This
26826 provides a means of specifying an &"and"& conjunction between conditions. For
26827 example:
26828 .code
26829 deny  dnslists = list1.example
26830 dnslists = list2.example
26831 .endd
26832 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26833 the conditions and modifiers when it reaches a condition that fails. What
26834 happens then depends on the verb (and in one case, on a special modifier). Not
26835 all the conditions make sense at every testing point. For example, you cannot
26836 test a sender address in the ACL that is run for a VRFY command.
26837
26838
26839 .section "ACL verbs" "SECID200"
26840 The ACL verbs are as follows:
26841
26842 .ilist
26843 .cindex "&%accept%& ACL verb"
26844 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26845 of the conditions are not met, what happens depends on whether &%endpass%&
26846 appears among the conditions (for syntax see below). If the failing condition
26847 is before &%endpass%&, control is passed to the next ACL statement; if it is
26848 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26849 check a RCPT command:
26850 .code
26851 accept domains = +local_domains
26852 endpass
26853 verify = recipient
26854 .endd
26855 If the recipient domain does not match the &%domains%& condition, control
26856 passes to the next statement. If it does match, the recipient is verified, and
26857 the command is accepted if verification succeeds. However, if verification
26858 fails, the ACL yields &"deny"&, because the failing condition is after
26859 &%endpass%&.
26860
26861 The &%endpass%& feature has turned out to be confusing to many people, so its
26862 use is not recommended nowadays. It is always possible to rewrite an ACL so
26863 that &%endpass%& is not needed, and it is no longer used in the default
26864 configuration.
26865
26866 .cindex "&%message%& ACL modifier" "with &%accept%&"
26867 If a &%message%& modifier appears on an &%accept%& statement, its action
26868 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26869 (when an &%accept%& verb either accepts or passes control to the next
26870 statement), &%message%& can be used to vary the message that is sent when an
26871 SMTP command is accepted. For example, in a RCPT ACL you could have:
26872 .display
26873 &`accept  `&<&'some conditions'&>
26874 &`        message = OK, I will allow you through today`&
26875 .endd
26876 You can specify an SMTP response code, optionally followed by an &"extended
26877 response code"& at the start of the message, but the first digit must be the
26878 same as would be sent by default, which is 2 for an &%accept%& verb.
26879
26880 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26881 an error message that is used when access is denied. This behaviour is retained
26882 for backward compatibility, but current &"best practice"& is to avoid the use
26883 of &%endpass%&.
26884
26885
26886 .next
26887 .cindex "&%defer%& ACL verb"
26888 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26889 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26890 &%defer%& is the same as &%deny%&, because there is no way of sending a
26891 temporary error. For a RCPT command, &%defer%& is much the same as using a
26892 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26893 be used in any ACL, and even for a recipient it might be a simpler approach.
26894
26895
26896 .next
26897 .cindex "&%deny%& ACL verb"
26898 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26899 the conditions are not met, control is passed to the next ACL statement. For
26900 example,
26901 .code
26902 deny dnslists = blackholes.mail-abuse.org
26903 .endd
26904 rejects commands from hosts that are on a DNS black list.
26905
26906
26907 .next
26908 .cindex "&%discard%& ACL verb"
26909 &%discard%&: This verb behaves like &%accept%&, except that it returns
26910 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26911 that are concerned with receiving messages. When all the conditions are true,
26912 the sending entity receives a &"success"& response. However, &%discard%& causes
26913 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26914 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26915 message's recipients are discarded. Recipients that are discarded before DATA
26916 do not appear in the log line when the &%received_recipients%& log selector is set.
26917
26918 If the &%log_message%& modifier is set when &%discard%& operates,
26919 its contents are added to the line that is automatically written to the log.
26920 The &%message%& modifier operates exactly as it does for &%accept%&.
26921
26922
26923 .next
26924 .cindex "&%drop%& ACL verb"
26925 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26926 forcibly closed after the 5&'xx'& error message has been sent. For example:
26927 .code
26928 drop   message   = I don't take more than 20 RCPTs
26929        condition = ${if > {$rcpt_count}{20}}
26930 .endd
26931 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26932 The connection is always dropped after sending a 550 response.
26933
26934 .next
26935 .cindex "&%require%& ACL verb"
26936 &%require%&: If all the conditions are met, control is passed to the next ACL
26937 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26938 example, when checking a RCPT command,
26939 .code
26940 require message = Sender did not verify
26941         verify  = sender
26942 .endd
26943 passes control to subsequent statements only if the message's sender can be
26944 verified. Otherwise, it rejects the command. Note the positioning of the
26945 &%message%& modifier, before the &%verify%& condition. The reason for this is
26946 discussed in section &<<SECTcondmodproc>>&.
26947
26948 .next
26949 .cindex "&%warn%& ACL verb"
26950 &%warn%&: If all the conditions are true, a line specified by the
26951 &%log_message%& modifier is written to Exim's main log. Control always passes
26952 to the next ACL statement. If any condition is false, the log line is not
26953 written. If an identical log line is requested several times in the same
26954 message, only one copy is actually written to the log. If you want to force
26955 duplicates to be written, use the &%logwrite%& modifier instead.
26956
26957 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26958 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26959 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
26960 first failing condition. There is more about adding header lines in section
26961 &<<SECTaddheadacl>>&.
26962
26963 If any condition on a &%warn%& statement cannot be completed (that is, there is
26964 some sort of defer), the log line specified by &%log_message%& is not written.
26965 This does not include the case of a forced failure from a lookup, which
26966 is considered to be a successful completion. After a defer, no further
26967 conditions or modifiers in the &%warn%& statement are processed. The incident
26968 is logged, and the ACL continues to be processed, from the next statement
26969 onwards.
26970
26971
26972 .vindex "&$acl_verify_message$&"
26973 When one of the &%warn%& conditions is an address verification that fails, the
26974 text of the verification failure message is in &$acl_verify_message$&. If you
26975 want this logged, you must set it up explicitly. For example:
26976 .code
26977 warn   !verify = sender
26978        log_message = sender verify failed: $acl_verify_message
26979 .endd
26980 .endlist
26981
26982 At the end of each ACL there is an implicit unconditional &%deny%&.
26983
26984 As you can see from the examples above, the conditions and modifiers are
26985 written one to a line, with the first one on the same line as the verb, and
26986 subsequent ones on following lines. If you have a very long condition, you can
26987 continue it onto several physical lines by the usual backslash continuation
26988 mechanism. It is conventional to align the conditions vertically.
26989
26990
26991
26992 .section "ACL variables" "SECTaclvariables"
26993 .cindex "&ACL;" "variables"
26994 There are some special variables that can be set during ACL processing. They
26995 can be used to pass information between different ACLs, different invocations
26996 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26997 transports, and filters that are used to deliver a message. The names of these
26998 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26999 an underscore, but the remainder of the name can be any sequence of
27000 alphanumeric characters and underscores that you choose. There is no limit on
27001 the number of ACL variables. The two sets act as follows:
27002 .ilist
27003 The values of those variables whose names begin with &$acl_c$& persist
27004 throughout an SMTP connection. They are never reset. Thus, a value that is set
27005 while receiving one message is still available when receiving the next message
27006 on the same SMTP connection.
27007 .next
27008 The values of those variables whose names begin with &$acl_m$& persist only
27009 while a message is being received. They are reset afterwards. They are also
27010 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27011 .endlist
27012
27013 When a message is accepted, the current values of all the ACL variables are
27014 preserved with the message and are subsequently made available at delivery
27015 time. The ACL variables are set by a modifier called &%set%&. For example:
27016 .code
27017 accept hosts = whatever
27018        set acl_m4 = some value
27019 accept authenticated = *
27020        set acl_c_auth = yes
27021 .endd
27022 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27023 be set. If you want to set a variable without taking any action, you can use a
27024 &%warn%& verb without any other modifiers or conditions.
27025
27026 .oindex &%strict_acl_vars%&
27027 What happens if a syntactically valid but undefined ACL variable is
27028 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27029 false (the default), an empty string is substituted; if it is true, an
27030 error is generated.
27031
27032 Versions of Exim before 4.64 have a limited set of numbered variables, but
27033 their names are compatible, so there is no problem with upgrading.
27034
27035
27036 .section "Condition and modifier processing" "SECTcondmodproc"
27037 .cindex "&ACL;" "conditions; processing"
27038 .cindex "&ACL;" "modifiers; processing"
27039 An exclamation mark preceding a condition negates its result. For example:
27040 .code
27041 deny   domains = *.dom.example
27042       !verify  = recipient
27043 .endd
27044 causes the ACL to return &"deny"& if the recipient domain ends in
27045 &'dom.example'& and the recipient address cannot be verified. Sometimes
27046 negation can be used on the right-hand side of a condition. For example, these
27047 two statements are equivalent:
27048 .code
27049 deny  hosts = !192.168.3.4
27050 deny !hosts =  192.168.3.4
27051 .endd
27052 However, for many conditions (&%verify%& being a good example), only left-hand
27053 side negation of the whole condition is possible.
27054
27055 The arguments of conditions and modifiers are expanded. A forced failure
27056 of an expansion causes a condition to be ignored, that is, it behaves as if the
27057 condition is true. Consider these two statements:
27058 .code
27059 accept  senders = ${lookup{$host_name}lsearch\
27060                   {/some/file}{$value}fail}
27061 accept  senders = ${lookup{$host_name}lsearch\
27062                   {/some/file}{$value}{}}
27063 .endd
27064 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27065 the returned list is searched, but if the lookup fails the behaviour is
27066 different in the two cases. The &%fail%& in the first statement causes the
27067 condition to be ignored, leaving no further conditions. The &%accept%& verb
27068 therefore succeeds. The second statement, however, generates an empty list when
27069 the lookup fails. No sender can match an empty list, so the condition fails,
27070 and therefore the &%accept%& also fails.
27071
27072 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27073 specify actions that are taken as the conditions for a statement are checked;
27074 others specify text for messages that are used when access is denied or a
27075 warning is generated. The &%control%& modifier affects the way an incoming
27076 message is handled.
27077
27078 The positioning of the modifiers in an ACL statement is important, because the
27079 processing of a verb ceases as soon as its outcome is known. Only those
27080 modifiers that have already been encountered will take effect. For example,
27081 consider this use of the &%message%& modifier:
27082 .code
27083 require message = Can't verify sender
27084         verify  = sender
27085         message = Can't verify recipient
27086         verify  = recipient
27087         message = This message cannot be used
27088 .endd
27089 If sender verification fails, Exim knows that the result of the statement is
27090 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27091 so its text is used as the error message. If sender verification succeeds, but
27092 recipient verification fails, the second message is used. If recipient
27093 verification succeeds, the third message becomes &"current"&, but is never used
27094 because there are no more conditions to cause failure.
27095
27096 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27097 modifier that is used, because all the conditions must be true for rejection to
27098 happen. Specifying more than one &%message%& modifier does not make sense, and
27099 the message can even be specified after all the conditions. For example:
27100 .code
27101 deny   hosts = ...
27102       !senders = *@my.domain.example
27103        message = Invalid sender from client host
27104 .endd
27105 The &"deny"& result does not happen until the end of the statement is reached,
27106 by which time Exim has set up the message.
27107
27108
27109
27110 .section "ACL modifiers" "SECTACLmodi"
27111 .cindex "&ACL;" "modifiers; list of"
27112 The ACL modifiers are as follows:
27113
27114 .vlist
27115 .vitem &*add_header*&&~=&~<&'text'&>
27116 This modifier specifies one or more header lines that are to be added to an
27117 incoming message, assuming, of course, that the message is ultimately
27118 accepted. For details, see section &<<SECTaddheadacl>>&.
27119
27120 .vitem &*continue*&&~=&~<&'text'&>
27121 .cindex "&%continue%& ACL modifier"
27122 .cindex "database" "updating in ACL"
27123 This modifier does nothing of itself, and processing of the ACL always
27124 continues with the next condition or modifier. The value of &%continue%& is in
27125 the side effects of expanding its argument. Typically this could be used to
27126 update a database. It is really just a syntactic tidiness, to avoid having to
27127 write rather ugly lines like this:
27128 .display
27129 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27130 .endd
27131 Instead, all you need is
27132 .display
27133 &`continue = `&<&'some expansion'&>
27134 .endd
27135
27136 .vitem &*control*&&~=&~<&'text'&>
27137 .cindex "&%control%& ACL modifier"
27138 This modifier affects the subsequent processing of the SMTP connection or of an
27139 incoming message that is accepted. The effect of the first type of control
27140 lasts for the duration of the connection, whereas the effect of the second type
27141 lasts only until the current message has been received. The message-specific
27142 controls always apply to the whole message, not to individual recipients,
27143 even if the &%control%& modifier appears in a RCPT ACL.
27144
27145 As there are now quite a few controls that can be applied, they are described
27146 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27147 in several different ways. For example:
27148
27149 . ==== As this is a nested list, any displays it contains must be indented
27150 . ==== as otherwise they are too far to the left. That comment applies only
27151 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27152 . ==== way.
27153
27154 .ilist
27155 It can be at the end of an &%accept%& statement:
27156 .code
27157     accept  ...some conditions
27158             control = queue_only
27159 .endd
27160 In this case, the control is applied when this statement yields &"accept"&, in
27161 other words, when the conditions are all true.
27162
27163 .next
27164 It can be in the middle of an &%accept%& statement:
27165 .code
27166     accept  ...some conditions...
27167             control = queue_only
27168             ...some more conditions...
27169 .endd
27170 If the first set of conditions are true, the control is applied, even if the
27171 statement does not accept because one of the second set of conditions is false.
27172 In this case, some subsequent statement must yield &"accept"& for the control
27173 to be relevant.
27174
27175 .next
27176 It can be used with &%warn%& to apply the control, leaving the
27177 decision about accepting or denying to a subsequent verb. For
27178 example:
27179 .code
27180     warn    ...some conditions...
27181             control = freeze
27182     accept  ...
27183 .endd
27184 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27185 &%logwrite%&, so it does not add anything to the message and does not write a
27186 log entry.
27187
27188 .next
27189 If you want to apply a control unconditionally, you can use it with a
27190 &%require%& verb. For example:
27191 .code
27192     require  control = no_multiline_responses
27193 .endd
27194 .endlist
27195
27196 .vitem &*delay*&&~=&~<&'time'&>
27197 .cindex "&%delay%& ACL modifier"
27198 .oindex "&%-bh%&"
27199 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27200 the time interval before proceeding. However, when testing Exim using the
27201 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27202 output instead). The time is given in the usual Exim notation, and the delay
27203 happens as soon as the modifier is processed. In an SMTP session, pending
27204 output is flushed before the delay is imposed.
27205
27206 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27207 example:
27208 .code
27209 deny    ...some conditions...
27210         delay = 30s
27211 .endd
27212 The delay happens if all the conditions are true, before the statement returns
27213 &"deny"&. Compare this with:
27214 .code
27215 deny    delay = 30s
27216         ...some conditions...
27217 .endd
27218 which waits for 30s before processing the conditions. The &%delay%& modifier
27219 can also be used with &%warn%& and together with &%control%&:
27220 .code
27221 warn    ...some conditions...
27222         delay = 2m
27223         control = freeze
27224 accept  ...
27225 .endd
27226
27227 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27228 responses to several commands are no longer buffered and sent in one packet (as
27229 they would normally be) because all output is flushed before imposing the
27230 delay. This optimization is disabled so that a number of small delays do not
27231 appear to the client as one large aggregated delay that might provoke an
27232 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27233 using a &%control%& modifier to set &%no_delay_flush%&.
27234
27235
27236 .vitem &*endpass*&
27237 .cindex "&%endpass%& ACL modifier"
27238 This modifier, which has no argument, is recognized only in &%accept%& and
27239 &%discard%& statements. It marks the boundary between the conditions whose
27240 failure causes control to pass to the next statement, and the conditions whose
27241 failure causes the ACL to return &"deny"&. This concept has proved to be
27242 confusing to some people, so the use of &%endpass%& is no longer recommended as
27243 &"best practice"&. See the description of &%accept%& above for more details.
27244
27245
27246 .vitem &*log_message*&&~=&~<&'text'&>
27247 .cindex "&%log_message%& ACL modifier"
27248 This modifier sets up a message that is used as part of the log message if the
27249 ACL denies access or a &%warn%& statement's conditions are true. For example:
27250 .code
27251 require log_message = wrong cipher suite $tls_in_cipher
27252         encrypted   = DES-CBC3-SHA
27253 .endd
27254 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27255 example:
27256 .display
27257 &`discard `&<&'some conditions'&>
27258 &`        log_message = Discarded $local_part@$domain because...`&
27259 .endd
27260 When access is denied, &%log_message%& adds to any underlying error message
27261 that may exist because of a condition failure. For example, while verifying a
27262 recipient address, a &':fail:'& redirection might have already set up a
27263 message.
27264
27265 The message may be defined before the conditions to which it applies, because
27266 the string expansion does not happen until Exim decides that access is to be
27267 denied. This means that any variables that are set by the condition are
27268 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27269 variables are set after a DNS black list lookup succeeds. If the expansion of
27270 &%log_message%& fails, or if the result is an empty string, the modifier is
27271 ignored.
27272
27273 .vindex "&$acl_verify_message$&"
27274 If you want to use a &%warn%& statement to log the result of an address
27275 verification, you can use &$acl_verify_message$& to include the verification
27276 error message.
27277
27278 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27279 the start of the logged message. If the same warning log message is requested
27280 more than once while receiving  a single email message, only one copy is
27281 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27282 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27283 is logged for a successful &%warn%& statement.
27284
27285 If &%log_message%& is not present and there is no underlying error message (for
27286 example, from the failure of address verification), but &%message%& is present,
27287 the &%message%& text is used for logging rejections. However, if any text for
27288 logging contains newlines, only the first line is logged. In the absence of
27289 both &%log_message%& and &%message%&, a default built-in message is used for
27290 logging rejections.
27291
27292
27293 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27294 .cindex "&%log_reject_target%& ACL modifier"
27295 .cindex "logging in ACL" "specifying which log"
27296 This modifier makes it possible to specify which logs are used for messages
27297 about ACL rejections. Its argument is a colon-separated list of words that can
27298 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27299 may be empty, in which case a rejection is not logged at all. For example, this
27300 ACL fragment writes no logging information when access is denied:
27301 .display
27302 &`deny `&<&'some conditions'&>
27303 &`     log_reject_target =`&
27304 .endd
27305 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27306 permanent and temporary rejections. Its effect lasts for the rest of the
27307 current ACL.
27308
27309
27310 .vitem &*logwrite*&&~=&~<&'text'&>
27311 .cindex "&%logwrite%& ACL modifier"
27312 .cindex "logging in ACL" "immediate"
27313 This modifier writes a message to a log file as soon as it is encountered when
27314 processing an ACL. (Compare &%log_message%&, which, except in the case of
27315 &%warn%& and &%discard%&, is used only if the ACL statement denies
27316 access.) The &%logwrite%& modifier can be used to log special incidents in
27317 ACLs. For example:
27318 .display
27319 &`accept `&<&'some special conditions'&>
27320 &`       control  = freeze`&
27321 &`       logwrite = froze message because ...`&
27322 .endd
27323 By default, the message is written to the main log. However, it may begin
27324 with a colon, followed by a comma-separated list of log names, and then
27325 another colon, to specify exactly which logs are to be written. For
27326 example:
27327 .code
27328 logwrite = :main,reject: text for main and reject logs
27329 logwrite = :panic: text for panic log only
27330 .endd
27331
27332
27333 .vitem &*message*&&~=&~<&'text'&>
27334 .cindex "&%message%& ACL modifier"
27335 This modifier sets up a text string that is expanded and used as a response
27336 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27337 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27338 there is some complication if &%endpass%& is involved; see the description of
27339 &%accept%& for details.)
27340
27341 The expansion of the message happens at the time Exim decides that the ACL is
27342 to end, not at the time it processes &%message%&. If the expansion fails, or
27343 generates an empty string, the modifier is ignored. Here is an example where
27344 &%message%& must be specified first, because the ACL ends with a rejection if
27345 the &%hosts%& condition fails:
27346 .code
27347 require  message = Host not recognized
27348          hosts = 10.0.0.0/8
27349 .endd
27350 (Once a condition has failed, no further conditions or modifiers are
27351 processed.)
27352
27353 .cindex "SMTP" "error codes"
27354 .oindex "&%smtp_banner%&
27355 For ACLs that are triggered by SMTP commands, the message is returned as part
27356 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27357 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27358 is accepted. In the case of the connect ACL, accepting with a message modifier
27359 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27360 accept message may not contain more than one line (otherwise it will be
27361 truncated at the first newline and a panic logged), and it cannot affect the
27362 EHLO options.
27363
27364 When SMTP is involved, the message may begin with an overriding response code,
27365 consisting of three digits optionally followed by an &"extended response code"&
27366 of the form &'n.n.n'&, each code being followed by a space. For example:
27367 .code
27368 deny  message = 599 1.2.3 Host not welcome
27369       hosts = 192.168.34.0/24
27370 .endd
27371 The first digit of the supplied response code must be the same as would be sent
27372 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27373 access, but for the predata ACL, note that the default success code is 354, not
27374 2&'xx'&.
27375
27376 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27377 the message modifier cannot override the 221 response code.
27378
27379 The text in a &%message%& modifier is literal; any quotes are taken as
27380 literals, but because the string is expanded, backslash escapes are processed
27381 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27382 response.
27383
27384 .vindex "&$acl_verify_message$&"
27385 If &%message%& is used on a statement that verifies an address, the message
27386 specified overrides any message that is generated by the verification process.
27387 However, the original message is available in the variable
27388 &$acl_verify_message$&, so you can incorporate it into your message if you
27389 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27390 routers to be passed back as part of the SMTP response, you should either not
27391 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27392
27393 For compatibility with previous releases of Exim, a &%message%& modifier that
27394 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27395 modifier, but this usage is now deprecated. However, &%message%& acts only when
27396 all the conditions are true, wherever it appears in an ACL command, whereas
27397 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27398 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27399 effect.
27400
27401
27402 .vitem &*remove_header*&&~=&~<&'text'&>
27403 This modifier specifies one or more header names in a colon-separated list
27404  that are to be removed from an incoming message, assuming, of course, that
27405 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27406
27407
27408 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27409 .cindex "&%set%& ACL modifier"
27410 This modifier puts a value into one of the ACL variables (see section
27411 &<<SECTaclvariables>>&).
27412
27413
27414 .vitem &*udpsend*&&~=&~<&'parameters'&>
27415 This modifier sends a UDP packet, for purposes such as statistics
27416 collection or behaviour monitoring. The parameters are expanded, and
27417 the result of the expansion must be a colon-separated list consisting
27418 of a destination server, port number, and the packet contents. The
27419 server can be specified as a host name or IPv4 or IPv6 address. The
27420 separator can be changed with the usual angle bracket syntax. For
27421 example, you might want to collect information on which hosts connect
27422 when:
27423 .code
27424 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27425              $tod_zulu $sender_host_address
27426 .endd
27427 .endlist
27428
27429
27430
27431
27432 .section "Use of the control modifier" "SECTcontrols"
27433 .cindex "&%control%& ACL modifier"
27434 The &%control%& modifier supports the following settings:
27435
27436 .vlist
27437 .vitem &*control&~=&~allow_auth_unadvertised*&
27438 This modifier allows a client host to use the SMTP AUTH command even when it
27439 has not been advertised in response to EHLO. Furthermore, because there are
27440 apparently some really broken clients that do this, Exim will accept AUTH after
27441 HELO (rather than EHLO) when this control is set. It should be used only if you
27442 really need it, and you should limit its use to those broken clients that do
27443 not work without it. For example:
27444 .code
27445 warn hosts   = 192.168.34.25
27446      control = allow_auth_unadvertised
27447 .endd
27448 Normally, when an Exim server receives an AUTH command, it checks the name of
27449 the authentication mechanism that is given in the command to ensure that it
27450 matches an advertised mechanism. When this control is set, the check that a
27451 mechanism has been advertised is bypassed. Any configured mechanism can be used
27452 by the client. This control is permitted only in the connection and HELO ACLs.
27453
27454
27455 .vitem &*control&~=&~caseful_local_part*& &&&
27456        &*control&~=&~caselower_local_part*&
27457 .cindex "&ACL;" "case of local part in"
27458 .cindex "case of local parts"
27459 .vindex "&$local_part$&"
27460 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27461 (that is, during RCPT processing). By default, the contents of &$local_part$&
27462 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27463 any uppercase letters in the original local part are restored in &$local_part$&
27464 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27465 is encountered.
27466
27467 These controls affect only the current recipient. Moreover, they apply only to
27468 local part handling that takes place directly in the ACL (for example, as a key
27469 in lookups). If a test to verify the recipient is obeyed, the case-related
27470 handling of the local part during the verification is controlled by the router
27471 configuration (see the &%caseful_local_part%& generic router option).
27472
27473 This facility could be used, for example, to add a spam score to local parts
27474 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27475 spam score:
27476 .code
27477 warn  control = caseful_local_part
27478       set acl_m4 = ${eval:\
27479                      $acl_m4 + \
27480                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27481                     }
27482       control = caselower_local_part
27483 .endd
27484 Notice that we put back the lower cased version afterwards, assuming that
27485 is what is wanted for subsequent tests.
27486
27487
27488 .vitem &*control&~=&~cutthrough_delivery*&
27489 .cindex "&ACL;" "cutthrough routing"
27490 .cindex "cutthrough" "requesting"
27491 This option requests delivery be attempted while the item is being received.
27492 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27493 from one SMTP connection to another.  If a recipient-verify callout connection is
27494 requested in the same ACL it is held open and used for the data, otherwise one is made
27495 after the ACL completes.
27496
27497 Note that routers are used in verify mode,
27498 and cannot depend on content of received headers.
27499 Note also that headers cannot be
27500 modified by any of the post-data ACLs (DATA, MIME and DKIM).
27501 Headers may be modified by routers (subject to the above) and transports.
27502
27503 Cutthrough delivery is not supported via transport-filters or when DKIM signing
27504 of outgoing messages is done, because it sends data to the ultimate destination
27505 before the entire message has been received from the source.
27506
27507 Should the ultimate destination system positively accept or reject the mail,
27508 a corresponding indication is given to the source system and nothing is queued.
27509 If there is a temporary error the item is queued for later delivery in the
27510 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27511 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27512 line.
27513
27514 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27515 sender when the destination system is doing content-scan based rejection.
27516
27517
27518 .vitem &*control&~=&~debug/*&<&'options'&>
27519 .cindex "&ACL;" "enabling debug logging"
27520 .cindex "debugging" "enabling from an ACL"
27521 This control turns on debug logging, almost as though Exim had been invoked
27522 with &`-d`&, with the output going to a new logfile, by default called
27523 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27524 may access any variables already defined.  The logging may be adjusted with
27525 the &'opts'& option, which takes the same values as the &`-d`& command-line
27526 option.  Some examples (which depend on variables that don't exist in all
27527 contexts):
27528 .code
27529       control = debug
27530       control = debug/tag=.$sender_host_address
27531       control = debug/opts=+expand+acl
27532       control = debug/tag=.$message_exim_id/opts=+expand
27533 .endd
27534
27535
27536 .vitem &*control&~=&~dkim_disable_verify*&
27537 .cindex "disable DKIM verify"
27538 .cindex "DKIM" "disable verify"
27539 This control turns off DKIM verification processing entirely.  For details on
27540 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
27541
27542
27543 .vitem &*control&~=&~dscp/*&<&'value'&>
27544 .cindex "&ACL;" "setting DSCP value"
27545 .cindex "DSCP" "inbound"
27546 This option causes the DSCP value associated with the socket for the inbound
27547 connection to be adjusted to a given value, given as one of a number of fixed
27548 strings or to numeric value.
27549 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27550 Common values include &`throughput`&, &`mincost`&, and on newer systems
27551 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27552
27553 The outbound packets from Exim will be marked with this value in the header
27554 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27555 that these values will have any effect, not be stripped by networking
27556 equipment, or do much of anything without cooperation with your Network
27557 Engineer and those of all network operators between the source and destination.
27558
27559
27560 .vitem &*control&~=&~enforce_sync*& &&&
27561        &*control&~=&~no_enforce_sync*&
27562 .cindex "SMTP" "synchronization checking"
27563 .cindex "synchronization checking in SMTP"
27564 These controls make it possible to be selective about when SMTP synchronization
27565 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27566 state of the switch (it is true by default). See the description of this option
27567 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27568
27569 The effect of these two controls lasts for the remainder of the SMTP
27570 connection. They can appear in any ACL except the one for the non-SMTP
27571 messages. The most straightforward place to put them is in the ACL defined by
27572 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27573 before the first synchronization check. The expected use is to turn off the
27574 synchronization checks for badly-behaved hosts that you nevertheless need to
27575 work with.
27576
27577
27578 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27579 .cindex "fake defer"
27580 .cindex "defer, fake"
27581 This control works in exactly the same way as &%fakereject%& (described below)
27582 except that it causes an SMTP 450 response after the message data instead of a
27583 550 response. You must take care when using &%fakedefer%& because it causes the
27584 messages to be duplicated when the sender retries. Therefore, you should not
27585 use &%fakedefer%& if the message is to be delivered normally.
27586
27587 .vitem &*control&~=&~fakereject/*&<&'message'&>
27588 .cindex "fake rejection"
27589 .cindex "rejection, fake"
27590 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27591 words, only when an SMTP message is being received. If Exim accepts the
27592 message, instead the final 250 response, a 550 rejection message is sent.
27593 However, Exim proceeds to deliver the message as normal. The control applies
27594 only to the current message, not to any subsequent ones that may be received in
27595 the same SMTP connection.
27596
27597 The text for the 550 response is taken from the &%control%& modifier. If no
27598 message is supplied, the following is used:
27599 .code
27600 550-Your message has been rejected but is being
27601 550-kept for evaluation.
27602 550-If it was a legitimate message, it may still be
27603 550 delivered to the target recipient(s).
27604 .endd
27605 This facility should be used with extreme caution.
27606
27607 .vitem &*control&~=&~freeze*&
27608 .cindex "frozen messages" "forcing in ACL"
27609 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27610 other words, only when a message is being received. If the message is accepted,
27611 it is placed on Exim's queue and frozen. The control applies only to the
27612 current message, not to any subsequent ones that may be received in the same
27613 SMTP connection.
27614
27615 This modifier can optionally be followed by &`/no_tell`&. If the global option
27616 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
27617 is told about the freezing), provided all the &*control=freeze*& modifiers that
27618 are obeyed for the current message have the &`/no_tell`& option.
27619
27620 .vitem &*control&~=&~no_delay_flush*&
27621 .cindex "SMTP" "output flushing, disabling for delay"
27622 Exim normally flushes SMTP output before implementing a delay in an ACL, to
27623 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27624 use. This control, as long as it is encountered before the &%delay%& modifier,
27625 disables such output flushing.
27626
27627 .vitem &*control&~=&~no_callout_flush*&
27628 .cindex "SMTP" "output flushing, disabling for callout"
27629 Exim normally flushes SMTP output before performing a callout in an ACL, to
27630 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27631 use. This control, as long as it is encountered before the &%verify%& condition
27632 that causes the callout, disables such output flushing.
27633
27634 .vitem &*control&~=&~no_mbox_unspool*&
27635 This control is available when Exim is compiled with the content scanning
27636 extension. Content scanning may require a copy of the current message, or parts
27637 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
27638 or spam scanner. Normally, such copies are deleted when they are no longer
27639 needed. If this control is set, the copies are not deleted. The control applies
27640 only to the current message, not to any subsequent ones that may be received in
27641 the same SMTP connection. It is provided for debugging purposes and is unlikely
27642 to be useful in production.
27643
27644 .vitem &*control&~=&~no_multiline_responses*&
27645 .cindex "multiline responses, suppressing"
27646 This control is permitted for any ACL except the one for non-SMTP messages.
27647 It seems that there are broken clients in use that cannot handle multiline
27648 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
27649
27650 If this control is set, multiline SMTP responses from ACL rejections are
27651 suppressed. One way of doing this would have been to put out these responses as
27652 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
27653 (&"use multiline responses for more"& it says &-- ha!), and some of the
27654 responses might get close to that. So this facility, which is after all only a
27655 sop to broken clients, is implemented by doing two very easy things:
27656
27657 .ilist
27658 Extra information that is normally output as part of a rejection caused by
27659 sender verification failure is omitted. Only the final line (typically &"sender
27660 verification failed"&) is sent.
27661 .next
27662 If a &%message%& modifier supplies a multiline response, only the first
27663 line is output.
27664 .endlist
27665
27666 The setting of the switch can, of course, be made conditional on the
27667 calling host. Its effect lasts until the end of the SMTP connection.
27668
27669 .vitem &*control&~=&~no_pipelining*&
27670 .cindex "PIPELINING" "suppressing advertising"
27671 This control turns off the advertising of the PIPELINING extension to SMTP in
27672 the current session. To be useful, it must be obeyed before Exim sends its
27673 response to an EHLO command. Therefore, it should normally appear in an ACL
27674 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
27675 &%pipelining_advertise_hosts%&.
27676
27677 .vitem &*control&~=&~queue_only*&
27678 .oindex "&%queue_only%&"
27679 .cindex "queueing incoming messages"
27680 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27681 other words, only when a message is being received. If the message is accepted,
27682 it is placed on Exim's queue and left there for delivery by a subsequent queue
27683 runner. No immediate delivery process is started. In other words, it has the
27684 effect as the &%queue_only%& global option. However, the control applies only
27685 to the current message, not to any subsequent ones that may be received in the
27686 same SMTP connection.
27687
27688 .vitem &*control&~=&~submission/*&<&'options'&>
27689 .cindex "message" "submission"
27690 .cindex "submission mode"
27691 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
27692 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
27693 the current message is a submission from a local MUA. In this case, Exim
27694 operates in &"submission mode"&, and applies certain fixups to the message if
27695 necessary. For example, it adds a &'Date:'& header line if one is not present.
27696 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
27697 late (the message has already been created).
27698
27699 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
27700 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
27701 submission mode; the available options for this control are described there.
27702 The control applies only to the current message, not to any subsequent ones
27703 that may be received in the same SMTP connection.
27704
27705 .vitem &*control&~=&~suppress_local_fixups*&
27706 .cindex "submission fixups, suppressing"
27707 This control applies to locally submitted (non TCP/IP) messages, and is the
27708 complement of &`control = submission`&. It disables the fixups that are
27709 normally applied to locally-submitted messages. Specifically:
27710
27711 .ilist
27712 Any &'Sender:'& header line is left alone (in this respect, it is a
27713 dynamic version of &%local_sender_retain%&).
27714 .next
27715 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
27716 .next
27717 There is no check that &'From:'& corresponds to the actual sender.
27718 .endlist ilist
27719
27720 This control may be useful when a remotely-originated message is accepted,
27721 passed to some scanning program, and then re-submitted for delivery. It can be
27722 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27723 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
27724 data is read.
27725
27726 &*Note:*& This control applies only to the current message, not to any others
27727 that are being submitted at the same time using &%-bs%& or &%-bS%&.
27728 .endlist vlist
27729
27730
27731 .section "Summary of message fixup control" "SECTsummesfix"
27732 All four possibilities for message fixups can be specified:
27733
27734 .ilist
27735 Locally submitted, fixups applied: the default.
27736 .next
27737 Locally submitted, no fixups applied: use
27738 &`control = suppress_local_fixups`&.
27739 .next
27740 Remotely submitted, no fixups applied: the default.
27741 .next
27742 Remotely submitted, fixups applied: use &`control = submission`&.
27743 .endlist
27744
27745
27746
27747 .section "Adding header lines in ACLs" "SECTaddheadacl"
27748 .cindex "header lines" "adding in an ACL"
27749 .cindex "header lines" "position of added lines"
27750 .cindex "&%add_header%& ACL modifier"
27751 The &%add_header%& modifier can be used to add one or more extra header lines
27752 to an incoming message, as in this example:
27753 .code
27754 warn dnslists = sbl.spamhaus.org : \
27755                 dialup.mail-abuse.org
27756      add_header = X-blacklisted-at: $dnslist_domain
27757 .endd
27758 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27759 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
27760 receiving a message). The message must ultimately be accepted for
27761 &%add_header%& to have any significant effect. You can use &%add_header%& with
27762 any ACL verb, including &%deny%& (though this is potentially useful only in a
27763 RCPT ACL).
27764
27765 Headers will not be added to the message if the modifier is used in
27766 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
27767
27768 Leading and trailing newlines are removed from
27769 the data for the &%add_header%& modifier; if it then
27770 contains one or more newlines that
27771 are not followed by a space or a tab, it is assumed to contain multiple header
27772 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
27773 front of any line that is not a valid header line.
27774
27775 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27776 They are added to the message before processing the DATA and MIME ACLs.
27777 However, if an identical header line is requested more than once, only one copy
27778 is actually added to the message. Further header lines may be accumulated
27779 during the DATA and MIME ACLs, after which they are added to the message, again
27780 with duplicates suppressed. Thus, it is possible to add two identical header
27781 lines to an SMTP message, but only if one is added before DATA and one after.
27782 In the case of non-SMTP messages, new headers are accumulated during the
27783 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
27784 message is rejected after DATA or by the non-SMTP ACL, all added header lines
27785 are included in the entry that is written to the reject log.
27786
27787 .cindex "header lines" "added; visibility of"
27788 Header lines are not visible in string expansions
27789 of message headers
27790 until they are added to the
27791 message. It follows that header lines defined in the MAIL, RCPT, and predata
27792 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
27793 header lines that are added by the DATA or MIME ACLs are not visible in those
27794 ACLs. Because of this restriction, you cannot use header lines as a way of
27795 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
27796 this, you can use ACL variables, as described in section
27797 &<<SECTaclvariables>>&.
27798
27799 The list of headers yet to be added is given by the &%$headers_added%& variable.
27800
27801 The &%add_header%& modifier acts immediately as it is encountered during the
27802 processing of an ACL. Notice the difference between these two cases:
27803 .display
27804 &`accept add_header = ADDED: some text`&
27805 &`       `&<&'some condition'&>
27806
27807 &`accept `&<&'some condition'&>
27808 &`       add_header = ADDED: some text`&
27809 .endd
27810 In the first case, the header line is always added, whether or not the
27811 condition is true. In the second case, the header line is added only if the
27812 condition is true. Multiple occurrences of &%add_header%& may occur in the same
27813 ACL statement. All those that are encountered before a condition fails are
27814 honoured.
27815
27816 .cindex "&%warn%& ACL verb"
27817 For compatibility with previous versions of Exim, a &%message%& modifier for a
27818 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
27819 effect only if all the conditions are true, even if it appears before some of
27820 them. Furthermore, only the last occurrence of &%message%& is honoured. This
27821 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
27822 are present on a &%warn%& verb, both are processed according to their
27823 specifications.
27824
27825 By default, new header lines are added to a message at the end of the existing
27826 header lines. However, you can specify that any particular header line should
27827 be added right at the start (before all the &'Received:'& lines), immediately
27828 after the first block of &'Received:'& lines, or immediately before any line
27829 that is not a &'Received:'& or &'Resent-something:'& header.
27830
27831 This is done by specifying &":at_start:"&, &":after_received:"&, or
27832 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
27833 header line, respectively. (Header text cannot start with a colon, as there has
27834 to be a header name first.) For example:
27835 .code
27836 warn add_header = \
27837        :after_received:X-My-Header: something or other...
27838 .endd
27839 If more than one header line is supplied in a single &%add_header%& modifier,
27840 each one is treated independently and can therefore be placed differently. If
27841 you add more than one line at the start, or after the Received: block, they end
27842 up in reverse order.
27843
27844 &*Warning*&: This facility currently applies only to header lines that are
27845 added in an ACL. It does NOT work for header lines that are added in a
27846 system filter or in a router or transport.
27847
27848
27849
27850 .section "Removing header lines in ACLs" "SECTremoveheadacl"
27851 .cindex "header lines" "removing in an ACL"
27852 .cindex "header lines" "position of removed lines"
27853 .cindex "&%remove_header%& ACL modifier"
27854 The &%remove_header%& modifier can be used to remove one or more header lines
27855 from an incoming message, as in this example:
27856 .code
27857 warn   message        = Remove internal headers
27858        remove_header  = x-route-mail1 : x-route-mail2
27859 .endd
27860 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27861 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
27862 receiving a message). The message must ultimately be accepted for
27863 &%remove_header%& to have any significant effect. You can use &%remove_header%&
27864 with any ACL verb, including &%deny%&, though this is really not useful for
27865 any verb that doesn't result in a delivered message.
27866
27867 Headers will not be removed to the message if the modifier is used in
27868 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
27869
27870 More than one header can be removed at the same time by using a colon separated
27871 list of header names. The header matching is case insensitive. Wildcards are
27872 not permitted, nor is list expansion performed, so you cannot use hostlists to
27873 create a list of headers, however both connection and message variable expansion
27874 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
27875 .code
27876 warn   hosts           = +internal_hosts
27877        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
27878 warn   message         = Remove internal headers
27879        remove_header   = $acl_c_ihdrs
27880 .endd
27881 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27882 They are removed from the message before processing the DATA and MIME ACLs.
27883 There is no harm in attempting to remove the same header twice nor is removing
27884 a non-existent header. Further header lines to be removed may be accumulated
27885 during the DATA and MIME ACLs, after which they are removed from the message,
27886 if present. In the case of non-SMTP messages, headers to be removed are
27887 accumulated during the non-SMTP ACLs, and are removed from the message after
27888 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
27889 ACL, there really is no effect because there is no logging of what headers
27890 would have been removed.
27891
27892 .cindex "header lines" "removed; visibility of"
27893 Header lines are not visible in string expansions until the DATA phase when it
27894 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
27895 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
27896 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
27897 this restriction, you cannot use header lines as a way of controlling data
27898 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
27899 you should instead use ACL variables, as described in section
27900 &<<SECTaclvariables>>&.
27901
27902 The &%remove_header%& modifier acts immediately as it is encountered during the
27903 processing of an ACL. Notice the difference between these two cases:
27904 .display
27905 &`accept remove_header = X-Internal`&
27906 &`       `&<&'some condition'&>
27907
27908 &`accept `&<&'some condition'&>
27909 &`       remove_header = X-Internal`&
27910 .endd
27911 In the first case, the header line is always removed, whether or not the
27912 condition is true. In the second case, the header line is removed only if the
27913 condition is true. Multiple occurrences of &%remove_header%& may occur in the
27914 same ACL statement. All those that are encountered before a condition fails
27915 are honoured.
27916
27917 &*Warning*&: This facility currently applies only to header lines that are
27918 present during ACL processing. It does NOT remove header lines that are added
27919 in a system filter or in a router or transport.
27920
27921
27922
27923
27924 .section "ACL conditions" "SECTaclconditions"
27925 .cindex "&ACL;" "conditions; list of"
27926 Some of the conditions listed in this section are available only when Exim is
27927 compiled with the content-scanning extension. They are included here briefly
27928 for completeness. More detailed descriptions can be found in the discussion on
27929 content scanning in chapter &<<CHAPexiscan>>&.
27930
27931 Not all conditions are relevant in all circumstances. For example, testing
27932 senders and recipients does not make sense in an ACL that is being run as the
27933 result of the arrival of an ETRN command, and checks on message headers can be
27934 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
27935 can use the same condition (with different parameters) more than once in the
27936 same ACL statement. This provides a way of specifying an &"and"& conjunction.
27937 The conditions are as follows:
27938
27939
27940 .vlist
27941 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
27942 .cindex "&ACL;" "nested"
27943 .cindex "&ACL;" "indirect"
27944 .cindex "&ACL;" "arguments"
27945 .cindex "&%acl%& ACL condition"
27946 The possible values of the argument are the same as for the
27947 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
27948 &"accept"& the condition is true; if it returns &"deny"& the condition is
27949 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
27950 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
27951 condition false. This means that further processing of the &%warn%& verb
27952 ceases, but processing of the ACL continues.
27953
27954 If the argument is a named ACL, up to nine space-separated optional values
27955 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
27956 and $acl_narg is set to the count of values.
27957 Previous values of these variables are restored after the call returns.
27958 The name and values are expanded separately.
27959
27960 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
27961 the connection is dropped. If it returns &"discard"&, the verb must be
27962 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
27963 conditions are tested.
27964
27965 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
27966 loops. This condition allows you to use different ACLs in different
27967 circumstances. For example, different ACLs can be used to handle RCPT commands
27968 for different local users or different local domains.
27969
27970 .vitem &*authenticated&~=&~*&<&'string&~list'&>
27971 .cindex "&%authenticated%& ACL condition"
27972 .cindex "authentication" "ACL checking"
27973 .cindex "&ACL;" "testing for authentication"
27974 If the SMTP connection is not authenticated, the condition is false. Otherwise,
27975 the name of the authenticator is tested against the list. To test for
27976 authentication by any authenticator, you can set
27977 .code
27978 authenticated = *
27979 .endd
27980
27981 .vitem &*condition&~=&~*&<&'string'&>
27982 .cindex "&%condition%& ACL condition"
27983 .cindex "customizing" "ACL condition"
27984 .cindex "&ACL;" "customized test"
27985 .cindex "&ACL;" "testing, customized"
27986 This feature allows you to make up custom conditions. If the result of
27987 expanding the string is an empty string, the number zero, or one of the strings
27988 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27989 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27990 any other value, some error is assumed to have occurred, and the ACL returns
27991 &"defer"&. However, if the expansion is forced to fail, the condition is
27992 ignored. The effect is to treat it as true, whether it is positive or
27993 negative.
27994
27995 .vitem &*decode&~=&~*&<&'location'&>
27996 .cindex "&%decode%& ACL condition"
27997 This condition is available only when Exim is compiled with the
27998 content-scanning extension, and it is allowed only in the ACL defined by
27999 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28000 If all goes well, the condition is true. It is false only if there are
28001 problems such as a syntax error or a memory shortage. For more details, see
28002 chapter &<<CHAPexiscan>>&.
28003
28004 .vitem &*demime&~=&~*&<&'extension&~list'&>
28005 .cindex "&%demime%& ACL condition"
28006 This condition is available only when Exim is compiled with the
28007 content-scanning extension. Its use is described in section
28008 &<<SECTdemimecond>>&.
28009
28010 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28011 .cindex "&%dnslists%& ACL condition"
28012 .cindex "DNS list" "in ACL"
28013 .cindex "black list (DNS)"
28014 .cindex "&ACL;" "testing a DNS list"
28015 This condition checks for entries in DNS black lists. These are also known as
28016 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28017 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28018 different variants of this condition to describe briefly here. See sections
28019 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28020
28021 .vitem &*domains&~=&~*&<&'domain&~list'&>
28022 .cindex "&%domains%& ACL condition"
28023 .cindex "domain" "ACL checking"
28024 .cindex "&ACL;" "testing a recipient domain"
28025 .vindex "&$domain_data$&"
28026 This condition is relevant only after a RCPT command. It checks that the domain
28027 of the recipient address is in the domain list. If percent-hack processing is
28028 enabled, it is done before this test is done. If the check succeeds with a
28029 lookup, the result of the lookup is placed in &$domain_data$& until the next
28030 &%domains%& test.
28031
28032 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28033 use &%domains%& in a DATA ACL.
28034
28035
28036 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28037 .cindex "&%encrypted%& ACL condition"
28038 .cindex "encryption" "checking in an ACL"
28039 .cindex "&ACL;" "testing for encryption"
28040 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28041 name of the cipher suite in use is tested against the list. To test for
28042 encryption without testing for any specific cipher suite(s), set
28043 .code
28044 encrypted = *
28045 .endd
28046
28047
28048 .vitem &*hosts&~=&~*&<&'host&~list'&>
28049 .cindex "&%hosts%& ACL condition"
28050 .cindex "host" "ACL checking"
28051 .cindex "&ACL;" "testing the client host"
28052 This condition tests that the calling host matches the host list. If you have
28053 name lookups or wildcarded host names and IP addresses in the same host list,
28054 you should normally put the IP addresses first. For example, you could have:
28055 .code
28056 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28057 .endd
28058 The lookup in this example uses the host name for its key. This is implied by
28059 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28060 and it wouldn't matter which way round you had these two items.)
28061
28062 The reason for the problem with host names lies in the left-to-right way that
28063 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28064 but when it reaches an item that requires a host name, it fails if it cannot
28065 find a host name to compare with the pattern. If the above list is given in the
28066 opposite order, the &%accept%& statement fails for a host whose name cannot be
28067 found, even if its IP address is 10.9.8.7.
28068
28069 If you really do want to do the name check first, and still recognize the IP
28070 address even if the name lookup fails, you can rewrite the ACL like this:
28071 .code
28072 accept hosts = dbm;/etc/friendly/hosts
28073 accept hosts = 10.9.8.7
28074 .endd
28075 The default action on failing to find the host name is to assume that the host
28076 is not in the list, so the first &%accept%& statement fails. The second
28077 statement can then check the IP address.
28078
28079 .vindex "&$host_data$&"
28080 If a &%hosts%& condition is satisfied by means of a lookup, the result
28081 of the lookup is made available in the &$host_data$& variable. This
28082 allows you, for example, to set up a statement like this:
28083 .code
28084 deny  hosts = net-lsearch;/some/file
28085 message = $host_data
28086 .endd
28087 which gives a custom error message for each denied host.
28088
28089 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28090 .cindex "&%local_parts%& ACL condition"
28091 .cindex "local part" "ACL checking"
28092 .cindex "&ACL;" "testing a local part"
28093 .vindex "&$local_part_data$&"
28094 This condition is relevant only after a RCPT command. It checks that the local
28095 part of the recipient address is in the list. If percent-hack processing is
28096 enabled, it is done before this test. If the check succeeds with a lookup, the
28097 result of the lookup is placed in &$local_part_data$&, which remains set until
28098 the next &%local_parts%& test.
28099
28100 .vitem &*malware&~=&~*&<&'option'&>
28101 .cindex "&%malware%& ACL condition"
28102 .cindex "&ACL;" "virus scanning"
28103 .cindex "&ACL;" "scanning for viruses"
28104 This condition is available only when Exim is compiled with the
28105 content-scanning extension. It causes the incoming message to be scanned for
28106 viruses. For details, see chapter &<<CHAPexiscan>>&.
28107
28108 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28109 .cindex "&%mime_regex%& ACL condition"
28110 .cindex "&ACL;" "testing by regex matching"
28111 This condition is available only when Exim is compiled with the
28112 content-scanning extension, and it is allowed only in the ACL defined by
28113 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28114 with any of the regular expressions. For details, see chapter
28115 &<<CHAPexiscan>>&.
28116
28117 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28118 .cindex "rate limiting"
28119 This condition can be used to limit the rate at which a user or host submits
28120 messages. Details are given in section &<<SECTratelimiting>>&.
28121
28122 .vitem &*recipients&~=&~*&<&'address&~list'&>
28123 .cindex "&%recipients%& ACL condition"
28124 .cindex "recipient" "ACL checking"
28125 .cindex "&ACL;" "testing a recipient"
28126 This condition is relevant only after a RCPT command. It checks the entire
28127 recipient address against a list of recipients.
28128
28129 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28130 .cindex "&%regex%& ACL condition"
28131 .cindex "&ACL;" "testing by regex matching"
28132 This condition is available only when Exim is compiled with the
28133 content-scanning extension, and is available only in the DATA, MIME, and
28134 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28135 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28136
28137 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28138 .cindex "&%sender_domains%& ACL condition"
28139 .cindex "sender" "ACL checking"
28140 .cindex "&ACL;" "testing a sender domain"
28141 .vindex "&$domain$&"
28142 .vindex "&$sender_address_domain$&"
28143 This condition tests the domain of the sender of the message against the given
28144 domain list. &*Note*&: The domain of the sender address is in
28145 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28146 of this condition. This is an exception to the general rule for testing domain
28147 lists. It is done this way so that, if this condition is used in an ACL for a
28148 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28149 influence the sender checking.
28150
28151 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28152 relaying, because sender addresses are easily, and commonly, forged.
28153
28154 .vitem &*senders&~=&~*&<&'address&~list'&>
28155 .cindex "&%senders%& ACL condition"
28156 .cindex "sender" "ACL checking"
28157 .cindex "&ACL;" "testing a sender"
28158 This condition tests the sender of the message against the given list. To test
28159 for a bounce message, which has an empty sender, set
28160 .code
28161 senders = :
28162 .endd
28163 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28164 relaying, because sender addresses are easily, and commonly, forged.
28165
28166 .vitem &*spam&~=&~*&<&'username'&>
28167 .cindex "&%spam%& ACL condition"
28168 .cindex "&ACL;" "scanning for spam"
28169 This condition is available only when Exim is compiled with the
28170 content-scanning extension. It causes the incoming message to be scanned by
28171 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28172
28173 .vitem &*verify&~=&~certificate*&
28174 .cindex "&%verify%& ACL condition"
28175 .cindex "TLS" "client certificate verification"
28176 .cindex "certificate" "verification of client"
28177 .cindex "&ACL;" "certificate verification"
28178 .cindex "&ACL;" "testing a TLS certificate"
28179 This condition is true in an SMTP session if the session is encrypted, and a
28180 certificate was received from the client, and the certificate was verified. The
28181 server requests a certificate only if the client matches &%tls_verify_hosts%&
28182 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28183
28184 .vitem &*verify&~=&~csa*&
28185 .cindex "CSA verification"
28186 This condition checks whether the sending host (the client) is authorized to
28187 send email. Details of how this works are given in section
28188 &<<SECTverifyCSA>>&.
28189
28190 .new
28191 .vitem &*verify&~=&~header_names_ascii*&
28192 .cindex "&%verify%& ACL condition"
28193 .cindex "&ACL;" "verifying header names only ASCII"
28194 .cindex "header lines" "verifying header names only ASCII"
28195 .cindex "verifying" "header names only ASCII"
28196 This condition is relevant only in an ACL that is run after a message has been
28197 received, that is, in an ACL specified by &%acl_smtp_data%& or
28198 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28199 there are no non-ASCII characters, also excluding control characters.  The
28200 allowable characters are decimal ASCII values 33 through 126.
28201
28202 Exim itself will handle headers with non-ASCII characters, but it can cause
28203 problems for downstream applications, so this option will allow their
28204 detection and rejection in the DATA ACL's.
28205 .wen
28206
28207 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28208 .cindex "&%verify%& ACL condition"
28209 .cindex "&ACL;" "verifying sender in the header"
28210 .cindex "header lines" "verifying the sender in"
28211 .cindex "sender" "verifying in header"
28212 .cindex "verifying" "sender in header"
28213 This condition is relevant only in an ACL that is run after a message has been
28214 received, that is, in an ACL specified by &%acl_smtp_data%& or
28215 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28216 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28217 is loosely thought of as a &"sender"& address (hence the name of the test).
28218 However, an address that appears in one of these headers need not be an address
28219 that accepts bounce messages; only sender addresses in envelopes are required
28220 to accept bounces. Therefore, if you use the callout option on this check, you
28221 might want to arrange for a non-empty address in the MAIL command.
28222
28223 Details of address verification and the options are given later, starting at
28224 section &<<SECTaddressverification>>& (callouts are described in section
28225 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28226 condition to restrict it to bounce messages only:
28227 .code
28228 deny    senders = :
28229         message = A valid sender header is required for bounces
28230        !verify  = header_sender
28231 .endd
28232
28233 .vitem &*verify&~=&~header_syntax*&
28234 .cindex "&%verify%& ACL condition"
28235 .cindex "&ACL;" "verifying header syntax"
28236 .cindex "header lines" "verifying syntax"
28237 .cindex "verifying" "header syntax"
28238 This condition is relevant only in an ACL that is run after a message has been
28239 received, that is, in an ACL specified by &%acl_smtp_data%& or
28240 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28241 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28242 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28243 permitted only in locally generated messages and from hosts that match
28244 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28245 appropriate.
28246
28247 Note that this condition is a syntax check only. However, a common spamming
28248 ploy used to be to send syntactically invalid headers such as
28249 .code
28250 To: @
28251 .endd
28252 and this condition can be used to reject such messages, though they are not as
28253 common as they used to be.
28254
28255 .vitem &*verify&~=&~helo*&
28256 .cindex "&%verify%& ACL condition"
28257 .cindex "&ACL;" "verifying HELO/EHLO"
28258 .cindex "HELO" "verifying"
28259 .cindex "EHLO" "verifying"
28260 .cindex "verifying" "EHLO"
28261 .cindex "verifying" "HELO"
28262 This condition is true if a HELO or EHLO command has been received from the
28263 client host, and its contents have been verified. If there has been no previous
28264 attempt to verify the HELO/EHLO contents, it is carried out when this
28265 condition is encountered. See the description of the &%helo_verify_hosts%& and
28266 &%helo_try_verify_hosts%& options for details of how to request verification
28267 independently of this condition.
28268
28269 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28270 option), this condition is always true.
28271
28272
28273 .vitem &*verify&~=&~not_blind*&
28274 .cindex "verifying" "not blind"
28275 .cindex "bcc recipients, verifying none"
28276 This condition checks that there are no blind (bcc) recipients in the message.
28277 Every envelope recipient must appear either in a &'To:'& header line or in a
28278 &'Cc:'& header line for this condition to be true. Local parts are checked
28279 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28280 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28281 used only in a DATA or non-SMTP ACL.
28282
28283 There are, of course, many legitimate messages that make use of blind (bcc)
28284 recipients. This check should not be used on its own for blocking messages.
28285
28286
28287 .vitem &*verify&~=&~recipient/*&<&'options'&>
28288 .cindex "&%verify%& ACL condition"
28289 .cindex "&ACL;" "verifying recipient"
28290 .cindex "recipient" "verifying"
28291 .cindex "verifying" "recipient"
28292 .vindex "&$address_data$&"
28293 This condition is relevant only after a RCPT command. It verifies the current
28294 recipient. Details of address verification are given later, starting at section
28295 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28296 of &$address_data$& is the last value that was set while routing the address.
28297 This applies even if the verification fails. When an address that is being
28298 verified is redirected to a single address, verification continues with the new
28299 address, and in that case, the subsequent value of &$address_data$& is the
28300 value for the child address.
28301
28302 .vitem &*verify&~=&~reverse_host_lookup*&
28303 .cindex "&%verify%& ACL condition"
28304 .cindex "&ACL;" "verifying host reverse lookup"
28305 .cindex "host" "verifying reverse lookup"
28306 This condition ensures that a verified host name has been looked up from the IP
28307 address of the client host. (This may have happened already if the host name
28308 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28309 Verification ensures that the host name obtained from a reverse DNS lookup, or
28310 one of its aliases, does, when it is itself looked up in the DNS, yield the
28311 original IP address.
28312
28313 If this condition is used for a locally generated message (that is, when there
28314 is no client host involved), it always succeeds.
28315
28316 .vitem &*verify&~=&~sender/*&<&'options'&>
28317 .cindex "&%verify%& ACL condition"
28318 .cindex "&ACL;" "verifying sender"
28319 .cindex "sender" "verifying"
28320 .cindex "verifying" "sender"
28321 This condition is relevant only after a MAIL or RCPT command, or after a
28322 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28323 the message's sender is empty (that is, this is a bounce message), the
28324 condition is true. Otherwise, the sender address is verified.
28325
28326 .vindex "&$address_data$&"
28327 .vindex "&$sender_address_data$&"
28328 If there is data in the &$address_data$& variable at the end of routing, its
28329 value is placed in &$sender_address_data$& at the end of verification. This
28330 value can be used in subsequent conditions and modifiers in the same ACL
28331 statement. It does not persist after the end of the current statement. If you
28332 want to preserve the value for longer, you can save it in an ACL variable.
28333
28334 Details of verification are given later, starting at section
28335 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28336 to avoid doing it more than once per message.
28337
28338 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28339 .cindex "&%verify%& ACL condition"
28340 This is a variation of the previous option, in which a modified address is
28341 verified as a sender.
28342 .endlist
28343
28344
28345
28346 .section "Using DNS lists" "SECTmorednslists"
28347 .cindex "DNS list" "in ACL"
28348 .cindex "black list (DNS)"
28349 .cindex "&ACL;" "testing a DNS list"
28350 In its simplest form, the &%dnslists%& condition tests whether the calling host
28351 is on at least one of a number of DNS lists by looking up the inverted IP
28352 address in one or more DNS domains. (Note that DNS list domains are not mail
28353 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28354 special options instead.) For example, if the calling host's IP
28355 address is 192.168.62.43, and the ACL statement is
28356 .code
28357 deny dnslists = blackholes.mail-abuse.org : \
28358                 dialups.mail-abuse.org
28359 .endd
28360 the following records are looked up:
28361 .code
28362 43.62.168.192.blackholes.mail-abuse.org
28363 43.62.168.192.dialups.mail-abuse.org
28364 .endd
28365 As soon as Exim finds an existing DNS record, processing of the list stops.
28366 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28367 to test that a host is on more than one list (an &"and"& conjunction), you can
28368 use two separate conditions:
28369 .code
28370 deny dnslists = blackholes.mail-abuse.org
28371      dnslists = dialups.mail-abuse.org
28372 .endd
28373 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28374 behaves as if the host does not match the list item, that is, as if the DNS
28375 record does not exist. If there are further items in the DNS list, they are
28376 processed.
28377
28378 This is usually the required action when &%dnslists%& is used with &%deny%&
28379 (which is the most common usage), because it prevents a DNS failure from
28380 blocking mail. However, you can change this behaviour by putting one of the
28381 following special items in the list:
28382 .display
28383 &`+include_unknown `&   behave as if the item is on the list
28384 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28385 &`+defer_unknown   `&   give a temporary error
28386 .endd
28387 .cindex "&`+include_unknown`&"
28388 .cindex "&`+exclude_unknown`&"
28389 .cindex "&`+defer_unknown`&"
28390 Each of these applies to any subsequent items on the list. For example:
28391 .code
28392 deny dnslists = +defer_unknown : foo.bar.example
28393 .endd
28394 Testing the list of domains stops as soon as a match is found. If you want to
28395 warn for one list and block for another, you can use two different statements:
28396 .code
28397 deny  dnslists = blackholes.mail-abuse.org
28398 warn  message  = X-Warn: sending host is on dialups list
28399       dnslists = dialups.mail-abuse.org
28400 .endd
28401 DNS list lookups are cached by Exim for the duration of the SMTP session,
28402 so a lookup based on the IP address is done at most once for any incoming
28403 connection. Exim does not share information between multiple incoming
28404 connections (but your local name server cache should be active).
28405
28406
28407
28408 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28409 .cindex "DNS list" "keyed by explicit IP address"
28410 By default, the IP address that is used in a DNS list lookup is the IP address
28411 of the calling host. However, you can specify another IP address by listing it
28412 after the domain name, introduced by a slash. For example:
28413 .code
28414 deny dnslists = black.list.tld/192.168.1.2
28415 .endd
28416 This feature is not very helpful with explicit IP addresses; it is intended for
28417 use with IP addresses that are looked up, for example, the IP addresses of the
28418 MX hosts or nameservers of an email sender address. For an example, see section
28419 &<<SECTmulkeyfor>>& below.
28420
28421
28422
28423
28424 .section "DNS lists keyed on domain names" "SECID202"
28425 .cindex "DNS list" "keyed by domain name"
28426 There are some lists that are keyed on domain names rather than inverted IP
28427 addresses (see for example the &'domain based zones'& link at
28428 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28429 with these lists. You can change the name that is looked up in a DNS list by
28430 listing it after the domain name, introduced by a slash. For example,
28431 .code
28432 deny  message  = Sender's domain is listed at $dnslist_domain
28433       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28434 .endd
28435 This particular example is useful only in ACLs that are obeyed after the
28436 RCPT or DATA commands, when a sender address is available. If (for
28437 example) the message's sender is &'user@tld.example'& the name that is looked
28438 up by this example is
28439 .code
28440 tld.example.dsn.rfc-ignorant.org
28441 .endd
28442 A single &%dnslists%& condition can contain entries for both names and IP
28443 addresses. For example:
28444 .code
28445 deny dnslists = sbl.spamhaus.org : \
28446                 dsn.rfc-ignorant.org/$sender_address_domain
28447 .endd
28448 The first item checks the sending host's IP address; the second checks a domain
28449 name. The whole condition is true if either of the DNS lookups succeeds.
28450
28451
28452
28453
28454 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28455 .cindex "DNS list" "multiple keys for"
28456 The syntax described above for looking up explicitly-defined values (either
28457 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28458 name for the DNS list, what follows the slash can in fact be a list of items.
28459 As with all lists in Exim, the default separator is a colon. However, because
28460 this is a sublist within the list of DNS blacklist domains, it is necessary
28461 either to double the separators like this:
28462 .code
28463 dnslists = black.list.tld/name.1::name.2
28464 .endd
28465 or to change the separator character, like this:
28466 .code
28467 dnslists = black.list.tld/<;name.1;name.2
28468 .endd
28469 If an item in the list is an IP address, it is inverted before the DNS
28470 blacklist domain is appended. If it is not an IP address, no inversion
28471 occurs. Consider this condition:
28472 .code
28473 dnslists = black.list.tld/<;192.168.1.2;a.domain
28474 .endd
28475 The DNS lookups that occur are:
28476 .code
28477 2.1.168.192.black.list.tld
28478 a.domain.black.list.tld
28479 .endd
28480 Once a DNS record has been found (that matches a specific IP return
28481 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28482 are done. If there is a temporary DNS error, the rest of the sublist of domains
28483 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28484 only if no other DNS lookup in this sublist succeeds. In other words, a
28485 successful lookup for any of the items in the sublist overrides a temporary
28486 error for a previous item.
28487
28488 The ability to supply a list of items after the slash is in some sense just a
28489 syntactic convenience. These two examples have the same effect:
28490 .code
28491 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28492 dnslists = black.list.tld/a.domain::b.domain
28493 .endd
28494 However, when the data for the list is obtained from a lookup, the second form
28495 is usually much more convenient. Consider this example:
28496 .code
28497 deny message  = The mail servers for the domain \
28498                 $sender_address_domain \
28499                 are listed at $dnslist_domain ($dnslist_value); \
28500                 see $dnslist_text.
28501      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28502                                    ${lookup dnsdb {>|mxh=\
28503                                    $sender_address_domain} }} }
28504 .endd
28505 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28506 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28507 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28508 of expanding the condition might be something like this:
28509 .code
28510 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28511 .endd
28512 Thus, this example checks whether or not the IP addresses of the sender
28513 domain's mail servers are on the Spamhaus black list.
28514
28515 The key that was used for a successful DNS list lookup is put into the variable
28516 &$dnslist_matched$& (see section &<<SECID204>>&).
28517
28518
28519
28520
28521 .section "Data returned by DNS lists" "SECID203"
28522 .cindex "DNS list" "data returned from"
28523 DNS lists are constructed using address records in the DNS. The original RBL
28524 just used the address 127.0.0.1 on the right hand side of each record, but the
28525 RBL+ list and some other lists use a number of values with different meanings.
28526 The values used on the RBL+ list are:
28527 .display
28528 127.1.0.1  RBL
28529 127.1.0.2  DUL
28530 127.1.0.3  DUL and RBL
28531 127.1.0.4  RSS
28532 127.1.0.5  RSS and RBL
28533 127.1.0.6  RSS and DUL
28534 127.1.0.7  RSS and DUL and RBL
28535 .endd
28536 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28537 different values. Some DNS lists may return more than one address record;
28538 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28539
28540
28541 .section "Variables set from DNS lists" "SECID204"
28542 .cindex "expansion" "variables, set from DNS list"
28543 .cindex "DNS list" "variables set from"
28544 .vindex "&$dnslist_domain$&"
28545 .vindex "&$dnslist_matched$&"
28546 .vindex "&$dnslist_text$&"
28547 .vindex "&$dnslist_value$&"
28548 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28549 the name of the overall domain that matched (for example,
28550 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28551 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28552 the DNS record. When the key is an IP address, it is not reversed in
28553 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28554 cases, for example:
28555 .code
28556 deny dnslists = spamhaus.example
28557 .endd
28558 the key is also available in another variable (in this case,
28559 &$sender_host_address$&). In more complicated cases, however, this is not true.
28560 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28561 might generate a dnslists lookup like this:
28562 .code
28563 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28564 .endd
28565 If this condition succeeds, the value in &$dnslist_matched$& might be
28566 &`192.168.6.7`& (for example).
28567
28568 If more than one address record is returned by the DNS lookup, all the IP
28569 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28570 The variable &$dnslist_text$& contains the contents of any associated TXT
28571 record. For lists such as RBL+ the TXT record for a merged entry is often not
28572 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28573 information.
28574
28575 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28576 &-- although these appear before the condition in the ACL, they are not
28577 expanded until after it has failed. For example:
28578 .code
28579 deny    hosts = !+local_networks
28580         message = $sender_host_address is listed \
28581                   at $dnslist_domain
28582         dnslists = rbl-plus.mail-abuse.example
28583 .endd
28584
28585
28586
28587 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28588 .cindex "DNS list" "matching specific returned data"
28589 You can add an equals sign and an IP address after a &%dnslists%& domain name
28590 in order to restrict its action to DNS records with a matching right hand side.
28591 For example,
28592 .code
28593 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28594 .endd
28595 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28596 any address record is considered to be a match. For the moment, we assume
28597 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28598 describes how multiple records are handled.
28599
28600 More than one IP address may be given for checking, using a comma as a
28601 separator. These are alternatives &-- if any one of them matches, the
28602 &%dnslists%& condition is true. For example:
28603 .code
28604 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28605 .endd
28606 If you want to specify a constraining address list and also specify names or IP
28607 addresses to be looked up, the constraining address list must be specified
28608 first. For example:
28609 .code
28610 deny dnslists = dsn.rfc-ignorant.org\
28611                 =127.0.0.2/$sender_address_domain
28612 .endd
28613
28614 If the character &`&&`& is used instead of &`=`&, the comparison for each
28615 listed IP address is done by a bitwise &"and"& instead of by an equality test.
28616 In other words, the listed addresses are used as bit masks. The comparison is
28617 true if all the bits in the mask are present in the address that is being
28618 tested. For example:
28619 .code
28620 dnslists = a.b.c&0.0.0.3
28621 .endd
28622 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
28623 want to test whether one bit or another bit is present (as opposed to both
28624 being present), you must use multiple values. For example:
28625 .code
28626 dnslists = a.b.c&0.0.0.1,0.0.0.2
28627 .endd
28628 matches if the final component of the address is an odd number or two times
28629 an odd number.
28630
28631
28632
28633 .section "Negated DNS matching conditions" "SECID205"
28634 You can supply a negative list of IP addresses as part of a &%dnslists%&
28635 condition. Whereas
28636 .code
28637 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28638 .endd
28639 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28640 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
28641 .code
28642 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
28643 .endd
28644 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28645 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
28646 words, the result of the test is inverted if an exclamation mark appears before
28647 the &`=`& (or the &`&&`&) sign.
28648
28649 &*Note*&: This kind of negation is not the same as negation in a domain,
28650 host, or address list (which is why the syntax is different).
28651
28652 If you are using just one list, the negation syntax does not gain you much. The
28653 previous example is precisely equivalent to
28654 .code
28655 deny  dnslists = a.b.c
28656      !dnslists = a.b.c=127.0.0.2,127.0.0.3
28657 .endd
28658 However, if you are using multiple lists, the negation syntax is clearer.
28659 Consider this example:
28660 .code
28661 deny  dnslists = sbl.spamhaus.org : \
28662                  list.dsbl.org : \
28663                  dnsbl.njabl.org!=127.0.0.3 : \
28664                  relays.ordb.org
28665 .endd
28666 Using only positive lists, this would have to be:
28667 .code
28668 deny  dnslists = sbl.spamhaus.org : \
28669                  list.dsbl.org
28670 deny  dnslists = dnsbl.njabl.org
28671      !dnslists = dnsbl.njabl.org=127.0.0.3
28672 deny  dnslists = relays.ordb.org
28673 .endd
28674 which is less clear, and harder to maintain.
28675
28676
28677
28678
28679 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
28680 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
28681 thereby providing more than one IP address. When an item in a &%dnslists%& list
28682 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
28683 the match to specific results from the DNS lookup, there are two ways in which
28684 the checking can be handled. For example, consider the condition:
28685 .code
28686 dnslists = a.b.c=127.0.0.1
28687 .endd
28688 What happens if the DNS lookup for the incoming IP address yields both
28689 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
28690 condition true because at least one given value was found, or is it false
28691 because at least one of the found values was not listed? And how does this
28692 affect negated conditions? Both possibilities are provided for with the help of
28693 additional separators &`==`& and &`=&&`&.
28694
28695 .ilist
28696 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
28697 IP addresses matches one of the listed addresses. For the example above, the
28698 condition is true because 127.0.0.1 matches.
28699 .next
28700 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
28701 looked up IP addresses matches one of the listed addresses. If the condition is
28702 changed to:
28703 .code
28704 dnslists = a.b.c==127.0.0.1
28705 .endd
28706 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28707 false because 127.0.0.2 is not listed. You would need to have:
28708 .code
28709 dnslists = a.b.c==127.0.0.1,127.0.0.2
28710 .endd
28711 for the condition to be true.
28712 .endlist
28713
28714 When &`!`& is used to negate IP address matching, it inverts the result, giving
28715 the precise opposite of the behaviour above. Thus:
28716 .ilist
28717 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
28718 addresses matches one of the listed addresses. Consider:
28719 .code
28720 dnslists = a.b.c!&0.0.0.1
28721 .endd
28722 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28723 false because 127.0.0.1 matches.
28724 .next
28725 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
28726 looked up IP address that does not match. Consider:
28727 .code
28728 dnslists = a.b.c!=&0.0.0.1
28729 .endd
28730 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28731 true, because 127.0.0.2 does not match. You would need to have:
28732 .code
28733 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
28734 .endd
28735 for the condition to be false.
28736 .endlist
28737 When the DNS lookup yields only a single IP address, there is no difference
28738 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
28739
28740
28741
28742
28743 .section "Detailed information from merged DNS lists" "SECTmordetinf"
28744 .cindex "DNS list" "information from merged"
28745 When the facility for restricting the matching IP values in a DNS list is used,
28746 the text from the TXT record that is set in &$dnslist_text$& may not reflect
28747 the true reason for rejection. This happens when lists are merged and the IP
28748 address in the A record is used to distinguish them; unfortunately there is
28749 only one TXT record. One way round this is not to use merged lists, but that
28750 can be inefficient because it requires multiple DNS lookups where one would do
28751 in the vast majority of cases when the host of interest is not on any of the
28752 lists.
28753
28754 A less inefficient way of solving this problem is available. If
28755 two domain names, comma-separated, are given, the second is used first to
28756 do an initial check, making use of any IP value restrictions that are set.
28757 If there is a match, the first domain is used, without any IP value
28758 restrictions, to get the TXT record. As a byproduct of this, there is also
28759 a check that the IP being tested is indeed on the first list. The first
28760 domain is the one that is put in &$dnslist_domain$&. For example:
28761 .code
28762 reject message  = \
28763          rejected because $sender_host_address is blacklisted \
28764          at $dnslist_domain\n$dnslist_text
28765        dnslists = \
28766          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
28767          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28768 .endd
28769 For the first blacklist item, this starts by doing a lookup in
28770 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
28771 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
28772 value, and as long as something is found, it looks for the corresponding TXT
28773 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
28774 The second blacklist item is processed similarly.
28775
28776 If you are interested in more than one merged list, the same list must be
28777 given several times, but because the results of the DNS lookups are cached,
28778 the DNS calls themselves are not repeated. For example:
28779 .code
28780 reject dnslists = \
28781          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
28782          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
28783          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
28784          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28785 .endd
28786 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
28787 values matches (or if no record is found), this is the only lookup that is
28788 done. Only if there is a match is one of the more specific lists consulted.
28789
28790
28791
28792 .section "DNS lists and IPv6" "SECTmorednslistslast"
28793 .cindex "IPv6" "DNS black lists"
28794 .cindex "DNS list" "IPv6 usage"
28795 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
28796 nibble by nibble. For example, if the calling host's IP address is
28797 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
28798 .code
28799 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
28800   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
28801 .endd
28802 (split over two lines here to fit on the page). Unfortunately, some of the DNS
28803 lists contain wildcard records, intended for IPv4, that interact badly with
28804 IPv6. For example, the DNS entry
28805 .code
28806 *.3.some.list.example.    A    127.0.0.1
28807 .endd
28808 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
28809 Unfortunately, it also matches the entire 3::/4 IPv6 network.
28810
28811 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
28812 &%condition%& condition, as in this example:
28813 .code
28814 deny   condition = ${if isip4{$sender_host_address}}
28815        dnslists  = some.list.example
28816 .endd
28817
28818 If an explicit key is being used for a DNS lookup and it may be an IPv6
28819 address you should specify alternate list separators for both the outer
28820 (DNS list name) list and inner (lookup keys) list:
28821 .code
28822        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
28823 .endd
28824
28825 .section "Rate limiting incoming messages" "SECTratelimiting"
28826 .cindex "rate limiting" "client sending"
28827 .cindex "limiting client sending rates"
28828 .oindex "&%smtp_ratelimit_*%&"
28829 The &%ratelimit%& ACL condition can be used to measure and control the rate at
28830 which clients can send email. This is more powerful than the
28831 &%smtp_ratelimit_*%& options, because those options control the rate of
28832 commands in a single SMTP session only, whereas the &%ratelimit%& condition
28833 works across all connections (concurrent and sequential) from the same client
28834 host. The syntax of the &%ratelimit%& condition is:
28835 .display
28836 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
28837 .endd
28838 If the average client sending rate is less than &'m'& messages per time
28839 period &'p'& then the condition is false; otherwise it is true.
28840
28841 As a side-effect, the &%ratelimit%& condition sets the expansion variable
28842 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
28843 configured value of &'m'&, and &$sender_rate_period$& to the configured value
28844 of &'p'&.
28845
28846 The parameter &'p'& is the smoothing time constant, in the form of an Exim
28847 time interval, for example, &`8h`& for eight hours. A larger time constant
28848 means that it takes Exim longer to forget a client's past behaviour. The
28849 parameter &'m'& is the maximum number of messages that a client is permitted to
28850 send in each time interval. It also specifies the number of messages permitted
28851 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
28852 constant, you can allow a client to send more messages in a burst without
28853 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
28854 both small, messages must be sent at an even rate.
28855
28856 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
28857 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
28858 when deploying the &%ratelimit%& ACL condition. The script prints usage
28859 instructions when it is run with no arguments.
28860
28861 The key is used to look up the data for calculating the client's average
28862 sending rate. This data is stored in Exim's spool directory, alongside the
28863 retry and other hints databases. The default key is &$sender_host_address$&,
28864 which means Exim computes the sending rate of each client host IP address.
28865 By changing the key you can change how Exim identifies clients for the purpose
28866 of ratelimiting. For example, to limit the sending rate of each authenticated
28867 user, independent of the computer they are sending from, set the key to
28868 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
28869 example, &$authenticated_id$& is only meaningful if the client has
28870 authenticated (which you can check with the &%authenticated%& ACL condition).
28871
28872 The lookup key does not have to identify clients: If you want to limit the
28873 rate at which a recipient receives messages, you can use the key
28874 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
28875 ACL.
28876
28877 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
28878 specifies what Exim measures the rate of, for example messages or recipients
28879 or bytes. You can adjust the measurement using the &%unique=%& and/or
28880 &%count=%& options. You can also control when Exim updates the recorded rate
28881 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
28882 separated by a slash, like the other parameters. They may appear in any order.
28883
28884 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
28885 any options that alter the meaning of the stored data. The limit &'m'& is not
28886 stored, so you can alter the configured maximum rate and Exim will still
28887 remember clients' past behaviour. If you change the &%per_*%& mode or add or
28888 remove the &%unique=%& option, the lookup key changes so Exim will forget past
28889 behaviour. The lookup key is not affected by changes to the update mode and
28890 the &%count=%& option.
28891
28892
28893 .section "Ratelimit options for what is being measured" "ratoptmea"
28894 .cindex "rate limiting" "per_* options"
28895 The &%per_conn%& option limits the client's connection rate. It is not
28896 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
28897 &%acl_not_smtp_start%& ACLs.
28898
28899 The &%per_mail%& option limits the client's rate of sending messages. This is
28900 the default if none of the &%per_*%& options is specified. It can be used in
28901 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
28902 &%acl_smtp_data%&, or &%acl_not_smtp%&.
28903
28904 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
28905 the same ACLs as the &%per_mail%& option, though it is best to use this option
28906 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
28907 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
28908 in its MAIL command, which may be inaccurate or completely missing. You can
28909 follow the limit &'m'& in the configuration with K, M, or G to specify limits
28910 in kilobytes, megabytes, or gigabytes, respectively.
28911
28912 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
28913 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28914 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
28915 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
28916 ACLs the rate is updated with the total recipient count in one go. Note that
28917 in either case the rate limiting engine will see a message with many
28918 recipients as a large high-speed burst.
28919
28920 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
28921 number of different recipients that the client has sent messages to in the
28922 last time period. That is, if the client repeatedly sends messages to the same
28923 recipient, its measured rate is not increased. This option can only be used in
28924 &%acl_smtp_rcpt%&.
28925
28926 The &%per_cmd%& option causes Exim to recompute the rate every time the
28927 condition is processed. This can be used to limit the rate of any SMTP
28928 command. If it is used in multiple ACLs it can limit the aggregate rate of
28929 multiple different commands.
28930
28931 The &%count=%& option can be used to alter how much Exim adds to the client's
28932 measured rate. For example, the &%per_byte%& option is equivalent to
28933 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
28934 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
28935 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
28936
28937 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
28938
28939
28940 .section "Ratelimit update modes" "ratoptupd"
28941 .cindex "rate limiting" "reading data without updating"
28942 You can specify one of three options with the &%ratelimit%& condition to
28943 control when its database is updated. This section describes the &%readonly%&
28944 mode, and the next section describes the &%strict%& and &%leaky%& modes.
28945
28946 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
28947 previously-computed rate to check against the limit.
28948
28949 For example, you can test the client's sending rate and deny it access (when
28950 it is too fast) in the connect ACL. If the client passes this check then it
28951 can go on to send a message, in which case its recorded rate will be updated
28952 in the MAIL ACL. Subsequent connections from the same client will check this
28953 new rate.
28954 .code
28955 acl_check_connect:
28956  deny ratelimit = 100 / 5m / readonly
28957     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
28958                   (max $sender_rate_limit)
28959 # ...
28960 acl_check_mail:
28961  warn ratelimit = 100 / 5m / strict
28962     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
28963                   (max $sender_rate_limit)
28964 .endd
28965
28966 If Exim encounters multiple &%ratelimit%& conditions with the same key when
28967 processing a message then it may increase the client's measured rate more than
28968 it should. For example, this will happen if you check the &%per_rcpt%& option
28969 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
28970 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
28971 multiple update problems by using the &%readonly%& option on later ratelimit
28972 checks.
28973
28974 The &%per_*%& options described above do not make sense in some ACLs. If you
28975 use a &%per_*%& option in an ACL where it is not normally permitted then the
28976 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
28977 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
28978 next section) so you must specify the &%readonly%& option explicitly.
28979
28980
28981 .section "Ratelimit options for handling fast clients" "ratoptfast"
28982 .cindex "rate limiting" "strict and leaky modes"
28983 If a client's average rate is greater than the maximum, the rate limiting
28984 engine can react in two possible ways, depending on the presence of the
28985 &%strict%& or &%leaky%& update modes. This is independent of the other
28986 counter-measures (such as rejecting the message) that may be specified by the
28987 rest of the ACL.
28988
28989 The &%leaky%& (default) option means that the client's recorded rate is not
28990 updated if it is above the limit. The effect of this is that Exim measures the
28991 client's average rate of successfully sent email, which cannot be greater than
28992 the maximum allowed. If the client is over the limit it may suffer some
28993 counter-measures (as specified in the ACL), but it will still be able to send
28994 email at the configured maximum rate, whatever the rate of its attempts. This
28995 is generally the better choice if you have clients that retry automatically.
28996 For example, it does not prevent a sender with an over-aggressive retry rate
28997 from getting any email through.
28998
28999 The &%strict%& option means that the client's recorded rate is always
29000 updated. The effect of this is that Exim measures the client's average rate
29001 of attempts to send email, which can be much higher than the maximum it is
29002 actually allowed. If the client is over the limit it may be subjected to
29003 counter-measures by the ACL. It must slow down and allow sufficient time to
29004 pass that its computed rate falls below the maximum before it can send email
29005 again. The time (the number of smoothing periods) it must wait and not
29006 attempt to send mail can be calculated with this formula:
29007 .code
29008         ln(peakrate/maxrate)
29009 .endd
29010
29011
29012 .section "Limiting the rate of different events" "ratoptuniq"
29013 .cindex "rate limiting" "counting unique events"
29014 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29015 rate of different events. For example, the &%per_addr%& option uses this
29016 mechanism to count the number of different recipients that the client has
29017 sent messages to in the last time period; it is equivalent to
29018 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29019 measure the rate that a client uses different sender addresses with the
29020 options &`per_mail/unique=$sender_address`&.
29021
29022 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29023 has seen for that key. The whole set is thrown away when it is older than the
29024 rate smoothing period &'p'&, so each different event is counted at most once
29025 per period. In the &%leaky%& update mode, an event that causes the client to
29026 go over the limit is not added to the set, in the same way that the client's
29027 recorded rate is not updated in the same situation.
29028
29029 When you combine the &%unique=%& and &%readonly%& options, the specific
29030 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29031 rate.
29032
29033 The &%unique=%& mechanism needs more space in the ratelimit database than the
29034 other &%ratelimit%& options in order to store the event set. The number of
29035 unique values is potentially as large as the rate limit, so the extra space
29036 required increases with larger limits.
29037
29038 The uniqueification is not perfect: there is a small probability that Exim
29039 will think a new event has happened before. If the sender's rate is less than
29040 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29041 the measured rate can go above the limit, in which case Exim may under-count
29042 events by a significant margin. Fortunately, if the rate is high enough (2.7
29043 times the limit) that the false positive rate goes above 9%, then Exim will
29044 throw away the over-full event set before the measured rate falls below the
29045 limit. Therefore the only harm should be that exceptionally high sending rates
29046 are logged incorrectly; any countermeasures you configure will be as effective
29047 as intended.
29048
29049
29050 .section "Using rate limiting" "useratlim"
29051 Exim's other ACL facilities are used to define what counter-measures are taken
29052 when the rate limit is exceeded. This might be anything from logging a warning
29053 (for example, while measuring existing sending rates in order to define
29054 policy), through time delays to slow down fast senders, up to rejecting the
29055 message. For example:
29056 .code
29057 # Log all senders' rates
29058 warn ratelimit = 0 / 1h / strict
29059      log_message = Sender rate $sender_rate / $sender_rate_period
29060
29061 # Slow down fast senders; note the need to truncate $sender_rate
29062 # at the decimal point.
29063 warn ratelimit = 100 / 1h / per_rcpt / strict
29064      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29065                    $sender_rate_limit }s
29066
29067 # Keep authenticated users under control
29068 deny authenticated = *
29069      ratelimit = 100 / 1d / strict / $authenticated_id
29070
29071 # System-wide rate limit
29072 defer message = Sorry, too busy. Try again later.
29073      ratelimit = 10 / 1s / $primary_hostname
29074
29075 # Restrict incoming rate from each host, with a default
29076 # set using a macro and special cases looked up in a table.
29077 defer message = Sender rate exceeds $sender_rate_limit \
29078                messages per $sender_rate_period
29079      ratelimit = ${lookup {$sender_host_address} \
29080                    cdb {DB/ratelimits.cdb} \
29081                    {$value} {RATELIMIT} }
29082 .endd
29083 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29084 especially with the &%per_rcpt%& option, you may suffer from a performance
29085 bottleneck caused by locking on the ratelimit hints database. Apart from
29086 making your ACLs less complicated, you can reduce the problem by using a
29087 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29088 this means that Exim will lose its hints data after a reboot (including retry
29089 hints, the callout cache, and ratelimit data).
29090
29091
29092
29093 .section "Address verification" "SECTaddressverification"
29094 .cindex "verifying address" "options for"
29095 .cindex "policy control" "address verification"
29096 Several of the &%verify%& conditions described in section
29097 &<<SECTaclconditions>>& cause addresses to be verified. Section
29098 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29099 The verification conditions can be followed by options that modify the
29100 verification process. The options are separated from the keyword and from each
29101 other by slashes, and some of them contain parameters. For example:
29102 .code
29103 verify = sender/callout
29104 verify = recipient/defer_ok/callout=10s,defer_ok
29105 .endd
29106 The first stage of address verification, which always happens, is to run the
29107 address through the routers, in &"verify mode"&. Routers can detect the
29108 difference between verification and routing for delivery, and their actions can
29109 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29110 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29111 The available options are as follows:
29112
29113 .ilist
29114 If the &%callout%& option is specified, successful routing to one or more
29115 remote hosts is followed by a &"callout"& to those hosts as an additional
29116 check. Callouts and their sub-options are discussed in the next section.
29117 .next
29118 If there is a defer error while doing verification routing, the ACL
29119 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29120 options, the condition is forced to be true instead. Note that this is a main
29121 verification option as well as a suboption for callouts.
29122 .next
29123 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29124 discusses the reporting of sender address verification failures.
29125 .next
29126 The &%success_on_redirect%& option causes verification always to succeed
29127 immediately after a successful redirection. By default, if a redirection
29128 generates just one address, that address is also verified. See further
29129 discussion in section &<<SECTredirwhilveri>>&.
29130 .endlist
29131
29132 .cindex "verifying address" "differentiating failures"
29133 .vindex "&$recipient_verify_failure$&"
29134 .vindex "&$sender_verify_failure$&"
29135 .vindex "&$acl_verify_message$&"
29136 After an address verification failure, &$acl_verify_message$& contains the
29137 error message that is associated with the failure. It can be preserved by
29138 coding like this:
29139 .code
29140 warn  !verify = sender
29141        set acl_m0 = $acl_verify_message
29142 .endd
29143 If you are writing your own custom rejection message or log message when
29144 denying access, you can use this variable to include information about the
29145 verification failure.
29146
29147 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29148 appropriate) contains one of the following words:
29149
29150 .ilist
29151 &%qualify%&: The address was unqualified (no domain), and the message
29152 was neither local nor came from an exempted host.
29153 .next
29154 &%route%&: Routing failed.
29155 .next
29156 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29157 occurred at or before the MAIL command (that is, on initial
29158 connection, HELO, or MAIL).
29159 .next
29160 &%recipient%&: The RCPT command in a callout was rejected.
29161 .next
29162 &%postmaster%&: The postmaster check in a callout was rejected.
29163 .endlist
29164
29165 The main use of these variables is expected to be to distinguish between
29166 rejections of MAIL and rejections of RCPT in callouts.
29167
29168
29169
29170
29171 .section "Callout verification" "SECTcallver"
29172 .cindex "verifying address" "by callout"
29173 .cindex "callout" "verification"
29174 .cindex "SMTP" "callout verification"
29175 For non-local addresses, routing verifies the domain, but is unable to do any
29176 checking of the local part. There are situations where some means of verifying
29177 the local part is desirable. One way this can be done is to make an SMTP
29178 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29179 a subsequent host for a recipient address, to see if the host accepts the
29180 address. We use the term &'callout'& to cover both cases. Note that for a
29181 sender address, the callback is not to the client host that is trying to
29182 deliver the message, but to one of the hosts that accepts incoming mail for the
29183 sender's domain.
29184
29185 Exim does not do callouts by default. If you want them to happen, you must
29186 request them by setting appropriate options on the &%verify%& condition, as
29187 described below. This facility should be used with care, because it can add a
29188 lot of resource usage to the cost of verifying an address. However, Exim does
29189 cache the results of callouts, which helps to reduce the cost. Details of
29190 caching are in section &<<SECTcallvercache>>&.
29191
29192 Recipient callouts are usually used only between hosts that are controlled by
29193 the same administration. For example, a corporate gateway host could use
29194 callouts to check for valid recipients on an internal mailserver. A successful
29195 callout does not guarantee that a real delivery to the address would succeed;
29196 on the other hand, a failing callout does guarantee that a delivery would fail.
29197
29198 If the &%callout%& option is present on a condition that verifies an address, a
29199 second stage of verification occurs if the address is successfully routed to
29200 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29201 &(manualroute)& router, where the router specifies the hosts. However, if a
29202 router that does not set up hosts routes to an &(smtp)& transport with a
29203 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29204 &%hosts_override%& set, its hosts are always used, whether or not the router
29205 supplies a host list.
29206 Callouts are only supported on &(smtp)& transports.
29207
29208 The port that is used is taken from the transport, if it is specified and is a
29209 remote transport. (For routers that do verification only, no transport need be
29210 specified.) Otherwise, the default SMTP port is used. If a remote transport
29211 specifies an outgoing interface, this is used; otherwise the interface is not
29212 specified. Likewise, the text that is used for the HELO command is taken from
29213 the transport's &%helo_data%& option; if there is no transport, the value of
29214 &$smtp_active_hostname$& is used.
29215
29216 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29217 test whether a bounce message could be delivered to the sender address. The
29218 following SMTP commands are sent:
29219 .display
29220 &`HELO `&<&'local host name'&>
29221 &`MAIL FROM:<>`&
29222 &`RCPT TO:`&<&'the address to be tested'&>
29223 &`QUIT`&
29224 .endd
29225 LHLO is used instead of HELO if the transport's &%protocol%& option is
29226 set to &"lmtp"&.
29227
29228 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29229 settings.
29230
29231 A recipient callout check is similar. By default, it also uses an empty address
29232 for the sender. This default is chosen because most hosts do not make use of
29233 the sender address when verifying a recipient. Using the same address means
29234 that a single cache entry can be used for each recipient. Some sites, however,
29235 do make use of the sender address when verifying. These are catered for by the
29236 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29237
29238 If the response to the RCPT command is a 2&'xx'& code, the verification
29239 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29240 Exim tries the next host, if any. If there is a problem with all the remote
29241 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29242 &%callout%& option is given, in which case the condition is forced to succeed.
29243
29244 .cindex "SMTP" "output flushing, disabling for callout"
29245 A callout may take a little time. For this reason, Exim normally flushes SMTP
29246 output before performing a callout in an ACL, to avoid unexpected timeouts in
29247 clients when the SMTP PIPELINING extension is in use. The flushing can be
29248 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29249
29250
29251
29252
29253 .section "Additional parameters for callouts" "CALLaddparcall"
29254 .cindex "callout" "additional parameters for"
29255 The &%callout%& option can be followed by an equals sign and a number of
29256 optional parameters, separated by commas. For example:
29257 .code
29258 verify = recipient/callout=10s,defer_ok
29259 .endd
29260 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29261 separate verify options, is retained for backwards compatibility, but is now
29262 deprecated. The additional parameters for &%callout%& are as follows:
29263
29264
29265 .vlist
29266 .vitem <&'a&~time&~interval'&>
29267 .cindex "callout" "timeout, specifying"
29268 This specifies the timeout that applies for the callout attempt to each host.
29269 For example:
29270 .code
29271 verify = sender/callout=5s
29272 .endd
29273 The default is 30 seconds. The timeout is used for each response from the
29274 remote host. It is also used for the initial connection, unless overridden by
29275 the &%connect%& parameter.
29276
29277
29278 .vitem &*connect&~=&~*&<&'time&~interval'&>
29279 .cindex "callout" "connection timeout, specifying"
29280 This parameter makes it possible to set a different (usually smaller) timeout
29281 for making the SMTP connection. For example:
29282 .code
29283 verify = sender/callout=5s,connect=1s
29284 .endd
29285 If not specified, this timeout defaults to the general timeout value.
29286
29287 .vitem &*defer_ok*&
29288 .cindex "callout" "defer, action on"
29289 When this parameter is present, failure to contact any host, or any other kind
29290 of temporary error, is treated as success by the ACL. However, the cache is not
29291 updated in this circumstance.
29292
29293 .vitem &*fullpostmaster*&
29294 .cindex "callout" "full postmaster check"
29295 This operates like the &%postmaster%& option (see below), but if the check for
29296 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29297 accordance with the specification in RFC 2821. The RFC states that the
29298 unqualified address &'postmaster'& should be accepted.
29299
29300
29301 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29302 .cindex "callout" "sender when verifying header"
29303 When verifying addresses in header lines using the &%header_sender%&
29304 verification option, Exim behaves by default as if the addresses are envelope
29305 sender addresses from a message. Callout verification therefore tests to see
29306 whether a bounce message could be delivered, by using an empty address in the
29307 MAIL command. However, it is arguable that these addresses might never be used
29308 as envelope senders, and could therefore justifiably reject bounce messages
29309 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29310 address to use in the MAIL command. For example:
29311 .code
29312 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29313 .endd
29314 This parameter is available only for the &%header_sender%& verification option.
29315
29316
29317 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29318 .cindex "callout" "overall timeout, specifying"
29319 This parameter sets an overall timeout for performing a callout verification.
29320 For example:
29321 .code
29322 verify = sender/callout=5s,maxwait=30s
29323 .endd
29324 This timeout defaults to four times the callout timeout for individual SMTP
29325 commands. The overall timeout applies when there is more than one host that can
29326 be tried. The timeout is checked before trying the next host. This prevents
29327 very long delays if there are a large number of hosts and all are timing out
29328 (for example, when network connections are timing out).
29329
29330
29331 .vitem &*no_cache*&
29332 .cindex "callout" "cache, suppressing"
29333 .cindex "caching callout, suppressing"
29334 When this parameter is given, the callout cache is neither read nor updated.
29335
29336 .vitem &*postmaster*&
29337 .cindex "callout" "postmaster; checking"
29338 When this parameter is set, a successful callout check is followed by a similar
29339 check for the local part &'postmaster'& at the same domain. If this address is
29340 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29341 the postmaster check is recorded in a cache record; if it is a failure, this is
29342 used to fail subsequent callouts for the domain without a connection being
29343 made, until the cache record expires.
29344
29345 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29346 The postmaster check uses an empty sender in the MAIL command by default.
29347 You can use this parameter to do a postmaster check using a different address.
29348 For example:
29349 .code
29350 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29351 .endd
29352 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29353 one overrides. The &%postmaster%& parameter is equivalent to this example:
29354 .code
29355 require  verify = sender/callout=postmaster_mailfrom=
29356 .endd
29357 &*Warning*&: The caching arrangements for postmaster checking do not take
29358 account of the sender address. It is assumed that either the empty address or
29359 a fixed non-empty address will be used. All that Exim remembers is that the
29360 postmaster check for the domain succeeded or failed.
29361
29362
29363 .vitem &*random*&
29364 .cindex "callout" "&""random""& check"
29365 When this parameter is set, before doing the normal callout check, Exim does a
29366 check for a &"random"& local part at the same domain. The local part is not
29367 really random &-- it is defined by the expansion of the option
29368 &%callout_random_local_part%&, which defaults to
29369 .code
29370 $primary_hostname-$tod_epoch-testing
29371 .endd
29372 The idea here is to try to determine whether the remote host accepts all local
29373 parts without checking. If it does, there is no point in doing callouts for
29374 specific local parts. If the &"random"& check succeeds, the result is saved in
29375 a cache record, and used to force the current and subsequent callout checks to
29376 succeed without a connection being made, until the cache record expires.
29377
29378 .vitem &*use_postmaster*&
29379 .cindex "callout" "sender for recipient check"
29380 This parameter applies to recipient callouts only. For example:
29381 .code
29382 deny  !verify = recipient/callout=use_postmaster
29383 .endd
29384 .vindex "&$qualify_domain$&"
29385 It causes a non-empty postmaster address to be used in the MAIL command when
29386 performing the callout for the recipient, and also for a &"random"& check if
29387 that is configured. The local part of the address is &`postmaster`& and the
29388 domain is the contents of &$qualify_domain$&.
29389
29390 .vitem &*use_sender*&
29391 This option applies to recipient callouts only. For example:
29392 .code
29393 require  verify = recipient/callout=use_sender
29394 .endd
29395 It causes the message's actual sender address to be used in the MAIL
29396 command when performing the callout, instead of an empty address. There is no
29397 need to use this option unless you know that the called hosts make use of the
29398 sender when checking recipients. If used indiscriminately, it reduces the
29399 usefulness of callout caching.
29400 .endlist
29401
29402 If you use any of the parameters that set a non-empty sender for the MAIL
29403 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29404 &%use_sender%&), you should think about possible loops. Recipient checking is
29405 usually done between two hosts that are under the same management, and the host
29406 that receives the callouts is not normally configured to do callouts itself.
29407 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29408 these circumstances.
29409
29410 However, if you use a non-empty sender address for a callout to an arbitrary
29411 host, there is the likelihood that the remote host will itself initiate a
29412 callout check back to your host. As it is checking what appears to be a message
29413 sender, it is likely to use an empty address in MAIL, thus avoiding a
29414 callout loop. However, to be on the safe side it would be best to set up your
29415 own ACLs so that they do not do sender verification checks when the recipient
29416 is the address you use for header sender or postmaster callout checking.
29417
29418 Another issue to think about when using non-empty senders for callouts is
29419 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29420 by the sender/recipient combination; thus, for any given recipient, many more
29421 actual callouts are performed than when an empty sender or postmaster is used.
29422
29423
29424
29425
29426 .section "Callout caching" "SECTcallvercache"
29427 .cindex "hints database" "callout cache"
29428 .cindex "callout" "cache, description of"
29429 .cindex "caching" "callout"
29430 Exim caches the results of callouts in order to reduce the amount of resources
29431 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29432 option. A hints database called &"callout"& is used for the cache. Two
29433 different record types are used: one records the result of a callout check for
29434 a specific address, and the other records information that applies to the
29435 entire domain (for example, that it accepts the local part &'postmaster'&).
29436
29437 When an original callout fails, a detailed SMTP error message is given about
29438 the failure. However, for subsequent failures use the cache data, this message
29439 is not available.
29440
29441 The expiry times for negative and positive address cache records are
29442 independent, and can be set by the global options &%callout_negative_expire%&
29443 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29444
29445 If a host gives a negative response to an SMTP connection, or rejects any
29446 commands up to and including
29447 .code
29448 MAIL FROM:<>
29449 .endd
29450 (but not including the MAIL command with a non-empty address),
29451 any callout attempt is bound to fail. Exim remembers such failures in a
29452 domain cache record, which it uses to fail callouts for the domain without
29453 making new connections, until the domain record times out. There are two
29454 separate expiry times for domain cache records:
29455 &%callout_domain_negative_expire%& (default 3h) and
29456 &%callout_domain_positive_expire%& (default 7d).
29457
29458 Domain records expire when the negative expiry time is reached if callouts
29459 cannot be made for the domain, or if the postmaster check failed.
29460 Otherwise, they expire when the positive expiry time is reached. This
29461 ensures that, for example, a host that stops accepting &"random"& local parts
29462 will eventually be noticed.
29463
29464 The callout caching mechanism is based on the domain of the address that is
29465 being tested. If the domain routes to several hosts, it is assumed that their
29466 behaviour will be the same.
29467
29468
29469
29470 .section "Sender address verification reporting" "SECTsenaddver"
29471 .cindex "verifying" "suppressing error details"
29472 See section &<<SECTaddressverification>>& for a general discussion of
29473 verification. When sender verification fails in an ACL, the details of the
29474 failure are given as additional output lines before the 550 response to the
29475 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29476 you might see:
29477 .code
29478 MAIL FROM:<xyz@abc.example>
29479 250 OK
29480 RCPT TO:<pqr@def.example>
29481 550-Verification failed for <xyz@abc.example>
29482 550-Called:   192.168.34.43
29483 550-Sent:     RCPT TO:<xyz@abc.example>
29484 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29485 550 Sender verification failed
29486 .endd
29487 If more than one RCPT command fails in the same way, the details are given
29488 only for the first of them. However, some administrators do not want to send
29489 out this much information. You can suppress the details by adding
29490 &`/no_details`& to the ACL statement that requests sender verification. For
29491 example:
29492 .code
29493 verify = sender/no_details
29494 .endd
29495
29496 .section "Redirection while verifying" "SECTredirwhilveri"
29497 .cindex "verifying" "redirection while"
29498 .cindex "address redirection" "while verifying"
29499 A dilemma arises when a local address is redirected by aliasing or forwarding
29500 during verification: should the generated addresses themselves be verified,
29501 or should the successful expansion of the original address be enough to verify
29502 it? By default, Exim takes the following pragmatic approach:
29503
29504 .ilist
29505 When an incoming address is redirected to just one child address, verification
29506 continues with the child address, and if that fails to verify, the original
29507 verification also fails.
29508 .next
29509 When an incoming address is redirected to more than one child address,
29510 verification does not continue. A success result is returned.
29511 .endlist
29512
29513 This seems the most reasonable behaviour for the common use of aliasing as a
29514 way of redirecting different local parts to the same mailbox. It means, for
29515 example, that a pair of alias entries of the form
29516 .code
29517 A.Wol:   aw123
29518 aw123:   :fail: Gone away, no forwarding address
29519 .endd
29520 work as expected, with both local parts causing verification failure. When a
29521 redirection generates more than one address, the behaviour is more like a
29522 mailing list, where the existence of the alias itself is sufficient for
29523 verification to succeed.
29524
29525 It is possible, however, to change the default behaviour so that all successful
29526 redirections count as successful verifications, however many new addresses are
29527 generated. This is specified by the &%success_on_redirect%& verification
29528 option. For example:
29529 .code
29530 require verify = recipient/success_on_redirect/callout=10s
29531 .endd
29532 In this example, verification succeeds if a router generates a new address, and
29533 the callout does not occur, because no address was routed to a remote host.
29534
29535 When verification is being tested via the &%-bv%& option, the treatment of
29536 redirections is as just described, unless the &%-v%& or any debugging option is
29537 also specified. In that case, full verification is done for every generated
29538 address and a report is output for each of them.
29539
29540
29541
29542 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29543 .cindex "CSA" "verifying"
29544 Client SMTP Authorization is a system that allows a site to advertise
29545 which machines are and are not permitted to send email. This is done by placing
29546 special SRV records in the DNS; these are looked up using the client's HELO
29547 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29548 Authorization checks in Exim are performed by the ACL condition:
29549 .code
29550 verify = csa
29551 .endd
29552 This fails if the client is not authorized. If there is a DNS problem, or if no
29553 valid CSA SRV record is found, or if the client is authorized, the condition
29554 succeeds. These three cases can be distinguished using the expansion variable
29555 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29556 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29557 be likely to cause problems for legitimate email.
29558
29559 The error messages produced by the CSA code include slightly more
29560 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29561 looking up the CSA SRV record, or problems looking up the CSA target
29562 address record. There are four reasons for &$csa_status$& being &"fail"&:
29563
29564 .ilist
29565 The client's host name is explicitly not authorized.
29566 .next
29567 The client's IP address does not match any of the CSA target IP addresses.
29568 .next
29569 The client's host name is authorized but it has no valid target IP addresses
29570 (for example, the target's addresses are IPv6 and the client is using IPv4).
29571 .next
29572 The client's host name has no CSA SRV record but a parent domain has asserted
29573 that all subdomains must be explicitly authorized.
29574 .endlist
29575
29576 The &%csa%& verification condition can take an argument which is the domain to
29577 use for the DNS query. The default is:
29578 .code
29579 verify = csa/$sender_helo_name
29580 .endd
29581 This implementation includes an extension to CSA. If the query domain
29582 is an address literal such as [192.0.2.95], or if it is a bare IP
29583 address, Exim searches for CSA SRV records in the reverse DNS as if
29584 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29585 meaningful to say:
29586 .code
29587 verify = csa/$sender_host_address
29588 .endd
29589 In fact, this is the check that Exim performs if the client does not say HELO.
29590 This extension can be turned off by setting the main configuration option
29591 &%dns_csa_use_reverse%& to be false.
29592
29593 If a CSA SRV record is not found for the domain itself, a search
29594 is performed through its parent domains for a record which might be
29595 making assertions about subdomains. The maximum depth of this search is limited
29596 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29597 default. Exim does not look for CSA SRV records in a top level domain, so the
29598 default settings handle HELO domains as long as seven
29599 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29600 of legitimate HELO domains.
29601
29602 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29603 direct SRV lookups, this is not sufficient because of the extra parent domain
29604 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29605 addresses into lookups in the reverse DNS space. The result of a successful
29606 lookup such as:
29607 .code
29608 ${lookup dnsdb {csa=$sender_helo_name}}
29609 .endd
29610 has two space-separated fields: an authorization code and a target host name.
29611 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
29612 authorization required but absent, or &"?"& for unknown.
29613
29614
29615
29616
29617 .section "Bounce address tag validation" "SECTverifyPRVS"
29618 .cindex "BATV, verifying"
29619 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
29620 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
29621 Genuine incoming bounce messages should therefore always be addressed to
29622 recipients that have a valid tag. This scheme is a way of detecting unwanted
29623 bounce messages caused by sender address forgeries (often called &"collateral
29624 spam"&), because the recipients of such messages do not include valid tags.
29625
29626 There are two expansion items to help with the implementation of the BATV
29627 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
29628 the original envelope sender address by using a simple key to add a hash of the
29629 address and some time-based randomizing information. The &%prvs%& expansion
29630 item creates a signed address, and the &%prvscheck%& expansion item checks one.
29631 The syntax of these expansion items is described in section
29632 &<<SECTexpansionitems>>&.
29633
29634 As an example, suppose the secret per-address keys are stored in an MySQL
29635 database. A query to look up the key for an address could be defined as a macro
29636 like this:
29637 .code
29638 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
29639                 WHERE sender='${quote_mysql:$prvscheck_address}'\
29640                 }{$value}}
29641 .endd
29642 Suppose also that the senders who make use of BATV are defined by an address
29643 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
29644 use this:
29645 .code
29646 # Bounces: drop unsigned addresses for BATV senders
29647 deny message = This address does not send an unsigned reverse path
29648      senders = :
29649      recipients = +batv_senders
29650
29651 # Bounces: In case of prvs-signed address, check signature.
29652 deny message = Invalid reverse path signature.
29653      senders = :
29654      condition  = ${prvscheck {$local_part@$domain}\
29655                   {PRVSCHECK_SQL}{1}}
29656      !condition = $prvscheck_result
29657 .endd
29658 The first statement rejects recipients for bounce messages that are addressed
29659 to plain BATV sender addresses, because it is known that BATV senders do not
29660 send out messages with plain sender addresses. The second statement rejects
29661 recipients that are prvs-signed, but with invalid signatures (either because
29662 the key is wrong, or the signature has timed out).
29663
29664 A non-prvs-signed address is not rejected by the second statement, because the
29665 &%prvscheck%& expansion yields an empty string if its first argument is not a
29666 prvs-signed address, thus causing the &%condition%& condition to be false. If
29667 the first argument is a syntactically valid prvs-signed address, the yield is
29668 the third string (in this case &"1"&), whether or not the cryptographic and
29669 timeout checks succeed. The &$prvscheck_result$& variable contains the result
29670 of the checks (empty for failure, &"1"& for success).
29671
29672 There is one more issue you must consider when implementing prvs-signing:
29673 you have to ensure that the routers accept prvs-signed addresses and
29674 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
29675 router to remove the signature with a configuration along these lines:
29676 .code
29677 batv_redirect:
29678   driver = redirect
29679   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
29680 .endd
29681 This works because, if the third argument of &%prvscheck%& is empty, the result
29682 of the expansion of a prvs-signed address is the decoded value of the original
29683 address. This router should probably be the first of your routers that handles
29684 local addresses.
29685
29686 To create BATV-signed addresses in the first place, a transport of this form
29687 can be used:
29688 .code
29689 external_smtp_batv:
29690   driver = smtp
29691   return_path = ${prvs {$return_path} \
29692                        {${lookup mysql{SELECT \
29693                        secret FROM batv_prvs WHERE \
29694                        sender='${quote_mysql:$sender_address}'} \
29695                        {$value}fail}}}
29696 .endd
29697 If no key can be found for the existing return path, no signing takes place.
29698
29699
29700
29701 .section "Using an ACL to control relaying" "SECTrelaycontrol"
29702 .cindex "&ACL;" "relay control"
29703 .cindex "relaying" "control by ACL"
29704 .cindex "policy control" "relay control"
29705 An MTA is said to &'relay'& a message if it receives it from some host and
29706 delivers it directly to another host as a result of a remote address contained
29707 within it. Redirecting a local address via an alias or forward file and then
29708 passing the message on to another host is not relaying,
29709 .cindex "&""percent hack""&"
29710 but a redirection as a result of the &"percent hack"& is.
29711
29712 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
29713 A host which is acting as a gateway or an MX backup is concerned with incoming
29714 relaying from arbitrary hosts to a specific set of domains. On the other hand,
29715 a host which is acting as a smart host for a number of clients is concerned
29716 with outgoing relaying from those clients to the Internet at large. Often the
29717 same host is fulfilling both functions,
29718 . ///
29719 . as illustrated in the diagram below,
29720 . ///
29721 but in principle these two kinds of relaying are entirely independent. What is
29722 not wanted is the transmission of mail from arbitrary remote hosts through your
29723 system to arbitrary domains.
29724
29725
29726 You can implement relay control by means of suitable statements in the ACL that
29727 runs for each RCPT command. For convenience, it is often easiest to use
29728 Exim's named list facility to define the domains and hosts involved. For
29729 example, suppose you want to do the following:
29730
29731 .ilist
29732 Deliver a number of domains to mailboxes on the local host (or process them
29733 locally in some other way). Let's say these are &'my.dom1.example'& and
29734 &'my.dom2.example'&.
29735 .next
29736 Relay mail for a number of other domains for which you are the secondary MX.
29737 These might be &'friend1.example'& and &'friend2.example'&.
29738 .next
29739 Relay mail from the hosts on your local LAN, to whatever domains are involved.
29740 Suppose your LAN is 192.168.45.0/24.
29741 .endlist
29742
29743
29744 In the main part of the configuration, you put the following definitions:
29745 .code
29746 domainlist local_domains    = my.dom1.example : my.dom2.example
29747 domainlist relay_to_domains = friend1.example : friend2.example
29748 hostlist   relay_from_hosts = 192.168.45.0/24
29749 .endd
29750 Now you can use these definitions in the ACL that is run for every RCPT
29751 command:
29752 .code
29753 acl_check_rcpt:
29754   accept domains = +local_domains : +relay_to_domains
29755   accept hosts   = +relay_from_hosts
29756 .endd
29757 The first statement accepts any RCPT command that contains an address in
29758 the local or relay domains. For any other domain, control passes to the second
29759 statement, which accepts the command only if it comes from one of the relay
29760 hosts. In practice, you will probably want to make your ACL more sophisticated
29761 than this, for example, by including sender and recipient verification. The
29762 default configuration includes a more comprehensive example, which is described
29763 in chapter &<<CHAPdefconfil>>&.
29764
29765
29766
29767 .section "Checking a relay configuration" "SECTcheralcon"
29768 .cindex "relaying" "checking control of"
29769 You can check the relay characteristics of your configuration in the same way
29770 that you can test any ACL behaviour for an incoming SMTP connection, by using
29771 the &%-bh%& option to run a fake SMTP session with which you interact.
29772
29773 For specifically testing for unwanted relaying, the host
29774 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
29775 host from the host on which Exim is running, using the normal telnet port, you
29776 will see a normal telnet connection message and then quite a long delay. Be
29777 patient. The remote host is making an SMTP connection back to your host, and
29778 trying a number of common probes to test for open relay vulnerability. The
29779 results of the tests will eventually appear on your terminal.
29780 .ecindex IIDacl
29781
29782
29783
29784 . ////////////////////////////////////////////////////////////////////////////
29785 . ////////////////////////////////////////////////////////////////////////////
29786
29787 .chapter "Content scanning at ACL time" "CHAPexiscan"
29788 .scindex IIDcosca "content scanning" "at ACL time"
29789 The extension of Exim to include content scanning at ACL time, formerly known
29790 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
29791 was integrated into the main source for Exim release 4.50, and Tom continues to
29792 maintain it. Most of the wording of this chapter is taken from Tom's
29793 specification.
29794
29795 It is also possible to scan the content of messages at other times. The
29796 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
29797 scanning after all the ACLs have run. A transport filter can be used to scan
29798 messages at delivery time (see the &%transport_filter%& option, described in
29799 chapter &<<CHAPtransportgeneric>>&).
29800
29801 If you want to include the ACL-time content-scanning features when you compile
29802 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
29803 &_Local/Makefile_&. When you do that, the Exim binary is built with:
29804
29805 .ilist
29806 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
29807 for all MIME parts for SMTP and non-SMTP messages, respectively.
29808 .next
29809 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
29810 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
29811 run at the end of message reception (the &%acl_smtp_data%& ACL).
29812 .next
29813 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
29814 of messages, or parts of messages, for debugging purposes.
29815 .next
29816 Additional expansion variables that are set in the new ACL and by the new
29817 conditions.
29818 .next
29819 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
29820 .endlist
29821
29822 There is another content-scanning configuration option for &_Local/Makefile_&,
29823 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
29824 condition is compiled, in addition to all the other content-scanning features.
29825
29826 Content-scanning is continually evolving, and new features are still being
29827 added. While such features are still unstable and liable to incompatible
29828 changes, they are made available in Exim by setting options whose names begin
29829 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
29830 this manual. You can find out about them by reading the file called
29831 &_doc/experimental.txt_&.
29832
29833 All the content-scanning facilities work on a MBOX copy of the message that is
29834 temporarily created in a file called:
29835 .display
29836 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
29837 .endd
29838 The &_.eml_& extension is a friendly hint to virus scanners that they can
29839 expect an MBOX-like structure inside that file. The file is created when the
29840 first content scanning facility is called. Subsequent calls to content
29841 scanning conditions open the same file again. The directory is recursively
29842 removed when the &%acl_smtp_data%& ACL has finished running, unless
29843 .code
29844 control = no_mbox_unspool
29845 .endd
29846 has been encountered. When the MIME ACL decodes files, they are put into the
29847 same directory by default.
29848
29849
29850
29851 .section "Scanning for viruses" "SECTscanvirus"
29852 .cindex "virus scanning"
29853 .cindex "content scanning" "for viruses"
29854 .cindex "content scanning" "the &%malware%& condition"
29855 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
29856 It supports a &"generic"& interface to scanners called via the shell, and
29857 specialized interfaces for &"daemon"& type virus scanners, which are resident
29858 in memory and thus are much faster.
29859
29860
29861 .oindex "&%av_scanner%&"
29862 You can set the &%av_scanner%& option in first part of the Exim configuration
29863 file to specify which scanner to use, together with any additional options that
29864 are needed. The basic syntax is as follows:
29865 .display
29866 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
29867 .endd
29868 If you do not set &%av_scanner%&, it defaults to
29869 .code
29870 av_scanner = sophie:/var/run/sophie
29871 .endd
29872 If the value of &%av_scanner%& starts with a dollar character, it is expanded
29873 before use.
29874 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
29875 The following scanner types are supported in this release:
29876
29877 .vlist
29878 .vitem &%aveserver%&
29879 .cindex "virus scanners" "Kaspersky"
29880 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
29881 at &url(http://www.kaspersky.com). This scanner type takes one option,
29882 which is the path to the daemon's UNIX socket. The default is shown in this
29883 example:
29884 .code
29885 av_scanner = aveserver:/var/run/aveserver
29886 .endd
29887
29888
29889 .vitem &%clamd%&
29890 .cindex "virus scanners" "clamd"
29891 This daemon-type scanner is GPL and free. You can get it at
29892 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
29893 unpack MIME containers, so it used to be recommended to unpack MIME attachments
29894 in the MIME ACL. This no longer believed to be necessary. One option is
29895 required: either the path and name of a UNIX socket file, or a hostname or IP
29896 number, and a port, separated by space, as in the second of these examples:
29897 .code
29898 av_scanner = clamd:/opt/clamd/socket
29899 av_scanner = clamd:192.0.2.3 1234
29900 av_scanner = clamd:192.0.2.3 1234:local
29901 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
29902 .endd
29903 If the value of av_scanner points to a UNIX socket file or contains the local
29904 keyword, then the ClamAV interface will pass a filename containing the data
29905 to be scanned, which will should normally result in less I/O happening and be
29906 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
29907 Exim does not assume that there is a common filesystem with the remote host.
29908 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
29909 you be running a version of ClamAV prior to 0.95.
29910
29911 The final example shows that multiple TCP targets can be specified.  Exim will
29912 randomly use one for each incoming email (i.e. it load balances them).  Note
29913 that only TCP targets may be used if specifying a list of scanners; a UNIX
29914 socket cannot be mixed in with TCP targets.  If one of the servers becomes
29915 unavailable, Exim will try the remaining one(s) until it finds one that works.
29916 When a clamd server becomes unreachable, Exim will log a message.  Exim does
29917 not keep track of scanner state between multiple messages, and the scanner
29918 selection is random, so the message will get logged in the mainlog for each
29919 email that the down scanner gets chosen first (message wrapped to be readable):
29920 .code
29921 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
29922    clamd: connection to localhost, port 3310 failed
29923    (Connection refused)
29924 .endd
29925
29926 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
29927 contributing the code for this scanner.
29928
29929 .vitem &%cmdline%&
29930 .cindex "virus scanners" "command line interface"
29931 This is the keyword for the generic command line scanner interface. It can be
29932 used to attach virus scanners that are invoked from the shell. This scanner
29933 type takes 3 mandatory options:
29934
29935 .olist
29936 The full path and name of the scanner binary, with all command line options,
29937 and a placeholder (&`%s`&) for the directory to scan.
29938
29939 .next
29940 A regular expression to match against the STDOUT and STDERR output of the
29941 virus scanner. If the expression matches, a virus was found. You must make
29942 absolutely sure that this expression matches on &"virus found"&. This is called
29943 the &"trigger"& expression.
29944
29945 .next
29946 Another regular expression, containing exactly one pair of parentheses, to
29947 match the name of the virus found in the scanners output. This is called the
29948 &"name"& expression.
29949 .endlist olist
29950
29951 For example, Sophos Sweep reports a virus on a line like this:
29952 .code
29953 Virus 'W32/Magistr-B' found in file ./those.bat
29954 .endd
29955 For the trigger expression, we can match the phrase &"found in file"&. For the
29956 name expression, we want to extract the W32/Magistr-B string, so we can match
29957 for the single quotes left and right of it. Altogether, this makes the
29958 configuration setting:
29959 .code
29960 av_scanner = cmdline:\
29961              /path/to/sweep -ss -all -rec -archive %s:\
29962              found in file:'(.+)'
29963 .endd
29964 .vitem &%drweb%&
29965 .cindex "virus scanners" "DrWeb"
29966 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
29967 argument, either a full path to a UNIX socket, or an IP address and port
29968 separated by white space, as in these examples:
29969 .code
29970 av_scanner = drweb:/var/run/drwebd.sock
29971 av_scanner = drweb:192.168.2.20 31337
29972 .endd
29973 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
29974 is used. Thanks to Alex Miller for contributing the code for this scanner.
29975
29976 .vitem &%fsecure%&
29977 .cindex "virus scanners" "F-Secure"
29978 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
29979 argument which is the path to a UNIX socket. For example:
29980 .code
29981 av_scanner = fsecure:/path/to/.fsav
29982 .endd
29983 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
29984 Thelmen for contributing the code for this scanner.
29985
29986 .vitem &%kavdaemon%&
29987 .cindex "virus scanners" "Kaspersky"
29988 This is the scanner daemon of Kaspersky Version 4. This version of the
29989 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
29990 scanner type takes one option, which is the path to the daemon's UNIX socket.
29991 For example:
29992 .code
29993 av_scanner = kavdaemon:/opt/AVP/AvpCtl
29994 .endd
29995 The default path is &_/var/run/AvpCtl_&.
29996
29997 .vitem &%mksd%&
29998 .cindex "virus scanners" "mksd"
29999 This is a daemon type scanner that is aimed mainly at Polish users, though some
30000 parts of documentation are now available in English. You can get it at
30001 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30002 the maximum number of processes used simultaneously to scan the attachments,
30003 provided that the demime facility is employed and also provided that mksd has
30004 been run with at least the same number of child processes. For example:
30005 .code
30006 av_scanner = mksd:2
30007 .endd
30008 You can safely omit this option (the default value is 1).
30009
30010 .vitem &%sock%&
30011 .cindex "virus scanners" "simple socket-connected"
30012 This is a general-purpose way of talking to simple scanner daemons
30013 running on the local machine.
30014 There are four options:
30015 an address (which may be an IP addres and port, or the path of a Unix socket),
30016 a commandline to send (may include a single %s which will be replaced with
30017 the path to the mail file to be scanned),
30018 an RE to trigger on from the returned data,
30019 an RE to extract malware_name from the returned data.
30020 For example:
30021 .code
30022 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30023 .endd
30024 Default for the socket specifier is &_/tmp/malware.sock_&.
30025 Default for the commandline is &_%s\n_&.
30026 Both regular-expressions are required.
30027
30028 .vitem &%sophie%&
30029 .cindex "virus scanners" "Sophos and Sophie"
30030 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30031 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30032 for this scanner type is the path to the UNIX socket that Sophie uses for
30033 client communication. For example:
30034 .code
30035 av_scanner = sophie:/tmp/sophie
30036 .endd
30037 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30038 the option.
30039 .endlist
30040
30041 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30042 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30043 ACL.
30044
30045 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30046 makes it possible to use different scanners. See further below for an example.
30047 The &%malware%& condition caches its results, so when you use it multiple times
30048 for the same message, the actual scanning process is only carried out once.
30049 However, using expandable items in &%av_scanner%& disables this caching, in
30050 which case each use of the &%malware%& condition causes a new scan of the
30051 message.
30052
30053 The &%malware%& condition takes a right-hand argument that is expanded before
30054 use. It can then be one of
30055
30056 .ilist
30057 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30058 The condition succeeds if a virus was found, and fail otherwise. This is the
30059 recommended usage.
30060 .next
30061 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30062 the condition fails immediately.
30063 .next
30064 A regular expression, in which case the message is scanned for viruses. The
30065 condition succeeds if a virus is found and its name matches the regular
30066 expression. This allows you to take special actions on certain types of virus.
30067 .endlist
30068
30069 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
30070 even if there is a problem with the virus scanner. Otherwise, such a problem
30071 causes the ACL to defer.
30072
30073 .vindex "&$malware_name$&"
30074 When a virus is found, the condition sets up an expansion variable called
30075 &$malware_name$& that contains the name of the virus. You can use it in a
30076 &%message%& modifier that specifies the error returned to the sender, and/or in
30077 logging data.
30078
30079 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30080 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30081 &%malware%& condition.
30082
30083 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30084 imposed by your anti-virus scanner.
30085
30086 Here is a very simple scanning example:
30087 .code
30088 deny message = This message contains malware ($malware_name)
30089      demime = *
30090      malware = *
30091 .endd
30092 The next example accepts messages when there is a problem with the scanner:
30093 .code
30094 deny message = This message contains malware ($malware_name)
30095      demime = *
30096      malware = */defer_ok
30097 .endd
30098 The next example shows how to use an ACL variable to scan with both sophie and
30099 aveserver. It assumes you have set:
30100 .code
30101 av_scanner = $acl_m0
30102 .endd
30103 in the main Exim configuration.
30104 .code
30105 deny message = This message contains malware ($malware_name)
30106      set acl_m0 = sophie
30107      malware = *
30108
30109 deny message = This message contains malware ($malware_name)
30110      set acl_m0 = aveserver
30111      malware = *
30112 .endd
30113
30114
30115 .section "Scanning with SpamAssassin" "SECTscanspamass"
30116 .cindex "content scanning" "for spam"
30117 .cindex "spam scanning"
30118 .cindex "SpamAssassin"
30119 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30120 score and a report for the message. You can get SpamAssassin at
30121 &url(http://www.spamassassin.org), or, if you have a working Perl
30122 installation, you can use CPAN by running:
30123 .code
30124 perl -MCPAN -e 'install Mail::SpamAssassin'
30125 .endd
30126 SpamAssassin has its own set of configuration files. Please review its
30127 documentation to see how you can tweak it. The default installation should work
30128 nicely, however.
30129
30130 .oindex "&%spamd_address%&"
30131 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
30132 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
30133 port for &%spamd%&, you must set the &%spamd_address%& option in the global
30134 part of the Exim configuration as follows (example):
30135 .code
30136 spamd_address = 192.168.99.45 387
30137 .endd
30138 You do not need to set this option if you use the default. As of version 2.60,
30139 &%spamd%& also supports communication over UNIX sockets. If you want to use
30140 these, supply &%spamd_address%& with an absolute file name instead of a
30141 address/port pair:
30142 .code
30143 spamd_address = /var/run/spamd_socket
30144 .endd
30145 You can have multiple &%spamd%& servers to improve scalability. These can
30146 reside on other hardware reachable over the network. To specify multiple
30147 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30148 option, separated with colons:
30149 .code
30150 spamd_address = 192.168.2.10 783 : \
30151                 192.168.2.11 783 : \
30152                 192.168.2.12 783
30153 .endd
30154 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
30155 fashion. When a server fails to respond to the connection attempt, all other
30156 servers are tried until one succeeds. If no server responds, the &%spam%&
30157 condition defers.
30158
30159 &*Warning*&: It is not possible to use the UNIX socket connection method with
30160 multiple &%spamd%& servers.
30161
30162 The &%spamd_address%& variable is expanded before use if it starts with
30163 a dollar sign. In this case, the expansion may return a string that is
30164 used as the list so that multiple spamd servers can be the result of an
30165 expansion.
30166
30167 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30168 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30169 .code
30170 deny message = This message was classified as SPAM
30171      spam = joe
30172 .endd
30173 The right-hand side of the &%spam%& condition specifies a name. This is
30174 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30175 to scan using a specific profile, but rather use the SpamAssassin system-wide
30176 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30177 However, you must put something on the right-hand side.
30178
30179 The name allows you to use per-domain or per-user antispam profiles in
30180 principle, but this is not straightforward in practice, because a message may
30181 have multiple recipients, not necessarily all in the same domain. Because the
30182 &%spam%& condition has to be called from a DATA ACL in order to be able to
30183 read the contents of the message, the variables &$local_part$& and &$domain$&
30184 are not set.
30185
30186 The right-hand side of the &%spam%& condition is expanded before being used, so
30187 you can put lookups or conditions there. When the right-hand side evaluates to
30188 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30189
30190
30191 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30192 large ones may cause significant performance degradation. As most spam messages
30193 are quite small, it is recommended that you do not scan the big ones. For
30194 example:
30195 .code
30196 deny message = This message was classified as SPAM
30197      condition = ${if < {$message_size}{10K}}
30198      spam = nobody
30199 .endd
30200
30201 The &%spam%& condition returns true if the threshold specified in the user's
30202 SpamAssassin profile has been matched or exceeded. If you want to use the
30203 &%spam%& condition for its side effects (see the variables below), you can make
30204 it always return &"true"& by appending &`:true`& to the username.
30205
30206 .cindex "spam scanning" "returned variables"
30207 When the &%spam%& condition is run, it sets up a number of expansion
30208 variables. These variables are saved with the received message, thus they are
30209 available for use at delivery time.
30210
30211 .vlist
30212 .vitem &$spam_score$&
30213 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30214 for inclusion in log or reject messages.
30215
30216 .vitem &$spam_score_int$&
30217 The spam score of the message, multiplied by ten, as an integer value. For
30218 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30219 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30220 The integer value is useful for numeric comparisons in conditions.
30221
30222 .vitem &$spam_bar$&
30223 A string consisting of a number of &"+"& or &"-"& characters, representing the
30224 integer part of the spam score value. A spam score of 4.4 would have a
30225 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30226 headers, since MUAs can match on such strings.
30227
30228 .vitem &$spam_report$&
30229 A multiline text table, containing the full SpamAssassin report for the
30230 message. Useful for inclusion in headers or reject messages.
30231 .endlist
30232
30233 The &%spam%& condition caches its results unless expansion in
30234 spamd_address was used. If you call it again with the same user name, it
30235 does not scan again, but rather returns the same values as before.
30236
30237 The &%spam%& condition returns DEFER if there is any error while running
30238 the message through SpamAssassin or if the expansion of spamd_address
30239 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30240 statement block), append &`/defer_ok`& to the right-hand side of the
30241 spam condition, like this:
30242 .code
30243 deny message = This message was classified as SPAM
30244      spam    = joe/defer_ok
30245 .endd
30246 This causes messages to be accepted even if there is a problem with &%spamd%&.
30247
30248 Here is a longer, commented example of the use of the &%spam%&
30249 condition:
30250 .code
30251 # put headers in all messages (no matter if spam or not)
30252 warn  spam = nobody:true
30253       add_header = X-Spam-Score: $spam_score ($spam_bar)
30254       add_header = X-Spam-Report: $spam_report
30255
30256 # add second subject line with *SPAM* marker when message
30257 # is over threshold
30258 warn  spam = nobody
30259       add_header = Subject: *SPAM* $h_Subject:
30260
30261 # reject spam at high scores (> 12)
30262 deny  message = This message scored $spam_score spam points.
30263       spam = nobody:true
30264       condition = ${if >{$spam_score_int}{120}{1}{0}}
30265 .endd
30266
30267
30268
30269 .section "Scanning MIME parts" "SECTscanmimepart"
30270 .cindex "content scanning" "MIME parts"
30271 .cindex "MIME content scanning"
30272 .oindex "&%acl_smtp_mime%&"
30273 .oindex "&%acl_not_smtp_mime%&"
30274 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30275 each MIME part of an SMTP message, including multipart types, in the sequence
30276 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30277 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30278 options may both refer to the same ACL if you want the same processing in both
30279 cases.
30280
30281 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30282 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30283 the case of a non-SMTP message. However, a MIME ACL is called only if the
30284 message contains a &'Content-Type:'& header line. When a call to a MIME
30285 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30286 result code is sent to the client. In the case of an SMTP message, the
30287 &%acl_smtp_data%& ACL is not called when this happens.
30288
30289 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30290 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30291 condition to match against the raw MIME part. You can also use the
30292 &%mime_regex%& condition to match against the decoded MIME part (see section
30293 &<<SECTscanregex>>&).
30294
30295 At the start of a MIME ACL, a number of variables are set from the header
30296 information for the relevant MIME part. These are described below. The contents
30297 of the MIME part are not by default decoded into a disk file except for MIME
30298 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30299 part into a disk file, you can use the &%decode%& condition. The general
30300 syntax is:
30301 .display
30302 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30303 .endd
30304 The right hand side is expanded before use. After expansion,
30305 the value can be:
30306
30307 .olist
30308 &"0"& or &"false"&, in which case no decoding is done.
30309 .next
30310 The string &"default"&. In that case, the file is put in the temporary
30311 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30312 a sequential file name consisting of the message id and a sequence number. The
30313 full path and name is available in &$mime_decoded_filename$& after decoding.
30314 .next
30315 A full path name starting with a slash. If the full name is an existing
30316 directory, it is used as a replacement for the default directory. The filename
30317 is then sequentially assigned. If the path does not exist, it is used as
30318 the full path and file name.
30319 .next
30320 If the string does not start with a slash, it is used as the
30321 filename, and the default path is then used.
30322 .endlist
30323 The &%decode%& condition normally succeeds. It is only false for syntax
30324 errors or unusual circumstances such as memory shortages. You can easily decode
30325 a file with its original, proposed filename using
30326 .code
30327 decode = $mime_filename
30328 .endd
30329 However, you should keep in mind that &$mime_filename$& might contain
30330 anything. If you place files outside of the default path, they are not
30331 automatically unlinked.
30332
30333 For RFC822 attachments (these are messages attached to messages, with a
30334 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30335 as for the primary message, only that the &$mime_is_rfc822$& expansion
30336 variable is set (see below). Attached messages are always decoded to disk
30337 before being checked, and the files are unlinked once the check is done.
30338
30339 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30340 used to match regular expressions against raw and decoded MIME parts,
30341 respectively. They are described in section &<<SECTscanregex>>&.
30342
30343 .cindex "MIME content scanning" "returned variables"
30344 The following list describes all expansion variables that are
30345 available in the MIME ACL:
30346
30347 .vlist
30348 .vitem &$mime_boundary$&
30349 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30350 have a boundary string, which is stored in this variable. If the current part
30351 has no boundary parameter in the &'Content-Type:'& header, this variable
30352 contains the empty string.
30353
30354 .vitem &$mime_charset$&
30355 This variable contains the character set identifier, if one was found in the
30356 &'Content-Type:'& header. Examples for charset identifiers are:
30357 .code
30358 us-ascii
30359 gb2312 (Chinese)
30360 iso-8859-1
30361 .endd
30362 Please note that this value is not normalized, so you should do matches
30363 case-insensitively.
30364
30365 .vitem &$mime_content_description$&
30366 This variable contains the normalized content of the &'Content-Description:'&
30367 header. It can contain a human-readable description of the parts content. Some
30368 implementations repeat the filename for attachments here, but they are usually
30369 only used for display purposes.
30370
30371 .vitem &$mime_content_disposition$&
30372 This variable contains the normalized content of the &'Content-Disposition:'&
30373 header. You can expect strings like &"attachment"& or &"inline"& here.
30374
30375 .vitem &$mime_content_id$&
30376 This variable contains the normalized content of the &'Content-ID:'& header.
30377 This is a unique ID that can be used to reference a part from another part.
30378
30379 .vitem &$mime_content_size$&
30380 This variable is set only after the &%decode%& modifier (see above) has been
30381 successfully run. It contains the size of the decoded part in kilobytes. The
30382 size is always rounded up to full kilobytes, so only a completely empty part
30383 has a &$mime_content_size$& of zero.
30384
30385 .vitem &$mime_content_transfer_encoding$&
30386 This variable contains the normalized content of the
30387 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30388 type. Typical values are &"base64"& and &"quoted-printable"&.
30389
30390 .vitem &$mime_content_type$&
30391 If the MIME part has a &'Content-Type:'& header, this variable contains its
30392 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30393 are some examples of popular MIME types, as they may appear in this variable:
30394 .code
30395 text/plain
30396 text/html
30397 application/octet-stream
30398 image/jpeg
30399 audio/midi
30400 .endd
30401 If the MIME part has no &'Content-Type:'& header, this variable contains the
30402 empty string.
30403
30404 .vitem &$mime_decoded_filename$&
30405 This variable is set only after the &%decode%& modifier (see above) has been
30406 successfully run. It contains the full path and file name of the file
30407 containing the decoded data.
30408 .endlist
30409
30410 .cindex "RFC 2047"
30411 .vlist
30412 .vitem &$mime_filename$&
30413 This is perhaps the most important of the MIME variables. It contains a
30414 proposed filename for an attachment, if one was found in either the
30415 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30416 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30417 found, this variable contains the empty string.
30418
30419 .vitem &$mime_is_coverletter$&
30420 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30421 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30422 content in the cover letter, while not restricting attachments at all.
30423
30424 The variable contains 1 (true) for a MIME part believed to be part of the
30425 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30426 follows:
30427
30428 .olist
30429 The outermost MIME part of a message is always a cover letter.
30430
30431 .next
30432 If a multipart/alternative or multipart/related MIME part is a cover letter,
30433 so are all MIME subparts within that multipart.
30434
30435 .next
30436 If any other multipart is a cover letter, the first subpart is a cover letter,
30437 and the rest are attachments.
30438
30439 .next
30440 All parts contained within an attachment multipart are attachments.
30441 .endlist olist
30442
30443 As an example, the following will ban &"HTML mail"& (including that sent with
30444 alternative plain text), while allowing HTML files to be attached. HTML
30445 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30446 .code
30447 deny message = HTML mail is not accepted here
30448 !condition = $mime_is_rfc822
30449 condition = $mime_is_coverletter
30450 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30451 .endd
30452 .vitem &$mime_is_multipart$&
30453 This variable has the value 1 (true) when the current part has the main type
30454 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30455 Since multipart entities only serve as containers for other parts, you may not
30456 want to carry out specific actions on them.
30457
30458 .vitem &$mime_is_rfc822$&
30459 This variable has the value 1 (true) if the current part is not a part of the
30460 checked message itself, but part of an attached message. Attached message
30461 decoding is fully recursive.
30462
30463 .vitem &$mime_part_count$&
30464 This variable is a counter that is raised for each processed MIME part. It
30465 starts at zero for the very first part (which is usually a multipart). The
30466 counter is per-message, so it is reset when processing RFC822 attachments (see
30467 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
30468 complete, so you can use it in the DATA ACL to determine the number of MIME
30469 parts of a message. For non-MIME messages, this variable contains the value -1.
30470 .endlist
30471
30472
30473
30474 .section "Scanning with regular expressions" "SECTscanregex"
30475 .cindex "content scanning" "with regular expressions"
30476 .cindex "regular expressions" "content scanning with"
30477 You can specify your own custom regular expression matches on the full body of
30478 the message, or on individual MIME parts.
30479
30480 The &%regex%& condition takes one or more regular expressions as arguments and
30481 matches them against the full message (when called in the DATA ACL) or a raw
30482 MIME part (when called in the MIME ACL). The &%regex%& condition matches
30483 linewise, with a maximum line length of 32K characters. That means you cannot
30484 have multiline matches with the &%regex%& condition.
30485
30486 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
30487 to 32K of decoded content (the whole content at once, not linewise). If the
30488 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
30489 is decoded automatically when &%mime_regex%& is executed (using default path
30490 and filename values). If the decoded data is larger than  32K, only the first
30491 32K characters are checked.
30492
30493 The regular expressions are passed as a colon-separated list. To include a
30494 literal colon, you must double it. Since the whole right-hand side string is
30495 expanded before being used, you must also escape dollar signs and backslashes
30496 with more backslashes, or use the &`\N`& facility to disable expansion.
30497 Here is a simple example that contains two regular expressions:
30498 .code
30499 deny message = contains blacklisted regex ($regex_match_string)
30500      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
30501 .endd
30502 The conditions returns true if any one of the regular expressions matches. The
30503 &$regex_match_string$& expansion variable is then set up and contains the
30504 matching regular expression.
30505
30506 &*Warning*&: With large messages, these conditions can be fairly
30507 CPU-intensive.
30508
30509
30510
30511
30512 .section "The demime condition" "SECTdemimecond"
30513 .cindex "content scanning" "MIME checking"
30514 .cindex "MIME content scanning"
30515 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
30516 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
30517 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
30518 ACL functionality, but provides no additional facilities. Please note that this
30519 condition is deprecated and kept only for backward compatibility. You must set
30520 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
30521 use the &%demime%& condition.
30522
30523 The &%demime%& condition unpacks MIME containers in the message. It detects
30524 errors in MIME containers and can match file extensions found in the message
30525 against a list. Using this facility produces files containing the unpacked MIME
30526 parts of the message in the temporary scan directory. If you do antivirus
30527 scanning, it is recommended that you use the &%demime%& condition before the
30528 antivirus (&%malware%&) condition.
30529
30530 On the right-hand side of the &%demime%& condition you can pass a
30531 colon-separated list of file extensions that it should match against. For
30532 example:
30533 .code
30534 deny message = Found blacklisted file attachment
30535      demime  = vbs:com:bat:pif:prf:lnk
30536 .endd
30537 If one of the file extensions is found, the condition is true, otherwise it is
30538 false. If there is a temporary error while demimeing (for example, &"disk
30539 full"&), the condition defers, and the message is temporarily rejected (unless
30540 the condition is on a &%warn%& verb).
30541
30542 The right-hand side is expanded before being treated as a list, so you can have
30543 conditions and lookups there. If it expands to an empty string, &"false"&, or
30544 zero (&"0"&), no demimeing is done and the condition is false.
30545
30546 The &%demime%& condition set the following variables:
30547
30548 .vlist
30549 .vitem &$demime_errorlevel$&
30550 .vindex "&$demime_errorlevel$&"
30551 When an error is detected in a MIME container, this variable contains the
30552 severity of the error, as an integer number. The higher the value, the more
30553 severe the error (the current maximum value is 3). If this variable is unset or
30554 zero, no error occurred.
30555
30556 .vitem &$demime_reason$&
30557 .vindex "&$demime_reason$&"
30558 When &$demime_errorlevel$& is greater than zero, this variable contains a
30559 human-readable text string describing the MIME error that occurred.
30560 .endlist
30561
30562 .vlist
30563 .vitem &$found_extension$&
30564 .vindex "&$found_extension$&"
30565 When the &%demime%& condition is true, this variable contains the file
30566 extension it found.
30567 .endlist
30568
30569 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30570 the &%demime%& condition, and are not changed on subsequent calls.
30571
30572 If you do not want to check for file extensions, but rather use the &%demime%&
30573 condition for unpacking or error checking purposes, pass &"*"& as the
30574 right-hand side value. Here is a more elaborate example of how to use this
30575 facility:
30576 .code
30577 # Reject messages with serious MIME container errors
30578 deny  message = Found MIME error ($demime_reason).
30579       demime = *
30580       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30581
30582 # Reject known virus spreading file extensions.
30583 # Accepting these is pretty much braindead.
30584 deny  message = contains $found_extension file (blacklisted).
30585       demime  = com:vbs:bat:pif:scr
30586
30587 # Freeze .exe and .doc files. Postmaster can
30588 # examine them and eventually thaw them.
30589 deny  log_message = Another $found_extension file.
30590       demime = exe:doc
30591       control = freeze
30592 .endd
30593 .ecindex IIDcosca
30594
30595
30596
30597
30598 . ////////////////////////////////////////////////////////////////////////////
30599 . ////////////////////////////////////////////////////////////////////////////
30600
30601 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
30602          "Local scan function"
30603 .scindex IIDlosca "&[local_scan()]& function" "description of"
30604 .cindex "customizing" "input scan using C function"
30605 .cindex "policy control" "by local scan function"
30606 In these days of email worms, viruses, and ever-increasing spam, some sites
30607 want to apply a lot of checking to messages before accepting them.
30608
30609 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
30610 passing messages to external virus and spam scanning software. You can also do
30611 a certain amount in Exim itself through string expansions and the &%condition%&
30612 condition in the ACL that runs after the SMTP DATA command or the ACL for
30613 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
30614
30615 To allow for further customization to a site's own requirements, there is the
30616 possibility of linking Exim with a private message scanning function, written
30617 in C. If you want to run code that is written in something other than C, you
30618 can of course use a little C stub to call it.
30619
30620 The local scan function is run once for every incoming message, at the point
30621 when Exim is just about to accept the message.
30622 It can therefore be used to control non-SMTP messages from local processes as
30623 well as messages arriving via SMTP.
30624
30625 Exim applies a timeout to calls of the local scan function, and there is an
30626 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
30627 Zero means &"no timeout"&.
30628 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
30629 before calling the local scan function, so that the most common types of crash
30630 are caught. If the timeout is exceeded or one of those signals is caught, the
30631 incoming message is rejected with a temporary error if it is an SMTP message.
30632 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
30633 code. The incident is logged on the main and reject logs.
30634
30635
30636
30637 .section "Building Exim to use a local scan function" "SECID207"
30638 .cindex "&[local_scan()]& function" "building Exim to use"
30639 To make use of the local scan function feature, you must tell Exim where your
30640 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
30641 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
30642 directory, so you might set
30643 .code
30644 LOCAL_SCAN_SOURCE=Local/local_scan.c
30645 .endd
30646 for example. The function must be called &[local_scan()]&. It is called by
30647 Exim after it has received a message, when the success return code is about to
30648 be sent. This is after all the ACLs have been run. The return code from your
30649 function controls whether the message is actually accepted or not. There is a
30650 commented template function (that just accepts the message) in the file
30651 _src/local_scan.c_.
30652
30653 If you want to make use of Exim's run time configuration file to set options
30654 for your &[local_scan()]& function, you must also set
30655 .code
30656 LOCAL_SCAN_HAS_OPTIONS=yes
30657 .endd
30658 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
30659
30660
30661
30662
30663 .section "API for local_scan()" "SECTapiforloc"
30664 .cindex "&[local_scan()]& function" "API description"
30665 You must include this line near the start of your code:
30666 .code
30667 #include "local_scan.h"
30668 .endd
30669 This header file defines a number of variables and other values, and the
30670 prototype for the function itself. Exim is coded to use unsigned char values
30671 almost exclusively, and one of the things this header defines is a shorthand
30672 for &`unsigned char`& called &`uschar`&.
30673 It also contains the following macro definitions, to simplify casting character
30674 strings and pointers to character strings:
30675 .code
30676 #define CS   (char *)
30677 #define CCS  (const char *)
30678 #define CSS  (char **)
30679 #define US   (unsigned char *)
30680 #define CUS  (const unsigned char *)
30681 #define USS  (unsigned char **)
30682 .endd
30683 The function prototype for &[local_scan()]& is:
30684 .code
30685 extern int local_scan(int fd, uschar **return_text);
30686 .endd
30687 The arguments are as follows:
30688
30689 .ilist
30690 &%fd%& is a file descriptor for the file that contains the body of the message
30691 (the -D file). The file is open for reading and writing, but updating it is not
30692 recommended. &*Warning*&: You must &'not'& close this file descriptor.
30693
30694 The descriptor is positioned at character 19 of the file, which is the first
30695 character of the body itself, because the first 19 characters are the message
30696 id followed by &`-D`& and a newline. If you rewind the file, you should use the
30697 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
30698 case this changes in some future version.
30699 .next
30700 &%return_text%& is an address which you can use to return a pointer to a text
30701 string at the end of the function. The value it points to on entry is NULL.
30702 .endlist
30703
30704 The function must return an &%int%& value which is one of the following macros:
30705
30706 .vlist
30707 .vitem &`LOCAL_SCAN_ACCEPT`&
30708 .vindex "&$local_scan_data$&"
30709 The message is accepted. If you pass back a string of text, it is saved with
30710 the message, and made available in the variable &$local_scan_data$&. No
30711 newlines are permitted (if there are any, they are turned into spaces) and the
30712 maximum length of text is 1000 characters.
30713
30714 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
30715 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30716 queued without immediate delivery, and is frozen.
30717
30718 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
30719 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30720 queued without immediate delivery.
30721
30722 .vitem &`LOCAL_SCAN_REJECT`&
30723 The message is rejected; the returned text is used as an error message which is
30724 passed back to the sender and which is also logged. Newlines are permitted &--
30725 they cause a multiline response for SMTP rejections, but are converted to
30726 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
30727 used.
30728
30729 .vitem &`LOCAL_SCAN_TEMPREJECT`&
30730 The message is temporarily rejected; the returned text is used as an error
30731 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
30732 problem"& is used.
30733
30734 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
30735 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
30736 message is not written to the reject log. It has the effect of unsetting the
30737 &%rejected_header%& log selector for just this rejection. If
30738 &%rejected_header%& is already unset (see the discussion of the
30739 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
30740 same as LOCAL_SCAN_REJECT.
30741
30742 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
30743 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
30744 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
30745 .endlist
30746
30747 If the message is not being received by interactive SMTP, rejections are
30748 reported by writing to &%stderr%& or by sending an email, as configured by the
30749 &%-oe%& command line options.
30750
30751
30752
30753 .section "Configuration options for local_scan()" "SECTconoptloc"
30754 .cindex "&[local_scan()]& function" "configuration options"
30755 It is possible to have option settings in the main configuration file
30756 that set values in static variables in the &[local_scan()]& module. If you
30757 want to do this, you must have the line
30758 .code
30759 LOCAL_SCAN_HAS_OPTIONS=yes
30760 .endd
30761 in your &_Local/Makefile_& when you build Exim. (This line is in
30762 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
30763 file, you must define static variables to hold the option values, and a table
30764 to define them.
30765
30766 The table must be a vector called &%local_scan_options%&, of type
30767 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
30768 and a pointer to the variable that holds the value. The entries must appear in
30769 alphabetical order. Following &%local_scan_options%& you must also define a
30770 variable called &%local_scan_options_count%& that contains the number of
30771 entries in the table. Here is a short example, showing two kinds of option:
30772 .code
30773 static int my_integer_option = 42;
30774 static uschar *my_string_option = US"a default string";
30775
30776 optionlist local_scan_options[] = {
30777   { "my_integer", opt_int,       &my_integer_option },
30778   { "my_string",  opt_stringptr, &my_string_option }
30779 };
30780
30781 int local_scan_options_count =
30782   sizeof(local_scan_options)/sizeof(optionlist);
30783 .endd
30784 The values of the variables can now be changed from Exim's runtime
30785 configuration file by including a local scan section as in this example:
30786 .code
30787 begin local_scan
30788 my_integer = 99
30789 my_string = some string of text...
30790 .endd
30791 The available types of option data are as follows:
30792
30793 .vlist
30794 .vitem &*opt_bool*&
30795 This specifies a boolean (true/false) option. The address should point to a
30796 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
30797 that are defined as &"1"& and &"0"&, respectively. If you want to detect
30798 whether such a variable has been set at all, you can initialize it to
30799 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
30800 values.)
30801
30802 .vitem &*opt_fixed*&
30803 This specifies a fixed point number, such as is used for load averages.
30804 The address should point to a variable of type &`int`&. The value is stored
30805 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
30806
30807 .vitem &*opt_int*&
30808 This specifies an integer; the address should point to a variable of type
30809 &`int`&. The value may be specified in any of the integer formats accepted by
30810 Exim.
30811
30812 .vitem &*opt_mkint*&
30813 This is the same as &%opt_int%&, except that when such a value is output in a
30814 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
30815 printed with the suffix K or M.
30816
30817 .vitem &*opt_octint*&
30818 This also specifies an integer, but the value is always interpreted as an
30819 octal integer, whether or not it starts with the digit zero, and it is
30820 always output in octal.
30821
30822 .vitem &*opt_stringptr*&
30823 This specifies a string value; the address must be a pointer to a
30824 variable that points to a string (for example, of type &`uschar *`&).
30825
30826 .vitem &*opt_time*&
30827 This specifies a time interval value. The address must point to a variable of
30828 type &`int`&. The value that is placed there is a number of seconds.
30829 .endlist
30830
30831 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
30832 out the values of all the &[local_scan()]& options.
30833
30834
30835
30836 .section "Available Exim variables" "SECID208"
30837 .cindex "&[local_scan()]& function" "available Exim variables"
30838 The header &_local_scan.h_& gives you access to a number of C variables. These
30839 are the only ones that are guaranteed to be maintained from release to release.
30840 Note, however, that you can obtain the value of any Exim expansion variable,
30841 including &$recipients$&, by calling &'expand_string()'&. The exported
30842 C variables are as follows:
30843
30844 .vlist
30845 .vitem &*int&~body_linecount*&
30846 This variable contains the number of lines in the message's body.
30847
30848 .vitem &*int&~body_zerocount*&
30849 This variable contains the number of binary zero bytes in the message's body.
30850
30851 .vitem &*unsigned&~int&~debug_selector*&
30852 This variable is set to zero when no debugging is taking place. Otherwise, it
30853 is a bitmap of debugging selectors. Two bits are identified for use in
30854 &[local_scan()]&; they are defined as macros:
30855
30856 .ilist
30857 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
30858 testing option that is not privileged &-- any caller may set it. All the
30859 other selector bits can be set only by admin users.
30860
30861 .next
30862 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
30863 by the &`+local_scan`& debug selector. It is not included in the default set
30864 of debugging bits.
30865 .endlist ilist
30866
30867 Thus, to write to the debugging output only when &`+local_scan`& has been
30868 selected, you should use code like this:
30869 .code
30870 if ((debug_selector & D_local_scan) != 0)
30871   debug_printf("xxx", ...);
30872 .endd
30873 .vitem &*uschar&~*expand_string_message*&
30874 After a failing call to &'expand_string()'& (returned value NULL), the
30875 variable &%expand_string_message%& contains the error message, zero-terminated.
30876
30877 .vitem &*header_line&~*header_list*&
30878 A pointer to a chain of header lines. The &%header_line%& structure is
30879 discussed below.
30880
30881 .vitem &*header_line&~*header_last*&
30882 A pointer to the last of the header lines.
30883
30884 .vitem &*uschar&~*headers_charset*&
30885 The value of the &%headers_charset%& configuration option.
30886
30887 .vitem &*BOOL&~host_checking*&
30888 This variable is TRUE during a host checking session that is initiated by the
30889 &%-bh%& command line option.
30890
30891 .vitem &*uschar&~*interface_address*&
30892 The IP address of the interface that received the message, as a string. This
30893 is NULL for locally submitted messages.
30894
30895 .vitem &*int&~interface_port*&
30896 The port on which this message was received. When testing with the &%-bh%&
30897 command line option, the value of this variable is -1 unless a port has been
30898 specified via the &%-oMi%& option.
30899
30900 .vitem &*uschar&~*message_id*&
30901 This variable contains Exim's message id for the incoming message (the value of
30902 &$message_exim_id$&) as a zero-terminated string.
30903
30904 .vitem &*uschar&~*received_protocol*&
30905 The name of the protocol by which the message was received.
30906
30907 .vitem &*int&~recipients_count*&
30908 The number of accepted recipients.
30909
30910 .vitem &*recipient_item&~*recipients_list*&
30911 .cindex "recipient" "adding in local scan"
30912 .cindex "recipient" "removing in local scan"
30913 The list of accepted recipients, held in a vector of length
30914 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
30915 can add additional recipients by calling &'receive_add_recipient()'& (see
30916 below). You can delete recipients by removing them from the vector and
30917 adjusting the value in &%recipients_count%&. In particular, by setting
30918 &%recipients_count%& to zero you remove all recipients. If you then return the
30919 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
30920 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
30921 and then call &'receive_add_recipient()'& as often as needed.
30922
30923 .vitem &*uschar&~*sender_address*&
30924 The envelope sender address. For bounce messages this is the empty string.
30925
30926 .vitem &*uschar&~*sender_host_address*&
30927 The IP address of the sending host, as a string. This is NULL for
30928 locally-submitted messages.
30929
30930 .vitem &*uschar&~*sender_host_authenticated*&
30931 The name of the authentication mechanism that was used, or NULL if the message
30932 was not received over an authenticated SMTP connection.
30933
30934 .vitem &*uschar&~*sender_host_name*&
30935 The name of the sending host, if known.
30936
30937 .vitem &*int&~sender_host_port*&
30938 The port on the sending host.
30939
30940 .vitem &*BOOL&~smtp_input*&
30941 This variable is TRUE for all SMTP input, including BSMTP.
30942
30943 .vitem &*BOOL&~smtp_batched_input*&
30944 This variable is TRUE for BSMTP input.
30945
30946 .vitem &*int&~store_pool*&
30947 The contents of this variable control which pool of memory is used for new
30948 requests. See section &<<SECTmemhanloc>>& for details.
30949 .endlist
30950
30951
30952 .section "Structure of header lines" "SECID209"
30953 The &%header_line%& structure contains the members listed below.
30954 You can add additional header lines by calling the &'header_add()'& function
30955 (see below). You can cause header lines to be ignored (deleted) by setting
30956 their type to *.
30957
30958
30959 .vlist
30960 .vitem &*struct&~header_line&~*next*&
30961 A pointer to the next header line, or NULL for the last line.
30962
30963 .vitem &*int&~type*&
30964 A code identifying certain headers that Exim recognizes. The codes are printing
30965 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
30966 Notice in particular that any header line whose type is * is not transmitted
30967 with the message. This flagging is used for header lines that have been
30968 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
30969 lines.) Effectively, * means &"deleted"&.
30970
30971 .vitem &*int&~slen*&
30972 The number of characters in the header line, including the terminating and any
30973 internal newlines.
30974
30975 .vitem &*uschar&~*text*&
30976 A pointer to the text of the header. It always ends with a newline, followed by
30977 a zero byte. Internal newlines are preserved.
30978 .endlist
30979
30980
30981
30982 .section "Structure of recipient items" "SECID210"
30983 The &%recipient_item%& structure contains these members:
30984
30985 .vlist
30986 .vitem &*uschar&~*address*&
30987 This is a pointer to the recipient address as it was received.
30988
30989 .vitem &*int&~pno*&
30990 This is used in later Exim processing when top level addresses are created by
30991 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
30992 and must always contain -1 at this stage.
30993
30994 .vitem &*uschar&~*errors_to*&
30995 If this value is not NULL, bounce messages caused by failing to deliver to the
30996 recipient are sent to the address it contains. In other words, it overrides the
30997 envelope sender for this one recipient. (Compare the &%errors_to%& generic
30998 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
30999 an unqualified address, Exim qualifies it using the domain from
31000 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31001 is NULL for all recipients.
31002 .endlist
31003
31004
31005
31006 .section "Available Exim functions" "SECID211"
31007 .cindex "&[local_scan()]& function" "available Exim functions"
31008 The header &_local_scan.h_& gives you access to a number of Exim functions.
31009 These are the only ones that are guaranteed to be maintained from release to
31010 release:
31011
31012 .vlist
31013 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31014        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31015
31016 This function creates a child process that runs the command specified by
31017 &%argv%&. The environment for the process is specified by &%envp%&, which can
31018 be NULL if no environment variables are to be passed. A new umask is supplied
31019 for the process in &%newumask%&.
31020
31021 Pipes to the standard input and output of the new process are set up
31022 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31023 standard error is cloned to the standard output. If there are any file
31024 descriptors &"in the way"& in the new process, they are closed. If the final
31025 argument is TRUE, the new process is made into a process group leader.
31026
31027 The function returns the pid of the new process, or -1 if things go wrong.
31028
31029 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31030 This function waits for a child process to terminate, or for a timeout (in
31031 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31032 return value is as follows:
31033
31034 .ilist
31035 >= 0
31036
31037 The process terminated by a normal exit and the value is the process
31038 ending status.
31039
31040 .next
31041 < 0 and > &--256
31042
31043 The process was terminated by a signal and the value is the negation of the
31044 signal number.
31045
31046 .next
31047 &--256
31048
31049 The process timed out.
31050 .next
31051 &--257
31052
31053 The was some other error in wait(); &%errno%& is still set.
31054 .endlist
31055
31056 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31057 This function provide you with a means of submitting a new message to
31058 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31059 want, but this packages it all up for you.) The function creates a pipe,
31060 forks a subprocess that is running
31061 .code
31062 exim -t -oem -oi -f <>
31063 .endd
31064 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31065 that is connected to the standard input. The yield of the function is the PID
31066 of the subprocess. You can then write a message to the file descriptor, with
31067 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31068
31069 When you have finished, call &'child_close()'& to wait for the process to
31070 finish and to collect its ending status. A timeout value of zero is usually
31071 fine in this circumstance. Unless you have made a mistake with the recipient
31072 addresses, you should get a return code of zero.
31073
31074
31075 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31076        *sender_authentication)*&
31077 This function is a more sophisticated version of &'child_open()'&. The command
31078 that it runs is:
31079 .display
31080 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31081 .endd
31082 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31083
31084
31085 .vitem &*void&~debug_printf(char&~*,&~...)*&
31086 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31087 output is written to the standard error stream. If no debugging is selected,
31088 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31089 conditional on the &`local_scan`& debug selector by coding like this:
31090 .code
31091 if ((debug_selector & D_local_scan) != 0)
31092   debug_printf("xxx", ...);
31093 .endd
31094
31095 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31096 This is an interface to Exim's string expansion code. The return value is the
31097 expanded string, or NULL if there was an expansion failure.
31098 The C variable &%expand_string_message%& contains an error message after an
31099 expansion failure. If expansion does not change the string, the return value is
31100 the pointer to the input string. Otherwise, the return value points to a new
31101 block of memory that was obtained by a call to &'store_get()'&. See section
31102 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31103
31104 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31105 This function allows you to an add additional header line at the end of the
31106 existing ones. The first argument is the type, and should normally be a space
31107 character. The second argument is a format string and any number of
31108 substitution arguments as for &[sprintf()]&. You may include internal newlines
31109 if you want, and you must ensure that the string ends with a newline.
31110
31111 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31112         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31113 This function adds a new header line at a specified point in the header
31114 chain. The header itself is specified as for &'header_add()'&.
31115
31116 If &%name%& is NULL, the new header is added at the end of the chain if
31117 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31118 NULL, the header lines are searched for the first non-deleted header that
31119 matches the name. If one is found, the new header is added before it if
31120 &%after%& is false. If &%after%& is true, the new header is added after the
31121 found header and any adjacent subsequent ones with the same name (even if
31122 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31123 option controls where the header is added. If it is true, addition is at the
31124 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31125 headers, or at the top if there are no &'Received:'& headers, you could use
31126 .code
31127 header_add_at_position(TRUE, US"Received", TRUE,
31128   ' ', "X-xxx: ...");
31129 .endd
31130 Normally, there is always at least one non-deleted &'Received:'& header, but
31131 there may not be if &%received_header_text%& expands to an empty string.
31132
31133
31134 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31135 This function removes header lines. If &%occurrence%& is zero or negative, all
31136 occurrences of the header are removed. If occurrence is greater than zero, that
31137 particular instance of the header is removed. If no header(s) can be found that
31138 match the specification, the function does nothing.
31139
31140
31141 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31142         int&~length,&~BOOL&~notdel)*&"
31143 This function tests whether the given header has the given name. It is not just
31144 a string comparison, because white space is permitted between the name and the
31145 colon. If the &%notdel%& argument is true, a false return is forced for all
31146 &"deleted"& headers; otherwise they are not treated specially. For example:
31147 .code
31148 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31149 .endd
31150 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31151 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31152 This function base64-encodes a string, which is passed by address and length.
31153 The text may contain bytes of any value, including zero. The result is passed
31154 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31155 zero-terminated.
31156
31157 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31158 This function decodes a base64-encoded string. Its arguments are a
31159 zero-terminated base64-encoded string and the address of a variable that is set
31160 to point to the result, which is in dynamic memory. The length of the decoded
31161 string is the yield of the function. If the input is invalid base64 data, the
31162 yield is -1. A zero byte is added to the end of the output string to make it
31163 easy to interpret as a C string (assuming it contains no zeros of its own). The
31164 added zero byte is not included in the returned count.
31165
31166 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31167 This function checks for a match in a domain list. Domains are always
31168 matched caselessly. The return value is one of the following:
31169 .display
31170 &`OK     `& match succeeded
31171 &`FAIL   `& match failed
31172 &`DEFER  `& match deferred
31173 .endd
31174 DEFER is usually caused by some kind of lookup defer, such as the
31175 inability to contact a database.
31176
31177 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31178         BOOL&~caseless)*&"
31179 This function checks for a match in a local part list. The third argument
31180 controls case-sensitivity. The return values are as for
31181 &'lss_match_domain()'&.
31182
31183 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31184         BOOL&~caseless)*&"
31185 This function checks for a match in an address list. The third argument
31186 controls the case-sensitivity of the local part match. The domain is always
31187 matched caselessly. The return values are as for &'lss_match_domain()'&.
31188
31189 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31190         uschar&~*list)*&"
31191 This function checks for a match in a host list. The most common usage is
31192 expected to be
31193 .code
31194 lss_match_host(sender_host_name, sender_host_address, ...)
31195 .endd
31196 .vindex "&$sender_host_address$&"
31197 An empty address field matches an empty item in the host list. If the host name
31198 is NULL, the name corresponding to &$sender_host_address$& is automatically
31199 looked up if a host name is required to match an item in the list. The return
31200 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31201 returns ERROR in the case when it had to look up a host name, but the lookup
31202 failed.
31203
31204 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31205         *format,&~...)*&"
31206 This function writes to Exim's log files. The first argument should be zero (it
31207 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31208 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31209 them. It specifies to which log or logs the message is written. The remaining
31210 arguments are a format and relevant insertion arguments. The string should not
31211 contain any newlines, not even at the end.
31212
31213
31214 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31215 This function adds an additional recipient to the message. The first argument
31216 is the recipient address. If it is unqualified (has no domain), it is qualified
31217 with the &%qualify_recipient%& domain. The second argument must always be -1.
31218
31219 This function does not allow you to specify a private &%errors_to%& address (as
31220 described with the structure of &%recipient_item%& above), because it pre-dates
31221 the addition of that field to the structure. However, it is easy to add such a
31222 value afterwards. For example:
31223 .code
31224  receive_add_recipient(US"monitor@mydom.example", -1);
31225  recipients_list[recipients_count-1].errors_to =
31226    US"postmaster@mydom.example";
31227 .endd
31228
31229 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31230 This is a convenience function to remove a named recipient from the list of
31231 recipients. It returns true if a recipient was removed, and false if no
31232 matching recipient could be found. The argument must be a complete email
31233 address.
31234 .endlist
31235
31236
31237 .cindex "RFC 2047"
31238 .vlist
31239 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31240   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31241 This function decodes strings that are encoded according to RFC 2047. Typically
31242 these are the contents of header lines. First, each &"encoded word"& is decoded
31243 from the Q or B encoding into a byte-string. Then, if provided with the name of
31244 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31245 made  to translate the result to the named character set. If this fails, the
31246 binary string is returned with an error message.
31247
31248 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31249 maximum MIME word length is enforced. The third argument is the target
31250 encoding, or NULL if no translation is wanted.
31251
31252 .cindex "binary zero" "in RFC 2047 decoding"
31253 .cindex "RFC 2047" "binary zero in"
31254 If a binary zero is encountered in the decoded string, it is replaced by the
31255 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31256 not be 0 because header lines are handled as zero-terminated strings.
31257
31258 The function returns the result of processing the string, zero-terminated; if
31259 &%lenptr%& is not NULL, the length of the result is set in the variable to
31260 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31261
31262 If an error is encountered, the function returns NULL and uses the &%error%&
31263 argument to return an error message. The variable pointed to by &%error%& is
31264 set to NULL if there is no error; it may be set non-NULL even when the function
31265 returns a non-NULL value if decoding was successful, but there was a problem
31266 with translation.
31267
31268
31269 .vitem &*int&~smtp_fflush(void)*&
31270 This function is used in conjunction with &'smtp_printf()'&, as described
31271 below.
31272
31273 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31274 The arguments of this function are like &[printf()]&; it writes to the SMTP
31275 output stream. You should use this function only when there is an SMTP output
31276 stream, that is, when the incoming message is being received via interactive
31277 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31278 is FALSE. If you want to test for an incoming message from another host (as
31279 opposed to a local process that used the &%-bs%& command line option), you can
31280 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31281 is involved.
31282
31283 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31284 output function, so it can be used for all forms of SMTP connection.
31285
31286 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31287 must start with an appropriate response code: 550 if you are going to return
31288 LOCAL_SCAN_REJECT, 451 if you are going to return
31289 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31290 initial lines of a multi-line response, the code must be followed by a hyphen
31291 to indicate that the line is not the final response line. You must also ensure
31292 that the lines you write terminate with CRLF. For example:
31293 .code
31294 smtp_printf("550-this is some extra info\r\n");
31295 return LOCAL_SCAN_REJECT;
31296 .endd
31297 Note that you can also create multi-line responses by including newlines in
31298 the data returned via the &%return_text%& argument. The added value of using
31299 &'smtp_printf()'& is that, for instance, you could introduce delays between
31300 multiple output lines.
31301
31302 The &'smtp_printf()'& function does not return any error indication, because it
31303 does not automatically flush pending output, and therefore does not test
31304 the state of the stream. (In the main code of Exim, flushing and error
31305 detection is done when Exim is ready for the next SMTP input command.) If
31306 you want to flush the output and check for an error (for example, the
31307 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31308 arguments. It flushes the output stream, and returns a non-zero value if there
31309 is an error.
31310
31311 .vitem &*void&~*store_get(int)*&
31312 This function accesses Exim's internal store (memory) manager. It gets a new
31313 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31314 runs out of memory. See the next section for a discussion of memory handling.
31315
31316 .vitem &*void&~*store_get_perm(int)*&
31317 This function is like &'store_get()'&, but it always gets memory from the
31318 permanent pool. See the next section for a discussion of memory handling.
31319
31320 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31321 See below.
31322
31323 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31324 See below.
31325
31326 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31327 These three functions create strings using Exim's dynamic memory facilities.
31328 The first makes a copy of an entire string. The second copies up to a maximum
31329 number of characters, indicated by the second argument. The third uses a format
31330 and insertion arguments to create a new string. In each case, the result is a
31331 pointer to a new string in the current memory pool. See the next section for
31332 more discussion.
31333 .endlist
31334
31335
31336
31337 .section "More about Exim's memory handling" "SECTmemhanloc"
31338 .cindex "&[local_scan()]& function" "memory handling"
31339 No function is provided for freeing memory, because that is never needed.
31340 The dynamic memory that Exim uses when receiving a message is automatically
31341 recycled if another message is received by the same process (this applies only
31342 to incoming SMTP connections &-- other input methods can supply only one
31343 message at a time). After receiving the last message, a reception process
31344 terminates.
31345
31346 Because it is recycled, the normal dynamic memory cannot be used for holding
31347 data that must be preserved over a number of incoming messages on the same SMTP
31348 connection. However, Exim in fact uses two pools of dynamic memory; the second
31349 one is not recycled, and can be used for this purpose.
31350
31351 If you want to allocate memory that remains available for subsequent messages
31352 in the same SMTP connection, you should set
31353 .code
31354 store_pool = POOL_PERM
31355 .endd
31356 before calling the function that does the allocation. There is no need to
31357 restore the value if you do not need to; however, if you do want to revert to
31358 the normal pool, you can either restore the previous value of &%store_pool%& or
31359 set it explicitly to POOL_MAIN.
31360
31361 The pool setting applies to all functions that get dynamic memory, including
31362 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31363 There is also a convenience function called &'store_get_perm()'& that gets a
31364 block of memory from the permanent pool while preserving the value of
31365 &%store_pool%&.
31366 .ecindex IIDlosca
31367
31368
31369
31370
31371 . ////////////////////////////////////////////////////////////////////////////
31372 . ////////////////////////////////////////////////////////////////////////////
31373
31374 .chapter "System-wide message filtering" "CHAPsystemfilter"
31375 .scindex IIDsysfil1 "filter" "system filter"
31376 .scindex IIDsysfil2 "filtering all mail"
31377 .scindex IIDsysfil3 "system filter"
31378 The previous chapters (on ACLs and the local scan function) describe checks
31379 that can be applied to messages before they are accepted by a host. There is
31380 also a mechanism for checking messages once they have been received, but before
31381 they are delivered. This is called the &'system filter'&.
31382
31383 The system filter operates in a similar manner to users' filter files, but it
31384 is run just once per message (however many recipients the message has).
31385 It should not normally be used as a substitute for routing, because &%deliver%&
31386 commands in a system router provide new envelope recipient addresses.
31387 The system filter must be an Exim filter. It cannot be a Sieve filter.
31388
31389 The system filter is run at the start of a delivery attempt, before any routing
31390 is done. If a message fails to be completely delivered at the first attempt,
31391 the system filter is run again at the start of every retry.
31392 If you want your filter to do something only once per message, you can make use
31393 of the &%first_delivery%& condition in an &%if%& command in the filter to
31394 prevent it happening on retries.
31395
31396 .vindex "&$domain$&"
31397 .vindex "&$local_part$&"
31398 &*Warning*&: Because the system filter runs just once, variables that are
31399 specific to individual recipient addresses, such as &$local_part$& and
31400 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31401 you want to run a centrally-specified filter for each recipient address
31402 independently, you can do so by setting up a suitable &(redirect)& router, as
31403 described in section &<<SECTperaddfil>>& below.
31404
31405
31406 .section "Specifying a system filter" "SECID212"
31407 .cindex "uid (user id)" "system filter"
31408 .cindex "gid (group id)" "system filter"
31409 The name of the file that contains the system filter must be specified by
31410 setting &%system_filter%&. If you want the filter to run under a uid and gid
31411 other than root, you must also set &%system_filter_user%& and
31412 &%system_filter_group%& as appropriate. For example:
31413 .code
31414 system_filter = /etc/mail/exim.filter
31415 system_filter_user = exim
31416 .endd
31417 If a system filter generates any deliveries directly to files or pipes (via the
31418 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31419 specified by setting &%system_filter_file_transport%& and
31420 &%system_filter_pipe_transport%&, respectively. Similarly,
31421 &%system_filter_reply_transport%& must be set to handle any messages generated
31422 by the &%reply%& command.
31423
31424
31425 .section "Testing a system filter" "SECID213"
31426 You can run simple tests of a system filter in the same way as for a user
31427 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31428 are permitted only in system filters are recognized.
31429
31430 If you want to test the combined effect of a system filter and a user filter,
31431 you can use both &%-bF%& and &%-bf%& on the same command line.
31432
31433
31434
31435 .section "Contents of a system filter" "SECID214"
31436 The language used to specify system filters is the same as for users' filter
31437 files. It is described in the separate end-user document &'Exim's interface to
31438 mail filtering'&. However, there are some additional features that are
31439 available only in system filters; these are described in subsequent sections.
31440 If they are encountered in a user's filter file or when testing with &%-bf%&,
31441 they cause errors.
31442
31443 .cindex "frozen messages" "manual thaw; testing in filter"
31444 There are two special conditions which, though available in users' filter
31445 files, are designed for use in system filters. The condition &%first_delivery%&
31446 is true only for the first attempt at delivering a message, and
31447 &%manually_thawed%& is true only if the message has been frozen, and
31448 subsequently thawed by an admin user. An explicit forced delivery counts as a
31449 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31450
31451 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31452 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31453 succeed, it will not be tried again.
31454 If you want Exim to retry an unseen delivery until it succeeds, you should
31455 arrange to set it up every time the filter runs.
31456
31457 When a system filter finishes running, the values of the variables &$n0$& &--
31458 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
31459 users' filter files. Thus a system filter can, for example, set up &"scores"&
31460 to which users' filter files can refer.
31461
31462
31463
31464 .section "Additional variable for system filters" "SECID215"
31465 .vindex "&$recipients$&"
31466 The expansion variable &$recipients$&, containing a list of all the recipients
31467 of the message (separated by commas and white space), is available in system
31468 filters. It is not available in users' filters for privacy reasons.
31469
31470
31471
31472 .section "Defer, freeze, and fail commands for system filters" "SECID216"
31473 .cindex "freezing messages"
31474 .cindex "message" "freezing"
31475 .cindex "message" "forced failure"
31476 .cindex "&%fail%&" "in system filter"
31477 .cindex "&%freeze%& in system filter"
31478 .cindex "&%defer%& in system filter"
31479 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
31480 always available in system filters, but are not normally enabled in users'
31481 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
31482 for the &(redirect)& router.) These commands can optionally be followed by the
31483 word &%text%& and a string containing an error message, for example:
31484 .code
31485 fail text "this message looks like spam to me"
31486 .endd
31487 The keyword &%text%& is optional if the next character is a double quote.
31488
31489 The &%defer%& command defers delivery of the original recipients of the
31490 message. The &%fail%& command causes all the original recipients to be failed,
31491 and a bounce message to be created. The &%freeze%& command suspends all
31492 delivery attempts for the original recipients. In all cases, any new deliveries
31493 that are specified by the filter are attempted as normal after the filter has
31494 run.
31495
31496 The &%freeze%& command is ignored if the message has been manually unfrozen and
31497 not manually frozen since. This means that automatic freezing by a system
31498 filter can be used as a way of checking out suspicious messages. If a message
31499 is found to be all right, manually unfreezing it allows it to be delivered.
31500
31501 .cindex "log" "&%fail%& command log line"
31502 .cindex "&%fail%&" "log line; reducing"
31503 The text given with a fail command is used as part of the bounce message as
31504 well as being written to the log. If the message is quite long, this can fill
31505 up a lot of log space when such failures are common. To reduce the size of the
31506 log message, Exim interprets the text in a special way if it starts with the
31507 two characters &`<<`& and contains &`>>`& later. The text between these two
31508 strings is written to the log, and the rest of the text is used in the bounce
31509 message. For example:
31510 .code
31511 fail "<<filter test 1>>Your message is rejected \
31512      because it contains attachments that we are \
31513      not prepared to receive."
31514 .endd
31515
31516 .cindex "loop" "caused by &%fail%&"
31517 Take great care with the &%fail%& command when basing the decision to fail on
31518 the contents of the message, because the bounce message will of course include
31519 the contents of the original message and will therefore trigger the &%fail%&
31520 command again (causing a mail loop) unless steps are taken to prevent this.
31521 Testing the &%error_message%& condition is one way to prevent this. You could
31522 use, for example
31523 .code
31524 if $message_body contains "this is spam" and not error_message
31525 then fail text "spam is not wanted here" endif
31526 .endd
31527 though of course that might let through unwanted bounce messages. The
31528 alternative is clever checking of the body and/or headers to detect bounces
31529 generated by the filter.
31530
31531 The interpretation of a system filter file ceases after a
31532 &%defer%&,
31533 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
31534 set up earlier in the filter file are honoured, so you can use a sequence such
31535 as
31536 .code
31537 mail ...
31538 freeze
31539 .endd
31540 to send a specified message when the system filter is freezing (or deferring or
31541 failing) a message. The normal deliveries for the message do not, of course,
31542 take place.
31543
31544
31545
31546 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31547 .cindex "header lines" "adding; in system filter"
31548 .cindex "header lines" "removing; in system filter"
31549 .cindex "filter" "header lines; adding/removing"
31550 Two filter commands that are available only in system filters are:
31551 .code
31552 headers add <string>
31553 headers remove <string>
31554 .endd
31555 The argument for the &%headers add%& is a string that is expanded and then
31556 added to the end of the message's headers. It is the responsibility of the
31557 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31558 space is ignored, and if the string is otherwise empty, or if the expansion is
31559 forced to fail, the command has no effect.
31560
31561 You can use &"\n"& within the string, followed by white space, to specify
31562 continued header lines. More than one header may be added in one command by
31563 including &"\n"& within the string without any following white space. For
31564 example:
31565 .code
31566 headers add "X-header-1: ....\n  \
31567              continuation of X-header-1 ...\n\
31568              X-header-2: ...."
31569 .endd
31570 Note that the header line continuation white space after the first newline must
31571 be placed before the backslash that continues the input string, because white
31572 space after input continuations is ignored.
31573
31574 The argument for &%headers remove%& is a colon-separated list of header names.
31575 This command applies only to those headers that are stored with the message;
31576 those that are added at delivery time (such as &'Envelope-To:'& and
31577 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31578 header with the same name, they are all removed.
31579
31580 The &%headers%& command in a system filter makes an immediate change to the set
31581 of header lines that was received with the message (with possible additions
31582 from ACL processing). Subsequent commands in the system filter operate on the
31583 modified set, which also forms the basis for subsequent message delivery.
31584 Unless further modified during routing or transporting, this set of headers is
31585 used for all recipients of the message.
31586
31587 During routing and transporting, the variables that refer to the contents of
31588 header lines refer only to those lines that are in this set. Thus, header lines
31589 that are added by a system filter are visible to users' filter files and to all
31590 routers and transports. This contrasts with the manipulation of header lines by
31591 routers and transports, which is not immediate, but which instead is saved up
31592 until the message is actually being written (see section
31593 &<<SECTheadersaddrem>>&).
31594
31595 If the message is not delivered at the first attempt, header lines that were
31596 added by the system filter are stored with the message, and so are still
31597 present at the next delivery attempt. Header lines that were removed are still
31598 present, but marked &"deleted"& so that they are not transported with the
31599 message. For this reason, it is usual to make the &%headers%& command
31600 conditional on &%first_delivery%& so that the set of header lines is not
31601 modified more than once.
31602
31603 Because header modification in a system filter acts immediately, you have to
31604 use an indirect approach if you want to modify the contents of a header line.
31605 For example:
31606 .code
31607 headers add "Old-Subject: $h_subject:"
31608 headers remove "Subject"
31609 headers add "Subject: new subject (was: $h_old-subject:)"
31610 headers remove "Old-Subject"
31611 .endd
31612
31613
31614
31615 .section "Setting an errors address in a system filter" "SECID217"
31616 .cindex "envelope sender"
31617 In a system filter, if a &%deliver%& command is followed by
31618 .code
31619 errors_to <some address>
31620 .endd
31621 in order to change the envelope sender (and hence the error reporting) for that
31622 delivery, any address may be specified. (In a user filter, only the current
31623 user's address can be set.) For example, if some mail is being monitored, you
31624 might use
31625 .code
31626 unseen deliver monitor@spying.example errors_to root@local.example
31627 .endd
31628 to take a copy which would not be sent back to the normal error reporting
31629 address if its delivery failed.
31630
31631
31632
31633 .section "Per-address filtering" "SECTperaddfil"
31634 .vindex "&$domain$&"
31635 .vindex "&$local_part$&"
31636 In contrast to the system filter, which is run just once per message for each
31637 delivery attempt, it is also possible to set up a system-wide filtering
31638 operation that runs once for each recipient address. In this case, variables
31639 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
31640 filter file could be made dependent on them. This is an example of a router
31641 which implements such a filter:
31642 .code
31643 central_filter:
31644   check_local_user
31645   driver = redirect
31646   domains = +local_domains
31647   file = /central/filters/$local_part
31648   no_verify
31649   allow_filter
31650   allow_freeze
31651 .endd
31652 The filter is run in a separate process under its own uid. Therefore, either
31653 &%check_local_user%& must be set (as above), in which case the filter is run as
31654 the local user, or the &%user%& option must be used to specify which user to
31655 use. If both are set, &%user%& overrides.
31656
31657 Care should be taken to ensure that none of the commands in the filter file
31658 specify a significant delivery if the message is to go on to be delivered to
31659 its intended recipient. The router will not then claim to have dealt with the
31660 address, so it will be passed on to subsequent routers to be delivered in the
31661 normal way.
31662 .ecindex IIDsysfil1
31663 .ecindex IIDsysfil2
31664 .ecindex IIDsysfil3
31665
31666
31667
31668
31669
31670
31671 . ////////////////////////////////////////////////////////////////////////////
31672 . ////////////////////////////////////////////////////////////////////////////
31673
31674 .chapter "Message processing" "CHAPmsgproc"
31675 .scindex IIDmesproc "message" "general processing"
31676 Exim performs various transformations on the sender and recipient addresses of
31677 all messages that it handles, and also on the messages' header lines. Some of
31678 these are optional and configurable, while others always take place. All of
31679 this processing, except rewriting as a result of routing, and the addition or
31680 removal of header lines while delivering, happens when a message is received,
31681 before it is placed on Exim's queue.
31682
31683 Some of the automatic processing takes place by default only for
31684 &"locally-originated"& messages. This adjective is used to describe messages
31685 that are not received over TCP/IP, but instead are passed to an Exim process on
31686 its standard input. This includes the interactive &"local SMTP"& case that is
31687 set up by the &%-bs%& command line option.
31688
31689 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
31690 or ::1) are not considered to be locally-originated. Exim does not treat the
31691 loopback interface specially in any way.
31692
31693 If you want the loopback interface to be treated specially, you must ensure
31694 that there are appropriate entries in your ACLs.
31695
31696
31697
31698
31699 .section "Submission mode for non-local messages" "SECTsubmodnon"
31700 .cindex "message" "submission"
31701 .cindex "submission mode"
31702 Processing that happens automatically for locally-originated messages (unless
31703 &%suppress_local_fixups%& is set) can also be requested for messages that are
31704 received over TCP/IP. The term &"submission mode"& is used to describe this
31705 state. Submission mode is set by the modifier
31706 .code
31707 control = submission
31708 .endd
31709 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
31710 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
31711 a local submission, and is normally used when the source of the message is
31712 known to be an MUA running on a client host (as opposed to an MTA). For
31713 example, to set submission mode for messages originating on the IPv4 loopback
31714 interface, you could include the following in the MAIL ACL:
31715 .code
31716 warn  hosts = 127.0.0.1
31717       control = submission
31718 .endd
31719 .cindex "&%sender_retain%& submission option"
31720 There are some options that can be used when setting submission mode. A slash
31721 is used to separate options. For example:
31722 .code
31723 control = submission/sender_retain
31724 .endd
31725 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
31726 true and &%local_from_check%& false for the current incoming message. The first
31727 of these allows an existing &'Sender:'& header in the message to remain, and
31728 the second suppresses the check to ensure that &'From:'& matches the
31729 authenticated sender. With this setting, Exim still fixes up messages by adding
31730 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
31731 attempt to check sender authenticity in header lines.
31732
31733 When &%sender_retain%& is not set, a submission mode setting may specify a
31734 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
31735 example:
31736 .code
31737 control = submission/domain=some.domain
31738 .endd
31739 The domain may be empty. How this value is used is described in sections
31740 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
31741 that allows you to specify the user's full name for inclusion in a created
31742 &'Sender:'& or &'From:'& header line. For example:
31743 .code
31744 accept authenticated = *
31745        control = submission/domain=wonderland.example/\
31746                             name=${lookup {$authenticated_id} \
31747                                    lsearch {/etc/exim/namelist}}
31748 .endd
31749 Because the name may contain any characters, including slashes, the &%name%&
31750 option must be given last. The remainder of the string is used as the name. For
31751 the example above, if &_/etc/exim/namelist_& contains:
31752 .code
31753 bigegg:  Humpty Dumpty
31754 .endd
31755 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
31756 line would be:
31757 .code
31758 Sender: Humpty Dumpty <bigegg@wonderland.example>
31759 .endd
31760 .cindex "return path" "in submission mode"
31761 By default, submission mode forces the return path to the same address as is
31762 used to create the &'Sender:'& header. However, if &%sender_retain%& is
31763 specified, the return path is also left unchanged.
31764
31765 &*Note*&: The changes caused by submission mode take effect after the predata
31766 ACL. This means that any sender checks performed before the fix-ups use the
31767 untrusted sender address specified by the user, not the trusted sender address
31768 specified by submission mode. Although this might be slightly unexpected, it
31769 does mean that you can configure ACL checks to spot that a user is trying to
31770 spoof another's address.
31771
31772 .section "Line endings" "SECTlineendings"
31773 .cindex "line endings"
31774 .cindex "carriage return"
31775 .cindex "linefeed"
31776 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
31777 linefeed) is the line ending for messages transmitted over the Internet using
31778 SMTP over TCP/IP. However, within individual operating systems, different
31779 conventions are used. For example, Unix-like systems use just LF, but others
31780 use CRLF or just CR.
31781
31782 Exim was designed for Unix-like systems, and internally, it stores messages
31783 using the system's convention of a single LF as a line terminator. When
31784 receiving a message, all line endings are translated to this standard format.
31785 Originally, it was thought that programs that passed messages directly to an
31786 MTA within an operating system would use that system's convention. Experience
31787 has shown that this is not the case; for example, there are Unix applications
31788 that use CRLF in this circumstance. For this reason, and for compatibility with
31789 other MTAs, the way Exim handles line endings for all messages is now as
31790 follows:
31791
31792 .ilist
31793 LF not preceded by CR is treated as a line ending.
31794 .next
31795 CR is treated as a line ending; if it is immediately followed by LF, the LF
31796 is ignored.
31797 .next
31798 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
31799 nor a local message in the state where a line containing only a dot is a
31800 terminator.
31801 .next
31802 If a bare CR is encountered within a header line, an extra space is added after
31803 the line terminator so as not to end the header line. The reasoning behind this
31804 is that bare CRs in header lines are most likely either to be mistakes, or
31805 people trying to play silly games.
31806 .next
31807 If the first header line received in a message ends with CRLF, a subsequent
31808 bare LF in a header line is treated in the same way as a bare CR in a header
31809 line.
31810 .endlist
31811
31812
31813
31814
31815
31816 .section "Unqualified addresses" "SECID218"
31817 .cindex "unqualified addresses"
31818 .cindex "address" "qualification"
31819 By default, Exim expects every envelope address it receives from an external
31820 host to be fully qualified. Unqualified addresses cause negative responses to
31821 SMTP commands. However, because SMTP is used as a means of transporting
31822 messages from MUAs running on personal workstations, there is sometimes a
31823 requirement to accept unqualified addresses from specific hosts or IP networks.
31824
31825 Exim has two options that separately control which hosts may send unqualified
31826 sender or recipient addresses in SMTP commands, namely
31827 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
31828 cases, if an unqualified address is accepted, it is qualified by adding the
31829 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
31830
31831 .oindex "&%qualify_domain%&"
31832 .oindex "&%qualify_recipient%&"
31833 Unqualified addresses in header lines are automatically qualified for messages
31834 that are locally originated, unless the &%-bnq%& option is given on the command
31835 line. For messages received over SMTP, unqualified addresses in header lines
31836 are qualified only if unqualified addresses are permitted in SMTP commands. In
31837 other words, such qualification is also controlled by
31838 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
31839
31840
31841
31842
31843 .section "The UUCP From line" "SECID219"
31844 .cindex "&""From""& line"
31845 .cindex "UUCP" "&""From""& line"
31846 .cindex "sender" "address"
31847 .oindex "&%uucp_from_pattern%&"
31848 .oindex "&%uucp_from_sender%&"
31849 .cindex "envelope sender"
31850 .cindex "Sendmail compatibility" "&""From""& line"
31851 Messages that have come from UUCP (and some other applications) often begin
31852 with a line containing the envelope sender and a timestamp, following the word
31853 &"From"&. Examples of two common formats are:
31854 .code
31855 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
31856 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
31857 .endd
31858 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
31859 Exim recognizes such lines at the start of messages that are submitted to it
31860 via the command line (that is, on the standard input). It does not recognize
31861 such lines in incoming SMTP messages, unless the sending host matches
31862 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
31863 and &%ignore_fromline_local%& is set. The recognition is controlled by a
31864 regular expression that is defined by the &%uucp_from_pattern%& option, whose
31865 default value matches the two common cases shown above and puts the address
31866 that follows &"From"& into &$1$&.
31867
31868 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
31869 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
31870 a trusted user, the message's sender address is constructed by expanding the
31871 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
31872 then parsed as an RFC 2822 address. If there is no domain, the local part is
31873 qualified with &%qualify_domain%& unless it is the empty string. However, if
31874 the command line &%-f%& option is used, it overrides the &"From"& line.
31875
31876 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
31877 sender address is not changed. This is also the case for incoming SMTP messages
31878 that are permitted to contain &"From"& lines.
31879
31880 Only one &"From"& line is recognized. If there is more than one, the second is
31881 treated as a data line that starts the body of the message, as it is not valid
31882 as a header line. This also happens if a &"From"& line is present in an
31883 incoming SMTP message from a source that is not permitted to send them.
31884
31885
31886
31887 .section "Resent- header lines" "SECID220"
31888 .cindex "&%Resent-%& header lines"
31889 RFC 2822 makes provision for sets of header lines starting with the string
31890 &`Resent-`& to be added to a message when it is resent by the original
31891 recipient to somebody else. These headers are &'Resent-Date:'&,
31892 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
31893 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
31894
31895 .blockquote
31896 &'Resent fields are strictly informational. They MUST NOT be used in the normal
31897 processing of replies or other such automatic actions on messages.'&
31898 .endblockquote
31899
31900 This leaves things a bit vague as far as other processing actions such as
31901 address rewriting are concerned. Exim treats &%Resent-%& header lines as
31902 follows:
31903
31904 .ilist
31905 A &'Resent-From:'& line that just contains the login id of the submitting user
31906 is automatically rewritten in the same way as &'From:'& (see below).
31907 .next
31908 If there's a rewriting rule for a particular header line, it is also applied to
31909 &%Resent-%& header lines of the same type. For example, a rule that rewrites
31910 &'From:'& also rewrites &'Resent-From:'&.
31911 .next
31912 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
31913 also removed.
31914 .next
31915 For a locally-submitted message,
31916 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
31917 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
31918 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
31919 included in log lines in this case.
31920 .next
31921 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
31922 &%Resent-%& header lines are present.
31923 .endlist
31924
31925
31926
31927
31928 .section "The Auto-Submitted: header line" "SECID221"
31929 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
31930 includes the header line:
31931 .code
31932 Auto-Submitted: auto-replied
31933 .endd
31934
31935 .section "The Bcc: header line" "SECID222"
31936 .cindex "&'Bcc:'& header line"
31937 If Exim is called with the &%-t%& option, to take recipient addresses from a
31938 message's header, it removes any &'Bcc:'& header line that may exist (after
31939 extracting its addresses). If &%-t%& is not present on the command line, any
31940 existing &'Bcc:'& is not removed.
31941
31942
31943 .section "The Date: header line" "SECID223"
31944 .cindex "&'Date:'& header line"
31945 If a locally-generated or submission-mode message has no &'Date:'& header line,
31946 Exim adds one, using the current date and time, unless the
31947 &%suppress_local_fixups%& control has been specified.
31948
31949 .section "The Delivery-date: header line" "SECID224"
31950 .cindex "&'Delivery-date:'& header line"
31951 .oindex "&%delivery_date_remove%&"
31952 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
31953 set. Exim can be configured to add them to the final delivery of messages. (See
31954 the generic &%delivery_date_add%& transport option.) They should not be present
31955 in messages in transit. If the &%delivery_date_remove%& configuration option is
31956 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
31957 messages.
31958
31959
31960 .section "The Envelope-to: header line" "SECID225"
31961 .cindex "&'Envelope-to:'& header line"
31962 .oindex "&%envelope_to_remove%&"
31963 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
31964 Exim can be configured to add them to the final delivery of messages. (See the
31965 generic &%envelope_to_add%& transport option.) They should not be present in
31966 messages in transit. If the &%envelope_to_remove%& configuration option is set
31967 (the default), Exim removes &'Envelope-to:'& header lines from incoming
31968 messages.
31969
31970
31971 .section "The From: header line" "SECTthefrohea"
31972 .cindex "&'From:'& header line"
31973 .cindex "Sendmail compatibility" "&""From""& line"
31974 .cindex "message" "submission"
31975 .cindex "submission mode"
31976 If a submission-mode message does not contain a &'From:'& header line, Exim
31977 adds one if either of the following conditions is true:
31978
31979 .ilist
31980 The envelope sender address is not empty (that is, this is not a bounce
31981 message). The added header line copies the envelope sender address.
31982 .next
31983 .vindex "&$authenticated_id$&"
31984 The SMTP session is authenticated and &$authenticated_id$& is not empty.
31985 .olist
31986 .vindex "&$qualify_domain$&"
31987 If no domain is specified by the submission control, the local part is
31988 &$authenticated_id$& and the domain is &$qualify_domain$&.
31989 .next
31990 If a non-empty domain is specified by the submission control, the local
31991 part is &$authenticated_id$&, and the domain is the specified domain.
31992 .next
31993 If an empty domain is specified by the submission control,
31994 &$authenticated_id$& is assumed to be the complete address.
31995 .endlist
31996 .endlist
31997
31998 A non-empty envelope sender takes precedence.
31999
32000 If a locally-generated incoming message does not contain a &'From:'& header
32001 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32002 containing the sender's address. The calling user's login name and full name
32003 are used to construct the address, as described in section &<<SECTconstr>>&.
32004 They are obtained from the password data by calling &[getpwuid()]& (but see the
32005 &%unknown_login%& configuration option). The address is qualified with
32006 &%qualify_domain%&.
32007
32008 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32009 &'From:'& header line containing just the unqualified login name of the calling
32010 user, this is replaced by an address containing the user's login name and full
32011 name as described in section &<<SECTconstr>>&.
32012
32013
32014 .section "The Message-ID: header line" "SECID226"
32015 .cindex "&'Message-ID:'& header line"
32016 .cindex "message" "submission"
32017 .oindex "&%message_id_header_text%&"
32018 If a locally-generated or submission-mode incoming message does not contain a
32019 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32020 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32021 to the message. If there are any &'Resent-:'& headers in the message, it
32022 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32023 message id, preceded by the letter E to ensure it starts with a letter, and
32024 followed by @ and the primary host name. Additional information can be included
32025 in this header line by setting the &%message_id_header_text%& and/or
32026 &%message_id_header_domain%& options.
32027
32028
32029 .section "The Received: header line" "SECID227"
32030 .cindex "&'Received:'& header line"
32031 A &'Received:'& header line is added at the start of every message. The
32032 contents are defined by the &%received_header_text%& configuration option, and
32033 Exim automatically adds a semicolon and a timestamp to the configured string.
32034
32035 The &'Received:'& header is generated as soon as the message's header lines
32036 have been received. At this stage, the timestamp in the &'Received:'& header
32037 line is the time that the message started to be received. This is the value
32038 that is seen by the DATA ACL and by the &[local_scan()]& function.
32039
32040 Once a message is accepted, the timestamp in the &'Received:'& header line is
32041 changed to the time of acceptance, which is (apart from a small delay while the
32042 -H spool file is written) the earliest time at which delivery could start.
32043
32044
32045 .section "The References: header line" "SECID228"
32046 .cindex "&'References:'& header line"
32047 Messages created by the &(autoreply)& transport include a &'References:'&
32048 header line. This is constructed according to the rules that are described in
32049 section 3.64 of RFC 2822 (which states that replies should contain such a
32050 header line), and section 3.14 of RFC 3834 (which states that automatic
32051 responses are not different in this respect). However, because some mail
32052 processing software does not cope well with very long header lines, no more
32053 than 12 message IDs are copied from the &'References:'& header line in the
32054 incoming message. If there are more than 12, the first one and then the final
32055 11 are copied, before adding the message ID of the incoming message.
32056
32057
32058
32059 .section "The Return-path: header line" "SECID229"
32060 .cindex "&'Return-path:'& header line"
32061 .oindex "&%return_path_remove%&"
32062 &'Return-path:'& header lines are defined as something an MTA may insert when
32063 it does the final delivery of messages. (See the generic &%return_path_add%&
32064 transport option.) Therefore, they should not be present in messages in
32065 transit. If the &%return_path_remove%& configuration option is set (the
32066 default), Exim removes &'Return-path:'& header lines from incoming messages.
32067
32068
32069
32070 .section "The Sender: header line" "SECTthesenhea"
32071 .cindex "&'Sender:'& header line"
32072 .cindex "message" "submission"
32073 For a locally-originated message from an untrusted user, Exim may remove an
32074 existing &'Sender:'& header line, and it may add a new one. You can modify
32075 these actions by setting the &%local_sender_retain%& option true, the
32076 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32077 control setting.
32078
32079 When a local message is received from an untrusted user and
32080 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32081 control has not been set, a check is made to see if the address given in the
32082 &'From:'& header line is the correct (local) sender of the message. The address
32083 that is expected has the login name as the local part and the value of
32084 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32085 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32086 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32087 line is added to the message.
32088
32089 If you set &%local_from_check%& false, this checking does not occur. However,
32090 the removal of an existing &'Sender:'& line still happens, unless you also set
32091 &%local_sender_retain%& to be true. It is not possible to set both of these
32092 options true at the same time.
32093
32094 .cindex "submission mode"
32095 By default, no processing of &'Sender:'& header lines is done for messages
32096 received over TCP/IP or for messages submitted by trusted users. However, when
32097 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32098 not specified on the submission control, the following processing takes place:
32099
32100 .vindex "&$authenticated_id$&"
32101 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32102 authenticated, and &$authenticated_id$& is not empty, a sender address is
32103 created as follows:
32104
32105 .ilist
32106 .vindex "&$qualify_domain$&"
32107 If no domain is specified by the submission control, the local part is
32108 &$authenticated_id$& and the domain is &$qualify_domain$&.
32109 .next
32110 If a non-empty domain is specified by the submission control, the local part
32111 is &$authenticated_id$&, and the domain is the specified domain.
32112 .next
32113 If an empty domain is specified by the submission control,
32114 &$authenticated_id$& is assumed to be the complete address.
32115 .endlist
32116
32117 This address is compared with the address in the &'From:'& header line. If they
32118 are different, a &'Sender:'& header line containing the created address is
32119 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32120 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32121
32122 .cindex "return path" "created from &'Sender:'&"
32123 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32124 the message (the envelope sender address) is changed to be the same address,
32125 except in the case of submission mode when &%sender_retain%& is specified.
32126
32127
32128
32129 .section "Adding and removing header lines in routers and transports" &&&
32130          "SECTheadersaddrem"
32131 .cindex "header lines" "adding; in router or transport"
32132 .cindex "header lines" "removing; in router or transport"
32133 When a message is delivered, the addition and removal of header lines can be
32134 specified in a system filter, or on any of the routers and transports that
32135 process the message. Section &<<SECTaddremheasys>>& contains details about
32136 modifying headers in a system filter. Header lines can also be added in an ACL
32137 as a message is received (see section &<<SECTaddheadacl>>&).
32138
32139 In contrast to what happens in a system filter, header modifications that are
32140 specified on routers and transports apply only to the particular recipient
32141 addresses that are being processed by those routers and transports. These
32142 changes do not actually take place until a copy of the message is being
32143 transported. Therefore, they do not affect the basic set of header lines, and
32144 they do not affect the values of the variables that refer to header lines.
32145
32146 &*Note*&: In particular, this means that any expansions in the configuration of
32147 the transport cannot refer to the modified header lines, because such
32148 expansions all occur before the message is actually transported.
32149
32150 For both routers and transports, the argument of a &%headers_add%&
32151 option must be in the form of one or more RFC 2822 header lines, separated by
32152 newlines (coded as &"\n"&). For example:
32153 .code
32154 headers_add = X-added-header: added by $primary_hostname\n\
32155               X-added-second: another added header line
32156 .endd
32157 Exim does not check the syntax of these added header lines.
32158
32159 Multiple &%headers_add%& options for a single router or transport can be
32160 specified; the values will append to a single list of header lines.
32161 Each header-line is separately expanded.
32162
32163 The argument of a &%headers_remove%& option must consist of a colon-separated
32164 list of header names. This is confusing, because header names themselves are
32165 often terminated by colons. In this case, the colons are the list separators,
32166 not part of the names. For example:
32167 .code
32168 headers_remove = return-receipt-to:acknowledge-to
32169 .endd
32170
32171 Multiple &%headers_remove%& options for a single router or transport can be
32172 specified; the arguments will append to a single header-names list.
32173 Each item is separately expanded.
32174
32175 When &%headers_add%& or &%headers_remove%& is specified on a router,
32176 items are expanded at routing time,
32177 and then associated with all addresses that are
32178 accepted by that router, and also with any new addresses that it generates. If
32179 an address passes through several routers as a result of aliasing or
32180 forwarding, the changes are cumulative.
32181
32182 .oindex "&%unseen%&"
32183 However, this does not apply to multiple routers that result from the use of
32184 the &%unseen%& option. Any header modifications that were specified by the
32185 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32186
32187 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32188 settings cannot be delivered together in a batch, so a transport is always
32189 dealing with a set of addresses that have the same header-processing
32190 requirements.
32191
32192 The transport starts by writing the original set of header lines that arrived
32193 with the message, possibly modified by the system filter. As it writes out
32194 these lines, it consults the list of header names that were attached to the
32195 recipient address(es) by &%headers_remove%& options in routers, and it also
32196 consults the transport's own &%headers_remove%& option. Header lines whose
32197 names are on either of these lists are not written out. If there are multiple
32198 instances of any listed header, they are all skipped.
32199
32200 After the remaining original header lines have been written, new header
32201 lines that were specified by routers' &%headers_add%& options are written, in
32202 the order in which they were attached to the address. These are followed by any
32203 header lines specified by the transport's &%headers_add%& option.
32204
32205 This way of handling header line modifications in routers and transports has
32206 the following consequences:
32207
32208 .ilist
32209 The original set of header lines, possibly modified by the system filter,
32210 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32211 to it, at all times.
32212 .next
32213 Header lines that are added by a router's
32214 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32215 expansion syntax in subsequent routers or the transport.
32216 .next
32217 Conversely, header lines that are specified for removal by &%headers_remove%&
32218 in a router remain visible to subsequent routers and the transport.
32219 .next
32220 Headers added to an address by &%headers_add%& in a router cannot be removed by
32221 a later router or by a transport.
32222 .next
32223 An added header can refer to the contents of an original header that is to be
32224 removed, even it has the same name as the added header. For example:
32225 .code
32226 headers_remove = subject
32227 headers_add = Subject: new subject (was: $h_subject:)
32228 .endd
32229 .endlist
32230
32231 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32232 for a &(redirect)& router that has the &%one_time%& option set.
32233
32234
32235
32236
32237
32238 .section "Constructed addresses" "SECTconstr"
32239 .cindex "address" "constructed"
32240 .cindex "constructed address"
32241 When Exim constructs a sender address for a locally-generated message, it uses
32242 the form
32243 .display
32244 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32245 .endd
32246 For example:
32247 .code
32248 Zaphod Beeblebrox <zaphod@end.univ.example>
32249 .endd
32250 The user name is obtained from the &%-F%& command line option if set, or
32251 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32252 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32253 ampersand character, this is replaced by the login name with the first letter
32254 upper cased, as is conventional in a number of operating systems. See the
32255 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32256 The &%unknown_username%& option can be used to specify user names in cases when
32257 there is no password file entry.
32258
32259 .cindex "RFC 2047"
32260 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32261 parts of it if necessary. In addition, if it contains any non-printing
32262 characters, it is encoded as described in RFC 2047, which defines a way of
32263 including non-ASCII characters in header lines. The value of the
32264 &%headers_charset%& option specifies the name of the encoding that is used (the
32265 characters are assumed to be in this encoding). The setting of
32266 &%print_topbitchars%& controls whether characters with the top bit set (that
32267 is, with codes greater than 127) count as printing characters or not.
32268
32269
32270
32271 .section "Case of local parts" "SECID230"
32272 .cindex "case of local parts"
32273 .cindex "local part" "case of"
32274 RFC 2822 states that the case of letters in the local parts of addresses cannot
32275 be assumed to be non-significant. Exim preserves the case of local parts of
32276 addresses, but by default it uses a lower-cased form when it is routing,
32277 because on most Unix systems, usernames are in lower case and case-insensitive
32278 routing is required. However, any particular router can be made to use the
32279 original case for local parts by setting the &%caseful_local_part%& generic
32280 router option.
32281
32282 .cindex "mixed-case login names"
32283 If you must have mixed-case user names on your system, the best way to proceed,
32284 assuming you want case-independent handling of incoming email, is to set up
32285 your first router to convert incoming local parts in your domains to the
32286 correct case by means of a file lookup. For example:
32287 .code
32288 correct_case:
32289   driver = redirect
32290   domains = +local_domains
32291   data = ${lookup{$local_part}cdb\
32292               {/etc/usercased.cdb}{$value}fail}\
32293               @$domain
32294 .endd
32295 For this router, the local part is forced to lower case by the default action
32296 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32297 up a new local part in the correct case. If you then set &%caseful_local_part%&
32298 on any subsequent routers which process your domains, they will operate on
32299 local parts with the correct case in a case-sensitive manner.
32300
32301
32302
32303 .section "Dots in local parts" "SECID231"
32304 .cindex "dot" "in local part"
32305 .cindex "local part" "dots in"
32306 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32307 part may not begin or end with a dot, nor have two consecutive dots in the
32308 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32309 empty components for compatibility.
32310
32311
32312
32313 .section "Rewriting addresses" "SECID232"
32314 .cindex "rewriting" "addresses"
32315 Rewriting of sender and recipient addresses, and addresses in headers, can
32316 happen automatically, or as the result of configuration options, as described
32317 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32318 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32319
32320 Automatic rewriting includes qualification, as mentioned above. The other case
32321 in which it can happen is when an incomplete non-local domain is given. The
32322 routing process may cause this to be expanded into the full domain name. For
32323 example, a header such as
32324 .code
32325 To: hare@teaparty
32326 .endd
32327 might get rewritten as
32328 .code
32329 To: hare@teaparty.wonderland.fict.example
32330 .endd
32331 Rewriting as a result of routing is the one kind of message processing that
32332 does not happen at input time, as it cannot be done until the address has
32333 been routed.
32334
32335 Strictly, one should not do &'any'& deliveries of a message until all its
32336 addresses have been routed, in case any of the headers get changed as a
32337 result of routing. However, doing this in practice would hold up many
32338 deliveries for unreasonable amounts of time, just because one address could not
32339 immediately be routed. Exim therefore does not delay other deliveries when
32340 routing of one or more addresses is deferred.
32341 .ecindex IIDmesproc
32342
32343
32344
32345 . ////////////////////////////////////////////////////////////////////////////
32346 . ////////////////////////////////////////////////////////////////////////////
32347
32348 .chapter "SMTP processing" "CHAPSMTP"
32349 .scindex IIDsmtpproc1 "SMTP" "processing details"
32350 .scindex IIDsmtpproc2 "LMTP" "processing details"
32351 Exim supports a number of different ways of using the SMTP protocol, and its
32352 LMTP variant, which is an interactive protocol for transferring messages into a
32353 closed mail store application. This chapter contains details of how SMTP is
32354 processed. For incoming mail, the following are available:
32355
32356 .ilist
32357 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32358 .next
32359 SMTP over the standard input and output (the &%-bs%& option);
32360 .next
32361 Batched SMTP on the standard input (the &%-bS%& option).
32362 .endlist
32363
32364 For mail delivery, the following are available:
32365
32366 .ilist
32367 SMTP over TCP/IP (the &(smtp)& transport);
32368 .next
32369 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32370 &"lmtp"&);
32371 .next
32372 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32373 transport);
32374 .next
32375 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32376 the &%use_bsmtp%& option set).
32377 .endlist
32378
32379 &'Batched SMTP'& is the name for a process in which batches of messages are
32380 stored in or read from files (or pipes), in a format in which SMTP commands are
32381 used to contain the envelope information.
32382
32383
32384
32385 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32386 .cindex "SMTP" "outgoing over TCP/IP"
32387 .cindex "outgoing SMTP over TCP/IP"
32388 .cindex "LMTP" "over TCP/IP"
32389 .cindex "outgoing LMTP over TCP/IP"
32390 .cindex "EHLO"
32391 .cindex "HELO"
32392 .cindex "SIZE option on MAIL command"
32393 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32394 The &%protocol%& option selects which protocol is to be used, but the actual
32395 processing is the same in both cases.
32396
32397 If, in response to its EHLO command, Exim is told that the SIZE
32398 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32399 command. The value of <&'n'&> is the message size plus the value of the
32400 &%size_addition%& option (default 1024) to allow for additions to the message
32401 such as per-transport header lines, or changes made in a
32402 .cindex "transport" "filter"
32403 .cindex "filter" "transport filter"
32404 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32405 suppressed.
32406
32407 If the remote server advertises support for PIPELINING, Exim uses the
32408 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32409 required for the transaction.
32410
32411 If the remote server advertises support for the STARTTLS command, and Exim
32412 was built to support TLS encryption, it tries to start a TLS session unless the
32413 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32414 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32415 is called for verification.
32416
32417 If the remote server advertises support for the AUTH command, Exim scans
32418 the authenticators configuration for any suitable client settings, as described
32419 in chapter &<<CHAPSMTPAUTH>>&.
32420
32421 .cindex "carriage return"
32422 .cindex "linefeed"
32423 Responses from the remote host are supposed to be terminated by CR followed by
32424 LF. However, there are known to be hosts that do not send CR characters, so in
32425 order to be able to interwork with such hosts, Exim treats LF on its own as a
32426 line terminator.
32427
32428 If a message contains a number of different addresses, all those with the same
32429 characteristics (for example, the same envelope sender) that resolve to the
32430 same set of hosts, in the same order, are sent in a single SMTP transaction,
32431 even if they are for different domains, unless there are more than the setting
32432 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32433 they are split into groups containing no more than &%max_rcpt%&s addresses
32434 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32435 in parallel sessions. The order of hosts with identical MX values is not
32436 significant when checking whether addresses can be batched in this way.
32437
32438 When the &(smtp)& transport suffers a temporary failure that is not
32439 message-related, Exim updates its transport-specific database, which contains
32440 records indexed by host name that remember which messages are waiting for each
32441 particular host. It also updates the retry database with new retry times.
32442
32443 .cindex "hints database" "retry keys"
32444 Exim's retry hints are based on host name plus IP address, so if one address of
32445 a multi-homed host is broken, it will soon be skipped most of the time.
32446 See the next section for more detail about error handling.
32447
32448 .cindex "SMTP" "passed connection"
32449 .cindex "SMTP" "batching over TCP/IP"
32450 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32451 looks in the hints database for the transport to see if there are any queued
32452 messages waiting for the host to which it is connected. If it finds one, it
32453 creates a new Exim process using the &%-MC%& option (which can only be used by
32454 a process running as root or the Exim user) and passes the TCP/IP socket to it
32455 so that it can deliver another message using the same socket. The new process
32456 does only those deliveries that are routed to the connected host, and may in
32457 turn pass the socket on to a third process, and so on.
32458
32459 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
32460 limit the number of messages sent down a single TCP/IP connection.
32461
32462 .cindex "asterisk" "after IP address"
32463 The second and subsequent messages delivered down an existing connection are
32464 identified in the main log by the addition of an asterisk after the closing
32465 square bracket of the IP address.
32466
32467
32468
32469
32470 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
32471 .cindex "error" "in outgoing SMTP"
32472 .cindex "SMTP" "errors in outgoing"
32473 .cindex "host" "error"
32474 Three different kinds of error are recognized for outgoing SMTP: host errors,
32475 message errors, and recipient errors.
32476
32477 .vlist
32478 .vitem "&*Host errors*&"
32479 A host error is not associated with a particular message or with a
32480 particular recipient of a message. The host errors are:
32481
32482 .ilist
32483 Connection refused or timed out,
32484 .next
32485 Any error response code on connection,
32486 .next
32487 Any error response code to EHLO or HELO,
32488 .next
32489 Loss of connection at any time, except after &"."&,
32490 .next
32491 I/O errors at any time,
32492 .next
32493 Timeouts during the session, other than in response to MAIL, RCPT or
32494 the &"."& at the end of the data.
32495 .endlist ilist
32496
32497 For a host error, a permanent error response on connection, or in response to
32498 EHLO, causes all addresses routed to the host to be failed. Any other host
32499 error causes all addresses to be deferred, and retry data to be created for the
32500 host. It is not tried again, for any message, until its retry time arrives. If
32501 the current set of addresses are not all delivered in this run (to some
32502 alternative host), the message is added to the list of those waiting for this
32503 host, so if it is still undelivered when a subsequent successful delivery is
32504 made to the host, it will be sent down the same SMTP connection.
32505
32506 .vitem "&*Message errors*&"
32507 .cindex "message" "error"
32508 A message error is associated with a particular message when sent to a
32509 particular host, but not with a particular recipient of the message. The
32510 message errors are:
32511
32512 .ilist
32513 Any error response code to MAIL, DATA, or the &"."& that terminates
32514 the data,
32515 .next
32516 Timeout after MAIL,
32517 .next
32518 Timeout or loss of connection after the &"."& that terminates the data. A
32519 timeout after the DATA command itself is treated as a host error, as is loss of
32520 connection at any other time.
32521 .endlist ilist
32522
32523 For a message error, a permanent error response (5&'xx'&) causes all addresses
32524 to be failed, and a delivery error report to be returned to the sender. A
32525 temporary error response (4&'xx'&), or one of the timeouts, causes all
32526 addresses to be deferred. Retry data is not created for the host, but instead,
32527 a retry record for the combination of host plus message id is created. The
32528 message is not added to the list of those waiting for this host. This ensures
32529 that the failing message will not be sent to this host again until the retry
32530 time arrives. However, other messages that are routed to the host are not
32531 affected, so if it is some property of the message that is causing the error,
32532 it will not stop the delivery of other mail.
32533
32534 If the remote host specified support for the SIZE parameter in its response
32535 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
32536 over-large message will cause a message error because the error arrives as a
32537 response to MAIL.
32538
32539 .vitem "&*Recipient errors*&"
32540 .cindex "recipient" "error"
32541 A recipient error is associated with a particular recipient of a message. The
32542 recipient errors are:
32543
32544 .ilist
32545 Any error response to RCPT,
32546 .next
32547 Timeout after RCPT.
32548 .endlist
32549
32550 For a recipient error, a permanent error response (5&'xx'&) causes the
32551 recipient address to be failed, and a bounce message to be returned to the
32552 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32553 address to be deferred, and routing retry data to be created for it. This is
32554 used to delay processing of the address in subsequent queue runs, until its
32555 routing retry time arrives. This applies to all messages, but because it
32556 operates only in queue runs, one attempt will be made to deliver a new message
32557 to the failing address before the delay starts to operate. This ensures that,
32558 if the failure is really related to the message rather than the recipient
32559 (&"message too big for this recipient"& is a possible example), other messages
32560 have a chance of getting delivered. If a delivery to the address does succeed,
32561 the retry information gets cleared, so all stuck messages get tried again, and
32562 the retry clock is reset.
32563
32564 The message is not added to the list of those waiting for this host. Use of the
32565 host for other messages is unaffected, and except in the case of a timeout,
32566 other recipients are processed independently, and may be successfully delivered
32567 in the current SMTP session. After a timeout it is of course impossible to
32568 proceed with the session, so all addresses get deferred. However, those other
32569 than the one that failed do not suffer any subsequent retry delays. Therefore,
32570 if one recipient is causing trouble, the others have a chance of getting
32571 through when a subsequent delivery attempt occurs before the failing
32572 recipient's retry time.
32573 .endlist
32574
32575 In all cases, if there are other hosts (or IP addresses) available for the
32576 current set of addresses (for example, from multiple MX records), they are
32577 tried in this run for any undelivered addresses, subject of course to their
32578 own retry data. In other words, recipient error retry data does not take effect
32579 until the next delivery attempt.
32580
32581 Some hosts have been observed to give temporary error responses to every
32582 MAIL command at certain times (&"insufficient space"& has been seen). It
32583 would be nice if such circumstances could be recognized, and defer data for the
32584 host itself created, but this is not possible within the current Exim design.
32585 What actually happens is that retry data for every (host, message) combination
32586 is created.
32587
32588 The reason that timeouts after MAIL and RCPT are treated specially is that
32589 these can sometimes arise as a result of the remote host's verification
32590 procedures. Exim makes this assumption, and treats them as if a temporary error
32591 response had been received. A timeout after &"."& is treated specially because
32592 it is known that some broken implementations fail to recognize the end of the
32593 message if the last character of the last line is a binary zero. Thus, it is
32594 helpful to treat this case as a message error.
32595
32596 Timeouts at other times are treated as host errors, assuming a problem with the
32597 host, or the connection to it. If a timeout after MAIL, RCPT,
32598 or &"."& is really a connection problem, the assumption is that at the next try
32599 the timeout is likely to occur at some other point in the dialogue, causing it
32600 then to be treated as a host error.
32601
32602 There is experimental evidence that some MTAs drop the connection after the
32603 terminating &"."& if they do not like the contents of the message for some
32604 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
32605 should be given. That is why Exim treats this case as a message rather than a
32606 host error, in order not to delay other messages to the same host.
32607
32608
32609
32610
32611 .section "Incoming SMTP messages over TCP/IP" "SECID233"
32612 .cindex "SMTP" "incoming over TCP/IP"
32613 .cindex "incoming SMTP over TCP/IP"
32614 .cindex "inetd"
32615 .cindex "daemon"
32616 Incoming SMTP messages can be accepted in one of two ways: by running a
32617 listening daemon, or by using &'inetd'&. In the latter case, the entry in
32618 &_/etc/inetd.conf_& should be like this:
32619 .code
32620 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
32621 .endd
32622 Exim distinguishes between this case and the case of a locally running user
32623 agent using the &%-bs%& option by checking whether or not the standard input is
32624 a socket. When it is, either the port must be privileged (less than 1024), or
32625 the caller must be root or the Exim user. If any other user passes a socket
32626 with an unprivileged port number, Exim prints a message on the standard error
32627 stream and exits with an error code.
32628
32629 By default, Exim does not make a log entry when a remote host connects or
32630 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
32631 unexpected. It can be made to write such log entries by setting the
32632 &%smtp_connection%& log selector.
32633
32634 .cindex "carriage return"
32635 .cindex "linefeed"
32636 Commands from the remote host are supposed to be terminated by CR followed by
32637 LF. However, there are known to be hosts that do not send CR characters. In
32638 order to be able to interwork with such hosts, Exim treats LF on its own as a
32639 line terminator.
32640 Furthermore, because common code is used for receiving messages from all
32641 sources, a CR on its own is also interpreted as a line terminator. However, the
32642 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
32643
32644 .cindex "EHLO" "invalid data"
32645 .cindex "HELO" "invalid data"
32646 One area that sometimes gives rise to problems concerns the EHLO or
32647 HELO commands. Some clients send syntactically invalid versions of these
32648 commands, which Exim rejects by default. (This is nothing to do with verifying
32649 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
32650 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
32651 match the broken hosts that send invalid commands.
32652
32653 .cindex "SIZE option on MAIL command"
32654 .cindex "MAIL" "SIZE option"
32655 The amount of disk space available is checked whenever SIZE is received on
32656 a MAIL command, independently of whether &%message_size_limit%& or
32657 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
32658 false. A temporary error is given if there is not enough space. If
32659 &%check_spool_space%& is set, the check is for that amount of space plus the
32660 value given with SIZE, that is, it checks that the addition of the incoming
32661 message will not reduce the space below the threshold.
32662
32663 When a message is successfully received, Exim includes the local message id in
32664 its response to the final &"."& that terminates the data. If the remote host
32665 logs this text it can help with tracing what has happened to a message.
32666
32667 The Exim daemon can limit the number of simultaneous incoming connections it is
32668 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
32669 number of simultaneous incoming connections from a single remote host (see the
32670 &%smtp_accept_max_per_host%& option). Additional connection attempts are
32671 rejected using the SMTP temporary error code 421.
32672
32673 The Exim daemon does not rely on the SIGCHLD signal to detect when a
32674 subprocess has finished, as this can get lost at busy times. Instead, it looks
32675 for completed subprocesses every time it wakes up. Provided there are other
32676 things happening (new incoming calls, starts of queue runs), completed
32677 processes will be noticed and tidied away. On very quiet systems you may
32678 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
32679 it will be noticed when the daemon next wakes up.
32680
32681 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
32682 and can also be set up to reject SMTP calls from non-reserved hosts at times of
32683 high system load &-- for details see the &%smtp_accept_reserve%&,
32684 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
32685 applies in both the daemon and &'inetd'& cases.
32686
32687 Exim normally starts a delivery process for each message received, though this
32688 can be varied by means of the &%-odq%& command line option and the
32689 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
32690 number of simultaneously running delivery processes started in this way from
32691 SMTP input can be limited by the &%smtp_accept_queue%& and
32692 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
32693 subsequently received messages are just put on the input queue without starting
32694 a delivery process.
32695
32696 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
32697 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
32698 started up from the &'inetd'& daemon, because in that case each connection is
32699 handled by an entirely independent Exim process. Control by load average is,
32700 however, available with &'inetd'&.
32701
32702 Exim can be configured to verify addresses in incoming SMTP commands as they
32703 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
32704 to rewrite addresses at this time &-- before any syntax checking is done. See
32705 section &<<SECTrewriteS>>&.
32706
32707 Exim can also be configured to limit the rate at which a client host submits
32708 MAIL and RCPT commands in a single SMTP session. See the
32709 &%smtp_ratelimit_hosts%& option.
32710
32711
32712
32713 .section "Unrecognized SMTP commands" "SECID234"
32714 .cindex "SMTP" "unrecognized commands"
32715 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
32716 commands during a single SMTP connection, it drops the connection after sending
32717 the error response to the last command. The default value for
32718 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
32719 abuse that subvert web servers into making connections to SMTP ports; in these
32720 circumstances, a number of non-SMTP lines are sent first.
32721
32722
32723 .section "Syntax and protocol errors in SMTP commands" "SECID235"
32724 .cindex "SMTP" "syntax errors"
32725 .cindex "SMTP" "protocol errors"
32726 A syntax error is detected if an SMTP command is recognized, but there is
32727 something syntactically wrong with its data, for example, a malformed email
32728 address in a RCPT command. Protocol errors include invalid command
32729 sequencing such as RCPT before MAIL. If Exim receives more than
32730 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
32731 drops the connection after sending the error response to the last command. The
32732 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
32733 broken clients that loop sending bad commands (yes, it has been seen).
32734
32735
32736
32737 .section "Use of non-mail SMTP commands" "SECID236"
32738 .cindex "SMTP" "non-mail commands"
32739 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
32740 DATA. Exim counts such commands, and drops the connection if there are too
32741 many of them in a single SMTP session. This action catches some
32742 denial-of-service attempts and things like repeated failing AUTHs, or a mad
32743 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
32744 defines what &"too many"& means. Its default value is 10.
32745
32746 When a new message is expected, one occurrence of RSET is not counted. This
32747 allows a client to send one RSET between messages (this is not necessary,
32748 but some clients do it). Exim also allows one uncounted occurrence of HELO
32749 or EHLO, and one occurrence of STARTTLS between messages. After
32750 starting up a TLS session, another EHLO is expected, and so it too is not
32751 counted.
32752
32753 The first occurrence of AUTH in a connection, or immediately following
32754 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
32755 RCPT, DATA, and QUIT are counted.
32756
32757 You can control which hosts are subject to the limit set by
32758 &%smtp_accept_max_nonmail%& by setting
32759 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
32760 the limit apply to all hosts. This option means that you can exclude any
32761 specific badly-behaved hosts that you have to live with.
32762
32763
32764
32765
32766 .section "The VRFY and EXPN commands" "SECID237"
32767 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
32768 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
32769 appropriate) in order to decide whether the command should be accepted or not.
32770 If no ACL is defined, the command is rejected.
32771
32772 .cindex "VRFY" "processing"
32773 When VRFY is accepted, it runs exactly the same code as when Exim is
32774 called with the &%-bv%& option.
32775
32776 .cindex "EXPN" "processing"
32777 When EXPN is accepted, a single-level expansion of the address is done.
32778 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
32779 than a verification (the &%-bv%& option). If an unqualified local part is given
32780 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
32781 of VRFY and EXPN commands are logged on the main and reject logs, and
32782 VRFY verification failures are logged on the main log for consistency with
32783 RCPT failures.
32784
32785
32786
32787 .section "The ETRN command" "SECTETRN"
32788 .cindex "ETRN" "processing"
32789 RFC 1985 describes an SMTP command called ETRN that is designed to
32790 overcome the security problems of the TURN command (which has fallen into
32791 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
32792 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
32793 should be accepted or not. If no ACL is defined, the command is rejected.
32794
32795 The ETRN command is concerned with &"releasing"& messages that are awaiting
32796 delivery to certain hosts. As Exim does not organize its message queue by host,
32797 the only form of ETRN that is supported by default is the one where the
32798 text starts with the &"#"& prefix, in which case the remainder of the text is
32799 specific to the SMTP server. A valid ETRN command causes a run of Exim with
32800 the &%-R%& option to happen, with the remainder of the ETRN text as its
32801 argument. For example,
32802 .code
32803 ETRN #brigadoon
32804 .endd
32805 runs the command
32806 .code
32807 exim -R brigadoon
32808 .endd
32809 which causes a delivery attempt on all messages with undelivered addresses
32810 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
32811 default), Exim prevents the simultaneous execution of more than one queue run
32812 for the same argument string as a result of an ETRN command. This stops
32813 a misbehaving client from starting more than one queue runner at once.
32814
32815 .cindex "hints database" "ETRN serialization"
32816 Exim implements the serialization by means of a hints database in which a
32817 record is written whenever a process is started by ETRN, and deleted when
32818 the process completes. However, Exim does not keep the SMTP session waiting for
32819 the ETRN process to complete. Once ETRN is accepted, the client is sent
32820 a &"success"& return code. Obviously there is scope for hints records to get
32821 left lying around if there is a system or program crash. To guard against this,
32822 Exim ignores any records that are more than six hours old.
32823
32824 .oindex "&%smtp_etrn_command%&"
32825 For more control over what ETRN does, the &%smtp_etrn_command%& option can
32826 used. This specifies a command that is run whenever ETRN is received,
32827 whatever the form of its argument. For
32828 example:
32829 .code
32830 smtp_etrn_command = /etc/etrn_command $domain \
32831                     $sender_host_address
32832 .endd
32833 .vindex "&$domain$&"
32834 The string is split up into arguments which are independently expanded. The
32835 expansion variable &$domain$& is set to the argument of the ETRN command,
32836 and no syntax checking is done on the contents of this argument. Exim does not
32837 wait for the command to complete, so its status code is not checked. Exim runs
32838 under its own uid and gid when receiving incoming SMTP, so it is not possible
32839 for it to change them before running the command.
32840
32841
32842
32843 .section "Incoming local SMTP" "SECID238"
32844 .cindex "SMTP" "local incoming"
32845 Some user agents use SMTP to pass messages to their local MTA using the
32846 standard input and output, as opposed to passing the envelope on the command
32847 line and writing the message to the standard input. This is supported by the
32848 &%-bs%& option. This form of SMTP is handled in the same way as incoming
32849 messages over TCP/IP (including the use of ACLs), except that the envelope
32850 sender given in a MAIL command is ignored unless the caller is trusted. In
32851 an ACL you can detect this form of SMTP input by testing for an empty host
32852 identification. It is common to have this as the first line in the ACL that
32853 runs for RCPT commands:
32854 .code
32855 accept hosts = :
32856 .endd
32857 This accepts SMTP messages from local processes without doing any other tests.
32858
32859
32860
32861 .section "Outgoing batched SMTP" "SECTbatchSMTP"
32862 .cindex "SMTP" "batched outgoing"
32863 .cindex "batched SMTP output"
32864 Both the &(appendfile)& and &(pipe)& transports can be used for handling
32865 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
32866 be output in BSMTP format. No SMTP responses are possible for this form of
32867 delivery. All it is doing is using SMTP commands as a way of transmitting the
32868 envelope along with the message.
32869
32870 The message is written to the file or pipe preceded by the SMTP commands
32871 MAIL and RCPT, and followed by a line containing a single dot. Lines in
32872 the message that start with a dot have an extra dot added. The SMTP command
32873 HELO is not normally used. If it is required, the &%message_prefix%& option
32874 can be used to specify it.
32875
32876 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
32877 one recipient address at a time by default. However, you can arrange for them
32878 to handle several addresses at once by setting the &%batch_max%& option. When
32879 this is done for BSMTP, messages may contain multiple RCPT commands. See
32880 chapter &<<CHAPbatching>>& for more details.
32881
32882 .vindex "&$host$&"
32883 When one or more addresses are routed to a BSMTP transport by a router that
32884 sets up a host list, the name of the first host on the list is available to the
32885 transport in the variable &$host$&. Here is an example of such a transport and
32886 router:
32887 .code
32888 begin routers
32889 route_append:
32890   driver = manualroute
32891   transport = smtp_appendfile
32892   route_list = domain.example  batch.host.example
32893
32894 begin transports
32895 smtp_appendfile:
32896   driver = appendfile
32897   directory = /var/bsmtp/$host
32898   batch_max = 1000
32899   use_bsmtp
32900   user = exim
32901 .endd
32902 This causes messages addressed to &'domain.example'& to be written in BSMTP
32903 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
32904 message (unless there are more than 1000 recipients).
32905
32906
32907
32908 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
32909 .cindex "SMTP" "batched incoming"
32910 .cindex "batched SMTP input"
32911 The &%-bS%& command line option causes Exim to accept one or more messages by
32912 reading SMTP on the standard input, but to generate no responses. If the caller
32913 is trusted, the senders in the MAIL commands are believed; otherwise the
32914 sender is always the caller of Exim. Unqualified senders and receivers are not
32915 rejected (there seems little point) but instead just get qualified. HELO
32916 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
32917 as NOOP; QUIT quits.
32918
32919 Minimal policy checking is done for BSMTP input. Only the non-SMTP
32920 ACL is run in the same way as for non-SMTP local input.
32921
32922 If an error is detected while reading a message, including a missing &"."& at
32923 the end, Exim gives up immediately. It writes details of the error to the
32924 standard output in a stylized way that the calling program should be able to
32925 make some use of automatically, for example:
32926 .code
32927 554 Unexpected end of file
32928 Transaction started in line 10
32929 Error detected in line 14
32930 .endd
32931 It writes a more verbose version, for human consumption, to the standard error
32932 file, for example:
32933 .code
32934 An error was detected while processing a file of BSMTP input.
32935 The error message was:
32936
32937 501 '>' missing at end of address
32938
32939 The SMTP transaction started in line 10.
32940 The error was detected in line 12.
32941 The SMTP command at fault was:
32942
32943 rcpt to:<malformed@in.com.plete
32944
32945 1 previous message was successfully processed.
32946 The rest of the batch was abandoned.
32947 .endd
32948 The return code from Exim is zero only if there were no errors. It is 1 if some
32949 messages were accepted before an error was detected, and 2 if no messages were
32950 accepted.
32951 .ecindex IIDsmtpproc1
32952 .ecindex IIDsmtpproc2
32953
32954
32955
32956 . ////////////////////////////////////////////////////////////////////////////
32957 . ////////////////////////////////////////////////////////////////////////////
32958
32959 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
32960          "Customizing messages"
32961 When a message fails to be delivered, or remains on the queue for more than a
32962 configured amount of time, Exim sends a message to the original sender, or
32963 to an alternative configured address. The text of these messages is built into
32964 the code of Exim, but it is possible to change it, either by adding a single
32965 string, or by replacing each of the paragraphs by text supplied in a file.
32966
32967 The &'From:'& and &'To:'& header lines are automatically generated; you can
32968 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
32969 option. Exim also adds the line
32970 .code
32971 Auto-Submitted: auto-generated
32972 .endd
32973 to all warning and bounce messages,
32974
32975
32976 .section "Customizing bounce messages" "SECID239"
32977 .cindex "customizing" "bounce message"
32978 .cindex "bounce message" "customizing"
32979 If &%bounce_message_text%& is set, its contents are included in the default
32980 message immediately after &"This message was created automatically by mail
32981 delivery software."& The string is not expanded. It is not used if
32982 &%bounce_message_file%& is set.
32983
32984 When &%bounce_message_file%& is set, it must point to a template file for
32985 constructing error messages. The file consists of a series of text items,
32986 separated by lines consisting of exactly four asterisks. If the file cannot be
32987 opened, default text is used and a message is written to the main and panic
32988 logs. If any text item in the file is empty, default text is used for that
32989 item.
32990
32991 .vindex "&$bounce_recipient$&"
32992 .vindex "&$bounce_return_size_limit$&"
32993 Each item of text that is read from the file is expanded, and there are two
32994 expansion variables which can be of use here: &$bounce_recipient$& is set to
32995 the recipient of an error message while it is being created, and
32996 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
32997 option, rounded to a whole number.
32998
32999 The items must appear in the file in the following order:
33000
33001 .ilist
33002 The first item is included in the headers, and should include at least a
33003 &'Subject:'& header. Exim does not check the syntax of these headers.
33004 .next
33005 The second item forms the start of the error message. After it, Exim lists the
33006 failing addresses with their error messages.
33007 .next
33008 The third item is used to introduce any text from pipe transports that is to be
33009 returned to the sender. It is omitted if there is no such text.
33010 .next
33011 The fourth item is used to introduce the copy of the message that is returned
33012 as part of the error report.
33013 .next
33014 The fifth item is added after the fourth one if the returned message is
33015 truncated because it is bigger than &%return_size_limit%&.
33016 .next
33017 The sixth item is added after the copy of the original message.
33018 .endlist
33019
33020 The default state (&%bounce_message_file%& unset) is equivalent to the
33021 following file, in which the sixth item is empty. The &'Subject:'& and some
33022 other lines have been split in order to fit them on the page:
33023 .code
33024 Subject: Mail delivery failed
33025   ${if eq{$sender_address}{$bounce_recipient}
33026   {: returning message to sender}}
33027 ****
33028 This message was created automatically by mail delivery software.
33029
33030 A message ${if eq{$sender_address}{$bounce_recipient}
33031   {that you sent }{sent by
33032
33033 <$sender_address>
33034
33035 }}could not be delivered to all of its recipients.
33036 This is a permanent error. The following address(es) failed:
33037 ****
33038 The following text was generated during the delivery attempt(s):
33039 ****
33040 ------ This is a copy of the message, including all the headers.
33041   ------
33042 ****
33043 ------ The body of the message is $message_size characters long;
33044   only the first
33045 ------ $bounce_return_size_limit or so are included here.
33046 ****
33047 .endd
33048 .section "Customizing warning messages" "SECTcustwarn"
33049 .cindex "customizing" "warning message"
33050 .cindex "warning of delay" "customizing the message"
33051 The option &%warn_message_file%& can be pointed at a template file for use when
33052 warnings about message delays are created. In this case there are only three
33053 text sections:
33054
33055 .ilist
33056 The first item is included in the headers, and should include at least a
33057 &'Subject:'& header. Exim does not check the syntax of these headers.
33058 .next
33059 The second item forms the start of the warning message. After it, Exim lists
33060 the delayed addresses.
33061 .next
33062 The third item then ends the message.
33063 .endlist
33064
33065 The default state is equivalent to the following file, except that some lines
33066 have been split here, in order to fit them on the page:
33067 .code
33068 Subject: Warning: message $message_exim_id delayed
33069   $warn_message_delay
33070 ****
33071 This message was created automatically by mail delivery software.
33072
33073 A message ${if eq{$sender_address}{$warn_message_recipients}
33074 {that you sent }{sent by
33075
33076 <$sender_address>
33077
33078 }}has not been delivered to all of its recipients after
33079 more than $warn_message_delay on the queue on $primary_hostname.
33080
33081 The message identifier is:     $message_exim_id
33082 The subject of the message is: $h_subject
33083 The date of the message is:    $h_date
33084
33085 The following address(es) have not yet been delivered:
33086 ****
33087 No action is required on your part. Delivery attempts will
33088 continue for some time, and this warning may be repeated at
33089 intervals if the message remains undelivered. Eventually the
33090 mail delivery software will give up, and when that happens,
33091 the message will be returned to you.
33092 .endd
33093 .vindex "&$warn_message_delay$&"
33094 .vindex "&$warn_message_recipients$&"
33095 However, in the default state the subject and date lines are omitted if no
33096 appropriate headers exist. During the expansion of this file,
33097 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33098 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33099 of recipients for the warning message. There may be more than one if there are
33100 multiple addresses with different &%errors_to%& settings on the routers that
33101 handled them.
33102
33103
33104
33105
33106 . ////////////////////////////////////////////////////////////////////////////
33107 . ////////////////////////////////////////////////////////////////////////////
33108
33109 .chapter "Some common configuration settings" "CHAPcomconreq"
33110 This chapter discusses some configuration settings that seem to be fairly
33111 common. More examples and discussion can be found in the Exim book.
33112
33113
33114
33115 .section "Sending mail to a smart host" "SECID240"
33116 .cindex "smart host" "example router"
33117 If you want to send all mail for non-local domains to a &"smart host"&, you
33118 should replace the default &(dnslookup)& router with a router which does the
33119 routing explicitly:
33120 .code
33121 send_to_smart_host:
33122   driver = manualroute
33123   route_list = !+local_domains smart.host.name
33124   transport = remote_smtp
33125 .endd
33126 You can use the smart host's IP address instead of the name if you wish.
33127 If you are using Exim only to submit messages to a smart host, and not for
33128 receiving incoming messages, you can arrange for it to do the submission
33129 synchronously by setting the &%mua_wrapper%& option (see chapter
33130 &<<CHAPnonqueueing>>&).
33131
33132
33133
33134
33135 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33136 .cindex "mailing lists"
33137 Exim can be used to run simple mailing lists, but for large and/or complicated
33138 requirements, the use of additional specialized mailing list software such as
33139 Majordomo or Mailman is recommended.
33140
33141 The &(redirect)& router can be used to handle mailing lists where each list
33142 is maintained in a separate file, which can therefore be managed by an
33143 independent manager. The &%domains%& router option can be used to run these
33144 lists in a separate domain from normal mail. For example:
33145 .code
33146 lists:
33147   driver = redirect
33148   domains = lists.example
33149   file = /usr/lists/$local_part
33150   forbid_pipe
33151   forbid_file
33152   errors_to = $local_part-request@lists.example
33153   no_more
33154 .endd
33155 This router is skipped for domains other than &'lists.example'&. For addresses
33156 in that domain, it looks for a file that matches the local part. If there is no
33157 such file, the router declines, but because &%no_more%& is set, no subsequent
33158 routers are tried, and so the whole delivery fails.
33159
33160 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33161 expanded into a file name or a pipe delivery, which is usually inappropriate in
33162 a mailing list.
33163
33164 .oindex "&%errors_to%&"
33165 The &%errors_to%& option specifies that any delivery errors caused by addresses
33166 taken from a mailing list are to be sent to the given address rather than the
33167 original sender of the message. However, before acting on this, Exim verifies
33168 the error address, and ignores it if verification fails.
33169
33170 For example, using the configuration above, mail sent to
33171 &'dicts@lists.example'& is passed on to those addresses contained in
33172 &_/usr/lists/dicts_&, with error reports directed to
33173 &'dicts-request@lists.example'&, provided that this address can be verified.
33174 There could be a file called &_/usr/lists/dicts-request_& containing
33175 the address(es) of this particular list's manager(s), but other approaches,
33176 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33177 or &%local_part_suffix%& options) to handle addresses of the form
33178 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33179
33180
33181
33182 .section "Syntax errors in mailing lists" "SECID241"
33183 .cindex "mailing lists" "syntax errors in"
33184 If an entry in redirection data contains a syntax error, Exim normally defers
33185 delivery of the original address. That means that a syntax error in a mailing
33186 list holds up all deliveries to the list. This may not be appropriate when a
33187 list is being maintained automatically from data supplied by users, and the
33188 addresses are not rigorously checked.
33189
33190 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33191 entries that fail to parse, noting the incident in the log. If in addition
33192 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33193 whenever a broken address is skipped. It is usually appropriate to set
33194 &%syntax_errors_to%& to the same address as &%errors_to%&.
33195
33196
33197
33198 .section "Re-expansion of mailing lists" "SECID242"
33199 .cindex "mailing lists" "re-expansion of"
33200 Exim remembers every individual address to which a message has been delivered,
33201 in order to avoid duplication, but it normally stores only the original
33202 recipient addresses with a message. If all the deliveries to a mailing list
33203 cannot be done at the first attempt, the mailing list is re-expanded when the
33204 delivery is next tried. This means that alterations to the list are taken into
33205 account at each delivery attempt, so addresses that have been added to
33206 the list since the message arrived will therefore receive a copy of the
33207 message, even though it pre-dates their subscription.
33208
33209 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33210 on the &(redirect)& router. If this is done, any addresses generated by the
33211 router that fail to deliver at the first attempt are added to the message as
33212 &"top level"& addresses, and the parent address that generated them is marked
33213 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33214 subsequent delivery attempts. The disadvantage of this is that if any of the
33215 failing addresses are incorrect, correcting them in the file has no effect on
33216 pre-existing messages.
33217
33218 The original top-level address is remembered with each of the generated
33219 addresses, and is output in any log messages. However, any intermediate parent
33220 addresses are not recorded. This makes a difference to the log only if the
33221 &%all_parents%& selector is set, but for mailing lists there is normally only
33222 one level of expansion anyway.
33223
33224
33225
33226 .section "Closed mailing lists" "SECID243"
33227 .cindex "mailing lists" "closed"
33228 The examples so far have assumed open mailing lists, to which anybody may
33229 send mail. It is also possible to set up closed lists, where mail is accepted
33230 from specified senders only. This is done by making use of the generic
33231 &%senders%& option to restrict the router that handles the list.
33232
33233 The following example uses the same file as a list of recipients and as a list
33234 of permitted senders. It requires three routers:
33235 .code
33236 lists_request:
33237   driver = redirect
33238   domains = lists.example
33239   local_part_suffix = -request
33240   file = /usr/lists/$local_part$local_part_suffix
33241   no_more
33242
33243 lists_post:
33244   driver = redirect
33245   domains = lists.example
33246   senders = ${if exists {/usr/lists/$local_part}\
33247              {lsearch;/usr/lists/$local_part}{*}}
33248   file = /usr/lists/$local_part
33249   forbid_pipe
33250   forbid_file
33251   errors_to = $local_part-request@lists.example
33252   no_more
33253
33254 lists_closed:
33255   driver = redirect
33256   domains = lists.example
33257   allow_fail
33258   data = :fail: $local_part@lists.example is a closed mailing list
33259 .endd
33260 All three routers have the same &%domains%& setting, so for any other domains,
33261 they are all skipped. The first router runs only if the local part ends in
33262 &%-request%&. It handles messages to the list manager(s) by means of an open
33263 mailing list.
33264
33265 The second router runs only if the &%senders%& precondition is satisfied. It
33266 checks for the existence of a list that corresponds to the local part, and then
33267 checks that the sender is on the list by means of a linear search. It is
33268 necessary to check for the existence of the file before trying to search it,
33269 because otherwise Exim thinks there is a configuration error. If the file does
33270 not exist, the expansion of &%senders%& is *, which matches all senders. This
33271 means that the router runs, but because there is no list, declines, and
33272 &%no_more%& ensures that no further routers are run. The address fails with an
33273 &"unrouteable address"& error.
33274
33275 The third router runs only if the second router is skipped, which happens when
33276 a mailing list exists, but the sender is not on it. This router forcibly fails
33277 the address, giving a suitable error message.
33278
33279
33280
33281
33282 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33283 .cindex "VERP"
33284 .cindex "Variable Envelope Return Paths"
33285 .cindex "envelope sender"
33286 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33287 are a way of helping mailing list administrators discover which subscription
33288 address is the cause of a particular delivery failure. The idea is to encode
33289 the original recipient address in the outgoing envelope sender address, so that
33290 if the message is forwarded by another host and then subsequently bounces, the
33291 original recipient can be extracted from the recipient address of the bounce.
33292
33293 .oindex &%errors_to%&
33294 .oindex &%return_path%&
33295 Envelope sender addresses can be modified by Exim using two different
33296 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33297 list examples), or the &%return_path%& option on a transport. The second of
33298 these is effective only if the message is successfully delivered to another
33299 host; it is not used for errors detected on the local host (see the description
33300 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33301 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33302 .code
33303 verp_smtp:
33304   driver = smtp
33305   max_rcpt = 1
33306   return_path = \
33307     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33308       {$1-request+$local_part=$domain@your.dom.example}fail}
33309 .endd
33310 This has the effect of rewriting the return path (envelope sender) on outgoing
33311 SMTP messages, if the local part of the original return path ends in
33312 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33313 local part and domain of the recipient into the return path. Suppose, for
33314 example, that a message whose return path has been set to
33315 &'somelist-request@your.dom.example'& is sent to
33316 &'subscriber@other.dom.example'&. In the transport, the return path is
33317 rewritten as
33318 .code
33319 somelist-request+subscriber=other.dom.example@your.dom.example
33320 .endd
33321 .vindex "&$local_part$&"
33322 For this to work, you must tell Exim to send multiple copies of messages that
33323 have more than one recipient, so that each copy has just one recipient. This is
33324 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33325 might be sent to several different recipients in the same domain, in which case
33326 &$local_part$& is not available in the transport, because it is not unique.
33327
33328 Unless your host is doing nothing but mailing list deliveries, you should
33329 probably use a separate transport for the VERP deliveries, so as not to use
33330 extra resources in making one-per-recipient copies for other deliveries. This
33331 can easily be done by expanding the &%transport%& option in the router:
33332 .code
33333 dnslookup:
33334   driver = dnslookup
33335   domains = ! +local_domains
33336   transport = \
33337     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33338       {verp_smtp}{remote_smtp}}
33339   no_more
33340 .endd
33341 If you want to change the return path using &%errors_to%& in a router instead
33342 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33343 routers that handle mailing list addresses. This will ensure that all delivery
33344 errors, including those detected on the local host, are sent to the VERP
33345 address.
33346
33347 On a host that does no local deliveries and has no manual routing, only the
33348 &(dnslookup)& router needs to be changed. A special transport is not needed for
33349 SMTP deliveries. Every mailing list recipient has its own return path value,
33350 and so Exim must hand them to the transport one at a time. Here is an example
33351 of a &(dnslookup)& router that implements VERP:
33352 .code
33353 verp_dnslookup:
33354   driver = dnslookup
33355   domains = ! +local_domains
33356   transport = remote_smtp
33357   errors_to = \
33358     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33359      {$1-request+$local_part=$domain@your.dom.example}fail}
33360   no_more
33361 .endd
33362 Before you start sending out messages with VERPed return paths, you must also
33363 configure Exim to accept the bounce messages that come back to those paths.
33364 Typically this is done by setting a &%local_part_suffix%& option for a
33365 router, and using this to route the messages to wherever you want to handle
33366 them.
33367
33368 The overhead incurred in using VERP depends very much on the size of the
33369 message, the number of recipient addresses that resolve to the same remote
33370 host, and the speed of the connection over which the message is being sent. If
33371 a lot of addresses resolve to the same host and the connection is slow, sending
33372 a separate copy of the message for each address may take substantially longer
33373 than sending a single copy with many recipients (for which VERP cannot be
33374 used).
33375
33376
33377
33378
33379
33380
33381 .section "Virtual domains" "SECTvirtualdomains"
33382 .cindex "virtual domains"
33383 .cindex "domain" "virtual"
33384 The phrase &'virtual domain'& is unfortunately used with two rather different
33385 meanings:
33386
33387 .ilist
33388 A domain for which there are no real mailboxes; all valid local parts are
33389 aliases for other email addresses. Common examples are organizational
33390 top-level domains and &"vanity"& domains.
33391 .next
33392 One of a number of independent domains that are all handled by the same host,
33393 with mailboxes on that host, but where the mailbox owners do not necessarily
33394 have login accounts on that host.
33395 .endlist
33396
33397 The first usage is probably more common, and does seem more &"virtual"& than
33398 the second. This kind of domain can be handled in Exim with a straightforward
33399 aliasing router. One approach is to create a separate alias file for each
33400 virtual domain. Exim can test for the existence of the alias file to determine
33401 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33402 to a router of this form:
33403 .code
33404 virtual:
33405   driver = redirect
33406   domains = dsearch;/etc/mail/virtual
33407   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33408   no_more
33409 .endd
33410 The &%domains%& option specifies that the router is to be skipped, unless there
33411 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33412 domain that is being processed. When the router runs, it looks up the local
33413 part in the file to find a new address (or list of addresses). The &%no_more%&
33414 setting ensures that if the lookup fails (leading to &%data%& being an empty
33415 string), Exim gives up on the address without trying any subsequent routers.
33416
33417 This one router can handle all the virtual domains because the alias file names
33418 follow a fixed pattern. Permissions can be arranged so that appropriate people
33419 can edit the different alias files. A successful aliasing operation results in
33420 a new envelope recipient address, which is then routed from scratch.
33421
33422 The other kind of &"virtual"& domain can also be handled in a straightforward
33423 way. One approach is to create a file for each domain containing a list of
33424 valid local parts, and use it in a router like this:
33425 .code
33426 my_domains:
33427   driver = accept
33428   domains = dsearch;/etc/mail/domains
33429   local_parts = lsearch;/etc/mail/domains/$domain
33430   transport = my_mailboxes
33431 .endd
33432 The address is accepted if there is a file for the domain, and the local part
33433 can be found in the file. The &%domains%& option is used to check for the
33434 file's existence because &%domains%& is tested before the &%local_parts%&
33435 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33436 because that option is tested after &%local_parts%&. The transport is as
33437 follows:
33438 .code
33439 my_mailboxes:
33440   driver = appendfile
33441   file = /var/mail/$domain/$local_part
33442   user = mail
33443 .endd
33444 This uses a directory of mailboxes for each domain. The &%user%& setting is
33445 required, to specify which uid is to be used for writing to the mailboxes.
33446
33447 The configuration shown here is just one example of how you might support this
33448 requirement. There are many other ways this kind of configuration can be set
33449 up, for example, by using a database instead of separate files to hold all the
33450 information about the domains.
33451
33452
33453
33454 .section "Multiple user mailboxes" "SECTmulbox"
33455 .cindex "multiple mailboxes"
33456 .cindex "mailbox" "multiple"
33457 .cindex "local part" "prefix"
33458 .cindex "local part" "suffix"
33459 Heavy email users often want to operate with multiple mailboxes, into which
33460 incoming mail is automatically sorted. A popular way of handling this is to
33461 allow users to use multiple sender addresses, so that replies can easily be
33462 identified. Users are permitted to add prefixes or suffixes to their local
33463 parts for this purpose. The wildcard facility of the generic router options
33464 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
33465 example, consider this router:
33466 .code
33467 userforward:
33468   driver = redirect
33469   check_local_user
33470   file = $home/.forward
33471   local_part_suffix = -*
33472   local_part_suffix_optional
33473   allow_filter
33474 .endd
33475 .vindex "&$local_part_suffix$&"
33476 It runs a user's &_.forward_& file for all local parts of the form
33477 &'username-*'&. Within the filter file the user can distinguish different
33478 cases by testing the variable &$local_part_suffix$&. For example:
33479 .code
33480 if $local_part_suffix contains -special then
33481 save /home/$local_part/Mail/special
33482 endif
33483 .endd
33484 If the filter file does not exist, or does not deal with such addresses, they
33485 fall through to subsequent routers, and, assuming no subsequent use of the
33486 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
33487 control over which suffixes are valid.
33488
33489 Alternatively, a suffix can be used to trigger the use of a different
33490 &_.forward_& file &-- which is the way a similar facility is implemented in
33491 another MTA:
33492 .code
33493 userforward:
33494   driver = redirect
33495   check_local_user
33496   file = $home/.forward$local_part_suffix
33497   local_part_suffix = -*
33498   local_part_suffix_optional
33499   allow_filter
33500 .endd
33501 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
33502 example, &_.forward-special_& is used. Once again, if the appropriate file
33503 does not exist, or does not deal with the address, it is passed on to
33504 subsequent routers, which could, if required, look for an unqualified
33505 &_.forward_& file to use as a default.
33506
33507
33508
33509 .section "Simplified vacation processing" "SECID244"
33510 .cindex "vacation processing"
33511 The traditional way of running the &'vacation'& program is for a user to set up
33512 a pipe command in a &_.forward_& file
33513 (see section &<<SECTspecitredli>>& for syntax details).
33514 This is prone to error by inexperienced users. There are two features of Exim
33515 that can be used to make this process simpler for users:
33516
33517 .ilist
33518 A local part prefix such as &"vacation-"& can be specified on a router which
33519 can cause the message to be delivered directly to the &'vacation'& program, or
33520 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
33521 &_.forward_& file are then much simpler. For example:
33522 .code
33523 spqr, vacation-spqr
33524 .endd
33525 .next
33526 The &%require_files%& generic router option can be used to trigger a
33527 vacation delivery by checking for the existence of a certain file in the
33528 user's home directory. The &%unseen%& generic option should also be used, to
33529 ensure that the original delivery also proceeds. In this case, all the user has
33530 to do is to create a file called, say, &_.vacation_&, containing a vacation
33531 message.
33532 .endlist
33533
33534 Another advantage of both these methods is that they both work even when the
33535 use of arbitrary pipes by users is locked out.
33536
33537
33538
33539 .section "Taking copies of mail" "SECID245"
33540 .cindex "message" "copying every"
33541 Some installations have policies that require archive copies of all messages to
33542 be made. A single copy of each message can easily be taken by an appropriate
33543 command in a system filter, which could, for example, use a different file for
33544 each day's messages.
33545
33546 There is also a shadow transport mechanism that can be used to take copies of
33547 messages that are successfully delivered by local transports, one copy per
33548 delivery. This could be used, &'inter alia'&, to implement automatic
33549 notification of delivery by sites that insist on doing such things.
33550
33551
33552
33553 .section "Intermittently connected hosts" "SECID246"
33554 .cindex "intermittently connected hosts"
33555 It has become quite common (because it is cheaper) for hosts to connect to the
33556 Internet periodically rather than remain connected all the time. The normal
33557 arrangement is that mail for such hosts accumulates on a system that is
33558 permanently connected.
33559
33560 Exim was designed for use on permanently connected hosts, and so it is not
33561 particularly well-suited to use in an intermittently connected environment.
33562 Nevertheless there are some features that can be used.
33563
33564
33565 .section "Exim on the upstream server host" "SECID247"
33566 It is tempting to arrange for incoming mail for the intermittently connected
33567 host to remain on Exim's queue until the client connects. However, this
33568 approach does not scale very well. Two different kinds of waiting message are
33569 being mixed up in the same queue &-- those that cannot be delivered because of
33570 some temporary problem, and those that are waiting for their destination host
33571 to connect. This makes it hard to manage the queue, as well as wasting
33572 resources, because each queue runner scans the entire queue.
33573
33574 A better approach is to separate off those messages that are waiting for an
33575 intermittently connected host. This can be done by delivering these messages
33576 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33577 format, from where they are transmitted by other software when their
33578 destination connects. This makes it easy to collect all the mail for one host
33579 in a single directory, and to apply local timeout rules on a per-message basis
33580 if required.
33581
33582 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33583 you are doing this, you should configure Exim with a long retry period for the
33584 intermittent host. For example:
33585 .code
33586 cheshire.wonderland.fict.example    *   F,5d,24h
33587 .endd
33588 This stops a lot of failed delivery attempts from occurring, but Exim remembers
33589 which messages it has queued up for that host. Once the intermittent host comes
33590 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
33591 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
33592 causes all the queued up messages to be delivered, often down a single SMTP
33593 connection. While the host remains connected, any new messages get delivered
33594 immediately.
33595
33596 If the connecting hosts do not have fixed IP addresses, that is, if a host is
33597 issued with a different IP address each time it connects, Exim's retry
33598 mechanisms on the holding host get confused, because the IP address is normally
33599 used as part of the key string for holding retry information. This can be
33600 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
33601 Since this has disadvantages for permanently connected hosts, it is best to
33602 arrange a separate transport for the intermittently connected ones.
33603
33604
33605
33606 .section "Exim on the intermittently connected client host" "SECID248"
33607 The value of &%smtp_accept_queue_per_connection%& should probably be
33608 increased, or even set to zero (that is, disabled) on the intermittently
33609 connected host, so that all incoming messages down a single connection get
33610 delivered immediately.
33611
33612 .cindex "SMTP" "passed connection"
33613 .cindex "SMTP" "multiple deliveries"
33614 .cindex "multiple SMTP deliveries"
33615 Mail waiting to be sent from an intermittently connected host will probably
33616 not have been routed, because without a connection DNS lookups are not
33617 possible. This means that if a normal queue run is done at connection time,
33618 each message is likely to be sent in a separate SMTP session. This can be
33619 avoided by starting the queue run with a command line option beginning with
33620 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
33621 first pass, routing is done but no deliveries take place. The second pass is a
33622 normal queue run; since all the messages have been previously routed, those
33623 destined for the same host are likely to get sent as multiple deliveries in a
33624 single SMTP connection.
33625
33626
33627
33628 . ////////////////////////////////////////////////////////////////////////////
33629 . ////////////////////////////////////////////////////////////////////////////
33630
33631 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
33632          "Exim as a non-queueing client"
33633 .cindex "client, non-queueing"
33634 .cindex "smart host" "suppressing queueing"
33635 On a personal computer, it is a common requirement for all
33636 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
33637 configured to operate that way, for all the popular operating systems.
33638 However, there are some MUAs for Unix-like systems that cannot be so
33639 configured: they submit messages using the command line interface of
33640 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
33641 messages this way.
33642
33643 If the personal computer runs continuously, there is no problem, because it can
33644 run a conventional MTA that handles delivery to the smart host, and deal with
33645 any delays via its queueing mechanism. However, if the computer does not run
33646 continuously or runs different operating systems at different times, queueing
33647 email is not desirable.
33648
33649 There is therefore a requirement for something that can provide the
33650 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
33651 any queueing or retrying facilities. Furthermore, the delivery to the smart
33652 host should be synchronous, so that if it fails, the sending MUA is immediately
33653 informed. In other words, we want something that extends an MUA that submits
33654 to a local MTA via the command line so that it behaves like one that submits
33655 to a remote smart host using TCP/SMTP.
33656
33657 There are a number of applications (for example, there is one called &'ssmtp'&)
33658 that do this job. However, people have found them to be lacking in various
33659 ways. For instance, you might want to allow aliasing and forwarding to be done
33660 before sending a message to the smart host.
33661
33662 Exim already had the necessary infrastructure for doing this job. Just a few
33663 tweaks were needed to make it behave as required, though it is somewhat of an
33664 overkill to use a fully-featured MTA for this purpose.
33665
33666 .oindex "&%mua_wrapper%&"
33667 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
33668 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
33669 assumes that it is being used to &"wrap"& a command-line MUA in the manner
33670 just described. As well as setting &%mua_wrapper%&, you also need to provide a
33671 compatible router and transport configuration. Typically there will be just one
33672 router and one transport, sending everything to a smart host.
33673
33674 When run in MUA wrapping mode, the behaviour of Exim changes in the
33675 following ways:
33676
33677 .ilist
33678 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
33679 In other words, the only way to submit messages is via the command line.
33680 .next
33681 Each message is synchronously delivered as soon as it is received (&%-odi%& is
33682 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
33683 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
33684 does not finish until the delivery attempt is complete. If the delivery is
33685 successful, a zero return code is given.
33686 .next
33687 Address redirection is permitted, but the final routing for all addresses must
33688 be to the same remote transport, and to the same list of hosts. Furthermore,
33689 the return address (envelope sender) must be the same for all recipients, as
33690 must any added or deleted header lines. In other words, it must be possible to
33691 deliver the message in a single SMTP transaction, however many recipients there
33692 are.
33693 .next
33694 If these conditions are not met, or if routing any address results in a
33695 failure or defer status, or if Exim is unable to deliver all the recipients
33696 successfully to one of the smart hosts, delivery of the entire message fails.
33697 .next
33698 Because no queueing is allowed, all failures are treated as permanent; there
33699 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
33700 smart host. Furthermore, because only a single yes/no response can be given to
33701 the caller, it is not possible to deliver to some recipients and not others. If
33702 there is an error (temporary or permanent) for any recipient, all are failed.
33703 .next
33704 If more than one smart host is listed, Exim will try another host after a
33705 connection failure or a timeout, in the normal way. However, if this kind of
33706 failure happens for all the hosts, the delivery fails.
33707 .next
33708 When delivery fails, an error message is written to the standard error stream
33709 (as well as to Exim's log), and Exim exits to the caller with a return code
33710 value 1. The message is expunged from Exim's spool files. No bounce messages
33711 are ever generated.
33712 .next
33713 No retry data is maintained, and any retry rules are ignored.
33714 .next
33715 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
33716 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
33717 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
33718 .endlist
33719
33720 The overall effect is that Exim makes a single synchronous attempt to deliver
33721 the message, failing if there is any kind of problem. Because no local
33722 deliveries are done and no daemon can be run, Exim does not need root
33723 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
33724 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
33725 the advantages and disadvantages of running without root privilege.
33726
33727
33728
33729
33730 . ////////////////////////////////////////////////////////////////////////////
33731 . ////////////////////////////////////////////////////////////////////////////
33732
33733 .chapter "Log files" "CHAPlog"
33734 .scindex IIDloggen "log" "general description"
33735 .cindex "log" "types of"
33736 Exim writes three different logs, referred to as the main log, the reject log,
33737 and the panic log:
33738
33739 .ilist
33740 .cindex "main log"
33741 The main log records the arrival of each message and each delivery in a single
33742 line in each case. The format is as compact as possible, in an attempt to keep
33743 down the size of log files. Two-character flag sequences make it easy to pick
33744 out these lines. A number of other events are recorded in the main log. Some of
33745 them are optional, in which case the &%log_selector%& option controls whether
33746 they are included or not. A Perl script called &'eximstats'&, which does simple
33747 analysis of main log files, is provided in the Exim distribution (see section
33748 &<<SECTmailstat>>&).
33749 .next
33750 .cindex "reject log"
33751 The reject log records information from messages that are rejected as a result
33752 of a configuration option (that is, for policy reasons).
33753 The first line of each rejection is a copy of the line that is also written to
33754 the main log. Then, if the message's header has been read at the time the log
33755 is written, its contents are written to this log. Only the original header
33756 lines are available; header lines added by ACLs are not logged. You can use the
33757 reject log to check that your policy controls are working correctly; on a busy
33758 host this may be easier than scanning the main log for rejection messages. You
33759 can suppress the writing of the reject log by setting &%write_rejectlog%&
33760 false.
33761 .next
33762 .cindex "panic log"
33763 .cindex "system log"
33764 When certain serious errors occur, Exim writes entries to its panic log. If the
33765 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
33766 are usually written to the main log as well, but can get lost amid the mass of
33767 other entries. The panic log should be empty under normal circumstances. It is
33768 therefore a good idea to check it (or to have a &'cron'& script check it)
33769 regularly, in order to become aware of any problems. When Exim cannot open its
33770 panic log, it tries as a last resort to write to the system log (syslog). This
33771 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
33772 message itself is written at priority LOG_CRIT.
33773 .endlist
33774
33775 Every log line starts with a timestamp, in the format shown in the following
33776 example. Note that many of the examples shown in this chapter are line-wrapped.
33777 In the log file, this would be all on one line:
33778 .code
33779 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
33780   by QUIT
33781 .endd
33782 By default, the timestamps are in the local timezone. There are two
33783 ways of changing this:
33784
33785 .ilist
33786 You can set the &%timezone%& option to a different time zone; in particular, if
33787 you set
33788 .code
33789 timezone = UTC
33790 .endd
33791 the timestamps will be in UTC (aka GMT).
33792 .next
33793 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
33794 example:
33795 .code
33796 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
33797 .endd
33798 .endlist
33799
33800 .cindex "log" "process ids in"
33801 .cindex "pid (process id)" "in log lines"
33802 Exim does not include its process id in log lines by default, but you can
33803 request that it does so by specifying the &`pid`& log selector (see section
33804 &<<SECTlogselector>>&). When this is set, the process id is output, in square
33805 brackets, immediately after the time and date.
33806
33807
33808
33809
33810 .section "Where the logs are written" "SECTwhelogwri"
33811 .cindex "log" "destination"
33812 .cindex "log" "to file"
33813 .cindex "log" "to syslog"
33814 .cindex "syslog"
33815 The logs may be written to local files, or to syslog, or both. However, it
33816 should be noted that many syslog implementations use UDP as a transport, and
33817 are therefore unreliable in the sense that messages are not guaranteed to
33818 arrive at the loghost, nor is the ordering of messages necessarily maintained.
33819 It has also been reported that on large log files (tens of megabytes) you may
33820 need to tweak syslog to prevent it syncing the file with each write &-- on
33821 Linux this has been seen to make syslog take 90% plus of CPU time.
33822
33823 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
33824 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
33825 configuration. This latter string is expanded, so it can contain, for example,
33826 references to the host name:
33827 .code
33828 log_file_path = /var/log/$primary_hostname/exim_%slog
33829 .endd
33830 It is generally advisable, however, to set the string in &_Local/Makefile_&
33831 rather than at run time, because then the setting is available right from the
33832 start of Exim's execution. Otherwise, if there's something it wants to log
33833 before it has read the configuration file (for example, an error in the
33834 configuration file) it will not use the path you want, and may not be able to
33835 log at all.
33836
33837 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
33838 list, currently limited to at most two items. This is one option where the
33839 facility for changing a list separator may not be used. The list must always be
33840 colon-separated. If an item in the list is &"syslog"& then syslog is used;
33841 otherwise the item must either be an absolute path, containing &`%s`& at the
33842 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
33843 implying the use of a default path.
33844
33845 When Exim encounters an empty item in the list, it searches the list defined by
33846 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
33847 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
33848 mean &"use the path specified at build time"&. It no such item exists, log
33849 files are written in the &_log_& subdirectory of the spool directory. This is
33850 equivalent to the setting:
33851 .code
33852 log_file_path = $spool_directory/log/%slog
33853 .endd
33854 If you do not specify anything at build time or run time, that is where the
33855 logs are written.
33856
33857 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
33858 are in use &-- see section &<<SECTdatlogfil>>& below.
33859
33860 Here are some examples of possible settings:
33861 .display
33862 &`LOG_FILE_PATH=syslog                    `& syslog only
33863 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
33864 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
33865 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
33866 .endd
33867 If there are more than two paths in the list, the first is used and a panic
33868 error is logged.
33869
33870
33871
33872 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
33873 .cindex "log" "cycling local files"
33874 .cindex "cycling logs"
33875 .cindex "&'exicyclog'&"
33876 .cindex "log" "local files; writing to"
33877 Some operating systems provide centralized and standardized methods for cycling
33878 log files. For those that do not, a utility script called &'exicyclog'& is
33879 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
33880 main and reject logs each time it is called. The maximum number of old logs to
33881 keep can be set. It is suggested this script is run as a daily &'cron'& job.
33882
33883 An Exim delivery process opens the main log when it first needs to write to it,
33884 and it keeps the file open in case subsequent entries are required &-- for
33885 example, if a number of different deliveries are being done for the same
33886 message. However, remote SMTP deliveries can take a long time, and this means
33887 that the file may be kept open long after it is renamed if &'exicyclog'& or
33888 something similar is being used to rename log files on a regular basis. To
33889 ensure that a switch of log files is noticed as soon as possible, Exim calls
33890 &[stat()]& on the main log's name before reusing an open file, and if the file
33891 does not exist, or its inode has changed, the old file is closed and Exim
33892 tries to open the main log from scratch. Thus, an old log file may remain open
33893 for quite some time, but no Exim processes should write to it once it has been
33894 renamed.
33895
33896
33897
33898 .section "Datestamped log files" "SECTdatlogfil"
33899 .cindex "log" "datestamped files"
33900 Instead of cycling the main and reject log files by renaming them
33901 periodically, some sites like to use files whose names contain a datestamp,
33902 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
33903 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
33904 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
33905 point where the datestamp is required. For example:
33906 .code
33907 log_file_path = /var/spool/exim/log/%slog-%D
33908 log_file_path = /var/log/exim-%s-%D.log
33909 log_file_path = /var/spool/exim/log/%D-%slog
33910 log_file_path = /var/log/exim/%s.%M
33911 .endd
33912 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
33913 examples of names generated by the above examples:
33914 .code
33915 /var/spool/exim/log/mainlog-20021225
33916 /var/log/exim-reject-20021225.log
33917 /var/spool/exim/log/20021225-mainlog
33918 /var/log/exim/main.200212
33919 .endd
33920 When this form of log file is specified, Exim automatically switches to new
33921 files at midnight. It does not make any attempt to compress old logs; you
33922 will need to write your own script if you require this. You should not
33923 run &'exicyclog'& with this form of logging.
33924
33925 The location of the panic log is also determined by &%log_file_path%&, but it
33926 is not datestamped, because rotation of the panic log does not make sense.
33927 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
33928 the string. In addition, if it immediately follows a slash, a following
33929 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
33930 character is removed. Thus, the four examples above would give these panic
33931 log names:
33932 .code
33933 /var/spool/exim/log/paniclog
33934 /var/log/exim-panic.log
33935 /var/spool/exim/log/paniclog
33936 /var/log/exim/panic
33937 .endd
33938
33939
33940 .section "Logging to syslog" "SECID249"
33941 .cindex "log" "syslog; writing to"
33942 The use of syslog does not change what Exim logs or the format of its messages,
33943 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
33944 Exim's log lines are omitted when these lines are sent to syslog. Apart from
33945 that, the same strings are written to syslog as to log files. The syslog
33946 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
33947 by default, but you can change these by setting the &%syslog_facility%& and
33948 &%syslog_processname%& options, respectively. If Exim was compiled with
33949 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
33950 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
33951 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
33952 the time and host name to each line.
33953 The three log streams are mapped onto syslog priorities as follows:
33954
33955 .ilist
33956 &'mainlog'& is mapped to LOG_INFO
33957 .next
33958 &'rejectlog'& is mapped to LOG_NOTICE
33959 .next
33960 &'paniclog'& is mapped to LOG_ALERT
33961 .endlist
33962
33963 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
33964 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
33965 these are routed by syslog to the same place. You can suppress this duplication
33966 by setting &%syslog_duplication%& false.
33967
33968 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
33969 entries contain multiple lines when headers are included. To cope with both
33970 these cases, entries written to syslog are split into separate &[syslog()]&
33971 calls at each internal newline, and also after a maximum of
33972 870 data characters. (This allows for a total syslog line length of 1024, when
33973 additions such as timestamps are added.) If you are running a syslog
33974 replacement that can handle lines longer than the 1024 characters allowed by
33975 RFC 3164, you should set
33976 .code
33977 SYSLOG_LONG_LINES=yes
33978 .endd
33979 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
33980 lines, but it still splits at internal newlines in &'reject'& log entries.
33981
33982 To make it easy to re-assemble split lines later, each component of a split
33983 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
33984 where <&'n'&> is the component number and <&'m'&> is the total number of
33985 components in the entry. The / delimiter is used when the line was split
33986 because it was too long; if it was split because of an internal newline, the \
33987 delimiter is used. For example, supposing the length limit to be 50 instead of
33988 870, the following would be the result of a typical rejection message to
33989 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
33990 name, and pid as added by syslog:
33991 .code
33992 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
33993 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
33994 [3/5]  when scanning for sender: missing or malformed lo
33995 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
33996 [5/5] mple>)
33997 .endd
33998 The same error might cause the following lines to be written to &"rejectlog"&
33999 (LOG_NOTICE):
34000 .code
34001 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34002 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34003 [3/18] er when scanning for sender: missing or malformed
34004 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34005 [5\18] .example>)
34006 [6\18] Recipients: ph10@some.domain.cam.example
34007 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34008 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34009 [9\18]        id 16RdAL-0006pc-00
34010 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34011 [11\18] 09:43 +0100
34012 [12\18] F From: <>
34013 [13\18]   Subject: this is a test header
34014 [18\18]   X-something: this is another header
34015 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34016 [16\18] le>
34017 [17\18] B Bcc:
34018 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34019 .endd
34020 Log lines that are neither too long nor contain newlines are written to syslog
34021 without modification.
34022
34023 If only syslog is being used, the Exim monitor is unable to provide a log tail
34024 display, unless syslog is routing &'mainlog'& to a file on the local host and
34025 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34026 where it is.
34027
34028
34029
34030 .section "Log line flags" "SECID250"
34031 One line is written to the main log for each message received, and for each
34032 successful, unsuccessful, and delayed delivery. These lines can readily be
34033 picked out by the distinctive two-character flags that immediately follow the
34034 timestamp. The flags are:
34035 .display
34036 &`<=`&     message arrival
34037 &`=>`&     normal message delivery
34038 &`->`&     additional address in same delivery
34039 &`>>`&     cutthrough message delivery
34040 &`*>`&     delivery suppressed by &%-N%&
34041 &`**`&     delivery failed; address bounced
34042 &`==`&     delivery deferred; temporary problem
34043 .endd
34044
34045
34046 .section "Logging message reception" "SECID251"
34047 .cindex "log" "reception line"
34048 The format of the single-line entry in the main log that is written for every
34049 message received is shown in the basic example below, which is split over
34050 several lines in order to fit it on the page:
34051 .code
34052 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34053   H=mailer.fict.example [192.168.123.123] U=exim
34054   P=smtp S=5678 id=<incoming message id>
34055 .endd
34056 The address immediately following &"<="& is the envelope sender address. A
34057 bounce message is shown with the sender address &"<>"&, and if it is locally
34058 generated, this is followed by an item of the form
34059 .code
34060 R=<message id>
34061 .endd
34062 which is a reference to the message that caused the bounce to be sent.
34063
34064 .cindex "HELO"
34065 .cindex "EHLO"
34066 For messages from other hosts, the H and U fields identify the remote host and
34067 record the RFC 1413 identity of the user that sent the message, if one was
34068 received. The number given in square brackets is the IP address of the sending
34069 host. If there is a single, unparenthesized  host name in the H field, as
34070 above, it has been verified to correspond to the IP address (see the
34071 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34072 by the remote host in the SMTP HELO or EHLO command, and has not been
34073 verified. If verification yields a different name to that given for HELO or
34074 EHLO, the verified name appears first, followed by the HELO or EHLO
34075 name in parentheses.
34076
34077 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34078 without brackets, in the HELO or EHLO command, leading to entries in
34079 the log containing text like these examples:
34080 .code
34081 H=(10.21.32.43) [192.168.8.34]
34082 H=([10.21.32.43]) [192.168.8.34]
34083 .endd
34084 This can be confusing. Only the final address in square brackets can be relied
34085 on.
34086
34087 For locally generated messages (that is, messages not received over TCP/IP),
34088 the H field is omitted, and the U field contains the login name of the caller
34089 of Exim.
34090
34091 .cindex "authentication" "logging"
34092 .cindex "AUTH" "logging"
34093 For all messages, the P field specifies the protocol used to receive the
34094 message. This is the value that is stored in &$received_protocol$&. In the case
34095 of incoming SMTP messages, the value indicates whether or not any SMTP
34096 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34097 session was encrypted, there is an additional X field that records the cipher
34098 suite that was used.
34099
34100 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34101 hosts that have authenticated themselves using the SMTP AUTH command. The first
34102 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34103 there is an additional item A= followed by the name of the authenticator that
34104 was used. If an authenticated identification was set up by the authenticator's
34105 &%server_set_id%& option, this is logged too, separated by a colon from the
34106 authenticator name.
34107
34108 .cindex "size" "of message"
34109 The id field records the existing message id, if present. The size of the
34110 received message is given by the S field. When the message is delivered,
34111 headers may be removed or added, so that the size of delivered copies of the
34112 message may not correspond with this value (and indeed may be different to each
34113 other).
34114
34115 The &%log_selector%& option can be used to request the logging of additional
34116 data when a message is received. See section &<<SECTlogselector>>& below.
34117
34118
34119
34120 .section "Logging deliveries" "SECID252"
34121 .cindex "log" "delivery line"
34122 The format of the single-line entry in the main log that is written for every
34123 delivery is shown in one of the examples below, for local and remote
34124 deliveries, respectively. Each example has been split into two lines in order
34125 to fit it on the page:
34126 .code
34127 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34128   <marv@hitch.fict.example> R=localuser T=local_delivery
34129 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34130   monk@holistic.fict.example R=dnslookup T=remote_smtp
34131   H=holistic.fict.example [192.168.234.234]
34132 .endd
34133 For ordinary local deliveries, the original address is given in angle brackets
34134 after the final delivery address, which might be a pipe or a file. If
34135 intermediate address(es) exist between the original and the final address, the
34136 last of these is given in parentheses after the final address. The R and T
34137 fields record the router and transport that were used to process the address.
34138
34139 If SMTP AUTH was used for the delivery there is an additional item A=
34140 followed by the name of the authenticator that was used.
34141 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34142 option, this is logged too, separated by a colon from the authenticator name.
34143
34144 If a shadow transport was run after a successful local delivery, the log line
34145 for the successful delivery has an item added on the end, of the form
34146 .display
34147 &`ST=<`&&'shadow transport name'&&`>`&
34148 .endd
34149 If the shadow transport did not succeed, the error message is put in
34150 parentheses afterwards.
34151
34152 .cindex "asterisk" "after IP address"
34153 When more than one address is included in a single delivery (for example, two
34154 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34155 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34156 down a single SMTP connection, an asterisk follows the IP address in the log
34157 lines for the second and subsequent messages.
34158
34159 .cindex "delivery" "cutthrough; logging"
34160 .cindex "cutthrough" "logging"
34161 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34162 line precedes the reception line, since cutthrough waits for a possible
34163 rejection from the destination in case it can reject the sourced item.
34164
34165 The generation of a reply message by a filter file gets logged as a
34166 &"delivery"& to the addressee, preceded by &">"&.
34167
34168 The &%log_selector%& option can be used to request the logging of additional
34169 data when a message is delivered. See section &<<SECTlogselector>>& below.
34170
34171
34172 .section "Discarded deliveries" "SECID253"
34173 .cindex "discarded messages"
34174 .cindex "message" "discarded"
34175 .cindex "delivery" "discarded; logging"
34176 When a message is discarded as a result of the command &"seen finish"& being
34177 obeyed in a filter file which generates no deliveries, a log entry of the form
34178 .code
34179 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34180   <low.club@bridge.example> R=userforward
34181 .endd
34182 is written, to record why no deliveries are logged. When a message is discarded
34183 because it is aliased to &":blackhole:"& the log line is like this:
34184 .code
34185 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34186   <hole@nowhere.example> R=blackhole_router
34187 .endd
34188
34189
34190 .section "Deferred deliveries" "SECID254"
34191 When a delivery is deferred, a line of the following form is logged:
34192 .code
34193 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34194   R=dnslookup T=smtp defer (146): Connection refused
34195 .endd
34196 In the case of remote deliveries, the error is the one that was given for the
34197 last IP address that was tried. Details of individual SMTP failures are also
34198 written to the log, so the above line would be preceded by something like
34199 .code
34200 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34201   mail1.endrest.example [192.168.239.239]: Connection refused
34202 .endd
34203 When a deferred address is skipped because its retry time has not been reached,
34204 a message is written to the log, but this can be suppressed by setting an
34205 appropriate value in &%log_selector%&.
34206
34207
34208
34209 .section "Delivery failures" "SECID255"
34210 .cindex "delivery" "failure; logging"
34211 If a delivery fails because an address cannot be routed, a line of the
34212 following form is logged:
34213 .code
34214 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34215   <jim@trek99.example>: unknown mail domain
34216 .endd
34217 If a delivery fails at transport time, the router and transport are shown, and
34218 the response from the remote host is included, as in this example:
34219 .code
34220 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34221   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34222   after pipelined RCPT TO:<ace400@pb.example>: host
34223   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34224   <ace400@pb.example>...Addressee unknown
34225 .endd
34226 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34227 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34228 disabling PIPELINING. The log lines for all forms of delivery failure are
34229 flagged with &`**`&.
34230
34231
34232
34233 .section "Fake deliveries" "SECID256"
34234 .cindex "delivery" "fake; logging"
34235 If a delivery does not actually take place because the &%-N%& option has been
34236 used to suppress it, a normal delivery line is written to the log, except that
34237 &"=>"& is replaced by &"*>"&.
34238
34239
34240
34241 .section "Completion" "SECID257"
34242 A line of the form
34243 .code
34244 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34245 .endd
34246 is written to the main log when a message is about to be removed from the spool
34247 at the end of its processing.
34248
34249
34250
34251
34252 .section "Summary of Fields in Log Lines" "SECID258"
34253 .cindex "log" "summary of fields"
34254 A summary of the field identifiers that are used in log lines is shown in
34255 the following table:
34256 .display
34257 &`A   `&        authenticator name (and optional id and sender)
34258 &`C   `&        SMTP confirmation on delivery
34259 &`    `&        command list for &"no mail in SMTP session"&
34260 &`CV  `&        certificate verification status
34261 &`D   `&        duration of &"no mail in SMTP session"&
34262 &`DN  `&        distinguished name from peer certificate
34263 &`DT  `&        on &`=>`& lines: time taken for a delivery
34264 &`F   `&        sender address (on delivery lines)
34265 &`H   `&        host name and IP address
34266 &`I   `&        local interface used
34267 &`id  `&        message id for incoming message
34268 &`P   `&        on &`<=`& lines: protocol used
34269 &`    `&        on &`=>`& and &`**`& lines: return path
34270 &`QT  `&        on &`=>`& lines: time spent on queue so far
34271 &`    `&        on &"Completed"& lines: time spent on queue
34272 &`R   `&        on &`<=`& lines: reference for local bounce
34273 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34274 &`S   `&        size of message
34275 &`SNI `&        server name indication from TLS client hello
34276 &`ST  `&        shadow transport name
34277 &`T   `&        on &`<=`& lines: message subject (topic)
34278 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34279 &`U   `&        local user or RFC 1413 identity
34280 &`X   `&        TLS cipher suite
34281 .endd
34282
34283
34284 .section "Other log entries" "SECID259"
34285 Various other types of log entry are written from time to time. Most should be
34286 self-explanatory. Among the more common are:
34287
34288 .ilist
34289 .cindex "retry" "time not reached"
34290 &'retry time not reached'&&~&~An address previously suffered a temporary error
34291 during routing or local delivery, and the time to retry has not yet arrived.
34292 This message is not written to an individual message log file unless it happens
34293 during the first delivery attempt.
34294 .next
34295 &'retry time not reached for any host'&&~&~An address previously suffered
34296 temporary errors during remote delivery, and the retry time has not yet arrived
34297 for any of the hosts to which it is routed.
34298 .next
34299 .cindex "spool directory" "file locked"
34300 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34301 some other Exim process is already working on the message. This can be quite
34302 common if queue running processes are started at frequent intervals. The
34303 &'exiwhat'& utility script can be used to find out what Exim processes are
34304 doing.
34305 .next
34306 .cindex "error" "ignored"
34307 &'error ignored'&&~&~There are several circumstances that give rise to this
34308 message:
34309 .olist
34310 Exim failed to deliver a bounce message whose age was greater than
34311 &%ignore_bounce_errors_after%&. The bounce was discarded.
34312 .next
34313 A filter file set up a delivery using the &"noerror"& option, and the delivery
34314 failed. The delivery was discarded.
34315 .next
34316 A delivery set up by a router configured with
34317 . ==== As this is a nested list, any displays it contains must be indented
34318 . ==== as otherwise they are too far to the left.
34319 .code
34320     errors_to = <>
34321 .endd
34322 failed. The delivery was discarded.
34323 .endlist olist
34324 .endlist ilist
34325
34326
34327
34328
34329
34330 .section "Reducing or increasing what is logged" "SECTlogselector"
34331 .cindex "log" "selectors"
34332 By setting the &%log_selector%& global option, you can disable some of Exim's
34333 default logging, or you can request additional logging. The value of
34334 &%log_selector%& is made up of names preceded by plus or minus characters. For
34335 example:
34336 .code
34337 log_selector = +arguments -retry_defer
34338 .endd
34339 The list of optional log items is in the following table, with the default
34340 selection marked by asterisks:
34341 .display
34342 &` 8bitmime                   `&  received 8BITMIME status
34343 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34344 &` address_rewrite            `&  address rewriting
34345 &` all_parents                `&  all parents in => lines
34346 &` arguments                  `&  command line arguments
34347 &`*connection_reject          `&  connection rejections
34348 &`*delay_delivery             `&  immediate delivery delayed
34349 &` deliver_time               `&  time taken to perform delivery
34350 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34351 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34352 &`*etrn                       `&  ETRN commands
34353 &`*host_lookup_failed         `&  as it says
34354 &` ident_timeout              `&  timeout for ident connection
34355 &` incoming_interface         `&  incoming interface on <= lines
34356 &` incoming_port              `&  incoming port on <= lines
34357 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34358 &` outgoing_port              `&  add remote port to => lines
34359 &`*queue_run                  `&  start and end queue runs
34360 &` queue_time                 `&  time on queue for one recipient
34361 &` queue_time_overall         `&  time on queue for whole message
34362 &` pid                        `&  Exim process id
34363 &` received_recipients        `&  recipients on <= lines
34364 &` received_sender            `&  sender on <= lines
34365 &`*rejected_header            `&  header contents on reject log
34366 &`*retry_defer                `&  &"retry time not reached"&
34367 &` return_path_on_delivery    `&  put return path on => and ** lines
34368 &` sender_on_delivery         `&  add sender to => lines
34369 &`*sender_verify_fail         `&  sender verification failures
34370 &`*size_reject                `&  rejection because too big
34371 &`*skip_delivery              `&  delivery skipped in a queue run
34372 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34373 &` smtp_connection            `&  SMTP connections
34374 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34375 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34376 &` smtp_no_mail               `&  session with no MAIL commands
34377 &` smtp_protocol_error        `&  SMTP protocol errors
34378 &` smtp_syntax_error          `&  SMTP syntax errors
34379 &` subject                    `&  contents of &'Subject:'& on <= lines
34380 &` tls_certificate_verified   `&  certificate verification status
34381 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34382 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34383 &` tls_sni                    `&  TLS SNI on <= lines
34384 &` unknown_in_list            `&  DNS lookup failed in list match
34385
34386 &` all                        `&  all of the above
34387 .endd
34388 More details on each of these items follows:
34389
34390 .ilist
34391 .cindex "8BITMIME"
34392 .cindex "log" "8BITMIME"
34393 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34394 which may help in tracking down interoperability issues with ancient MTAs
34395 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34396 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34397 &`7BIT`& and &`8BITMIME`& respectively.
34398 .next
34399 .cindex "&%warn%& ACL verb" "log when skipping"
34400 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34401 its conditions cannot be evaluated, a log line to this effect is written if
34402 this log selector is set.
34403 .next
34404 .cindex "log" "rewriting"
34405 .cindex "rewriting" "logging"
34406 &%address_rewrite%&: This applies both to global rewrites and per-transport
34407 rewrites, but not to rewrites in filters run as an unprivileged user (because
34408 such users cannot access the log).
34409 .next
34410 .cindex "log" "full parentage"
34411 &%all_parents%&: Normally only the original and final addresses are logged on
34412 delivery lines; with this selector, intermediate parents are given in
34413 parentheses between them.
34414 .next
34415 .cindex "log" "Exim arguments"
34416 .cindex "Exim arguments, logging"
34417 &%arguments%&: This causes Exim to write the arguments with which it was called
34418 to the main log, preceded by the current working directory. This is a debugging
34419 feature, added to make it easier to find out how certain MUAs call
34420 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34421 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34422 that are empty or that contain white space are quoted. Non-printing characters
34423 are shown as escape sequences. This facility cannot log unrecognized arguments,
34424 because the arguments are checked before the configuration file is read. The
34425 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34426 between the caller and Exim.
34427 .next
34428 .cindex "log" "connection rejections"
34429 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34430 connection is rejected, for whatever reason.
34431 .next
34432 .cindex "log" "delayed delivery"
34433 .cindex "delayed delivery, logging"
34434 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34435 started for an incoming message because the load is too high or too many
34436 messages were received on one connection. Logging does not occur if no delivery
34437 process is started because &%queue_only%& is set or &%-odq%& was used.
34438 .next
34439 .cindex "log" "delivery duration"
34440 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34441 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34442 .next
34443 .cindex "log" "message size on delivery"
34444 .cindex "size" "of message"
34445 &%delivery_size%&: For each delivery, the size of message delivered is added to
34446 the &"=>"& line, tagged with S=.
34447 .next
34448 .cindex "log" "dnslist defer"
34449 .cindex "DNS list" "logging defer"
34450 .cindex "black list (DNS)"
34451 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34452 DNS black list suffers a temporary error.
34453 .next
34454 .cindex "log" "ETRN commands"
34455 .cindex "ETRN" "logging"
34456 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34457 is run to determine whether or not it is actually accepted. An invalid ETRN
34458 command, or one received within a message transaction is not logged by this
34459 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
34460 .next
34461 .cindex "log" "host lookup failure"
34462 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
34463 any addresses, or when a lookup of an IP address fails to find a host name, a
34464 log line is written. This logging does not apply to direct DNS lookups when
34465 routing email addresses, but it does apply to &"byname"& lookups.
34466 .next
34467 .cindex "log" "ident timeout"
34468 .cindex "RFC 1413" "logging timeout"
34469 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
34470 client's ident port times out.
34471 .next
34472 .cindex "log" "incoming interface"
34473 .cindex "interface" "logging"
34474 &%incoming_interface%&: The interface on which a message was received is added
34475 to the &"<="& line as an IP address in square brackets, tagged by I= and
34476 followed by a colon and the port number. The local interface and port are also
34477 added to other SMTP log lines, for example &"SMTP connection from"&, and to
34478 rejection lines.
34479 .next
34480 .cindex "log" "incoming remote port"
34481 .cindex "port" "logging remote"
34482 .cindex "TCP/IP" "logging incoming remote port"
34483 .vindex "&$sender_fullhost$&"
34484 .vindex "&$sender_rcvhost$&"
34485 &%incoming_port%&: The remote port number from which a message was received is
34486 added to log entries and &'Received:'& header lines, following the IP address
34487 in square brackets, and separated from it by a colon. This is implemented by
34488 changing the value that is put in the &$sender_fullhost$& and
34489 &$sender_rcvhost$& variables. Recording the remote port number has become more
34490 important with the widening use of NAT (see RFC 2505).
34491 .next
34492 .cindex "log" "dropped connection"
34493 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
34494 connection is unexpectedly dropped.
34495 .next
34496 .cindex "log" "outgoing remote port"
34497 .cindex "port" "logging outgoint remote"
34498 .cindex "TCP/IP" "logging ougtoing remote port"
34499 &%outgoing_port%&: The remote port number is added to delivery log lines (those
34500 containing => tags) following the IP address. This option is not included in
34501 the default setting, because for most ordinary configurations, the remote port
34502 number is always 25 (the SMTP port).
34503 .next
34504 .cindex "log" "process ids in"
34505 .cindex "pid (process id)" "in log lines"
34506 &%pid%&: The current process id is added to every log line, in square brackets,
34507 immediately after the time and date.
34508 .next
34509 .cindex "log" "queue run"
34510 .cindex "queue runner" "logging"
34511 &%queue_run%&: The start and end of every queue run are logged.
34512 .next
34513 .cindex "log" "queue time"
34514 &%queue_time%&: The amount of time the message has been in the queue on the
34515 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
34516 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
34517 includes reception time as well as the delivery time for the current address.
34518 This means that it may be longer than the difference between the arrival and
34519 delivery log line times, because the arrival log line is not written until the
34520 message has been successfully received.
34521 .next
34522 &%queue_time_overall%&: The amount of time the message has been in the queue on
34523 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
34524 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
34525 message, so it includes reception time as well as the total delivery time.
34526 .next
34527 .cindex "log" "recipients"
34528 &%received_recipients%&: The recipients of a message are listed in the main log
34529 as soon as the message is received. The list appears at the end of the log line
34530 that is written when a message is received, preceded by the word &"for"&. The
34531 addresses are listed after they have been qualified, but before any rewriting
34532 has taken place.
34533 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
34534 in the list.
34535 .next
34536 .cindex "log" "sender reception"
34537 &%received_sender%&: The unrewritten original sender of a message is added to
34538 the end of the log line that records the message's arrival, after the word
34539 &"from"& (before the recipients if &%received_recipients%& is also set).
34540 .next
34541 .cindex "log" "header lines for rejection"
34542 &%rejected_header%&: If a message's header has been received at the time a
34543 rejection is written to the reject log, the complete header is added to the
34544 log. Header logging can be turned off individually for messages that are
34545 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
34546 .next
34547 .cindex "log" "retry defer"
34548 &%retry_defer%&: A log line is written if a delivery is deferred because a
34549 retry time has not yet been reached. However, this &"retry time not reached"&
34550 message is always omitted from individual message logs after the first delivery
34551 attempt.
34552 .next
34553 .cindex "log" "return path"
34554 &%return_path_on_delivery%&: The return path that is being transmitted with
34555 the message is included in delivery and bounce lines, using the tag P=.
34556 This is omitted if no delivery actually happens, for example, if routing fails,
34557 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
34558 .next
34559 .cindex "log" "sender on delivery"
34560 &%sender_on_delivery%&: The message's sender address is added to every delivery
34561 and bounce line, tagged by F= (for &"from"&).
34562 This is the original sender that was received with the message; it is not
34563 necessarily the same as the outgoing return path.
34564 .next
34565 .cindex "log" "sender verify failure"
34566 &%sender_verify_fail%&: If this selector is unset, the separate log line that
34567 gives details of a sender verification failure is not written. Log lines for
34568 the rejection of SMTP commands contain just &"sender verify failed"&, so some
34569 detail is lost.
34570 .next
34571 .cindex "log" "size rejection"
34572 &%size_reject%&: A log line is written whenever a message is rejected because
34573 it is too big.
34574 .next
34575 .cindex "log" "frozen messages; skipped"
34576 .cindex "frozen messages" "logging skipping"
34577 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34578 queue run because it is frozen or because another process is already delivering
34579 it.
34580 .cindex "&""spool file is locked""&"
34581 The message that is written is &"spool file is locked"&.
34582 .next
34583 .cindex "log" "smtp confirmation"
34584 .cindex "SMTP" "logging confirmation"
34585 .cindex "LMTP" "logging confirmation"
34586 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
34587 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34588 A number of MTAs (including Exim) return an identifying string in this
34589 response.
34590 .next
34591 .cindex "log" "SMTP connections"
34592 .cindex "SMTP" "logging connections"
34593 &%smtp_connection%&: A log line is written whenever an SMTP connection is
34594 established or closed, unless the connection is from a host that matches
34595 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
34596 only when the closure is unexpected.) This applies to connections from local
34597 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
34598 dropped in the middle of a message, a log line is always written, whether or
34599 not this selector is set, but otherwise nothing is written at the start and end
34600 of connections unless this selector is enabled.
34601
34602 For TCP/IP connections to an Exim daemon, the current number of connections is
34603 included in the log message for each new connection, but note that the count is
34604 reset if the daemon is restarted.
34605 Also, because connections are closed (and the closure is logged) in
34606 subprocesses, the count may not include connections that have been closed but
34607 whose termination the daemon has not yet noticed. Thus, while it is possible to
34608 match up the opening and closing of connections in the log, the value of the
34609 logged counts may not be entirely accurate.
34610 .next
34611 .cindex "log" "SMTP transaction; incomplete"
34612 .cindex "SMTP" "logging incomplete transactions"
34613 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
34614 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
34615 and the message sender plus any accepted recipients are included in the log
34616 line. This can provide evidence of dictionary attacks.
34617 .next
34618 .cindex "log" "non-MAIL SMTP sessions"
34619 .cindex "MAIL" "logging session without"
34620 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
34621 connection terminates without having issued a MAIL command. This includes both
34622 the case when the connection is dropped, and the case when QUIT is used. It
34623 does not include cases where the connection is rejected right at the start (by
34624 an ACL, or because there are too many connections, or whatever). These cases
34625 already have their own log lines.
34626
34627 The log line that is written contains the identity of the client in the usual
34628 way, followed by D= and a time, which records the duration of the connection.
34629 If the connection was authenticated, this fact is logged exactly as it is for
34630 an incoming message, with an A= item. If the connection was encrypted, CV=,
34631 DN=, and X= items may appear as they do for an incoming message, controlled by
34632 the same logging options.
34633
34634 Finally, if any SMTP commands were issued during the connection, a C= item
34635 is added to the line, listing the commands that were used. For example,
34636 .code
34637 C=EHLO,QUIT
34638 .endd
34639 shows that the client issued QUIT straight after EHLO. If there were fewer
34640 than 20 commands, they are all listed. If there were more than 20 commands,
34641 the last 20 are listed, preceded by &"..."&. However, with the default
34642 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
34643 have been aborted before 20 non-mail commands are processed.
34644 .next
34645 &%smtp_mailauth%&: A third subfield with the authenticated sender,
34646 colon-separated, is appended to the A= item for a message arrival or delivery
34647 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
34648 was accepted or used.
34649 .next
34650 .cindex "log" "SMTP protocol error"
34651 .cindex "SMTP" "logging protocol error"
34652 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
34653 encountered. Exim does not have perfect detection of all protocol errors
34654 because of transmission delays and the use of pipelining. If PIPELINING has
34655 been advertised to a client, an Exim server assumes that the client will use
34656 it, and therefore it does not count &"expected"& errors (for example, RCPT
34657 received after rejecting MAIL) as protocol errors.
34658 .next
34659 .cindex "SMTP" "logging syntax errors"
34660 .cindex "SMTP" "syntax errors; logging"
34661 .cindex "SMTP" "unknown command; logging"
34662 .cindex "log" "unknown SMTP command"
34663 .cindex "log" "SMTP syntax error"
34664 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
34665 encountered. An unrecognized command is treated as a syntax error. For an
34666 external connection, the host identity is given; for an internal connection
34667 using &%-bs%& the sender identification (normally the calling user) is given.
34668 .next
34669 .cindex "log" "subject"
34670 .cindex "subject, logging"
34671 &%subject%&: The subject of the message is added to the arrival log line,
34672 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
34673 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
34674 specifies whether characters with values greater than 127 should be logged
34675 unchanged, or whether they should be rendered as escape sequences.
34676 .next
34677 .cindex "log" "certificate verification"
34678 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
34679 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
34680 verified, and &`CV=no`& if not.
34681 .next
34682 .cindex "log" "TLS cipher"
34683 .cindex "TLS" "logging cipher"
34684 &%tls_cipher%&: When a message is sent or received over an encrypted
34685 connection, the cipher suite used is added to the log line, preceded by X=.
34686 .next
34687 .cindex "log" "TLS peer DN"
34688 .cindex "TLS" "logging peer DN"
34689 &%tls_peerdn%&: When a message is sent or received over an encrypted
34690 connection, and a certificate is supplied by the remote host, the peer DN is
34691 added to the log line, preceded by DN=.
34692 .next
34693 .cindex "log" "TLS SNI"
34694 .cindex "TLS" "logging SNI"
34695 &%tls_sni%&: When a message is received over an encrypted connection, and
34696 the remote host provided the Server Name Indication extension, the SNI is
34697 added to the log line, preceded by SNI=.
34698 .next
34699 .cindex "log" "DNS failure in list"
34700 &%unknown_in_list%&: This setting causes a log entry to be written when the
34701 result of a list match is failure because a DNS lookup failed.
34702 .endlist
34703
34704
34705 .section "Message log" "SECID260"
34706 .cindex "message" "log file for"
34707 .cindex "log" "message log; description of"
34708 .cindex "&_msglog_& directory"
34709 .oindex "&%preserve_message_logs%&"
34710 In addition to the general log files, Exim writes a log file for each message
34711 that it handles. The names of these per-message logs are the message ids, and
34712 they are kept in the &_msglog_& sub-directory of the spool directory. Each
34713 message log contains copies of the log lines that apply to the message. This
34714 makes it easier to inspect the status of an individual message without having
34715 to search the main log. A message log is deleted when processing of the message
34716 is complete, unless &%preserve_message_logs%& is set, but this should be used
34717 only with great care because they can fill up your disk very quickly.
34718
34719 On a heavily loaded system, it may be desirable to disable the use of
34720 per-message logs, in order to reduce disk I/O. This can be done by setting the
34721 &%message_logs%& option false.
34722 .ecindex IIDloggen
34723
34724
34725
34726
34727 . ////////////////////////////////////////////////////////////////////////////
34728 . ////////////////////////////////////////////////////////////////////////////
34729
34730 .chapter "Exim utilities" "CHAPutils"
34731 .scindex IIDutils "utilities"
34732 A number of utility scripts and programs are supplied with Exim and are
34733 described in this chapter. There is also the Exim Monitor, which is covered in
34734 the next chapter. The utilities described here are:
34735
34736 .itable none 0 0 3  7* left  15* left  40* left
34737 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
34738   "list what Exim processes are doing"
34739 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
34740 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
34741 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
34742 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
34743                                                 various criteria"
34744 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
34745 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
34746   "extract statistics from the log"
34747 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
34748   "check address acceptance from given IP"
34749 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
34750 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
34751 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
34752 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
34753 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
34754 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
34755 .endtable
34756
34757 Another utility that might be of use to sites with many MTAs is Tom Kistner's
34758 &'exilog'&. It provides log visualizations across multiple Exim servers. See
34759 &url(http://duncanthrax.net/exilog/) for details.
34760
34761
34762
34763
34764 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
34765 .cindex "&'exiwhat'&"
34766 .cindex "process, querying"
34767 .cindex "SIGUSR1"
34768 On operating systems that can restart a system call after receiving a signal
34769 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
34770 a line describing what it is doing to the file &_exim-process.info_& in the
34771 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
34772 processes it can find, having first emptied the file. It then waits for one
34773 second to allow the Exim processes to react before displaying the results. In
34774 order to run &'exiwhat'& successfully you have to have sufficient privilege to
34775 send the signal to the Exim processes, so it is normally run as root.
34776
34777 &*Warning*&: This is not an efficient process. It is intended for occasional
34778 use by system administrators. It is not sensible, for example, to set up a
34779 script that sends SIGUSR1 signals to Exim processes at short intervals.
34780
34781
34782 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
34783 varies in different operating systems. Not only are different options used,
34784 but the format of the output is different. For this reason, there are some
34785 system configuration options that configure exactly how &'exiwhat'& works. If
34786 it doesn't seem to be working for you, check the following compile-time
34787 options:
34788 .display
34789 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
34790 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
34791 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
34792 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
34793 .endd
34794 An example of typical output from &'exiwhat'& is
34795 .code
34796 164 daemon: -q1h, listening on port 25
34797 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
34798 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
34799   [10.19.42.42] (editor@ref.example)
34800 10592 handling incoming call from [192.168.243.242]
34801 10628 accepting a local non-SMTP message
34802 .endd
34803 The first number in the output line is the process number. The third line has
34804 been split here, in order to fit it on the page.
34805
34806
34807
34808 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
34809 .cindex "&'exiqgrep'&"
34810 .cindex "queue" "grepping"
34811 This utility is a Perl script contributed by Matt Hubbard. It runs
34812 .code
34813 exim -bpu
34814 .endd
34815 or (in case &*-a*& switch is specified)
34816 .code
34817 exim -bp
34818 .endd
34819 .new
34820 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
34821 contain alternate exim configuration the queue management might be using.
34822 .wen
34823
34824 to obtain a queue listing, and then greps the output to select messages 
34825 that match given criteria. The following selection options are available:
34826
34827 .vlist
34828 .vitem &*-f*&&~<&'regex'&>
34829 Match the sender address using a case-insensitive search. The field that is
34830 tested is enclosed in angle brackets, so you can test for bounce messages with
34831 .code
34832 exiqgrep -f '^<>$'
34833 .endd
34834 .vitem &*-r*&&~<&'regex'&>
34835 Match a recipient address using a case-insensitve search. The field that is
34836 tested is not enclosed in angle brackets.
34837
34838 .vitem &*-s*&&~<&'regex'&>
34839 Match against the size field.
34840
34841 .vitem &*-y*&&~<&'seconds'&>
34842 Match messages that are younger than the given time.
34843
34844 .vitem &*-o*&&~<&'seconds'&>
34845 Match messages that are older than the given time.
34846
34847 .vitem &*-z*&
34848 Match only frozen messages.
34849
34850 .vitem &*-x*&
34851 Match only non-frozen messages.
34852 .endlist
34853
34854 The following options control the format of the output:
34855
34856 .vlist
34857 .vitem &*-c*&
34858 Display only the count of matching messages.
34859
34860 .vitem &*-l*&
34861 Long format &-- display the full message information as output by Exim. This is
34862 the default.
34863
34864 .vitem &*-i*&
34865 Display message ids only.
34866
34867 .vitem &*-b*&
34868 Brief format &-- one line per message.
34869
34870 .vitem &*-R*&
34871 Display messages in reverse order.
34872
34873 .vitem &*-a*&
34874 Include delivered recipients in queue listing.
34875 .endlist
34876
34877 There is one more option, &%-h%&, which outputs a list of options.
34878
34879
34880
34881 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
34882 .cindex "&'exiqsumm'&"
34883 .cindex "queue" "summary"
34884 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
34885 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
34886 running a command such as
34887 .code
34888 exim -bp | exiqsumm
34889 .endd
34890 The output consists of one line for each domain that has messages waiting for
34891 it, as in the following example:
34892 .code
34893 3   2322   74m   66m  msn.com.example
34894 .endd
34895 Each line lists the number of pending deliveries for a domain, their total
34896 volume, and the length of time that the oldest and the newest messages have
34897 been waiting. Note that the number of pending deliveries is greater than the
34898 number of messages when messages have more than one recipient.
34899
34900 A summary line is output at the end. By default the output is sorted on the
34901 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
34902 the output to be sorted by oldest message and by count of messages,
34903 respectively. There are also three options that split the messages for each
34904 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
34905 separates frozen messages, and &%-s%& separates messages according to their
34906 sender.
34907
34908 The output of &'exim -bp'& contains the original addresses in the message, so
34909 this also applies to the output from &'exiqsumm'&. No domains from addresses
34910 generated by aliasing or forwarding are included (unless the &%one_time%&
34911 option of the &(redirect)& router has been used to convert them into &"top
34912 level"& addresses).
34913
34914
34915
34916
34917 .section "Extracting specific information from the log (exigrep)" &&&
34918          "SECTextspeinf"
34919 .cindex "&'exigrep'&"
34920 .cindex "log" "extracts; grepping for"
34921 The &'exigrep'& utility is a Perl script that searches one or more main log
34922 files for entries that match a given pattern. When it finds a match, it
34923 extracts all the log entries for the relevant message, not just those that
34924 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
34925 given message, or all mail for a given user, or for a given host, for example.
34926 The input files can be in Exim log format or syslog format.
34927 If a matching log line is not associated with a specific message, it is
34928 included in &'exigrep'&'s output without any additional lines. The usage is:
34929 .display
34930 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
34931 .endd
34932 If no log file names are given on the command line, the standard input is read.
34933
34934 The &%-t%& argument specifies a number of seconds. It adds an additional
34935 condition for message selection. Messages that are complete are shown only if
34936 they spent more than <&'n'&> seconds on the queue.
34937
34938 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
34939 makes it case-sensitive. This may give a performance improvement when searching
34940 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
34941 option; with &%-I%& they do not. In both cases it is possible to change the
34942 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
34943
34944 The &%-l%& option means &"literal"&, that is, treat all characters in the
34945 pattern as standing for themselves. Otherwise the pattern must be a Perl
34946 regular expression.
34947
34948 The &%-v%& option inverts the matching condition. That is, a line is selected
34949 if it does &'not'& match the pattern.
34950
34951 If the location of a &'zcat'& command is known from the definition of
34952 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
34953 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
34954
34955
34956 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
34957 .cindex "&'exipick'&"
34958 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
34959 lists messages from the queue according to a variety of criteria. For details
34960 of &'exipick'&'s facilities, visit the web page at
34961 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
34962 the &%--help%& option.
34963
34964
34965 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
34966 .cindex "log" "cycling local files"
34967 .cindex "cycling logs"
34968 .cindex "&'exicyclog'&"
34969 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
34970 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
34971 you are using log files with datestamps in their names (see section
34972 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
34973 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
34974 There are two command line options for &'exicyclog'&:
34975 .ilist
34976 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
34977 default that is set when Exim is built. The default default is 10.
34978 .next
34979 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
34980 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
34981 overriding the script's default, which is to find the setting from Exim's
34982 configuration.
34983 .endlist
34984
34985 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
34986 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
34987 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
34988 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
34989 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
34990 logs are handled similarly.
34991
34992 If the limit is greater than 99, the script uses 3-digit numbers such as
34993 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
34994 to one that is greater, or &'vice versa'&, you will have to fix the names of
34995 any existing log files.
34996
34997 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
34998 the end are deleted. All files with numbers greater than 01 are compressed,
34999 using a compression command which is configured by the COMPRESS_COMMAND
35000 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35001 root &%crontab%& entry of the form
35002 .code
35003 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35004 .endd
35005 assuming you have used the name &"exim"& for the Exim user. You can run
35006 &'exicyclog'& as root if you wish, but there is no need.
35007
35008
35009
35010 .section "Mail statistics (eximstats)" "SECTmailstat"
35011 .cindex "statistics"
35012 .cindex "&'eximstats'&"
35013 A Perl script called &'eximstats'& is provided for extracting statistical
35014 information from log files. The output is either plain text, or HTML.
35015 Exim log files are also supported by the &'Lire'& system produced by the
35016 LogReport Foundation &url(http://www.logreport.org).
35017
35018 The &'eximstats'& script has been hacked about quite a bit over time. The
35019 latest version is the result of some extensive revision by Steve Campbell. A
35020 lot of information is given by default, but there are options for suppressing
35021 various parts of it. Following any options, the arguments to the script are a
35022 list of files, which should be main log files. For example:
35023 .code
35024 eximstats -nr /var/spool/exim/log/mainlog.01
35025 .endd
35026 By default, &'eximstats'& extracts information about the number and volume of
35027 messages received from or delivered to various hosts. The information is sorted
35028 both by message count and by volume, and the top fifty hosts in each category
35029 are listed on the standard output. Similar information, based on email
35030 addresses or domains instead of hosts can be requested by means of various
35031 options. For messages delivered and received locally, similar statistics are
35032 also produced per user.
35033
35034 The output also includes total counts and statistics about delivery errors, and
35035 histograms showing the number of messages received and deliveries made in each
35036 hour of the day. A delivery with more than one address in its envelope (for
35037 example, an SMTP transaction with more than one RCPT command) is counted
35038 as a single delivery by &'eximstats'&.
35039
35040 Though normally more deliveries than receipts are reported (as messages may
35041 have multiple recipients), it is possible for &'eximstats'& to report more
35042 messages received than delivered, even though the queue is empty at the start
35043 and end of the period in question. If an incoming message contains no valid
35044 recipients, no deliveries are recorded for it. A bounce message is handled as
35045 an entirely separate message.
35046
35047 &'eximstats'& always outputs a grand total summary giving the volume and number
35048 of messages received and deliveries made, and the number of hosts involved in
35049 each case. It also outputs the number of messages that were delayed (that is,
35050 not completely delivered at the first attempt), and the number that had at
35051 least one address that failed.
35052
35053 The remainder of the output is in sections that can be independently disabled
35054 or modified by various options. It consists of a summary of deliveries by
35055 transport, histograms of messages received and delivered per time interval
35056 (default per hour), information about the time messages spent on the queue,
35057 a list of relayed messages, lists of the top fifty sending hosts, local
35058 senders, destination hosts, and destination local users by count and by volume,
35059 and a list of delivery errors that occurred.
35060
35061 The relay information lists messages that were actually relayed, that is, they
35062 came from a remote host and were directly delivered to some other remote host,
35063 without being processed (for example, for aliasing or forwarding) locally.
35064
35065 There are quite a few options for &'eximstats'& to control exactly what it
35066 outputs. These are documented in the Perl script itself, and can be extracted
35067 by running the command &(perldoc)& on the script. For example:
35068 .code
35069 perldoc /usr/exim/bin/eximstats
35070 .endd
35071
35072 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35073 .cindex "&'exim_checkaccess'&"
35074 .cindex "policy control" "checking access"
35075 .cindex "checking access"
35076 The &%-bh%& command line argument allows you to run a fake SMTP session with
35077 debugging output, in order to check what Exim is doing when it is applying
35078 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35079 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35080 sometimes you just want to answer the question &"Does this address have
35081 access?"& without bothering with any further details.
35082
35083 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35084 two arguments, an IP address and an email address:
35085 .code
35086 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35087 .endd
35088 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35089 given email address would be accepted in a RCPT command in a TCP/IP
35090 connection from the host with the given IP address. The output of the utility
35091 is either the word &"accepted"&, or the SMTP error response, for example:
35092 .code
35093 Rejected:
35094 550 Relay not permitted
35095 .endd
35096 When running this test, the utility uses &`<>`& as the envelope sender address
35097 for the MAIL command, but you can change this by providing additional
35098 options. These are passed directly to the Exim command. For example, to specify
35099 that the test is to be run with the sender address &'himself@there.example'&
35100 you can use:
35101 .code
35102 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35103                  -f himself@there.example
35104 .endd
35105 Note that these additional Exim command line items must be given after the two
35106 mandatory arguments.
35107
35108 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35109 while running its checks. You can run checks that include callouts by using
35110 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35111
35112
35113
35114 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35115 .cindex "DBM" "building dbm files"
35116 .cindex "building DBM files"
35117 .cindex "&'exim_dbmbuild'&"
35118 .cindex "lower casing"
35119 .cindex "binary zero" "in lookup key"
35120 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35121 the format used by the &(lsearch)& lookup (see section
35122 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35123 names as keys and the remainder of the information as data. The lower-casing
35124 can be prevented by calling the program with the &%-nolc%& option.
35125
35126 A terminating zero is included as part of the key string. This is expected by
35127 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35128 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35129 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35130 files.
35131
35132 The program requires two arguments: the name of the input file (which can be a
35133 single hyphen to indicate the standard input), and the name of the output file.
35134 It creates the output under a temporary name, and then renames it if all went
35135 well.
35136
35137 .cindex "USE_DB"
35138 If the native DB interface is in use (USE_DB is set in a compile-time
35139 configuration file &-- this is common in free versions of Unix) the two file
35140 names must be different, because in this mode the Berkeley DB functions create
35141 a single output file using exactly the name given. For example,
35142 .code
35143 exim_dbmbuild /etc/aliases /etc/aliases.db
35144 .endd
35145 reads the system alias file and creates a DBM version of it in
35146 &_/etc/aliases.db_&.
35147
35148 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35149 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35150 environment, the suffixes are added to the second argument of
35151 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35152 when the Berkeley functions are used in compatibility mode (though this is not
35153 recommended), because in that case it adds a &_.db_& suffix to the file name.
35154
35155 If a duplicate key is encountered, the program outputs a warning, and when it
35156 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35157 option is used. By default, only the first of a set of duplicates is used &--
35158 this makes it compatible with &(lsearch)& lookups. There is an option
35159 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35160 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35161 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35162 return code is 2.
35163
35164
35165
35166
35167 .section "Finding individual retry times (exinext)" "SECTfinindret"
35168 .cindex "retry" "times"
35169 .cindex "&'exinext'&"
35170 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35171 fish specific information out of the retry database. Given a mail domain (or a
35172 complete address), it looks up the hosts for that domain, and outputs any retry
35173 information for the hosts or for the domain. At present, the retry information
35174 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35175 output. For example:
35176 .code
35177 $ exinext piglet@milne.fict.example
35178 kanga.milne.example:192.168.8.1 error 146: Connection refused
35179   first failed: 21-Feb-1996 14:57:34
35180   last tried:   21-Feb-1996 14:57:34
35181   next try at:  21-Feb-1996 15:02:34
35182 roo.milne.example:192.168.8.3 error 146: Connection refused
35183   first failed: 20-Jan-1996 13:12:08
35184   last tried:   21-Feb-1996 11:42:03
35185   next try at:  21-Feb-1996 19:42:03
35186   past final cutoff time
35187 .endd
35188 You can also give &'exinext'& a local part, without a domain, and it
35189 will give any retry information for that local part in your default domain.
35190 A message id can be used to obtain retry information pertaining to a specific
35191 message. This exists only when an attempt to deliver a message to a remote host
35192 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35193 &'exinext'& is not particularly efficient, but then it is not expected to be
35194 run very often.
35195
35196 The &'exinext'& utility calls Exim to find out information such as the location
35197 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35198 passed on to the &'exim'& commands. The first specifies an alternate Exim
35199 configuration file, and the second sets macros for use within the configuration
35200 file. These features are mainly to help in testing, but might also be useful in
35201 environments where more than one configuration file is in use.
35202
35203
35204
35205 .section "Hints database maintenance" "SECThindatmai"
35206 .cindex "hints database" "maintenance"
35207 .cindex "maintaining Exim's hints database"
35208 Three utility programs are provided for maintaining the DBM files that Exim
35209 uses to contain its delivery hint information. Each program requires two
35210 arguments. The first specifies the name of Exim's spool directory, and the
35211 second is the name of the database it is to operate on. These are as follows:
35212
35213 .ilist
35214 &'retry'&: the database of retry information
35215 .next
35216 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35217 for remote hosts
35218 .next
35219 &'callout'&: the callout cache
35220 .next
35221 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35222 .next
35223 &'misc'&: other hints data
35224 .endlist
35225
35226 The &'misc'& database is used for
35227
35228 .ilist
35229 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35230 .next
35231 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35232 &(smtp)& transport)
35233 .endlist
35234
35235
35236
35237 .section "exim_dumpdb" "SECID261"
35238 .cindex "&'exim_dumpdb'&"
35239 The entire contents of a database are written to the standard output by the
35240 &'exim_dumpdb'& program, which has no options or arguments other than the
35241 spool and database names. For example, to dump the retry database:
35242 .code
35243 exim_dumpdb /var/spool/exim retry
35244 .endd
35245 Two lines of output are produced for each entry:
35246 .code
35247 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35248 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35249 .endd
35250 The first item on the first line is the key of the record. It starts with one
35251 of the letters R, or T, depending on whether it refers to a routing or
35252 transport retry. For a local delivery, the next part is the local address; for
35253 a remote delivery it is the name of the remote host, followed by its failing IP
35254 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35255 transport). If the remote port is not the standard one (port 25), it is added
35256 to the IP address. Then there follows an error code, an additional error code,
35257 and a textual description of the error.
35258
35259 The three times on the second line are the time of first failure, the time of
35260 the last delivery attempt, and the computed time for the next attempt. The line
35261 ends with an asterisk if the cutoff time for the last retry rule has been
35262 exceeded.
35263
35264 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35265 consists of a host name followed by a list of ids for messages that are or were
35266 waiting to be delivered to that host. If there are a very large number for any
35267 one host, continuation records, with a sequence number added to the host name,
35268 may be seen. The data in these records is often out of date, because a message
35269 may be routed to several alternative hosts, and Exim makes no effort to keep
35270 cross-references.
35271
35272
35273
35274 .section "exim_tidydb" "SECID262"
35275 .cindex "&'exim_tidydb'&"
35276 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35277 database. If run with no options, it removes all records that are more than 30
35278 days old. The age is calculated from the date and time that the record was last
35279 updated. Note that, in the case of the retry database, it is &'not'& the time
35280 since the first delivery failure. Information about a host that has been down
35281 for more than 30 days will remain in the database, provided that the record is
35282 updated sufficiently often.
35283
35284 The cutoff date can be altered by means of the &%-t%& option, which must be
35285 followed by a time. For example, to remove all records older than a week from
35286 the retry database:
35287 .code
35288 exim_tidydb -t 7d /var/spool/exim retry
35289 .endd
35290 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35291 message ids. In the former these appear as data in records keyed by host &--
35292 they were messages that were waiting for that host &-- and in the latter they
35293 are the keys for retry information for messages that have suffered certain
35294 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35295 message ids in database records are those of messages that are still on the
35296 queue. Message ids for messages that no longer exist are removed from
35297 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35298 For the &'retry'& database, records whose keys are non-existent message ids are
35299 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35300 whenever it removes information from the database.
35301
35302 Certain records are automatically removed by Exim when they are no longer
35303 needed, but others are not. For example, if all the MX hosts for a domain are
35304 down, a retry record is created for each one. If the primary MX host comes back
35305 first, its record is removed when Exim successfully delivers to it, but the
35306 records for the others remain because Exim has not tried to use those hosts.
35307
35308 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35309 hints databases. You should do this at a quiet time of day, because it requires
35310 a database to be locked (and therefore inaccessible to Exim) while it does its
35311 work. Removing records from a DBM file does not normally make the file smaller,
35312 but all the common DBM libraries are able to re-use the space that is released.
35313 After an initial phase of increasing in size, the databases normally reach a
35314 point at which they no longer get any bigger, as long as they are regularly
35315 tidied.
35316
35317 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35318 databases is likely to keep on increasing.
35319
35320
35321
35322
35323 .section "exim_fixdb" "SECID263"
35324 .cindex "&'exim_fixdb'&"
35325 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35326 Its main use is for testing Exim, but it might also be occasionally useful for
35327 getting round problems in a live system. It has no options, and its interface
35328 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35329 key of a database record can then be entered, and the data for that record is
35330 displayed.
35331
35332 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35333 except the &'retry'& database, that is the only operation that can be carried
35334 out. For the &'retry'& database, each field is output preceded by a number, and
35335 data for individual fields can be changed by typing the field number followed
35336 by new data, for example:
35337 .code
35338 > 4 951102:1000
35339 .endd
35340 resets the time of the next delivery attempt. Time values are given as a
35341 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35342 used as optional separators.
35343
35344
35345
35346
35347 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35348 .cindex "mailbox" "maintenance"
35349 .cindex "&'exim_lock'&"
35350 .cindex "locking mailboxes"
35351 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35352 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35353 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35354 a user agent while investigating a problem. The utility requires the name of
35355 the file as its first argument. If the locking is successful, the second
35356 argument is run as a command (using C's &[system()]& function); if there is no
35357 second argument, the value of the SHELL environment variable is used; if this
35358 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35359 is unlocked and the utility ends. The following options are available:
35360
35361 .vlist
35362 .vitem &%-fcntl%&
35363 Use &[fcntl()]& locking on the open mailbox.
35364
35365 .vitem &%-flock%&
35366 Use &[flock()]& locking on the open mailbox, provided the operating system
35367 supports it.
35368
35369 .vitem &%-interval%&
35370 This must be followed by a number, which is a number of seconds; it sets the
35371 interval to sleep between retries (default 3).
35372
35373 .vitem &%-lockfile%&
35374 Create a lock file before opening the mailbox.
35375
35376 .vitem &%-mbx%&
35377 Lock the mailbox using MBX rules.
35378
35379 .vitem &%-q%&
35380 Suppress verification output.
35381
35382 .vitem &%-retries%&
35383 This must be followed by a number; it sets the number of times to try to get
35384 the lock (default 10).
35385
35386 .vitem &%-restore_time%&
35387 This option causes &%exim_lock%& to restore the modified and read times to the
35388 locked file before exiting. This allows you to access a locked mailbox (for
35389 example, to take a backup copy) without disturbing the times that the user
35390 subsequently sees.
35391
35392 .vitem &%-timeout%&
35393 This must be followed by a number, which is a number of seconds; it sets a
35394 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35395 default), a non-blocking call is used.
35396
35397 .vitem &%-v%&
35398 Generate verbose output.
35399 .endlist
35400
35401 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35402 default is to create a lock file and also to use &[fcntl()]& locking on the
35403 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35404 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35405 requires that the directory containing the file be writeable. Locking by lock
35406 file does not last for ever; Exim assumes that a lock file is expired if it is
35407 more than 30 minutes old.
35408
35409 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35410 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35411 to be taken out on the open mailbox, and an exclusive lock on the file
35412 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35413 number of the mailbox file. When the locking is released, if an exclusive lock
35414 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35415
35416 The default output contains verification of the locking that takes place. The
35417 &%-v%& option causes some additional information to be given. The &%-q%& option
35418 suppresses all output except error messages.
35419
35420 A command such as
35421 .code
35422 exim_lock /var/spool/mail/spqr
35423 .endd
35424 runs an interactive shell while the file is locked, whereas
35425 .display
35426 &`exim_lock -q /var/spool/mail/spqr <<End`&
35427 <&'some commands'&>
35428 &`End`&
35429 .endd
35430 runs a specific non-interactive sequence of commands while the file is locked,
35431 suppressing all verification output. A single command can be run by a command
35432 such as
35433 .code
35434 exim_lock -q /var/spool/mail/spqr \
35435   "cp /var/spool/mail/spqr /some/where"
35436 .endd
35437 Note that if a command is supplied, it must be entirely contained within the
35438 second argument &-- hence the quotes.
35439 .ecindex IIDutils
35440
35441
35442 . ////////////////////////////////////////////////////////////////////////////
35443 . ////////////////////////////////////////////////////////////////////////////
35444
35445 .chapter "The Exim monitor" "CHAPeximon"
35446 .scindex IIDeximon "Exim monitor" "description"
35447 .cindex "X-windows"
35448 .cindex "&'eximon'&"
35449 .cindex "Local/eximon.conf"
35450 .cindex "&_exim_monitor/EDITME_&"
35451 The Exim monitor is an application which displays in an X window information
35452 about the state of Exim's queue and what Exim is doing. An admin user can
35453 perform certain operations on messages from this GUI interface; however all
35454 such facilities are also available from the command line, and indeed, the
35455 monitor itself makes use of the command line to perform any actions requested.
35456
35457
35458
35459 .section "Running the monitor" "SECID264"
35460 The monitor is started by running the script called &'eximon'&. This is a shell
35461 script that sets up a number of environment variables, and then runs the
35462 binary called &_eximon.bin_&. The default appearance of the monitor window can
35463 be changed by editing the &_Local/eximon.conf_& file created by editing
35464 &_exim_monitor/EDITME_&. Comments in that file describe what the various
35465 parameters are for.
35466
35467 The parameters that get built into the &'eximon'& script can be overridden for
35468 a particular invocation by setting up environment variables of the same names,
35469 preceded by &`EXIMON_`&. For example, a shell command such as
35470 .code
35471 EXIMON_LOG_DEPTH=400 eximon
35472 .endd
35473 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
35474 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
35475 overrides the Exim log file configuration. This makes it possible to have
35476 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
35477 syslog messages are routed to a file on the local host.
35478
35479 X resources can be used to change the appearance of the window in the normal
35480 way. For example, a resource setting of the form
35481 .code
35482 Eximon*background: gray94
35483 .endd
35484 changes the colour of the background to light grey rather than white. The
35485 stripcharts are drawn with both the data lines and the reference lines in
35486 black. This means that the reference lines are not visible when on top of the
35487 data. However, their colour can be changed by setting a resource called
35488 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
35489 For example, if your X server is running Unix, you could set up lighter
35490 reference lines in the stripcharts by obeying
35491 .code
35492 xrdb -merge <<End
35493 Eximon*highlight: gray
35494 End
35495 .endd
35496 .cindex "admin user"
35497 In order to see the contents of messages on the queue, and to operate on them,
35498 &'eximon'& must either be run as root or by an admin user.
35499
35500 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
35501 contain X11 resource parameters interpreted by the X11 library.  In addition,
35502 if the first parameter starts with the string "gdb" then it is removed and the
35503 binary is invoked under gdb (the parameter is used as the gdb command-name, so
35504 versioned variants of gdb can be invoked).
35505
35506 The monitor's window is divided into three parts. The first contains one or
35507 more stripcharts and two action buttons, the second contains a &"tail"& of the
35508 main log file, and the third is a display of the queue of messages awaiting
35509 delivery, with two more action buttons. The following sections describe these
35510 different parts of the display.
35511
35512
35513
35514
35515 .section "The stripcharts" "SECID265"
35516 .cindex "stripchart"
35517 The first stripchart is always a count of messages on the queue. Its name can
35518 be configured by setting QUEUE_STRIPCHART_NAME in the
35519 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
35520 configuration script by regular expression matches on log file entries, making
35521 it possible to display, for example, counts of messages delivered to certain
35522 hosts or using certain transports. The supplied defaults display counts of
35523 received and delivered messages, and of local and SMTP deliveries. The default
35524 period between stripchart updates is one minute; this can be adjusted by a
35525 parameter in the &_Local/eximon.conf_& file.
35526
35527 The stripchart displays rescale themselves automatically as the value they are
35528 displaying changes. There are always 10 horizontal lines in each chart; the
35529 title string indicates the value of each division when it is greater than one.
35530 For example, &"x2"& means that each division represents a value of 2.
35531
35532 It is also possible to have a stripchart which shows the percentage fullness of
35533 a particular disk partition, which is useful when local deliveries are confined
35534 to a single partition.
35535
35536 .cindex "&%statvfs%& function"
35537 This relies on the availability of the &[statvfs()]& function or equivalent in
35538 the operating system. Most, but not all versions of Unix that support Exim have
35539 this. For this particular stripchart, the top of the chart always represents
35540 100%, and the scale is given as &"x10%"&. This chart is configured by setting
35541 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
35542 &_Local/eximon.conf_& file.
35543
35544
35545
35546
35547 .section "Main action buttons" "SECID266"
35548 .cindex "size" "of monitor window"
35549 .cindex "Exim monitor" "window size"
35550 .cindex "window size"
35551 Below the stripcharts there is an action button for quitting the monitor. Next
35552 to this is another button marked &"Size"&. They are placed here so that
35553 shrinking the window to its default minimum size leaves just the queue count
35554 stripchart and these two buttons visible. Pressing the &"Size"& button causes
35555 the window to expand to its maximum size, unless it is already at the maximum,
35556 in which case it is reduced to its minimum.
35557
35558 When expanding to the maximum, if the window cannot be fully seen where it
35559 currently is, it is moved back to where it was the last time it was at full
35560 size. When it is expanding from its minimum size, the old position is
35561 remembered, and next time it is reduced to the minimum it is moved back there.
35562
35563 The idea is that you can keep a reduced window just showing one or two
35564 stripcharts at a convenient place on your screen, easily expand it to show
35565 the full window when required, and just as easily put it back to what it was.
35566 The idea is copied from what the &'twm'& window manager does for its
35567 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
35568 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
35569
35570 Normally, the monitor starts up with the window at its full size, but it can be
35571 built so that it starts up with the window at its smallest size, by setting
35572 START_SMALL=yes in &_Local/eximon.conf_&.
35573
35574
35575
35576 .section "The log display" "SECID267"
35577 .cindex "log" "tail of; in monitor"
35578 The second section of the window is an area in which a display of the tail of
35579 the main log is maintained.
35580 To save space on the screen, the timestamp on each log line is shortened by
35581 removing the date and, if &%log_timezone%& is set, the timezone.
35582 The log tail is not available when the only destination for logging data is
35583 syslog, unless the syslog lines are routed to a local file whose name is passed
35584 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
35585
35586 The log sub-window has a scroll bar at its lefthand side which can be used to
35587 move back to look at earlier text, and the up and down arrow keys also have a
35588 scrolling effect. The amount of log that is kept depends on the setting of
35589 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
35590 to use. When this is full, the earlier 50% of data is discarded &-- this is
35591 much more efficient than throwing it away line by line. The sub-window also has
35592 a horizontal scroll bar for accessing the ends of long log lines. This is the
35593 only means of horizontal scrolling; the right and left arrow keys are not
35594 available. Text can be cut from this part of the window using the mouse in the
35595 normal way. The size of this subwindow is controlled by parameters in the
35596 configuration file &_Local/eximon.conf_&.
35597
35598 Searches of the text in the log window can be carried out by means of the ^R
35599 and ^S keystrokes, which default to a reverse and a forward search,
35600 respectively. The search covers only the text that is displayed in the window.
35601 It cannot go further back up the log.
35602
35603 The point from which the search starts is indicated by a caret marker. This is
35604 normally at the end of the text in the window, but can be positioned explicitly
35605 by pointing and clicking with the left mouse button, and is moved automatically
35606 by a successful search. If new text arrives in the window when it is scrolled
35607 back, the caret remains where it is, but if the window is not scrolled back,
35608 the caret is moved to the end of the new text.
35609
35610 Pressing ^R or ^S pops up a window into which the search text can be typed.
35611 There are buttons for selecting forward or reverse searching, for carrying out
35612 the search, and for cancelling. If the &"Search"& button is pressed, the search
35613 happens and the window remains so that further searches can be done. If the
35614 &"Return"& key is pressed, a single search is done and the window is closed. If
35615 ^C is typed the search is cancelled.
35616
35617 The searching facility is implemented using the facilities of the Athena text
35618 widget. By default this pops up a window containing both &"search"& and
35619 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
35620 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
35621 However, the linkers in BSDI and HP-UX seem unable to handle an externally
35622 provided version of &%TextPop%& when the remaining parts of the text widget
35623 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
35624 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
35625 on these systems, at the expense of having unwanted items in the search popup
35626 window.
35627
35628
35629
35630 .section "The queue display" "SECID268"
35631 .cindex "queue" "display in monitor"
35632 The bottom section of the monitor window contains a list of all messages that
35633 are on the queue, which includes those currently being received or delivered,
35634 as well as those awaiting delivery. The size of this subwindow is controlled by
35635 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
35636 at which it is updated is controlled by another parameter in the same file &--
35637 the default is 5 minutes, since queue scans can be quite expensive. However,
35638 there is an &"Update"& action button just above the display which can be used
35639 to force an update of the queue display at any time.
35640
35641 When a host is down for some time, a lot of pending mail can build up for it,
35642 and this can make it hard to deal with other messages on the queue. To help
35643 with this situation there is a button next to &"Update"& called &"Hide"&. If
35644 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
35645 type anything in here and press &"Return"&, the text is added to a chain of
35646 such texts, and if every undelivered address in a message matches at least one
35647 of the texts, the message is not displayed.
35648
35649 If there is an address that does not match any of the texts, all the addresses
35650 are displayed as normal. The matching happens on the ends of addresses so, for
35651 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
35652 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
35653 has been set up, a button called &"Unhide"& is displayed. If pressed, it
35654 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
35655 a hide request is automatically cancelled after one hour.
35656
35657 While the dialogue box is displayed, you can't press any buttons or do anything
35658 else to the monitor window. For this reason, if you want to cut text from the
35659 queue display to use in the dialogue box, you have to do the cutting before
35660 pressing the &"Hide"& button.
35661
35662 The queue display contains, for each unhidden queued message, the length of
35663 time it has been on the queue, the size of the message, the message id, the
35664 message sender, and the first undelivered recipient, all on one line. If it is
35665 a bounce message, the sender is shown as &"<>"&. If there is more than one
35666 recipient to which the message has not yet been delivered, subsequent ones are
35667 listed on additional lines, up to a maximum configured number, following which
35668 an ellipsis is displayed. Recipients that have already received the message are
35669 not shown.
35670
35671 .cindex "frozen messages" "display"
35672 If a message is frozen, an asterisk is displayed at the left-hand side.
35673
35674 The queue display has a vertical scroll bar, and can also be scrolled by means
35675 of the arrow keys. Text can be cut from it using the mouse in the normal way.
35676 The text searching facilities, as described above for the log window, are also
35677 available, but the caret is always moved to the end of the text when the queue
35678 display is updated.
35679
35680
35681
35682 .section "The queue menu" "SECID269"
35683 .cindex "queue" "menu in monitor"
35684 If the &%shift%& key is held down and the left button is clicked when the mouse
35685 pointer is over the text for any message, an action menu pops up, and the first
35686 line of the queue display for the message is highlighted. This does not affect
35687 any selected text.
35688
35689 If you want to use some other event for popping up the menu, you can set the
35690 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
35691 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
35692 value set in this parameter is a standard X event description. For example, to
35693 run eximon using &%ctrl%& rather than &%shift%& you could use
35694 .code
35695 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
35696 .endd
35697 The title of the menu is the message id, and it contains entries which act as
35698 follows:
35699
35700 .ilist
35701 &'message log'&: The contents of the message log for the message are displayed
35702 in a new text window.
35703 .next
35704 &'headers'&: Information from the spool file that contains the envelope
35705 information and headers is displayed in a new text window. See chapter
35706 &<<CHAPspool>>& for a description of the format of spool files.
35707 .next
35708 &'body'&: The contents of the spool file containing the body of the message are
35709 displayed in a new text window. There is a default limit of 20,000 bytes to the
35710 amount of data displayed. This can be changed by setting the BODY_MAX
35711 option at compile time, or the EXIMON_BODY_MAX option at run time.
35712 .next
35713 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
35714 delivery of the message. This causes an automatic thaw if the message is
35715 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
35716 a new text window. The delivery is run in a separate process, to avoid holding
35717 up the monitor while the delivery proceeds.
35718 .next
35719 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
35720 that the message be frozen.
35721 .next
35722 .cindex "thawing messages"
35723 .cindex "unfreezing messages"
35724 .cindex "frozen messages" "thawing"
35725 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
35726 that the message be thawed.
35727 .next
35728 .cindex "delivery" "forcing failure"
35729 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
35730 that Exim gives up trying to deliver the message. A bounce message is generated
35731 for any remaining undelivered addresses.
35732 .next
35733 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
35734 that the message be deleted from the system without generating a bounce
35735 message.
35736 .next
35737 &'add recipient'&: A dialog box is displayed into which a recipient address can
35738 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35739 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35740 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35741 causes a call to Exim to be made using the &%-Mar%& option to request that an
35742 additional recipient be added to the message, unless the entry box is empty, in
35743 which case no action is taken.
35744 .next
35745 &'mark delivered'&: A dialog box is displayed into which a recipient address
35746 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35747 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35748 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35749 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
35750 recipient address as already delivered, unless the entry box is empty, in which
35751 case no action is taken.
35752 .next
35753 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
35754 mark all recipient addresses as already delivered.
35755 .next
35756 &'edit sender'&: A dialog box is displayed initialized with the current
35757 sender's address. Pressing RETURN causes a call to Exim to be made using the
35758 &%-Mes%& option to replace the sender address, unless the entry box is empty,
35759 in which case no action is taken. If you want to set an empty sender (as in
35760 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
35761 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
35762 the address is qualified with that domain.
35763 .endlist
35764
35765 When a delivery is forced, a window showing the &%-v%& output is displayed. In
35766 other cases when a call to Exim is made, if there is any output from Exim (in
35767 particular, if the command fails) a window containing the command and the
35768 output is displayed. Otherwise, the results of the action are normally apparent
35769 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
35770 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
35771 if no output is generated.
35772
35773 The queue display is automatically updated for actions such as freezing and
35774 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
35775 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
35776 force an update of the display after one of these actions.
35777
35778 In any text window that is displayed as result of a menu action, the normal
35779 cut-and-paste facility is available, and searching can be carried out using ^R
35780 and ^S, as described above for the log tail window.
35781 .ecindex IIDeximon
35782
35783
35784
35785
35786
35787 . ////////////////////////////////////////////////////////////////////////////
35788 . ////////////////////////////////////////////////////////////////////////////
35789
35790 .chapter "Security considerations" "CHAPsecurity"
35791 .scindex IIDsecurcon "security" "discussion of"
35792 This chapter discusses a number of issues concerned with security, some of
35793 which are also covered in other parts of this manual.
35794
35795 For reasons that this author does not understand, some people have promoted
35796 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
35797 existence of this chapter in the documentation. However, the intent of the
35798 chapter is simply to describe the way Exim works in relation to certain
35799 security concerns, not to make any specific claims about the effectiveness of
35800 its security as compared with other MTAs.
35801
35802 What follows is a description of the way Exim is supposed to be. Best efforts
35803 have been made to try to ensure that the code agrees with the theory, but an
35804 absence of bugs can never be guaranteed. Any that are reported will get fixed
35805 as soon as possible.
35806
35807
35808 .section "Building a more &""hardened""& Exim" "SECID286"
35809 .cindex "security" "build-time features"
35810 There are a number of build-time options that can be set in &_Local/Makefile_&
35811 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
35812 Exim administrator who does not have the root password, or by someone who has
35813 penetrated the Exim (but not the root) account. These options are as follows:
35814
35815 .ilist
35816 ALT_CONFIG_PREFIX can be set to a string that is required to match the
35817 start of any file names used with the &%-C%& option. When it is set, these file
35818 names are also not allowed to contain the sequence &"/../"&. (However, if the
35819 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
35820 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
35821 default setting for &%ALT_CONFIG_PREFIX%&.
35822
35823 If the permitted configuration files are confined to a directory to
35824 which only root has access, this guards against someone who has broken
35825 into the Exim account from running a privileged Exim with an arbitrary
35826 configuration file, and using it to break into other accounts.
35827 .next
35828
35829 If a non-trusted configuration file (i.e. not the default configuration file
35830 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
35831 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
35832 the next item), then root privilege is retained only if the caller of Exim is
35833 root. This locks out the possibility of testing a configuration using &%-C%&
35834 right through message reception and delivery, even if the caller is root. The
35835 reception works, but by that time, Exim is running as the Exim user, so when
35836 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
35837 privilege to be lost. However, root can test reception and delivery using two
35838 separate commands.
35839
35840 .next
35841 The WHITELIST_D_MACROS build option declares some macros to be safe to override
35842 with &%-D%& if the real uid is one of root, the Exim run-time user or the
35843 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
35844 requiring the run-time value supplied to &%-D%& to match a regex that errs on
35845 the restrictive side.  Requiring build-time selection of safe macros is onerous
35846 but this option is intended solely as a transition mechanism to permit
35847 previously-working configurations to continue to work after release 4.73.
35848 .next
35849 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
35850 is disabled.
35851 .next
35852 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
35853 never to be used for any deliveries. This is like the &%never_users%& runtime
35854 option, but it cannot be overridden; the runtime option adds additional users
35855 to the list. The default setting is &"root"&; this prevents a non-root user who
35856 is permitted to modify the runtime file from using Exim as a way to get root.
35857 .endlist
35858
35859
35860
35861 .section "Root privilege" "SECID270"
35862 .cindex "setuid"
35863 .cindex "root privilege"
35864 The Exim binary is normally setuid to root, which means that it gains root
35865 privilege (runs as root) when it starts execution. In some special cases (for
35866 example, when the daemon is not in use and there are no local deliveries), it
35867 may be possible to run Exim setuid to some user other than root. This is
35868 discussed in the next section. However, in most installations, root privilege
35869 is required for two things:
35870
35871 .ilist
35872 To set up a socket connected to the standard SMTP port (25) when initialising
35873 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
35874 not required.
35875 .next
35876 To be able to change uid and gid in order to read users' &_.forward_& files and
35877 perform local deliveries as the receiving user or as specified in the
35878 configuration.
35879 .endlist
35880
35881 It is not necessary to be root to do any of the other things Exim does, such as
35882 receiving messages and delivering them externally over SMTP, and it is
35883 obviously more secure if Exim does not run as root except when necessary.
35884 For this reason, a user and group for Exim to use must be defined in
35885 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
35886 group"&. Their values can be changed by the run time configuration, though this
35887 is not recommended. Often a user called &'exim'& is used, but some sites use
35888 &'mail'& or another user name altogether.
35889
35890 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
35891 abdication; the process cannot regain root afterwards. Prior to release 4.00,
35892 &[seteuid()]& was used in some circumstances, but this is no longer the case.
35893
35894 After a new Exim process has interpreted its command line options, it changes
35895 uid and gid in the following cases:
35896
35897 .ilist
35898 .oindex "&%-C%&"
35899 .oindex "&%-D%&"
35900 If the &%-C%& option is used to specify an alternate configuration file, or if
35901 the &%-D%& option is used to define macro values for the configuration, and the
35902 calling process is not running as root, the uid and gid are changed to those of
35903 the calling process.
35904 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
35905 option may not be used at all.
35906 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
35907 can be supplied if the calling process is running as root, the Exim run-time
35908 user or CONFIGURE_OWNER, if defined.
35909 .next
35910 .oindex "&%-be%&"
35911 .oindex "&%-bf%&"
35912 .oindex "&%-bF%&"
35913 If the expansion test option (&%-be%&) or one of the filter testing options
35914 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
35915 calling process.
35916 .next
35917 If the process is not a daemon process or a queue runner process or a delivery
35918 process or a process for testing address routing (started with &%-bt%&), the
35919 uid and gid are changed to the Exim user and group. This means that Exim always
35920 runs under its own uid and gid when receiving messages. This also applies when
35921 testing address verification
35922 .oindex "&%-bv%&"
35923 .oindex "&%-bh%&"
35924 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
35925 option).
35926 .next
35927 For a daemon, queue runner, delivery, or address testing process, the uid
35928 remains as root at this stage, but the gid is changed to the Exim group.
35929 .endlist
35930
35931 The processes that initially retain root privilege behave as follows:
35932
35933 .ilist
35934 A daemon process changes the gid to the Exim group and the uid to the Exim
35935 user after setting up one or more listening sockets. The &[initgroups()]&
35936 function is called, so that if the Exim user is in any additional groups, they
35937 will be used during message reception.
35938 .next
35939 A queue runner process retains root privilege throughout its execution. Its
35940 job is to fork a controlled sequence of delivery processes.
35941 .next
35942 A delivery process retains root privilege throughout most of its execution,
35943 but any actual deliveries (that is, the transports themselves) are run in
35944 subprocesses which always change to a non-root uid and gid. For local
35945 deliveries this is typically the uid and gid of the owner of the mailbox; for
35946 remote deliveries, the Exim uid and gid are used. Once all the delivery
35947 subprocesses have been run, a delivery process changes to the Exim uid and gid
35948 while doing post-delivery tidying up such as updating the retry database and
35949 generating bounce and warning messages.
35950
35951 While the recipient addresses in a message are being routed, the delivery
35952 process runs as root. However, if a user's filter file has to be processed,
35953 this is done in a subprocess that runs under the individual user's uid and
35954 gid. A system filter is run as root unless &%system_filter_user%& is set.
35955 .next
35956 A process that is testing addresses (the &%-bt%& option) runs as root so that
35957 the routing is done in the same environment as a message delivery.
35958 .endlist
35959
35960
35961
35962
35963 .section "Running Exim without privilege" "SECTrunexiwitpri"
35964 .cindex "privilege, running without"
35965 .cindex "unprivileged running"
35966 .cindex "root privilege" "running without"
35967 Some installations like to run Exim in an unprivileged state for more of its
35968 operation, for added security. Support for this mode of operation is provided
35969 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
35970 gid are changed to the Exim user and group at the start of a delivery process
35971 (and also queue runner and address testing processes). This means that address
35972 routing is no longer run as root, and the deliveries themselves cannot change
35973 to any other uid.
35974
35975 .cindex SIGHUP
35976 .cindex "daemon" "restarting"
35977 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
35978 that the daemon can still be started in the usual way, and it can respond
35979 correctly to SIGHUP because the re-invocation regains root privilege.
35980
35981 An alternative approach is to make Exim setuid to the Exim user and also setgid
35982 to the Exim group. If you do this, the daemon must be started from a root
35983 process. (Calling Exim from a root process makes it behave in the way it does
35984 when it is setuid root.) However, the daemon cannot restart itself after a
35985 SIGHUP signal because it cannot regain privilege.
35986
35987 It is still useful to set &%deliver_drop_privilege%& in this case, because it
35988 stops Exim from trying to re-invoke itself to do a delivery after a message has
35989 been received. Such a re-invocation is a waste of resources because it has no
35990 effect.
35991
35992 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
35993 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
35994 to the Exim user seems a clean approach, but there is one complication:
35995
35996 In this style of operation, Exim is running with the real uid and gid set to
35997 those of the calling process, and the effective uid/gid set to Exim's values.
35998 Ideally, any association with the calling process' uid/gid should be dropped,
35999 that is, the real uid/gid should be reset to the effective values so as to
36000 discard any privileges that the caller may have. While some operating systems
36001 have a function that permits this action for a non-root effective uid, quite a
36002 number of them do not. Because of this lack of standardization, Exim does not
36003 address this problem at this time.
36004
36005 For this reason, the recommended approach for &"mostly unprivileged"& running
36006 is to keep the Exim binary setuid to root, and to set
36007 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36008 be used in the most straightforward way.
36009
36010 If you configure Exim not to run delivery processes as root, there are a
36011 number of restrictions on what you can do:
36012
36013 .ilist
36014 You can deliver only as the Exim user/group. You should  explicitly use the
36015 &%user%& and &%group%& options to override routers or local transports that
36016 normally deliver as the recipient. This makes sure that configurations that
36017 work in this mode function the same way in normal mode. Any implicit or
36018 explicit specification of another user causes an error.
36019 .next
36020 Use of &_.forward_& files is severely restricted, such that it is usually
36021 not worthwhile to include them in the configuration.
36022 .next
36023 Users who wish to use &_.forward_& would have to make their home directory and
36024 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36025 and their equivalents in Exim filters, cannot be used. While they could be
36026 enabled in the Exim user's name, that would be insecure and not very useful.
36027 .next
36028 Unless the local user mailboxes are all owned by the Exim user (possible in
36029 some POP3 or IMAP-only environments):
36030
36031 .olist
36032 They must be owned by the Exim group and be writeable by that group. This
36033 implies you must set &%mode%& in the appendfile configuration, as well as the
36034 mode of the mailbox files themselves.
36035 .next
36036 You must set &%no_check_owner%&, since most or all of the files will not be
36037 owned by the Exim user.
36038 .next
36039 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36040 on a newly created mailbox when unprivileged. This also implies that new
36041 mailboxes need to be created manually.
36042 .endlist olist
36043 .endlist ilist
36044
36045
36046 These restrictions severely restrict what can be done in local deliveries.
36047 However, there are no restrictions on remote deliveries. If you are running a
36048 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36049 gives more security at essentially no cost.
36050
36051 If you are using the &%mua_wrapper%& facility (see chapter
36052 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36053
36054
36055
36056
36057 .section "Delivering to local files" "SECID271"
36058 Full details of the checks applied by &(appendfile)& before it writes to a file
36059 are given in chapter &<<CHAPappendfile>>&.
36060
36061
36062
36063 .section "Running local commands" "SECTsecconslocalcmds"
36064 .cindex "security" "local commands"
36065 .cindex "security" "command injection attacks"
36066 There are a number of ways in which an administrator can configure Exim to run
36067 commands based upon received, untrustworthy, data. Further, in some
36068 configurations a user who can control a &_.forward_& file can also arrange to
36069 run commands. Configuration to check includes, but is not limited to:
36070
36071 .ilist
36072 Use of &%use_shell%& in the pipe transport: various forms of shell command
36073 injection may be possible with this option present. It is dangerous and should
36074 be used only with considerable caution. Consider constraints which whitelist
36075 allowed characters in a variable which is to be used in a pipe transport that
36076 has &%use_shell%& enabled.
36077 .next
36078 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36079 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36080 &_.forward_& files in a redirect router. If Exim is running on a central mail
36081 hub to which ordinary users do not have shell access, but home directories are
36082 NFS mounted (for instance) then administrators should review the list of these
36083 forbid options available, and should bear in mind that the options that may
36084 need forbidding can change as new features are added between releases.
36085 .next
36086 The &%${run...}%& expansion item does not use a shell by default, but
36087 administrators can configure use of &_/bin/sh_& as part of the command.
36088 Such invocations should be viewed with prejudicial suspicion.
36089 .next
36090 Administrators who use embedded Perl are advised to explore how Perl's
36091 taint checking might apply to their usage.
36092 .next
36093 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36094 administrators are well advised to view its use with suspicion, in case (for
36095 instance) it allows a local-part to contain embedded Exim directives.
36096 .next
36097 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36098 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36099 each can reference arbitrary lists and files, rather than just being a list
36100 of opaque strings.
36101 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36102 real-world security vulnerabilities caused by its use with untrustworthy data
36103 injected in, for SQL injection attacks.
36104 Consider the use of the &%inlisti%& expansion condition instead.
36105 .endlist
36106
36107
36108
36109
36110 .section "Trust in configuration data" "SECTsecconfdata"
36111 .cindex "security" "data sources"
36112 .cindex "security" "regular expressions"
36113 .cindex "regular expressions" "security"
36114 .cindex "PCRE" "security"
36115 If configuration data for Exim can come from untrustworthy sources, there
36116 are some issues to be aware of:
36117
36118 .ilist
36119 Use of &%${expand...}%& may provide a path for shell injection attacks.
36120 .next
36121 Letting untrusted data provide a regular expression is unwise.
36122 .next
36123 Using &%${match...}%& to apply a fixed regular expression against untrusted
36124 data may result in pathological behaviour within PCRE.  Be aware of what
36125 "backtracking" means and consider options for being more strict with a regular
36126 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36127 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36128 possessive quantifiers or just not using regular expressions against untrusted
36129 data.
36130 .next
36131 It can be important to correctly use &%${quote:...}%&,
36132 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36133 items to ensure that data is correctly constructed.
36134 .next
36135 Some lookups might return multiple results, even though normal usage is only
36136 expected to yield one result.
36137 .endlist
36138
36139
36140
36141
36142 .section "IPv4 source routing" "SECID272"
36143 .cindex "source routing" "in IP packets"
36144 .cindex "IP source routing"
36145 Many operating systems suppress IP source-routed packets in the kernel, but
36146 some cannot be made to do this, so Exim does its own check. It logs incoming
36147 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36148 IPv6. No special checking is currently done.
36149
36150
36151
36152 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36153 Support for these SMTP commands is disabled by default. If required, they can
36154 be enabled by defining suitable ACLs.
36155
36156
36157
36158
36159 .section "Privileged users" "SECID274"
36160 .cindex "trusted users"
36161 .cindex "admin user"
36162 .cindex "privileged user"
36163 .cindex "user" "trusted"
36164 .cindex "user" "admin"
36165 Exim recognizes two sets of users with special privileges. Trusted users are
36166 able to submit new messages to Exim locally, but supply their own sender
36167 addresses and information about a sending host. For other users submitting
36168 local messages, Exim sets up the sender address from the uid, and doesn't
36169 permit a remote host to be specified.
36170
36171 .oindex "&%-f%&"
36172 However, an untrusted user is permitted to use the &%-f%& command line option
36173 in the special form &%-f <>%& to indicate that a delivery failure for the
36174 message should not cause an error report. This affects the message's envelope,
36175 but it does not affect the &'Sender:'& header. Untrusted users may also be
36176 permitted to use specific forms of address with the &%-f%& option by setting
36177 the &%untrusted_set_sender%& option.
36178
36179 Trusted users are used to run processes that receive mail messages from some
36180 other mail domain and pass them on to Exim for delivery either locally, or over
36181 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36182 as any user listed in the &%trusted_users%& configuration option, or under any
36183 group listed in the &%trusted_groups%& option.
36184
36185 Admin users are permitted to do things to the messages on Exim's queue. They
36186 can freeze or thaw messages, cause them to be returned to their senders, remove
36187 them entirely, or modify them in various ways. In addition, admin users can run
36188 the Exim monitor and see all the information it is capable of providing, which
36189 includes the contents of files on the spool.
36190
36191 .oindex "&%-M%&"
36192 .oindex "&%-q%&"
36193 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36194 delivery of messages on its queue is restricted to admin users. This
36195 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36196 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36197 queue is also restricted to admin users. This restriction can be relaxed by
36198 setting &%no_queue_list_requires_admin%&.
36199
36200 Exim recognizes an admin user if the calling process is running as root or as
36201 the Exim user or if any of the groups associated with the calling process is
36202 the Exim group. It is not necessary actually to be running under the Exim
36203 group. However, if admin users who are not root or the Exim user are to access
36204 the contents of files on the spool via the Exim monitor (which runs
36205 unprivileged), Exim must be built to allow group read access to its spool
36206 files.
36207
36208
36209
36210 .section "Spool files" "SECID275"
36211 .cindex "spool directory" "files"
36212 Exim's spool directory and everything it contains is owned by the Exim user and
36213 set to the Exim group. The mode for spool files is defined in the
36214 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36215 any user who is a member of the Exim group can access these files.
36216
36217
36218
36219 .section "Use of argv[0]" "SECID276"
36220 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36221 of specific strings, Exim assumes certain options. For example, calling Exim
36222 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36223 to calling it with the option &%-bS%&. There are no security implications in
36224 this.
36225
36226
36227
36228 .section "Use of %f formatting" "SECID277"
36229 The only use made of &"%f"& by Exim is in formatting load average values. These
36230 are actually stored in integer variables as 1000 times the load average.
36231 Consequently, their range is limited and so therefore is the length of the
36232 converted output.
36233
36234
36235
36236 .section "Embedded Exim path" "SECID278"
36237 Exim uses its own path name, which is embedded in the code, only when it needs
36238 to re-exec in order to regain root privilege. Therefore, it is not root when it
36239 does so. If some bug allowed the path to get overwritten, it would lead to an
36240 arbitrary program's being run as exim, not as root.
36241
36242
36243
36244 .section "Dynamic module directory" "SECTdynmoddir"
36245 Any dynamically loadable modules must be installed into the directory
36246 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36247 loading it.
36248
36249
36250 .section "Use of sprintf()" "SECID279"
36251 .cindex "&[sprintf()]&"
36252 A large number of occurrences of &"sprintf"& in the code are actually calls to
36253 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36254 The intermediate formatting is done into a large fixed buffer by a function
36255 that runs through the format string itself, and checks the length of each
36256 conversion before performing it, thus preventing buffer overruns.
36257
36258 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36259 the output buffer is known to be sufficiently long to contain the converted
36260 string.
36261
36262
36263
36264 .section "Use of debug_printf() and log_write()" "SECID280"
36265 Arbitrary strings are passed to both these functions, but they do their
36266 formatting by calling the function &'string_vformat()'&, which runs through
36267 the format string itself, and checks the length of each conversion.
36268
36269
36270
36271 .section "Use of strcat() and strcpy()" "SECID281"
36272 These are used only in cases where the output buffer is known to be large
36273 enough to hold the result.
36274 .ecindex IIDsecurcon
36275
36276
36277
36278
36279 . ////////////////////////////////////////////////////////////////////////////
36280 . ////////////////////////////////////////////////////////////////////////////
36281
36282 .chapter "Format of spool files" "CHAPspool"
36283 .scindex IIDforspo1 "format" "spool files"
36284 .scindex IIDforspo2 "spool directory" "format of files"
36285 .scindex IIDforspo3 "spool files" "format of"
36286 .cindex "spool files" "editing"
36287 A message on Exim's queue consists of two files, whose names are the message id
36288 followed by -D and -H, respectively. The data portion of the message is kept in
36289 the -D file on its own. The message's envelope, status, and headers are all
36290 kept in the -H file, whose format is described in this chapter. Each of these
36291 two files contains the final component of its own name as its first line. This
36292 is insurance against disk crashes where the directory is lost but the files
36293 themselves are recoverable.
36294
36295 Some people are tempted into editing -D files in order to modify messages. You
36296 need to be extremely careful if you do this; it is not recommended and you are
36297 on your own if you do it. Here are some of the pitfalls:
36298
36299 .ilist
36300 You must ensure that Exim does not try to deliver the message while you are
36301 fiddling with it. The safest way is to take out a write lock on the -D file,
36302 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36303 place, the lock will be retained. If you write a new file and rename it, the
36304 lock will be lost at the instant of rename.
36305 .next
36306 .vindex "&$body_linecount$&"
36307 If you change the number of lines in the file, the value of
36308 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36309 present, this value is not used by Exim, but there is no guarantee that this
36310 will always be the case.
36311 .next
36312 If the message is in MIME format, you must take care not to break it.
36313 .next
36314 If the message is cryptographically signed, any change will invalidate the
36315 signature.
36316 .endlist
36317 All in all, modifying -D files is fraught with danger.
36318
36319 Files whose names end with -J may also be seen in the &_input_& directory (or
36320 its subdirectories when &%split_spool_directory%& is set). These are journal
36321 files, used to record addresses to which the message has been delivered during
36322 the course of a delivery attempt. If there are still undelivered recipients at
36323 the end, the -H file is updated, and the -J file is deleted. If, however, there
36324 is some kind of crash (for example, a power outage) before this happens, the -J
36325 file remains in existence. When Exim next processes the message, it notices the
36326 -J file and uses it to update the -H file before starting the next delivery
36327 attempt.
36328
36329 .section "Format of the -H file" "SECID282"
36330 .cindex "uid (user id)" "in spool file"
36331 .cindex "gid (group id)" "in spool file"
36332 The second line of the -H file contains the login name for the uid of the
36333 process that called Exim to read the message, followed by the numerical uid and
36334 gid. For a locally generated message, this is normally the user who sent the
36335 message. For a message received over TCP/IP via the daemon, it is
36336 normally the Exim user.
36337
36338 The third line of the file contains the address of the message's sender as
36339 transmitted in the envelope, contained in angle brackets. The sender address is
36340 empty for bounce messages. For incoming SMTP mail, the sender address is given
36341 in the MAIL command. For locally generated mail, the sender address is
36342 created by Exim from the login name of the current user and the configured
36343 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36344 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36345 &"<>"& or an address that matches &%untrusted_set_senders%&.
36346
36347 The fourth line contains two numbers. The first is the time that the message
36348 was received, in the conventional Unix form &-- the number of seconds since the
36349 start of the epoch. The second number is a count of the number of messages
36350 warning of delayed delivery that have been sent to the sender.
36351
36352 There follow a number of lines starting with a hyphen. These can appear in any
36353 order, and are omitted when not relevant:
36354
36355 .vlist
36356 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36357 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36358 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36359 recognized, to provide backward compatibility. In the old format, a line of
36360 this form is present for every ACL variable that is not empty. The number
36361 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36362 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36363 the data string for the variable. The string itself starts at the beginning of
36364 the next line, and is followed by a newline character. It may contain internal
36365 newlines.
36366
36367 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36368 A line of this form is present for every ACL connection variable that is
36369 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36370 The length is the length of the data string for the variable. The string itself
36371 starts at the beginning of the next line, and is followed by a newline
36372 character. It may contain internal newlines.
36373
36374 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36375 A line of this form is present for every ACL message variable that is defined.
36376 Note that there is a space between &%-aclm%& and the rest of the name. The
36377 length is the length of the data string for the variable. The string itself
36378 starts at the beginning of the next line, and is followed by a newline
36379 character. It may contain internal newlines.
36380
36381 .vitem "&%-active_hostname%&&~<&'hostname'&>"
36382 This is present if, when the message was received over SMTP, the value of
36383 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36384
36385 .vitem &%-allow_unqualified_recipient%&
36386 This is present if unqualified recipient addresses are permitted in header
36387 lines (to stop such addresses from being qualified if rewriting occurs at
36388 transport time). Local messages that were input using &%-bnq%& and remote
36389 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36390
36391 .vitem &%-allow_unqualified_sender%&
36392 This is present if unqualified sender addresses are permitted in header lines
36393 (to stop such addresses from being qualified if rewriting occurs at transport
36394 time). Local messages that were input using &%-bnq%& and remote messages from
36395 hosts that match &%sender_unqualified_hosts%& set this flag.
36396
36397 .vitem "&%-auth_id%&&~<&'text'&>"
36398 The id information for a message received on an authenticated SMTP connection
36399 &-- the value of the &$authenticated_id$& variable.
36400
36401 .vitem "&%-auth_sender%&&~<&'address'&>"
36402 The address of an authenticated sender &-- the value of the
36403 &$authenticated_sender$& variable.
36404
36405 .vitem "&%-body_linecount%&&~<&'number'&>"
36406 This records the number of lines in the body of the message, and is always
36407 present.
36408
36409 .vitem "&%-body_zerocount%&&~<&'number'&>"
36410 This records the number of binary zero bytes in the body of the message, and is
36411 present if the number is greater than zero.
36412
36413 .vitem &%-deliver_firsttime%&
36414 This is written when a new message is first added to the spool. When the spool
36415 file is updated after a deferral, it is omitted.
36416
36417 .vitem "&%-frozen%&&~<&'time'&>"
36418 .cindex "frozen messages" "spool data"
36419 The message is frozen, and the freezing happened at <&'time'&>.
36420
36421 .vitem "&%-helo_name%&&~<&'text'&>"
36422 This records the host name as specified by a remote host in a HELO or EHLO
36423 command.
36424
36425 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
36426 This records the IP address of the host from which the message was received and
36427 the remote port number that was used. It is omitted for locally generated
36428 messages.
36429
36430 .vitem "&%-host_auth%&&~<&'text'&>"
36431 If the message was received on an authenticated SMTP connection, this records
36432 the name of the authenticator &-- the value of the
36433 &$sender_host_authenticated$& variable.
36434
36435 .vitem &%-host_lookup_failed%&
36436 This is present if an attempt to look up the sending host's name from its IP
36437 address failed. It corresponds to the &$host_lookup_failed$& variable.
36438
36439 .vitem "&%-host_name%&&~<&'text'&>"
36440 .cindex "reverse DNS lookup"
36441 .cindex "DNS" "reverse lookup"
36442 This records the name of the remote host from which the message was received,
36443 if the host name was looked up from the IP address when the message was being
36444 received. It is not present if no reverse lookup was done.
36445
36446 .vitem "&%-ident%&&~<&'text'&>"
36447 For locally submitted messages, this records the login of the originating user,
36448 unless it was a trusted user and the &%-oMt%& option was used to specify an
36449 ident value. For messages received over TCP/IP, this records the ident string
36450 supplied by the remote host, if any.
36451
36452 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
36453 This records the IP address of the local interface and the port number through
36454 which a message was received from a remote host. It is omitted for locally
36455 generated messages.
36456
36457 .vitem &%-local%&
36458 The message is from a local sender.
36459
36460 .vitem &%-localerror%&
36461 The message is a locally-generated bounce message.
36462
36463 .vitem "&%-local_scan%&&~<&'string'&>"
36464 This records the data string that was returned by the &[local_scan()]& function
36465 when the message was received &-- the value of the &$local_scan_data$&
36466 variable. It is omitted if no data was returned.
36467
36468 .vitem &%-manual_thaw%&
36469 The message was frozen but has been thawed manually, that is, by an explicit
36470 Exim command rather than via the auto-thaw process.
36471
36472 .vitem &%-N%&
36473 A testing delivery process was started using the &%-N%& option to suppress any
36474 actual deliveries, but delivery was deferred. At any further delivery attempts,
36475 &%-N%& is assumed.
36476
36477 .vitem &%-received_protocol%&
36478 This records the value of the &$received_protocol$& variable, which contains
36479 the name of the protocol by which the message was received.
36480
36481 .vitem &%-sender_set_untrusted%&
36482 The envelope sender of this message was set by an untrusted local caller (used
36483 to ensure that the caller is displayed in queue listings).
36484
36485 .vitem "&%-spam_score_int%&&~<&'number'&>"
36486 If a message was scanned by SpamAssassin, this is present. It records the value
36487 of &$spam_score_int$&.
36488
36489 .vitem &%-tls_certificate_verified%&
36490 A TLS certificate was received from the client that sent this message, and the
36491 certificate was verified by the server.
36492
36493 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
36494 When the message was received over an encrypted connection, this records the
36495 name of the cipher suite that was used.
36496
36497 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
36498 When the message was received over an encrypted connection, and a certificate
36499 was received from the client, this records the Distinguished Name from that
36500 certificate.
36501 .endlist
36502
36503 Following the options there is a list of those addresses to which the message
36504 is not to be delivered. This set of addresses is initialized from the command
36505 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
36506 is set; otherwise it starts out empty. Whenever a successful delivery is made,
36507 the address is added to this set. The addresses are kept internally as a
36508 balanced binary tree, and it is a representation of that tree which is written
36509 to the spool file. If an address is expanded via an alias or forward file, the
36510 original address is added to the tree when deliveries to all its child
36511 addresses are complete.
36512
36513 If the tree is empty, there is a single line in the spool file containing just
36514 the text &"XX"&. Otherwise, each line consists of two letters, which are either
36515 Y or N, followed by an address. The address is the value for the node of the
36516 tree, and the letters indicate whether the node has a left branch and/or a
36517 right branch attached to it, respectively. If branches exist, they immediately
36518 follow. Here is an example of a three-node tree:
36519 .code
36520 YY darcy@austen.fict.example
36521 NN alice@wonderland.fict.example
36522 NN editor@thesaurus.ref.example
36523 .endd
36524 After the non-recipients tree, there is a list of the message's recipients.
36525 This is a simple list, preceded by a count. It includes all the original
36526 recipients of the message, including those to whom the message has already been
36527 delivered. In the simplest case, the list contains one address per line. For
36528 example:
36529 .code
36530 4
36531 editor@thesaurus.ref.example
36532 darcy@austen.fict.example
36533 rdo@foundation
36534 alice@wonderland.fict.example
36535 .endd
36536 However, when a child address has been added to the top-level addresses as a
36537 result of the use of the &%one_time%& option on a &(redirect)& router, each
36538 line is of the following form:
36539 .display
36540 <&'top-level address'&> <&'errors_to address'&> &&&
36541   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
36542 .endd
36543 The 01 flag bit indicates the presence of the three other fields that follow
36544 the top-level address. Other bits may be used in future to support additional
36545 fields. The <&'parent number'&> is the offset in the recipients list of the
36546 original parent of the &"one time"& address. The first two fields are the
36547 envelope sender that is associated with this address and its length. If the
36548 length is zero, there is no special envelope sender (there are then two space
36549 characters in the line). A non-empty field can arise from a &(redirect)& router
36550 that has an &%errors_to%& setting.
36551
36552
36553 A blank line separates the envelope and status information from the headers
36554 which follow. A header may occupy several lines of the file, and to save effort
36555 when reading it in, each header is preceded by a number and an identifying
36556 character. The number is the number of characters in the header, including any
36557 embedded newlines and the terminating newline. The character is one of the
36558 following:
36559
36560 .table2 50pt
36561 .row <&'blank'&>         "header in which Exim has no special interest"
36562 .row &`B`&               "&'Bcc:'& header"
36563 .row &`C`&               "&'Cc:'& header"
36564 .row &`F`&               "&'From:'& header"
36565 .row &`I`&               "&'Message-id:'& header"
36566 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
36567 .row &`R`&               "&'Reply-To:'& header"
36568 .row &`S`&               "&'Sender:'& header"
36569 .row &`T`&               "&'To:'& header"
36570 .row &`*`&               "replaced or deleted header"
36571 .endtable
36572
36573 Deleted or replaced (rewritten) headers remain in the spool file for debugging
36574 purposes. They are not transmitted when the message is delivered. Here is a
36575 typical set of headers:
36576 .code
36577 111P Received: by hobbit.fict.example with local (Exim 4.00)
36578 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
36579 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
36580 038* X-rewrote-sender: bb@hobbit.fict.example
36581 042* From: Bilbo Baggins <bb@hobbit.fict.example>
36582 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
36583 099* To: alice@wonderland.fict.example, rdo@foundation,
36584 darcy@austen.fict.example, editor@thesaurus.ref.example
36585 104T To: alice@wonderland.fict.example, rdo@foundation.example,
36586 darcy@austen.fict.example, editor@thesaurus.ref.example
36587 038  Date: Fri, 11 May 2001 10:28:59 +0100
36588 .endd
36589 The asterisked headers indicate that the envelope sender, &'From:'& header, and
36590 &'To:'& header have been rewritten, the last one because routing expanded the
36591 unqualified domain &'foundation'&.
36592 .ecindex IIDforspo1
36593 .ecindex IIDforspo2
36594 .ecindex IIDforspo3
36595
36596 . ////////////////////////////////////////////////////////////////////////////
36597 . ////////////////////////////////////////////////////////////////////////////
36598
36599 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
36600          "DKIM Support"
36601 .cindex "DKIM"
36602
36603 DKIM is a mechanism by which messages sent by some entity can be provably
36604 linked to a domain which that entity controls.  It permits reputation to
36605 be tracked on a per-domain basis, rather than merely upon source IP address.
36606 DKIM is documented in RFC 4871.
36607
36608 Since version 4.70, DKIM support is compiled into Exim by default. It can be
36609 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
36610
36611 Exim's DKIM implementation allows to
36612 .olist
36613 Sign outgoing messages: This function is implemented in the SMTP transport.
36614 It can co-exist with all other Exim features
36615 (including transport filters)
36616 except cutthrough delivery.
36617 .next
36618 Verify signatures in incoming messages: This is implemented by an additional
36619 ACL (acl_smtp_dkim), which can be called several times per message, with
36620 different signature contexts.
36621 .endlist
36622
36623 In typical Exim style, the verification implementation does not include any
36624 default "policy". Instead it enables you to build your own policy using
36625 Exim's standard controls.
36626
36627 Please note that verification of DKIM signatures in incoming mail is turned
36628 on by default for logging purposes. For each signature in incoming email,
36629 exim will log a line displaying the most important signature details, and the
36630 signature status. Here is an example (with line-breaks added for clarity):
36631 .code
36632 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
36633     d=facebookmail.com s=q1-2009b
36634     c=relaxed/relaxed a=rsa-sha1
36635     i=@facebookmail.com t=1252484542 [verification succeeded]
36636 .endd
36637 You might want to turn off DKIM verification processing entirely for internal
36638 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
36639 control modifier. This should typically be done in the RCPT ACL, at points
36640 where you accept mail from relay sources (internal hosts or authenticated
36641 senders).
36642
36643
36644 .section "Signing outgoing messages" "SECID513"
36645 .cindex "DKIM" "signing"
36646
36647 Signing is implemented by setting private options on the SMTP transport.
36648 These options take (expandable) strings as arguments.
36649
36650 .option dkim_domain smtp string&!! unset
36651 MANDATORY:
36652 The domain you want to sign with. The result of this expanded
36653 option is put into the &%$dkim_domain%& expansion variable.
36654
36655 .option dkim_selector smtp string&!! unset
36656 MANDATORY:
36657 This sets the key selector string. You can use the &%$dkim_domain%& expansion
36658 variable to look up a matching selector. The result is put in the expansion
36659 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
36660 option along with &%$dkim_domain%&.
36661
36662 .option dkim_private_key smtp string&!! unset
36663 MANDATORY:
36664 This sets the private key to use. You can use the &%$dkim_domain%& and
36665 &%$dkim_selector%& expansion variables to determine the private key to use.
36666 The result can either
36667 .ilist
36668 be a valid RSA private key in ASCII armor, including line breaks.
36669 .next
36670 start with a slash, in which case it is treated as a file that contains
36671 the private key.
36672 .next
36673 be "0", "false" or the empty string, in which case the message will not
36674 be signed. This case will not result in an error, even if &%dkim_strict%&
36675 is set.
36676 .endlist
36677
36678 .option dkim_canon smtp string&!! unset
36679 OPTIONAL:
36680 This option sets the canonicalization method used when signing a message.
36681 The DKIM RFC currently supports two methods: "simple" and "relaxed".
36682 The option defaults to "relaxed" when unset. Note: the current implementation
36683 only supports using the same canonicalization method for both headers and body.
36684
36685 .option dkim_strict smtp string&!! unset
36686 OPTIONAL:
36687 This  option  defines  how  Exim  behaves  when  signing a message that
36688 should be signed fails for some reason.  When the expansion evaluates to
36689 either "1" or "true", Exim will defer. Otherwise Exim will send the message
36690 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
36691 variables here.
36692
36693 .option dkim_sign_headers smtp string&!! unset
36694 OPTIONAL:
36695 When set, this option must expand to (or be specified as) a colon-separated
36696 list of header names. Headers with these names will be included in the message
36697 signature. When unspecified, the header names recommended in RFC4871 will be
36698 used.
36699
36700
36701 .section "Verifying DKIM signatures in incoming mail" "SECID514"
36702 .cindex "DKIM" "verification"
36703
36704 Verification of DKIM signatures in incoming email is implemented via the
36705 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
36706 syntactically(!) correct signature in the incoming message.
36707 A missing ACL definition defaults to accept.
36708 If any ACL call does not acccept, the message is not accepted.
36709 If a cutthrough delivery was in progress for the message it is
36710 summarily dropped (having wasted the transmission effort).
36711
36712 To evaluate the signature in the ACL a large number of expansion variables
36713 containing the signature status and its details are set up during the
36714 runtime of the ACL.
36715
36716 Calling the ACL only for existing signatures is not sufficient to build
36717 more advanced policies. For that reason, the global option
36718 &%dkim_verify_signers%&, and a global expansion variable
36719 &%$dkim_signers%& exist.
36720
36721 The global option &%dkim_verify_signers%& can be set to a colon-separated
36722 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
36723 called. It is expanded when the message has been received. At this point,
36724 the expansion variable &%$dkim_signers%& already contains a colon-separated
36725 list of signer domains and identities for the message. When
36726 &%dkim_verify_signers%& is not specified in the main configuration,
36727 it defaults as:
36728 .code
36729 dkim_verify_signers = $dkim_signers
36730 .endd
36731 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
36732 DKIM signature in the message. Current DKIM verifiers may want to explicitly
36733 call the ACL for known domains or identities. This would be achieved as follows:
36734 .code
36735 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
36736 .endd
36737 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
36738 and "ebay.com", plus all domains and identities that have signatures in the message.
36739 You can also be more creative in constructing your policy. For example:
36740 .code
36741 dkim_verify_signers = $sender_address_domain:$dkim_signers
36742 .endd
36743
36744 If a domain or identity is listed several times in the (expanded) value of
36745 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
36746
36747
36748 Inside the &%acl_smtp_dkim%&, the following expansion variables are
36749 available (from most to least important):
36750
36751
36752 .vlist
36753 .vitem &%$dkim_cur_signer%&
36754 The signer that is being evaluated in this ACL run. This can be a domain or
36755 an identity. This is one of the list items from the expanded main option
36756 &%dkim_verify_signers%& (see above).
36757 .vitem &%$dkim_verify_status%&
36758 A string describing the general status of the signature. One of
36759 .ilist
36760 &%none%&: There is no signature in the message for the current domain or
36761 identity (as reflected by &%$dkim_cur_signer%&).
36762 .next
36763 &%invalid%&: The signature could not be verified due to a processing error.
36764 More detail is available in &%$dkim_verify_reason%&.
36765 .next
36766 &%fail%&: Verification of the signature failed.  More detail is
36767 available in &%$dkim_verify_reason%&.
36768 .next
36769 &%pass%&: The signature passed verification. It is valid.
36770 .endlist
36771 .vitem &%$dkim_verify_reason%&
36772 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
36773 "fail" or "invalid". One of
36774 .ilist
36775 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
36776 key for the domain could not be retrieved. This may be a temporary problem.
36777 .next
36778 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
36779 record for the domain is syntactically invalid.
36780 .next
36781 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
36782 body hash does not match the one specified in the signature header. This
36783 means that the message body was modified in transit.
36784 .next
36785 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
36786 could not be verified. This may mean that headers were modified,
36787 re-written or otherwise changed in a way which is incompatible with
36788 DKIM verification. It may of course also mean that the signature is forged.
36789 .endlist
36790 .vitem &%$dkim_domain%&
36791 The signing domain. IMPORTANT: This variable is only populated if there is
36792 an actual signature in the message for the current domain or identity (as
36793 reflected by &%$dkim_cur_signer%&).
36794 .vitem &%$dkim_identity%&
36795 The signing identity, if present. IMPORTANT: This variable is only populated
36796 if there is an actual signature in the message for the current domain or
36797 identity (as reflected by &%$dkim_cur_signer%&).
36798 .vitem &%$dkim_selector%&
36799 The key record selector string.
36800 .vitem &%$dkim_algo%&
36801 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
36802 .vitem &%$dkim_canon_body%&
36803 The body canonicalization method. One of 'relaxed' or 'simple'.
36804 .vitem &%dkim_canon_headers%&
36805 The header canonicalization method. One of 'relaxed' or 'simple'.
36806 .vitem &%$dkim_copiedheaders%&
36807 A transcript of headers and their values which are included in the signature
36808 (copied from the 'z=' tag of the signature).
36809 .vitem &%$dkim_bodylength%&
36810 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
36811 limit was set by the signer, "9999999999999" is returned. This makes sure
36812 that this variable always expands to an integer value.
36813 .vitem &%$dkim_created%&
36814 UNIX timestamp reflecting the date and time when the signature was created.
36815 When this was not specified by the signer, "0" is returned.
36816 .vitem &%$dkim_expires%&
36817 UNIX timestamp reflecting the date and time when the signer wants the
36818 signature to be treated as "expired". When this was not specified by the
36819 signer, "9999999999999" is returned. This makes it possible to do useful
36820 integer size comparisons against this value.
36821 .vitem &%$dkim_headernames%&
36822 A colon-separated list of names of headers included in the signature.
36823 .vitem &%$dkim_key_testing%&
36824 "1" if the key record has the "testing" flag set, "0" if not.
36825 .vitem &%$dkim_key_nosubdomains%&
36826 "1" if the key record forbids subdomaining, "0" otherwise.
36827 .vitem &%$dkim_key_srvtype%&
36828 Service type (tag s=) from the key record. Defaults to "*" if not specified
36829 in the key record.
36830 .vitem &%$dkim_key_granularity%&
36831 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
36832 in the key record.
36833 .vitem &%$dkim_key_notes%&
36834 Notes from the key record (tag n=).
36835 .endlist
36836
36837 In addition, two ACL conditions are provided:
36838
36839 .vlist
36840 .vitem &%dkim_signers%&
36841 ACL condition that checks a colon-separated list of domains or identities
36842 for a match against the domain or identity that the ACL is currently verifying
36843 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
36844 verb to a group of domains or identities. For example:
36845
36846 .code
36847 # Warn when Mail purportedly from GMail has no signature at all
36848 warn log_message = GMail sender without DKIM signature
36849      sender_domains = gmail.com
36850      dkim_signers = gmail.com
36851      dkim_status = none
36852 .endd
36853
36854 .vitem &%dkim_status%&
36855 ACL condition that checks a colon-separated list of possible DKIM verification
36856 results against the actual result of verification. This is typically used
36857 to restrict an ACL verb to a list of verification outcomes, for example:
36858
36859 .code
36860 deny message = Mail from Paypal with invalid/missing signature
36861      sender_domains = paypal.com:paypal.de
36862      dkim_signers = paypal.com:paypal.de
36863      dkim_status = none:invalid:fail
36864 .endd
36865
36866 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
36867 see the documentation of the &%$dkim_verify_status%& expansion variable above
36868 for more information of what they mean.
36869 .endlist
36870
36871 . ////////////////////////////////////////////////////////////////////////////
36872 . ////////////////////////////////////////////////////////////////////////////
36873
36874 .chapter "Adding new drivers or lookup types" "CHID13" &&&
36875          "Adding drivers or lookups"
36876 .cindex "adding drivers"
36877 .cindex "new drivers, adding"
36878 .cindex "drivers" "adding new"
36879 The following actions have to be taken in order to add a new router, transport,
36880 authenticator, or lookup type to Exim:
36881
36882 .olist
36883 Choose a name for the driver or lookup type that does not conflict with any
36884 existing name; I will use &"newdriver"& in what follows.
36885 .next
36886 Add to &_src/EDITME_& the line:
36887 .display
36888 <&'type'&>&`_NEWDRIVER=yes`&
36889 .endd
36890 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
36891 code is not to be included in the binary by default, comment this line out. You
36892 should also add any relevant comments about the driver or lookup type.
36893 .next
36894 Add to &_src/config.h.defaults_& the line:
36895 .code
36896 #define <type>_NEWDRIVER
36897 .endd
36898 .next
36899 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
36900 and create a table entry as is done for all the other drivers and lookup types.
36901 .next
36902 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
36903 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
36904 Add your &`NEWDRIVER`& to that list.
36905 As long as the dynamic module would be named &_newdriver.so_&, you can use the
36906 simple form that most lookups have.
36907 .next
36908 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
36909 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
36910 driver or lookup type and add it to the definition of OBJ.
36911 .next
36912 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
36913 &_src_&.
36914 .next
36915 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
36916 as for other drivers and lookups.
36917 .endlist
36918
36919 Then all you need to do is write the code! A good way to start is to make a
36920 proforma by copying an existing module of the same type, globally changing all
36921 occurrences of the name, and cutting out most of the code. Note that any
36922 options you create must be listed in alphabetical order, because the tables are
36923 searched using a binary chop procedure.
36924
36925 There is a &_README_& file in each of the sub-directories of &_src_& describing
36926 the interface that is expected.
36927
36928
36929
36930
36931 . ////////////////////////////////////////////////////////////////////////////
36932 . ////////////////////////////////////////////////////////////////////////////
36933
36934 . /////////////////////////////////////////////////////////////////////////////
36935 . These lines are processing instructions for the Simple DocBook Processor that
36936 . Philip Hazel has developed as a less cumbersome way of making PostScript and
36937 . PDFs than using xmlto and fop. They will be ignored by all other XML
36938 . processors.
36939 . /////////////////////////////////////////////////////////////////////////////
36940
36941 .literal xml
36942 <?sdop
36943   format="newpage"
36944   foot_right_recto="&chaptertitle;"
36945   foot_right_verso="&chaptertitle;"
36946 ?>
36947 .literal off
36948
36949 .makeindex "Options index"   "option"
36950 .makeindex "Variables index" "variable"
36951 .makeindex "Concept index"   "concept"
36952
36953
36954 . /////////////////////////////////////////////////////////////////////////////
36955 . /////////////////////////////////////////////////////////////////////////////